@amcharts/amcharts5 5.1.12 → 5.2.0

package/.internal/charts/stock/StockChart.d.ts

@@ -0,0 +1,189 @@
+import type { StockPanel } from "./StockPanel";
+import type { Axis } from "../xy/axes/Axis";
+import type { AxisRenderer } from "../xy/axes/AxisRenderer";
+import type { IValueAxisSettings } from "../xy/axes/ValueAxis";
+import type { XYSeries, IXYSeriesDataItem, IXYSeriesSettings } from "../xy/series/XYSeries";
+import type { DataItem } from "../../core/render/Component";
+import type { Indicator } from "./indicators/Indicator";
+import { Container, IContainerPrivate, IContainerSettings, IContainerEvents } from "../../core/render/Container";
+import { ListAutoDispose } from "../../core/util/List";
+import { Rectangle } from "../../core/render/Rectangle";
+import { Percent } from "../../core/util/Percent";
+import { SettingsModal } from "./SettingsModal";
+import { Color } from "../../core/util/Color";
+export interface IStockChartSettings extends IContainerSettings {
+    /**
+     * Main value series.
+     *
+     * This series is used to target by settings, as well as calculating
+     * indicators, and annotations.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/#Setting_main_series}
+     */
+    stockSeries?: XYSeries;
+    /**
+     * Main volume series.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/#Setting_main_series}
+     */
+    volumeSeries?: XYSeries;
+    /**
+     * @ignore
+     */
+    comparingSeriesSettings?: Partial<IXYSeriesSettings>;
+    /**
+     * Settings to be applied to the the main value series, when chart is
+     * switched to "percent scale".
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/percent-mode/#Configuring} for more info
+     */
+    percentScaleSeriesSettings?: Partial<IXYSeriesSettings>;
+    /**
+     * Settings to be applied to the [[ValueAxis]] of the main value series,
+     * when chart is switched to "percent scale".
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/percent-mode/#Configuring} for more info
+     */
+    percentScaleValueAxisSettings?: Partial<IValueAxisSettings<AxisRenderer>>;
+    /**
+     * If set to `true`, the chart will go into "percent scale" when compared
+     * series are added to chart, and will exit it when all of the comparisons
+     * are removed.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/percent-mode/} for more info
+     * @default true
+     */
+    autoSetPercentScale?: boolean;
+    /**
+     * This color will be applied to columns/candles on the main value series (series
+     * set as `stockSeries`) where the open value is lower or equal to the close
+     * value.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/#Positive_negative_colors} for more info
+     */
+    stockPositiveColor?: Color;
+    /**
+     * This color will be applied to columns/candles on the main value series (series
+     * set as `stockSeries`) where the open value is higher than the close value.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/#Positive_negative_colors} for more info
+     */
+    stockNegativeColor?: Color;
+    /**
+     * This color will be applied to columns/candles on the main volume series (series
+     * set as `stockSeries`) where the open value is lower or equal to the close
+     * value.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/#Positive_negative_colors} for more info
+     */
+    volumePositiveColor?: Color;
+    /**
+     * This color will be applied to columns/candles on the main volume series (series
+     * set as `stockSeries`) where the open value is higher than the close value.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/#Positive_negative_colors} for more info
+     */
+    volumeNegativeColor?: Color;
+}
+export interface IStockChartPrivate extends IContainerPrivate {
+    /**
+     * A instance of [[SettingsModal]].
+     */
+    settingsModal: SettingsModal;
+    /**
+     * Indicates if chart has currently have any "compared" series set.
+     */
+    comparing?: boolean;
+    /**
+     * A list of compared series.
+     */
+    comparedSeries?: XYSeries[];
+}
+export interface IStockChartEvents extends IContainerEvents {
+}
+/**
+ * A main class for the Stock Chart.
+ *
+ * @see {@link https://www.amcharts.com/docs/v5/charts/stock/} for more info
+ * @important
+ */
+export declare class StockChart extends Container {
+    static className: string;
+    static classNames: Array<string>;
+    _settings: IStockChartSettings;
+    _privateSettings: IStockChartPrivate;
+    _events: IContainerEvents;
+    protected _xAxes: Array<Axis<AxisRenderer>>;
+    protected _downY?: number;
+    protected _upperPanel?: StockPanel;
+    protected _dhp?: Percent;
+    protected _uhp?: Percent;
+    protected _downResizer?: Rectangle;
+    /**
+     * A list of stock panels.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/#Panels} for more info
+     */
+    readonly panels: ListAutoDispose<StockPanel>;
+    /**
+     * A list of indicators on chart.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/stock/indicators/} for more info
+     */
+    readonly indicators: ListAutoDispose<Indicator>;
+    /**
+     * A [[Container]], resiting on top of the charts, suitable for additional
+     * tools, like [[Scrollbar]].
+     *
+     * @default Container.new()
+     */
+    readonly toolsContainer: Container;
+    /**
+     * A [[Container]] where all the stock panels are placed into.
+     *
+     * @default Container.new()
+     */
+    readonly panelsContainer: Container;
+    protected _afterNew(): void;
+    _updateChildren(): void;
+    /**
+     * Enables or disables percent scale mode.
+     *
+     * If `percentScale` is not set, it will try to determine the status on its own.
+     *
+     * In percent scale mode `percentScaleSeriesSettings` and `percentScaleValueAxisSettings` will
+     * be applied to the regular series on the main panel and its Y axis.
+     *
+     * @param  percentScale  Comparison mode active
+     */
+    setPercentScale(percentScale?: boolean): void;
+    /**
+     * Adds a "compared" series to chart. Returns the same series.
+     *
+     * @param   series  Compared series
+     * @return          Compared series
+     */
+    addComparingSeries(series: XYSeries): XYSeries;
+    /**
+     * Removes compared series.
+     *
+     * @param  series  Compared series
+     */
+    removeComparingSeries(series: XYSeries): void;
+    protected _maybePrepSeriesDefaults(series: XYSeries): void;
+    protected _maybePrepAxisDefaults(): void;
+    protected _processIndicator(indicator: Indicator): void;
+    protected _removeIndicator(indicator: Indicator): void;
+    protected _removePanel(chart: StockPanel): void;
+    _updateControls(): void;
+    protected _processPanel(panel: StockPanel): void;
+    protected _syncYAxesSize(): void;
+    protected _removeXAxis(_axis: Axis<AxisRenderer>): void;
+    protected _processXAxis(axis: Axis<AxisRenderer>): void;
+    protected _syncXAxes(axis: Axis<AxisRenderer>): void;
+    /**
+     * @ignore
+     */
+    getVolumeColor(dataItem: DataItem<IXYSeriesDataItem>, negativeColor?: Color, positiveColor?: Color): Color | undefined;
+}
+//# sourceMappingURL=StockChart.d.ts.map

