com.sparsity.sparksee.gdb.NodeExport Class Reference

Stores the node exporting values. More...

Public Member Functions
int	GetLabelColorRGB ()
	Gets the node label color.
void	SetLabel (System.String label)
	Sets the node label.
void	SetWidth (int width)
	Gets the node width.
void	SetImage (System.String image)
	Sets the node image.
void	SetColorRGB (int color)
	Sets the node color.
void	SetFontSize (int size)
	Sets the node label font size.
void	SetHeight (int height)
	Sets the node height.
void	SetDefaults ()
	Sets to default values.
System.Drawing.Color	GetColor ()
	Gets the color of the node.
System.String	GetLabel ()
	Gets the node label.
int	GetHeight ()
	Gets the node height.
System.String	GetTitle ()
	Gets the node title.
void	SetLabelColor (System.Drawing.Color c)
	Sets the color of the label.
int	GetWidth ()
	Gets the node width.
void	CopyDefaults (com.sparsity.sparksee.gdb.NodeExport source)
	Sets the default values using a refrerence NodeExport.
System.String	GetImage ()
	Gets the node image.
System.Drawing.Color	GetLabelColor ()
	Gets the color of the label.
com.sparsity.sparksee.gdb.NodeShape	GetShape ()
	Gets the node shape.
void	SetLabelColorRGB (int color)
	Sets the node label color.
bool	IsFit ()
	Gets whether the node size is fitted to the label or not.
int	GetColorRGB ()
	Gets the node color.
void	SetFit (bool fit)
	Sets the node fit property.
void	SetColor (System.Drawing.Color c)
	Sets the color of the node.
	NodeExport ()
	Creates a new instance.
int	GetFontSize ()
	Gets the node label font size.
void	SetTitle (System.String title)
	Sets the node title.
void	SetShape (com.sparsity.sparksee.gdb.NodeShape shape)
	Sets the node shape.

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

CopyDefaults()

void com.sparsity.sparksee.gdb.NodeExport.CopyDefaults

(

com.sparsity.sparksee.gdb.NodeExport

source

)

Sets the default values using a refrerence NodeExport.

Parameters

source

null

GetColorRGB()

int com.sparsity.sparksee.gdb.NodeExport.GetColorRGB

(

)

Gets the node color.

Returns

The node color.

GetFontSize()

int com.sparsity.sparksee.gdb.NodeExport.GetFontSize

(

)

Gets the node label font size.

Returns

The node label font size.

GetHeight()

int com.sparsity.sparksee.gdb.NodeExport.GetHeight

(

)

Gets the node height.

Returns

The node height in pixels.

GetImage()

System.String com.sparsity.sparksee.gdb.NodeExport.GetImage

(

)

Gets the node image.

Returns

The node image.

GetLabel()

System.String com.sparsity.sparksee.gdb.NodeExport.GetLabel

(

)

Gets the node label.

Returns

The node label.

GetLabelColorRGB()

int com.sparsity.sparksee.gdb.NodeExport.GetLabelColorRGB

(

)

Gets the node label color.

Returns

The node label color.

GetShape()

com.sparsity.sparksee.gdb.NodeShape com.sparsity.sparksee.gdb.NodeExport.GetShape

(

)

Gets the node shape.

Returns

The node shape.

GetTitle()

System.String com.sparsity.sparksee.gdb.NodeExport.GetTitle

(

)

Gets the node title.

Returns

The node title.

GetWidth()

int com.sparsity.sparksee.gdb.NodeExport.GetWidth

(

)

Gets the node width.

Returns

The node width in pixels.

IsFit()

bool com.sparsity.sparksee.gdb.NodeExport.IsFit

(

)

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'.

SetColor()

void com.sparsity.sparksee.gdb.NodeExport.SetColor

(

System.Drawing.Color

c

)

Sets the color of the node.

Parameters

c	New value.

SetColorRGB()

void com.sparsity.sparksee.gdb.NodeExport.SetColorRGB

(

int

color

)

Sets the node color.

Parameters

color

The node color.

SetFit()

void com.sparsity.sparksee.gdb.NodeExport.SetFit

(

bool

fit

)

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 com.sparsity.sparksee.gdb.NodeExport.SetFontSize

(

int

size

)

Sets the node label font size.

Parameters

size	[in] The node label font size.

SetHeight()

void com.sparsity.sparksee.gdb.NodeExport.SetHeight

(

int

height

)

Sets the node height.

Parameters

height

[in] The node height in pixels.

SetImage()

void com.sparsity.sparksee.gdb.NodeExport.SetImage

(

System.String

image

)

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 com.sparsity.sparksee.gdb.NodeExport.SetLabel

(

System.String

label

)

Sets the node label.

Parameters

label

[in] The node label.

SetLabelColor()

void com.sparsity.sparksee.gdb.NodeExport.SetLabelColor

(

System.Drawing.Color

c

)

Sets the color of the label.

Parameters

c	New value.

SetLabelColorRGB()

void com.sparsity.sparksee.gdb.NodeExport.SetLabelColorRGB

(

int

color

)

Sets the node label color.

Parameters

color

[in] The node label color.

SetShape()

void com.sparsity.sparksee.gdb.NodeExport.SetShape

(

com.sparsity.sparksee.gdb.NodeShape

shape

)

Sets the node shape.

Parameters

shape

[in] The node shape.

SetTitle()

void com.sparsity.sparksee.gdb.NodeExport.SetTitle

(

System.String

title

)

Sets the node title.

Parameters

title

[in] The node title.

SetWidth()

void com.sparsity.sparksee.gdb.NodeExport.SetWidth

(

int

width

)

Gets the node width.

Parameters

width

The node width in pixels.