Describes an ordering constraint that can be given as additional input to the HierarchicalLayout to influence the ordering of items in the layout.
Inheritance Hierarchy
OrderingConstraint
Default Values of Properties
Type Details
- yFiles module
- algorithms
See Also
Constructors
OrderingConstraint
(type: OrderingConstraintType, minimumDistance: number, weight: number, priority: number)Initializes a new instance of the OrderingConstraint class.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- type - OrderingConstraintType
- The type of the placement constraint.
- minimumDistance - number
- The minimum distance when type BEFORE is used.
- weight - number
- The weight of the constraint. This influences the cost when a relative constraint will be elongated when BEFORE is specified.
- priority - number
- The priority of the constraint. If multiple constraints conflict, the ones with lower priority will be discarded.
Properties
Gets the type of this ordering constraint.
Gets the weight to apply by relative constraints when constraints span multiple layers.
Remarks
The weight of the constraint. This influences the cost when a relative constraint will be elongated when BEFORE is specified.