@barchart/chart-lib 2.215.1 → 2.215.3

chart-lib/barchart.chart.d.ts

@@ -506,7 +506,7 @@ declare module "@barchart/chart-lib" {
         | "MCCLO"
         | "NHLAI";
 
-    type PlotType =
+    export type PlotType =
         | "Symbol"
         | "Expression"
         | "Study"
@@ -1254,7 +1254,16 @@ declare module "@barchart/chart-lib" {
         | MovePaneAccessor
         | TemplateAccessor
         | OutlineAccessor
-        | ThemeAccessor;
+        | ThemeAccessor
+        | ClearAccessor;
+
+    export interface ClearAccessor {
+        id: "Clear";
+        context: {
+            studies: boolean;
+            annotations: boolean;
+        };
+    }
 
     export interface MainPlotAccessor {
         id: string;
@@ -1753,6 +1762,13 @@ declare module "@barchart/chart-lib" {
      */
     export function setAttributesDOMElement(element: HTMLElement, attributes: object): void;
 
+    export type MainPlotType = Exclude<PlotType, "BalanceSheet" | "IncomeStatement" | "Study">;
+    export type MainPlotTypeLower = Lowercase<MainPlotType>;
+
+    export type MainPlotApiModel = {
+        [Property in MainPlotTypeLower]?: string;
+    } & { template?: string };
+
     /** Chart accessor is the main API entry point, it essentially _is_ the chart. */
     export class ChartAccessor {
         /** The only parameter for construction is `headless` which if set to `true` will create a chart without any kind of visual representation. This form of a chart is useful for template editors which don't render any content. */
@@ -1764,7 +1780,7 @@ declare module "@barchart/chart-lib" {
         /** Always up-to-date model of the chart at any given moment. If you need to restore the chart later, take the model and save it somewhere, then @see load the model later. */
         model: ChartModel;
         /** You don't need to call this method, it is called by the @see BaseDataFeed for you when you call the @see addChart method. */
-        initialize(renderTo: RenderTo, config: ChartConfig): void;
+        initialize(renderTo: RenderTo, init: MainPlotApiModel): void;
         /** If you are going to be creating and removing a lot of charts during the host page's lifetime, you should always call the `shutdown` method when you no longer need the chart. Please note that if you are simply going to @see load another chart's definition into the same chart instance, you don't need to call this method. In other words, this method applies if you are tearing down chart completely, and clearing the @see elementId (and @see hostElement) completely. */
         shutdown(): boolean;
         /** Call this method when you need to place an annotation on the chart. Detailed information can be found in the online documentation. */