import { Entity, IEntitySettings, IEntityPrivate, IEntityEvents } from "../../core/util/Entity"; export interface IAnnotatorSettings extends IEntitySettings { /** * Layer the annotations are drawn on, above the chart. * * @default 1000 */ layer?: number; /** * The annotations, as state saved by MarkerJS. Setting it draws them, e.g. * to restore annotations saved earlier. */ markerState?: any; /** * Settings for MarkerJS's `MarkerArea`, as an object of setting names and * values, e.g.: * * ```TypeScript * let annotator = am5plugins_exporting.Annotator.new(root, { * markerSettings: { * defaultColorSet: ["red", "green", "blue"], * wrapText: true * } *}); * ``` * ```JavaScript * var annotator = am5plugins_exporting.Annotator.new(root, { * markerSettings: { * defaultColorSet: ["red", "green", "blue"], * wrapText: true * } *}); * ``` * * @see {@link https://markerjs.com/reference/classes/settings.html} for a full list of settings * @since 5.7.4 */ markerSettings?: { [index: string]: any; }; /** * Style settings for the MarkerJS user interface, e.g.: * * ```TypeScript * let annotator = am5plugins_exporting.Annotator.new(root, { * markerStyleSettings: { * toolboxColor: "#F472B6", * toolboxAccentColor: "#BE185D" * } *}); * ``` * ```JavaScript * var annotator = am5plugins_exporting.Annotator.new(root, { * markerStyleSettings: { * toolboxColor: "#F472B6", * toolboxAccentColor: "#BE185D" * } *}); * ``` * * @see {@link https://markerjs.com/reference/classes/settings.html} for a full list of settings * @since 5.7.5 */ markerStyleSettings?: { [index: string]: any; }; } export interface IAnnotatorPrivate extends IEntityPrivate { } export interface IAnnotatorEvents extends IEntityEvents { } /** * A plugin that lets the user draw annotations over the chart, using the * MarkerJS library. * * @see {@link https://www.amcharts.com/docs/v5/concepts/exporting/annotator/} for more info */ export declare class Annotator extends Entity { static className: string; static classNames: Array; _settings: IAnnotatorSettings; _privateSettings: IAnnotatorPrivate; _events: IAnnotatorEvents; private _container?; private _picture?; private _markerArea?; private _skipRender?; protected _afterNew(): void; _beforeChanged(): void; /** * Opens annotation mode: shows the MarkerJS toolbars and disables * interaction with the chart. */ open(): Promise; _renderState(): Promise; /** * Exits annotation mode. The annotations stay visible on the chart. */ close(): Promise; /** * Exits annotation mode, discarding the changes made since it opened. */ cancel(): Promise; /** * Removes all annotations. */ clear(): void; /** * Opens annotation mode, or closes it if it is open. */ toggle(): Promise; protected _dispose(): void; private _maybeInit; /** * @ignore */ private _getMarkerJS; /** * Returns MarkerJS's `MarkerArea`, loading MarkerJS first if needed. * * @see {@link https://markerjs.com/docs/getting-started} for more info * @return MarkerArea */ getMarkerArea(): Promise; } //# sourceMappingURL=Annotator.d.ts.map