Class MoveOperation

constructor

• new MoveOperation(
      sourcePosition: ModelPosition,
      howMany: number,
      targetPosition: ModelPosition,
      baseVersion: number,
  ): MoveOperation

  Creates a move operation.

  Parameters

  • sourcePosition: ModelPosition

    Position before the first module:engine/model/item~ModelItem 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: 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 MoveOperation

howMany

sourcePosition

targetPosition

affectedSelectable

• 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

type

• get type(): "remove" | "move" | "reinsert"

  Operation type.

  Returns "remove" | "move" | "reinsert"

StaticclassName

• get className(): string

  Name of the operation class used for serialization.

  Returns string

_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

clone

• clone(): MoveOperation

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

  Returns MoveOperation

getMovedRangeStart

• getMovedRangeStart(): ModelPosition

  Returns the start position of the moved range after it got moved. This may be different than module:engine/model/operation/moveoperation~MoveOperation#targetPosition in some cases, i.e. when a range is moved inside the same parent but module:engine/model/operation/moveoperation~MoveOperation#targetPosition targetPosition is after module:engine/model/operation/moveoperation~MoveOperation#sourcePosition sourcePosition.

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

  Returns ModelPosition

getReversed

• getReversed(): Operation

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

  Returns Operation

toJSON

• toJSON(): unknown

  Custom toJSON method to solve child-parent circular dependencies.

  Returns unknown

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

StaticfromJSON

• fromJSON(json: any, document: ModelDocument): MoveOperation

  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