This class provides a way to easily pass custom item-specific data to the LayoutGraph which is used during the layout algorithm execution.
Inheritance Hierarchy
LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
GenericLayoutData
Remarks
This is a generic implementation of the LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> class that can be used to conveniently configure a custom layout configuration and to attach arbitrary data to the LayoutGraph that is used during layout.
Depending on the type of the original input graph this layout data can be provided as follows:
- IGraph: via the LayoutExecutor, the method applyLayout, or the method applyLayoutAnimated.
- LayoutGraph: via the method applyLayout.
Instances of this type can be passed to . Instead of using one of the provided use-case specific LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> subclasses, this class can be used to provide various types of data to layout algorithms. The layout algorithms can then retrieve the data via the getItemData mechanism under the key used to register the data with instances of this class.
Use combineWith to create a layout data instance that contains both the data for an existing instance and this instance. Alternatively add multiple layout data instances to instances of this type.
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify which nodes to fix
const fixedNodes = layoutData.addItemCollection(
RemoveOverlapsStage.FIXED_NODE_DATA_KEY,
).items
for (const node of graph.nodes) {
if (node.labels.some((label) => label.text == 'Fix')) {
fixedNodes.add(node)
}
}
// specify which nodes should be handled by a custom layout
// and register the information in the data
layoutData.addItemCollection(
CustomLayout.CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY,
).predicate = isAffected
// run the custom layout, passing in the data
graph.applyLayout(new CustomLayout(), layoutData)public static readonly CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY: NodeDataKey<boolean> =
new NodeDataKey<boolean>('CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY')
public applyLayout(graph: LayoutGraph): void {
// get the data provider that was registered with the provided key
const fixedNodes = graph.context.getItemData(
RemoveOverlapsStage.FIXED_NODE_DATA_KEY,
)
if (fixedNodes != null) {
for (const node of graph.nodes) {
// check whether the node was marked as fixed or not
const isFree = !fixedNodes.get(node)
if (isFree) {
// and use it
node.layout.x = 1337
node.layout.y = 42
}
}
}
// get the mapper that was registered and tells us which nodes should be affected
const affectedNodes = graph.context.getItemData(
CustomLayout.CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY,
)
if (affectedNodes != null) {
for (const node of graph.nodes) {
// obtain the data for each node
if (affectedNodes.get(node)) {
// and use it
node.layout.size = new Size(42, 42)
}
}
}
}// create the container for the data
const layoutData = new GenericLayoutData()
// specify insets for each node, letting the data create the mapping for us
const insets = layoutData.addItemMapping(
LayoutKeys.NODE_MARGIN_DATA_KEY,
).mapper
const labelInsets = new Insets(10)
for (const node of graph.nodes) {
insets.set(node, node.labels.size > 0 ? labelInsets : Insets.EMPTY)
}
// specify port candidate for the edges
const fixedPortCandidates = new EdgePortCandidates().addFixedCandidate(
PortSides.TOP,
)
// and register the information in the data
layoutData.addItemMapping(
EdgePortCandidates.SOURCE_PORT_CANDIDATES_DATA_KEY,
).mapperFunction = (edge) =>
isFixedEdge(edge) ? fixedPortCandidates : null
// run the custom layout, passing in the data
graph.applyLayout(new MyLayout(), layoutData)applyLayout(graph: LayoutGraph) {
// get the data provider that was registered with the provided key
const nodeMargins = graph.context.getItemData(
LayoutKeys.NODE_MARGIN_DATA_KEY,
)
if (nodeMargins != null) {
for (const node of graph.nodes) {
// obtain the data for each node from the provider
const margin = nodeMargins.get(node)
if (margin instanceof Insets) {
// and use it
node.layout.topLeft = new Point(margin.left, margin.top)
}
}
}
}Type Parameters
- TNode
- TEdge
- TNodeLabel
- TEdgeLabel
Type Details
- yFiles module
- algorithms
See Also
LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>,
Migrating from Synchronous to Asynchronous Layout Calculation,
Layout Data,
Example: Decorating a Graph,
Providing Data for Custom Layout Stages,
Renamed, Moved, and Removed Classes and Members
Methods
Adds the data from one or more other LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> instances to this instance.
Remarks
This will only record a reference to the other data which will then be added to the graph when the layout gets executed. Changes to the other instance will be reflected by this instance.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- data - LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The data to add to this instance.
addItemCollection
(dataKey: NodeDataKey<boolean>, initialCollection?: ItemCollectionConvertible<TNode>) : ItemCollection<TNode>Adds a set of TNodes in the graph that will be passed to the LayoutGraph.
Remarks
You may either specify an existing collection that is convertible to ItemCollection<TNode> or omit the parameter and use the return value to initialize the data.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - NodeDataKey<boolean>
- The key under which the boolean information will be stored in the LayoutGraph's map of data providers. Each corresponding element in the ItemCollection<TItem> will be associated with a
truevalue. - initialCollection - ItemCollectionConvertible<TNode>
- The set of TNode elements to add.
Returns
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify which nodes to fix
const fixedNodes = layoutData.addItemCollection(
RemoveOverlapsStage.FIXED_NODE_DATA_KEY,
).items
for (const node of graph.nodes) {
if (node.labels.some((label) => label.text == 'Fix')) {
fixedNodes.add(node)
}
}
// specify which nodes should be handled by a custom layout
// and register the information in the data
layoutData.addItemCollection(
CustomLayout.CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY,
).predicate = isAffected
// run the custom layout, passing in the data
graph.applyLayout(new CustomLayout(), layoutData)addItemCollection
(dataKey: NodeLabelDataKey<boolean>, initialCollection?: ItemCollectionConvertible<TNodeLabel>) : ItemCollection<TNodeLabel>Adds a set of node labels in the graph that will be passed to the LayoutGraph.
Remarks
You may either specify an existing collection that is convertible to ItemCollection<TNodeLabel> or omit the parameter and use the return value to initialize the data.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - NodeLabelDataKey<boolean>
- The key under which the boolean information will be stored in the LayoutGraph's map of data providers. Each corresponding element in the ItemCollection<TItem> will be associated with a
truevalue. - initialCollection - ItemCollectionConvertible<TNodeLabel>
- The set of node labels elements to add.
Returns
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify which nodes to fix
const fixedNodes = layoutData.addItemCollection(
RemoveOverlapsStage.FIXED_NODE_DATA_KEY,
).items
for (const node of graph.nodes) {
if (node.labels.some((label) => label.text == 'Fix')) {
fixedNodes.add(node)
}
}
// specify which nodes should be handled by a custom layout
// and register the information in the data
layoutData.addItemCollection(
CustomLayout.CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY,
).predicate = isAffected
// run the custom layout, passing in the data
graph.applyLayout(new CustomLayout(), layoutData)addItemCollection
(dataKey: EdgeLabelDataKey<boolean>, initialCollection?: ItemCollectionConvertible<TEdgeLabel>) : ItemCollection<TEdgeLabel>Adds a set of edge labels in the graph that will be passed to the LayoutGraph.
Remarks
You may either specify an existing collection that is convertible to ItemCollection<TEdgeLabel> or omit the parameter and use the return value to initialize the data.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - EdgeLabelDataKey<boolean>
- The key under which the boolean information will be stored in the LayoutGraph's map of data providers. Each corresponding element in the ItemCollection<TItem> will be associated with a
truevalue. - initialCollection - ItemCollectionConvertible<TEdgeLabel>
- The set of edge labels elements to add.
Returns
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify which nodes to fix
const fixedNodes = layoutData.addItemCollection(
RemoveOverlapsStage.FIXED_NODE_DATA_KEY,
).items
for (const node of graph.nodes) {
if (node.labels.some((label) => label.text == 'Fix')) {
fixedNodes.add(node)
}
}
// specify which nodes should be handled by a custom layout
// and register the information in the data
layoutData.addItemCollection(
CustomLayout.CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY,
).predicate = isAffected
// run the custom layout, passing in the data
graph.applyLayout(new CustomLayout(), layoutData)addItemCollection
(dataKey: EdgeDataKey<boolean>, initialCollection?: ItemCollectionConvertible<TEdge>) : ItemCollection<TEdge>Adds a set of TEdge in the graph that will be passed to the LayoutGraph.
Remarks
You may either specify an existing collection that is convertible to ItemCollection<TEdge> or omit the parameter and use the return value to initialize the data.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - EdgeDataKey<boolean>
- The key under which the boolean information will be stored in the LayoutGraph's map of data providers. Each corresponding element in the ItemCollection<TItem> will be associated with a
truevalue. - initialCollection - ItemCollectionConvertible<TEdge>
- The set of elements to add. If omitted, an instance will automatically be created and returned.
Returns
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify which nodes to fix
const fixedNodes = layoutData.addItemCollection(
RemoveOverlapsStage.FIXED_NODE_DATA_KEY,
).items
for (const node of graph.nodes) {
if (node.labels.some((label) => label.text == 'Fix')) {
fixedNodes.add(node)
}
}
// specify which nodes should be handled by a custom layout
// and register the information in the data
layoutData.addItemCollection(
CustomLayout.CUSTOM_LAYOUT_AFFECTED_NODES_DATA_KEY,
).predicate = isAffected
// run the custom layout, passing in the data
graph.applyLayout(new CustomLayout(), layoutData)addItemMapping
<TValue>(dataKey: NodeDataKey<TValue>, initialMapping?: ItemMappingConvertible<TNode,TValue>) : ItemMapping<TNode,TValue>Adds data per TNode in the graph that will be added to the LayoutGraph.
Remarks
You may either specify an existing mapping that is convertible to ItemMapping<TItem,TValue> or omit the parameter and use the return value to initialize the mapping.
Type Parameters
- TValue
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - NodeDataKey<TValue>
- The key under which the data will be registered in the LayoutGraph's map of data providers.
- initialMapping - ItemMappingConvertible<TNode,TValue>
- The mapping to add.
Returns
- ↪ItemMapping<TNode,TValue>
- An ItemMapping<TItem,TValue> for
TNodes.
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify insets for each node, letting the data create the mapping for us
const insets = layoutData.addItemMapping(
LayoutKeys.NODE_MARGIN_DATA_KEY,
).mapper
const labelInsets = new Insets(10)
for (const node of graph.nodes) {
insets.set(node, node.labels.size > 0 ? labelInsets : Insets.EMPTY)
}
// specify port candidate for the edges
const fixedPortCandidates = new EdgePortCandidates().addFixedCandidate(
PortSides.TOP,
)
// and register the information in the data
layoutData.addItemMapping(
EdgePortCandidates.SOURCE_PORT_CANDIDATES_DATA_KEY,
).mapperFunction = (edge) =>
isFixedEdge(edge) ? fixedPortCandidates : null
// run the custom layout, passing in the data
graph.applyLayout(new MyLayout(), layoutData)addItemMapping
<TValue>(dataKey: EdgeDataKey<TValue>, itemMapping?: ItemMappingConvertible<TEdge,TValue>) : ItemMapping<TEdge,TValue>Adds data per TEdge in the graph that will be added to the LayoutGraph.
Remarks
You may either specify an existing mapping that is convertible to ItemMapping<TItem,TValue> or omit the parameter and use the return value to initialize the mapping.
Type Parameters
- TValue
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - EdgeDataKey<TValue>
- The key under which the data will be registered in the LayoutGraph's map of data providers.
- itemMapping - ItemMappingConvertible<TEdge,TValue>
- The mapping to add.
Returns
- ↪ItemMapping<TEdge,TValue>
- An ItemMapping<TItem,TValue> for
TEdges.
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify insets for each node, letting the data create the mapping for us
const insets = layoutData.addItemMapping(
LayoutKeys.NODE_MARGIN_DATA_KEY,
).mapper
const labelInsets = new Insets(10)
for (const node of graph.nodes) {
insets.set(node, node.labels.size > 0 ? labelInsets : Insets.EMPTY)
}
// specify port candidate for the edges
const fixedPortCandidates = new EdgePortCandidates().addFixedCandidate(
PortSides.TOP,
)
// and register the information in the data
layoutData.addItemMapping(
EdgePortCandidates.SOURCE_PORT_CANDIDATES_DATA_KEY,
).mapperFunction = (edge) =>
isFixedEdge(edge) ? fixedPortCandidates : null
// run the custom layout, passing in the data
graph.applyLayout(new MyLayout(), layoutData)addItemMapping
<TValue>(dataKey: NodeLabelDataKey<TValue>, itemMapping?: ItemMappingConvertible<TNodeLabel,TValue>) : ItemMapping<TNodeLabel,TValue>Adds data per node labels in the graph that will be added to the LayoutGraph.
Remarks
You may either specify an existing mapping that is convertible to ItemMapping<TItem,TValue> or omit the parameter and use the return value to initialize the mapping.
Type Parameters
- TValue
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - NodeLabelDataKey<TValue>
- The key under which the data will be registered in the LayoutGraph's map of data providers
- itemMapping - ItemMappingConvertible<TNodeLabel,TValue>
- The mapping to add.
Returns
- ↪ItemMapping<TNodeLabel,TValue>
- An ItemMapping<TItem,TValue> for labels at nodes.
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify insets for each node, letting the data create the mapping for us
const insets = layoutData.addItemMapping(
LayoutKeys.NODE_MARGIN_DATA_KEY,
).mapper
const labelInsets = new Insets(10)
for (const node of graph.nodes) {
insets.set(node, node.labels.size > 0 ? labelInsets : Insets.EMPTY)
}
// specify port candidate for the edges
const fixedPortCandidates = new EdgePortCandidates().addFixedCandidate(
PortSides.TOP,
)
// and register the information in the data
layoutData.addItemMapping(
EdgePortCandidates.SOURCE_PORT_CANDIDATES_DATA_KEY,
).mapperFunction = (edge) =>
isFixedEdge(edge) ? fixedPortCandidates : null
// run the custom layout, passing in the data
graph.applyLayout(new MyLayout(), layoutData)addItemMapping
<TValue>(dataKey: EdgeLabelDataKey<TValue>, itemMapping?: ItemMappingConvertible<TEdgeLabel,TValue>) : ItemMapping<TEdgeLabel,TValue>Adds data per edge label in the graph that will be added to the LayoutGraph.
Remarks
You may either specify an existing mapping that is convertible to ItemMapping<TItem,TValue> or omit the parameter and use the return value to initialize the mapping.
Type Parameters
- TValue
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- dataKey - EdgeLabelDataKey<TValue>
- The key under which the data will be registered in the LayoutGraph's map of data providers
- itemMapping - ItemMappingConvertible<TEdgeLabel,TValue>
- The mapping to add.
Returns
- ↪ItemMapping<TEdgeLabel,TValue>
- An ItemMapping<TItem,TValue> for labels at edges.
Examples
// create the container for the data
const layoutData = new GenericLayoutData()
// specify insets for each node, letting the data create the mapping for us
const insets = layoutData.addItemMapping(
LayoutKeys.NODE_MARGIN_DATA_KEY,
).mapper
const labelInsets = new Insets(10)
for (const node of graph.nodes) {
insets.set(node, node.labels.size > 0 ? labelInsets : Insets.EMPTY)
}
// specify port candidate for the edges
const fixedPortCandidates = new EdgePortCandidates().addFixedCandidate(
PortSides.TOP,
)
// and register the information in the data
layoutData.addItemMapping(
EdgePortCandidates.SOURCE_PORT_CANDIDATES_DATA_KEY,
).mapperFunction = (edge) =>
isFixedEdge(edge) ? fixedPortCandidates : null
// run the custom layout, passing in the data
graph.applyLayout(new MyLayout(), layoutData)combineWith
(data: LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>…) : LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>Combines this instance with the given layout data.
Remarks
This keeps the current instance unmodified and instead returns a new instance that dynamically combines the contents of all involved instances.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- data - LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> to combine this instance with.
Returns
- ↪LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
- The combined layout data.
See Also
CompositeLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>,
GenericLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>,
Combining Layout Data