lightweight-charts - npm Package Compare versions

Comparing version 3.1.5 to 3.2.0

dist/typings.d.ts

@@ -1,2 +0,2 @@
-// Generated by dts-bundle-generator v4.3.0
+// Generated by dts-bundle-generator v5.5.0
 
@@ -70,3 +70,3 @@ /**
 export declare type AutoscaleInfoProvider = (baseImplementation: () => AutoscaleInfo | null) => AutoscaleInfo | null;
-export declare type BarPrice = Nominal<number, 'BarPrice'>;
+export declare type BarPrice = Nominal<number, "BarPrice">;
 /**
@@ -86,3 +86,3 @@ * Structure describing bar series options.
 export declare type CandlestickSeriesPartialOptions = SeriesPartialOptions<CandlestickStyleOptions>;
-export declare type Coordinate = Nominal<number, 'Coordinate'>;
+export declare type Coordinate = Nominal<number, "Coordinate">;
 export declare type DeepPartial<T> = {
@@ -96,3 +96,3 @@ [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends readonly (infer X)[] ? readonly DeepPartial<X>[] : DeepPartial<T[P]>;
 export declare type HistogramSeriesPartialOptions = SeriesPartialOptions<HistogramStyleOptions>;
-export declare type HorzAlign = 'left' | 'center' | 'right';
+export declare type HorzAlign = "left" | "center" | "right";
 /**
@@ -104,3 +104,3 @@ * Structure describing line series options.
 export declare type LineWidth = 1 | 2 | 3 | 4;
-export declare type Logical = Nominal<number, 'Logical'>;
+export declare type Logical = Nominal<number, "Logical">;
 export declare type LogicalRange = Range<Logical>;
@@ -126,7 +126,7 @@ export declare type LogicalRangeChangeEventHandler = (logicalRange: LogicalRange | null) => void;
 };
-export declare type OverlayPriceScaleOptions = Omit<PriceScaleOptions, 'visible' | 'autoScale'>;
+export declare type OverlayPriceScaleOptions = Omit<PriceScaleOptions, "visible" | "autoScale">;
 export declare type PriceFormat = PriceFormatBuiltIn | PriceFormatCustom;
 export declare type PriceFormatterFn = (priceValue: BarPrice) => string;
-export declare type SeriesMarkerPosition = 'aboveBar' | 'belowBar' | 'inBar';
-export declare type SeriesMarkerShape = 'circle' | 'square' | 'arrowUp' | 'arrowDown';
+export declare type SeriesMarkerPosition = "aboveBar" | "belowBar" | "inBar";
+export declare type SeriesMarkerShape = "circle" | "square" | "arrowUp" | "arrowDown";
 export declare type SeriesOptions<T> = T & SeriesOptionsCommon;
@@ -140,4 +140,4 @@ export declare type SeriesPartialOptions<T> = DeepPartial<T & SeriesOptionsCommon>;
 export declare type TimeRangeChangeEventHandler = (timeRange: TimeRange | null) => void;
-export declare type UTCTimestamp = Nominal<number, 'UTCTimestamp'>;
-export declare type VertAlign = 'top' | 'center' | 'bottom';
+export declare type UTCTimestamp = Nominal<number, "UTCTimestamp">;
+export declare type VertAlign = "top" | "center" | "bottom";
 export declare type VisiblePriceScaleOptions = PriceScaleOptions;
@@ -336,3 +336,3 @@ export interface AreaStyleOptions {
 	 */
-	addAreaSeries(areaOptions?: AreaSeriesPartialOptions): ISeriesApi<'Area'>;
+	addAreaSeries(areaOptions?: AreaSeriesPartialOptions): ISeriesApi<"Area">;
 	/**
@@ -344,3 +344,3 @@ * Creates a bar series with specified parameters
 	 */
-	addBarSeries(barOptions?: BarSeriesPartialOptions): ISeriesApi<'Bar'>;
+	addBarSeries(barOptions?: BarSeriesPartialOptions): ISeriesApi<"Bar">;
 	/**
@@ -352,3 +352,3 @@ * Creates a candlestick series with specified parameters
 	 */
-	addCandlestickSeries(candlestickOptions?: CandlestickSeriesPartialOptions): ISeriesApi<'Candlestick'>;
+	addCandlestickSeries(candlestickOptions?: CandlestickSeriesPartialOptions): ISeriesApi<"Candlestick">;
 	/**
@@ -360,3 +360,3 @@ * Creates a histogram series with specified parameters
 	 */
-	addHistogramSeries(histogramOptions?: HistogramSeriesPartialOptions): ISeriesApi<'Histogram'>;
+	addHistogramSeries(histogramOptions?: HistogramSeriesPartialOptions): ISeriesApi<"Histogram">;
 	/**
@@ -368,3 +368,3 @@ * Creates a line series with specified parameters
 	 */
-	addLineSeries(lineOptions?: LineSeriesPartialOptions): ISeriesApi<'Line'>;
+	addLineSeries(lineOptions?: LineSeriesPartialOptions): ISeriesApi<"Line">;
 	/**
@@ -504,3 +504,3 @@ * Removes a series of any type. This is an irreversible operation, you cannot do anything with the series after removing it
 	/**
-	 * Returns interface of the pri scale the series is currently attached
+	 * Returns interface of the price scale the series is currently attached
 	 *
@@ -595,2 +595,16 @@ * @returns IPriceScaleApi object to control the price scale
 	/**
+	 * Converts a logical index to local x coordinate.
+	 *
+	 * @param logical - logical index needs to be converted
+	 * @returns x coordinate of that time or `null` if the chart doesn't have data
+	 */
+	logicalToCoordinate(logical: Logical): Coordinate | null;
+	/**
+	 * Converts a coordinate to logical index.
+	 *
+	 * @param x - coordinate needs to be converted
+	 * @returns logical index that is located on that coordinate or `null` if the chart doesn't have data
+	 */
+	coordinateToLogical(x: number): Logical | null;
+	/**
 	 * Converts a time to local x coordinate.
@@ -701,3 +715,3 @@ *
 	hoveredSeries?: ISeriesApi<SeriesType>;
-	hoveredMarkerId?: SeriesMarker<Time>['id'];
+	hoveredMarkerId?: SeriesMarker<Time>["id"];
 }
@@ -724,3 +738,3 @@ export interface Point {
 	 */
-	type: 'price' | 'volume' | 'percent';
+	type: "price" | "volume" | "percent";
 	/**
@@ -737,3 +751,3 @@ * Number of digits after the decimal point.
 export interface PriceFormatCustom {
-	type: 'custom';
+	type: "custom";
 	/**
@@ -754,2 +768,3 @@ * User-defined function for price formatting that could be used for some specific cases, that could not be covered with PriceFormatBuiltIn
 	axisLabelVisible: boolean;
+	title: string;
 }
@@ -820,2 +835,4 @@ export interface PriceRange {
 	priceScaleId?: string;
+	/** Visibility of series. */
+	visible: boolean;
 	/** Visibility of the price line. Price line is a horizontal line indicating the last price of the series */
@@ -822,0 +839,0 @@ priceLineVisible: boolean;

package.json

 {
-  "version": "3.1.5",
+  "version": "3.2.0",
   "name": "lightweight-charts",
@@ -4,0 +4,0 @@ "author": "TradingView, Inc.",

No alert changes

Improved metrics

Total package byte prevSize

1390052

increased by1.62%

Lines of code

23331

increased by1.74%

No dependency changes