Provides different ways to define an ordering for the successors of nodes.
Remarks
Only one of the provided ways to define an ordering can be used at the same time, therefore only one of the properties outEdgeComparators, outEdgeComparables, targetNodeComparators and targetNodeComparables should be set on each instance.
This class supports LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> implementations and does not usually have to be instantiated by client code explicitly. Instances of this class are properties of concrete LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> implementations.
Type Parameters
- TNode
- TEdge
Type Details
- yFiles module
- algorithms
Properties
Gets or sets a mapping from edges to an IComparable used to sort the nodes' outgoing edges, which ultimately orders the successor nodes of a node.
Remarks
If edges are to be ordered per local "root", use the outEdgeComparators property instead.
Setting this property will override any previously set properties.
Gets or sets a mapping from nodes to comparison functions used to sort the nodes' outgoing edges, which ultimately orders the successors of a node.
Remarks
Use this property if only edges at certain local "root" nodes are to be ordered or if the ordering depends on the local "root" node. If all nodes are to be ordered based on simple comparable values (e.g., numbers or strings), then it is more convenient to use the outEdgeComparables property instead.
Setting this property will override any previously set properties.
Gets or sets a mapping from nodes to an IComparable used to sort the nodes' successors.
Remarks
If the successor nodes are to be ordered per local "root" use the targetNodeComparators property instead.
Setting this property will override any previously set properties.
Gets or sets a mapping from nodes to comparison functions used to sort the nodes' successors.
Remarks
Use this property if only nodes at certain local "root" nodes are to be ordered or if the ordering depends on the local "root" node. If all nodes are to be ordered based on simple comparable values (e.g., numbers or strings), then it is more convenient to use the targetNodeComparables property instead.
Setting this property will override any previously set properties.