Home > @i2analyze/notebook-sdk > commands > IGroupAction

commands.IGroupAction interface

A representation of a group of commands in the user interface. A group action is created when a group is surfaced.

Signature:

interface IGroupAction 

Introduced: version 1.10

Remarks

Group actions mirror commands.IAction for individual commands. They are passed to commands.IGroupConfigBase.onSurface() (for static groups) and commands.IDynamicGroupConfigBase.onSurface() (for the popup button of a dynamic group), allowing the group's label, icon, and enabled/hidden state to be driven from application state.

When a group is disabled and expanded, its immediate children are rendered as disabled too — disabling the group is therefore a render-time cascade, not a mutation of child state.

Methods

Method	Description
setEnabled(value)	Sets whether the group is enabled — that is, whether it is available for users to interact with.
setHidden(value)	Sets whether the group is hidden — that is, whether it is visible to users at all. Hidden groups do not render their container, label, or children.
setIcon(value)	Sets the icon for the group.
setName(value)	Sets the label of the group. For example, "Layouts".