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

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

  • clone : never

    See source

  • getReversed : never

    See source

  • howMany : number

    See source

    Offset size of moved range.

  • readonly inherited

    isDocumentOperation : boolean

    See source

    Defines whether operation is executed on attached or detached items.

  • sourcePosition : Position

    See source

    Position before the first model item to detach.

  • readonly

    type : 'detach'

    See source

    Operation type.

Static properties

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

  • 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

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

    Returns

    void

  • internal

    _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

    Returns

    Operation