Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface describing a toolbar item widget

Hierarchy

Index

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: "command" | "spacer"

The type of the toolbar item.

Generated using TypeDoc