@devexperts/dxcharts-lite 1.0.1

package/dist/chart/components/volumes/volumes.model.d.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 { BehaviorSubject } from 'rxjs';
+import { ChartBaseElement } from '../../model/chart-base-element';
+import { ScaleModel } from '../../model/scale.model';
+import { HighLowProvider } from '../../model/scaling/auto-scale.model';
+import { ChartComponent } from '../chart/chart.component';
+export declare class VolumesModel extends ChartBaseElement {
+    private chartComponent;
+    private scaleModel;
+    volumeMax: BehaviorSubject<number>;
+    highLowProvider: HighLowProvider;
+    constructor(chartComponent: ChartComponent, scaleModel: ScaleModel);
+    protected doActivate(): void;
+    /**
+     * Used for optimization when we have to update only the last candle
+     * Doesn't work for line chart types
+     * @doc-tags tricky
+     */
+    private recalculateLastVisualVolume;
+    /**
+     * Updates the maximum volume value of the chart.
+     * @function
+     * @name updateVolumeMax
+     * @memberof ChartComponent
+     * @returns {void}
+     */
+    updateVolumeMax(): void;
+}

package/dist/chart/components/volumes/volumes.model.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{BehaviorSubject as o,merge as i}from"rxjs";import{ChartBaseElement as s}from"../../model/chart-base-element";import{firstOf as l,maxMin as r}from"../../utils/array.utils";const h=r(t=>t.candle.volume);export class VolumesModel extends s{constructor(e,a){super(),this.chartComponent=e,this.scaleModel=a,this.volumeMax=new o(0),this.highLowProvider={calculateHighLow:()=>({high:this.volumeMax.getValue(),low:0}),isHighLowActive:()=>!0}}doActivate(){super.doActivate(),this.addRxSubscription(i(this.chartComponent.chartModel.observeCandlesChanged(),this.scaleModel.xChanged).subscribe(()=>this.updateVolumeMax())),this.addRxSubscription(this.chartComponent.chartModel.mainCandleSeries.observeLastVisualCandleChanged().subscribe(()=>this.recalculateLastVisualVolume()))}recalculateLastVisualVolume(){}updateVolumeMax(){var e;this.volumeMax.next((e=l(h(this.chartComponent.chartModel.mainCandleSeries.getSeriesInViewport().flat())))!==null&&e!==void 0?e:0)}}

package/dist/chart/components/watermark/water-mark.component.d.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 { CanvasBoundsContainer } from '../../canvas/canvas-bounds-container';
+import { ChartBaseElement } from '../../model/chart-base-element';
+import { FullChartConfig } from '../../chart.config';
+import { CanvasModel } from '../../model/canvas.model';
+import { DrawingManager } from '../../drawers/drawing-manager';
+import EventBus from '../../events/event-bus';
+import { ChartModel } from '../chart/chart.model';
+import { PaneManager } from '../pane/pane-manager.component';
+export interface WaterMarkConfig {
+    isVisible?: boolean;
+    fontFamily?: string;
+    firstRowFontSize?: number;
+    firstRowBottomPadding?: number;
+    secondRowFontSize?: number;
+    secondRowBottomPadding?: number;
+    thirdRowFontSize?: number;
+}
+export interface WaterMarkData {
+    firstRow?: string;
+    secondRow?: string;
+    thirdRow?: string;
+}
+export declare class WaterMarkComponent extends ChartBaseElement {
+    private paneManager;
+    private chartModel;
+    eventBus: EventBus;
+    private config;
+    canvasModel: CanvasModel;
+    private waterMarkDrawer;
+    private waterMarkConfig;
+    private waterMarkData;
+    constructor(paneManager: PaneManager, chartModel: ChartModel, eventBus: EventBus, config: FullChartConfig, canvasBoundsContainer: CanvasBoundsContainer, canvasModel: CanvasModel, drawingManager: DrawingManager);
+    /**
+     * Sets the visibility of the watermark component.
+     *
+     * @param {boolean} visible - A boolean indicating whether the watermark should be visible or not.
+     * @returns {void}
+     */
+    setWaterMarkVisible(visible: boolean): void;
+    /**
+     * Sets the watermark data to be used in the canvas.
+     * @param {WaterMarkData} watermarkData - The data to be used as watermark.
+     * @returns {void}
+     */
+    setWaterMarkData(watermarkData: WaterMarkData): void;
+    /**
+     * Returns the water mark data object if it exists, otherwise returns an empty object.
+     * @returns {WaterMarkData} The water mark data object.
+     */
+    private getWaterMarkData;
+    /**
+     * Sets the watermark configuration for the chart.
+     * @param {WaterMarkConfig} watermarkConfig - The configuration object for the watermark.
+     * @returns {void}
+     
+    */
+    setWaterMarkConfig(watermarkConfig: WaterMarkConfig): void;
+    /**
+     * Sets the logo image to be used as a watermark.
+     * @param {CanvasImageSource} img - The image to be used as a watermark.
+     */
+    setLogoImage(img: CanvasImageSource): void;
+    /**
+     * Recalculates the watermark text size based on the chart's width and height.
+     * @param {number} chartWidth - The width of the chart.
+     * @param {number} chartHeight - The height of the chart.
+     * @returns {Object} - An object containing the updated watermark font sizes.
+     */
+    private recalculateTextSize;
+}

