// Generated by dts-bundle-generator v9.5.1

import { Coordinate, DataChangedScope, IChartApi, IPrimitivePaneView, ISeriesApi, ISeriesPrimitive, ISeriesPrimitiveAxisView, LineStyle, PrimitiveHoveredItem, PrimitivePaneViewZOrder, SeriesAttachedParameter, SeriesOptionsMap, SeriesType, Time } from 'lightweight-charts';

declare abstract class PluginBase implements ISeriesPrimitive<Time> {
	private _chart;
	private _series;
	protected dataUpdated?(scope: DataChangedScope): void;
	protected requestUpdate(): void;
	private _requestUpdate?;
	attached({ chart, series, requestUpdate }: SeriesAttachedParameter<Time>): void;
	detached(): void;
	get chart(): IChartApi;
	get series(): ISeriesApi<keyof SeriesOptionsMap>;
	private _fireDataUpdated;
}
export type Callback<T1 = void> = (param1: T1) => void;
export interface ISubscription<T1 = void> {
	subscribe(callback: Callback<T1>, linkedObject?: unknown, singleshot?: boolean): void;
	unsubscribe(callback: Callback<T1>): void;
	unsubscribeAll(linkedObject: unknown): void;
}
/**
 * An optional text badge drawn on the line itself, for a short caption that
 * should stay next to the line rather than sit on the time axis.
 */
export interface VerticalLineBadgeOptions {
	/** Text of the badge. An empty string hides it. */
	text: string;
	/** Text color. */
	color: string;
	/** Background color. */
	backgroundColor: string;
	/** Border color. Leave undefined for no border. */
	borderColor?: string;
	/** Border width, in CSS pixels. */
	borderWidth: number;
	/** Corner radius of the background, in CSS pixels. */
	borderRadius: number;
	/** Font, as a CSS `font` shorthand. */
	font: string;
	/** Space between the text and the edge of the background, in CSS pixels. */
	padding: number;
	/** Distance from the line and from the pane edge, in CSS pixels. */
	margin: number;
	/** Where along the line the badge sits. */
	verticalAlign: "top" | "middle" | "bottom";
	/** Which side of the line the badge sits on. */
	horizontalAlign: "left" | "right";
}
/** Where the line is placed when its time is not a bar of the chart. */
export type VerticalLineSnap = "exact" | "nearest";
export interface VerticalLineOptions {
	/** Color of the line. */
	color: string;
	/** Width of the line, in CSS pixels. */
	width: number;
	/** Dash pattern of the line. */
	lineStyle: LineStyle;
	/**
	 * Draw the line itself. Set it to `false` for a time-axis label with no
	 * line, which is also what the badge and the hit test follow.
	 */
	lineVisible: boolean;
	/** Show a label at the line's position on the time axis. */
	showLabel: boolean;
	/** Draw the tick mark of the time-axis label. */
	tickVisible: boolean;
	/** Text of the time-axis label. Overrides {@link labelFormatter} when set. */
	labelText: string;
	/**
	 * Builds the text of the time-axis label from the line's time. Used only
	 * while `labelText` is empty; the default formats the time the way the
	 * chart's own time axis does.
	 */
	labelFormatter?: (time: Time) => string;
	/** Background color of the label. */
	labelBackgroundColor: string;
	/** Text color of the label. */
	labelTextColor: string;
	/** Layer the line is drawn in. */
	zOrder: PrimitivePaneViewZOrder;
	/**
	 * `'exact'` draws the line only at a time which is a bar of the chart;
	 * `'nearest'` places it at the closest bar instead.
	 */
	snap: VerticalLineSnap;
	/** Lets the user drag the line along the time scale. */
	draggable: boolean;
	/** Distance from the line, in CSS pixels, still counted as a hit. */
	hitTestTolerance: number;
	/** Reported as `externalId` for a hit on this line. */
	id: string;
	/** Text badge drawn on the line. Omit it for no badge. */
	badge?: Partial<VerticalLineBadgeOptions> & {
		text: string;
	};
}
/** @deprecated Use VerticalLineOptions. */
export type VertLineOptions = VerticalLineOptions;
/** Values used for any option not passed to the constructor. */
export declare const defaultOptions: VerticalLineOptions;
/** Values used for any badge option left out. */
export declare const defaultBadgeOptions: VerticalLineBadgeOptions;
export declare class VerticalLine extends PluginBase {
	private readonly _paneViews;
	private readonly _timeAxisViews;
	private readonly _timeChanged;
	private _options;
	private _time;
	private _x;
	private _dragging;
	private _pointerId;
	private _restoreHandlers;
	private _unsubscribers;
	/**
	 * Creates a vertical line at the given time. Attach it to a series with
	 * `series.attachPrimitive(line)`.
	 */
	constructor(time: Time, options?: Partial<VerticalLineOptions>);
	/**
	 * @deprecated Pass the time and the options only: `new VerticalLine(time, options)`.
	 * The chart and the series are taken from the series the line is attached to.
	 */
	constructor(chart: IChartApi, series: ISeriesApi<SeriesType>, time: Time, options?: Partial<VerticalLineOptions>);
	attached(param: SeriesAttachedParameter<Time>): void;
	detached(): void;
	/** The time the line is drawn at. */
	time(): Time;
	/** Moves the line to another time. */
	setTime(time: Time): void;
	/** Fired whenever the line's time changes, including while it is dragged. */
	timeChanged(): ISubscription<Time>;
	/** The line's current options. */
	options(): Readonly<VerticalLineOptions>;
	/** Merges `options` into the line's options and redraws it. */
	applyOptions(options: Partial<VerticalLineOptions>): void;
	/** Horizontal position of the line, or `null` when its time is off scale. */
	coordinate(): Coordinate | null;
	/** Badge options with the defaults filled in, or `null` for no badge. */
	badgeOptions(): VerticalLineBadgeOptions | null;
	updateAllViews(): void;
	timeAxisViews(): ISeriesPrimitiveAxisView[];
	paneViews(): IPrimitivePaneView[];
	hitTest(x: number, _y: number): PrimitiveHoveredItem | null;
	private _labelText;
	private _defaultLabelText;
	private _updateCoordinate;
	private _chartOrNull;
	private _subscribeDragHandlers;
	private _unsubscribeDragHandlers;
	private _paneX;
	private _onPointerDown;
	private _onPointerMove;
	private _onPointerUp;
	private _endDrag;
}
/** @deprecated Use VerticalLine. */
export declare const VertLine: typeof VerticalLine;
/** @deprecated Use VerticalLine. */
export type VertLine = VerticalLine;

export {};