@ckeditor/ckeditor5-engine/src/model/operation/markeroperation.d.ts

The editing engine of CKEditor 5 – the best browser-based rich text editor.

/**
 * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
 */
/**
 * @module engine/model/operation/markeroperation
 */
import { Operation } from './operation.js';
import { ModelRange } from '../range.js';
import { type ModelDocument } from '../document.js';
import { type MarkerCollection } from '../markercollection.js';
import type { ModelSelectable } from '../selection.js';
export declare class MarkerOperation extends Operation {
    /**
     * Marker name.
     *
     * @readonly
     */
    name: string;
    /**
     * Marker range before the change.
     *
     * @readonly
     */
    oldRange: ModelRange | null;
    /**
     * Marker range after the change.
     *
     * @readonly
     */
    newRange: ModelRange | null;
    /**
     * Specifies whether the marker operation affects the data produced by the data pipeline
     * (is persisted in the editor's data).
     *
     * @readonly
     */
    affectsData: boolean;
    /**
     * Marker collection on which change should be executed.
     */
    private readonly _markers;
    /**
     * @param name Marker name.
     * @param oldRange Marker range before the change.
     * @param newRange Marker range after the change.
     * @param markers Marker collection on which change should be executed.
     * @param affectsData Specifies whether the marker operation affects the data produced by the data pipeline
     * (is persisted in the editor's data).
     * @param baseVersion Document {@link module:engine/model/document~ModelDocument#version} on which operation
     * can be applied or `null` if the operation operates on detached (non-document) tree.
     */
    constructor(name: string, oldRange: ModelRange | null, newRange: ModelRange | null, markers: MarkerCollection, affectsData: boolean, baseVersion: number | null);
    /**
     * @inheritDoc
     */
    get type(): 'marker';
    /**
     * @inheritDoc
     */
    get affectedSelectable(): ModelSelectable;
    /**
     * Creates and returns an operation that has the same parameters as this operation.
     */
    clone(): MarkerOperation;
    /**
     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
     */
    getReversed(): Operation;
    /**
     * @inheritDoc
     * @internal
     */
    _execute(): void;
    /**
     * @inheritDoc
     * @internal
     */
    toJSON(): unknown;
    /**
     * @inheritDoc
     */
    static get className(): string;
    /**
     * Creates `MarkerOperation` object from deserialized object, i.e. from parsed JSON string.
     *
     * @param json Deserialized JSON object.
     * @param document Document on which this operation will be applied.
     */
    static fromJSON(json: any, document: ModelDocument): MarkerOperation;
}