AttributeOperation

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.

Defines whether operation is executed on attached or detached items.

Key of an attribute to change or remove.

New value of the attribute with given key or null, if operation should remove attribute.

Old value of the attribute with given key or null, if attribute was not set before.

Range on which operation should be applied.

Operation type.

Name of the operation class used for serialization.

Creates an operation that changes, removes or adds attributes.

If only newValue is set, attribute will be added on a node. Note that all nodes in operation's range must not have an attribute with the same key as the added attribute.

If only oldValue is set, then attribute with given key will be removed. Note that all nodes in operation's range must have an attribute with that key added.

If both newValue and oldValue are set, then the operation will change the attribute value. Note that all nodes in operation's ranges must already have an attribute with given key and oldValue as value

Parameters

range : ModelRange

Range on which the operation should be applied. Must be a flat range.

key : string

Key of an attribute to change or remove.

oldValue : unknown

Old value of the attribute with given key or null, if attribute was not set before.

newValue : unknown

New value of the attribute with given key or null, if operation should remove attribute.

baseVersion : null | number

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

AttributeOperation

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

AttributeOperation