Specifies custom data for the ReverseEdgesStage.
Inheritance Hierarchy
LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
ReverseEdgesStageData
Type Parameters
- TNode
- TEdge
- TNodeLabel
- TEdgeLabel
Type Details
- yFiles module
- algorithms
Constructors
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- sourceGroupIds - ItemMapping<TEdge,any>
- A mapping from edges to an object representing their source edge group. This option either sets the value directly or recursively sets properties to the instance of the sourceGroupIds property on the created object.
- targetGroupIds - ItemMapping<TEdge,any>
- A mapping from edges to an object representing their target edge group. This option either sets the value directly or recursively sets properties to the instance of the targetGroupIds property on the created object.
- ports - PortData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The sub-data that influences the placement of the ports. This option either sets the value directly or recursively sets properties to the instance of the ports property on the created object.
Properties
Gets or sets the sub-data that influences the placement of the ports.
Remarks
For edges reversed by class ReverseEdgesStage (if applied as layout stage), the specified source and target values are automatically exchanged (after reversing the edge, the former source value is associated with the new target and vice versa).
Gets or sets the sub-data that specifies the subset of edges that are in scope for the ReverseEdgesStage.
Gets or sets a mapping from edges to an object representing their source edge group.
Remarks
For edges reversed by class ReverseEdgesStage (if applied as layout stage), the specified group ids are automatically exchanged (after reversing the edge, the former source value is associated with the new target and vice versa).
See Also
Gets or sets a mapping from edges to an object representing their target edge group.
Remarks
For edges reversed by class ReverseEdgesStage (if applied as layout stage), the specified group ids are automatically exchanged (after reversing the edge, the former source value is associated with the new target and vice versa).
See Also
Methods
combineWith
(data: LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>…) : LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>Combines this instance with the given layout data.
Remarks
This keeps the current instance unmodified and instead returns a new instance that dynamically combines the contents of all involved instances.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- data - LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> to combine this instance with.
Returns
- ↪LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The combined layout data.
See Also
CompositeLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>,
GenericLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>