@amcharts/amcharts5
Version:
amCharts 5
89 lines • 2.26 kB
TypeScript
import type { PanelControls } from "./PanelControls";
import type { StockChart } from "./StockChart";
import type { XYSeries } from "../xy/series/XYSeries";
import type { Rectangle } from "../../core/render/Rectangle";
import { XYChart, IXYChartPrivate, IXYChartSettings, IXYChartEvents } from "../xy/XYChart";
import { ListAutoDispose } from "../../core/util/List";
export interface IStockPanelSettings extends IXYChartSettings {
}
export interface IStockPanelPrivate extends IXYChartPrivate {
/**
* A target [[StockChart]].
*/
stockChart: StockChart;
}
export interface IStockPanelEvents extends IXYChartEvents {
/**
* Kicks in when panel is moved up or down.
*
* @since 5.9.2
*/
moved: {
oldIndex: number;
newIndex: number;
};
/**
* Kicks in when panel is closed (removed).
*
* @since 5.9.2
*/
closed: {};
/**
* Kicks in when panel is expanded.
*
* @since 5.9.2
*/
expanded: {};
/**
* Kicks in when panel is collapsed (returns to normal size).
*
* @since 5.9.2
*/
collapsed: {};
}
/**
* A panel instance for the [[StockChart]].
*
* @see {@link https://www.amcharts.com/docs/v5/charts/stock/panels/} for more info
* @important
*/
export declare class StockPanel extends XYChart {
static className: string;
static classNames: Array<string>;
_settings: IStockPanelSettings;
_privateSettings: IStockPanelPrivate;
_events: IStockPanelEvents;
/**
* An instance of [[PanelControls]].
*/
panelControls: PanelControls;
/**
* Panel resize grip element.
*
* @since 5.4.7
*/
panelResizer?: Rectangle;
/**
* A list of drawings on panel.
*
*/
readonly drawings: ListAutoDispose<XYSeries>;
protected _afterNew(): void;
/**
* Moves panel up.
*/
moveUp(): void;
/**
* Moves panel down.
*/
moveDown(): void;
/**
* Closes panel.
*/
close(): void;
/**
* Toggles "full screen" mode of the panel on and off.
*/
expand(): void;
}
//# sourceMappingURL=StockPanel.d.ts.map