CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
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

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

    See source

  • batch : Batch | null

    inherited

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

    See source

  • howMany

    Total offset size of inserted nodes.

    See source

  • isDocumentOperation : Boolean

    readonly inherited

    Defines whether operation is executed on attached or detached items.

    See source

  • nodeList : NodeList

    readonly

    List of nodes to insert.

    See source

  • position : Position

    readonly

    Position of insertion.

    See source

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

    See source

  • type : String

    readonly inherited

    Operation type.

    See source

Static properties

  • className : String

    inherited static

    Name of the operation class used for serialization.

    See source

Methods

  • constructor( position, nodes, baseVersion )

    Creates an insert operation.

    See source

    Parameters

    position : Position

    Position of insertion.

    nodes : NodeSet

    The list of nodes to be inserted.

    baseVersion : Number | null

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

  • clone() → InsertOperation

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

    See source

    Returns

    InsertOperation

    Clone of this operation.

  • getReversed() → MoveOperation

    See Operation#getReversed().

    See source

    Returns

    MoveOperation

  • toJSON() → Object

    inherited

    Custom toJSON method to solve child-parent circular dependencies.

    See source

    Returns

    Object

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

  • _execute()

    protected inherited

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

    See source

  • _validate()

    protected inherited

    Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.

    See source

Static methods

  • fromJSON( json, document ) → InsertOperation

    static

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

    See source

    Parameters

    json : Object

    Deserialized JSON object.

    document : Document

    Document on which this operation will be applied.

    Returns

    InsertOperation