CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

MarkerOperation (engine/model/operation)

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

class
See source

Abstract base operation class.

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.

  • affectsData : boolean

    See source

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

  • 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 inherited

    isDocumentOperation : boolean

    See source

    Defines whether operation is executed on attached or detached items.

  • name : string

    See source

    Marker name.

  • newRange : null | Range

    See source

    Marker range after the change.

  • oldRange : null | Range

    See source

    Marker range before the change.

  • readonly

    type : 'marker'

    See source

    Operation type.

  • private readonly

    _markers : MarkerCollection

    See source

    Marker collection on which change should be executed.

Static properties

  • readonly static

    className : string

    See source

    Name of the operation class used for serialization.

Methods

  • constructor( name, oldRange, newRange, markers, affectsData, baseVersion )

    See source

    Parameters

    name : string

    Marker name.

    oldRange : null | Range

    Marker range before the change.

    newRange : null | Range

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

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

  • clone() → MarkerOperation

    See source

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

    Returns

    MarkerOperation

  • getReversed() → Operation

    See source

    See Operation#getReversed().

    Returns

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

    See source

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

    MarkerOperation