This class allows specifying temporary groups for nodes that are considered by the TemporaryGroupInsertionStage.
Inheritance Hierarchy
TemporaryGroupDescriptor
Remarks
More precisely, nodes mapped to the same TemporaryGroupDescriptor instance will form a temporary group inserted by the stage. This mapping is specified by property temporaryGroups. A TemporaryGroupDescriptor may have a reference to its parent which allows to create a hierarchically nested grouping structure.
Default Values of Properties
Type Details
- yFiles module
- algorithms
Constructors
TemporaryGroupDescriptor
(parent?: TemporaryGroupDescriptor, recursiveGroupLayoutAlgorithm?: ILayoutAlgorithm)Creates a new instance of TemporaryGroupDescriptor using the given descriptor as parent and the ILayoutAlgorithm that is considered by the RecursiveGroupLayout.
Remarks
If the applied TemporaryGroupInsertionStage uses the RecursiveGroupLayout as coreLayout, the recursive group layout algorithm specified here is responsible for the arrangement of the nodes belonging to this temporary group. Internally, the temporary inserted group node that encloses the nodes is automatically mapped by property groupNodeLayouts.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- parent - TemporaryGroupDescriptor
- the parent temporary group of this group
- recursiveGroupLayoutAlgorithm - ILayoutAlgorithm
- the layout algorithm that is applied in each recursion step
- padding - Insets
- minimumSize - Size
- The minimum size of this temporary group. This option sets the minimumSize property on the created object.
- margins - Insets
- computedBounds - Rect
- The bounds of this temporary group. This option sets the computedBounds property on the created object.
The specified recursive group layout algorithm is only considered if the used coreLayout is of type RecursiveGroupLayout.
Properties
Gets the bounds of this temporary group.
Remarks
If the bounds have not yet been computed, the value is of this property EMPTY.
Property Value
the bounds of the temporary group
If the TemporaryGroupInsertionStage uses a coreLayout that can handle group nodes, all nodes associated with this temporary group should be placed within the returned bounds.
Gets or sets the margins of this temporary group.
Default Value
Property Value
The margins of the temporary group
The specified margins are only considered if the TemporaryGroupInsertionStage uses a coreLayout that can handle group nodes and node margins.
Gets or sets the minimum size of this temporary group.
Default Value
Property Value
The minimum size of this temporary group.
The specified minimum size is only considered if the TemporaryGroupInsertionStage uses a coreLayout that can handle group nodes and minimum group sizes.
Gets or sets the padding of this temporary group.
Default Value
Property Value
The padding of this temporary group.
The specified padding is only considered if the TemporaryGroupInsertionStage uses a coreLayout that can handle group nodes.
Gets or sets the parent group of this temporary group.
Gets or sets the ILayoutAlgorithm that is considered by the RecursiveGroupLayout when arranging the nodes belonging to this temporary group.
Remarks
If the applied TemporaryGroupInsertionStage uses the RecursiveGroupLayout as coreLayout, the recursive group layout algorithm specified here is responsible for the arrangement of the nodes belonging to this temporary group. Internally, the temporary inserted group node that encloses the nodes is automatically mapped by property groupNodeLayouts.
Default Value
The default value is
null.Property Value
The ILayoutAlgorithm that is considered by the RecursiveGroupLayout.
The specified recursive group layout algorithm is only considered if the used coreLayout is of type RecursiveGroupLayout.