@pipsend/charts 2.3.17 → 2.3.19

package/dist/typings.d.ts

@@ -185,6 +185,11 @@ export declare class BrushTool extends DrawingToolBase {
 	startDrawingMode(): void;
 	stopDrawingMode(): void;
 	isDrawingModeActive(): boolean;
+	/**
+	 * A brush armed for its next stroke is not a drawing yet: it stays out of the
+	 * undo history, where restoring it would re-arm a brush the app does not hold.
+	 */
+	isComplete(): boolean;
 	private _onPointerDown;
 	private _onPointerMove;
 	private _onPointerUp;
@@ -2474,6 +2479,7 @@ export declare function createTextTool(context: DrawingContext, options: TextToo
  * ```
  */
 export declare function createTextWatermark<T>(pane: IPaneApi<T>, options: DeepPartial<TextWatermarkOptions>): ITextWatermarkPluginApi<T>;
+export declare function createTimeLabels<HorzScaleItem>(series: ISeriesApi<SeriesType, HorzScaleItem>, labels?: readonly TimeLabel<HorzScaleItem>[], options?: DeepPartial<TimeLabelsOptions>): ITimeLabelsPluginApi<HorzScaleItem>;
 /**
  * Create a flexible trading line with presets for common trading scenarios
  * @param series - Series to attach the line to
@@ -5296,6 +5302,12 @@ export interface ISeriesUpDownMarkerPluginApi<HorzScaleItem, TData extends Serie
 	 */
 	clearMarkers: () => void;
 }
+export interface ITimeLabelsPluginApi<HorzScaleItem> extends ISeriesPrimitiveWrapper<HorzScaleItem, TimeLabelsOptions> {
+	setLabels: (labels: readonly TimeLabel<HorzScaleItem>[]) => void;
+	labels: () => readonly TimeLabel<HorzScaleItem>[];
+	applyOptions: (options: DeepPartial<TimeLabelsOptions>) => void;
+	detach: () => void;
+}
 /** Interface to chart time scale */
 export interface ITimeScaleApi<HorzScaleItem> {
 	/**
@@ -7397,6 +7409,19 @@ export interface TimeChartOptions extends ChartOptionsImpl<Time> {
 	 */
 	timeScale: TimeScaleOptions;
 }
+export interface TimeLabel<HorzScaleItem> {
+	time: HorzScaleItem;
+	text: string;
+	color?: string;
+	size?: number;
+}
+export interface TimeLabelsOptions {
+	position: "bottom" | "top";
+	offset: number;
+	fontSize: number;
+	fontFamily: string;
+	color: string;
+}
 /**
  * Represents a tick mark on the horizontal (time) scale.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "private": false,
-  "version": "2.3.17",
+  "version": "2.3.19",
   "name": "@pipsend/charts",
   "author": "Pipsend",
   "license": "SEE LICENSE IN LICENSE",