@deephaven/chart 0.38.1-beta.3 → 0.38.1-beta.5

package/dist/ChartModelFactory.d.ts

@@ -1,10 +1,11 @@
-import { Figure, Table } from '@deephaven/jsapi-shim';
+import type { dh as DhType, Figure, Table } from '@deephaven/jsapi-types';
 import { ChartModelSettings } from './ChartUtils';
 import ChartModel from './ChartModel';
 declare class ChartModelFactory {
     /**
      * Creates a model from the settings provided.
      * Tries to create a Figure in the API with it.
+     * @param dh JSAPI instance
      * @param settings The chart builder settings
      * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated
      * @param settings.series The column names to use for creating the series of this chart
@@ -17,7 +18,7 @@ declare class ChartModelFactory {
      * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel
      * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel
      */
-    static makeModelFromSettings(settings: ChartModelSettings, table: Table, theme?: Readonly<{
+    static makeModelFromSettings(dh: DhType, settings: ChartModelSettings, table: Table, theme?: Readonly<{
         paper_bgcolor: string;
         plot_bgcolor: string;
         title_color: string;
@@ -38,6 +39,7 @@ declare class ChartModelFactory {
     /**
      * Creates a model from the settings provided.
      * Tries to create a Figure in the API with it.
+     * @param dh DH JSAPI instance
      * @param settings The chart builder settings
      * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated
      * @param settings.series The column names to use for creating the series of this chart
@@ -47,10 +49,11 @@ declare class ChartModelFactory {
      * @param table The table to build the model for
      * @returns The Figure created with the settings provided
      */
-    static makeFigureFromSettings(settings: ChartModelSettings, table: Table): Promise<Figure>;
+    static makeFigureFromSettings(dh: DhType, settings: ChartModelSettings, table: Table): Promise<Figure>;
     /**
      * Creates a model from the settings provided.
      * Tries to create a Figure in the API with it.
+     * @param dh DH JSAPI instance
      * @param settings The chart builder settings
      * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated
      * @param settings.series The column names to use for creating the series of this chart
@@ -63,7 +66,7 @@ declare class ChartModelFactory {
      * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel
      * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel
      */
-    static makeModel(settings: ChartModelSettings | undefined, figure: Figure, theme?: Readonly<{
+    static makeModel(dh: DhType, settings: ChartModelSettings | undefined, figure: Figure, theme?: Readonly<{
         paper_bgcolor: string;
         plot_bgcolor: string;
         title_color: string;

package/dist/ChartModelFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChartModelFactory.d.ts","sourceRoot":"","sources":["../src/ChartModelFactory.ts"],"names":[],"mappings":"AAAA,OAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAmB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAG9D,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC,cAAM,iBAAiB;IACrB;;;;;;;;;;;;;;OAcG;WACU,qBAAqB,CAChC,QAAQ,EAAE,kBAAkB,EAC5B,KAAK,EAAE,KAAK,EACZ,KAAK;;;;;;;;;;;;;;;;;MAAa,GACjB,OAAO,CAAC,UAAU,CAAC;IAQtB;;;;;;;;;;;OAWG;WACU,sBAAsB,CACjC,QAAQ,EAAE,kBAAkB,EAC5B,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,MAAM,CAAC;IAelB;;;;;;;;;;;;;;OAcG;WACU,SAAS,CACpB,QAAQ,EAAE,kBAAkB,GAAG,SAAS,EACxC,MAAM,EAAE,MAAM,EACd,KAAK;;;;;;;;;;;;;;;;;MAAa,GACjB,OAAO,CAAC,UAAU,CAAC;CAGvB;AAED,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"ChartModelFactory.d.ts","sourceRoot":"","sources":["../src/ChartModelFactory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAmB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAG9D,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC,cAAM,iBAAiB;IACrB;;;;;;;;;;;;;;;OAeG;WACU,qBAAqB,CAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,kBAAkB,EAC5B,KAAK,EAAE,KAAK,EACZ,KAAK;;;;;;;;;;;;;;;;;MAAa,GACjB,OAAO,CAAC,UAAU,CAAC;IAStB;;;;;;;;;;;;OAYG;WACU,sBAAsB,CACjC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,kBAAkB,EAC5B,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,MAAM,CAAC;IAelB;;;;;;;;;;;;;;;OAeG;WACU,SAAS,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,kBAAkB,GAAG,SAAS,EACxC,MAAM,EAAE,MAAM,EACd,KAAK;;;;;;;;;;;;;;;;;MAAa,GACjB,OAAO,CAAC,UAAU,CAAC;CAGvB;AAED,eAAe,iBAAiB,CAAC"}

package/dist/ChartModelFactory.js

@@ -1,6 +1,5 @@
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-import dh from '@deephaven/jsapi-shim';
 import ChartUtils from "./ChartUtils.js";
 import FigureChartModel from "./FigureChartModel.js";
 import ChartTheme from "./ChartTheme.js";
@@ -8,6 +7,7 @@ class ChartModelFactory {
   /**
    * Creates a model from the settings provided.
    * Tries to create a Figure in the API with it.
+   * @param dh JSAPI instance
    * @param settings The chart builder settings
    * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated
    * @param settings.series The column names to use for creating the series of this chart
@@ -20,18 +20,19 @@ class ChartModelFactory {
    * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel
    * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel
    */
-  static makeModelFromSettings(settings, table) {
+  static makeModelFromSettings(dh, settings, table) {
     var _arguments = arguments;
     return _asyncToGenerator(function* () {
-      var theme = _arguments.length > 2 && _arguments[2] !== undefined ? _arguments[2] : ChartTheme;
-      var figure = yield ChartModelFactory.makeFigureFromSettings(settings, table);
-      return new FigureChartModel(figure, settings, theme);
+      var theme = _arguments.length > 3 && _arguments[3] !== undefined ? _arguments[3] : ChartTheme;
+      var figure = yield ChartModelFactory.makeFigureFromSettings(dh, settings, table);
+      return new FigureChartModel(dh, figure, settings, theme);
     })();
   }
 
   /**
    * Creates a model from the settings provided.
    * Tries to create a Figure in the API with it.
+   * @param dh DH JSAPI instance
    * @param settings The chart builder settings
    * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated
    * @param settings.series The column names to use for creating the series of this chart
@@ -41,23 +42,24 @@ class ChartModelFactory {
    * @param table The table to build the model for
    * @returns The Figure created with the settings provided
    */
-  static makeFigureFromSettings(settings, table) {
+  static makeFigureFromSettings(dh, settings, table) {
     return _asyncToGenerator(function* () {
       // Copy the table first and then re-apply the filters from the original table
-      // When we add toable linking we'll want to listen to the original table and update
+      // When we add table linking we'll want to listen to the original table and update
       // the copied table with any changes that occur.
       // The table gets owned by the Figure that gets created, which closes the table
       var tableCopy = yield table.copy();
       tableCopy.applyCustomColumns(table.customColumns);
       tableCopy.applyFilter(table.filter);
       tableCopy.applySort(table.sort);
-      return dh.plot.Figure.create(ChartUtils.makeFigureSettings(settings, tableCopy));
+      return dh.plot.Figure.create(new ChartUtils(dh).makeFigureSettings(settings, tableCopy));
     })();
   }
 
   /**
    * Creates a model from the settings provided.
    * Tries to create a Figure in the API with it.
+   * @param dh DH JSAPI instance
    * @param settings The chart builder settings
    * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated
    * @param settings.series The column names to use for creating the series of this chart
@@ -70,11 +72,11 @@ class ChartModelFactory {
    * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel
    * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel
    */
-  static makeModel(settings, figure) {
+  static makeModel(dh, settings, figure) {
     var _arguments2 = arguments;
     return _asyncToGenerator(function* () {
-      var theme = _arguments2.length > 2 && _arguments2[2] !== undefined ? _arguments2[2] : ChartTheme;
-      return new FigureChartModel(figure, settings, theme);
+      var theme = _arguments2.length > 3 && _arguments2[3] !== undefined ? _arguments2[3] : ChartTheme;
+      return new FigureChartModel(dh, figure, settings, theme);
     })();
   }
 }

package/dist/ChartModelFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChartModelFactory.js","names":["dh","ChartUtils","FigureChartModel","ChartTheme","ChartModelFactory","makeModelFromSettings","settings","table","theme","figure","makeFigureFromSettings","tableCopy","copy","applyCustomColumns","customColumns","applyFilter","filter","applySort","sort","plot","Figure","create","makeFigureSettings","makeModel"],"sources":["../src/ChartModelFactory.ts"],"sourcesContent":["import dh, { Figure, Table } from '@deephaven/jsapi-shim';\nimport ChartUtils, { ChartModelSettings } from './ChartUtils';\nimport FigureChartModel from './FigureChartModel';\nimport ChartTheme from './ChartTheme';\nimport ChartModel from './ChartModel';\n\nclass ChartModelFactory {\n  /**\n   * Creates a model from the settings provided.\n   * Tries to create a Figure in the API with it.\n   * @param settings The chart builder settings\n   * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated\n   * @param settings.series The column names to use for creating the series of this chart\n   * @param settings.type Chart builder type, from ChartBuilder.types\n   * @param settings.xAxis The column name to use for the x-axis\n   * @param [settings.hiddenSeries] Array of hidden series names\n   * @param table The table to build the model for\n   * @param theme The theme for the figure. Defaults to ChartTheme\n   * @returns The ChartModel Promise representing the figure\n   * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel\n   * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel\n   */\n  static async makeModelFromSettings(\n    settings: ChartModelSettings,\n    table: Table,\n    theme = ChartTheme\n  ): Promise<ChartModel> {\n    const figure = await ChartModelFactory.makeFigureFromSettings(\n      settings,\n      table\n    );\n    return new FigureChartModel(figure, settings, theme);\n  }\n\n  /**\n   * Creates a model from the settings provided.\n   * Tries to create a Figure in the API with it.\n   * @param settings The chart builder settings\n   * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated\n   * @param settings.series The column names to use for creating the series of this chart\n   * @param settings.type Chart builder type, from ChartBuilder.types\n   * @param settings.xAxis The column name to use for the x-axis\n   * @param [settings.hiddenSeries] Array of hidden series names\n   * @param table The table to build the model for\n   * @returns The Figure created with the settings provided\n   */\n  static async makeFigureFromSettings(\n    settings: ChartModelSettings,\n    table: Table\n  ): Promise<Figure> {\n    // Copy the table first and then re-apply the filters from the original table\n    // When we add toable linking we'll want to listen to the original table and update\n    // the copied table with any changes that occur.\n    // The table gets owned by the Figure that gets created, which closes the table\n    const tableCopy = await table.copy();\n    tableCopy.applyCustomColumns(table.customColumns);\n    tableCopy.applyFilter(table.filter);\n    tableCopy.applySort(table.sort);\n\n    return dh.plot.Figure.create(\n      ChartUtils.makeFigureSettings(settings, tableCopy)\n    );\n  }\n\n  /**\n   * Creates a model from the settings provided.\n   * Tries to create a Figure in the API with it.\n   * @param settings The chart builder settings\n   * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated\n   * @param settings.series The column names to use for creating the series of this chart\n   * @param settings.type Chart builder type, from ChartBuilder.types\n   * @param settings.xAxis The column name to use for the x-axis\n   * @param [settings.hiddenSeries] Array of hidden series names\n   * @param figure The figure to build the model for\n   * @param theme The theme for the figure. Defaults to ChartTheme\n   * @returns The FigureChartModel representing the figure\n   * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel\n   * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel\n   */\n  static async makeModel(\n    settings: ChartModelSettings | undefined,\n    figure: Figure,\n    theme = ChartTheme\n  ): Promise<ChartModel> {\n    return new FigureChartModel(figure, settings, theme);\n  }\n}\n\nexport default ChartModelFactory;\n"],"mappings":";;AAAA,OAAOA,EAAE,MAAyB,uBAAuB;AAAC,OACnDC,UAAU;AAAA,OACVC,gBAAgB;AAAA,OAChBC,UAAU;AAGjB,MAAMC,iBAAiB,CAAC;EACtB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAaC,qBAAqB,CAChCC,QAA4B,EAC5BC,KAAY,EAES;IAAA;IAAA;MAAA,IADrBC,KAAK,0EAAGL,UAAU;MAElB,IAAMM,MAAM,SAASL,iBAAiB,CAACM,sBAAsB,CAC3DJ,QAAQ,EACRC,KAAK,CACN;MACD,OAAO,IAAIL,gBAAgB,CAACO,MAAM,EAAEH,QAAQ,EAAEE,KAAK,CAAC;IAAC;EACvD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAaE,sBAAsB,CACjCJ,QAA4B,EAC5BC,KAAY,EACK;IAAA;MACjB;MACA;MACA;MACA;MACA,IAAMI,SAAS,SAASJ,KAAK,CAACK,IAAI,EAAE;MACpCD,SAAS,CAACE,kBAAkB,CAACN,KAAK,CAACO,aAAa,CAAC;MACjDH,SAAS,CAACI,WAAW,CAACR,KAAK,CAACS,MAAM,CAAC;MACnCL,SAAS,CAACM,SAAS,CAACV,KAAK,CAACW,IAAI,CAAC;MAE/B,OAAOlB,EAAE,CAACmB,IAAI,CAACC,MAAM,CAACC,MAAM,CAC1BpB,UAAU,CAACqB,kBAAkB,CAAChB,QAAQ,EAAEK,SAAS,CAAC,CACnD;IAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAaY,SAAS,CACpBjB,QAAwC,EACxCG,MAAc,EAEO;IAAA;IAAA;MAAA,IADrBD,KAAK,6EAAGL,UAAU;MAElB,OAAO,IAAID,gBAAgB,CAACO,MAAM,EAAEH,QAAQ,EAAEE,KAAK,CAAC;IAAC;EACvD;AACF;AAEA,eAAeJ,iBAAiB"}
+{"version":3,"file":"ChartModelFactory.js","names":["ChartUtils","FigureChartModel","ChartTheme","ChartModelFactory","makeModelFromSettings","dh","settings","table","theme","figure","makeFigureFromSettings","tableCopy","copy","applyCustomColumns","customColumns","applyFilter","filter","applySort","sort","plot","Figure","create","makeFigureSettings","makeModel"],"sources":["../src/ChartModelFactory.ts"],"sourcesContent":["import type { dh as DhType, Figure, Table } from '@deephaven/jsapi-types';\nimport ChartUtils, { ChartModelSettings } from './ChartUtils';\nimport FigureChartModel from './FigureChartModel';\nimport ChartTheme from './ChartTheme';\nimport ChartModel from './ChartModel';\n\nclass ChartModelFactory {\n  /**\n   * Creates a model from the settings provided.\n   * Tries to create a Figure in the API with it.\n   * @param dh JSAPI instance\n   * @param settings The chart builder settings\n   * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated\n   * @param settings.series The column names to use for creating the series of this chart\n   * @param settings.type Chart builder type, from ChartBuilder.types\n   * @param settings.xAxis The column name to use for the x-axis\n   * @param [settings.hiddenSeries] Array of hidden series names\n   * @param table The table to build the model for\n   * @param theme The theme for the figure. Defaults to ChartTheme\n   * @returns The ChartModel Promise representing the figure\n   * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel\n   * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel\n   */\n  static async makeModelFromSettings(\n    dh: DhType,\n    settings: ChartModelSettings,\n    table: Table,\n    theme = ChartTheme\n  ): Promise<ChartModel> {\n    const figure = await ChartModelFactory.makeFigureFromSettings(\n      dh,\n      settings,\n      table\n    );\n    return new FigureChartModel(dh, figure, settings, theme);\n  }\n\n  /**\n   * Creates a model from the settings provided.\n   * Tries to create a Figure in the API with it.\n   * @param dh DH JSAPI instance\n   * @param settings The chart builder settings\n   * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated\n   * @param settings.series The column names to use for creating the series of this chart\n   * @param settings.type Chart builder type, from ChartBuilder.types\n   * @param settings.xAxis The column name to use for the x-axis\n   * @param [settings.hiddenSeries] Array of hidden series names\n   * @param table The table to build the model for\n   * @returns The Figure created with the settings provided\n   */\n  static async makeFigureFromSettings(\n    dh: DhType,\n    settings: ChartModelSettings,\n    table: Table\n  ): Promise<Figure> {\n    // Copy the table first and then re-apply the filters from the original table\n    // When we add table linking we'll want to listen to the original table and update\n    // the copied table with any changes that occur.\n    // The table gets owned by the Figure that gets created, which closes the table\n    const tableCopy = await table.copy();\n    tableCopy.applyCustomColumns(table.customColumns);\n    tableCopy.applyFilter(table.filter);\n    tableCopy.applySort(table.sort);\n\n    return dh.plot.Figure.create(\n      new ChartUtils(dh).makeFigureSettings(settings, tableCopy)\n    );\n  }\n\n  /**\n   * Creates a model from the settings provided.\n   * Tries to create a Figure in the API with it.\n   * @param dh DH JSAPI instance\n   * @param settings The chart builder settings\n   * @param settings.isLinked Whether the newly created chart should stay linked with the original table, update when filters are updated\n   * @param settings.series The column names to use for creating the series of this chart\n   * @param settings.type Chart builder type, from ChartBuilder.types\n   * @param settings.xAxis The column name to use for the x-axis\n   * @param [settings.hiddenSeries] Array of hidden series names\n   * @param figure The figure to build the model for\n   * @param theme The theme for the figure. Defaults to ChartTheme\n   * @returns The FigureChartModel representing the figure\n   * CRA sets tsconfig to type check JS based on jsdoc comments. It isn't able to figure out FigureChartModel extends ChartModel\n   * This causes TS issues in 1 or 2 spots. Once this is TS it can be returned to just FigureChartModel\n   */\n  static async makeModel(\n    dh: DhType,\n    settings: ChartModelSettings | undefined,\n    figure: Figure,\n    theme = ChartTheme\n  ): Promise<ChartModel> {\n    return new FigureChartModel(dh, figure, settings, theme);\n  }\n}\n\nexport default ChartModelFactory;\n"],"mappings":";;OACOA,UAAU;AAAA,OACVC,gBAAgB;AAAA,OAChBC,UAAU;AAGjB,MAAMC,iBAAiB,CAAC;EACtB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAaC,qBAAqB,CAChCC,EAAU,EACVC,QAA4B,EAC5BC,KAAY,EAES;IAAA;IAAA;MAAA,IADrBC,KAAK,0EAAGN,UAAU;MAElB,IAAMO,MAAM,SAASN,iBAAiB,CAACO,sBAAsB,CAC3DL,EAAE,EACFC,QAAQ,EACRC,KAAK,CACN;MACD,OAAO,IAAIN,gBAAgB,CAACI,EAAE,EAAEI,MAAM,EAAEH,QAAQ,EAAEE,KAAK,CAAC;IAAC;EAC3D;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAaE,sBAAsB,CACjCL,EAAU,EACVC,QAA4B,EAC5BC,KAAY,EACK;IAAA;MACjB;MACA;MACA;MACA;MACA,IAAMI,SAAS,SAASJ,KAAK,CAACK,IAAI,EAAE;MACpCD,SAAS,CAACE,kBAAkB,CAACN,KAAK,CAACO,aAAa,CAAC;MACjDH,SAAS,CAACI,WAAW,CAACR,KAAK,CAACS,MAAM,CAAC;MACnCL,SAAS,CAACM,SAAS,CAACV,KAAK,CAACW,IAAI,CAAC;MAE/B,OAAOb,EAAE,CAACc,IAAI,CAACC,MAAM,CAACC,MAAM,CAC1B,IAAIrB,UAAU,CAACK,EAAE,CAAC,CAACiB,kBAAkB,CAAChB,QAAQ,EAAEK,SAAS,CAAC,CAC3D;IAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,OAAaY,SAAS,CACpBlB,EAAU,EACVC,QAAwC,EACxCG,MAAc,EAEO;IAAA;IAAA;MAAA,IADrBD,KAAK,6EAAGN,UAAU;MAElB,OAAO,IAAID,gBAAgB,CAACI,EAAE,EAAEI,MAAM,EAAEH,QAAQ,EAAEE,KAAK,CAAC;IAAC;EAC3D;AACF;AAEA,eAAeL,iBAAiB"}

package/dist/ChartUtils.d.ts

@@ -1,5 +1,5 @@
 import { Formatter } from '@deephaven/jsapi-utils';
-import { Axis, AxisPosition, AxisType, Chart, Figure, Holiday, Series, SeriesDataSource, SeriesPlotStyle, SourceType, TableTemplate, TimeZone } from '@deephaven/jsapi-shim';
+import type { Axis, AxisPosition, AxisType, Chart, dh as DhType, Figure, Holiday, Series, SeriesDataSource, SeriesPlotStyle, SourceType, TableTemplate, TimeZone } from '@deephaven/jsapi-types';
 import { Layout, PlotData, PlotType, Axis as PlotlyAxis, ErrorBar, LayoutAxis, MarkerSymbol } from 'plotly.js';
 import { Range } from '@deephaven/utils';
 import ChartTheme from './ChartTheme';
@@ -77,26 +77,6 @@ declare class ChartUtils {
     static DEFAULT_MARKER_SIZE: number;
     static MODE_MARKERS: PlotData['mode'];
     static MODE_LINES: PlotData['mode'];
-    /**
-     * Converts the Iris plot style into a plotly chart type
-     * @param plotStyle The plotStyle to use, see dh.plot.SeriesPlotStyle
-     * @param isBusinessTime If the plot is using business time for an axis
-     */
-    static getPlotlyChartType(plotStyle: SeriesPlotStyle, isBusinessTime: boolean): PlotType | undefined;
-    /**
-     * Converts the Iris plot style into a plotly chart mode
-     * @param plotStyle The plotStyle to use, see dh.plot.SeriesPlotStyle.*
-     * @param areLinesVisible Whether lines are visible or not
-     * @param areShapesVisible Whether shapes are visible or not
-     */
-    static getPlotlyChartMode(plotStyle: SeriesPlotStyle, areLinesVisible?: boolean, areShapesVisible?: boolean): PlotData['mode'] | undefined;
-    /**
-     * Get the property to set on the series data for plotly
-     * @param plotStyle The plot style of the series
-     * @param sourceType The source type for the series
-     */
-    static getPlotlyProperty(plotStyle: SeriesPlotStyle, sourceType: SourceType): string;
-    static getPlotlySeriesOrientation(series: Series): 'h' | 'v' | undefined;
     /**
      * Generate the plotly error bar data from the passed in data.
      * Iris passes in the values as absolute, plotly needs them as relative.
@@ -107,15 +87,8 @@ declare class ChartUtils {
      * @returns The error_x object required by plotly, or null if none is required
      */
     static getPlotlyErrorBars(x: number[], xLow: number[], xHigh: number[]): ErrorBar;
-    static getPlotlyDateFormat(formatter: Formatter | null, columnType: string, formatPattern: string): Partial<LayoutAxis>;
     static convertNumberPrefix(prefix: string): string;
     static getPlotlyNumberFormat(formatter: Formatter | null, columnType: string, formatPattern: string): Partial<LayoutAxis> | null;
-    /**
-     * Gets the plotly axis formatting information from the source passed in
-     * @param source The Source to get the formatter information from
-     * @param formatter The current formatter for formatting data
-     */
-    static getPlotlyAxisFormat(source: SeriesDataSource, formatter?: Formatter | null): Partial<PlotlyAxis> | null;
     /**
      * Adds tick spacing for an axis that has gapBetweenMajorTicks defined.
      *
@@ -150,14 +123,51 @@ declare class ChartUtils {
      */
     static makeSeriesData(type: PlotType | undefined, mode: PlotData['mode'] | undefined, name: string, showLegend: boolean | null, orientation?: 'h' | 'v'): Partial<PlotData>;
     /**
-     * Create a data series (trace) for use with plotly
-     * @param series The series to create the series data with
-     * @param axisTypeMap The map of axes grouped by type
-     * @param seriesVisibility Visibility setting for the series
-     * @param theme The theme properties for the plot. See ChartTheme.js for an example
-     * @returns The series data (trace) object for use with plotly.
+     * Get the Plotly marker symbol for the provided Deephaven shape
+     * Deephaven shapes: https://deephaven.io/enterprise/docs/plotting/visual-formatting/#point-formatting
+     * Plotly shapes: https://plotly.com/javascript/reference/scattergl/#scattergl-marker-symbol
+     * Table of plotly shapes: https://plotly.com/python/marker-style/#custom-marker-symbols
+     * @param deephavenShape Deephaven shape to get the marker symbol for
+     */
+    static getMarkerSymbol(deephavenShape: string): MarkerSymbol;
+    /**
+     * Get all axes for a given `Figure`. Iterates through all charts axes and concatenates them.
+     * @param figure Figure to get all axes for
+     */
+    static getAllAxes(figure: Figure): Axis[];
+    /**
+     * Retrieve the chart that contains the passed in series from the figure
+     * @param figure The figure to retrieve the chart from
+     * @param series The series to get the chart for
+     */
+    static getChartForSeries(figure: Figure, series: Series): Chart | null;
+    /**
+     * Get an object mapping axis to their ranges
+     * @param layout The plotly layout object to get the ranges from
+     * @returns An object mapping the axis name to it's range
+     */
+    static getLayoutRanges(layout: Layout): Record<string, Range[]>;
+    static getAxisLayoutProperty(axisProperty: 'x' | 'y', axisIndex: number): LayoutAxisKey;
+    /**
+     * Converts an open or close period to a declimal. e.g '09:30" to 9.5
+     *
+     * @param period the open or close value of the period
+     */
+    static periodToDecimal(period: string): number;
+    /**
+     * Groups an array and returns a map
+     * @param array The object to group
+     * @param property The property name to group by
+     * @returns A map containing the items grouped by their values for the property
+     */
+    static groupArray<T, P extends keyof T>(array: T[], property: P): Map<T[P], T[]>;
+    /**
+     * Parses the colorway property of a theme and returns an array of colors
+     * Theme could have a single string with space separated colors or an array of strings representing the colorway
+     * @param theme The theme to get colorway from
+     * @returns Colorway array for the theme
      */
-    static makeSeriesDataFromSeries(series: Series, axisTypeMap: AxisTypeMap, seriesVisibility: boolean | 'legendonly', showLegend?: boolean | null, theme?: Readonly<{
+    static getColorwayFromTheme(theme?: Readonly<{
         paper_bgcolor: string;
         plot_bgcolor: string;
         title_color: string;
@@ -174,17 +184,11 @@ declare class ChartUtils {
         error_band_fill_color: string;
         ohlc_increasing: string;
         ohlc_decreasing: string;
-    }>): Partial<PlotData>;
-    static addSourcesToSeriesData(seriesDataParam: Partial<PlotData>, plotStyle: SeriesPlotStyle, sources: SeriesDataSource[], axisTypeMap: AxisTypeMap): void;
-    static addStylingToSeriesData(seriesDataParam: Partial<PlotData>, plotStyle: SeriesPlotStyle, theme?: typeof ChartTheme, lineColor?: string | null, shapeColor?: string | null, shape?: string | null, shapeSize?: number | null, seriesVisibility?: 'legendonly' | boolean | null): void;
-    /**
-     * Get the Plotly marker symbol for the provided Deephaven shape
-     * Deephaven shapes: https://deephaven.io/enterprise/docs/plotting/visual-formatting/#point-formatting
-     * Plotly shapes: https://plotly.com/javascript/reference/scattergl/#scattergl-marker-symbol
-     * Table of plotly shapes: https://plotly.com/python/marker-style/#custom-marker-symbols
-     * @param deephavenShape Deephaven shape to get the marker symbol for
-     */
-    static getMarkerSymbol(deephavenShape: string): MarkerSymbol;
+    }>): string[];
+    static titleFromSettings(settings: ChartModelSettings): string;
+    private dh;
+    private daysOfWeek;
+    constructor(dh: DhType);
     /**
      * Retrieve the axis formats from the provided figure.
      * Currently defaults to just the x/y axes.
@@ -192,35 +196,66 @@ declare class ChartUtils {
      * @param formatter The formatter to use when getting the axis format
      * @returns A map of axis layout property names to axis formats
      */
-    static getAxisFormats(figure: Figure, formatter: Formatter): Map<LayoutAxisKey, Partial<PlotlyAxis>>;
-    static getChartType(plotStyle: SeriesPlotStyle, isBusinessTime: boolean): PlotType | undefined;
+    getAxisFormats(figure: Figure, formatter: Formatter): Map<LayoutAxisKey, Partial<PlotlyAxis>>;
     /**
-     * Return the plotly axis property name
-     * @param axisType The axis type to get the property name for
+     * Converts the Iris plot style into a plotly chart type
+     * @param plotStyle The plotStyle to use, see dh.plot.SeriesPlotStyle
+     * @param isBusinessTime If the plot is using business time for an axis
      */
-    static getAxisPropertyName(axisType: AxisType): 'x' | 'y' | null;
+    getPlotlyChartType(plotStyle: SeriesPlotStyle, isBusinessTime: boolean): PlotType | undefined;
     /**
-     * Returns the plotly "side" value for the provided axis position
-     * @param axisPosition The Iris AxisPosition of the axis
+     * Converts the Iris plot style into a plotly chart mode
+     * @param plotStyle The plotStyle to use, see dh.plot.SeriesPlotStyle.*
+     * @param areLinesVisible Whether lines are visible or not
+     * @param areShapesVisible Whether shapes are visible or not
      */
-    static getAxisSide(axisPosition: AxisPosition): LayoutAxis['side'] | undefined;
+    getPlotlyChartMode(plotStyle: SeriesPlotStyle, areLinesVisible?: boolean | null, areShapesVisible?: boolean | null): PlotData['mode'] | undefined;
     /**
-     * Get all axes for a given `Figure`. Iterates through all charts axes and concatenates them.
-     * @param figure Figure to get all axes for
+     * Get the property to set on the series data for plotly
+     * @param plotStyle The plot style of the series
+     * @param sourceType The source type for the series
      */
-    static getAllAxes(figure: Figure): Axis[];
+    getPlotlyProperty(plotStyle: SeriesPlotStyle, sourceType: SourceType): string;
+    getPlotlySeriesOrientation(series: Series): 'h' | 'v' | undefined;
     /**
-     * Retrieve the chart that contains the passed in series from the figure
-     * @param figure The figure to retrieve the chart from
-     * @param series The series to get the chart for
+     * Create a data series (trace) for use with plotly
+     * @param series The series to create the series data with
+     * @param axisTypeMap The map of axes grouped by type
+     * @param seriesVisibility Visibility setting for the series
+     * @param theme The theme properties for the plot. See ChartTheme.js for an example
+     * @returns The series data (trace) object for use with plotly.
      */
-    static getChartForSeries(figure: Figure, series: Series): Chart | null;
+    makeSeriesDataFromSeries(series: Series, axisTypeMap: AxisTypeMap, seriesVisibility: boolean | 'legendonly', showLegend?: boolean | null, theme?: Readonly<{
+        paper_bgcolor: string;
+        plot_bgcolor: string;
+        title_color: string;
+        colorway: string;
+        gridcolor: string;
+        linecolor: string;
+        zerolinecolor: string;
+        activecolor: string;
+        rangebgcolor: string;
+        area_color: string;
+        trend_color: string;
+        line_color: string;
+        error_band_line_color: string;
+        error_band_fill_color: string;
+        ohlc_increasing: string;
+        ohlc_decreasing: string;
+    }>): Partial<PlotData>;
+    addSourcesToSeriesData(seriesDataParam: Partial<PlotData>, plotStyle: SeriesPlotStyle, sources: SeriesDataSource[], axisTypeMap: AxisTypeMap): void;
+    addStylingToSeriesData(seriesDataParam: Partial<PlotData>, plotStyle: SeriesPlotStyle, theme?: typeof ChartTheme, lineColor?: string | null, shapeColor?: string | null, shape?: string | null, shapeSize?: number | null, seriesVisibility?: 'legendonly' | boolean | null): void;
+    getChartType(plotStyle: SeriesPlotStyle, isBusinessTime: boolean): PlotType | undefined;
     /**
-     * Get an object mapping axis to their ranges
-     * @param layout The plotly layout object to get the ranges from
-     * @returns An object mapping the axis name to it's range
+     * Return the plotly axis property name
+     * @param axisType The axis type to get the property name for
      */
-    static getLayoutRanges(layout: Layout): Record<string, Range[]>;
+    getAxisPropertyName(axisType: AxisType): 'x' | 'y' | null;
+    /**
+     * Returns the plotly "side" value for the provided axis position
+     * @param axisPosition The Iris AxisPosition of the axis
+     */
+    getAxisSide(axisPosition: AxisPosition): LayoutAxis['side'] | undefined;
     /**
      * Update the layout with all the axes information for the provided figure
      * @param figure Figure to update the axes for
@@ -230,7 +265,7 @@ declare class ChartUtils {
      * @param plotHeight Height of the plot in pixels
      * @param theme Theme used for displaying the plot
      */
-    static updateFigureAxes(layoutParam: Partial<Layout>, figure: Figure, chartAxisRangeParser?: ChartAxisRangeParser, plotWidth?: number, plotHeight?: number, theme?: Readonly<{
+    updateFigureAxes(layoutParam: Partial<Layout>, figure: Figure, chartAxisRangeParser?: ChartAxisRangeParser, plotWidth?: number, plotHeight?: number, theme?: Readonly<{
         paper_bgcolor: string;
         plot_bgcolor: string;
         title_color: string;
@@ -248,7 +283,14 @@ declare class ChartUtils {
         ohlc_increasing: string;
         ohlc_decreasing: string;
     }>): void;
-    static getChartBounds(figure: Figure, chart: Chart, plotWidth: number, plotHeight: number): ChartBounds;
+    getChartBounds(figure: Figure, chart: Chart, plotWidth: number, plotHeight: number): ChartBounds;
+    getPlotlyDateFormat(formatter: Formatter | null, columnType: string, formatPattern: string): Partial<LayoutAxis>;
+    /**
+     * Gets the plotly axis formatting information from the source passed in
+     * @param source The Source to get the formatter information from
+     * @param formatter The current formatter for formatting data
+     */
+    getPlotlyAxisFormat(source: SeriesDataSource, formatter?: Formatter | null): Partial<PlotlyAxis> | null;
     /**
      * Updates the axes positions and sizes in the layout object provided.
      * If the axis did not exist in the layout previously, it is created and added.
@@ -262,7 +304,7 @@ declare class ChartUtils {
      * @param bounds The bounds for this set of axes
      * @param axisRangeParser A function to retrieve the range parser for a given axis
      */
-    static updateLayoutAxes(layoutParam: Partial<Layout>, chartAxes: Axis[], figureAxes: Axis[], plotWidth?: number, plotHeight?: number, bounds?: ChartBounds, axisRangeParser?: AxisRangeParser, theme?: Readonly<{
+    updateLayoutAxes(layoutParam: Partial<Layout>, chartAxes: Axis[], figureAxes: Axis[], plotWidth?: number, plotHeight?: number, bounds?: ChartBounds, axisRangeParser?: AxisRangeParser, theme?: Readonly<{
         paper_bgcolor: string;
         plot_bgcolor: string;
         title_color: string;
@@ -285,8 +327,7 @@ declare class ChartUtils {
      * @param layoutParam Layout object to remove stale axes from
      * @param axes All axes in the figure
      */
-    static removeStaleAxes(layoutParam: Partial<Layout>, axes: Axis[]): void;
-    static getAxisLayoutProperty(axisProperty: 'x' | 'y', axisIndex: number): LayoutAxisKey;
+    removeStaleAxes(layoutParam: Partial<Layout>, axes: Axis[]): void;
     /**
      * Updates the layout axis object in place
      * @param layoutAxisParam The plotly layout axis param
@@ -296,18 +337,12 @@ declare class ChartUtils {
      * @param axisSize The size of each axis in percent
      * @param bounds The bounds of the axes domains
      */
-    static updateLayoutAxis(layoutAxisParam: Partial<LayoutAxis>, axis: Axis, axisIndex: number, axisPositionMap: AxisPositionMap, xAxisSize: number, yAxisSize: number, bounds: {
+    updateLayoutAxis(layoutAxisParam: Partial<LayoutAxis>, axis: Axis, axisIndex: number, axisPositionMap: AxisPositionMap, xAxisSize: number, yAxisSize: number, bounds: {
         left: number;
         bottom: number;
         top: number;
         right: number;
     }): void;
-    /**
-     * Converts an open or close period to a declimal. e.g '09:30" to 9.5
-     *
-     * @param period the open or close value of the period
-     */
-    static periodToDecimal(period: string): number;
     /**
      * Creates range break bounds for plotly from business days.
      * For example a standard business week of ['MONDAY','TUESDAY','WEDNESDAY','THURSDAY','FRIDAY']
@@ -316,7 +351,7 @@ declare class ChartUtils {
      *
      * @param businessDays the days to display on the x-axis
      */
-    static createBoundsFromDays(businessDays: string[]): Range[];
+    createBoundsFromDays(businessDays: string[]): Range[];
     /**
      * Creates an array of range breaks for all holidays.
      *
@@ -324,7 +359,7 @@ declare class ChartUtils {
      * @param calendarTimeZone the time zone for the business calendar
      * @param formatterTimeZone the time zone for the formatter
      */
-    static createRangeBreakValuesFromHolidays(holidays: Holiday[], calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): Rangebreaks[];
+    createRangeBreakValuesFromHolidays(holidays: Holiday[], calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): Rangebreaks[];
     /**
      * Creates the range break value for a full holiday. A full holiday is day that has no business periods.
      *
@@ -332,7 +367,7 @@ declare class ChartUtils {
      * @param calendarTimeZone the time zone for the business calendar
      * @param formatterTimeZone the time zone for the formatter
      */
-    static createFullHoliday(holiday: Holiday, calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): string;
+    createFullHoliday(holiday: Holiday, calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): string;
     /**
      * Creates the range break for a partial holiday. A partial holiday is holiday with business periods
      * that are different than the default business periods.
@@ -341,7 +376,7 @@ declare class ChartUtils {
      * @param calendarTimeZone the time zone for the business calendar
      * @param formatterTimeZone the time zone for the formatter
      */
-    static createPartialHoliday(holiday: Holiday, calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): {
+    createPartialHoliday(holiday: Holiday, calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): {
         values: string[];
         dvalue: number;
     }[];
@@ -352,27 +387,57 @@ declare class ChartUtils {
      * @param calendarTimeZone the time zone for the business calendar
      * @param formatterTimeZone the time zone for the formatter
      */
-    static adjustDateForTimeZone(dateString: string, calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): string;
+    adjustDateForTimeZone(dateString: string, calendarTimeZone: TimeZone, formatterTimeZone?: TimeZone): string;
     /**
-     * Groups an array and returns a map
-     * @param array The object to group
-     * @param property The property name to group by
-     * @returns A map containing the items grouped by their values for the property
+     * Creates the Figure settings from the Chart Builder settings
+     * This should be deprecated at some point, and have Chart Builder create the figure settings directly.
+     * This logic will still need to exist to translate existing charts, but could be part of a migration script
+     * to translate the data.
+     * Change when we decide to add more functionality to the Chart Builder.
+     * @param settings The chart builder settings
+     * @param settings.title The title for this figure
+     * @param settings.xAxis The name of the column to use for the x-axis
+     * @param settings.series The name of the columns to use for the series of this figure
+     * @param settings.type The plot style for this figure
      */
-    static groupArray<T, P extends keyof T>(array: T[], property: P): Map<T[P], T[]>;
+    makeFigureSettings(settings: ChartModelSettings, table: TableTemplate): {
+        charts: {
+            chartType: string;
+            axes: {
+                formatType: string;
+                type: string;
+                position: string;
+            }[];
+            series: {
+                plotStyle: string;
+                name: string;
+                dataSources: {
+                    type: string;
+                    columnName: string;
+                    axis: {
+                        formatType: string;
+                        type: string;
+                        position: string;
+                    };
+                    table: TableTemplate;
+                }[];
+            }[];
+        }[];
+        title: string;
+    };
     /**
      * Unwraps a value provided from API to a value plotly can understand
      * Eg. Unwraps DateWrapper, LongWrapper objects.
      */
-    static unwrapValue(value: unknown, timeZone?: TimeZone): unknown;
+    unwrapValue(value: unknown, timeZone?: TimeZone): unknown;
     /**
      *
      * @param value The value to wrap up
      * @param columnType The type of column this value is from
      * @param timeZone The time zone if applicable
      */
-    static wrapValue(value: unknown, columnType: string, timeZone?: TimeZone | null): unknown;
-    static makeLayoutAxis(type: AxisType, theme?: Readonly<{
+    wrapValue(value: unknown, columnType: string, timeZone?: TimeZone | null): unknown;
+    makeLayoutAxis(type: AxisType, theme?: Readonly<{
         paper_bgcolor: string;
         plot_bgcolor: string;
         title_color: string;
@@ -390,31 +455,7 @@ declare class ChartUtils {
         ohlc_increasing: string;
         ohlc_decreasing: string;
     }>): Partial<LayoutAxis>;
-    /**
-     * Parses the colorway property of a theme and returns an array of colors
-     * Theme could have a single string with space separated colors or an array of strings representing the colorway
-     * @param theme The theme to get colorway from
-     * @returns Colorway array for the theme
-     */
-    static getColorwayFromTheme(theme?: Readonly<{
-        paper_bgcolor: string;
-        plot_bgcolor: string;
-        title_color: string;
-        colorway: string;
-        gridcolor: string;
-        linecolor: string;
-        zerolinecolor: string;
-        activecolor: string;
-        rangebgcolor: string;
-        area_color: string;
-        trend_color: string;
-        line_color: string;
-        error_band_line_color: string;
-        error_band_fill_color: string;
-        ohlc_increasing: string;
-        ohlc_decreasing: string;
-    }>): string[];
-    static makeDefaultLayout(theme?: Readonly<{
+    makeDefaultLayout(theme?: Readonly<{
         paper_bgcolor: string;
         plot_bgcolor: string;
         title_color: string;
@@ -436,47 +477,9 @@ declare class ChartUtils {
      * Hydrate settings from a JSONable object
      * @param settings Dehydrated settings
      */
-    static hydrateSettings(settings: ChartModelSettings): Omit<ChartModelSettings, 'type'> & {
+    hydrateSettings(settings: ChartModelSettings): Omit<ChartModelSettings, 'type'> & {
         type?: SeriesPlotStyle;
     };
-    static titleFromSettings(settings: ChartModelSettings): string;
-    /**
-     * Creates the Figure settings from the Chart Builder settings
-     * This should be deprecated at some point, and have Chart Builder create the figure settings directly.
-     * This logic will still need to exist to translate existing charts, but could be part of a migration script
-     * to translate the data.
-     * Change when we decide to add more functionality to the Chart Builder.
-     * @param settings The chart builder settings
-     * @param settings.title The title for this figure
-     * @param settings.xAxis The name of the column to use for the x-axis
-     * @param settings.series The name of the columns to use for the series of this figure
-     * @param settings.type The plot style for this figure
-     */
-    static makeFigureSettings(settings: ChartModelSettings, table: TableTemplate): {
-        charts: {
-            chartType: string;
-            axes: {
-                formatType: string;
-                type: string;
-                position: string;
-            }[];
-            series: {
-                plotStyle: string;
-                name: string;
-                dataSources: {
-                    type: string;
-                    columnName: string;
-                    axis: {
-                        formatType: string;
-                        type: string;
-                        position: string;
-                    };
-                    table: TableTemplate;
-                }[];
-            }[];
-        }[];
-        title: string;
-    };
 }
 export default ChartUtils;
 //# sourceMappingURL=ChartUtils.d.ts.map