@devexperts/dxcharts-lite 1.0.1

package/LICENSE

@@ -0,0 +1,151 @@
+Mozilla Public License
+Version 2.0
+1. Definitions
+1.1. “Contributor”
+means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.
+
+1.2. “Contributor Version”
+means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution.
+
+1.3. “Contribution”
+means Covered Software of a particular Contributor.
+
+1.4. “Covered Software”
+means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.
+
+1.5. “Incompatible With Secondary Licenses”
+means
+
+that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or
+
+that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License.
+
+1.6. “Executable Form”
+means any form of the work other than Source Code Form.
+
+1.7. “Larger Work”
+means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.
+
+1.8. “License”
+means this document.
+
+1.9. “Licensable”
+means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.
+
+1.10. “Modifications”
+means any of the following:
+
+any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or
+
+any new file in Source Code Form that contains any Covered Software.
+
+1.11. “Patent Claims” of a Contributor
+means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.
+
+1.12. “Secondary License”
+means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.
+
+1.13. “Source Code Form”
+means the form of the work preferred for making modifications.
+
+1.14. “You” (or “Your”)
+means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+2. License Grants and Conditions
+2.1. Grants
+Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
+
+under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and
+
+under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version.
+
+2.2. Effective Date
+The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor:
+
+for any code that a Contributor has removed from Covered Software; or
+
+for infringements caused by: (i) Your and any other third party’s modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or
+
+under Patent Claims infringed by Covered Software in the absence of its Contributions.
+
+This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3).
+
+2.5. Representation
+Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.
+
+2.7. Conditions
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1.
+
+3. Responsibilities
+3.1. Distribution of Source Form
+All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form.
+
+3.2. Distribution of Executable Form
+If You distribute Covered Software in Executable Form then:
+
+such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and
+
+You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients’ rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).
+
+3.4. Notices
+You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.
+
+5. Termination
+5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.
+
+6. Disclaimer of Warranty
+Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer.
+
+7. Limitation of Liability
+Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.
+
+8. Litigation
+Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims.
+
+9. Miscellaneous
+This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+10.1. New Versions
+Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.
+
+10.2. Effect of New Versions
+You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.
+
+10.3. Modified Versions
+If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
+If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+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/.
+
+If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - “Incompatible With Secondary Licenses” Notice
+This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,184 @@
+ <br>
+<p align="center">
+  <img src="docs/images/logo.png" alt="devexperts-logo" width="294px" height="100px"/>
+</p>
+
+<h1 align="center">DXCharts Lite - one of the most powerful financial charting tools</h1>
+
+<p align="center">
+  <i>
+    DXcharts Lite is a modern solution made for visualization financial data with full variety of charts.<br>
+    It's been created and tempered as a part of big tradings apps with millions of users.<br>
+    Now it's grown enough to be recognized as independent product capable to support any from your needs<br>
+    as a simple widget for blog and as a part of big enterprise solution for trading.
+  </i>
+  <br>
+</p>
+
+<p align="center">
+  <a href="https://opensource.org/licenses/MPL-2.0">
+    <img src="https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg" alt="License: MPL 2.0" />
+  </a>&nbsp;
+  <a href="https://devexperts.com/kb/dxcharts/docs/how-to-contribute">
+    <img src="https://img.shields.io/static/v1?label=PRs&message=Welcome&color=blue" alt="PRs: Welcome" />
+  </a>&nbsp;
+  <a href="https://devexperts.com/dxcharts-demo/?lang=en">
+    <img src="https://img.shields.io/static/v1?label=Latest%20version&message=1.0.0&color=blue" alt="Version" />
+  </a>
+</p>
+
+<br>
+
+<p align="center">
+  <img src="docs/images/fourbasiccharts.png" width="1000px" alt="4 charts example"/>
+</p>
+
+<hr>
+
+## Overview
+
+Get started with DXCharts Lite, install the library and configure it as you want.
+
+-   🚀 [Quick start](#quick-start)
+    -   📦 [Installation](#installation)
+    -   🛠️ [Create Chart](#create-chart)
+    -   📈 [Set data](#set-data)
+    -   📄 [HTML markup](#html-markup)
+-   ⚙️ [Configuration](#configuration)
+-   🔌 [API](#api)
+-   📒 [Examples](#examples)
+-   🧮 [Demo](#demo)
+
+## Quick-start
+
+### Installation
+
+Install library to your project:
+
+```js
+npm install @devexperts/dxcharts-lite
+```
+
+Your `package.json` after installation:
+
+```json
+"dependencies": {
+	"@devexperts/dxcharts-lite": "1.0.0",
+	...
+}
+```
+
+### Create chart
+
+If you use webpack or any other bundler - import `createChart` method and pass element where the chart will be rendered as a first argument.
+
+```js
+export const createChartInstance = () => {
+	const container = document.getElementById('chart_container');
+	const chartInstance = DXChart.createChart(container);
+	return chartInstance;
+};
+```
+
+`createChart` - method, that creates a new chart instance using ChartBootstrap class and returns it.
+
+Method accepts 2 parameters:
+
+-   `element` - The HTML element where the chart will be rendered
+-   `config` (optional) - instance of [ChartConfig](/chart/chart-config/overview)
+
+> Also, please, set `width: 100%` and `height: 100%` for parent container
+> by default chart is auto-resizing to parent
+> you can change it by setting `fixedSize` in config
+
+Now you should have empty chart on screen.
+
+### Set data
+
+Let's pass in some data i.e. `Candles`. You can use bundled function to generate some mock data.
+Import `generateCandlesData` and call it to generate candles.
+Also, you would need `Instrument` object - it is required to show instrument description on chart and show correct price precisions on Y axis.
+
+```js
+export const generateMockData = () => {
+	const mockCandles = generateCandlesData();
+	const mockInstrument = {
+		symbol: 'AAPL',
+		priceIncrements: [0.01],
+	};
+	chartInstance.chartComponent.setMainSeries({ candles: mockCandles, instrument: mockInstrument });
+};
+```
+
+Now you should see chart just like image below:
+
+<p align="center">
+  <img src="docs/images/basicchart.png" width="1000px" alt="Basic chart"/>
+</p>
+
+### HTML-markup
+
+Here is full quick-start code example:
+
+```markup
+<html>
+    <head>
+        <script src="https://webdev.prosp.devexperts.com:8095/dxcharts-lite-cdn/dxchart.min.js"></script>
+    </head>
+    <body>
+        <div id="chart_container"></div>
+    </body>
+    <script type="module">
+        import generateCandlesData from 'https://webdev.prosp.devexperts.com:8095/dxcharts-lite-cdn/chart/utils/candles-generator.utils.js';
+
+        // create chart instance, pass parent container as 1st argument
+        const container = document.getElementById("chart_container");
+        const chartInstance = DXChart.createChart(container);
+        // create and set candles data
+        const mockCandles = generateCandlesData();
+        const mockInstrument = {
+            symbol: 'AAPL',
+            priceIncrements: [0.01],
+        };
+        chartInstance.chartComponent.setMainSeries({ candles: mockCandles, instrument: mockInstrument });
+  </script>
+```
+
+## Configuration
+
+You can configure chart with `ChartConfig` object. It is optional.
+
+`ChartConfig` is used to set initial properties for chart instance.
+Below you can see full table of it, and other options, that `ChartConfig` consists of.
+
+-   [`FullChartConfig`](docs/generated/FullChartConfig.md)
+
+## API
+
+Every chart component has an API allowing change a lot of params on the fly.
+Change appearance at runtime.
+Subscribe on different events in chart (like HOVER on candle)
+
+Here are the links of the main components:
+
+-   [`ChartComponent`](docs/generated/ChartComponent.md) - set data, subscribe on data changes
+-   [`XAxisComponent`](docs/generated/XAxisComponent.md) - configure x-labels
+-   [`YAxisComponent`](docs/generated/YAxisComponent.md) - configure labels and set y-axis type
+-   [`CrossToolComponent`](docs/generated/CrossToolComponent.md) - cross-hair type, OHLC magnet
+-   [`EventsComponent`](docs/generated/EventsComponent.md) - set events data
+-   [`VolumesComponent`](docs/generated/VolumesComponent.md) - set volumes
+-   [`WaterMarkComponent`](docs/generated/WaterMarkComponent.md) - create and manage a watermark
+-   [`NavigationMapComponent`](docs/generated/NavigationMapComponent.md) - create a navigation map
+-   [`SnapshotComponent`](docs/generated/SnapshotComponent.md) - create a snapshot
+-   [`HighlightsComponent`](docs/generated/HighlightsComponent.md) - allows to draw highlights of some canvas objects such as labels
+-   [`PaneManager`](docs/generated/PaneManager.md) - create and manage panes
+-   [`PaneComponent`](docs/generated/PaneComponent.md) - create and manage panes data series
+
+## Examples
+
+We have created a lot of examples with different chart configuration.
+You can find them [here](https://github.com/devexperts/dxcharts-lite/tree/master/docs/how-to).
+
+## Demo
+
+To show you how it's beautiful, we have created [Demo version](https://devexperts.com/dxcharts-demo/), based on DXCharts Lite. Feel all power of our library!

package/dist/chart/animation/canvas-animation.d.ts

@@ -0,0 +1,96 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+import EventBus from '../events/event-bus';
+import { Animation } from './types/animation';
+import { ColorAlphaAnimationConfig, ColorAlphaAnimation } from './types/color-alpha-animation';
+import { ColorTransitionAnimationConfig, ColorTransitionAnimation } from './types/color-transition-animation';
+import { ViewportMovementAnimationConfig, ViewportMovementAnimation } from './types/viewport-movement-animation';
+import { ViewportModel } from '../model/scaling/viewport.model';
+import { StringTMap } from '../utils/object.utils';
+export interface AnimationConfig {
+    duration: number;
+    timeLeft?: number;
+}
+export declare const VIEWPORT_ANIMATION_ID = "VIEWPORT_ANIMATION";
+/**
+ * Singleton animation container for all chart animations.
+ * Does the following things:
+ *  - registers animations and updates their state
+ *  - fires only 1 DRAW event for all animations at once
+ *
+ * Add specific animation here as well with typed API.
+ * Like "color" animation which auto-updates color alpha channel.
+ *
+ * @doc-tags chart-core,animation
+ */
+export declare class CanvasAnimation {
+    private eventBus;
+    animationIntervalId?: number;
+    animations: StringTMap<Animation>;
+    constructor(eventBus: EventBus);
+    /**
+     * Starts a viewport movement animation with the given configuration and adds it to the list of animations.
+     * @param {ViewportModel} viewportModel - The viewport model to animate.
+     * @param {ViewportMovementAnimationConfig} config - The configuration for the animation.
+     * @param {string} [uniqueAnimationId=VIEWPORT_ANIMATION_ID] - The unique ID for the animation.
+     * @param {Function} [onTickFunction] - The function to be called on each tick of the animation.
+     * @returns {ViewportMovementAnimation} The container for the created animation.
+     */
+    startViewportMovementAnimation(viewportModel: ViewportModel, config: ViewportMovementAnimationConfig, uniqueAnimationId?: string, onTickFunction?: () => void): ViewportMovementAnimation;
+    /**
+     * Starts a color alpha animation with the given configuration and adds it to the list of animations.
+     * @param {string} uniqueAnimationId - A unique identifier for the animation.
+     * @param {Array<ColorAlphaAnimationConfig>} colorConfigs - An array of color alpha animation configurations.
+     * @param {() => void} [onTickFunction] - A function to be called on each animation tick.
+     * @param {Partial<ACAnimationConfig>} [animationConfig] - An optional configuration for the animation.
+     * @returns {ColorAlphaAnimation} - The created animation container.
+     */
+    startColorAlphaAnimation(uniqueAnimationId: string, colorConfigs: Array<ColorAlphaAnimationConfig>, onTickFunction?: () => void, animationConfig?: Partial<AnimationConfig>): ColorAlphaAnimation;
+    /**
+     * Starts a color transition animation with the given configurations and duration.
+     * @param {string} uniqueAnimationId - A unique identifier for the animation.
+     * @param {Array<ColorTransitionAnimationConfig>} colorConfigs - An array of color transition configurations.
+     * @param {number} [duration=DEFAULT_ANIMATION_TIME] - The duration of the animation in milliseconds.
+     * @param {Function} [onTickFunction] - A function to be called on each tick of the animation.
+     * @returns {ColorTransitionAnimation} - The created animation container.
+     */
+    startColorTransitionAnimation(uniqueAnimationId: string, colorConfigs: Array<ColorTransitionAnimationConfig>, duration?: number, onTickFunction?: () => void): ColorTransitionAnimation;
+    /**
+     * This function takes an id as a string and returns an animation container object of type T. It retrieves the animation container object from the animations object using the provided id. The @ts-ignore comment is used to ignore any TypeScript errors that may occur due to the dynamic nature of the function.
+     */
+    getAnimation<T extends Animation>(id: string): T;
+    /**
+     * Returns a ColorAlphaAnimation object for the given animation ID.
+     *
+     * @param {string} id - The ID of the animation to retrieve.
+     * @returns {ColorAlphaAnimation} - The ColorAlphaAnimation object for the given ID.
+     */
+    getColorAlphaAnimation(id: string): ColorAlphaAnimation;
+    /**
+     * Returns a ColorTransitionAnimation object for the given id.
+     * @param {string} id - The id of the animation to retrieve.
+     * @returns {ColorTransitionAnimation} - The ColorTransitionAnimation object for the given id.
+     */
+    getColorTransitionAnimation(id: string): ColorTransitionAnimation;
+    /**
+     * Stops the animation with the given ID.
+     * @param {string} id - The ID of the animation to be stopped.
+     * @returns {void}
+     */
+    forceStopAnimation(id: string): void;
+    /**
+     * This method ensures that the animation interval is started. If the animation interval ID is not set, it sets it to a new interval ID using `window.setInterval()` with a callback function of `this.tick()` and a delay of 20 milliseconds.
+     */
+    private ensureIntervalStarted;
+    /**
+     * This is a private method that iterates through all the animations in the container and calls their tick method. If any animation is still in progress, it sets the allCompleted flag to false. If all animations are completed, it stops the interval. If not, it fires the draw event.
+     */
+    private tick;
+    /**
+     * Stops the interval for the animation.
+     */
+    private stopInterval;
+}

package/dist/chart/animation/canvas-animation.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+import{ColorAlphaAnimation as r}from"./types/color-alpha-animation";import{ColorTransitionAnimation as s}from"./types/color-transition-animation";import{ViewportMovementAnimation as m}from"./types/viewport-movement-animation";const e=10;export const VIEWPORT_ANIMATION_ID="VIEWPORT_ANIMATION";export class CanvasAnimation{constructor(t){this.eventBus=t,this.animations={}}startViewportMovementAnimation(t,n,i=VIEWPORT_ANIMATION_ID,o){const a=new m(t,n,o);return this.animations[i]=a,this.ensureIntervalStarted(),a}startColorAlphaAnimation(t,n,i,o){const a=new r(Object.assign(Object.assign({},o),{duration:o&&o.duration||e}),n,i);return this.animations[t]=a,this.ensureIntervalStarted(),a}startColorTransitionAnimation(t,n,i=e,o){const a=new s({duration:i},n,o);return this.animations[t]=a,this.ensureIntervalStarted(),a}getAnimation(t){return this.animations[t]}getColorAlphaAnimation(t){return this.getAnimation(t)}getColorTransitionAnimation(t){return this.getAnimation(t)}forceStopAnimation(t){const n=this.animations[t];n&&(n.animationTimeLeft=-1,n.animationInProgress=!1)}ensureIntervalStarted(){this.animationIntervalId||(this.animationIntervalId=window.setInterval(()=>this.tick(),20))}tick(){let t=!0;for(const n of Object.keys(this.animations)){const i=this.animations[n];i.tick(),i.animationInProgress&&(t=!1)}t?this.stopInterval():this.eventBus.fireDraw()}stopInterval(){clearInterval(this.animationIntervalId),this.animationIntervalId=void 0}}

package/dist/chart/animation/types/animation.d.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+import { AnimationConfig } from '../canvas-animation';
+interface AnimationAware {
+    tick: () => void;
+}
+/**
+ * Basic animation. Holds current state: inProgress, timeLeft.
+ * Additional params are useful to pass data which helps animating.
+ */
+export declare class Animation implements AnimationAware {
+    private onTickFunction?;
+    animationTime: number;
+    animationTimeLeft: number;
+    animationInProgress: boolean;
+    constructor(animationConfig: AnimationConfig, onTickFunction?: (() => void) | undefined);
+    /**
+     * Decrements the animation time left and executes the onTickFunction if it exists.
+     * If the animation time left reaches zero, sets the animationInProgress flag to false.
+     */
+    tick(): void;
+    /**
+     * Calculates the normalized progress of an animation.
+     * @returns {number} A value between 0 and 1 representing the progress of the animation.
+     */
+    getProgress(): number;
+    /**
+     * Sets the animationInProgress flag to false and resets the animationTimeLeft to 0.
+     */
+    finishAnimation(): void;
+}
+export {};

package/dist/chart/animation/types/animation.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+export class Animation{constructor(i,t){this.onTickFunction=t,this.animationTimeLeft=0,this.animationInProgress=!1,this.animationTime=i.duration,this.animationTimeLeft=i.timeLeft===void 0?i.duration:i.timeLeft,this.animationInProgress=!0}tick(){this.animationTimeLeft<=0?this.animationInProgress=!1:this.animationTimeLeft--,this.onTickFunction&&this.onTickFunction()}getProgress(){return 1-this.animationTimeLeft/this.animationTime}finishAnimation(){this.animationInProgress=!1,this.animationTimeLeft=0}}

package/dist/chart/animation/types/color-alpha-animation.d.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+import { AnimationConfig } from '../canvas-animation';
+import { Animation } from './animation';
+import * as Color from 'color';
+interface CustomColor extends Color {
+    readonly valpha?: number;
+}
+export interface ColorAlphaAnimationConfig {
+    color: string;
+    type: 'appearing' | 'fading';
+}
+interface ColorAlphaAnimationConfigInternal extends ColorAlphaAnimationConfig {
+    rgbColor?: CustomColor;
+    currentAnimationColor?: Color;
+    initialAlpha?: number;
+}
+/**
+ * Color animation automatically updates alpha channel of provided colors on each tick.
+ * Can be in 'appearing' and 'fading' state.
+ */
+export declare class ColorAlphaAnimation extends Animation {
+    private colorConfigs;
+    constructor(animationConfig: AnimationConfig, colorConfigs: Array<ColorAlphaAnimationConfigInternal>, onTickFunction?: () => void);
+    /**
+     * Updates the current animation color of each color configuration based on the animation type and time left. If an animation is in progress, it iterates over each color configuration and updates its current animation color. If the configuration has an initial alpha and RGB color, it calculates the new alpha value based on the animation time left and updates the current animation color accordingly. The animation type can be either 'fading' or 'appearing'.
+     */
+    tick(): void;
+    /**
+     * Returns the color of the current animation for a given index.
+     * @param {number} index - The index of the color configuration to retrieve.
+     * @returns {string} - The color of the current animation for the given index, or white if not found.
+     */
+    getColor(index: number): string;
+    /**
+     * This function reverts the animation by changing the type of color configurations from 'fading' to 'appearing' and vice versa. It also ensures that the animationTimeLeft is not zero to avoid getting stuck in the middle of the animation.
+     */
+    revert(): void;
+}
+export {};

package/dist/chart/animation/types/color-alpha-animation.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+import{Animation as o}from"./animation";import*as e from"color";export class ColorAlphaAnimation extends o{constructor(i,t,a=()=>{}){super(i,a),this.colorConfigs=t,t.forEach(r=>{r.rgbColor=e.rgb(r.color),r.initialAlpha=r.rgbColor.valpha,r.currentAnimationColor=r.rgbColor})}tick(){super.tick(),this.animationInProgress&&this.colorConfigs.forEach(i=>{i.initialAlpha===void 0||i.rgbColor===void 0||(i.type==="fading"?i.currentAnimationColor=i.rgbColor.alpha(i.initialAlpha*this.animationTimeLeft/this.animationTime):i.type==="appearing"&&(i.currentAnimationColor=i.rgbColor.alpha(i.initialAlpha*(1-this.animationTimeLeft/this.animationTime))))})}getColor(i){var t,a;return(a=(t=this.colorConfigs[i].currentAnimationColor)===null||t===void 0?void 0:t.toString())!==null&&a!==void 0?a:"#FFFFFF"}revert(){this.animationTimeLeft=Math.max(this.animationTime-this.animationTimeLeft,1),this.colorConfigs.forEach(i=>{i.type==="fading"?i.type="appearing":i.type="fading"})}}

package/dist/chart/animation/types/color-transition-animation.d.ts

@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+import { AnimationConfig } from '../canvas-animation';
+import { Animation } from './animation';
+import * as Color from 'color';
+export interface ColorTransitionAnimationConfig {
+    startColor: string;
+    endColor: string;
+    type: 'appearing' | 'fading';
+}
+interface ColorTransitionAnimationConfigInternal extends ColorTransitionAnimationConfig {
+    rgbStartColor?: Color;
+    rgbEndColor?: Color;
+    currentAnimationColor?: Color;
+}
+/**
+ * Color transition calculates color between start..end color for each tick.
+ * Can be in 'appearing' and 'fading' state; 'fading' is just reverting the colors order.
+ */
+export declare class ColorTransitionAnimation extends Animation {
+    private colorConfigs;
+    constructor(animationConfig: AnimationConfig, colorConfigs: Array<ColorTransitionAnimationConfigInternal>, onTickFunction?: () => void);
+    /**
+     * Updates the current animation color for each color configuration based on the progress of the animation.
+     * If an animation is in progress, it calculates the transition color for each configuration based on the start and end colors and the current progress of the animation.
+     * If the configuration type is "fading", it transitions from the end color to the start color, and if the type is "appearing", it transitions from the start color to the end color.
+     * @function
+     * @returns {void}
+     */
+    tick(): void;
+    /**
+     * Returns the color of the current animation for a given index.
+     * @param {number} index - The index of the color configuration to retrieve.
+     * @returns {string} - The color of the current animation for the given index, or white if not found.
+     */
+    getColor(index: number): string;
+    /**
+     * Reverts the animation by changing the type of color configurations from 'fading' to 'appearing' and vice versa.
+     * It also ensures that the animation does not halt in the middle by setting the animationTimeLeft to the maximum of (animationTime - animationTimeLeft) and 1.
+     * @function
+     * @returns {void}
+     */
+    revert(): void;
+    /**
+     * Moves animation state to one last tick - instant-finishing animation as result.
+     */
+    moveToLastTick(): void;
+    /**
+     * Calculates new color in between of 2 colors.
+     * @param startColor - from color
+     * @param endColor - to color
+     * @param progress - number between 0..1
+     */
+    private calculateTransitionColor;
+}
+export {};

package/dist/chart/animation/types/color-transition-animation.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (C) 2002 - 2023 Devexperts LLC
+ * 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/.
+ */
+import{Animation as l}from"./animation";import*as e from"color";export class ColorTransitionAnimation extends l{constructor(r,t,o=()=>{}){super(r,o),this.colorConfigs=t,t.forEach(i=>{i.rgbStartColor=e.rgb(i.startColor),i.rgbEndColor=e.rgb(i.endColor),i.currentAnimationColor=i.type==="appearing"?i.rgbStartColor:i.rgbEndColor})}tick(){super.tick(),this.animationInProgress&&this.colorConfigs.forEach(r=>{const t=1-this.animationTimeLeft/this.animationTime;!r.rgbStartColor||!r.rgbEndColor||(r.type==="fading"?r.currentAnimationColor=this.calculateTransitionColor(r.rgbEndColor,r.rgbStartColor,t):r.type==="appearing"&&(r.currentAnimationColor=this.calculateTransitionColor(r.rgbStartColor,r.rgbEndColor,t)))})}getColor(r){var t,o;return(o=(t=this.colorConfigs[r].currentAnimationColor)===null||t===void 0?void 0:t.toString())!==null&&o!==void 0?o:"#FFFFFF"}revert(){this.animationTimeLeft=Math.max(this.animationTime-this.animationTimeLeft,1),this.colorConfigs.forEach(r=>{r.type==="fading"?r.type="appearing":r.type="fading"})}moveToLastTick(){this.animationTimeLeft=1}calculateTransitionColor(r,t,o){const i=r.red()-(r.red()-t.red())*o,a=r.green()-(r.green()-t.green())*o,n=r.blue()-(r.blue()-t.blue())*o;return e.rgb(i,a,n)}}