C

FillAreaLayoutData<TNode, TEdge, TNodeLabel, TEdgeLabel>

Show Usages
Specifies custom data for the FillAreaLayout.
Inheritance Hierarchy

Members

Show:

Constructors

FillAreaLayoutData

()

Parameters

Properties

componentIds

: ItemMapping<TNode, any>
Gets or sets the mapping from nodes to an object defining their component id.
Nodes of the same component should preferably not be separated. While the algorithm may move a whole component, it should try to not move only a subset of its elements. This means that the algorithm tries to move all elements of a component by the same offset (if at all). In order to achieve good results with this feature, the different components should not overlap in the initial drawing.
If custom components are specified, the componentAssignmentStrategy will be ignored.
If the input graph contains group nodes or a LayoutGrid structure, maintaining the specified components is not always possible. Furthermore, a custom component can never pass the border of a group node or layout grid cell, i.e., all nodes of a custom component have to be associated with the same group or grid cell.
conversionfinal

See Also

API
COMPONENT_ID_DATA_KEY, componentAssignmentStrategy

fixedNodes

: ItemCollection<TNode>
Gets or sets the collection of nodes that are fixed and must not be moved.
The algorithm tries to preserve the mental map and, thus, non-fixed nodes cannot simply pass/jump over the fixed nodes (i.e. fixed nodes restrict the possible movement of non-fixed nodes).
conversionfinal

See Also

API
FIXED_NODE_DATA_KEY

layoutGridData

: LayoutGridData<TNode, TEdge, TNodeLabel, TEdgeLabel>
Gets or sets the LayoutGrid layout data.
final

nodeMargins

: ItemMapping<TNode, Insets>
Gets or sets the mapping from nodes to their margins.
Node margins allow to reserve space around nodes.
conversionfinal

Examples

The easiest option is to reserve the same space around all nodes, by setting a constant value:

Using constant space around all nodes
layoutData.nodeMargins = new Insets(20)

Handling only certain nodes differently can be done easily by using the mapper property:

Using a mapper to set margins for certain nodes
// node1 only reserves space above and below
layoutData.nodeMargins.mapper.set(node1, new Insets(20, 10, 0, 0))
// node2 has space all around
layoutData.nodeMargins.mapper.set(node2, new Insets(25))
// all other nodes don't get extra space

In cases where the nodeMargins for each node can be determined by looking at the node itself it's often easier to just set a mapperFunction instead of preparing a mapper:

Using a delegate to determine margins for all nodes
// Retrieve the space around the node from its tag property
layoutData.nodeMargins = (node: INode): Insets =>
  new Insets(parseFloat(node.tag))

See Also

API
NODE_MARGIN_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