Class Command`Abstract`

A Command is an action that can be done, redone, and undone. It's used to enable undo/redo.

See Editor.dispatch.

Hierarchy (View Summary)

Command
- SerializableCommand

Index

Constructors

Properties

Methods

apply description onDrop unapply union

Constructors

constructor

new Command(): Command
Returns Command

Properties

`Static` `Readonly`empty

empty: (Anonymous class) = ...

Methods

`Abstract`apply

apply(editor: Editor): void | Promise<void>
Parameters
- editor: Editor
Returns void | Promise<void>
- Defined in commands/Command.ts:10

`Abstract`description

description(editor: Editor, localizationTable: EditorLocalization): string
Parameters
- editor: Editor
- localizationTable: EditorLocalization
Returns string
- Defined in commands/Command.ts:16

onDrop

onDrop(_editor: Editor): void
Called when the command is being deleted
Parameters
- _editor: Editor
Returns void
- Defined in commands/Command.ts:14

`Abstract`unapply

unapply(editor: Editor): void | Promise<void>
Parameters
- editor: Editor
Returns void | Promise<void>
- Defined in commands/Command.ts:11

`Static`union

union(a: Command, b: Command): Command
Parameters
- a: Command
- b: Command
Returns Command
Deprecated
Use uniteCommands
- Defined in commands/Command.ts:19

OpenSource licenses