Class el.Node

The Node Model.

Representation of a Node. Is an el.Model

Attributes

Node.name The node's name (string).
Node.valid Validity flag (bool).

Methods

Node:hasEditor () Returns true if this node has an editor.
Node:displayName () Returns the display name of this node.
Node:pluginName () Returns the original plugin name of this node.
Node:hasModifiedName () Returns true if the node has been renamed.
Node:uuidString () Returns a session-wide unique ID.
Node:nodeId () Returns a graph-wide unique ID.
Node:nodeType () Returns the type of this node.
Node:isGraph () Returns true if this is a graph.
Node:isRoot () Returns true if this is a root graph.
Node::toXmlString () Convert to XML string.
Node:saveState () Save state.
Node:restoreState () Restore state.


Attributes

Node.name
The node's name (string).
Node.valid
Validity flag (bool). False if this node isn't valid.

Methods

Node:hasEditor ()
Returns true if this node has an editor.

Returns:

    bool True if yes.
Node:displayName ()
Returns the display name of this node.

Returns:

    string The name to use for display.
Node:pluginName ()
Returns the original plugin name of this node.

Returns:

    string The plugin name.
Node:hasModifiedName ()
Returns true if the node has been renamed.

Returns:

    bool True if modified.
Node:uuidString ()
Returns a session-wide unique ID.

Returns:

    string
Node:nodeId ()
Returns a graph-wide unique ID.

Returns:

    int
Node:nodeType ()
Returns the type of this node. Usage of this method is only used to determine if the node is a graph or not. Subject to change and add more types.

Returns:

    string
Node:isGraph ()
Returns true if this is a graph.

Returns:

    bool
Node:isRoot ()
Returns true if this is a root graph. These exists as top level graphs in the el.Session

Returns:

    bool
Node::toXmlString ()
Convert to XML string.

Returns:

    string
Node:saveState ()
Save state.
Node:restoreState ()
Restore state.
generated by LDoc 1.5.0 Last updated 2024-02-18 20:31:17