@barchart/chart-lib 2.387.2 → 2.388.0

chart-lib/barchart.chart.d.ts

@@ -887,10 +887,16 @@ declare module "@barchart/chart-lib" {
     export type AnnotationModel = {
         /** A unique identifier of the annotation. */
         id: AnnotationId;
+        /** A unique instance identifier; generated during normalization when not provided. */
+        uid?: string;
         /** Whether the annotation is visible or not.
          * @default true
          */
         visible?: boolean;
+        /** When `true` the annotation cannot be moved or edited interactively.
+         * @default false
+         */
+        locked?: boolean;
         /** Annotation's visual properties like line color, stroke width, fill color etc. */
         traits?: AnnotationTraitsModel;
         /** Each annotation has one or more anchors, which are points the user can move around and arrange. For example, Line annotation has two - start and end of the line. Note that the point's coordinates are (time, price). */
@@ -1149,7 +1155,7 @@ declare module "@barchart/chart-lib" {
         refresh(): void;
         shutdown(): void;
         isCached?: boolean;
-        record?: Record;
+        record?: IRecord;
     };
 
     export type CalcCtx = {
@@ -2142,6 +2148,10 @@ declare module "@barchart/chart-lib" {
         annotate(id?: string, traits?: AnnotationTraits, annParam?: any): void;
         /** Cancel the (interactive) annotation creation and go back to the default (typically pan and zoom) tool  */
         cancelAnnotation(): void;
+        /** Replaces **all** annotations of the main axis — including any user-created ones — with the given models. Intended for fully programmatically-driven charts (strike/breakeven markers etc.) where users don't draw their own annotations. No-op for headless charts or before a main plot exists. */
+        setMainAxisAnnotations(annotations: AnnotationModel[]): void;
+        /** Converts pixel coordinates (relative to the chart) into the main axis' data coordinates; `time` is `undefined` when the x position cannot be mapped to the series. Returns `null` for headless charts or before a main plot exists. */
+        toMainAxisPoint(p: { x: number; y: number }): { price?: number; time?: Date } | null;
         /** Helper method to return back the default template, the same one you've provided during the feed's @see init call. */
         getDefaultTemplate(): string;
         /** Main API entry point. Please check out online documentation for details. */
@@ -2207,11 +2217,14 @@ declare module "@barchart/chart-lib" {
         cacheMe?: boolean;
     }
 
+    /** A pair of range boundaries: `[from, to]`; either end can be `null` for an open-ended range. */
+    export type RangePair = [number | Date | null, number | Date | null];
+
     interface NormalTimeSeriesQuery extends BaseTimeSeriesQuery {
         /** Aggregation of the data. */
         aggregation: Aggregation;
         /** Limit returned data to a given time span. */
-        range?: Range;
+        range?: RangePair;
         /** Should we apply the splits (`true` by default) to the data? */
         splits?: boolean;
         /** Should we pad the data (`false` by default) with almost empty values - for holidays - to make sure that
@@ -2220,7 +2233,25 @@ declare module "@barchart/chart-lib" {
     }
 
     export class TimeSeriesQuery implements NormalTimeSeriesQuery {
-        constructor(symbol: string, agg: Aggregation);
+        constructor(symbol: string, agg: Aggregation, seriesKind?: SeriesKind, range?: RangePair);
+        /** Symbol name to load the data for. */
+        symbol: string;
+        /** Aggregation of the data. */
+        aggregation: Aggregation;
+        /** A kind of series we're loading, @see SeriesKind. */
+        seriesKind: SeriesKind;
+        /** Should the chart cache the result; used _only_ when the data feed supports caching. */
+        cacheMe: boolean;
+        /** Limit returned data to a given time span. */
+        range?: RangePair;
+        /** Should we apply the splits (`true` by default) to the data? */
+        splits: boolean;
+        /** Should we pad the data (`false` by default) with almost empty values - for holidays. */
+        padded: boolean;
+        /** How many bars to fetch when no explicit @see range is given. */
+        barsToFetch: number;
+        /** When `true` the @see barsToFetch value is honored even when a @see range is present. */
+        alwaysUseBarsToFetch: boolean;
     }
 
     interface EventsTimeSeriesQuery extends BaseTimeSeriesQuery {
@@ -2457,7 +2488,7 @@ declare module "@barchart/chart-lib" {
     export type FieldValueArray = number[] | Date[] | string[] | null;
 
     /** Please treat as opaque for now. */
-    export interface Record {
+    export interface IRecord {
         ready(): Promise<boolean>;
         hasField(field: Field): boolean;
         getValue(field: Field): FieldValue;
@@ -2465,7 +2496,7 @@ declare module "@barchart/chart-lib" {
 
     /** Please treat as opaque for now. */
     export interface IRecordSource extends BaseRecordSource {
-        getRecord(symbol: string): Record;
+        getRecord(symbol: string): IRecord;
     }
 
     /** A common implementation used by all data feeds. Please note that the implementation contains several more methods, none of which are essential nor need to be used/overridden thus we don't document them. */
@@ -2522,7 +2553,28 @@ declare module "@barchart/chart-lib" {
         connection?: any;
     }
 
-    export function adaptOpenFeedClient(client: any, listener: any): any;
+    /** Implement to receive raw OpenFeed events when driving the chart through your own OpenFeed client. */
+    export interface IOpenFeedListener {
+        onConnected(): void;
+        onDisconnected(): void;
+        onHeartBeat(heartBeat: any): void;
+        onUpdate(update: any, symbol: string): void;
+        onSnapshot(snapshot: any, symbol: string): void;
+    }
+
+    /** Adapter over an external OpenFeed client, @see adaptOpenFeedClient. */
+    export interface IOpenFeedClientAdapter {
+        subscribeToRealTime(symbol: string): void;
+        unsubscribeFromRealTime(symbol: string): void;
+        shutdown(): void;
+        ready(): Promise<boolean>;
+        getInstrument(request: any): Promise<any[]>;
+        addListener(listener: IOpenFeedListener): void;
+        removeListener(listener: IOpenFeedListener): void;
+    }
+
+    /** Wraps an externally-created OpenFeed SDK client for use by the @see OpenFeed feed. The parameters are SDK types (`IOpenFeedClient`, `OpenFeedListeners`) left as `any` here so this declaration file does not require `@openfeed/sdk-js` to be installed. */
+    export function adaptOpenFeedClient(client: any, listener: any): IOpenFeedClientAdapter;
 
     class OpenFeed extends BaseDataFeed {
         setAdapter(adapter?: any): void;
@@ -3039,6 +3091,11 @@ declare module "@barchart/chart-lib" {
 
     export function optionValueToDate(value: number): Date;
 
+    export function dateToOptionValue(date: Date): number;
+
+    /** True if the study can be used as the basis of a seasonal chart (single-field based studies only). */
+    export function canBeBasedOnSeasonal(study: StudyModel): boolean;
+
     export {
         initFeed,
         getFeed,