@amcharts/amcharts5/.internal/charts/stock/SettingsModal.d.ts

amCharts 5

import type { Indicator } from "./indicators/Indicator";
import type { StockChart } from "./StockChart";
import type { XYSeries } from "../xy/series/XYSeries";
import { Modal, IModalSettings, IModalPrivate, IModalEvents } from "../../core/util/Modal";
import { ColorControl } from "./toolbar/ColorControl";
export interface ISettingsModalSettings extends IModalSettings {
    /**
     * A target [[StockChart]].
     */
    stockChart: StockChart;
    /**
     * Show the "Reset to default" link?
     *
     * @default true
     * @since 5.9.0
     */
    showResetLink?: boolean;
    /**
     * Available line widths for user to choose from.
     *
     * @default [1, 2, 4, 10]
     * @since 5.11.2
     */
    strokeWidths?: number[];
}
export interface ISettingsModalPrivate extends IModalPrivate {
}
export interface ISettingsModalEvents extends IModalEvents {
    /**
     * Invoked when modal is closed/saved.
     */
    done: {
        settings?: any;
        settingsTarget?: Indicator | XYSeries;
    };
    /**
     * Invoked when modal starts generating actual content.
     *
     * It's a good place to modify settings.
     */
    initstarted: {
        settings?: any;
        settingsTarget?: Indicator | XYSeries;
    };
}
/**
 * Used to display a modal dialog with HTML content.
 */
export declare class SettingsModal extends Modal {
    static className: string;
    static classNames: Array<string>;
    _settings: ISettingsModalSettings;
    _privateSettings: ISettingsModalPrivate;
    _events: ISettingsModalEvents;
    protected _updatedSettings: {
        [index: string]: any;
    };
    protected _settingsTarget?: Indicator | XYSeries;
    protected _colorControl?: ColorControl;
    protected _afterNew(): void;
    _beforeChanged(): void;
    /**
     * Opens settings modal for an [[Indicator]].
     *
     * @param  target  Target indicator
     */
    openIndicator(target: Indicator): void;
    /**
     * Opens settings editing for the any [[XYSeries]].
     *
     * @param  series  target series
     */
    openSeries(series: XYSeries): void;
    private initContent;
    private getDropdown;
    private getNumber;
    /**
     * Clamps a number input to its `data-min-value`/`data-max-value` and rounds to
     * an integer when `data-step` is `1`. Attribute-driven so it also works after
     * a mode dropdown retargets the input's bounds. Tolerant of missing / empty /
     * literal "null" attribute values.
     */
    private _clampNumberInput;
    private getText;
    private getCheckbox;
    private getColor;
    /**
     * Closes the modal, saving settings.
     */
    close(): void;
    /**
     * Closes the modal without applying any changes.
     */
    cancel(): void;
    /**
     * Clears contents of the modal.
     */
    clear(): void;
    private _getSettingKey;
}
//# sourceMappingURL=SettingsModal.d.ts.map