C

TreeMapLayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>

Show Usages
Specifies custom data for the TreeMapLayout.
Inheritance Hierarchy

Members

Show:

Constructors

TreeMapLayoutData

()

Parameters

Properties

childNodeComparator

: function(TNode, TNode): number
Gets or sets the comparison function that defines the order in which child nodes are placed inside their parent node.
If no comparison function is specified, the nodes are ordered with respect to their weight (higher weight first).
final

See Also

Developer's Guide

nodeWeights

: ItemMapping<TNode, number>
Gets or sets the mapping from nodes to the weight value used for the tree map layout.

The weight of a node defines the area assigned to the node inside the available parent area with respect to the other child nodes, i.e., the area of the node rectangle in the resulting layout is proportional to the weight. Child nodes at the same hierarchy level with equal weight get the same area, they do not necessarily get equal width and height values.

All leaf nodes (nodes without further children) need to have a weight greater than 0. Non-leaf nodes do not need to have a weight. They will get the sum of the weight of their children. If they have a weight on their own, some free space is generated inside the representative rectangle (i.e. the parent node is larger than the combined children).

Due to padding specified at parent nodes of different hierarchies and the inter-node padding defined by spacing, nodes that have the same actual weight can get slightly different sizes.
conversionfinal

See Also

API
NODE_WEIGHT_DATA_KEY

Methods

combineWith

(data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>): LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>
Combines this instance with the given layout data.
This keeps the current instance unmodified and instead returns a new instance that dynamically combines the contents of all involved instances.
final

Parameters

data: LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>
The LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel> to combine this instance with.

Return Value

LayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>
The combined layout data.

See Also

Developer's Guide
API
CompositeLayoutData, GenericLayoutData