Batch
A batch instance groups model changes (operations). All operations
grouped in a single batch can be reverted together, so you can also think about a batch as of a single undo step. If you want
to extend a given undo step, you can add more changes to the batch using enqueueChange:
model.enqueueChange( batch, writer => {
writer.insertText( 'foo', paragraph, 'end' );
} );
Properties
-
baseVersion : null | numberreadonlymodule:engine/model/batch~Batch#baseVersionReturns the base version of this batch, which is equal to the base version of the first operation in the batch. If there are no operations in the batch or neither operation has the base version set, it returns
null. -
isLocal : booleanreadonlymodule:engine/model/batch~Batch#isLocalWhether the batch includes operations created locally (
true) or operations created on other, remote editors (false). -
isTyping : booleanreadonlymodule:engine/model/batch~Batch#isTypingWhether the batch includes operations connected with typing.
-
isUndo : booleanreadonlymodule:engine/model/batch~Batch#isUndoWhether the batch was created by the undo feature and undoes other operations.
-
isUndoable : booleanreadonlymodule:engine/model/batch~Batch#isUndoableWhether the batch can be undone through the undo feature.
-
operations : Array<Operation>readonlymodule:engine/model/batch~Batch#operationsAn array of operations that compose this batch.
Methods
-
constructor( type )module:engine/model/batch~Batch#constructorCreates a batch instance.
Parameters
type : BatchTypeA set of flags that specify the type of the batch. Batch type can alter how some of the features work when encountering a given
Batchinstance (for example, when a feature listens to applied operations).Defaults to
{}
Related:
-
addOperation( operation ) → Operationmodule:engine/model/batch~Batch#addOperation