feat: Improve X-labels generation time

package.json

@@ -90,7 +90,6 @@
   "dependencies": {
     "color": "^4.2.3",
     "date-fns": "^2.30.0",
-    "date-fns-tz": "^1.3.8",
     "rxjs": "^7.5.7"
   },
   "peerDependencies": {

src/chart/components/chart/chart.component.ts

@@ -289,17 +289,17 @@ export class ChartComponent extends ChartBaseElement {
 	 * @param {Timestamp} end - The end timestamp of the range.
 	 * @returns {void}
 	 */
-	public setTimestampRange(start: Timestamp, end: Timestamp): void {
-		return this.chartModel.setTimestampRange(start, end);
+	public setTimestampRange(start: Timestamp, end: Timestamp, forceNoAnimation: boolean = true): void {
+		return this.chartModel.setTimestampRange(start, end, forceNoAnimation);
 	}
 
 	/**
 	 * Moves the viewport to exactly xStart..xEnd place.
 	 * @param xStart - viewport start in units
 	 * @param xEnd - viewport end in units
 	 */
-	public setXScale(xStart: Unit, xEnd: Unit) {
-		return this.scale.setXScale(xStart, xEnd);
+	public setXScale(xStart: Unit, xEnd: Unit, forceNoAnimation: boolean = true) {
+		return this.scale.setXScale(xStart, xEnd, forceNoAnimation);
 	}
 
 	/**

src/chart/components/chart/chart.model.ts

@@ -64,7 +64,6 @@ export class ChartModel extends ChartBaseElement {
 	public readonly nextCandleTimeStampSubject: Subject<void> = new Subject<void>();
 	public readonly chartTypeChanged: Subject<BarType> = new Subject<BarType>();
 	public readonly mainInstrumentChangedSubject: Subject<ChartInstrument> = new Subject<ChartInstrument>();
-	public readonly scaleInversedSubject: Subject<void> = new Subject<void>();
 	public readonly offsetsChanged = new Subject<void>();
 	private candlesTransformersByChartType: Partial<Record<BarType, VisualCandleCalculator>> = {};
 	lastCandleLabelsByChartType: Partial<Record<BarType, LastCandleLabelHandler>> = {};
@@ -802,11 +801,11 @@ export class ChartModel extends ChartBaseElement {
 	 * @param {Timestamp} end - The end timestamp of the range.
 	 * @returns {void}
 	 */
-	setTimestampRange(start: Timestamp, end: Timestamp): void {
+	setTimestampRange(start: Timestamp, end: Timestamp, forceNoAnimation: boolean = true): void {
 		const startUnit = this.candleFromTimestamp(start).startUnit;
 		const endCandle = this.candleFromTimestamp(end);
 		const endUnit = endCandle.startUnit + endCandle.width;
-		return this.scale.setXScale(startUnit, endUnit);
+		return this.scale.setXScale(startUnit, endUnit, forceNoAnimation);
 	}
 
 	/**

src/chart/components/x_axis/time/parser/time-formats-matchers.functions.ts

@@ -16,7 +16,7 @@ import {
 	isSunday,
 	startOfMonth,
 	endOfMonth,
-} from 'date-fns/esm';
+} from 'date-fns';
 import {
 	ParsedCTimeFormat,
 	ParsedNCTimeFormat,

src/chart/components/x_axis/time/x-axis-weights.functions.ts

@@ -60,14 +60,14 @@ export const getWeightFromTimeFormat = (format: ParsedTimeFormat) => {
 export const groupLabelsByWeight = (weightedLabels: XAxisLabelWeighted[]): Record<number, XAxisLabelWeighted[]> => {
 	const labelsGroupedByWeight: Record<number, XAxisLabelWeighted[]> = {};
 
-	weightedLabels.forEach(weightedLabel => {
+	for (const weightedLabel of weightedLabels) {
 		const labelsByWeight = labelsGroupedByWeight[weightedLabel.weight];
 		if (labelsByWeight === undefined) {
 			labelsGroupedByWeight[weightedLabel.weight] = [weightedLabel];
 		} else {
 			labelsByWeight.push(weightedLabel);
 		}
-	});
+	}
 
 	return labelsGroupedByWeight;
 };

src/chart/components/x_axis/time/x-axis-weights.generator.ts

@@ -30,12 +30,9 @@ const getWeightByDate = (
 	currentDate: Date,
 	previousDate: Date,
 	sortedWeights: [number, TimeFormatMatcher][],
-	tzOffset: (time: number) => Date,
 ): number => {
-	const offsetCurrentDate = tzOffset(currentDate.getTime());
-	const offsetPrevDate = tzOffset(previousDate.getTime());
 	for (const [weight, timeMatcher] of sortedWeights) {
-		if (timeMatcher(offsetCurrentDate, offsetPrevDate)) {
+		if (timeMatcher(currentDate, previousDate)) {
 			return weight;
 		}
 	}
@@ -52,16 +49,15 @@ export function mapCandlesToWeightedPoints(
 	tzOffset: (time: number) => Date,
 ): WeightedPoint[] {
 	const result: WeightedPoint[] = new Array(visualCandles.length);
-
 	// assume that candles` timestamp before the first visual candle is unreachable
-	let prevDate = new Date(0);
+	let prevDate = tzOffset(0);
 
 	for (let i = 0; i < visualCandles.length; i++) {
 		const currentCandle = visualCandles[i];
-		const currentDate = new Date(currentCandle.candle.timestamp);
-
+		// calculate timstamp to Date in acordance with provided timezone and time
+		const currentDate = tzOffset(currentCandle.candle.timestamp);
 		const currentWeightedPoint: WeightedPoint = {
-			weight: getWeightByDate(currentDate, prevDate, sortedWeights, tzOffset),
+			weight: getWeightByDate(currentDate, prevDate, sortedWeights),
 		};
 		result[i] = currentWeightedPoint;
 		prevDate = currentDate;

src/chart/components/x_axis/x-axis-labels.generator.ts

@@ -3,6 +3,7 @@
  * 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, CanvasElement } from '../../canvas/canvas-bounds-container';
 import { FullChartConfig } from '../../chart.config';
 import EventBus from '../../events/event-bus';
 import { CanvasModel } from '../../model/canvas.model';
@@ -70,7 +71,7 @@ export class XAxisTimeLabelsGenerator implements XAxisLabelsGenerator {
 	private levelsCache: Record<number, XAxisLabelWeighted[]> = {};
 
 	get labels(): XAxisLabelWeighted[] {
-		return this.getLabelsFromChartType();
+		return this.filterLabelsInViewport(this.getLabelsFromChartType());
 	}
 
 	private formatsByWeightMap: Record<TimeFormatWithDuration, string>;
@@ -89,6 +90,7 @@ export class XAxisTimeLabelsGenerator implements XAxisLabelsGenerator {
 		private scale: ScaleModel,
 		private timeZoneModel: TimeZoneModel,
 		private canvasModel: CanvasModel,
+		private canvasBoundsContainer: CanvasBoundsContainer,
 	) {
 		this.formatsByWeightMap = config.components.xAxis.formatsForLabelsConfig;
 		const { weightToTimeFormatsDict, weightToTimeFormatMatcherDict } = generateWeightsMapForConfig(
@@ -100,6 +102,21 @@ export class XAxisTimeLabelsGenerator implements XAxisLabelsGenerator {
 		this.weightToTimeFormatsDict = weightToTimeFormatsDict;
 	}
 
+	private filterLabelsInViewport(labels: XAxisLabelWeighted[]) {
+		const bounds = this.canvasBoundsContainer.getBounds(CanvasElement.X_AXIS);
+		const filteredLabels = [];
+
+		for (const label of labels) {
+			const x = this.scale.toX(label.value);
+			// skip labels outside viewport
+			if (x < 0 || x > bounds.width) {
+				continue;
+			}
+			filteredLabels.push(label);
+		}
+		return filteredLabels;
+	}
+
 	private getLabelsFromChartType() {
 		const labels = this.weightedCache?.labels ?? [];
 		//@ts-ignore
@@ -143,7 +160,8 @@ export class XAxisTimeLabelsGenerator implements XAxisLabelsGenerator {
 		allCandlesWithFake: VisualCandle[],
 	): XAxisLabelWeighted[] {
 		const arr = new Array(weightedPoints.length);
-		weightedPoints.forEach((point, index) => {
+		for (let index = 0; index < weightedPoints.length; ++index) {
+			const point = weightedPoints[index];
 			const visualCandle = allCandlesWithFake[index];
 			const labelFormat = this.weightToTimeFormatsDict[point.weight];
 			const formattedLabel = this.timeZoneModel.getDateTimeFormatter(labelFormat)(visualCandle.candle.timestamp);
@@ -155,7 +173,7 @@ export class XAxisTimeLabelsGenerator implements XAxisLabelsGenerator {
 				time: visualCandle.candle.timestamp,
 				text: formattedLabel,
 			};
-		});
+		}
 		return arr;
 	}
 
@@ -334,35 +352,48 @@ export class XAxisTimeLabelsGenerator implements XAxisLabelsGenerator {
 	}
 
 	/**
-	 * Recalculates cached labels based on the current configuration and zoom level.
-	 * If there are no grouped labels, the cache is not set.
-	 * Calculates the maximum label width based on the font size and the maximum format length.
 	 * Calculates the cover up level based on the maximum label width and the mean candle width.
-	 * If the cover up level is negative, the cache is not updated.
-	 * If the cover up level has not changed, the cached labels are returned.
-	 * Otherwise, the labels are filtered by extended rules and grouped by cover up level.
-	 * The filtered labels are then cached and returned.
+	 * Cover up level is based on maximum label width, which is based on the font size and the maximum format length.
+	 * Used to group labels.
 	 */
-	private recalculateCachedLabels() {
-		// skip cache setting if we don't have grouped labels
+	private calculateCoverUpLevel = () => {
+		const animation = this.scale.currentAnimation;
+		const meanCandleWidthInUnits = this.chartModel.mainCandleSeries.meanCandleWidth;
 		if (Object.getOwnPropertyNames(this.labelsGroupedByWeight).length === 0) {
-			return;
+			return -1;
 		}
+		// calculate coverUpLevel for target zoomX to prevent extra labels calculations on every animation tick
+		const meanCandleWidthInPixels = animation?.animationInProgress
+			? unitToPixels(meanCandleWidthInUnits, animation.animationConfig.targetZoomX)
+			: unitToPixels(meanCandleWidthInUnits, this.scale.zoomX);
 
+		if (!isFinite(meanCandleWidthInPixels)) {
+			return -1;
+		}
 		const fontSize = this.config.components.xAxis.fontSize;
-		const maxFormatLength = Object.values(this.formatsByWeightMap).reduce((max, item) => {
-			return Math.max(item.length, max);
-		}, 1);
+		const maxFormatLength = Object.values(this.formatsByWeightMap).reduce(
+			(max, item) => Math.max(item.length, max),
+			1,
+		);
 		const maxLabelWidth = fontSize * maxFormatLength;
-		const meanCandleWidthPx = unitToPixels(this.chartModel.mainCandleSeries.meanCandleWidth, this.scale.zoomX);
-
-		const coverUpLevel = Math.round(maxLabelWidth / meanCandleWidthPx);
+		return Math.round(maxLabelWidth / meanCandleWidthInPixels);
+	};
 
+	/**
+	 * Recalculates cached labels based on the current configuration and zoom level.
+	 * If there are no grouped labels, the cache is not set.
+	 * Recalculating depends on cover up level.
+	 * If the cover up level is negative, the cache is not updated.
+	 * If the cover up level has not changed, the cached labels are returned.
+	 * Otherwise, the labels are filtered by extended rules and grouped by cover up level.
+	 * The filtered labels are then cached and returned.
+	 */
+	private recalculateCachedLabels() {
+		const coverUpLevel = this.calculateCoverUpLevel();
 		// for some reason sometimes `this.scale.zoomX` is negative so we dont want to update labels
-		if (coverUpLevel < 0 && !isFinite(meanCandleWidthPx)) {
+		if (coverUpLevel < 0) {
 			return;
 		}
-
 		if (this.weightedCache === undefined || coverUpLevel !== this.weightedCache.coverUpLevel) {
 			const labelsFromCache = this.getLabelsFromCache(coverUpLevel);
 			if (labelsFromCache) {

src/chart/components/x_axis/x-axis-time-labels.drawer.ts

@@ -75,10 +75,6 @@ export class XAxisTimeLabelsDrawer implements Drawer {
 		ctx.fillStyle = color;
 		for (const label of labels) {
 			const x = this.viewportModel.toX(label.value) - calculateTextWidth(label.text, ctx, font) / 2;
-			// skip labels outside viewport
-			if (x < 0 || x > bounds.width) {
-				continue;
-			}
 			const y = bounds.y + fontHeight - 1 + offsetTop; // -1 for font drawing inconsistency
 			const labelText = label.text;
 			ctx.font = font;

src/chart/components/x_axis/x-axis.component.ts

@@ -61,6 +61,7 @@ export class XAxisComponent extends ChartBaseElement {
 			scale,
 			timeZoneModel,
 			this.canvasModel,
+			canvasBoundsContainer,
 		);
 		this.xAxisLabelsGenerator = xAxisLabelsGenerator;
 
@@ -121,18 +122,14 @@ export class XAxisComponent extends ChartBaseElement {
 			this.chartComponent.chartModel.candlesPrependSubject
 				.pipe(
 					filter(({ prependedCandles }) => prependedCandles.length !== 0),
-					map(({ prependedCandles }) => {
-						return this.chartComponent.chartModel.mainCandleSeries.visualPoints.slice(
-							0,
-							prependedCandles.length,
-						);
-					}),
+					map(({ prependedCandles }) =>
+						this.chartComponent.chartModel.mainCandleSeries.visualPoints.slice(0, prependedCandles.length),
+					),
 				)
 				.subscribe(newCandles => {
 					//@ts-ignore
 					if (availableBarTypes.includes(this.config.components.chart.type)) {
-						this.xAxisLabelsGenerator.updateHistoryLabels &&
-							this.xAxisLabelsGenerator.updateHistoryLabels(newCandles);
+						this.xAxisLabelsGenerator.updateHistoryLabels?.(newCandles);
 					}
 				}),
 		);
@@ -152,9 +149,7 @@ export class XAxisComponent extends ChartBaseElement {
 					distinctUntilChanged((a, b) => a?.candle?.timestamp === b?.candle?.timestamp),
 					filter(notEmpty),
 				)
-				.subscribe(x => {
-					this.xAxisLabelsGenerator.updateLastLabel && this.xAxisLabelsGenerator.updateLastLabel(x);
-				}),
+				.subscribe(x => this.xAxisLabelsGenerator?.updateLastLabel?.(x)),
 		);
 	}
 

src/chart/components/y_axis/y-axis-scale.handler.ts

@@ -69,6 +69,8 @@ export class YAxisScaleHandler extends ChartBaseElement {
 	}
 
 	private onYDragStart = () => {
+		// halt previous scale animation if drag is started
+		this.scale.haltAnimation();
 		this.lastYStart = this.scale.yStart;
 		this.lastYEnd = this.scale.yEnd;
 		this.lastYHeight = this.scale.yEnd - this.scale.yStart;

src/chart/model/data-series.model.ts

@@ -147,7 +147,7 @@ export class DataSeriesModel<
 
 	protected doActivate(): void {
 		this.addRxSubscription(this.scale.xChanged.subscribe(() => this.recalculateDataViewportIndexes()));
-		this.addRxSubscription(this.scale.scaleInversedSubject.subscribe(() => this.recalculateVisualPoints()));
+		this.addRxSubscription(this.scale.scaleInversedSubject.subscribe(() => { this.recalculateVisualPoints(); }));
 	}
 
 	/**

src/chart/model/scale.model.ts

@@ -83,6 +83,14 @@ export class ScaleModel extends ViewportModel {
 		);
 	}
 
+	protected doActivate(): void {
+		this.addRxSubscription(
+			this.scaleInversedSubject.subscribe(() => {
+				this.fireChanged();
+			}),
+		);
+	}
+
 	/**
 	 * The method adds a new "constraint" to the existing list of x-axis constraints for charting.
 	 * The "constraint" is expected to be an object containing information about the constraints, such as the minimum and maximum values for the x-axis.
@@ -181,19 +189,23 @@ export class ScaleModel extends ViewportModel {
 	 * @param fireChanged
 	 * @param forceNoAutoScale - force NOT apply auto-scaling (for lazy loading)
 	 */
-	public setXScale(xStart: Unit, xEnd: Unit) {
+	public setXScale(xStart: Unit, xEnd: Unit, forceNoAnimation: boolean = true) {
 		const initialState = this.export();
-		super.setXScale(xStart, xEnd, false);
-		const state = this.export();
+		const zoomX = this.calculateZoomX(xStart, xEnd);
+		const state = { ...initialState, zoomX, xStart, xEnd };
 		const constrainedState = this.scalePostProcessor(initialState, state);
 		if (this.state.lockPriceToBarRatio) {
 			changeYToKeepRatio(constrainedState, this.zoomXYRatio);
 		}
 		if (this.state.auto) {
 			this.autoScaleModel.doAutoYScale(constrainedState);
 		}
-
-		this.apply(constrainedState);
+		if (forceNoAnimation || this.config.scale.disableAnimations) {
+			this.haltAnimation();
+			this.apply(constrainedState);
+		} else {
+			startViewportModelAnimation(this.canvasAnimation, this, constrainedState);
+		}
 	}
 
 	public setYScale(yStart: Unit, yEnd: Unit, fire = false) {