Interface IToolbarItem

An interface describing a toolbar item.

interface IToolbarItem {
    args?: PartialJSONObject;
    command?: string;
    disabled?: boolean;
    icon?: string;
    label?: string;
    name: string;
    rank?: number;
    type?: "spacer" | "command";
}

Hierarchy

  • PartialJSONObject
    • IToolbarItem

    Properties

    args? command? disabled? icon? label? name rank? type?

    Properties

    Optional args

    args?: PartialJSONObject

    The arguments for the command.

    The default value is an empty object.

    Optional command

    command?: string

    The command to execute when the item is triggered.

    The default value is an empty string.

    Optional disabled

    disabled?: boolean

    Whether the toolbar item is ignored (i.e. not created). false by default.

    Notes

    This allows an user to suppress toolbar items.

    Optional icon

    icon?: string

    Item icon id

    Note

    The id will be looked for in the LabIcon registry. The command icon will be overridden by this label if defined.

    Optional label

    label?: string

    Item label

    Note

    The command label will be overridden by this label if defined.

    name

    name: string

    Unique toolbar item name

    Optional rank

    rank?: number

    The rank order of the toolbar item among its siblings.

    Optional type

    type?: "spacer" | "command"

    The type of the toolbar item.

    Settings

    Member Visibility

    Theme

    On This Page

    argscommanddisablediconlabelnameranktype