sparksee.EdgeExport Class Reference

Stores edge exporting values. More...

Public Member Functions
	set_as_directed (self, directed)
	Sets if the edge should be managed as directed.
	get_labelcolor_rgb (self)
	Gets the edge label color.
	set_label (self, label)
	Sets the edge label.
	set_width (self, width)
	Sets the edge width.
	set_color_rgb (self, color)
	Sets the edge color.
	set_font_size (self, size)
	Sets the edge label font size.
	set_labelcolor_rgb (self, color)
	Sets the edge label color.
	get_color_rgb (self)
	Gets the edge color.
	get_font_size (self)
	Gets the edge label font size.
	set_defaults (self)
	Sets to default values.
	__init__ (self)
	Creates a new instance.
	get_label (self)
	Gets the edge label.
	get_title (self)
	Gets the edge title.
	get_width (self)
	Gets the edge width.
	set_title (self, title)
	Sets the edge title.
	as_directed (self)
	Gets if the edge should be managed as directed.
	copy_defaults (self, source)
	Sets the default values using a refrerence EdgeExport.

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

as_directed()

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.

copy_defaults()

sparksee.EdgeExport.copy_defaults	(		self,
			source )

Sets the default values using a refrerence EdgeExport.

Parameters

source

null

get_color_rgb()

sparksee.EdgeExport.get_color_rgb

(

self

)

Gets the edge color.

Returns

The edge color.

get_font_size()

sparksee.EdgeExport.get_font_size

(

self

)

Gets the edge label font size.

Returns

The edge label font size.

get_label()

sparksee.EdgeExport.get_label

(

self

)

Gets the edge label.

Returns

The edge label.

get_labelcolor_rgb()

sparksee.EdgeExport.get_labelcolor_rgb

(

self

)

Gets the edge label color.

Returns

The edge label color.

get_title()

sparksee.EdgeExport.get_title

(

self

)

Gets the edge title.

Returns

The edge title.

get_width()

sparksee.EdgeExport.get_width

(

self

)

Gets the edge width.

Returns

The edge width.

set_as_directed()

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.

set_color_rgb()

sparksee.EdgeExport.set_color_rgb	(		self,
			color )

Sets the edge color.

Parameters

color

[in] The edge color.

set_font_size()

sparksee.EdgeExport.set_font_size	(		self,
			size )

Sets the edge label font size.

Parameters

size	[in] The edge label font size.

set_label()

sparksee.EdgeExport.set_label	(		self,
			label )

Sets the edge label.

Parameters

label

[in] The edge label.

set_labelcolor_rgb()

sparksee.EdgeExport.set_labelcolor_rgb	(		self,
			color )

Sets the edge label color.

Parameters

color

[in] The edge label color.

set_title()

sparksee.EdgeExport.set_title	(		self,
			title )

Sets the edge title.

Parameters

title

[in] The edge title.

set_width()

sparksee.EdgeExport.set_width	(		self,
			width )

Sets the edge width.

Parameters

width

[in] The edge width.