Specifies custom data for the AspectRatioTreeLayout.
Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.tree.AspectRatioTreeLayoutData
See Also
Constructors
Creates a new instance of AspectRatioTreeLayoutData which helps configuring AspectRatioTreeLayout.
Parameters
A map of options to pass to the method.
- subtreeAspectRatios - ItemMapping<INode,number>
The mapping from nodes to the aspect ratio of their sub tree. This option sets the subtreeAspectRatios property on the created object.
- rootPlacements - ItemMapping<INode,RootPlacement>
The mapping from nodes with sub trees to their placements. This option sets the rootPlacements property on the created object.
- subtreeRoutingPolicies - ItemMapping<INode,SubtreeArrangement>
The mapping from nodes to the routing policies of their sub trees. This option sets the subtreeRoutingPolicies property on the created object.
Properties
Gets or sets the mapping from nodes with sub trees to their placements.
Remarks
See Also
Gets or sets the mapping from nodes to the aspect ratio of their sub tree.
Remarks
The aspect ratio needs to be greater than 0.
- aspect ratio
1: width and height of the layout should be the same - aspect ratio between
0and1: the height of the layout should be greater than its width - aspect ratio greater than
1: the width of the layout should be greater than its height
If no specific ratio is defined for a subtree, the layout algorithm falls back to the default aspect ratio.
See Also
Gets or sets the mapping from nodes to the routing policies of their sub trees.
Remarks
The children in a subtree are arranged either horizontally or vertically. The edges are routed to the top of the child nodes or at the side, respectively. Directions depend on the layout orientation and refer to TOP_TO_BOTTOM for this description.
If no specific routing policy is specified for a subtree root, the layout algorithm uses the default routing direction.
See Also
Methods
Combines this instance with the given layout data.
Remarks
Parameters
A map of options to pass to the method.
- data - LayoutData
- The LayoutData to combine this instance with.
Returns
- ↪LayoutData
- The combined layout data.