Merge pull request #1739 from tradingview/get_pricelines_from_iseriesapi

Add method priceLines in ISeriesAPI

src/api/iseries-api.ts

@@ -259,6 +259,11 @@ export interface ISeriesApi<
 	 */
 	removePriceLine(line: IPriceLine): void;
 
+	/**
+	 * Returns an array of price lines.
+	 */
+	priceLines(): IPriceLine[];
+
 	/**
 	 * Return current series type.
 	 *

src/api/series-api.ts

@@ -7,6 +7,7 @@ import { clone, merge } from '../helpers/strict-type-checks';
 
 import { BarPrice } from '../model/bar';
 import { Coordinate } from '../model/coordinate';
+import { CustomPriceLine } from '../model/custom-price-line';
 import { DataUpdatesConsumer, SeriesDataItemTypeMap, WhitespaceData } from '../model/data-consumer';
 import { checkItemsAreOrdered, checkPriceLineOptions, checkSeriesValuesType } from '../model/data-validators';
 import { IHorzScaleBehavior } from '../model/ihorz-scale-behavior';
@@ -43,8 +44,7 @@ export class SeriesApi<
 	TOptions extends SeriesOptionsMap[TSeriesType] = SeriesOptionsMap[TSeriesType],
 	TPartialOptions extends SeriesPartialOptionsMap[TSeriesType] = SeriesPartialOptionsMap[TSeriesType]
 > implements
-		ISeriesApi<TSeriesType, HorzScaleItem, TData, TOptions, TPartialOptions>,
-		IDestroyable {
+	ISeriesApi<TSeriesType, HorzScaleItem, TData, TOptions, TPartialOptions>, IDestroyable {
 	protected _series: Series<TSeriesType>;
 	protected _dataUpdatesConsumer: DataUpdatesConsumer<TSeriesType, HorzScaleItem>;
 	protected readonly _chartApi: IChartApiBase<HorzScaleItem>;
@@ -210,6 +210,10 @@ export class SeriesApi<
 		this._series.removePriceLine((line as PriceLine).priceLine());
 	}
 
+	public priceLines(): IPriceLine[] {
+		return this._series.priceLines().map((priceLine: CustomPriceLine): IPriceLine => new PriceLine(priceLine));
+	}
+
 	public seriesType(): TSeriesType {
 		return this._series.seriesType();
 	}

src/model/series.ts

@@ -272,6 +272,10 @@ export class Series<T extends SeriesType> extends PriceDataSource implements IDe
 		this.model().updateSource(this);
 	}
 
+	public priceLines(): CustomPriceLine[] {
+		return this._customPriceLines;
+	}
+
 	public seriesType(): T {
 		return this._seriesType;
 	}

tests/e2e/graphics/test-cases/series/price-lines-getter.js

@@ -0,0 +1,44 @@
+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 = window.chart = LightweightCharts.createChart(container, { layout: { attributionLogo: false } });
+
+	const series = chart.addSeries(LightweightCharts.LineSeries);
+	series.setData(generateData());
+
+	series.createPriceLine({ price: 10 });
+	series.createPriceLine({ price: 20 });
+	series.createPriceLine({ price: 30 });
+
+	return new Promise(resolve => {
+		setTimeout(() => {
+			const priceLines = series.priceLines();
+			const [line1, line2] = priceLines;
+
+			// remove line 3 from array, however line3 should still be visible on the chart
+			priceLines.splice(2, 1);
+
+			// still check it can be removed
+			series.removePriceLine(line1);
+
+			// modify line 2 returned from the getter
+			line2.applyOptions({
+				price: 15,
+				color: 'red',
+			});
+			resolve();
+		}, 1000);
+	});
+}