@barchart/chart-lib 2.260.0 → 2.260.2

chart-lib/barchart.chart.d.ts

@@ -537,33 +537,32 @@ declare module "@barchart/chart-lib" {
         | "IncomeStatement"
         | "Seasonal";
 
-    export type AggregationUnit = "Tick" | "Intraday" | "Day" | "Week" | "Month" | "Quarter" | "Year";
-    export type AggregationSpec =
-        | "None"
-        | "Nearest"
-        | "Continue"
-        | "FormT"
-        | "PerCount"
-        | "PerVolume"
-        | "PerRange"
-        | "PerSeconds";
-
-    export type Aggregation = {
+    export enum AggregationUnit {
+        Tick,
+        Intraday,
+        Day,
+        Week,
+        Month,
+        Quarter,
+        Year,
+    }
+
+    export enum AggregationSpec {
+        None,
+        Nearest,
+        Continue,
+        FormT,
+        PerCount,
+        PerVolume,
+        PerRange,
+        PerSeconds,
+    }
+
+    interface AggregationCommon {
         /** Number of days/weeks etc. the data is aggregated over
          * @default 1
          */
         size?: number;
-        /** The unit (or time period) of aggregation
-         * @default "Day"
-         */
-        unit?: AggregationUnit;
-        /** Additional info about the aggregation
-         * @default "None"
-         */
-        spec?: AggregationSpec;
-        /** If the volume is per contract or total (futures only)
-         * @default false
-         */
         isContractVolume?: boolean;
         /** Turn off (false) or on (true) dividends adjustment for stock data.
          * @default false
@@ -581,7 +580,42 @@ declare module "@barchart/chart-lib" {
          * @default "combined"
          */
         contractRoll?: "expiration" | "combined";
-    };
+    }
+
+    export interface AggregationModel extends AggregationCommon {
+        /** The unit (or time period) of aggregation
+         * @default "Day"
+         */
+        unit?: keyof typeof AggregationUnit;
+        /** Additional info about the aggregation
+         * @default "None"
+         */
+        spec?: keyof typeof AggregationSpec;
+        /** If the volume is per contract or total (futures only)
+         * @default false
+         */
+    }
+
+    export class Aggregation implements AggregationCommon {
+        constructor(
+            unit: AggregationUnit,
+            size: number,
+            spec: AggregationSpec,
+            isContractVolume: boolean,
+            dividendsAdjust: boolean,
+            backAdjust: boolean,
+            daysToExpiration: number,
+            contractRoll: string
+        );
+        unit: AggregationUnit;
+        spec: AggregationSpec;
+        size: number;
+        isContractVolume: boolean;
+        dividendsAdjust: boolean;
+        backAdjust: boolean;
+        daysToExpiration: number;
+        contractRoll: "expiration" | "combined";
+    }
 
     /** A range of values, values are typically inclusive. */
     interface Range {
@@ -785,7 +819,7 @@ declare module "@barchart/chart-lib" {
 
     export type DataModel = {
         /** The way the data is aggregated across time. */
-        aggregation: Aggregation;
+        aggregation: AggregationModel;
         /** Maximum number of data points to load in a first chunk (sent as-is to historical server); there is no default in the model, internally defaults to 640. */
         maxDataPoints?: number;
         /** If set, the range of time the historical data will be limited to (if supported by the historical server). */
@@ -1034,14 +1068,12 @@ declare module "@barchart/chart-lib" {
         target?: Field;
     };
 
-    export type ValueType = "Number" | "String" | "Date";
-
     export type FieldModel = {
         id: string;
-        type: ValueType;
-        category: FieldCategory;
+        type: keyof typeof FieldValueType;
+        category: keyof typeof FieldCategory;
         name?: string;
-        format: FieldFormat;
+        format: keyof typeof FieldFormat;
         shortName?: string;
     };
 
@@ -1080,6 +1112,31 @@ declare module "@barchart/chart-lib" {
         studyProvider?: StudyProvider;
     };
 
+    export function makeStudy(studyId: string, options: StudyOptions, innerSeries: TimeSeries): StudySeries;
+    export function getStudyOptions(
+        model: StudyPlotModel & { target: string },
+        agg: Aggregation,
+        curves?: Curve[]
+    ): StudyOptions;
+
+    export enum ExpressionMissingBar {
+        UsePrevious,
+        UseNext,
+        UseNone,
+    }
+
+    export enum ExpressionRecompute {
+        Minimum,
+        Everything,
+        Manual,
+    }
+
+    export enum ExpressionNoDataApproach {
+        NoAction,
+        IgnoreTimelineOnly,
+        ModelTransformRequired,
+    }
+
     /** The configuration is extensively documented at our documentation site. */
     interface Config {
         environment?: Environment;
@@ -1321,7 +1378,7 @@ declare module "@barchart/chart-lib" {
 
     export interface AggregationAccessor {
         id: string;
-        context: Aggregation;
+        context: AggregationModel;
     }
 
     export interface PeriodAccessor {
@@ -1762,13 +1819,13 @@ declare module "@barchart/chart-lib" {
         popupElement: HTMLElement;
         constructor(view: any);
         /** Initial DOM setup; override if you need any additional initialization */
-        initialize();
+        initialize(): void;
         /** Called when a value needs to be "shown"; basically means you should populate the DOM with the
          * content, won't be called if the @member value doesn't change
          */
-        showValue();
+        showValue(): void;
         /** Called when hiding the popup, in case you need to do anything (most often you don't) */
-        hideValue();
+        hideValue(): void;
     }
 
     /**
@@ -1846,15 +1903,15 @@ declare module "@barchart/chart-lib" {
         /** Does again the last change undone to an annotation */
         redo(): void;
         /** Pause the undo/redo mechanism */
-        pauseUndoRedo();
+        pauseUndoRedo(): void;
         /** Resume the undo/redo mechanism
          * @param acceptLastChange Apply the last change while the undo/redo was paused
          * */
-        resumeUndoRedo(acceptLastChange: boolean);
+        resumeUndoRedo(acceptLastChange: boolean): void;
         /** Starts (or resets) the interactive zoom */
-        zoom(zoomIn: boolean);
+        zoom(zoomIn: boolean): void;
         /** Resets the chart to default template and re-applies current main plot */
-        reset(preserveTheme: boolean = true): void;
+        reset(preserveTheme: boolean): void;
         /** Reserved for internal use. */
         activate(): void;
     }
@@ -2010,17 +2067,29 @@ declare module "@barchart/chart-lib" {
         Tail,
     }
 
-    export type FieldValueType = "Number" | "String" | "Date";
+    export enum FieldValueType {
+        Number,
+        String,
+        Date,
+    }
 
-    export type FieldCategory =
-        | "Common"
-        | "Study"
-        | "BalanceSheet"
-        | "IncomeStatement"
-        | "Forward"
-        | "Seasonal";
+    export enum FieldCategory {
+        Common,
+        Study,
+        BalanceSheet,
+        IncomeStatement,
+        Forward,
+        Seasonal,
+        Event,
+        Option,
+    }
 
-    export type FieldFormat = "FromMetaData" | "AsInteger" | "UseMetricUnit" | "AsPercent";
+    export enum FieldFormat {
+        FromMetaData,
+        AsInteger,
+        UseMetricUnit,
+        AsPercent,
+    }
 
     /** A field is a descriptor/tag of the price, a 'kind' of price. Without the concept of fields, we wouldn't be able to distinguish different prices because they'd all be just numbers.  */
     export interface Field {
@@ -2084,6 +2153,7 @@ declare module "@barchart/chart-lib" {
          * @returns A string representation of the price.
          */
         format(price: number, field: Field, options: any): string;
+        shutdown(): void;
     }
 
     export interface IMetaDataSource {
@@ -2223,12 +2293,14 @@ declare module "@barchart/chart-lib" {
      */
     function parseExpression(text: string, useCache?: boolean): ExpressionSuccess | ExpressionError;
 
+    export type ValueProviderFunc = (symbol: string, field?: string) => number | null;
+
     /** If you would like to evaluate an expression yourself.
      * @param model Same as @see model property of the @see ExpressionSuccess
      * @param valueProvider A function which, given a symbol name, returns a price.
      * @returns The computed value of the expression.
      */
-    function evaluateExpression(model: ExpressionInternalModel, valueProvider: (string) => number): number;
+    function evaluateExpression(model: ExpressionInternalModel, valueProvider: ValueProviderFunc): number;
 
     interface StudyMetaRange {
         min: number;