Group class
📖 Description
The Group class defines a group of controls for the Tripetto builder.
🆕 constructor
Creates a new Group instance.
Signature
constructor(controls: Control[]): Group
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
controls | Control[] | No | Specifies the controls for the group. |
Return value
Returns a reference to the new Group instance.
🗃️ Fields
🏷️ controls
Retrieves the controls in the group.
Type
🏷️ isDisabled
Sets or retrieves if the group is disabled.
Type
boolean
🏷️ isLocked
Sets or retrieves if the group is locked (readonly).
Type
boolean
🏷️ isVisible
Sets or retrieves if the group is visible.
Type
boolean
▶️ Methods
🔧 disable
Disables the group.
Signature
disable(): this
Return value
Returns a reference to the Group instance to allow chaining.
🔧 disabled
Specifies the state of the group.
Signature
disabled(disabled: boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
disabled | boolean | No | Specifies if the group is disabled. |
Return value
Returns a reference to the Group instance to allow chaining.
🔧 enable
Enables the group.
Signature
enable(): this
Return value
Returns a reference to the Group instance to allow chaining.
🔧 hide
Hides the group.
Signature
hide(): this
Return value
Returns a reference to the Group instance to allow chaining.
🔧 lock
Locks the group.
Signature
lock(): this
Return value
Returns a reference to the Group instance to allow chaining.
🔧 locked
Specifies if the group is locked (readonly).
Signature
locked(locked?: boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
locked | boolean | Yes | Specifies if the group is locked (readonly). |
Return value
Returns a reference to the Group instance to allow chaining.
🔧 readonly
Makes the group readonly.
Signature
readonly(): this
Return value
Returns a reference to the Group instance to allow chaining.
🔧 show
Shows the group.
Signature
show(): this
Return value
Returns a reference to the Group instance to allow chaining.
🔧 unlock
Unlocks the group.
Signature
unlock(): this
Return value
Returns a reference to the Group instance to allow chaining.
🔧 visible
Specifies the visibility of the group.
Signature
visible(visible: boolean): this
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
visible | boolean | No | Specifies if the group is visible. |
Return value
Returns a reference to the Group instance to allow chaining.