Documentation - v20.0.0-dev
    Preparing search index...

    Sets the value of a setting (e.g. viewer.settings.helpers.gridSize), undoable: undo gives it back the value it had when executed. Updatable, for a value changed continuously (a slider): update changes it again, one step in the history.

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    isUndoable: boolean = true

    Indicates whether the command is undoable and redoable

    isUpdatable: true

    Indicated whether the command can be updated

    name: "SetSettingCommand" = 'SetSettingCommand'

    Name of the command

    viewer: Viewer

    Accessors

    • get hasBeenExecuted(): boolean

      Returns boolean

    Methods

    • Cleans the command footprint.

      Returns Promise<void>

    • Actions to execute during the execute method

      Returns Promise<void>

    • Actions to execute during the undo method

      Returns Promise<void>

    • Parameters

      • cmd: this

      Returns boolean

    • Toggle the command

      Parameters

      Returns Promise<void>

    • Sets another value, the value to restore on undo kept.

      Parameters

      • newValue: T

        The value to set.

      Returns Promise<void>