Trilium Frontend API
    Preparing search index...

    Class InsertOperation

    Operation to insert one or more nodes at given position in the model.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    baseVersion batch isDocumentOperation nodes position shouldReceiveAttributes

    Accessors

    affectedSelectable howMany type className

    Methods

    _execute _validate clone getReversed toJSON fromJSON

    Constructors

    • Creates an insert operation.

      Parameters

      • position: ModelPosition

        Position of insertion.

      • nodes: ModelNodeSet

        The list of nodes to be inserted.

      • baseVersion: number

        Document module:engine/model/document~ModelDocument#version on which operation can be applied or null if the operation operates on detached (non-document) tree.

      Returns InsertOperation

    Properties

    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.

    isDocumentOperation: boolean

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

    nodes: ModelNodeList

    List of nodes to insert.

    position: ModelPosition

    Position of insertion.

    shouldReceiveAttributes: boolean

    Flag deciding how the operation should be transformed. If set to true, nodes might get additional attributes during operational transformation. This happens when the operation insertion position is inside of a range where attributes have changed.

    Accessors

    • 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 howMany(): number

      Total offset size of inserted nodes.

      Returns number

    • get type(): "insert"

      Operation type.

      Returns "insert"

    • get className(): string

      Name of the operation class used for serialization.

      Returns string

    Methods

    _execute

    • _execute(): void
      Internal

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

      Returns void

    _validate

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

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

      Returns InsertOperation

    • See module:engine/model/operation/operation~Operation#getReversed Operation#getReversed().

      Returns Operation

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

      Returns unknown

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

    • Creates InsertOperation 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 InsertOperation

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods