This class represents the layout context.
Remarks
It provides several methods to access data as well as adding and removing elements.
This class cannot be instantiated
Type Details
- yFiles module
- algorithms
Methods
Gets the unique ID of the associated edge.
Parameters
A map of options to pass to the method.
- edge - LayoutEdge
- The edge for which to retrieve the unique ID.
Returns
- ↪any?
- The ID of the associated edge.
See Also
Gets the unique ID of the associated edge label.
Parameters
A map of options to pass to the method.
- label - LayoutEdgeLabel
- The edge label for which to retrieve the unique ID.
Returns
- ↪any?
- the unique ID of the associated edge label
See Also
Gets the type of the associated edge.
Parameters
A map of options to pass to the method.
- edge - LayoutEdge
- The edge for which to retrieve the associated type.
Returns
- ↪MultiPageEdgeType?
- The type of the associated edge.
Gets the unique ID of the given node.
Parameters
A map of options to pass to the method.
- node - LayoutNode
- The node for which to retrieve the unique ID.
Returns
- ↪any?
- the ID of the node
See Also
Gets the unique ID of the associated node label.
Parameters
A map of options to pass to the method.
- label - LayoutNodeLabel
- The node label for which to retrieve the unique ID.
Returns
- ↪any?
- the unique ID of the associated node label
See Also
Gets the type of the given node.
Parameters
A map of options to pass to the method.
- node - LayoutNode
- The node for which to retrieve the associated type.
Returns
- ↪MultiPageNodeType?
- The type of the node
Gets the page number of the page graph that contains the node associated with the given node.
Parameters
A map of options to pass to the method.
- node - LayoutNode
- The node for which to retrieve the associated page number.
Returns
- ↪number?
- the page number of the page graph that contains the node associated with the given node
Returns the edge of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such edge.
Parameters
A map of options to pass to the method.
- edgeId - any
- the ID of the edge that should be returned
Returns
- ↪LayoutEdge
- the edge of a page graph with the given ID or
nullif there is no such edge
Returns the node of a page graph (a graph that represents the result of the multi-page layout) with the given ID or null if there is no such node.
Parameters
A map of options to pass to the method.
- nodeId - any
- the ID of the node that should be returned
Returns
- ↪LayoutNode
- the node of a page graph with the given ID or
nullif there is no such node
Gets the node that refers to the one associated with the given node.
Remarks
- is a CONNECTOR node, this method returns the matching connector node.
- is a PROXY node, it returns the corresponding PROXY_REFERENCE node (or the associated common node if property useProxyReferenceNodes is disabled).
- is a PROXY_REFERENCE node, it returns the corresponding PROXY node.
- or otherwise, it returns
null.
Parameters
A map of options to pass to the method.
- node - LayoutNode
- The node for which to retrieve the referencing node.
Returns
- ↪LayoutNode?
- the node that refers to the one associated with the given node
See Also
Gets the original edge associated with this info.
Remarks
null.Parameters
A map of options to pass to the method.
- edge - LayoutEdge
- The edge for which to retrieve the original associated edge.
Returns
- ↪LayoutEdge?
- The original edge if the type of the edge is CONNECTOR,
nullotherwise
See Also
Gets the node of the input graph that is represented by the given node.
Remarks
- A CONNECTOR node is mapped to the common node connected to the matching connector.
- A PROXY node is mapped to the associated common node (i.e., the proxy is a copy of that node).
- A PROXY_REFERENCE node is not mapped to any node, and, thus this method returns
nullfor such nodes.
Parameters
A map of options to pass to the method.
- node - LayoutNode
- The node for which to retrieve the associated node.
Returns
- ↪LayoutNode?
- the node of the input graph that is represented by the given node