Trilium Frontend API
    Preparing search index...

    Class DetachOperationInternal

    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.

    Hierarchy (View Summary)

    Index
    • Creates an insert operation.

      Parameters

      • sourcePosition: ModelPosition

        Position before the first module:engine/model/item~ModelItem 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.

      Returns DetachOperation

    baseVersion: number

    module:engine/model/document~ModelDocument#version on which operation can be applied. If you try to module:engine/model/model~Model#applyOperation apply operation with different base version than the module:engine/model/document~ModelDocument#version document version the module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version error is thrown.

    batch: Batch

    module:engine/model/batch~Batch Batch to which the operation is added or null if the operation is not added to any batch yet.

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

    clone: never

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

    Clone of this operation.

    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.

    Reversed operation.

    howMany: number

    Offset size of moved range.

    isDocumentOperation: boolean

    Defines whether operation is executed on attached or detached module:engine/model/item~ModelItem items.

    sourcePosition: ModelPosition

    Position before the first module:engine/model/item~ModelItem model item to detach.

    • get affectedSelectable(): ModelSelectable

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

      The exact returned parameter differs between operation types.

      Returns ModelSelectable

    • get type(): "detach"

      Operation type.

      Returns "detach"

    • get className(): string

      Name of the operation class used for serialization.

      Returns string

    • Internal

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

      Returns 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

    • Custom toJSON method to solve child-parent circular dependencies.

      Returns unknown

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

    • 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