Defines node types distinguished by the MultiPageLayout.
Type Details
- yFiles module
- algorithms
See Also
Constants
A node type that specifies a connector node.
Remarks
Each edge of the input graph that connects two nodes
v and w that are placed on different pages is split by a pair of matching connector nodes (one for each of the two pages). One of the connector nodes is connected to v and the other to w. Hence, each connector represents a jump mark to the matching connector and guarantees that no information is lost as it would be the case if such edges are simply removed.See Also
Sample Graphs
A node type that specifies a group node.
Remarks
A group node is a node that may contain other nodes.
See Also
A node type that specifies a proxy node.
Remarks
A proxy node is a copy of a REGULAR node. It is created by the algorithm if a normal node and its neighbors or associated CONNECTORs do not fit onto a single page. Hence, in such cases, the neighbors/connectors associated with a normal node may be distributed among different proxy nodes associated with this node.
See Also
MultiPageLayoutContext.getNodeType,
MultiPageNodeType.REGULAR,
MultiPageNodeType.PROXY_REFERENCE,
MultiPageLayout.useProxyReferenceNodes
Sample Graphs
A node type that specifies a proxy reference node.
Remarks
For each PROXY node there is exactly one matching proxy reference node (except if property useProxyReferenceNodes is disabled). The reference node refers to the proxy and is either connected to the REGULAR node associated with this proxy or one of its other proxy nodes (a normal node may be associated with multiple proxy nodes). Hence, for a node connected to a proxy reference node there always exists a copy located on another page.
See Also
Sample Graphs
A node type that specifies a regular node.
Remarks
A node is called regular if it does not belong to any other type.
See Also
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - MultiPageNodeType
- The value to convert to an enum constant.
Returns
- ↪MultiPageNodeType
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - MultiPageNodeType
- The numeric value of an enum constant.
Returns
- ↪string
- The name of the enum constant.
Throws
- Exception({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.