SparkseePython  6.0.2
Public Member Functions | List of all members
sparksee.NodeExport Class Reference

Stores the node exporting values. More...

Public Member Functions

def get_labelcolor_rgb (self)
 Gets the node label color. More...
 
def set_label (self, label)
 Sets the node label. More...
 
def set_width (self, width)
 Gets the node width. More...
 
def set_color_rgb (self, color)
 Sets the node color. More...
 
def set_font_size (self, size)
 Sets the node label font size. More...
 
def set_height (self, height)
 Sets the node height. More...
 
def get_shape (self)
 Gets the node shape. More...
 
def set_labelcolor_rgb (self, color)
 Sets the node label color. More...
 
def is_fit (self)
 Gets whether the node size is fitted to the label or not. More...
 
def get_color_rgb (self)
 Gets the node color. More...
 
def set_fit (self, fit)
 Sets the node fit property. More...
 
def __init__ (self)
 Creates a new instance.
 
def get_font_size (self)
 Gets the node label font size. More...
 
def set_defaults (self)
 Sets to default values.
 
def get_label (self)
 Gets the node label. More...
 
def get_height (self)
 Gets the node height. More...
 
def get_width (self)
 Gets the node width. More...
 
def set_shape (self, shape)
 Sets the node shape. More...
 

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

def sparksee.NodeExport.get_color_rgb (   self)

Gets the node color.

Returns
The node color.
def sparksee.NodeExport.get_font_size (   self)

Gets the node label font size.

Returns
The node label font size.
def sparksee.NodeExport.get_height (   self)

Gets the node height.

Returns
The node height in pixels.
def sparksee.NodeExport.get_label (   self)

Gets the node label.

Returns
The node label.
def sparksee.NodeExport.get_labelcolor_rgb (   self)

Gets the node label color.

Returns
The node label color.
def sparksee.NodeExport.get_shape (   self)

Gets the node shape.

Returns
The node shape.
def sparksee.NodeExport.get_width (   self)

Gets the node width.

Returns
The node width in pixels.
def 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'.
def sparksee.NodeExport.set_color_rgb (   self,
  color 
)

Sets the node color.

Parameters
colorThe node color.
def 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'.
def sparksee.NodeExport.set_font_size (   self,
  size 
)

Sets the node label font size.

Parameters
size[in] The node label font size.
def sparksee.NodeExport.set_height (   self,
  height 
)

Sets the node height.

Parameters
height[in] The node height in pixels.
def sparksee.NodeExport.set_label (   self,
  label 
)

Sets the node label.

Parameters
label[in] The node label.
def sparksee.NodeExport.set_labelcolor_rgb (   self,
  color 
)

Sets the node label color.

Parameters
color[in] The node label color.
def sparksee.NodeExport.set_shape (   self,
  shape 
)

Sets the node shape.

Parameters
shape[in] The node shape.
def sparksee.NodeExport.set_width (   self,
  width 
)

Gets the node width.

Parameters
widthThe node width in pixels.