sparksee.EdgeExport Class Reference

Stores edge exporting values. More...

List of all members.

Public Member Functions

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


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.set_color_rgb (   self,
  color 
)

Sets the edge color.

Parameters:
color [in] The edge color.

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.get_font_size (   self  ) 

Gets the edge label font size.

Returns:
The edge label font size.

def sparksee.EdgeExport.get_color_rgb (   self  ) 

Gets the edge color.

Returns:
The edge color.

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_label (   self,
  label 
)

Sets the edge label.

Parameters:
label [in] The edge label.

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_label (   self  ) 

Gets the edge label.

Returns:
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.

def sparksee.EdgeExport.set_font_size (   self,
  size 
)

Sets the edge label font size.

Parameters:
size [in] The edge label font size.


Generated on Fri Sep 12 13:39:52 2014 for SparkseePython by  doxygen 1.5.6