package/dist/chart/components/watermark/water-mark.component.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{CHART_UUID as w,CanvasElement as f}from"../../canvas/canvas-bounds-container";import{ChartBaseElement as d}from"../../model/chart-base-element";import{merge as n}from"../../utils/merge.utils";import{WaterMarkDrawer as k}from"./water-mark.drawer";export class WaterMarkComponent extends d{constructor(t,e,c,h,a,i,o){super(),this.paneManager=t,this.chartModel=e,this.eventBus=c,this.config=h,this.canvasModel=i,this.waterMarkConfig=this.config.components.waterMark,this.waterMarkData=this.getWaterMarkData(),this.waterMarkDrawer=new k(this.config,a,i,()=>this.waterMarkConfig,()=>this.waterMarkData),this.addRxSubscription(n(a.observeBoundsChanged(f.PANE_UUID(w)),this.paneManager.panesChangedSubject).subscribe(r=>{this.waterMarkConfig=this.recalculateTextSize(r.width,r.height)})),this.addRxSubscription(this.chartModel.candlesSetSubject.subscribe(()=>{this.waterMarkData=this.getWaterMarkData()})),o.addDrawerAfter(this.waterMarkDrawer,"WATERMARK","DRAWINGS")}setWaterMarkVisible(t){this.config.components&&this.config.components.waterMark&&(this.config.components.waterMark.visible=t,this.canvasModel.fireDraw())}setWaterMarkData(t){this.waterMarkData=t,this.canvasModel.fireDraw()}getWaterMarkData(){return this.waterMarkData||{}}setWaterMarkConfig(t){if(!(!t||!this.config.components)){if(!this.config.components.waterMark)this.config.components.waterMark=JSON.parse(JSON.stringify(t));else{const e={};n(e,t),n(e,this.config.components.waterMark),this.config.components.waterMark=e}this.canvasModel.fireDraw()}}setLogoImage(t){this.waterMarkDrawer.setLogoImage(t)}recalculateTextSize(t,e){const a=g=>.15*Math.log(g)/Math.log(1.5)+1,i=a(t/1920),o=a(e/1080),r=Math.min(i,o),s=r>=0?r:0,M={firstRowFontSize:Math.round(this.config.components.waterMark.firstRowFontSize*s),secondRowFontSize:Math.round(this.config.components.waterMark.secondRowFontSize*s),thirdRowFontSize:Math.round(this.config.components.waterMark.thirdRowFontSize*s)};return Object.assign(Object.assign({},this.config.components.waterMark),M)}}

package/dist/chart/components/watermark/water-mark.drawer.d.ts

@@ -0,0 +1,68 @@
+/*
+ * 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 { Drawer } from '../../drawers/drawing-manager';
+import { ChartConfigComponentsWaterMark, FullChartConfig } from '../../chart.config';
+import { CanvasBoundsContainer } from '../../canvas/canvas-bounds-container';
+import { CanvasModel } from '../../model/canvas.model';
+import { WaterMarkData } from './water-mark.component';
+export type WaterMarkPositionType = 'center' | 'left-top' | 'left-bottom';
+export declare class WaterMarkDrawer implements Drawer {
+    private config;
+    private canvasBoundsContainer;
+    private canvasModel;
+    private waterMarkConfigProvider;
+    private watermarkDataProvider;
+    private logoImage?;
+    constructor(config: FullChartConfig, canvasBoundsContainer: CanvasBoundsContainer, canvasModel: CanvasModel, waterMarkConfigProvider: () => ChartConfigComponentsWaterMark, watermarkDataProvider: () => WaterMarkData);
+    /**
+     * Draws a watermark on the canvas if the watermark is visible and the colors are provided in the configuration.
+     * The watermark consists of three rows of text and an optional logo image.
+     * The height of each row is calculated based on the font size and the actual text height.
+     * The total height of the watermark is calculated by adding the heights of all rows and the logo image.
+     * The watermark is drawn using the drawWaterMark() method and the configuration is provided by the getConfig() method.
+     * The font size and color of each row are provided in the waterMarkConfig object.
+     * The logo image is drawn using the drawImage() method and its dimensions are provided in the waterMarkConfig object.
+     * @function
+     */
+    draw(): void;
+    /**
+     * Returns an array of canvas ids.
+     *
+     * @returns {Array<string>} An array of canvas ids.
+     */
+    getCanvasIds(): Array<string>;
+    /**
+     * Sets the logo image to be displayed.
+     *
+     * @param {CanvasImageSource} img - The image to be set as the logo.
+     * @returns {void}
+     */
+    setLogoImage(img: CanvasImageSource): void;
+    /**
+     * Draws a watermark on the canvas.
+     *
+     * @private
+     * @param {Object} config - The configuration object for the watermark.
+     * @param {string} config.text - The text to be displayed as the watermark.
+     * @param {string} config.font - The font to be used for the watermark.
+     * @param {string} config.color - The color to be used for the watermark.
+     * @param {number} config.x - The x-coordinate of the starting point of the watermark.
+     * @param {number} config.y - The y-coordinate of the starting point of the watermark.
+     * @returns {void}
+     */
+    private drawWaterMark;
+    private getConfig;
+    /**
+     * A method that resets the state of an object to its initial values.
+     *
+     * @function
+     * @name reset
+     * @returns {void}
+     */
+    reset(): void;
+}
+export declare const reCountingSize: (config: FullChartConfig, canvasBoundsContainer: CanvasBoundsContainer, fontSize: number, fontWidth: number) => string;
+export declare const setFont: (config: FullChartConfig, fontSize: number) => string;

