Sparksee  5.2.0
STSEdgeExport Class Reference

Stores edge exporting values. More...

Inheritance diagram for STSEdgeExport:
Inheritance graph
Collaboration diagram for STSEdgeExport:
Collaboration graph

Instance Methods

(id) - init
 Creates a new instance.
 
(void) - setDefaults
 Sets to default values.
 
(NSString *) - getLabel
 Gets the edge label.
 
(void) - setLabel:
 Sets the edge label.
 
(BOOL) - asDirected
 Gets if the edge should be managed as directed.
 
(void) - setAsDirected:
 Sets if the edge should be managed as directed.
 
(int) - getColorRGB
 Gets the edge color.
 
(void) - setColorRGB:
 Sets the edge color.
 
(int) - getLabelColorRGB
 Gets the edge label color.
 
(void) - setLabelColorRGB:
 Sets the edge label color.
 
(int) - getWidth
 Gets the edge width.
 
(void) - setWidth:
 Sets the edge width.
 
(int) - getFontSize
 Gets the edge label font size.
 
(void) - setFontSize:
 Sets the edge label font size.
 
(void) - getColorRed:green:blue:alpha:
 Get the edge color separated in RGBA.
 
(void) - setColorRed:green:blue:alpha:
 Set the edge color with separated RGBA components.
 
(void) - getLabelColorRed:green:blue:alpha:
 Get the edge label color separated in RGBA.
 
(void) - setLabelColorRed:green:blue:alpha:
 Set the edge label color with separated RGBA components.
 

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

Method Documentation

- (BOOL) asDirected

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.
- (void) getColorRed: (double *)  red
green: (double *)  green
blue: (double *)  blue
alpha: (double *)  alpha 

Get the edge color separated in RGBA.

Parameters
red[out] The red color component ([0..1]).
green[out] The green color component ([0..1]).
blue[out] The blue color component ([0..1]).
alpha[out] The alpha component ([0..1]).
- (int) getColorRGB

Gets the edge color.

Returns
The edge color.
- (int) getFontSize

Gets the edge label font size.

Returns
The edge label font size.
- (NSString*) getLabel

Gets the edge label.

Returns
The edge label.
- (void) getLabelColorRed: (double *)  red
green: (double *)  green
blue: (double *)  blue
alpha: (double *)  alpha 

Get the edge label color separated in RGBA.

Parameters
red[out] The red color component ([0..1]).
green[out] The green color component ([0..1]).
blue[out] The blue color component ([0..1]).
alpha[out] The alpha component ([0..1]).
- (int) getLabelColorRGB

Gets the edge label color.

Returns
The edge label color.
- (int) getWidth

Gets the edge width.

Returns
The edge width.
- (void) setAsDirected: (BOOL)  directed

Sets if the edge should be managed as directed.

Parameters
directed[in] If TRUE, use as directed, otherwise use as undirected.
- (void) setColorRed: (double)  red
green: (double)  green
blue: (double)  blue
alpha: (double)  alpha 

Set the edge color with separated RGBA components.

Parameters
red[in] The red color component ([0..1]).
green[in] The green color component ([0..1]).
blue[in] The blue color component ([0..1]).
alpha[in] The alpha component ([0..1]).
- (void) setColorRGB: (int)  color

Sets the edge color.

Parameters
color[in] The edge color.
- (void) setFontSize: (int)  size

Sets the edge label font size.

Parameters
size[in] The edge label font size.
- (void) setLabel: (NSString *)  label

Sets the edge label.

Parameters
label[in] The edge label.
- (void) setLabelColorRed: (double)  red
green: (double)  green
blue: (double)  blue
alpha: (double)  alpha 

Set the edge label color with separated RGBA components.

Parameters
red[in] The red color component ([0..1]).
green[in] The green color component ([0..1]).
blue[in] The blue color component ([0..1]).
alpha[in] The alpha component ([0..1]).
- (void) setLabelColorRGB: (int)  color

Sets the edge label color.

Parameters
color[in] The edge label color.
- (void) setWidth: (int)  width

Sets the edge width.

Parameters
width[in] The edge width.

The documentation for this class was generated from the following file: