This interface merges two ILayers instances whose nodes reside in the same graph.
Inheritance Hierarchy
ILayeredComponentsMerger
Remarks
Implementations of this interface may provide different strategies for merging.
Default implementations of this interface are used internally by HierarchicLayoutCore and MultiComponentLayerer when e.g. the graph is grouped or it consists of more than one connected component.
Type Details
- yfiles module
- layout-hierarchic
- yfiles-umd modules
- layout-familytree, layout-hierarchic, layout-radial, layout
- Legacy UMD name
- yfiles.hierarchic.ILayeredComponentsMerger
Methods
Merges two ILayers instances.
Remarks
All nodes that belong to the source and target ILayers are part of the graph at the moment of invocation.
The state of the source ILayers instance is discarded after this call and does not need to be updated to reflect the changes. The target ILayers instance must be updated accordingly.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- graph - LayoutGraph
- the graph containing the nodes of source and target ILayers instances
- ldp - ILayoutDataProvider
- the ILayoutDataProvider used for querying the layer indices
- srcLayers - ILayers
- targetLayers - ILayers
- the ILayers instance that will be modified to contain the resulting layering