Class

Operation (engine/model/operation)

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

class

Abstract base operation class.

Filtering

Properties

Static properties

  • readonly static

    className : string

    Name of the operation class used for serialization.

Methods

  • constructor( baseVersion )

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

    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

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

    Returns

    void
  • internal

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

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

    Parameters

    json : any

    Deserialized JSON object.

    document : Document

    Returns

    Operation