Report an issue
Class

Operation (engine/model/operation)

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

class

Abstract base operation class.

Filtering

Properties

  • baseVersion : Number

    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.

  • delta : Delta

    Delta which the operation is a part of. This property is set by the delta when the operations is added to it by the addOperation method.

  • isDocumentOperation : Boolean

    readonly

    Defines whether operation is executed on attached or detached items.

  • type : String

    readonly

    Operation type.

Static properties

  • className : String

    static

    Name of the operation class used for serialization.

Methods

  • constructor( baseVersion )

    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() → Operation

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

    Returns

    Operation

    Clone of this operation.

  • getReversed() → Operation

    Creates 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

    Operation

    Reversed operation.

  • toJSON() → Object

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    Object

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

  • _execute()

    protected

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

  • _validate()

    protected

    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

    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