MarkerOperation

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

The exact returned parameter differs between operation types.

Specifies whether the marker operation affects the data produced by the data pipeline (is persisted in the editor's data).

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.

Defines whether operation is executed on attached or detached items.

Marker name.

Marker range after the change.

Marker range before the change.

Operation type.

Marker collection on which change should be executed.

Name of the operation class used for serialization.

Parameters

name: string

Marker name.

oldRange: ModelRange | null

Marker range before the change.

newRange: ModelRange | null

Marker range after the change.

markers: MarkerCollection

Marker collection on which change should be executed.

affectsData: boolean

Specifies whether the marker operation affects the data produced by the data pipeline (is persisted in the editor's data).

baseVersion: number | null

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

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

Returns

MarkerOperation

See Operation#getReversed().

Returns

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 MarkerOperation 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

MarkerOperation