Merge pull request #791 from olegchernenko/master

tradingview · Jul 19, 2021 · 6e8927d · 6e8927d
2 parents ec91034 + 352166a
commit 6e8927d
Show file tree

Hide file tree

Showing 15 changed files with 94 additions and 45 deletions.
diff --git a/src/api/iseries-api.ts b/src/api/iseries-api.ts
@@ -1,3 +1,5 @@
+import { IPriceFormatter } from '../formatters/iprice-formatter';
+
 import { BarPrice } from '../model/bar';
 import { Coordinate } from '../model/coordinate';
 import { PriceLineOptions } from '../model/price-line-options';
@@ -22,17 +24,6 @@ export type BarsInfo =
 		barsAfter: number;
 	};
 
-/** Interface to be implemented by the object in order to be used as a price formatter */
-export interface IPriceFormatter {
-	/**
-	 * Formatting function
-	 *
-	 * @param price - original price to be formatted
-	 * @returns formatted price
-	 */
-	format(price: BarPrice): string;
-}
-
 export interface ISeriesApi<TSeriesType extends SeriesType> {
 	/**
 	 * Returns current price formatter

diff --git a/src/api/series-api.ts b/src/api/series-api.ts
@@ -1,3 +1,5 @@
+import { IPriceFormatter } from '../formatters/iprice-formatter';
+
 import { ensureNotNull } from '../helpers/assertions';
 import { clone, merge } from '../helpers/strict-type-checks';
 
@@ -22,7 +24,7 @@ import { convertTime } from './data-layer';
 import { checkItemsAreOrdered, checkPriceLineOptions, checkSeriesValuesType } from './data-validators';
 import { IPriceLine } from './iprice-line';
 import { IPriceScaleApi } from './iprice-scale-api';
-import { BarsInfo, IPriceFormatter, ISeriesApi } from './iseries-api';
+import { BarsInfo, ISeriesApi } from './iseries-api';
 import { priceLineOptionsDefaults } from './options/price-line-options-defaults';
 import { PriceLine } from './price-line-api';
 

diff --git a/src/formatters/date-formatter.ts b/src/formatters/date-formatter.ts
@@ -1,7 +1,6 @@
 import { formatDate } from './format-date';
-import { IFormatter } from './iformatter';
 
-export class DateFormatter implements IFormatter {
+export class DateFormatter {
 	private readonly _locale: string;
 	private readonly _dateFormat: string;
 

diff --git a/src/formatters/date-time-formatter.ts b/src/formatters/date-time-formatter.ts
@@ -1,5 +1,4 @@
 import { DateFormatter } from './date-formatter';
-import { IFormatter } from './iformatter';
 import { TimeFormatter } from './time-formatter';
 
 export interface DateTimeFormatterParams {
@@ -16,7 +15,7 @@ const defaultParams: DateTimeFormatterParams = {
 	locale: 'default',
 };
 
-export class DateTimeFormatter implements IFormatter {
+export class DateTimeFormatter {
 	private readonly _dateFormatter: DateFormatter;
 	private readonly _timeFormatter: TimeFormatter;
 	private readonly _separator: string;

diff --git a/src/formatters/iformatter.ts b/src/formatters/iformatter.ts
diff --git a/src/formatters/iprice-formatter.ts b/src/formatters/iprice-formatter.ts
@@ -0,0 +1,10 @@
+/** Interface to be implemented by the object in order to be used as a price formatter */
+export interface IPriceFormatter {
+	/**
+	 * Formatting function
+	 *
+	 * @param price - original price to be formatted
+	 * @returns formatted price
+	 */
+	format(price: number): string;
+}
diff --git a/src/formatters/price-formatter.ts b/src/formatters/price-formatter.ts
@@ -1,6 +1,6 @@
 import { isInteger, isNumber } from '../helpers/strict-type-checks';
 
-import { IFormatter } from './iformatter';
+import { IPriceFormatter } from './iprice-formatter';
 
 const formatterOptions = {
 	decimalSign: '.',
@@ -29,7 +29,7 @@ export function numberToStringWithLeadingZero(value: number, length: number): st
 	return (dummyString + value.toString()).slice(-length);
 }
 
-export class PriceFormatter implements IFormatter {
+export class PriceFormatter implements IPriceFormatter {
 	protected _fractionalLength: number | undefined;
 	private readonly _priceScale: number;
 	private readonly _minMove: number;

diff --git a/src/formatters/time-formatter.ts b/src/formatters/time-formatter.ts
@@ -1,7 +1,6 @@
-import { IFormatter } from './iformatter';
 import { numberToStringWithLeadingZero } from './price-formatter';
 
-export class TimeFormatter implements IFormatter {
+export class TimeFormatter {
 	private _formatStr: string;
 
 	public constructor(format?: string) {

diff --git a/src/formatters/volume-formatter.ts b/src/formatters/volume-formatter.ts
@@ -1,6 +1,6 @@
-import { IFormatter } from './iformatter';
+import { IPriceFormatter } from './iprice-formatter';
 
-export class VolumeFormatter implements IFormatter {
+export class VolumeFormatter implements IPriceFormatter {
 	private readonly _precision: number;
 
 	public constructor(precision: number) {

diff --git a/src/model/iprice-data-source.ts b/src/model/iprice-data-source.ts
@@ -1,4 +1,4 @@
-import { IFormatter } from '../formatters/iformatter';
+import { IPriceFormatter } from '../formatters/iprice-formatter';
 
 import { AutoscaleInfoImpl } from './autoscale-info-impl';
 import { ChartModel } from './chart-model';
@@ -12,7 +12,7 @@ export interface FirstValue {
 
 export interface IPriceDataSource extends IDataSource {
 	firstValue(): FirstValue | null;
-	formatter(): IFormatter;
+	formatter(): IPriceFormatter;
 	priceLineColor(lastBarColor: string): string;
 	model(): ChartModel;
 	minMove(): number;

diff --git a/src/model/price-data-source.ts b/src/model/price-data-source.ts
@@ -1,4 +1,4 @@
-import { IFormatter } from '../formatters/iformatter';
+import { IPriceFormatter } from '../formatters/iprice-formatter';
 
 import { AutoscaleInfoImpl } from './autoscale-info-impl';
 import { ChartModel } from './chart-model';
@@ -23,6 +23,6 @@ export abstract class PriceDataSource extends DataSource implements IPriceDataSo
 	public abstract autoscaleInfo(startTimePoint: TimePointIndex, endTimePoint: TimePointIndex): AutoscaleInfoImpl | null;
 
 	public abstract firstValue(): FirstValue | null;
-	public abstract formatter(): IFormatter;
+	public abstract formatter(): IPriceFormatter;
 	public abstract priceLineColor(lastBarColor: string): string;
 }
diff --git a/src/model/price-scale-conversions.ts b/src/model/price-scale-conversions.ts
@@ -1,6 +1,5 @@
 import { log10 } from '../helpers/mathex';
 
-import { Coordinate } from './coordinate';
 import { PriceRangeImpl } from './price-range-impl';
 
 const enum Constants {
@@ -16,9 +15,9 @@ export function fromPercent(value: number, baseValue: number): number {
 	return (value / 100) * baseValue + baseValue;
 }
 
-export function toPercent(value: number, baseValue: number): Coordinate {
+export function toPercent(value: number, baseValue: number): number {
 	const result = 100 * (value - baseValue) / baseValue;
-	return (baseValue < 0 ? -result : result) as Coordinate;
+	return (baseValue < 0 ? -result : result);
 }
 
 export function toPercentRange(priceRange: PriceRangeImpl, baseValue: number): PriceRangeImpl {
@@ -36,9 +35,9 @@ export function fromIndexedTo100(value: number, baseValue: number): number {
 	return (value / 100) * baseValue + baseValue;
 }
 
-export function toIndexedTo100(value: number, baseValue: number): Coordinate {
+export function toIndexedTo100(value: number, baseValue: number): number {
 	const result = 100 * (value - baseValue) / baseValue + 100;
-	return (baseValue < 0 ? -result : result) as Coordinate;
+	return (baseValue < 0 ? -result : result);
 }
 
 export function toIndexedTo100Range(priceRange: PriceRangeImpl, baseValue: number): PriceRangeImpl {
@@ -47,14 +46,14 @@ export function toIndexedTo100Range(priceRange: PriceRangeImpl, baseValue: numbe
 	return new PriceRangeImpl(minPercent, maxPercent);
 }
 
-export function toLog(price: number): Coordinate {
+export function toLog(price: number): number {
 	const m = Math.abs(price);
 	if (m < 1e-8) {
-		return 0 as Coordinate;
+		return 0;
 	}
 
 	const res = log10(m + Constants.CoordOffset) + Constants.LogicalOffset;
-	return ((price < 0) ? -res : res) as Coordinate;
+	return ((price < 0) ? -res : res);
 }
 
 export function fromLog(logical: number): number {

diff --git a/src/model/price-scale.ts b/src/model/price-scale.ts
@@ -1,4 +1,4 @@
-import { IFormatter } from '../formatters/iformatter';
+import { IPriceFormatter } from '../formatters/iprice-formatter';
 import { PercentageFormatter } from '../formatters/percentage-formatter';
 import { PriceFormatter } from '../formatters/price-formatter';
 
@@ -140,7 +140,7 @@ export class PriceScale {
 
 	private _scaleStartPoint: number | null = null;
 	private _scrollStartPoint: number | null = null;
-	private _formatter: IFormatter = defaultPriceFormatter;
+	private _formatter: IPriceFormatter = defaultPriceFormatter;
 
 	public constructor(id: string, options: PriceScaleOptions, layoutOptions: LayoutOptions, localizationOptions: LocalizationOptions) {
 		this._id = id;
@@ -636,7 +636,7 @@ export class PriceScale {
 		this._priceRangeSnapshot = null;
 	}
 
-	public formatter(): IFormatter {
+	public formatter(): IPriceFormatter {
 		if (!this._formatter) {
 			this.updateFormatter();
 		}
@@ -884,7 +884,7 @@ export class PriceScale {
 		return null;
 	}
 
-	private _formatPrice(price: BarPrice, fallbackFormatter?: IFormatter): string {
+	private _formatPrice(price: BarPrice, fallbackFormatter?: IPriceFormatter): string {
 		if (this._localizationOptions.priceFormatter === undefined) {
 			if (fallbackFormatter === undefined) {
 				fallbackFormatter = this.formatter();

diff --git a/src/model/series.ts b/src/model/series.ts
@@ -1,4 +1,4 @@
-import { IFormatter } from '../formatters/iformatter';
+import { IPriceFormatter } from '../formatters/iprice-formatter';
 import { PercentageFormatter } from '../formatters/percentage-formatter';
 import { PriceFormatter } from '../formatters/price-formatter';
 import { VolumeFormatter } from '../formatters/volume-formatter';
@@ -100,7 +100,7 @@ export class Series<T extends SeriesType = SeriesType> extends PriceDataSource i
 	private _data: SeriesPlotList<T> = createSeriesPlotList();
 	private readonly _priceAxisViews: IPriceAxisView[];
 	private readonly _panePriceAxisView: PanePriceAxisView;
-	private _formatter!: IFormatter;
+	private _formatter!: IPriceFormatter;
 	private readonly _priceLineView: SeriesPriceLinePaneView = new SeriesPriceLinePaneView(this);
 	private readonly _customPriceLines: CustomPriceLine[] = [];
 	private readonly _baseHorizontalLineView: SeriesHorizontalBaseLinePaneView = new SeriesHorizontalBaseLinePaneView(this);
@@ -395,7 +395,7 @@ export class Series<T extends SeriesType = SeriesType> extends PriceDataSource i
 		return this._options.priceFormat.minMove;
 	}
 
-	public formatter(): IFormatter {
+	public formatter(): IPriceFormatter {
 		return this._formatter;
 	}
 

diff --git a/tests/e2e/graphics/test-cases/series/series-price-formatter.js b/tests/e2e/graphics/test-cases/series/series-price-formatter.js
@@ -0,0 +1,54 @@
+function generateData() {
+	const res = [];
+	const time = new Date(Date.UTC(2018, 0, 1, 0, 0, 0, 0));
+	for (let i = 0; i < 60; ++i) {
+		res.push({
+			time: time.getTime() / 1000,
+			value: i,
+		});
+
+		time.setUTCDate(time.getUTCDate() + 1);
+	}
+	return res;
+}
+
+function runTestCase(container) {
+	const chart = LightweightCharts.createChart(container);
+
+	const lineSeries = chart.addLineSeries({
+		priceFormat: {
+			type: 'price',
+			precision: 4,
+			minMove: 0.005,
+		},
+	});
+	lineSeries.setData(generateData());
+	console.assert(lineSeries.priceFormatter().format(12.1) === '12.1000', 'Wrong format');
+
+	lineSeries.applyOptions({
+		priceFormat: {
+			type: 'volume',
+			precision: 5,
+			minMove: 0.05,
+		},
+	});
+	console.assert(lineSeries.priceFormatter().format(1000) === '1K', 'Wrong format');
+
+	lineSeries.applyOptions({
+		priceFormat: {
+			type: 'percent',
+			precision: 3,
+			minMove: 0.05,
+		},
+	});
+	console.assert(lineSeries.priceFormatter().format(12.1) === '12.0%', 'Wrong format');
+
+	lineSeries.applyOptions({
+		priceFormat: {
+			type: 'custom',
+			minMove: 0.02,
+			formatter: price => 'price=' + price.toFixed(2),
+		},
+	});
+	console.assert(lineSeries.priceFormatter().format(12.1) === 'price=12.10', 'Wrong format');
+}