// Generated by dts-bundle-generator v4.3.0 /** * Enum of possible crosshair behavior modes. * Normal means that the crosshair always follows the pointer. * Magnet means that the vertical line of the crosshair follows the pointer, while the horizontal line is placed on the corresponding series point. */ export declare enum CrosshairMode { Normal = 0, Magnet = 1 } export declare enum LineStyle { Solid = 0, Dotted = 1, Dashed = 2, LargeDashed = 3, SparseDotted = 4 } export declare enum LineType { Simple = 0, WithSteps = 1 } export declare enum PriceLineSource { /** * The last bar data */ LastBar = 0, /** * The last visible bar in viewport */ LastVisible = 1 } /** * Enum of possible price scale modes * Normal mode displays original price values * Logarithmic mode makes price scale show logarithms of series values instead of original values * Percentage turns the percentage mode on. * IndexedTo100 turns the "indexed to 100" mode on */ export declare enum PriceScaleMode { Normal = 0, Logarithmic = 1, Percentage = 2, IndexedTo100 = 3 } export declare enum TickMarkType { Year = 0, Month = 1, DayOfMonth = 2, Time = 3, TimeWithSeconds = 4 } /** * This function is the main entry point of the Lightweight Charting Library * @param container - id of HTML element or element itself * @param options - any subset of ChartOptions to be applied at start. * @returns an interface to the created chart */ export declare function createChart(container: string | HTMLElement, options?: DeepPartial): IChartApi; export declare function isBusinessDay(time: Time): time is BusinessDay; export declare function isUTCTimestamp(time: Time): time is UTCTimestamp; export declare function version(): string; /** * Structure describing area series options. */ export declare type AreaSeriesOptions = SeriesOptions; export declare type AreaSeriesPartialOptions = SeriesPartialOptions; export declare type AutoscaleInfoProvider = (baseImplementation: () => AutoscaleInfo | null) => AutoscaleInfo | null; export declare type BarPrice = Nominal; /** * Structure describing bar series options. */ export declare type BarSeriesOptions = SeriesOptions; export declare type BarSeriesPartialOptions = SeriesPartialOptions; export declare type BarsInfo = Partial> & { barsBefore: number; barsAfter: number; }; /** * Structure describing candlesticks series options. */ export declare type CandlestickSeriesOptions = SeriesOptions; export declare type CandlestickSeriesPartialOptions = SeriesPartialOptions; export declare type Coordinate = Nominal; export declare type DeepPartial = { [P in keyof T]?: T[P] extends Array ? Array> : T[P] extends ReadonlyArray ? ReadonlyArray> : DeepPartial; }; /** * Structure describing histogram series options. */ export declare type HistogramSeriesOptions = SeriesOptions; export declare type HistogramSeriesPartialOptions = SeriesPartialOptions; export declare type HorzAlign = 'left' | 'center' | 'right'; /** * Structure describing line series options. */ export declare type LineSeriesOptions = SeriesOptions; export declare type LineSeriesPartialOptions = SeriesPartialOptions; export declare type LineWidth = 1 | 2 | 3 | 4; export declare type Logical = Nominal; export declare type LogicalRange = Range; export declare type LogicalRangeChangeEventHandler = (logicalRange: LogicalRange | null) => void; export declare type MouseEventHandler = (param: MouseEventParams) => void; /** * This is the generic type useful for declaring a nominal type, * which does not structurally matches with the base type and * the other types declared over the same base type * * Usage: * @example * type Index = Nominal; * // let i: Index = 42; // this fails to compile * let i: Index = 42 as Index; // OK * @example * type TagName = Nominal; */ export declare type Nominal = T & { [Symbol.species]: Name; }; export declare type OverlayPriceScaleOptions = Omit; 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 SeriesOptions = T & SeriesOptionsCommon; export declare type SeriesPartialOptions = DeepPartial; export declare type SeriesType = keyof SeriesOptionsMap; export declare type TickMarkFormatter = (timePoint: TimePoint, tickMarkType: TickMarkType, locale: string) => string; export declare type Time = UTCTimestamp | BusinessDay | string; export declare type TimeFormatterFn = (time: BusinessDay | UTCTimestamp) => string; export declare type TimeRange = Range