Function recordUndoCommand

  • recordUndoCommand<
        T extends
            | JSUndoManagerCommand
            | SetValueUndoCommand<
                PrimitiveVal,
                string,
                any,
                SetValueUndoCommandProps<PrimitiveVal>,
                any,
            >
            | ActionUndoCommand<string, any, any[]>,
    >(
        um: undefined | JSUndoManager,
        com: T,
        setValueCommandType: string,
        undoEditingWaitTime?: number,
    ): undefined | JSUndoManager

  • Records an undo command in the undo manager, supports merging of subsequent setValue commands. See uiconfig.js or threepipe UndoManagerPlugin for usage.

    Type Parameters

    Parameters

    • um: undefined | JSUndoManager

      the undo manager to record the command in, if undefined, or not enabled the command will not be recorded

    • com: T

      the command to record, should be of type SetValueUndoCommand, ActionUndoCommand or JSUndoManagerCommand

    • setValueCommandType: string

      command type for the setValue command, used to identify the command type for merging

    • undoEditingWaitTime: number = 2000

      time in milliseconds to wait before considering the command final, defaults to 2000ms

    Returns undefined | JSUndoManager

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR