TemporaryGroupDescriptor

This class allows specifying temporary groups for nodes that are considered by the TemporaryGroupNodeInsertionStage.

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 a IDataProvider registered with key TEMPORARY_GROUP_DESCRIPTOR_DP_KEY. 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: layout-core
yfiles-umd modules: All layout modules, view-layout-bridge
Legacy UMD name: yfiles.layout.TemporaryGroupDescriptor

Constructors

TemporaryGroupDescriptor

(parent?: TemporaryGroupDescriptor, recursiveGroupLayoutAlgorithm?: ILayoutAlgorithm)

Creates a new instance of TemporaryGroupDescriptor using the given descriptor as parent and the layout algorithm that is considered by the RecursiveGroupLayout.

Remarks

If the applied TemporaryGroupNodeInsertionStage uses the RecursiveGroupLayout as core layout algorithm, 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 in a IDataProvider registered with key GROUP_NODE_LAYOUT_DP_KEY.

ParametersOptions Overload

options - Object
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
insets - YInsets: The insets of this temporary group or null if the group has no insets. This option sets the insets property on the created object.
minimumSize - YDimension: The minimum size of this temporary group or null if the group has no minimum size constraint. This option sets the minimumSize property on the created object.
halo - NodeHalo: The halo of this temporary group or null if the group has no halo. This option sets the halo property on the created object.

The specified recursive group layout algorithm is only considered if the used core layout algorithm is of type RecursiveGroupLayout.

Properties

computedBounds

: YRectangle

Gets the bounds of this temporary group.

If the TemporaryGroupNodeInsertionStage uses a core layout algorithm that can handle group nodes, all nodes associated with this temporary group should be placed within the returned bounds.

halo

: NodeHalo

Gets or sets the halo of this temporary group or null if the group has no halo.

Default Value

The default value is null.

The temporary group has no halo.

The specified halo is only considered if the TemporaryGroupNodeInsertionStage uses a core layout algorithm that can handle group nodes and node halos.

insets

: YInsets

Gets or sets the insets of this temporary group or null if the group has no insets.

Default Value

The default value is null.

The temporary group has no insets.

The specified insets are only considered if the TemporaryGroupNodeInsertionStage uses a core layout algorithm that can handle group nodes.

minimumSize

: YDimension

Gets or sets the minimum size of this temporary group or null if the group has no minimum size constraint.

Default Value

The default value is null.

The temporary group has no minimum size constraint.

The specified minimum size is only considered if the TemporaryGroupNodeInsertionStage uses a core layout algorithm that can handle group nodes and minimum group sizes.

parent

: TemporaryGroupDescriptor

Gets or sets the parent group of this temporary group.

Default Value

The default value is null.

recursiveGroupLayoutAlgorithm

: ILayoutAlgorithm

Gets or sets the layout algorithm that is considered by the RecursiveGroupLayout when arranging the nodes belonging to this temporary group.

Remarks

Default Value

The default value is null.

The specified recursive group layout algorithm is only considered if the used core layout algorithm is of type RecursiveGroupLayout.