Home > @i2analyze/notebook-sdk > commands > ICommandConfig
commands.ICommandConfig interface
A set of information that is necessary in order to register an i2 Notebook command.
Signature:
interface ICommandConfig<TCommandType extends CommandType> extends ICommandConfigBase
Extends: ICommandConfigBase
Introduced: version 1.0
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TCommandType | extends CommandType | The type of the command, which determines what payload it receives. |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| icon | readonly |
IIcon | Gets the icon for the command. (Inherited from ICommandConfigBase) |
| id | readonly |
CommandId | Gets the identifier of the command, which must be a lower-case GUID. (Inherited from ICommandConfigBase) |
| keyboardHelp? | readonly |
ICommandKeyboardHelp | (Optional) Gets the keyboard help for the command. (Inherited from ICommandConfigBase) |
| name | readonly |
string | Gets the name of the command. For example, "Quick Search". (Inherited from ICommandConfigBase) |
| type | readonly |
TCommandType | Gets the type of the command. |
Methods
| Method | Description |
|---|---|
| onExecute(payload) | Runs when the command is executed. |
| onSurface(action, eventApi, signal)? | (Optional) Runs when an action derived from the command is surfaced, enabling the command to configure the action in response to events. |