A HierarchicalLayoutSubcomponentDescriptor defines settings for subcomponents that are arranged by a different layout algorithm than their containing graph for HierarchicalLayout.
Inheritance Hierarchy
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
| Name | Default | Description |
|---|---|---|
| layoutAlgorithm | null | |
| placementPolicy | HierarchicalLayoutSubcomponentPlacementPolicy.AUTOMATIC | It is automatically determined how the subcomponent is placed. |
See Also
Developer's Guide
API
- subcomponents
Members
No filters for this type
Constructors
HierarchicalLayoutSubcomponentDescriptor
(layoutAlgorithm?: ILayoutAlgorithm, placementPolicy?: HierarchicalLayoutSubcomponentPlacementPolicy)Creates a new HierarchicalLayoutSubcomponentDescriptor instance with the specified settings.
HierarchicalLayoutSubcomponentDescriptor
(layoutAlgorithm?: ILayoutAlgorithm, placementPolicy?: HierarchicalLayoutSubcomponentPlacementPolicy)Creates a new HierarchicalLayoutSubcomponentDescriptor instance with the specified settings.
Parameters
- 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.
Gets or sets the ILayoutAlgorithm for the subgraph that is induced by the nodes associated with this descriptor.
It is possible to define another HierarchicalLayout instance as layout algorithm responsible for the component. This way, different hierarchical layout styles can be conveniently combined into one layout (e.g. layouts with different orientations). The best layout results are achieved if a is connected to only a single other connector node . In that case this connector can be embedded in both the main layout and the inner layout. A condition for this is that the orientations of the two layouts are orthogonal with respect to each other, e.g., one top-to-bottom orientation and one left-to-right orientation.
final
Property Value
The ILayoutAlgorithm handling the subgraph that is induced by the nodes associated with this descriptor.
Default Value
The default value is: null
Sample Graphs
ShownSetting: Subcomponent in TreeLayout
See Also
Developer's Guide
Gets or sets the policy defining how the subcomponent is placed within the layout context of the remaining graph.
Gets or sets the policy defining how the subcomponent is placed within the layout context of the remaining graph.
conversionfinal
Property Value
The policy defining how the subcomponent is placed within the layout context of the remaining graph.
Default Value
The default value is: HierarchicalLayoutSubcomponentPlacementPolicy.AUTOMATIC
It is automatically determined how the subcomponent is placed.
See Also
Developer's Guide
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.
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.
This convenience method can be used to determine if a subcomponent is a possible candidate for integrated placement when using the policies ALWAYS_INTEGRATED or AUTOMATIC.
final
Parameters
- graph: LayoutGraph
- The graph containing the subcomponent.
Return Value
- LayoutNode
- The only node outside the subcomponent with edges connecting to nodes within the subcomponent if such a node exists,
nullotherwise.