Stores the node exporting values. More...

#include <Sparksee.h>

Inheritance diagram for STSNodeExport:

Collaboration diagram for STSNodeExport:

Instance Methods
(id)	- init
	Creates a new instance.
(void)	- setDefaults
	Sets to default values.
(void)	- copyDefaults:
	Sets the default values using a refrerence NodeExport.
(NSString *)	- getLabel
	Gets the node label.
(void)	- setLabel:
	Sets the node label.
(NSString *)	- getTitle
	Gets the node title.
(void)	- setTitle:
	Sets the node title.
(enum STSNodeShape)	- getShape
	Gets the node shape.
(void)	- setShape:
	Sets the node shape.
(int)	- getColorRGB
	Gets the node color.
(void)	- setColorRGB:
	Sets the node color.
(int)	- getLabelColorRGB
	Gets the node label color.
(void)	- setLabelColorRGB:
	Sets the node label color.
(int)	- getHeight
	Gets the node height.
(void)	- setHeight:
	Sets the node height.
(int)	- getWidth
	Gets the node width.
(void)	- setWidth:
	Gets the node width.
(BOOL)	- isFit
	Gets whether the node size is fitted to the label or not.
(void)	- setFit:
	Sets the node fit property.
(int)	- getFontSize
	Gets the node label font size.
(void)	- setFontSize:
	Sets the node label font size.
(NSString *)	- getImage
	Gets the node image.
(void)	- setImage:
	Sets the node image.
(void)	- getColorRed:green:blue:alpha:
	Get the node color separated in RGBA.
(void)	- setColorRed:green:blue:alpha:
	Set the node color with separated RGBA components.
(void)	- getLabelColorRed:green:blue:alpha:
	Get the node label color separated in RGBA.
(void)	- setLabelColorRed:green:blue:alpha:
	Set the node label color with separated RGBA components.

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

Method Documentation

◆ copyDefaults:

- (void) copyDefaults: (STSNodeExport *) source

Sets the default values using a refrerence NodeExport.

Parameters

source null

◆ getColorRed:green:blue:alpha:

- (void) getColorRed:	(double *)	red
green:	(double *)	green
blue:	(double *)	blue
alpha:	(double *)	alpha

Get the node 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]).

◆ getColorRGB

- (int) getColorRGB

Gets the node color.

Returns: The node color.

References getColorRGB.

Referenced by getColorRGB.

◆ getFontSize

- (int) getFontSize

Gets the node label font size.

Returns: The node label font size.

References getFontSize.

Referenced by getFontSize.

◆ getHeight

- (int) getHeight

Gets the node height.

Returns: The node height in pixels.

References getHeight.

Referenced by getHeight.

◆ getImage

- (NSString *) getImage

Gets the node image.

Returns: The node image.

References getImage.

Referenced by getImage.

◆ getLabel

- (NSString *) getLabel

Gets the node label.

Returns: The node label.

References getLabel.

Referenced by getLabel.

◆ getLabelColorRed:green:blue:alpha:

- (void) getLabelColorRed:	(double *)	red
green:	(double *)	green
blue:	(double *)	blue
alpha:	(double *)	alpha

Get the node 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]).

◆ getLabelColorRGB

- (int) getLabelColorRGB

Gets the node label color.

Returns: The node label color.

References getLabelColorRGB.

Referenced by getLabelColorRGB.

◆ getShape

- (enum STSNodeShape) getShape

Gets the node shape.

Returns: The node shape.

References getShape.

Referenced by getShape.

◆ getTitle

- (NSString *) getTitle

Gets the node title.

Returns: The node title.

References getTitle.

Referenced by getTitle.

◆ getWidth

- (int) getWidth

Gets the node width.

Returns: The node width in pixels.

References getWidth.

Referenced by getWidth.

◆ isFit

- (BOOL) isFit

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'.

References isFit.

Referenced by isFit.

◆ setColorRed:green:blue:alpha:

- (void) setColorRed:	(double)	red
green:	(double)	green
blue:	(double)	blue
alpha:	(double)	alpha

Set the node 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]).

◆ setColorRGB:

- (void) setColorRGB: (int) color

Sets the node color.

Parameters

color The node color.

◆ setFit:

- (void) setFit: (BOOL) 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'.

◆ setFontSize:

- (void) setFontSize: (int) size

Sets the node label font size.

Parameters

size	[in] The node label font size.

◆ setHeight:

- (void) setHeight: (int) height

Sets the node height.

Parameters

height [in] The node height in pixels.

◆ setImage:

- (void) setImage: (NSString *) image

Sets the node image.

Parameters

image [in] The node image. The image should be a path to a local file or an URL. The image usage in the export depends on the exported format and shape. For Graphviz: Graphviz expects only local image paths as images in dot files unless you plan on using something like it's "dot_url_resolve.py" script to automatically download them. The Image shape is not directly supported for Graphviz. For Html: The vis.js html exports only show the image if the node shape selected is Image or Circle (that will be translated as "circularimage").

◆ setLabel:

- (void) setLabel: (NSString *) label

Sets the node label.

Parameters

label [in] The node label.

◆ setLabelColorRed:green:blue:alpha:

- (void) setLabelColorRed:	(double)	red
green:	(double)	green
blue:	(double)	blue
alpha:	(double)	alpha

Set the node 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]).

◆ setLabelColorRGB:

- (void) setLabelColorRGB: (int) color

Sets the node label color.

Parameters

color [in] The node label color.

◆ setShape:

- (void) setShape: (enum STSNodeShape) shape

Sets the node shape.

Parameters

shape [in] The node shape.

◆ setTitle:

- (void) setTitle: (NSString *) title

Sets the node title.

Parameters

title [in] The node title.

◆ setWidth:

- (void) setWidth: (int) width

Gets the node width.

Parameters

width The node width in pixels.

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

Sparksee.h

Instance Methods

Detailed Description

Method Documentation

◆ copyDefaults:

◆ getColorRed:green:blue:alpha:

◆ getColorRGB

◆ getFontSize

◆ getHeight

◆ getImage

◆ getLabel

◆ getLabelColorRed:green:blue:alpha:

◆ getLabelColorRGB

◆ getShape

◆ getTitle

◆ getWidth

◆ isFit

◆ setColorRed:green:blue:alpha:

◆ setColorRGB:

◆ setFit:

◆ setFontSize:

◆ setHeight:

◆ setImage:

◆ setLabel:

◆ setLabelColorRed:green:blue:alpha:

◆ setLabelColorRGB:

◆ setShape:

◆ setTitle:

◆ setWidth: