@barchart/chart-lib 2.366.0 → 2.367.0

chart-lib/barchart.chart.d.ts

@@ -670,7 +670,7 @@ declare module "@barchart/chart-lib" {
             dividendsAdjust: boolean,
             backAdjust: boolean,
             daysToExpiration: number,
-            contractRoll: ContractRoll
+            contractRoll: ContractRoll,
         );
         unit: AggregationUnit;
         spec: AggregationSpec;
@@ -1205,7 +1205,7 @@ declare module "@barchart/chart-lib" {
     export function getStudyOptions(
         model: StudyPlotModel & { target: string },
         agg: Aggregation,
-        curves?: Curve[]
+        curves?: Curve[],
     ): StudyOptions;
 
     export enum ExpressionMissingBar {
@@ -1241,7 +1241,7 @@ declare module "@barchart/chart-lib" {
     export function makeExpression(
         model: ExprNode,
         innerSeries: TimeSeries[],
-        policy: ExprPolicy
+        policy: ExprPolicy,
     ): CalculableTimeSeries;
 
     /** The configuration is extensively documented at our documentation site. */
@@ -1608,6 +1608,7 @@ declare module "@barchart/chart-lib" {
             id: "Add" | "Get" | "Delete" | "Update";
             type?: PlotType;
             main?: boolean;
+            uid?: string;
             index?: number;
             studyId?: string;
             fundamentalId?: string;
@@ -1619,8 +1620,10 @@ declare module "@barchart/chart-lib" {
             curves?: Curve[];
             levels?: StudyLevel[];
             bands?: StudyBand[];
+            basis?: StudyBasis;
             placement?: StudyPlacement;
             cloneIndex?: number;
+            cloneUid?: string;
             offsets?: number[];
             precision?: number;
             visible?: boolean;
@@ -1641,6 +1644,7 @@ declare module "@barchart/chart-lib" {
         symbol?: string;
         type: PlotType;
         expression?: string;
+        seasonal?: string;
         leftScale?: boolean; // NOTE: deprecated, use oppositeScale instead
         oppositeScale?: boolean;
         curves?: Curve[];
@@ -1675,7 +1679,8 @@ declare module "@barchart/chart-lib" {
         id: "MovePlot";
         context: {
             id?: "Get";
-            index: number;
+            uid?: string;
+            index?: number;
             type: PlotType;
             targetPane?: MoveTargetPane;
         };
@@ -1687,7 +1692,8 @@ declare module "@barchart/chart-lib" {
         id: "PinPlot";
         context: {
             id?: "Get";
-            index: number;
+            uid?: string;
+            index?: number;
             type: PlotType;
             targetAxis?: PinPlotAxis;
         };
@@ -2001,7 +2007,7 @@ declare module "@barchart/chart-lib" {
      */
     export function appendDOMElement<N extends keyof HTMLElementTagNameMap>(
         element: HTMLElement,
-        nodeName: N
+        nodeName: N,
     ): HTMLElement;
     /**
      * Apply styles to a given DOM element
@@ -2741,6 +2747,8 @@ declare module "@barchart/chart-lib" {
     export type PlotPlacement = "TimeAxis" | "WithSeries";
 
     export interface SymbolPlotModel {
+        /** Unique identifier of this plot within a single chart definition. */
+        uid: string;
         /** The curves are visual representations of the data associated with this plot. They are individual drawings (lines, OHLC bars, candlesticks) which project some slice of data onto the screen in a particular way. There are often multiple curves per single plot and minimum is 1. */
         curves: Curve[];
         /** A symbol name of this plot. */
@@ -2760,6 +2768,8 @@ declare module "@barchart/chart-lib" {
     }
 
     export interface FundamentalPlotModel {
+        /** Unique identifier of this plot within a single chart definition. */
+        uid: string;
         /** @see SymbolPlotModel */
         curves: Curve[];
         /** The symbol name whose data we are showing. */
@@ -2773,13 +2783,30 @@ declare module "@barchart/chart-lib" {
         type: FundamentalType;
     }
 
+    export type SelectorSeasonal = {
+        kind: "offset";
+        value: number;
+    };
+
+    export type BasisMain = {
+        kind: "main";
+    };
+
+    export type BasisSeasonal = {
+        kind: "seasonal";
+        uid: string;
+        offset: number;
+    };
+
+    export type StudyBasis = BasisMain | BasisSeasonal;
+
     export interface StudyPlotModel {
+        /** Unique identifier of this plot within a single chart definition. */
+        uid: string;
         /** @see SymbolPlotModel */
         curves: Curve[];
-        /** An opaque identifier of the plot (or rather its time-series data) this study will be based on. The default value is the onlly accepted value at the moment.
-         * @default "$main";
-         */
-        basis?: string;
+        /** The plot this study will be based on. Defaults to main plot. */
+        basis?: StudyBasis;
         /** A unique identifier of the study. */
         study: StudyId;
         /** An input field the study will be based on, if there's only one (valid for large number of cases, hence this "shortcut"). */
@@ -2794,6 +2821,8 @@ declare module "@barchart/chart-lib" {
     }
 
     export interface ExpressionPlotModel {
+        /** Unique identifier of this plot within a single chart definition. */
+        uid: string;
         /** @see SymbolPlotModel */
         curves: Curve[];
         /** An expression or a mathematical formula defining this plot. The syntax is described in detail on our documentation site. */
@@ -2806,6 +2835,8 @@ declare module "@barchart/chart-lib" {
     }
 
     export interface SeasonalPlotModel {
+        /** Unique identifier of this plot within a single chart definition. */
+        uid: string;
         /** @see SymbolPlotModel */
         curves: Curve[];
         /** An expression defining this seasonal. */
@@ -2820,6 +2851,8 @@ declare module "@barchart/chart-lib" {
     }
 
     export interface ForwardPlotModel {
+        /** Unique identifier of this plot within a single chart definition. */
+        uid: string;
         /** @see SymbolPlotModel */
         curves: Curve[];
         /** An expression defining this forward. */
@@ -2838,6 +2871,7 @@ declare module "@barchart/chart-lib" {
     interface Plot {
         type: PlotType;
         curves: Curve[];
+        uid: string;
         index: number;
         axisIndex?: number;
         paneIndex?: number;
@@ -2860,6 +2894,7 @@ declare module "@barchart/chart-lib" {
         bands: StudyBand[];
         inputs: StudyInput[];
         levels: StudyLevel[];
+        basis?: StudyBasis;
         placement: StudyPlacement;
         studyId: string;
     }