CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

InsertOperation (engine/model/operation)

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

class
See source

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

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.

  • readonly

    howMany : number

    See source

    Total offset size of inserted nodes.

  • readonly inherited

    isDocumentOperation : boolean

    See source

    Defines whether operation is executed on attached or detached items.

  • nodes : NodeList

    See source

    List of nodes to insert.

  • position : Position

    See source

    Position of insertion.

  • shouldReceiveAttributes : boolean

    See source

    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.

  • readonly

    type : 'insert'

    See source

    Operation type.

Static properties

  • readonly static

    className : string

    See source

    Name of the operation class used for serialization.

Methods

  • constructor( position, nodes, baseVersion )

    See source

    Creates an insert operation.

    Parameters

    position : Position

    Position of insertion.

    nodes : NodeSet

    The list of nodes to be inserted.

    baseVersion : null | number

    Document version on which operation can be applied or null if the operation operates on detached (non-document) tree.

  • clone() → InsertOperation

    See source

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

    Returns

    InsertOperation

  • getReversed() → Operation

    See source

    See Operation#getReversed().

    Returns

    Operation

  • 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

  • static

    fromJSON( json, document ) → InsertOperation

    See source

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

    Parameters

    json : any

    Deserialized JSON object.

    document : Document

    Document on which this operation will be applied.

    Returns

    InsertOperation