CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 5/API
Class

NoOperation (engine/model/operation)

@ckeditor/ckeditor5-engine/src/model/operation/nooperation

class

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

  • baseVersion : Number

    inherited

    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 : Batch | null

    inherited

    Batch to which the operation is added or null if the operation is not added to any batch yet.

  • isDocumentOperation : Boolean

    readonly inherited

    Defines whether operation is executed on attached or detached items.

  • type : String

    readonly inherited

    Operation type.

    Overrides: Operation#type

Static properties

  • className : String

    inherited static

    Name of the operation class used for serialization.

Methods

  • constructor( baseVersion )

    inherited

    Base operation constructor.

    Parameters

    baseVersion : Number | null

    Document version on which operation can be applied or null if the operation operates on detached (non-document) tree.

  • clone() → NoOperation

    Creates and returns an operation that has the same parameters as this operation.

    Returns

    NoOperation

    Clone of this operation.

    Overrides: Operation#clone

  • getReversed() → NoOperation

    See Operation#getReversed().

    Returns

    NoOperation
    Overrides: Operation#getReversed

  • toJSON() → Object

    inherited

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    Object

    Clone of this object with the operation property replaced with string.

  • _execute()

    protected inherited

    Executes the operation - modifications described by the operation properties will be applied to the model tree.

    Overrides: Operation#_execute

  • _validate()

    protected inherited

    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

  • fromJSON( json, doc ) → Operation

    inherited static

    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

    Operation