Batch (engine/model)
@ckeditor/ckeditor5-engine/src/model/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' );
} );
Filtering
Properties
-
Returns 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. -
Whether the batch includes operations created locally (
true) or operations created on other, remote editors (false). -
Whether the batch includes operations connected with typing.
-
Whether the batch was created by the undo feature and undoes other operations.
-
Whether the batch can be undone through the undo feature.
-
An array of operations that compose this batch.
-
The type of the batch.
This property has been deprecated and is always set to the
'default'value.It can be one of the following values:
'default'– All "normal" batches. This is the most commonly used type.'transparent'– A batch that should be ignored by other features, i.e. an initial batch or collaborative editing changes.
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
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.