sparksee.NodeExport Class Reference

Stores the node exporting values. More...

Public Member Functions
	get_image (self)
	Gets the node image.
	get_labelcolor_rgb (self)
	Gets the node label color.
	set_label (self, label)
	Sets the node label.
	set_width (self, width)
	Gets the node width.
	set_image (self, image)
	Sets the node image.
	set_color_rgb (self, color)
	Sets the node color.
	set_font_size (self, size)
	Sets the node label font size.
	set_height (self, height)
	Sets the node height.
	get_shape (self)
	Gets the node shape.
	set_labelcolor_rgb (self, color)
	Sets the node label color.
	is_fit (self)
	Gets whether the node size is fitted to the label or not.
	get_color_rgb (self)
	Gets the node color.
	set_fit (self, fit)
	Sets the node fit property.
	__init__ (self)
	Creates a new instance.
	get_font_size (self)
	Gets the node label font size.
	set_defaults (self)
	Sets to default values.
	get_label (self)
	Gets the node label.
	get_height (self)
	Gets the node height.
	get_title (self)
	Gets the node title.
	get_width (self)
	Gets the node width.
	set_title (self, title)
	Sets the node title.
	copy_defaults (self, source)
	Sets the default values using a refrerence NodeExport.
	set_shape (self, 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

copy_defaults()

sparksee.NodeExport.copy_defaults	(		self,
			source )

Sets the default values using a refrerence NodeExport.

Parameters

source

null

get_color_rgb()

sparksee.NodeExport.get_color_rgb

(

self

)

Gets the node color.

Returns

The node color.

get_font_size()

sparksee.NodeExport.get_font_size

(

self

)

Gets the node label font size.

Returns

The node label font size.

get_height()

sparksee.NodeExport.get_height

(

self

)

Gets the node height.

Returns

The node height in pixels.

get_image()

sparksee.NodeExport.get_image

(

self

)

Gets the node image.

Returns

The node image.

get_label()

sparksee.NodeExport.get_label

(

self

)

Gets the node label.

Returns

The node label.

get_labelcolor_rgb()

sparksee.NodeExport.get_labelcolor_rgb

(

self

)

Gets the node label color.

Returns

The node label color.

get_shape()

sparksee.NodeExport.get_shape

(

self

)

Gets the node shape.

Returns

The node shape.

get_title()

sparksee.NodeExport.get_title

(

self

)

Gets the node title.

Returns

The node title.

get_width()

sparksee.NodeExport.get_width

(

self

)

Gets the node width.

Returns

The node width in pixels.

is_fit()

sparksee.NodeExport.is_fit

(

self

)

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

set_color_rgb()

sparksee.NodeExport.set_color_rgb	(		self,
			color )

Sets the node color.

Parameters

color

The node color.

set_fit()

sparksee.NodeExport.set_fit	(		self,
			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'.

set_font_size()

sparksee.NodeExport.set_font_size	(		self,
			size )

Sets the node label font size.

Parameters

size	[in] The node label font size.

set_height()

sparksee.NodeExport.set_height	(		self,
			height )

Sets the node height.

Parameters

height

[in] The node height in pixels.

set_image()

sparksee.NodeExport.set_image	(		self,
			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").

set_label()

sparksee.NodeExport.set_label	(		self,
			label )

Sets the node label.

Parameters

label

[in] The node label.

set_labelcolor_rgb()

sparksee.NodeExport.set_labelcolor_rgb	(		self,
			color )

Sets the node label color.

Parameters

color

[in] The node label color.

set_shape()

sparksee.NodeExport.set_shape	(		self,
			shape )

Sets the node shape.

Parameters

shape

[in] The node shape.

set_title()

sparksee.NodeExport.set_title	(		self,
			title )

Sets the node title.

Parameters

title

[in] The node title.

set_width()

sparksee.NodeExport.set_width	(		self,
			width )

Gets the node width.

Parameters

width

The node width in pixels.