Home > @i2analyze/notebook-sdk > commands > IGroupTemplate
commands.IGroupTemplate interface
A detached group of actions that you build once and surface into one or more areas.
Signature:
interface IGroupTemplate extends IActionArea<undefined>
Extends: IActionArea<undefined>
Introduced: version 1.10
Remarks
Create a template with commands.ICommandApi.createGroup(), build its contents using the inherited commands.IActionArea methods, then add it to areas with commands.IActionArea.surfaceGroup(). Because the template carries its own group and command identifiers, a single template can be surfaced into several areas without rebuilding it. Nothing appears in the user interface until the template is surfaced.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| systemGroups |
readonly
| TSystemGroups | Gets the system groups for the action area, which you can use to specify relative locations for your actions and groups. (Inherited from IActionArea) |
Methods
| Method | Description |
|---|---|
| addDynamicGroup(config) | Adds a dynamic group whose commands are created on demand each time the group is opened. (Inherited from IActionArea) |
| addGroup(group) | Adds the specified group of actions to the user interface. (Inherited from IActionArea) |
| addOrGetGroup(group) | Adds the specified group of actions to the user interface, or gets an existing group with the same identifier. (Inherited from IActionArea) |
| after(id) | Locates the area of the user interface that appears immediately after a particular action or group of actions. (Inherited from IActionArea) |
| after(command) | Locates the area of the user interface that appears immediately after the action that represents the specified command. (Inherited from IActionArea) |
| before(id) | Locates the area of the user interface that appears immediately before a particular action or group of actions. (Inherited from IActionArea) |
| before(command) | Locates the area of the user interface that appears immediately before the action that represents the specified command. (Inherited from IActionArea) |
| getGroup(id) | Locates the area of the user interface that is occupied by a particular group of actions. (Inherited from IActionArea) |
| remove(id) | Removes an action or group of actions from the user interface. (Inherited from IActionArea) |
| surfaceCommands(commandsOrCommandIds) | Adds actions for the specified registered commands to the user interface. (Inherited from IActionArea) |
| surfaceGroup(group) | Surfaces a detached group, created with commands.ICommandApi.createGroup(), and its contents into the user interface. (Inherited from IActionArea) |