Home > @i2analyze/notebook-sdk > commands > ICommandApi
commands.ICommandApi interface
A collection of methods and properties that allow custom commands to interact with i2 Notebook.
Signature:
interface ICommandApi
Introduced: version 1.0
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| applicationRibbon | readonly |
IApplicationRibbon | Gets the area that represents the whole of the i2 Notebook application ribbon. |
| chartItemPopupMenu | readonly |
IActionArea<IChartItemPopupMenuSystemGroups> | Gets the area that represents the pop-up menu for chart items. |
| chartPopupMenu | readonly |
IActionArea<IChartPopupMenuSystemGroups> | Gets the area that represents the pop-up menu for chart items. |
| chartSurfacePopupMenu | readonly |
IActionArea<IChartSurfacePopupMenuSystemGroups> | Gets the area that represents the pop-up menu for the chart surface. |
| systemCommands | readonly |
ISystemCommands | Gets the command identifiers of the default system commands. |
Methods
| Method | Description |
|---|---|
| createCommand(config) | Creates a command, and registers it with the application. |
| createToolViewToggleCommand(config, toolview) | Creates a command that can open and close a tool view, and registers it with the application. |
| removeCommand(commandId) | Unregisters and removes a command and all its actions from the application. |