package/dist/chart/components/watermark/water-mark.drawer.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{CHART_UUID as k,CanvasElement as B}from"../../canvas/canvas-bounds-container";export class WaterMarkDrawer{constructor(e,n,s,w,h){this.config=e,this.canvasBoundsContainer=n,this.canvasModel=s,this.waterMarkConfigProvider=w,this.watermarkDataProvider=h,this.getConfig=(d=0,r,l,g,R,t)=>{const i=this.canvasModel.ctx,o=this.canvasBoundsContainer.getBounds(B.PANE_UUID(k)),{position:u,offsetY:m,offsetX:x}=this.config.components.waterMark;let a;switch(t?a=t:(i.font=setFont(this.config,l),a=i.measureText(r).width,o.width-10<a&&(i.font=reCountingSize(this.config,this.canvasBoundsContainer,l,a),a=i.measureText(r).width)),u){case"left-top":return{x:x+o.x,y:m+d+o.y,font:i.font,text:r,color:g};case"left-bottom":return{x:x+o.x,y:o.height-R-m+d+o.y,font:i.font,text:r,color:g};case"center":return{x:o.width/2-a/2+o.x,y:(o.height-R)/2+d+o.y,font:i.font,text:r,color:g}}}}draw(){var e,n,s,w,h,d,r;if(!((e=this.config.components.waterMark)===null||e===void 0)&&e.visible&&this.config.colors){const{firstRow:l,secondRow:g,thirdRow:R}=this.watermarkDataProvider(),t=this.waterMarkConfigProvider(),i=this.config.colors.waterMarkTheme,o=this.canvasModel.ctx;let u=0,m=0,x=0,a=0,v=0;if(o.save(),t.firstRowFontSize&&l){o.font=setFont(this.config,t.firstRowFontSize);const c=o.measureText(l);u=c.actualBoundingBoxAscent+c.actualBoundingBoxDescent}if(t.secondRowFontSize&&g){o.font=setFont(this.config,t.secondRowFontSize);const c=o.measureText(g);m=c.actualBoundingBoxAscent+c.actualBoundingBoxDescent,x=(n=t.firstRowBottomPadding)!==null&&n!==void 0?n:0}if(t.thirdRowFontSize&&R){o.font=setFont(this.config,t.thirdRowFontSize);const c=o.measureText(R);a=c.actualBoundingBoxAscent+c.actualBoundingBoxDescent,v=(s=t.secondRowBottomPadding)!==null&&s!==void 0?s:0}const p=(w=t.thirdRowBottomPadding)!==null&&w!==void 0?w:0,C=(h=t.logoHeight)!==null&&h!==void 0?h:0,M=u+m+x+a+v+p+C;if(l&&this.drawWaterMark(this.getConfig(u,l,t.firstRowFontSize,i.firstRowColor,M)),g&&this.drawWaterMark(this.getConfig(u+x+m,g,t.secondRowFontSize,i.secondRowColor,M)),R&&this.drawWaterMark(this.getConfig(u+x+m+v+a,R,t.thirdRowFontSize,i.thirdRowColor,M)),this.logoImage){const c=this.getConfig(u+x+m+v+a+p,"",t.thirdRowFontSize,i.thirdRowColor,M,t.logoWidth);this.canvasModel.ctx.drawImage(this.logoImage,c.x,c.y,(d=t.logoWidth)!==null&&d!==void 0?d:0,(r=t.logoHeight)!==null&&r!==void 0?r:0)}o.restore()}}getCanvasIds(){return[this.canvasModel.canvasId]}setLogoImage(e){this.logoImage=e}drawWaterMark(e){const n=e.text;if(!n||!n.length)return;const s=this.canvasModel.ctx;s.font=e.font,s.fillStyle=e.color;const w=e.x,h=e.y;s.fillText(n,w,h)}reset(){}}export const reCountingSize=(f,e,n,s)=>{const h=((r,l)=>e.getBounds(B.CHART).width/l*r)(n,s);let d;return f.components&&f.components.waterMark&&(d=f.components.waterMark.fontFamily),h+"px "+d},setFont=(f,e)=>{let n;return f.components&&f.components.waterMark&&(n=f.components.waterMark.fontFamily),e+"px "+n};

package/dist/chart/components/x_axis/numeric-x-axis-labels.generator.d.ts

