Specifies custom data for the FixNodeLayoutStage.
Examples
The following example shows how to create a new instance of FixNodeLayoutData and use it with an FixNodeLayoutStage:
// Create layout data for both the FixNodeLayoutStage and the layout that's actually being run
// first create and configure the actual layout data object
const organicLayoutData = new OrganicLayoutData()
// Configure the organic layout data object ...
const fixNodeLayoutData = new FixNodeLayoutData()
fixNodeLayoutData.fixedNodes = graphComponent.selection.selectedNodes
// Wrap both into a single layout data
const layoutData = fixNodeLayoutData.combineWith(organicLayoutData)
// Run the layout
graphComponent.graph.applyLayout(
new FixNodeLayoutStage(new OrganicLayout()),
layoutData
)In many cases the complete initialization of FixNodeLayoutData can also be done in a single object initializer:
// Create layout data for both the FixNodeLayoutStage and the layout that's actually being run
const fixNodeLayoutData = new FixNodeLayoutData({
fixedNodes: graphComponent.selection.selectedNodes
})
const organicLayoutData = new OrganicLayoutData({
// Configure the other layout data object ...
})
// Wrap both into a CompositeLayoutData
const layoutData = new CompositeLayoutData(
fixNodeLayoutData,
organicLayoutData
)
// Run the layout
graphComponent.graph.applyLayout(
new FixNodeLayoutStage(new OrganicLayout()),
layoutData
)Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.layout.FixNodeLayoutData
Constructors
Creates a new instance of FixNodeLayoutData which helps configuring FixNodeLayoutStage.
Parameters
A map of options to pass to the method.
- fixedNodes - ItemCollection<INode>
The collection of nodes which should remain fixed. This option sets the fixedNodes property on the created object.
Properties
Gets or sets the collection of nodes which should remain fixed.
Remarks
Examples
If only a single node should be fixed, then the easiest option is item:
layoutData.fixedNodes.item = nodeIn case multiple nodes should be fixed and they're already in a collection or IEnumerable<T>, the source option is usually the most convenient:
layoutData.fixedNodes = graphComponent.selection.selectedNodesIf they're not already in a collection or need to be collected one at a time, there's also the items property, which holds a collection that can be filled:
layoutData.fixedNodes.items.add(node1)
layoutData.fixedNodes.items.add(node2)And finally, if it's easy to determine from each node whether it should be fixed or not, then the delegate option tends to be the easiest to use:
layoutData.fixedNodes = (node) => node.tag.isFixedlayoutData.fixedNodes = (node: INode): boolean => node.tag.isFixedSee Also
Sample Graphs
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.