CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

DetachOperation (engine/model/operation)

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

class
See source

Operation to permanently remove node from detached root. Note this operation is only a local operation and won't be send to the other clients.

Filtering

Properties

Static properties

  • inherited static

    className : String

    See source

    Name of the operation class used for serialization.

Methods

  • constructor( sourcePosition, howMany )

    See source

    Creates an insert operation.

    Parameters

    sourcePosition : Position

    Position before the first model item to move.

    howMany : Number

    Offset size of moved range. Moved range will start from sourcePosition and end at sourcePosition with offset shifted by howMany.

  • inherited

    clone() → Operation

    See source

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

    Returns

    Operation

    Clone of this operation.

  • inherited

    getReversed() → Operation

    See source

    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.

  • inherited

    toJSON() → Object

    See source

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    Object

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

  • protected inherited

    _execute()

    See source

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

  • protected inherited

    _validate()

    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.

Static methods

  • inherited static

    fromJSON( json, doc ) → Operation

    See source

    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