A HierarchicalLayoutSubcomponentDescriptor defines settings for subcomponents that are arranged by a different layout algorithm than their containing graph for HierarchicalLayout.
Remarks
Property layoutAlgorithm defines the algorithm that is responsible for arranging the subcomponent. The placementPolicy specifies the integration into the main hierarchical layout.
Nodes mapped to the same HierarchicalLayoutSubcomponentDescriptor instance form a component that is arranged as an independent sub-graph, induced by the component nodes. The mapping is retrieved from subcomponents. Components may not be nested, that is, a subcomponent is not allowed to contain nodes that belong to yet another subcomponent. Nesting of subcomponents results in an exception.
Default Values of Properties
| layoutAlgorithm | null | |
| placementPolicy | AUTOMATIC | It is automatically determined how the subcomponent is placed. |
Type Details
- yFiles module
- algorithms
See Also
Constructors
HierarchicalLayoutSubcomponentDescriptor
(layoutAlgorithm?: ILayoutAlgorithm, placementPolicy?: HierarchicalLayoutSubcomponentPlacementPolicy)Creates a new HierarchicalLayoutSubcomponentDescriptor instance with the specified settings.
Parameters
A map of options to pass to the method.
- layoutAlgorithm - ILayoutAlgorithm
- The layout algorithm handling the layout of the graph induced by the subcomponent.
- placementPolicy - HierarchicalLayoutSubcomponentPlacementPolicy
- The policy for placing the component into the layout context of the remaining graph.
Properties
Gets or sets the ILayoutAlgorithm for the subgraph that is induced by the nodes associated with this descriptor.
Default Value
null.Property Value
Sample Graphs
Gets or sets the policy defining how the subcomponent is placed within the layout context of the remaining graph.
Default Value
Property Value
Methods
Determines if there is a unique node outside the subcomponent whose removal would disconnect the component from the remaining graph and returns the node if it exists.
Parameters
A map of options to pass to the method.
- graph - LayoutGraph
- The graph containing the subcomponent.
Returns
- ↪LayoutNode?
- The only node outside the subcomponent with edges connecting to nodes within the subcomponent if such a node exists,
nullotherwise.