CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

RootAttributeOperation (engine/model/operation)

@ckeditor/ckeditor5-engine/src/model/operation/rootattributeoperation

class
See source

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

Filtering

Properties

  • baseVersion : Number

    inherited

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

    inherited

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

    See source

  • isDocumentOperation : Boolean

    readonly inherited

    Defines whether operation is executed on attached or detached items.

    See source

  • key : String

    readonly

    Key of an attribute to change or remove.

    See source

  • newValue : *

    readonly

    New value to set for the attribute. If null, then the operation just removes the attribute.

    See source

  • oldValue : *

    readonly

    Old value of the attribute with given key or null if adding a new attribute.

    See source

  • root : RootElement

    readonly

    Root element to change.

    See source

  • type : String

    readonly inherited

    Operation type.

    See source

Static properties

  • className : String

    inherited static

    Name of the operation class used for serialization.

    See source

Methods

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

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

    See source

    Parameters

    root : RootElement

    Root element to change.

    key : String

    Key of an attribute to change or remove.

    oldValue : *

    Old value of the attribute with given key or null if adding a new attribute.

    newValue : *

    New value to set for the attribute. If null, then the operation just removes the attribute.

    baseVersion : Number | null

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

    Related:

  • clone() → RootAttributeOperation

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

    See source

    Returns

    RootAttributeOperation

    Clone of this operation.

  • getReversed() → RootAttributeOperation

    See Operation#getReversed().

    See source

    Returns

    RootAttributeOperation

  • toJSON() → Object

    inherited

    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()

    protected inherited

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

    See source

  • _validate()

    protected inherited

    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, document ) → RootAttributeOperation

    static

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

    See source

    Parameters

    json : Object

    Deserialized JSON object.

    document : Document

    Document on which this operation will be applied.

    Returns

    RootAttributeOperation