i2 Notebook SDK
Search results for

    Show/hide table of contents

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

    commands.IGroup type

    A group of actions in either the i2 Notebook application ribbon or a popup menu.

    Signature:

    type IGroup<TCommandType extends CommandType = 'unscoped'> = IStandardGroup<TCommandType> | ICommandGroup<TCommandType>;
    

    References: CommandType, IStandardGroup, ICommandGroup

    Introduced: version 1.0

    Type Parameters

    Parameter Type Description
    TCommandType extends CommandType(default: 'unscoped') The type of the command-context for the group, which determines what event API is passed to its onSurface. Defaults to 'unscoped'.

    Remarks

    Either a non-split commands.IStandardGroup (inline, collapsed, or stacked) or a split-button commands.ICommandGroup (type: 'command'). The type discriminates between them, so primaryCommand is allowed only when type is 'command'. If a command group omits primaryCommand, the first command that is surfaced in it is the primary command.

    In this article
    Back to top © N. Harris Computer Corporation