Interface IWidget

Interface describing a toolbar item widget

interface IWidget {
    args?: PartialJSONObject;
    command?: string;
    disabled?: boolean;
    icon?: string;
    label?: string;
    name: string;
    rank?: number;
    type?: "spacer" | "command";
    [key: string]: undefined | PartialJSONValue;
}

Hierarchy (View Summary)

Indexable

Properties

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

Properties

Optionalargs

args?: PartialJSONObject

The arguments for the command.

The default value is an empty object.

Optionalcommand

command?: string

The command to execute when the item is triggered.

The default value is an empty string.

Optionaldisabled

disabled?: boolean

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

Notes

This allows an user to suppress toolbar items.

Optionalicon

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.

Optionallabel

label?: string

Item label

Note

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

name

name: string

Unique toolbar item name

Optionalrank

rank?: number

The rank order of the toolbar item among its siblings.

Optionaltype

type?: "spacer" | "command"

The type of the toolbar item.

Settings

Member Visibility

On This Page

Properties