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

DetachOperation (engine/model/operation)

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

class

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

  • 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.

  • howMany : Number

    Offset size of moved range.

  • isDocumentOperation : Boolean

    readonly inherited

    Defines whether operation is executed on attached or detached items.

  • sourcePosition : Position

    Position before the first model item to detach.

  • 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( sourcePosition, howMany )

    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.

    Overrides: Operation#constructor

  • clone() → Operation

    inherited

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

    Returns

    Operation

    Clone of this operation.

  • getReversed() → Operation

    inherited

    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

    inherited

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    Object

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

    Overrides: Operation#toJSON

  • _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.

    Overrides: Operation#_validate

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