Specifies custom data for the TabularLayout.
Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.layout.TabularLayoutData
See Also
Constructors
Creates a new instance of TabularLayoutData which helps configuring TabularLayout.
Parameters
A map of options to pass to the method.
- nodeLayoutDescriptors - ItemMapping<INode,TabularLayoutNodeLayoutDescriptor>
The mapping of nodes to their TabularLayoutNodeLayoutDescriptor that defines custom node placement settings. This option sets the nodeLayoutDescriptors property on the created object.
- partitionGridData - PartitionGridData
The partition grid layout data. This option sets the partitionGridData property on the created object.
- nodeHalos - ItemMapping<INode,NodeHalo>
Properties
Gets or sets the mapping from nodes to their NodeHalo.
Remarks
Examples
The easiest option is to reserve the same space around all nodes, by setting a constant NodeHalo:
layoutData.nodeHalos.constant = NodeHalo.create(20)Handling only certain nodes differently can be done easily by using the mapper property:
// node1 only reserves space above and below
layoutData.nodeHalos.mapper.set(node1, NodeHalo.create(20, 0, 0, 10))
// node2 has space all around
layoutData.nodeHalos.mapper.set(node2, NodeHalo.create(25))
// all other nodes don't get extra spaceIn cases where the NodeHalo for each node can be determined by looking at the node itself it's often easier to just set a delegate instead of preparing a mapper:
// Retrieve the space around the node from its Tag property
layoutData.nodeHalos = (node) => NodeHalo.create(parseFloat(node.tag))// Retrieve the space around the node from its Tag property
layoutData.nodeHalos = (node: INode): NodeHalo =>
NodeHalo.create(parseFloat(node.tag))See Also
Gets or sets the mapping of nodes to their TabularLayoutNodeLayoutDescriptor that defines custom node placement settings.
Gets or sets the partition grid layout data.
Remarks
- When using AUTO_SIZE, it is not necessary to define a partition grid at all. If a Grid is specified, its existing rows and columns will be cleared and the grid is filled with the data resembling the computed layout. That allows to query information about the rows and columns using classes RowDescriptor and ColumnDescriptor (e.g. query computed position of row/column).
- For policy FIXED_SIZE it is necessary to define a partition grid instance. The size of the given grid defines the size of the computed tabular layout. A node can be mapped to a specific grid cell to manually define its location in the layout.
- Policy FROM_SKETCH: the same as for AUTO_SIZE applies with respect to the necessity of the partition grid. That means that the grid is optional and only necessary if the resulting dimension shall be queried after the layout.
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.