Class MergeOperation

constructor

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

  Creates a merge operation.

  Parameters

  • sourcePosition: ModelPosition

    Position inside the merged element. All nodes from that element after that position will be moved to #targetPosition.

  • howMany: number

    Summary offset size of nodes which will be moved from the merged element to the new parent.

  • targetPosition: ModelPosition

    Position which the nodes from the merged elements will be moved to.

  • graveyardPosition: ModelPosition

    Position in graveyard to which the merged element will be moved.

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

graveyardPosition

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

deletionPosition

• get deletionPosition(): ModelPosition

  Position before the merged element (which will be deleted).

  Returns ModelPosition

movedRange

• get movedRange(): ModelRange

  Artificial range that contains all the nodes from the merged element that will be moved to ~MergeOperation#sourcePosition. The range starts at ~MergeOperation#sourcePosition and ends in the same parent, at POSITIVE_INFINITY offset.

  Returns ModelRange

type

• get type(): "merge"

  Operation type.

  Returns "merge"

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(): MergeOperation

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

  Returns MergeOperation

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): MergeOperation

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