@@ -0,0 +1,25 @@
+/*
+ * 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 { NumericAxisLabel, NumericAxisLabelsGenerator } from '../labels_generator/numeric-axis-labels.generator';
+import { ViewportModel } from '../../model/scaling/viewport.model';
+import { XAxisLabelsGenerator } from './x-axis-labels.generator';
+/**
+ * Y axis labels generator for prices. Respects price increment from instrument.
+ */
+export declare class NumericXAxisLabelsGenerator extends NumericAxisLabelsGenerator implements XAxisLabelsGenerator {
+    constructor(viewportModel: ViewportModel, valueFormatter?: (value: number, precision?: number) => string);
+    get labels(): NumericAxisLabel[];
+    /**
+     * Recalculates the labels of the chart.
+     * Calls the generateNumericLabels method to generate new numeric labels.
+     */
+    recalculateLabels(): void;
+    /**
+     * Invalidates the labels cache and generates numeric labels.
+     * @returns {void}
+     */
+    generateLabels(): void;
+}

package/dist/chart/components/x_axis/numeric-x-axis-labels.generator.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{NumericAxisLabelsGenerator as s}from"../labels_generator/numeric-axis-labels.generator";export class NumericXAxisLabelsGenerator extends s{constructor(e,a=r=>`${r}`){super(null,()=>[e.yStart,e.yEnd],()=>e.getBounds().width,a,!1,()=>"regular",()=>0,void 0)}get labels(){return this.labelsCache.calculateOrGet()}recalculateLabels(){this.generateNumericLabels()}generateLabels(){this.labelsCache.invalidate(),this.generateNumericLabels()}}

package/dist/chart/components/x_axis/time/parser/time-formats-matchers.functions.d.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 { ParsedTimeFormat } from './time-formats.model';
+/**
+ * {@link TimeFormatMatcher} is a function that controls does passed {@link Date} match the {@link ParsedTimeFormat}
+ * that matcher is responsible for.
+ * Moreover {@link TimeFormatMatcher} compares dates to prevent including the same date
+ * for a corresponding period twice.
+ * @see
+ * Basically you need to use {@link timeFormatMatcherFactory}, because it'll catch up the
+ * matcher for the given {@link ParsedTimeFormat} automatically
+ * @example
+ * // In examples we will test the `currentDate`
+ *
+ * const currentDate = new Date('Fri Feb 10 2023 14:50:10 GMT+0500');
+ * const prevDate = new Date('Fri Feb 09 2023 14:50:10 GMT+0500');
+ * // that `timeFormat` means, that we want to get only dates
+ * // that represents days that are divisible by 10 (10, 20, 30)
+ * const timeFormat: ParsedTimeFormat = {
+ * 	key: 'day',
+ *     value: 10,
+ *     exact: false
+ * };
+ * // `timeFormatMatcherFactory` will automatically get the matcher for a given `timeFormat`
+ * const matcher = timeFormatMatcherFactory(timeFormat)
+ *
+ * // `true`, because `Feb 10' is divisible by 10,
+ * // and the `previousDate` was not the same `day`
+ * const applicable = matcher(currentDate)(prevDate); // true
+ *
+ * @example
+ * const currentDate = new Date('Fri Feb 10 2023 14:50:10 GMT+0500');
+ * const prevDate = new Date('Fri Feb 09 2023 14:50:10 GMT+0500');
+ * // that `timeFormat` means, that we want to get only dates
+ * // that represents months that are divisible by 3 (March, June etc.)
+ * const timeFormat: ParsedTimeFormat = {
+ * 	key: 'month',
+ *     value: 3,
+ *     exact: false
+ * };
+ * const matcher = timeFormatMatcherFactory(timeFormat)
+ * // `false`, because `Feb 02' i.e 2
+ * // is not divisible by 3, and the `previousDate` is `Feb` i.e the same `month`
+ * const applicable = matcher(currentDate)(prevDate); // false
+ */
+export type TimeFormatMatcher = (currentDate: Date, prevDate: Date) => boolean;
+/**
+ * Factory that return a {@link TimeFormatMatcher} function for a given {@link ParsedTimeFormats}
+ * @see
+ * Detailed explanation you can find here {@link TimeFormatMatcher}
+ */
+export declare const timeFormatMatcherFactory: <T extends ParsedTimeFormat>(timeFormat: T) => TimeFormatMatcher;

