Sign up (with export icon)

DetachOperation

Api-class icon 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.

Properties

  • Chevron-right icon

    A selectable that will be affected by the operation after it is executed.

    The exact returned parameter differs between operation types.

  • Chevron-right icon

    baseVersion : null | 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.

  • Chevron-right icon

    batch : null | Batch
    inherited

    Batch to which the operation is added or null if the operation is not added to any batch yet.

    Note, that a non-document operation has this property always set to null, and is never added to any batch.

  • Chevron-right icon

    clone : never

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

  • Chevron-right icon

    getReversed : never

    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.

  • Chevron-right icon

    howMany : number

    Offset size of moved range.

  • Chevron-right icon

    isDocumentOperation : boolean
    readonlyinherited

    Defines whether operation is executed on attached or detached items.

  • Chevron-right icon

    Position before the first model item to detach.

  • Chevron-right icon

    type : 'detach'
    readonly

Static properties

  • Chevron-right icon

    className : string
    readonlystatic

    Name of the operation class used for serialization.

Methods

  • Chevron-right icon

    constructor( sourcePosition, howMany )

    Creates an insert operation.

    Parameters

    sourcePosition : ModelPosition

    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.

  • Chevron-right icon

    toJSON() → unknown

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

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

  • Chevron-right icon

    _execute() → void
    internal

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

    Returns

    void
  • Chevron-right icon

    _validate() → void
    internal

    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

  • Chevron-right icon

    fromJSON( json, document ) → Operation
    inheritedstatic

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

    Parameters

    json : any

    Deserialized JSON object.

    document : ModelDocument

    Document on which this operation will be applied.

    Returns

    Operation