This interface specifies the general contract for factory classes that can be used to associate sequence constraints with a graph.
Inheritance Hierarchy
ISequenceConstraintFactory
Remarks
Sequence constraints affect the sequence of nodes within a layer.
A ISequenceConstraintFactory has to be disposed of after use. Disposing of the factory will also remove all constraints previously specified for the factory's associated graph.
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.hierarchic.ISequenceConstraintFactory
See Also
- Sequence constraints cannot be used together with swimlanes.
- If you manually register with the graph a IDataProvider with key NODE_ID_DP_KEY, you must use the corresponding node IDs stored in this IDataProvider as arguments for all methods that create a constraint. Otherwise, you can just use the node instances themselves.
Sample Graphs
Properties
Gets a token that allows to bind a constraint factory to a graph instance after creation.
Remarks
This method should only be used if the constraint factory is not bound to a graph instance initially. It allows to bind this factory to a graph instance after creation.
See Also
Methods
Adds a constraint that forces the YNode or Edge with id after to lie after the YNode or Edge with id reference.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- referenceId - Object
- the ID of the reference node or edge
- afterId - Object
- the ID of the node or edge that should be placed after the reference element
Sample Graphs
A constraint is only considered if both elements share at least one layer. An edge is associated with each layer that it spans, i.e., each layer between it's source and target (excluding the source and target layer).
A constraint is only considered if both elements share at least one layer. An edge constraint is associated with each layer that the edge spans including the edge's source and target (e.g., an after constraint between two edges also implies that the source/target of the
after edge should be placed after that of the reference edge, if possible). Constraints of edges with recursive edge style are ignored.If there are groups or swimlanes, there are implicit constraints on the edges, e.g., the edge path never leaves the bounding box of the group that is the common ancestor of the edge's endpoints. Furthermore, if both endpoints of an edge are associated with the same swimlane, the route does never leave this lane. Such constraints cannot be affected by sequence constraints.
Adds a constraint that places a YNode or Edge at the start of the sequence.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- id - Object
- the ID of the node or edge that should be placed at the start
Sample Graphs
For edges, this constraint applies to each layer that the edge spans including the edge's source and target. Edges with recursive edge style are ignored.
If there are groups or swimlanes, there are implicit constraints on the edges, e.g., the edge path never leaves the bounding box of the group that is the common ancestor of the edge's endpoints. Furthermore, if both endpoints of an edge are associated with the same swimlane, the route does never leave this lane. Such constraints cannot be affected by sequence constraints.
Adds a constraint that places a YNode or Edge at the end of the sequence.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- id - Object
- the ID of the node or edge that should be placed at the end
Sample Graphs
For edges, this constraint applies to each layer that the edge spans including the edge's source and target. Edges with recursive edge style are ignored.
If there are groups or swimlanes, there are implicit constraints on the edges, e.g., the edge path never leaves the bounding box of the group that is the common ancestor of the edge's endpoints. Furthermore, if both endpoints of an edge are associated with the same swimlane, the route does never leave this lane. Such constraints cannot be affected by sequence constraints.
Adds a constraint that forces the YNode or Edge with id before to lie before the YNode or Edge with id reference.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- referenceId - Object
- the ID of the reference node or edge
- beforeId - Object
- the ID of the node or edge that should be placed before the reference element
Sample Graphs
A constraint is only considered if both elements share at least one layer. An edge is associated with each layer that it spans, i.e., each layer between it's source and target (excluding the source and target layer).
A constraint is only considered if both elements share at least one layer. An edge constraint is associated with each layer that the edge spans including the edge's source and target (e.g., a before constraint between two edges also implies that the source/target of the
before edge should be placed before that of the reference edge, if possible). Constraints of edges with recursive edge style are ignored.If there are groups or swimlanes, there are implicit constraints on the edges, e.g., the edge path never leaves the bounding box of the group that is the common ancestor of the edge's endpoints. Furthermore, if both endpoints of an edge are associated with the same swimlane, the route does never leave this lane. Such constraints cannot be affected by sequence constraints.
Disposes of the ISequenceConstraintFactory.
Remarks
This method may have be called when the factory is not needed anymore, i.e. after the layout has been calculated. The documentation of the method or class providing this factory should state when this is necessary. Calling this method also clears all constraints.