Class SetOptionCommand<T>

Changes a viewer option value.

Type Parameters

T

Hierarchy (View Summary)

Command
- SetOptionCommand

Index

Constructors

Properties

isUndoable isUpdatable name

Accessors

hasBeenExecuted

Methods

_clean _do _undo equals execute toggle undo update

Constructors

constructor

new SetOptionCommand<T>(
    viewer: Viewer,
    controller: ValueController<T>,
    newValue: T,
): SetOptionCommand<T>
Type Parameters
- T
Parameters
- viewer: Viewer
  Viewer object
- controller: ValueController<T>
  The viewer option controller to change to value
- newValue: T
  The new value for the option controller
Returns SetOptionCommand<T>
Overrides Command.constructor
- Defined in src/viewer/command/SetOptionCommand.ts:23

Properties

isUndoable

isUndoable: boolean = false

Indicates whether the command is undoable and redoable

`Readonly`isUpdatable

isUpdatable: true

Indicated whether the command can be updated

`Readonly`name

name: "SetOptionCommand" = 'SetOptionCommand'

Name of the command

Accessors

hasBeenExecuted

get hasBeenExecuted(): boolean
Returns boolean
Inherited from Command.hasBeenExecuted
- Defined in src/viewer/command/Command.ts:46

Methods

_clean

_clean(): Promise<void>
Cleans the command footprint.

Returns Promise<void>
Inherited from Command._clean
- Defined in src/viewer/command/Command.ts:142

_do

_do(): Promise<void>
Actions to execute during the execute method

Returns Promise<void>
Overrides Command._do
- Defined in src/viewer/command/SetOptionCommand.ts:32

_undo

_undo(): Promise<void>
Actions to execute during the undo method

Returns Promise<void>
Overrides Command._undo
- Defined in src/viewer/command/SetOptionCommand.ts:36

equals

equals(cmd: this): boolean
Parameters
- cmd: this
Returns boolean
Inherited from Command.equals
- Defined in src/viewer/command/Command.ts:146

execute

execute(options?: ExecuteCommandOptions): Promise<void>
Execute the command
Parameters
- options: ExecuteCommandOptions = {}
Returns Promise<void>
Inherited from Command.execute
- Defined in src/viewer/command/Command.ts:55

toggle

toggle(options?: CommandOptions): Promise<void>
Toggle the command
Parameters
- options: CommandOptions = {}
Returns Promise<void>
Inherited from Command.toggle
- Defined in src/viewer/command/Command.ts:107

undo

undo(options?: UndoCommandOptions): Promise<void>
Undo the command
Parameters
- options: UndoCommandOptions = {}
Returns Promise<void>
Inherited from Command.undo
- Defined in src/viewer/command/Command.ts:82

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>
Inherited from Command.update
- Defined in src/viewer/command/Command.ts:161