RootOperation

A selectable that will be affected by the operation after it is executed.

The exact returned parameter differs between operation types.

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.

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

Note, that a non-document operation has this property always set to null, and is never added to any batch.

Root element name.

Specifies whether the operation adds (true) or detaches the root (false).

Defines whether operation is executed on attached or detached items.

Root name to create or detach.

Operation type.

Document which owns the root.

Name of the operation class used for serialization.

Creates an operation that creates or removes a root element.

Parameters

rootName : string

Root name to create or detach.

elementName : string

Root element name.

isAdd : boolean

Specifies whether the operation adds (true) or detaches the root (false).

document : ModelDocument

Document which owns the root.

baseVersion : number

Document version on which operation can be applied.

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

Returns

RootOperation

Clone of this operation.

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.

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

RootOperation

Reversed operation.

Custom toJSON method to solve child-parent circular dependencies.

Returns

unknown

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

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

Returns

void

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

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

RootOperation