Home > @i2analyze/notebook-sdk > commands > ICommandGroup
commands.ICommandGroup interface
A split-button group.
Signature:
interface ICommandGroup<TCommandType extends CommandType = 'unscoped'> extends IGroupConfigBase<TCommandType>
Extends: IGroupConfigBase<TCommandType>
Introduced: version 1.10
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TCommandType | extends CommandType(default: 'unscoped') | The type of the command-context for the group. Defaults to 'unscoped'. |
Remarks
Has a primary command and a drop-down menu of related commands. In the ribbon this is displayed as a split button; in pop-up menus, as a menu entry that runs the primary command and has a submenu.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| context? |
readonly
| TCommandType | (Optional) Gets the command-context type, which determines what event API is passed to commands.IGroupConfigBase.onSurface(). (Inherited from IGroupConfigBase) |
| icon? |
readonly
| IIcon | (Optional) Gets the icon of the group, which is displayed if the group is collapsed. (Inherited from IGroupConfigBase) |
| id |
readonly
| GroupId | Gets the identifier of the group. This must be a non-empty string. (Inherited from IGroupBase) |
| isCollapsed? |
readonly
| boolean |
(Optional) Indicates whether the group is initially expanded (false) or collapsed (true) in the user interface.
(Inherited from IGroupBase)
|
| label? |
readonly
| string | (Optional) Gets the label of the group. (Inherited from IGroupConfigBase) |
| popoutStyle? |
readonly
| 'ribbon' | (Optional) Gets the popup style for the group's trigger button. (Inherited from IGroupConfigBase) |
| primaryCommand? |
readonly
| ICommand | CommandId | (Optional) Gets the group's primary command, as a command or command identifier. |
| type |
readonly
| 'command' |
Gets the render type, always 'command' for a split-button group.
|
Methods
| Method | Description |
|---|---|
| onSurface(groupAction, eventApi, signal)? | (Optional) Runs when an action derived from the group is surfaced, enabling the group to configure the action in response to events. (Inherited from IGroupConfigBase) |