Sparksee 6.1.0
EdgeExport Class Reference
Gdb

Stores edge exporting values. More...

#include <Export.h>

Public Member Functions

 EdgeExport ()
 Creates a new instance.
virtual ~EdgeExport ()
 Destructor.
void SetDefaults ()
 Sets to default values.
void CopyDefaults (const EdgeExport &source)
 Sets the default values using a refrerence EdgeExport.
const std::wstring & GetLabel () const
 Gets the edge label.
void SetLabel (const std::wstring &label)
 Sets the edge label.
const std::wstring & GetTitle () const
 Gets the edge title.
void SetTitle (const std::wstring &title)
 Sets the edge title.
bool_t AsDirected () const
 Gets if the edge should be managed as directed.
void SetAsDirected (bool_t directed)
 Sets if the edge should be managed as directed.
ColorRGB GetColorRGB () const
 Gets the edge color.
void SetColorRGB (ColorRGB color)
 Sets the edge color.
ColorRGB GetLabelColorRGB () const
 Gets the edge label color.
void SetLabelColorRGB (ColorRGB color)
 Sets the edge label color.
int32_t GetWidth () const
 Gets the edge width.
void SetWidth (int32_t width)
 Sets the edge width.
int32_t GetFontSize () const
 Gets the edge label font size.
void SetFontSize (int32_t size)
 Sets the edge label font size.

Detailed Description

Stores edge exporting values.

Some properties may be ignored depending on the exportation type.

Default values are:

Label: "" (empty string).

As directed: TRUE.

Color: 13882323 (OxD3D3D3, Light gray).

Label color: 0 (Ox000000, Black).

Width: 5px.

Font size: 10.

Author
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

◆ AsDirected()

bool_t EdgeExport::AsDirected ( ) const
inline

Gets if the edge should be managed as directed.

TRUE is the default value. If TRUE, use as directed, otherwise use as undirected.

Returns
The edge direction.

◆ GetColorRGB()

ColorRGB EdgeExport::GetColorRGB ( ) const
inline

Gets the edge color.

Returns
The edge color.

◆ GetFontSize()

int32_t EdgeExport::GetFontSize ( ) const
inline

Gets the edge label font size.

Returns
The edge label font size.

◆ GetLabel()

const std::wstring & EdgeExport::GetLabel ( ) const
inline

Gets the edge label.

Returns
The edge label.

◆ GetLabelColorRGB()

ColorRGB EdgeExport::GetLabelColorRGB ( ) const
inline

Gets the edge label color.

Returns
The edge label color.

◆ GetTitle()

const std::wstring & EdgeExport::GetTitle ( ) const
inline

Gets the edge title.

Returns
The edge title.

◆ GetWidth()

int32_t EdgeExport::GetWidth ( ) const
inline

Gets the edge width.

Returns
The edge width.

◆ SetAsDirected()

void EdgeExport::SetAsDirected ( bool_t directed)
inline

Sets if the edge should be managed as directed.

Parameters
directed[in] If TRUE, use as directed, otherwise use as undirected.

◆ SetColorRGB()

void EdgeExport::SetColorRGB ( ColorRGB color)
inline

Sets the edge color.

Parameters
color[in] The edge color.

◆ SetFontSize()

void EdgeExport::SetFontSize ( int32_t size)
inline

Sets the edge label font size.

Parameters
size[in] The edge label font size.

◆ SetLabel()

void EdgeExport::SetLabel ( const std::wstring & label)
inline

Sets the edge label.

Parameters
label[in] The edge label.

◆ SetLabelColorRGB()

void EdgeExport::SetLabelColorRGB ( ColorRGB color)
inline

Sets the edge label color.

Parameters
color[in] The edge label color.

◆ SetTitle()

void EdgeExport::SetTitle ( const std::wstring & title)
inline

Sets the edge title.

Parameters
title[in] The edge title.

◆ SetWidth()

void EdgeExport::SetWidth ( int32_t width)
inline

Sets the edge width.

Parameters
width[in] The edge width.
The documentation for this class was generated from the following file: