Properties

• baseVersion : Numbermodule:engine/model/operation/operation~Operation#baseVersion

  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 | nullmodule:engine/model/operation/operation~Operation#batch

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

  See source

• isDocumentOperation : Booleanmodule:engine/model/operation/operation~Operation#isDocumentOperation

  readonly

  Defines whether operation is executed on attached or detached items.

  See source

• type : Stringmodule:engine/model/operation/operation~Operation#type

  readonly

  Operation type.

  See source

Static properties

• className : Stringmodule:engine/model/operation/operation~Operation.className

  static

  Name of the operation class used for serialization.

  See source

Methods

• constructor( baseVersion )module:engine/model/operation/operation~Operation#constructor

  Base operation constructor.

  See source

  Parameters

  baseVersion : Number | null

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

• clone() → Operationmodule:engine/model/operation/operation~Operation#clone

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

  See source

  Returns

  Operation

  Clone of this operation.

• getReversed() → Operationmodule:engine/model/operation/operation~Operation#getReversed

  Creates and returns a reverse operation. Reverse operation when executed right after the original operation will bring back tree model state to the point before the original operation execution. In other words, it reverses changes done by the original operation.

  See source

  Keep in mind that tree model state may change since executing the original operation, so reverse operation will be "outdated". In that case you will need to transform it by all operations that were executed after the original operation.

  Returns

  Operation

  Reversed operation.

• toJSON() → Objectmodule:engine/model/operation/operation~Operation#toJSON

  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()module:engine/model/operation/operation~Operation#_execute

  protected

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

  See source

• _validate()module:engine/model/operation/operation~Operation#_validate

  protected

  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, doc ) → Operationmodule:engine/model/operation/operation~Operation.fromJSON

  static

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

  See source

  Parameters

  json : Object

  Deserialized JSON object.

  doc : Document

  Document on which this operation will be applied.

  Returns

  Operation