package/dist/chart/components/x_axis/time/parser/time-formats-matchers.functions.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{eachDayOfInterval as k,isSameDay as h,isMonday as M,isTuesday as f,isWednesday as i,isThursday as v,isFriday as w,isSaturday as T,isSunday as g,startOfMonth as S,endOfMonth as O}from"date-fns/esm";export const timeFormatMatcherFactory=e=>{switch(e.key){case"lessThanSecond":return N(e);case"month":return W(e);case"second":case"minute":case"hour":case"day":case"year":return B(e);case"week-weekday":return C(e);default:return()=>!1}};const r=(e,s)=>{switch(s){case"lessThanSecond":return e.getMilliseconds();case"month":return e.getMonth();case"second":return e.getSeconds();case"minute":return e.getMinutes();case"hour":return e.getHours();case"day":return e.getDate();case"year":return e.getFullYear();case"week-weekday":return e.getDate()}},o=e=>(s,n)=>{const c=r(s,e),t=r(n,e);return c!==t},p=e=>(s,n)=>{const c=r(s,e),t=r(n,e);return c>=t},x={1:M,2:f,3:i,4:v,5:w,6:T,7:g},I=(e,s,n)=>{var c;const t=k({start:S(e),end:O(e)}),u=(c=x[n])!==null&&c!==void 0?c:()=>!1;if(s==="$"){for(const a of t.reverse())if(u(a))return h(e,a)}else{let a=1;for(const y of t)if(u(y)){if(a===s)return h(e,y);a++}}return!1},l=(e,s)=>s===1?e===1:e/s===1,d=(e,s)=>s===1?!0:e%s===0,N=e=>(s,n)=>p(e.key)(s,n),W=e=>(s,n)=>{const c=o(e.key)(s,n),t=e.exact?l(r(s,e.key)+1,e.value):d(r(s,e.key)+1,e.value);return c&&t},B=e=>(s,n)=>{const c=o(e.key)(s,n),t=e.exact?l(r(s,e.key),e.value):d(r(s,e.key),e.value);return c&&t},C=e=>(s,n)=>{const c=o(e.key)(s,n),t=I(s,e.week,e.weekday);return c&&t};

package/dist/chart/components/x_axis/time/parser/time-formats-parser.functions.d.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 { ParsedTimeFormat, TimeFormatWithDuration } from './time-formats.model';
+/**
+ * Parses the {@link TimeFormatWithDuration}
+ * and returns {@link ParsedTimeFormat} for a successfil parsing and `null`
+ * if the {@link TimeFormatWithDuration} couldn't be parsed.
+ * @example
+ * const timeFormat = 'day_14!';
+ * const parsedTimeFormat = parseTimeFormatsFromKey(timeFormat); // { key: 'day', value: 14, exact: true }
+ *
+ * @example
+ * const timeFormat = 'week-weekday_3_5';
+ * const parsedTimeFormat = parseTimeFormatsFromKey(timeFormat); // { key: 'week-weekday', week: 3, weekday: 5 }
+ *
+ * @example
+ * const timeFormat = 'bla-bla_1234';
+ * const parsedTimeFormat = parseTimeFormatsFromKey(timeFormat); // null
+ */
+export declare const parseTimeFormatsFromKey: (format: TimeFormatWithDuration) => ParsedTimeFormat | null;

package/dist/chart/components/x_axis/time/parser/time-formats-parser.functions.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{timeFormatConfirugableGuard as m,timeFormatNoNConfirugableGuard as p,weekWeekdayGuard as u}from"./time-formats.model";const c=r=>{const e={"!":!1,$:!1};return r.includes("!")&&(e["!"]=!0),r.includes("$")&&(e.$=!0),e},o=r=>parseInt(r,10);export const parseTimeFormatsFromKey=r=>{const[e,...n]=r.split("_");if(m(e)){const[t]=n,s=c(t),a=o(t);return{key:e,value:a,exact:s["!"]}}else if(u(e)){const[t,s]=n,a=c(t),l=o(t),i=o(s);return{key:e,week:a.$?"$":l,weekday:i}}else return p(e)?{key:e}:(console.warn(`${r} is not fit, check the documentation to see available formats https://webdev.prosp.devexperts.com:8095/docs/chart/x-axis`),null)};

package/dist/chart/components/x_axis/time/parser/time-formats-validators.functions.d.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 { ParsedTimeFormat } from './time-formats.model';
+/**
+ * Validators are aimed to check if the `ParsedTimeFormat` is correct
+ *
+ * @example
+ * const timeFormat: ParsedTimeFormat = {
+ * 	key: 'day',
+ *  value: 13,
+ *  exact: true
+ * };
+ * // valid, because day should be between 1 and 31
+ * const valid = validateParsedTimeFormat(timeFormat); // true
+ *
+ * @example
+ * const timeFormat: ParsedTimeFormat = {
+ * 	key: 'minute',
+ *  value: 255,
+ *  exact: true
+ * };
+ * // INvalid, because minute should be between 1 and 60
+ * const valid = validateParsedTimeFormat(timeFormat); // false
+ */
+export declare const validateParsedTimeFormat: <T extends ParsedTimeFormat>(parsed: T) => boolean;

package/dist/chart/components/x_axis/time/parser/time-formats-validators.functions.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 const validateParsedTimeFormat=e=>{switch(e.key){case"second":case"minute":return a(e.value);case"hour":return o(e.value);case"day":return s(e.value);case"month":return u(e.value);case"year":return d(e.value);case"week-weekday":const r=c(e.week),n=i(e.weekday);return r&&n;case"lessThanSecond":return!0;default:return!1}};const a=e=>e>0&&e<=60,o=e=>e>0&&e<=24,s=e=>e>0&&e<=31,i=e=>t(e)?e>=1&&e<=7:!1,c=e=>e==="$"?!0:t(e)?e>=1&&e<=6:!1,u=e=>e>0&&e<=12,d=e=>e>0,t=e=>!isNaN(e)&&isFinite(e);

package/dist/chart/components/x_axis/time/parser/time-formats.model.d.ts

