RootAttributeOperation

Api-class icon class

Operation to change root element's attribute. Using this class you can add, remove or change value of the attribute.

This operation is needed, because root elements can't be changed through AttributeOperation. It is because AttributeOperation requires a range to change and root element can't be a part of range because every ModelPosition has to be inside a root. ModelPosition can't be created before a root element.

Properties

Static properties

  • Chevron-right icon

    className : string
    readonlystatic

    Name of the operation class used for serialization.

Methods

  • Chevron-right icon

    constructor( root, key, oldValue, newValue, baseVersion )

    Creates an operation that changes, removes or adds attributes on root element.

    Parameters

    root : ModelRootElement

    Root element to change.

    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.

    Related:

  • Chevron-right icon

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

    Returns

    RootAttributeOperation

    Clone of this operation.

  • Chevron-right icon

  • Chevron-right icon

    toJSON() → unknown

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

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

  • Chevron-right icon

    _execute() → void
    internal

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

    Returns

    void
  • Chevron-right icon

    _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

Static methods