Class Command<TData>Abstract

constructor

• new Command<TData = void>(viewer: Viewer): Command<TData>

  Type Parameters

  • TData = void

  Parameters

  • viewer: Viewer

  Returns Command<TData>

AbstractisUndoable

ReadonlyisUpdatable

Abstract Readonlyname

hasBeenExecuted

• get hasBeenExecuted(): boolean

  Returns boolean

_clean

• _clean(): Promise<void>

  Cleans the command footprint.

  Returns Promise<void>

equals

• equals(cmd: this): boolean

  Parameters

  • cmd: this

  Returns boolean

execute

• execute(options?: ExecuteCommandOptions): Promise<TData>

  Execute the command

  Parameters

  • options: ExecuteCommandOptions = {}

  Returns Promise<TData>

toggle

• toggle(options?: CommandOptions): Promise<void | TData>

  Toggle the command

  Parameters

  • options: CommandOptions = {}

  Returns Promise<void | TData>

undo

• undo(options?: UndoCommandOptions): Promise<void>

  Undo the command

  Parameters

  • options: UndoCommandOptions = {}

  Returns Promise<void>

update

• update(..._params: unknown[]): Promise<void>

  Updates the command with a latest version of the required parameters.

  The update method can be called during continuous user interactions (such as mousemove, mousedrag or color changes) where the command to fire can be updated accordingly to the user inputs instead of creating a new command for each value.

  Note

  • The attribute isUpdatable indicates if a command can be updated (otherwise an error is thrown)

  Parameters

  • ..._params: unknown[]

  Returns Promise<void>