@@ -0,0 +1,33 @@
+/*
+ * 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/.
+ */
+declare const weekWeekday: "week-weekday";
+declare const timeFormatsConfirugable: readonly ["second", "minute", "hour", "day", "month", "year"];
+declare const timeFormatsNoNConfirugable: readonly ["lessThanSecond"];
+type TimeFormatWeekWeekdayType = typeof weekWeekday;
+type TimeFormatConfirugableType = typeof timeFormatsConfirugable[number];
+type TimeFormatNonConfirugableType = typeof timeFormatsNoNConfirugable[number];
+export type TimeFormat = TimeFormatConfirugableType | TimeFormatNonConfirugableType | TimeFormatWeekWeekdayType;
+type TimeFormatConfirugableWithDurationType = `${TimeFormatConfirugableType}_${number}` | `${TimeFormatConfirugableType}_${number}!` | `${TimeFormatWeekWeekdayType}_${number | '$'}_${number}`;
+export type TimeFormatWithDuration = TimeFormatConfirugableWithDurationType | TimeFormatNonConfirugableType;
+export interface ParsedCTimeFormat {
+    key: TimeFormatConfirugableType;
+    value: number;
+    exact: boolean;
+}
+export interface ParsedWeekFormat {
+    key: TimeFormatWeekWeekdayType;
+    week: number | '$';
+    weekday: number;
+}
+export interface ParsedNCTimeFormat {
+    key: TimeFormatNonConfirugableType;
+}
+export type ParsedTimeFormat = ParsedCTimeFormat | ParsedWeekFormat | ParsedNCTimeFormat;
+export type SpecialSymbol = '!' | '$';
+export declare const timeFormatConfirugableGuard: (key: string) => key is "second" | "minute" | "hour" | "day" | "month" | "year";
+export declare const weekWeekdayGuard: (key: string) => key is "week-weekday";
+export declare const timeFormatNoNConfirugableGuard: (key: string) => key is "lessThanSecond";
+export {};

package/dist/chart/components/x_axis/time/parser/time-formats.model.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/.
+ */
+const a="week-weekday",r=["second","minute","hour","day","month","year"],t=["lessThanSecond"];export const timeFormatConfirugableGuard=e=>r.some(o=>o===e),weekWeekdayGuard=e=>e==="week-weekday",timeFormatNoNConfirugableGuard=e=>t.some(o=>o===e);

package/dist/chart/components/x_axis/time/x-axis-weights.functions.d.ts

@@ -0,0 +1,62 @@
+/*
+ * 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 { FullChartConfig } from '../../../chart.config';
+import { ScaleModel } from '../../../model/scale.model';
+import { NumericAxisLabel } from '../../labels_generator/numeric-axis-labels.generator';
+import { XAxisLabelWeighted } from '../x-axis-labels.generator';
+import { ParsedTimeFormat } from './parser/time-formats.model';
+/**
+ * Generates `weight` based on the {@link ParsedTimeFormat}
+ * @example
+ * const timeFormat: ParsedTimeFormat = {
+ *  key: 'day',
+ *  value: 15,
+ *  exact: false
+ * }
+ * const weight = getWeightFromTimeFormat(timeFormat); // 415
+ */
+export declare const getWeightFromTimeFormat: (format: ParsedTimeFormat) => number;
+/**
+ * Group {@link XAxisLabelWeighted} by `weight` in a `Record<number, XAxisLabelWeighted[]>`
+ * @example
+ * const groupedLabels = {
+ *		601: Array(359),
+ *		415: Array(1685),
+ *		...
+ * 	}
+ */
+export declare const groupLabelsByWeight: (weightedLabels: XAxisLabelWeighted[]) => Record<number, XAxisLabelWeighted[]>;
+/**
+ * FilterMap grouped {@link XAxisLabelWeighted} labels by `coverUpLevel` value
+ *
+ * @see
+ * `coverUpLevel` - is a ratio, which tells us how much more space the widest label
+ * will take relative to the candle width
+ * @example
+ * const maxLabelWidthPx = 10;
+ * const meanCandleWidthPx = 5;
+ * const coverUpLevel = Math.round(10 / 5); // 2
+ *
+ * // `coverUpLebel = 2` means that label for a candle take `2x` more width
+ * // than the candle on the screen for that label.
+ * // That kind of fact give us a hint, that we can't draw labels for `i - 1` and `i + 1` candles,
+ * // because it wouldn't be enough space (`i` candle label will take all the place).
+ * // But we can draw labels for `i - 2` and `i + 2` candles.
+ * @see
+ * That algorightm do exactly that - it filters out labels (taking in mind its weight, weight is a priority) that couldn't be drawn
+ * because there's not enough space for them.
+ */
+export declare const filterMapGroupedLabelsByCoverUpLevel: (labelsGroupedByWeight: Record<number, XAxisLabelWeighted[]>, coverUpLevel: number) => XAxisLabelWeighted[];
+/**
+ * The function compares 2 labels and checks if they overlap each other
+ * @param {CanvasRenderingContext2D} ctx - canvas context
+ * @param {FullChartConfig} config - chart config
+ * @param {NumericAxisLabel} label - first label to compare
+ * @param {NumericAxisLabel} nextLabel - second label to compare
+ * @param {ScaleModel} scaleModel - chart scale model
+ * @returns
+ */
+export declare const overlappingPredicate: (ctx: CanvasRenderingContext2D, config: FullChartConfig, label: NumericAxisLabel, nextLabel: NumericAxisLabel, scaleModel: ScaleModel, overlapingDistance: number) => boolean;

