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

Stores edge exporting values. More...

Public Member Functions

def set_as_directed (self, directed)
 Sets if the edge should be managed as directed. More...
 
def get_labelcolor_rgb (self)
 Gets the edge label color. More...
 
def set_label (self, label)
 Sets the edge label. More...
 
def set_width (self, width)
 Sets the edge width. More...
 
def set_color_rgb (self, color)
 Sets the edge color. More...
 
def set_font_size (self, size)
 Sets the edge label font size. More...
 
def set_labelcolor_rgb (self, color)
 Sets the edge label color. More...
 
def get_color_rgb (self)
 Gets the edge color. More...
 
def get_font_size (self)
 Gets the edge label font size. More...
 
def set_defaults (self)
 Sets to default values.
 
def __init__ (self)
 Creates a new instance.
 
def get_label (self)
 Gets the edge label. More...
 
def get_width (self)
 Gets the edge width. More...
 
def as_directed (self)
 Gets if the edge should be managed as directed. More...
 

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

def sparksee.EdgeExport.as_directed (   self)

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.
def sparksee.EdgeExport.get_color_rgb (   self)

Gets the edge color.

Returns
The edge color.
def sparksee.EdgeExport.get_font_size (   self)

Gets the edge label font size.

Returns
The edge label font size.
def sparksee.EdgeExport.get_label (   self)

Gets the edge label.

Returns
The edge label.
def sparksee.EdgeExport.get_labelcolor_rgb (   self)

Gets the edge label color.

Returns
The edge label color.
def sparksee.EdgeExport.get_width (   self)

Gets the edge width.

Returns
The edge width.
def sparksee.EdgeExport.set_as_directed (   self,
  directed 
)

Sets if the edge should be managed as directed.

Parameters
directed[in] If TRUE, use as directed, otherwise use as undirected.
def sparksee.EdgeExport.set_color_rgb (   self,
  color 
)

Sets the edge color.

Parameters
color[in] The edge color.
def sparksee.EdgeExport.set_font_size (   self,
  size 
)

Sets the edge label font size.

Parameters
size[in] The edge label font size.
def sparksee.EdgeExport.set_label (   self,
  label 
)

Sets the edge label.

Parameters
label[in] The edge label.
def sparksee.EdgeExport.set_labelcolor_rgb (   self,
  color 
)

Sets the edge label color.

Parameters
color[in] The edge label color.
def sparksee.EdgeExport.set_width (   self,
  width 
)

Sets the edge width.

Parameters
width[in] The edge width.