CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

RootOperation (engine/model/operation)

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

class
See source

Operation that creates (or attaches) or detaches a root element.

Filtering

Properties

  • readonly

    affectedSelectable : Selectable

    See source

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

    The exact returned parameter differs between operation types.

  • inherited

    baseVersion : null | number

    See source

    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.

  • inherited

    batch : null | Batch

    See source

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

  • readonly

    elementName : string

    See source

    Root element name.

  • readonly

    isAdd : boolean

    See source

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

  • readonly inherited

    isDocumentOperation : boolean

    See source

    Defines whether operation is executed on attached or detached items.

  • readonly

    rootName : string

    See source

    Root name to create or detach.

  • readonly

    type : 'addRoot' | 'detachRoot'

    See source

    Operation type.

  • private readonly

    _document : Document

    See source

    Document which owns the root.

Static properties

  • readonly static

    className : string

    See source

    Name of the operation class used for serialization.

Methods

  • constructor( rootName, elementName, isAdd, document, baseVersion )

    See source

    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 : Document

    Document which owns the root.

    baseVersion : number

    Document version on which operation can be applied.

  • clone() → RootOperation

    See source

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

    Returns

    RootOperation

    Clone of this operation.

  • getReversed() → RootOperation

    See source

    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.

  • toJSON() → unknown

    See source

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

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

  • internal

    _execute() → void

    See source

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

    Returns

    void

  • internal inherited

    _validate() → void

    See source

    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

  • static

    fromJSON( json, document ) → RootOperation

    See source

    Creates RootOperation object from deserialized object, i.e. from parsed JSON string.

    Parameters

    json : any

    Deserialized JSON object.

    document : Document

    Document on which this operation will be applied.

    Returns

    RootOperation