Sign up (with export icon)

MoveOperation

Api-class icon class

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

Properties

Static properties

  • Chevron-right icon

    className : string
    readonlystatic

    Name of the operation class used for serialization.

Methods

  • Chevron-right icon

    constructor( sourcePosition, howMany, targetPosition, baseVersion )

    Creates a move operation.

    Parameters

    sourcePosition : ModelPosition

    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 : ModelPosition

    Position at which moved nodes will be inserted.

    baseVersion : null | number

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

  • Chevron-right icon

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

    Returns

    MoveOperation
  • Chevron-right icon

    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.

     vv              vv
    abcdefg ===> adefbcg
         ^          ^
         targetPos  movedRangeStart
         offset 6   offset 4
    
    Copy code

    Returns

    ModelPosition
  • Chevron-right icon

  • Chevron-right icon

    toJSON() → unknown

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

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

  • Chevron-right icon

    _execute() → void
    internal

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

    Returns

    void
  • Chevron-right icon

    _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

Static methods

  • Chevron-right icon

    fromJSON( json, document ) → MoveOperation
    static

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

    MoveOperation