CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

NoOperation (engine/model/operation)

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

class
See source

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

  • readonly

    affectedSelectable : Selectable

    See source

    A selectable that will be affected by the operation after it is executed.

    The exact returned parameter differs between operation types.

  • inherited

    baseVersion : null | number

    See source

    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.

  • inherited

    batch : null | Batch

    See source

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

    Note, that a non-document operation has this property always set to null, and is never added to any batch.

  • readonly inherited

    isDocumentOperation : boolean

    See source

    Defines whether operation is executed on attached or detached items.

  • readonly

    type : 'noop'

    See source

    Operation type.

Static properties

  • readonly static

    className : string

    See source

    Name of the operation class used for serialization.

Methods

  • inherited

    constructor( baseVersion )

    See source

    Base operation constructor.

    Parameters

    baseVersion : null | number

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

  • clone() → NoOperation

    See source

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

    Returns

    NoOperation

  • getReversed() → Operation

    See source

    See Operation#getReversed().

    Returns

    Operation

  • inherited

    toJSON() → unknown

    See source

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

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

  • internal

    _execute() → void

    See source

    Returns

    void

  • internal inherited

    _validate() → void

    See source

    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

  • inherited static

    fromJSON( json, document ) → Operation

    See source

    Creates Operation object from deserialized object, i.e. from parsed JSON string.

    Parameters

    json : any

    Deserialized JSON object.

    document : Document

    Document on which this operation will be applied.

    Returns

    Operation