MatrixData

matrix. MatrixData

Represents a matrix, which consists of a tree of groups and port objects; and a set of connections between ports.

Constructor

new MatrixData()

Source:

Methods

addConnection()

Source:

Add a connection object.

addGroup()

Source:

Add a group to this matrix. Will be added at the top level of the tree.

addPort()

Source:

Add a port to this matrix. Will be added at the top level of the tree.

connect(from, to)

Source:

Connect two ports.

Parameters:
Name Type Description
from PortData
to PortData

createConnection()

Source:

Create a connection object.

createGroup(groupd, GroupClassopt)

Source:

Creates a group object for this matrix.

Parameters:
Name Type Attributes Default Description
groupd Object

The data for the group object.

GroupClass function <optional>
GroupData

The group data class to use.

createPort(port, PortClassopt)

Source:

Creates a port object for this matrix.

Parameters:
Name Type Attributes Default Description
port Object

The data for the port object.

PortClass function <optional>
PortData

The port data class to use.

deleteConnection()

Source:

Delete a connection object.

deleteGroup()

Source:

Remove a group from the top level of the tree.

deletePort()

Source:

Remove a port from the top level of the tree.

forEachConnection()

Source:

Iterate all connections.

getConnection()

Source:

Return the connection of the two given ports, if any exists.

getConnectionsFrom()

Source:

Return all connections from this node.

getConnectionsOf()

Source:

Return all connections of the given node.

getConnectionsTo()

Source:

Return all connections to this node.

getGroupById()

Source:

Find a group object for the given id.

Parameters:
Name Type Description
id. any

getPortById()

Source:

Find a port object for the given id.

Parameters:
Name Type Description
id. any