NodeExport Class Reference

Stores the node exporting values. More...

#include <Export.h>

Public Member Functions
	NodeExport ()
	Creates a new instance.
virtual	~NodeExport ()
	Destructor.
void	SetDefaults ()
	Sets to default values.
void	CopyDefaults (const NodeExport &source)
	Sets the default values using a refrerence NodeExport.
const std::wstring &	GetLabel () const
	Gets the node label.
void	SetLabel (const std::wstring &label)
	Sets the node label.
const std::wstring &	GetTitle () const
	Gets the node title.
void	SetTitle (const std::wstring &title)
	Sets the node title.
NodeShape	GetShape () const
	Gets the node shape.
void	SetShape (NodeShape shape)
	Sets the node shape.
ColorRGB	GetColorRGB () const
	Gets the node color.
void	SetColorRGB (ColorRGB color)
	Sets the node color.
ColorRGB	GetLabelColorRGB () const
	Gets the node label color.
void	SetLabelColorRGB (ColorRGB color)
	Sets the node label color.
int32_t	GetHeight () const
	Gets the node height.
void	SetHeight (int32_t height)
	Sets the node height.
int32_t	GetWidth () const
	Gets the node width.
void	SetWidth (int32_t width)
	Gets the node width.
bool_t	IsFit () const
	Gets whether the node size is fitted to the label or not.
void	SetFit (bool_t fit)
	Sets the node fit property.
int32_t	GetFontSize () const
	Gets the node label font size.
void	SetFontSize (int32_t size)
	Sets the node label font size.
const std::wstring &	GetImage () const
	Gets the node image.
void	SetImage (const std::wstring &image)
	Sets the node image.

Detailed Description

Stores the node exporting values.

When 'fit' is set to TRUE, then 'height' and 'width' will be ignored.

Some properties may be ignored depending on the exportation type.

Default values are:

Label: "" (empty string).

Shape: Box.

Color: 10863606 (0xa5c3f6).

Label color: 0 (Ox000000, Black).

Height: 25px.

Width: 25px.

Fit: TRUE.

Font size: 10.

Author

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

Member Function Documentation

GetColorRGB()

ColorRGB NodeExport::GetColorRGB ( ) const

inline

Gets the node color.

Returns

The node color.

GetFontSize()

int32_t NodeExport::GetFontSize ( ) const

inline

Gets the node label font size.

Returns

The node label font size.

GetHeight()

int32_t NodeExport::GetHeight ( ) const

inline

Gets the node height.

Returns

The node height in pixels.

GetImage()

const std::wstring & NodeExport::GetImage ( ) const

inline

Gets the node image.

Returns

The node image.

GetLabel()

const std::wstring & NodeExport::GetLabel ( ) const

inline

Gets the node label.

Returns

The node label.

GetLabelColorRGB()

ColorRGB NodeExport::GetLabelColorRGB ( ) const

inline

Gets the node label color.

Returns

The node label color.

GetShape()

NodeShape NodeExport::GetShape ( ) const

inline

Gets the node shape.

Returns

The node shape.

GetTitle()

const std::wstring & NodeExport::GetTitle ( ) const

inline

Gets the node title.

Returns

The node title.

GetWidth()

int32_t NodeExport::GetWidth ( ) const

inline

Gets the node width.

Returns

The node width in pixels.

IsFit()

bool_t NodeExport::IsFit ( ) const

inline

Gets whether the node size is fitted to the label or not.

Returns

If TRUE, then the node size is fitted to the label, otherwise the size is fixed with the values of 'height' and 'width'.

SetColorRGB()

void NodeExport::SetColorRGB ( ColorRGB color )

inline

Sets the node color.

Parameters

color

The node color.

SetFit()

void NodeExport::SetFit ( bool_t fit )

inline

Sets the node fit property.

Parameters

fit	[in] If TRUE, then the node size is fitted to the label ('height' and 'width' will be ignored), otherwise the size is fixed with the values of 'height' and 'width'.

SetFontSize()

void NodeExport::SetFontSize ( int32_t size )

inline

Sets the node label font size.

Parameters

size	[in] The node label font size.

SetHeight()

void NodeExport::SetHeight ( int32_t height )

inline

Sets the node height.

Parameters

height

[in] The node height in pixels.

SetImage()

void NodeExport::SetImage ( const std::wstring & image )

inline

Sets the node image.

Parameters

image

[in] The node image. The image should be a path to a local file or an URL. The image usage in the export depends on the exported format and shape. For Graphviz: Graphviz expects only local image paths as images in dot files unless you plan on using something like it's "dot_url_resolve.py" script to automatically download them. The Image shape is not directly supported for Graphviz. For Html: The vis.js html exports only show the image if the node shape selected is Image or Circle (that will be translated as "circularimage").

SetLabel()

void NodeExport::SetLabel ( const std::wstring & label )

inline

Sets the node label.

Parameters

label

[in] The node label.

SetLabelColorRGB()

void NodeExport::SetLabelColorRGB ( ColorRGB color )

inline

Sets the node label color.

Parameters

color

[in] The node label color.

SetShape()

void NodeExport::SetShape ( NodeShape shape )

inline

Sets the node shape.

Parameters

shape

[in] The node shape.

SetTitle()

void NodeExport::SetTitle ( const std::wstring & title )

inline

Sets the node title.

Parameters

title

[in] The node title.

SetWidth()

void NodeExport::SetWidth ( int32_t width )

inline

Gets the node width.

Parameters

width

The node width in pixels.

---

The documentation for this class was generated from the following file:

• Export.h