@barchart/chart-lib 2.278.0 → 2.279.1

chart-lib/barchart.chart.d.ts

@@ -1385,7 +1385,8 @@ declare module "@barchart/chart-lib" {
         | OutlineAccessor
         | ThemeAccessor
         | ClearAccessor
-        | MovePlotAccessor;
+        | MovePlotAccessor
+        | PinPlotAccessor;
 
     export interface ClearAccessor {
         id: "Clear";
@@ -1597,6 +1598,18 @@ declare module "@barchart/chart-lib" {
         };
     }
 
+    export type PinPlotAxis = "PrimaryAxis" | "SecondaryAxis" | "NoAxis";
+
+    export interface PinPlotAccessor {
+        id: "PinPlot";
+        context: {
+            id?: "Get";
+            index: number;
+            type: PlotType;
+            targetAxis?: PinPlotAxis;
+        };
+    }
+
     export interface TemplateAccessor {
         id: string;
         context: {
@@ -2254,7 +2267,7 @@ declare module "@barchart/chart-lib" {
          * @param config The quick way to load a template and set the main plot type (with lots of defaults).
          * @returns @see ChartAccessor
          */
-        addChart(renderTo: RenderTo, config?: ChartConfig | string): ChartAccessor;
+        addChart(renderTo: RenderTo, config?: MainPlotApiModel | string | null): ChartAccessor;
         /** When you are completely tearing down the HTML of the chart on a page (assuming the page itself isn't being closed - if it is, nothing to do) you should call this method. If you are simply loading another chart's definition into the existing chart, there is no need to do this.
          * @param renderTo The id of the element (or the element itself) the chart was placed into.
          */
@@ -2404,20 +2417,13 @@ declare module "@barchart/chart-lib" {
         fill: FillTrait;
     }
 
-    export interface DetachedScale {
-        /** Top scale margin as (mathematical) percentage, defaults to 0.01 (1%) */
-        marginTop?: number;
-        /** Bottom scale margin as (mathematical) percentage, defaults to 0.01 (1%) */
-        marginBottom?: number;
-    }
-
     export interface StudyDefaults {
         source?: string;
         inputs?: StudyInput[];
         curves: Curve[];
         levels?: StudyLevel[];
         bands?: StudyBand[];
-        detachedScale?: DetachedScale;
+        detachedScale?: boolean;
     }
 
     export interface Study {