package/dist/chart/components/x_axis/time/x-axis-weights.functions.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{calculateTextWidth as w}from"../../../utils/canvas/canvas-font-measure-tool.utils";import{XAxisTimeLabelsDrawer as W}from"../x-axis-time-labels.drawer";const d={lessThanSecond:0,second:100,minute:200,hour:300,day:400,"week-weekday":500,month:600,year:1e4};export const getWeightFromTimeFormat=e=>{switch(e.key){case"second":case"minute":case"hour":case"day":case"month":case"year":return d[e.key]+e.value;case"lessThanSecond":return d[e.key];case"week-weekday":return d[e.key]+(e.week==="$"?9:e.week)+e.weekday*10}},groupLabelsByWeight=e=>{const s={};return e.forEach(n=>{const t=s[n.weight];t===void 0?s[n.weight]=[n]:t.push(n)}),s},filterMapGroupedLabelsByCoverUpLevel=(e,s)=>{const n=Object.keys(e).map(o=>parseInt(o,10)).sort((o,i)=>i-o);let t=[];for(const o of n){const i=e[o];if(!i)continue;const c=[...t];t=[];const a=c.length,l=i.length;let r=0,h=1/0,p=-1/0;for(let g=0;g<l;g++){const y=i[g],u=y.idx;for(;r<a;){const k=c[r],x=k.idx;if(u>x)r++,t.push(k),p=x,h=1/0;else{h=x;break}}h-u>=s&&u-p>=s&&(t.push(y),p=u)}for(;r<a;)t.push(c[r]),r++}return t},overlappingPredicate=(e,s,n,t,o,i)=>{const c=W.getFontFromConfig(s),a=w(n.text,e,c),l=w(t.text,e,c),r=o.toX(n.value)+a/2;return o.toX(t.value)-l/2-r<i};

package/dist/chart/components/x_axis/time/x-axis-weights.generator.d.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 VisualCandle from '../../../model/visual-candle';
+import { TimeFormatMatcher } from './parser/time-formats-matchers.functions';
+import { TimeFormatWithDuration } from './parser/time-formats.model';
+export interface WeightedPoint {
+    weight: number;
+}
+/**
+ * Transforms {@link VisualCandle} to {@link WeightedPoint}
+ */
+export declare function mapCandlesToWeightedPoints(visualCandles: VisualCandle[], sortedWeights: [number, TimeFormatMatcher][], tzOffset: (time: number) => Date): WeightedPoint[];
+/**
+ * Generates two maps for a given config.
+ * 1st map is { [weight]: [format] } to control which format should be used for a given weight;
+ * 2nd map is { [weight]: [Matcher] } to test a date for a match for a given weight;
+ *
+ * @example
+ * const config: Record<TimeFormatWithDuration, string> = {
+ *  'day_15': 'dd.MM',
+ *  'month_7!': 'MMM'
+ * }
+ * const { map1, map2 } = generateWeightsMapForConfig(config);
+ * // map1 = { 415: 'dd.MM', 607: 'MMM' };
+ * // map2 = { 415: DayMatcher, 607: MonthMatcher }
+ */
+export declare const generateWeightsMapForConfig: (config: Record<TimeFormatWithDuration, string>) => {
+    weightToTimeFormatsDict: Record<number, string>;
+    weightToTimeFormatMatcherDict: Record<number, TimeFormatMatcher>;
+};

package/dist/chart/components/x_axis/time/x-axis-weights.generator.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{typedEntries_UNSAFE as g}from"../../../utils/object.utils";import{timeFormatMatcherFactory as f}from"./parser/time-formats-matchers.functions";import{parseTimeFormatsFromKey as h}from"./parser/time-formats-parser.functions";import{validateParsedTimeFormat as l}from"./parser/time-formats-validators.functions";import{getWeightFromTimeFormat as p}from"./x-axis-weights.functions";const F=(o,m,e,n)=>{var r,t;const a=n(o.getTime()),i=n(m.getTime());for(const[c,s]of e)if(s(a,i))return c;return(t=(r=e[e.length-1])===null||r===void 0?void 0:r[0])!==null&&t!==void 0?t:0};export function mapCandlesToWeightedPoints(o,m,e){const n=new Array(o.length);let r=new Date(0);for(let t=0;t<o.length;t++){const a=o[t],i=new Date(a.candle.timestamp),c={weight:F(i,r,m,e)};n[t]=c,r=i}return n}export const generateWeightsMapForConfig=o=>{const m={},e={};return g(o).forEach(([n,r])=>{const t=h(n),a=t===null?!1:l(t);if(t&&a){const i=p(t);m[i]=r,e[i]=f(t)}}),{weightToTimeFormatsDict:m,weightToTimeFormatMatcherDict:e}};

