@barchart/chart-lib 2.200.0 → 2.201.1

chart-lib/barchart.chart.d.ts

@@ -956,6 +956,101 @@ declare module "@barchart/chart-lib" {
         password: string;
     }
 
+    export type StudyOptions = {
+        source: Field | null;
+        inputs: {
+            [key: string]: FieldValue;
+        };
+        outFields?: Field[];
+        target?: Field;
+        aggregation?: Aggregation;
+    };
+
+    export type TimeSeries = {
+        canLoadMoreData: boolean;
+        isLoading: boolean;
+        container: TimeSeriesContainer | null;
+        hasData: boolean;
+        calculable?: boolean;
+        query?: ITimeSeriesQuery;
+        loadMoreData(headChunk?: boolean): Promise<void>;
+        ready(): Promise<boolean>;
+        getCacheableEntities(unique: Set<TimeSeries>): void;
+        refresh(): void;
+        shutdown(): void;
+        isCached?: boolean;
+        record?: Record;
+    };
+
+    export type CalcCtx = {
+        tag: string;
+        src: TimeSeries | null;
+    };
+
+    export type CalculableTimeSeries = TimeSeries & {
+        calculate(calcCtx?: CalcCtx): void;
+        recalculateAt(calcCtx: CalcCtx, index: number, add: boolean): void;
+        calcCtx?: CalcCtx;
+        recalcTriggers: Set<TimeSeries>;
+        usedAsStyle?: boolean;
+    };
+
+    export type StudyTimeSeries = CalculableTimeSeries & {
+        baseVal(fld: Field, pos: number): FieldValue;
+        get base(): TimeSeriesContainer;
+        atLeast(pos: number, len: number): boolean;
+        past(pos: number, len: number, fld: Field, container: TimeSeriesContainer): FieldValueArray;
+        get source(): Field | null;
+        set source(value: Field | null);
+        target?: Field;
+    };
+
+    export type ValueType = "Number" | "String" | "Date";
+
+    export type FieldModel = {
+        id: string;
+        type: ValueType;
+        category: FieldCategory;
+        name?: string;
+        format: FieldFormat;
+        shortName?: string;
+    };
+
+    export type StudyModel = {
+        id: string;
+        defaults: StudyDefaults;
+        meta: StudyMeta;
+    };
+
+    export type CalculationResult = {
+        [key: string]: FieldValue;
+    };
+
+    export type GetValuesFunc = () => FieldValueArray;
+
+    export type FieldToValuesMapping = {
+        f: Field;
+        g: GetValuesFunc;
+    };
+
+    export type StudySeries = StudyTimeSeries &
+        StudyOptions & {
+            new (options: StudyOptions, ...innerSeries: TimeSeries[]): StudySeries;
+            calculateAt?(pos: number): CalculationResult | null;
+            wrapInner(field: Field, index: number): FieldToValuesMapping;
+            getWrappers?(): FieldToValuesMapping[];
+        };
+
+    export type StudyProvider = {
+        getStudies(): StudyModel[];
+        getFields(): FieldModel[];
+        factory(studyId: string, options: StudyOptions, innerSeries: TimeSeries): StudySeries | null;
+    };
+
+    export type Extensions = {
+        studyProvider?: StudyProvider;
+    };
+
     /** The configuration is extensively documented at our documentation site. */
     interface Config {
         environment?: Environment;
@@ -977,6 +1072,7 @@ declare module "@barchart/chart-lib" {
         logo?: string;
         baseUrl?: BaseUrl;
         overrides?: Overrides;
+        extensions?: Extensions;
         noDataText?: string;
         useAllFieldsForComparison?: boolean;
         credentials?: ICredentials;
@@ -987,6 +1083,25 @@ declare module "@barchart/chart-lib" {
         getCustomEventPopup(view: any): CustomEventPopup | null;
     }
 
+    export type Trade = {
+        isTrade: true;
+        symbol?: string;
+        time: Date;
+        tradePrice: number | undefined;
+        tradeSize: number;
+    };
+
+    export type ProcessingResult = {
+        isUpdate: boolean;
+        time: number;
+        index: number;
+    };
+
+    export class OHLCDataPointBuilder {
+        constructor(container: TimeSeriesContainer, agg: Aggregation);
+        process(trade: Trade): ProcessingResult;
+    }
+
     /** How should the chart be initialized on startup (if at all). Please note that this is suited for cases where the `template` is already made such that it matches the type of the main plot. This is not an issue: if the template doesn't match (main plot is set to a different kind of plot) the main plot will be replaced by the desired plot with all the values set to their defaults. */
     export type ChartConfig = {
         /** Make the main a plot a symbol. */