name(nameopt) → {string|Description}

Parameters:

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored name value;
otherwise it returns 'this' for use with the builder pattern.

Type

string
|
Description

outerHTML(outerHTMLopt) → {string|Description}

The object's HTML code and its content.

Parameters:

Name

Type

Attributes

Description

outerHTML

string

<optional>

When provided, this method acts as a setter and sets the outerHTML value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored outerHTML value;
otherwise it returns 'this' for use with the builder pattern.

Type

string
|
Description

outerText(outerTextopt) → {string|Description}

The object's text (supported in Internet Explorer only).

Parameters:

Name

Type

Attributes

Description

outerText

string

<optional>

When provided, this method acts as a setter and sets the outerText value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored outerText value;
otherwise it returns 'this' for use with the builder pattern.

Type

string
|
Description

selectedNode(selectedNodeopt) → {string|Description}

Deprecated (use selectedNodePath instead)
The currently selected node in this tree.

Parameters:

Name

Type

Attributes

Description

selectedNode

string

<optional>

When provided, this method acts as a setter and sets the selectedNode value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored selectedNode value;
otherwise it returns 'this' for use with the builder pattern.

Type

string
|
Description

selectedNodePath(selectedNodeopt) → {string|Description}

The currently selected node in this tree.

Parameters:

Name

Type

Attributes

Description

selectedNode

string

<optional>

When provided, this method acts as a setter and sets the selectedNode value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored selectedNode value;
otherwise it returns 'this' for use with the builder pattern.

Type

string
|
Description

size(sizeopt) → {Size|Description}

The object's size (in pixels).

Parameters:

Name

Type

Attributes

Description

size

Size

<optional>

When provided, this method acts as a setter and sets the size value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored size value;
otherwise it returns 'this' for use with the builder pattern.

Type

Size
|
Description

styles(stylesopt) → {Object|Description}

The object's computed style.

Parameters:

Name

Type

Attributes

Description

styles

Object

<optional>

When provided, this method acts as a setter and sets the object by its computed style value.
* Specify the style names as object keys and set their values to the desired style values.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored styles object;
otherwise it returns 'this' for use with the builder pattern.

Type

Object
|
Description

tagName(tagopt) → {string|Description}

The object's HTML tag.

Parameters:

Name

Type

Attributes

Description

tag

string

<optional>

When provided, this method acts as a setter and sets the HTML tagName value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored HTML tagName value;
otherwise it returns 'this' for use with the builder pattern.

Type

string
|
Description

title(titleopt) → {string|Description}

The object's title.

Parameters:

Name

Type

Attributes

Description

title

string

<optional>

When provided, this method acts as a setter and sets the title value.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored title value;
otherwise it returns 'this' for use with the builder pattern.

Type

string
|
Description

visibleNodes(nodes) → {Array.<string>|Description}

An array of all visible nodes in the object.

Parameters:

Name

Type

Description

nodes

Array.<string>

An array of all visible nodes in the object.

Returns:

If no parameter is provided, the method acts as a getter and returns the current stored visibleNodes value;
otherwise it returns 'this' for use with the builder pattern.

Type

Array.<string>
|
Description

vri(valueopt)

Sets a VisualRelation definition.
The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.