@devexperts/dxcharts-lite 1.0.1 → 2.0.0

package/dist/chart/bootstrap.d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2002 - 2023 Devexperts LLC
+ * Copyright (C) 2019 - 2023 Devexperts Solutions IE Limited
  * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  * If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
@@ -8,18 +8,20 @@ import { CanvasBoundsContainer } from './canvas/canvas-bounds-container';
 import { ValidatedChartElements } from './canvas/chart-elements';
 import { CursorHandler } from './canvas/cursor.handler';
 import ChartContainer from './chart-container';
-import { BarType, ChartColors, ChartConfigComponentsOffsets, FullChartConfig, GridComponentConfig, PartialChartConfig } from './chart.config';
+import { ChartColors, ChartConfigComponentsOffsets, FullChartConfig, GridComponentConfig, PartialChartConfig } from './chart.config';
+import { ChartBaseModel } from './components/chart/chart-base.model';
 import { ChartComponent } from './components/chart/chart.component';
 import { ChartModel } from './components/chart/chart.model';
 import { CrossToolComponent } from './components/cross_tool/cross-tool.component';
 import { CrossToolType } from './components/cross_tool/cross-tool.model';
+import { DynamicObjectsComponent } from './components/dynamic-objects/dynamic-objects.component';
 import { EventsComponent } from './components/events/events.component';
 import { HighlightsComponent } from './components/highlights/highlights.component';
 import { Highlight } from './components/highlights/highlights.model';
 import { NavigationMapComponent } from './components/navigation_map/navigation-map.component';
 import { ChartPanComponent } from './components/pan/chart-pan.component';
 import { PaneManager } from './components/pane/pane-manager.component';
-import { YExtentFormatters } from './components/pane/pane.component';
+import { PaneComponent } from './components/pane/pane.component';
 import { SnapshotComponent } from './components/snapshot/snapshot.component';
 import { VolumesComponent } from './components/volumes/volumes.component';
 import { WaterMarkComponent } from './components/watermark/water-mark.component';
@@ -38,6 +40,9 @@ import { ScaleModel } from './model/scale.model';
 import { TimeZoneModel } from './model/time-zone.model';
 import { DeepPartial } from './utils/object.utils';
 export type FitType = 'studies' | 'orders' | 'positions';
