Operation (engine/model/operation)
@ckeditor/ckeditor5-engine/src/model/operation/operation
Abstract base operation class.
Filtering
Properties
-
readonly
affectedSelectable : Selectablemodule:engine/model/operation/operation~Operation#affectedSelectableA selectable that will be affected by the operation after it is executed.
The exact returned parameter differs between operation types.
-
baseVersion : null | numbermodule:engine/model/operation/operation~Operation#baseVersionversionon which operation can be applied. If you try to apply operation with different base version than the document version the model-document-applyOperation-wrong-version error is thrown. -
Batch to which the operation is added or
nullif the operation is not added to any batch yet. -
readonly
isDocumentOperation : booleanmodule:engine/model/operation/operation~Operation#isDocumentOperationDefines whether operation is executed on attached or detached items.
-
Operation type.
Static properties
-
Name of the operation class used for serialization.
Methods
-
constructor( baseVersion )module:engine/model/operation/operation~Operation#constructorBase operation constructor.
Parameters
baseVersion : null | numberDocument
versionon which operation can be applied ornullif the operation operates on detached (non-document) tree.
-
Creates and returns an operation that has the same parameters as this operation.
Returns
OperationClone of this operation.
-
getReversed() → Operationmodule:engine/model/operation/operation~Operation#getReversedCreates and returns a reverse operation. Reverse operation when executed right after the original operation will bring back tree model state to the point before the original operation execution. In other words, it reverses changes done by the original operation.
Keep in mind that tree model state may change since executing the original operation, so reverse operation will be "outdated". In that case you will need to transform it by all operations that were executed after the original operation.
Returns
OperationReversed operation.
-
toJSON() → unknownmodule:engine/model/operation/operation~Operation#toJSONCustom toJSON method to solve child-parent circular dependencies.
Returns
unknownClone of this object with the operation property replaced with string.
-
Executes the operation - modifications described by the operation properties will be applied to the model tree.
Returns
void
-
Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.
Returns
void
Static methods
-
static
fromJSON( json, document ) → Operationmodule:engine/model/operation/operation~Operation.fromJSONCreates
Operationobject from deserialized object, i.e. from parsed JSON string.Parameters
json : anyDeserialized JSON object.
document : Document
Returns
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.