package/.internal/charts/stock/StockChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StockChart.d.ts","sourceRoot":"","sources":["../../../../../src/.internal/charts/stock/StockChart.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAE5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC5F,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAMxD,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AACjH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAiB,OAAO,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAO9C,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAE9D;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC;IAEvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IAExB;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAErD;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAExD;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC;IAE1E;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC;IAE3B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC;IAE3B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;IAE5B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC;CAE5B;AAED,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAE5D;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC;CAE5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;CAE1D;AAGD;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,SAAS;IAExC,OAAc,SAAS,EAAE,MAAM,CAAgB;IAC/C,OAAc,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAuD;IAG/E,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EAAE,kBAAkB,CAAC;IACrC,OAAO,EAAE,gBAAgB,CAAC;IAEzC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAM;IACjD,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC;IACnC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC;IAEnC;;;;OAIG;IACH,SAAgB,MAAM,EAAE,eAAe,CAAC,UAAU,CAAC,CAAyB;IAE5E;;;;OAIG;IACH,SAAgB,UAAU,EAAE,eAAe,CAAC,SAAS,CAAC,CAAyB;IAE/E;;;;;OAKG;IACH,SAAgB,cAAc,EAAE,SAAS,CAAiF;IAE1H;;;;OAIG;IACH,SAAgB,eAAe,EAAE,SAAS,CAAmJ;IAG7L,SAAS,CAAC,SAAS;IAoEZ,eAAe;IAkEtB;;;;;;;;;OASG;IACI,eAAe,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI;IA8CpD;;;;;OAKG;IACI,kBAAkB,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ;IA+CrD;;;;OAIG;IACI,qBAAqB,CAAC,MAAM,EAAE,QAAQ;IA0B7C,SAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI;IAW1D,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAaxC,SAAS,CAAC,iBAAiB,CAAC,SAAS,EAAE,SAAS;IAehD,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS;IAI/C,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,UAAU;IAIjC,eAAe;IAoCtB,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,UAAU;IAuFzC,SAAS,CAAC,cAAc;IAsBxB,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC;IAIhD,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC;IAchD,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC;IAW7C;;OAEG;IACI,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,aAAa,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS;CAwC7H"}