+/**
+ * @deprecated use {Chart} instead
+ */
 export default class ChartBootstrap implements ChartContainer {
     id: string;
     bus: EventBus;
@@ -46,38 +51,80 @@ export default class ChartBootstrap implements ChartContainer {
     elements: ValidatedChartElements;
     components: Array<any>;
     chartComponents: Array<ChartEntity>;
+    /**
+     * @deprecated use {xAxis} instead
+     */
     xAxisComponent: XAxisComponent;
+    /**
+     * @deprecated use {yAxis} instead
+     */
     yAxisComponent: YAxisComponent;
+    /**
+     * @deprecated use {watermark} instead
+     */
     watermarkComponent: WaterMarkComponent;
+    /**
+     * @deprecated use {snapshot} instead
+     */
     snapshotComponent: SnapshotComponent;
+    /**
+     * @deprecated use {navigationMap} instead
+     */
     navigationMapComponent: NavigationMapComponent;
     userInputListenerComponents: Array<ChartEntity>;
     drawingManager: DrawingManager;
     crossEventProducer: CrossEventProducerComponent;
+    /**
+     * @deprecated use {cursors} instead
+     */
     cursorHandler: CursorHandler;
     clearer: () => void;
+    /**
+     * @deprecated use {scale} instead
+     */
     scaleModel: ScaleModel;
     timeZoneModel: TimeZoneModel;
     chartModel: ChartModel;
     backgroundCanvasModel: CanvasModel;
     mainCanvasModel: CanvasModel;
-    dataSeriesCanvasModel: CanvasModel;
-    overSeriesCanvasModel: CanvasModel;
+    dynamicObjectsCanvasModel: CanvasModel;
     hitTestCanvasModel: HitTestCanvasModel;
     canvasBoundsContainer: CanvasBoundsContainer;
     canvasInputListener: CanvasInputListenerComponent;
+    /**
+     * @deprecated use {volumes} instead
+     */
     volumesComponent: VolumesComponent;
+    dynamicObjects: DynamicObjectsComponent;
+    /**
+     * @deprecated use {highlights} instead
+     */
     highlightsComponent: HighlightsComponent;
+    /**
+     * @deprecated use {data} instead
+     */
     chartComponent: ChartComponent;
+    /**
+     * @deprecated use {events} instead
+     */
     eventsComponent: EventsComponent;
+    /**
+     * @deprecated use {crosshair} instead
+     */
     crossToolComponent: CrossToolComponent;
+    /**
+     * @deprecated use {panning} instead
+     */
     chartPanComponent: ChartPanComponent;
     paneManager: PaneManager;
     hoverProducer: HoverProducerComponent;
     canvasModels: CanvasModel[];
     chartResizeHandler: ChartResizeHandler;
+    mainPane: PaneComponent;
+    chartBaseModel: ChartBaseModel<'candle'>;
     canvasAnimation: CanvasAnimation;
     constructor(element: HTMLElement, userConfig?: PartialChartConfig);
+    private initYAxisDrawer;
     /**
      * Creates a configuration object for overriding UTC time in a chart.
      * @param {ChartModel} chartModel - The chart model object.
@@ -105,14 +152,6 @@ export default class ChartBootstrap implements ChartContainer {
      * @returns {FullChartConfig} The FullChartConfig object.
      */
     getConfig(): FullChartConfig;
-    /**
-     * Sets the right-to-left (RTL) configuration of the component.
-     *
-     * @param {boolean} rtl - A boolean value indicating whether the component should be displayed in RTL mode.
-     * @returns {void}
-     */
-    setRtl(rtl: boolean): void;
-    setChartType(type: BarType): void;
     /**
      * Disables user controls by deactivating all userInputListenerComponents and disabling hitTestCanvasModel.
      * @returns {void}
@@ -147,14 +186,6 @@ export default class ChartBootstrap implements ChartContainer {
      * @returns {void}
      */
     setGridHorizontal(showHorizontal: boolean): void;
-    /**
-     * Deactivates the chart by clearing the canvas listeners and disabling user controls.
-     * This method is a hack and should not be used unless an activation/deactivation cycle is implemented.
-     * It is implemented to prevent memory leaks in the chart when components are deactivated.
-     * @returns {void}
-     * @todo This method should be revised soon.
-     */
-    deactivate(): void;
     /**
      * This method triggers the 'draw' event on the 'bus' object.
      * @returns {void}
@@ -166,27 +197,12 @@ export default class ChartBootstrap implements ChartContainer {
      * @returns {ChartConfigComponentsOffsets} The offsets of the chart components.
      */
     getOffsets(): ChartConfigComponentsOffsets;
-    /**
-     * Sets the visibility of the volumes separately and updates the yAxis width.
-     * @param {boolean} separate - A boolean value indicating whether to show the volumes separately or not. Default value is false.
-     */
-    showSeparateVolumes(separate?: boolean): void;
-    /**
-     * Sets the auto scale property of the scale model.
-     * @param {boolean} auto - A boolean value indicating whether the auto scale is enabled or not. Default value is true.
-     */
-    setAutoScale(auto?: boolean): void;
     /**
      * Sets the visibility of the borders of the candles in the chart.
      * @param {boolean} show - A boolean value indicating whether to show or hide the borders of the candles. Default value is true.
      * @returns {void}
      */
     setShowCandleBorders(show?: boolean): void;
-    /**
-     * Returns related Y-axis coordinate by provided value
-     * @param price
-     */
-    valueToY(price: number): number;
     /**
      * Sets the visibility of the high-low component.
      * @param {boolean} visible - Whether the high-low component should be visible or not. Default is true.
@@ -244,23 +260,10 @@ export default class ChartBootstrap implements ChartContainer {
      * @returns {() => void} - A function that can be called to unsubscribe from the drag event listener.
      */
     addDragEventsListener(canvasElement: string, handler: (xPosition: number) => void): () => void;
-    /**
-     * Contains tear-down logic for chart
-     * Use when you want to unmount the chart from the host app
-     */
-    destroy(): void;
     /**
      * Registers a chart component and includes it in the the chart lifecycle
      * @param initComponent - a function for component init
      * @param onComponentInit - will be called after component init
      */
     registerComponent<C extends ChartEntity>(initComponent: (chartInstance: ChartBootstrap) => C, onComponentInit?: (component: C) => void): void;
-    /**
-     * Registers number formatters for pane
-     * @param uuid - pane's id
-     * @param formatters - object, that contains 3 fileds: 'regular', 'percent', 'logarithmic'.
-     * Each filed must have it's own formatter.
-     * If 'percent' and 'logarithmic' formatters did not provided, 'regular' will be applied.
-     */
-    registerPaneFormatters(uuid: string, formatters: YExtentFormatters): void;
 }