NoOperation (engine/model/operation)
@ckeditor/ckeditor5-engine/src/model/operation/nooperation
Operation which is doing nothing ("empty operation", "do-nothing operation", "noop"). This is an operation, which when executed does not change the tree model. It still has some parameters defined for transformation purposes.
In most cases this operation is a result of transforming operations. When transformation returns
NoOperation
it means that changes done by the transformed operation
have already been applied.
Filtering
Properties
-
version
on 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
null
if the operation is not added to any batch yet. -
readonly inherited
isDocumentOperation : Boolean
module:engine/model/operation/nooperation~NoOperation#isDocumentOperation
Defines whether operation is executed on attached or detached items.
-
Operation type.
Static properties
-
Name of the operation class used for serialization.
Methods
-
inherited
constructor( baseVersion )
module:engine/model/operation/nooperation~NoOperation#constructor
Base operation constructor.
Parameters
baseVersion : Number | null
Document
version
on which operation can be applied ornull
if the operation operates on detached (non-document) tree.
-
clone() → NoOperation
module:engine/model/operation/nooperation~NoOperation#clone
Creates and returns an operation that has the same parameters as this operation.
Returns
NoOperation
Clone of this operation.
-
getReversed() → NoOperation
module:engine/model/operation/nooperation~NoOperation#getReversed
-
Custom toJSON method to solve child-parent circular dependencies.
Returns
Object
Clone 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.
-
Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.
Static methods
-
inherited static
fromJSON( json, doc ) → Operation
module:engine/model/operation/nooperation~NoOperation.fromJSON
Creates Operation object from deserilized object, i.e. from parsed JSON string.
Parameters
json : Object
Deserialized JSON object.
doc : Document
Document on which this operation will be applied.
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.