Home > @i2analyze/notebook-sdk > commands > IAction
commands.IAction interface
A representation of a command in the user interface. An action is created when a command is surfaced.
Signature:
interface IAction
Introduced: version 1.0
Methods
| Method | Description |
|---|---|
| setDescription(value) | Sets the description of the action. For example, "Undo add Gene Hendricks". |
| setEnabled(value) | Sets whether the action is enabled - that is, whether it is available for users to interact with. |
| setHidden(value) | Sets whether the action is hidden - that is, whether it is visible to users at all. |
| setIcon(value) | Sets the icon for the action. |
| setToggledState(value) | Sets whether the action is toggled "on" or "off" - that is, whether it appears to be active or inactive. |