package/dist/chart/components/x_axis/x-axis-draw.functions.d.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 { CanvasBoundsContainer } from '../../canvas/canvas-bounds-container';
+import { FullChartConfig } from '../../chart.config';
+import { XAxisLabel } from './x-axis-labels.model';
+export type LabelAlign = 'start' | 'end' | 'middle';
+/**
+ * Draws the label on X axis.
+ * @param ctx
+ * @param canvasBoundsContainer
+ * @param config
+ * @param label
+ */
+export declare function drawXAxisLabel(backgroundCtx: CanvasRenderingContext2D, ctx: CanvasRenderingContext2D, canvasBoundsContainer: CanvasBoundsContainer, config: FullChartConfig, label: XAxisLabel): void;

package/dist/chart/components/x_axis/x-axis-draw.functions.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{CanvasElement as A}from"../../canvas/canvas-bounds-container";import{redrawBackgroundArea as u}from"../../drawers/chart-background.drawer";const f={x:4,y:4};export function drawXAxisLabel(m,o,y,h,e){var i,r;const d=(i=e.alignType)!==null&&i!==void 0?i:"middle",{fontSize:l,fontFamily:p,padding:x}=h.components.xAxis,T=(r=x.top)!==null&&r!==void 0?r:0,t=y.getBounds(A.X_AXIS);o.save(),o.font=`bold ${l}px ${p}`;const a=o.measureText(e.text).width+f.x*2;let n=0;const s=e.x;switch(d){case"start":n=s-a;break;case"end":n=s;break;case"middle":default:n=s-a/2;break}u(m,o,n,t.y,a,t.height-1),d!=="middle"&&(o.strokeStyle=e.color,o.beginPath(),o.moveTo(s,t.y),o.lineTo(s,t.y+t.height),o.stroke()),o.fillStyle=e.color;const c=n+f.x,g=t.y+T+l;o.fillText(e.text,c,g),o.restore()}

package/dist/chart/components/x_axis/x-axis-labels.drawer.d.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { CanvasBoundsContainer } from '../../canvas/canvas-bounds-container';
+import { XAxisLabelsModel } from './x-axis-labels.model';
+import { CanvasModel } from '../../model/canvas.model';
+import { Drawer } from '../../drawers/drawing-manager';
+import { FullChartConfig } from '../../chart.config';
+/**
+ * This drawer draws custom labels for X Axis, using labels from XAxisLabelModel.
+ * By default labels for drawings are drawn by this drawer.
+ */
+export declare class XAxisLabelsDrawer implements Drawer {
+    private backgroundCanvasModel;
+    private config;
+    private canvasModel;
+    private canvasBoundsContainer;
+    private xAxisLabelsModel;
+    constructor(backgroundCanvasModel: CanvasModel, config: FullChartConfig, canvasModel: CanvasModel, canvasBoundsContainer: CanvasBoundsContainer, xAxisLabelsModel: XAxisLabelsModel);
+    /**
+     * Draws the X axis labels on the canvas.
+     * @function
+     * @name draw
+     * @memberof XAxisLabelsDrawer
+     * @returns {void}
+     */
+    draw(): void;
+    /**
+     * Draws a highlighted background between two labels with the same "subGroupId".
+     *
+     * @returns {void}
+     */
+    drawHighlightedBackgroundBetweenLabels(): void;
+    /**
+     * Returns an array with the ID of the canvas model.
+     *
+     * @returns {Array} An array with the ID of the canvas model.
+     */
+    getCanvasIds(): string[];
+}

package/dist/chart/components/x_axis/x-axis-labels.drawer.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{drawXAxisLabel as i}from"./x-axis-draw.functions";import{CanvasElement as r}from"../../canvas/canvas-bounds-container";import*as d from"color";import{fillRect as l}from"../../utils/canvas/canvas-drawing-functions.utils";export class XAxisLabelsDrawer{constructor(a,e,n,o,s){this.backgroundCanvasModel=a,this.config=e,this.canvasModel=n,this.canvasBoundsContainer=o,this.xAxisLabelsModel=s}draw(){const a=this.canvasModel.ctx;this.drawHighlightedBackgroundBetweenLabels(),this.xAxisLabelsModel.labels.forEach(e=>{i(this.backgroundCanvasModel.ctx,a,this.canvasBoundsContainer,this.config,e)})}drawHighlightedBackgroundBetweenLabels(){const a=this.canvasModel.ctx,e={},n=this.xAxisLabelsModel.labels.reduce((o,s)=>{if(s.subGroupId!==void 0){let t=o[s.subGroupId];t||(t=[],o[s.subGroupId]=t),t.push(s)}return o},e);Object.keys(n).forEach(o=>{const s=n[o];if(s.length===2){const t=this.canvasBoundsContainer.getBounds(r.X_AXIS);a.fillStyle=d.rgb(s[0].color).alpha(.1).toString(),l(a,{x:s[0].x,y:t.y},{x:s[1].x,y:t.y+t.height})}})}getCanvasIds(){return[this.canvasModel.canvasId]}}