Skip to main content

Home > @jsplumbtoolkit/browser-ui > UIGroupDefinition

UIGroupDefinition interface#

Definition of a group in the view.

Signature:

export interface UIGroupDefinition extends UIVertexDefinition<Group>, GroupDefinition 

Extends: UIVertexDefinition<Group>, GroupDefinition

Properties#

PropertyTypeDescription
autoGrow?boolean(Optional) Defaults to false, meaning that the group will not be resized if an item addition/removal or drag causes the bounds of the child members to change and the new size is greater than the previous size.
autoShrink?boolean(Optional) Defaults to false, meaning that the group will not be resized if an item addition/removal or drag causes the bounds of the child members to change and the new size is smaller than the previous size. If you set autoSize but also set a value for this (eg you set autoSize:true and autoShrink:false), this value will take precedence.
autoSize?boolean(Optional) Defaults to false. If true, the group's size will be automatically adjusted whenever items are added/removed, or dragged inside the group. Setting this flag to true is the same as setting both autoShrink and autoGrow. Note that this flag's value will be overridden by autoShrink and autoGrow, if they have values set.
ghost?boolean(Optional) Whether or not to show a 'ghost' element when an element inside the group is dragged to the point that it extends outside the bounds of the group. The original element remains inside the group. Defaults to false.
ghostProxyParent?any(Optional)
layout?{ type: string; options?: LayoutParameters; }(Optional) Layout spec for groups of this type. Groups default to having an Absolute layout.
maxSize?[number, number](Optional) Maximum size the group can grow to. If not specified the group can grow to an arbitrary size. Note that this behaviour can also be enforced via CSS.