CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

MoveOperation (engine/model/operation)

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

class
See source

Operation to move a range of model items to given target position.

Filtering

Properties

Static properties

  • className : String

    inherited static

    Name of the operation class used for serialization.

    See source

Methods

  • constructor( sourcePosition, howMany, targetPosition, baseVersion )

    Creates a move operation.

    See source

    Parameters

    sourcePosition : Position

    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.

    targetPosition : Position

    Position at which moved nodes will 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() → MoveOperation

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

    See source

    Returns

    MoveOperation

    Clone of this operation.

  • getMovedRangeStart() → Position

    Returns the start position of the moved range after it got moved. This may be different than targetPosition in some cases, i.e. when a range is moved inside the same parent but targetPosition is after sourcePosition.

    See source
     vv              vv
abcdefg ===> adefbcg
     ^          ^
     targetPos	movedRangeStart
     offset 6	offset 4

    Returns

    Position

  • 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 ) → MoveOperation

    static

    Creates MoveOperation 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

    MoveOperation