Home > @i2analyze/notebook-sdk > commands > IAction > setDescription

commands.IAction.setDescription() method

Sets the description of the action. For example, "Undo add Gene Hendricks".

Signature:

setDescription(value: string): void;

Introduced: version 1.0

Parameters

Parameter	Type	Description
value	string	A description of the action.

Returns:

void

Remarks

The action description does not appear in button labels, but does appear in tooltips and other locations.