Home > @i2analyze/notebook-sdk > commands > IActionArea
commands.IActionArea interface
An area of the i2 Notebook user interface that can display actions and groups of actions.
Signature:
interface IActionArea<TSystemGroups>
Introduced: version 1.0
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TSystemGroups | any | The type of the list of system action groups in the area. |
Remarks
To retrieve areas that represent the entire application ribbon or pop-up menu, use the properties of commands.ICommandApi.
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. |
Methods
| Method | Description |
|---|---|
| addGroup(group) | Adds the specified group of actions to the user interface. |
| addOrGetGroup(group) | Adds the specified group of actions to the user interface, or gets an existing group with the same identifier. |
| after(id) | Locates the area of the user interface that appears immediately after a particular action or group of actions. |
| after(command) | Locates the area of the user interface that appears immediately after the action that represents the specified command. |
| before(id) | Locates the area of the user interface that appears immediately before a particular action or group of actions. |
| before(command) | Locates the area of the user interface that appears immediately before the action that represents the specified command. |
| getGroup(id) | Locates the area of the user interface that is occupied by a particular group of actions. |
| remove(id) | Removes an action or group of actions from the user interface. |
| surfaceCommands(commandsOrCommandIds) | Adds actions for the specified registered commands to the user interface. |