Interface Command

Represents a reference to a command. Provides a title which will be used to represent a command in the UI and, optionally, an array of arguments which will be passed to the command handler function when invoked.

interface Command {
    arguments?: any[];
    command: string;
    title: string;
    tooltip?: string;
}

Properties

arguments? command title tooltip?

Properties

Optional arguments

arguments?: any[]

Arguments that the command handler should be invoked with.

command

command: string

The identifier of the actual command handler.

See

commands.registerCommand

title

title: string

Title of the command, like save.

Optional tooltip

tooltip?: string

A tooltip for the command, when represented in the UI.

Settings

Member Visibility

Theme

On This Page

argumentscommandtitletooltip