@deephaven/js-plugin-plotly-express 0.15.0 → 0.16.0

package/dist/PlotlyExpressChartPanel.js

@@ -0,0 +1,36 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useCallback, useState } from 'react';
+import Plotly from 'plotly.js-dist-min';
+import { ChartPanel } from '@deephaven/dashboard-core-plugins';
+import { useApi } from '@deephaven/jsapi-bootstrap';
+import PlotlyExpressChartModel from './PlotlyExpressChartModel.js';
+import { useHandleSceneTicks } from './useHandleSceneTicks.js';
+export function PlotlyExpressChartPanel(props) {
+    const dh = useApi();
+    const { fetch, metadata = {} } = props, rest = __rest(props, ["fetch", "metadata"]);
+    const [container, setContainer] = useState(null);
+    const [model, setModel] = useState();
+    const makeModel = useCallback(async () => {
+        const widgetData = await fetch();
+        const m = new PlotlyExpressChartModel(dh, widgetData, fetch);
+        setModel(m);
+        return m;
+    }, [dh, fetch]);
+    useHandleSceneTicks(model, container);
+    return (_jsx(ChartPanel
+    // eslint-disable-next-line react/jsx-props-no-spreading
+    , Object.assign({}, rest, { containerRef: setContainer, makeModel: makeModel, Plotly: Plotly, metadata: metadata })));
+}
+export default PlotlyExpressChartPanel;
+//# sourceMappingURL=PlotlyExpressChartPanel.js.map

package/dist/PlotlyExpressChartPanel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlotlyExpressChartPanel.js","sourceRoot":"","sources":["../src/PlotlyExpressChartPanel.tsx"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAc,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAmB,MAAM,mCAAmC,CAAC;AAGhF,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,MAAM,UAAU,uBAAuB,CACrC,KAAkC;IAElC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,EAAE,KAAc,KAAK,EAAd,IAAI,UAAK,KAAK,EAAzC,qBAAiC,CAAQ,CAAC;IAChD,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAwB,IAAI,CAAC,CAAC;IACxE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAA2B,CAAC;IAE9D,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;QACvC,MAAM,UAAU,GAAG,MAAM,KAAK,EAAE,CAAC;QACjC,MAAM,CAAC,GAAG,IAAI,uBAAuB,CAAC,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAC7D,QAAQ,CAAC,CAAC,CAAC,CAAC;QACZ,OAAO,CAAC,CAAC;IACX,CAAC,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;IAEhB,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAEtC,OAAO,CACL,KAAC,UAAU;IACT,wDAAwD;wBACnD,IAAwB,IAC7B,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAuC,IACjD,CACH,CAAC;AACJ,CAAC;AAED,eAAe,uBAAuB,CAAC"}

package/dist/PlotlyExpressChartUtils.d.ts

@@ -0,0 +1,222 @@
+import { type Data, type Delta, type LayoutAxis, type PlotlyDataLayoutConfig, type PlotNumber, type Layout } from 'plotly.js';
+import type { dh as DhType } from '@deephaven/jsapi-types';
+import { ChartUtils } from '@deephaven/chart';
+import { Formatter } from '@deephaven/jsapi-utils';
+/**
+ * A prefix for the number format to indicate it is in Java format and should be
+ *  transformed to a d3 format
+ */
+export declare const FORMAT_PREFIX = "DEEPHAVEN_JAVA_FORMAT=";
+export interface PlotlyChartWidget {
+    getDataAsBase64: () => string;
+    exportedObjects: {
+        fetch: () => Promise<DhType.Table>;
+    }[];
+    addEventListener: (type: string, fn: (event: CustomEvent<PlotlyChartWidget>) => () => void) => void;
+}
+interface DeephavenCalendarBusinessPeriod {
+    open: string;
+    close: string;
+}
+export interface PlotlyChartDeephavenData {
+    calendar?: {
+        timeZone: string;
+        businessDays: Array<string>;
+        holidays: Array<{
+            date: string;
+            businessPeriods: Array<DeephavenCalendarBusinessPeriod>;
+        }>;
+        businessPeriods: Array<DeephavenCalendarBusinessPeriod>;
+        name: string;
+    };
+    mappings: Array<{
+        table: number;
+        data_columns: Record<string, string[]>;
+    }>;
+    is_user_set_template: boolean;
+    is_user_set_color: boolean;
+}
+export interface PlotlyChartWidgetData {
+    type: string;
+    figure: {
+        deephaven: PlotlyChartDeephavenData;
+        plotly: PlotlyDataLayoutConfig;
+    };
+    revision: number;
+    new_references: number[];
+    removed_references: number[];
+}
+/** Information that is needed to update the default value format in the data
+ * The index is relative to the plotly/data/ array
+ * The path within the trace has the valueformat to update
+ * The typeFrom is a path to a variable that is mapped to a column type
+ * The options indicate if the prefix and suffix should be set
+ */
+export interface FormatUpdate {
+    index: number;
+    path: string;
+    typeFrom: string[];
+    options: Record<string, boolean>;
+}
+export declare function getWidgetData(widgetInfo: DhType.Widget): PlotlyChartWidgetData;
+export declare function getDataMappings(widgetData: PlotlyChartWidgetData): Map<number, Map<string, string[]>>;
+/**
+ * Removes the default colors from the data
+ * Data color is not removed if the user set the color specifically or the plot type sets it
+ *
+ * This only checks if the marker or line color is set to a color in the colorway.
+ * This means it is not possible to change the order of the colorway and use the same colors.
+ *
+ * @param colorway The colorway from plotly
+ * @param data The data to remove the colorway from. This will be mutated
+ */
+export declare function removeColorsFromData(colorway: string[], data: Data[]): void;
+/**
+ * Gets the path parts from a path replacement string from the widget data.
+ * The parts start with the plotly data array as the root.
+ * E.g. /plotly/data/0/x -> ['0', 'x']
+ * @param path The path from the widget data
+ * @returns The path parts within the plotly data array
+ */
+export declare function getPathParts(path: string): string[];
+/**
+ * Checks if a plotly series is a line series without markers
+ * @param data The plotly data to check
+ * @returns True if the data is a line series without markers
+ */
+export declare function isLineSeries(data: Data): boolean;
+/**
+ * Checks if a plotly axis type is automatically determined based on the data
+ * @param axis The plotly axis to check
+ * @returns True if the axis type is determined based on the data
+ */
+export declare function isAutoAxis(axis: Partial<LayoutAxis>): boolean;
+/**
+ * Checks if a plotly axis type is linear
+ * @param axis The plotly axis to check
+ * @returns True if the axis is a linear axis
+ */
+export declare function isLinearAxis(axis: Partial<LayoutAxis>): boolean;
+/**
+ * Check if 2 axis ranges are the same
+ * A null range indicates an auto range
+ * @param range1 The first axis range options
+ * @param range2 The second axis range options
+ * @returns True if the range options describe the same range
+ */
+export declare function areSameAxisRange(range1: unknown[] | null, range2: unknown[] | null): boolean;
+export interface DownsampleInfo {
+    type: 'linear';
+    /**
+     * The original table before downsampling.
+     */
+    originalTable: DhType.Table;
+    /**
+     * The x column to downsample.
+     */
+    xCol: string;
+    /**
+     * The y columns to downsample.
+     */
+    yCols: string[];
+    /**
+     * The width of the x-axis in pixels.
+     */
+    width: number;
+    /**
+     * The range of the x-axis. Null if set to autorange.
+     */
+    range: string[] | null;
+    /**
+     * If the range is a datae or number
+     */
+    rangeType: 'date' | 'number';
+}
+export declare function downsample(dh: typeof DhType, info: DownsampleInfo): Promise<DhType.Table>;
+/**
+ * Get the indexes of the replaceable WebGL traces in the data
+ * A replaceable WebGL has a type that ends with 'gl' which indicates it has a SVG equivalent
+ * @param data The data to check
+ * @returns The indexes of the WebGL traces
+ */
+export declare function getReplaceableWebGlTraceIndices(data: Data[]): Set<number>;
+/**
+ * Check if the data contains any traces that are at least partially powered by WebGL and have no SVG equivalent.
+ * @param data The data to check for WebGL traces
+ * @returns True if the data contains any unreplaceable WebGL traces
+ */
+export declare function hasUnreplaceableWebGlTraces(data: Data[]): boolean;
+/**
+ * Set traces to use WebGL if WebGL is enabled and the trace was originally WebGL
+ * or swap out WebGL for SVG if WebGL is disabled and the trace was originally WebGL
+ * @param data The plotly figure data to update
+ * @param webgl True if WebGL is enabled
+ * @param webGlTraceIndices The indexes of the traces that are originally WebGL traces
+ */
+export declare function setWebGlTraceType(data: Data[], webgl: boolean, webGlTraceIndices: Set<number>): void;
+/**
+ * Create rangebreaks from a business calendar
+ * @param formatter The formatter to use for the rangebreak calculations
+ * @param calendar The business calendar to create the rangebreaks from
+ * @param layout The layout to update with the rangebreaks
+ * @param chartUtils The chart utils to use for the rangebreaks
+ * @returns The updated layout with the rangebreaks added
+ */
+export declare function setRangebreaksFromCalendar(formatter: Formatter | null, calendar: DhType.calendar.BusinessCalendar | null, layout: Partial<Layout>, chartUtils: ChartUtils): Partial<Layout> | null;
+/**
+ * Check if the data at the selector should be replaced with a single value instead of an array
+ * @param data The data to check
+ * @param selector The selector to check
+ * @returns True if the data at the selector should be replaced with a single value
+ */
+export declare function isSingleValue(data: Data[], selector: string[]): boolean;
+/**
+ * Set the default value formats for all traces that require it
+ * @param plotlyData The plotly data to update
+ * @param defaultValueFormatSet The set of updates to make
+ * @param dataTypeMap The map of path to column type to pull the correct default format from
+ * @param formatter The formatter to use to get the default format
+ */
+export declare function setDefaultValueFormat(plotlyData: Data[], defaultValueFormatSet: Set<FormatUpdate>, dataTypeMap: Map<string, string>, formatter?: Formatter | null): void;
+/**
+ * Convert the number format to a d3 number format
+ * @param data The data to update
+ * @param valueFormat The number format to convert to a d3 format
+ * @param options Options of what to update
+ */
+export declare function convertToPlotlyNumberFormat(data: Partial<PlotNumber> | Partial<Delta>, valueFormat: string, options?: Record<string, boolean>): void;
+/**
+ * Transform the number format to a d3 number format, which is used by Plotly
+ * @param numberFormat The number format to transform
+ * @returns The d3 number format
+ */
+export declare function transformValueFormat(data: Partial<PlotNumber> | Partial<Delta>): Record<string, boolean>;
+/**
+ * Replace the number formats in the data with a d3 number format
+ * @param data The data to update
+ */
+export declare function replaceValueFormat(plotlyData: Data[]): Set<FormatUpdate>;
+/**
+ * Get the types of variables assocated with columns in the data
+ * For example, if the path /plotly/data/0/value is associated with a column of type int,
+ * the map will have the entry '0/value' -> 'int'
+ * @param deephavenData The deephaven data from the widget to get path and column name from
+ * @param tableReferenceMap The map of table index to table reference.
+ * Types are pulled from the table reference
+ * @returns A map of path to column type
+ */
+export declare function getDataTypeMap(deephavenData: PlotlyChartDeephavenData, tableReferenceMap: Map<number, DhType.Table>): Map<string, string>;
+/**
+ * Check if WebGL is supported in the current environment.
+ * Most modern browsers do support WebGL, but it's possible to disable it and it is also not available
+ * in some headless environments, which can affect e2e tests.
+ *
+ * https://github.com/microsoft/playwright/issues/13146
+ * https://bugzilla.mozilla.org/show_bug.cgi?id=1375585
+ *
+ * @returns True if WebGL is supported, false otherwise
+ */
+export declare function isWebGLSupported(): boolean;
+export declare const IS_WEBGL_SUPPORTED: boolean;
+export {};
+//# sourceMappingURL=PlotlyExpressChartUtils.d.ts.map

package/dist/PlotlyExpressChartUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlotlyExpressChartUtils.d.ts","sourceRoot":"","sources":["../src/PlotlyExpressChartUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,IAAI,EACT,KAAK,KAAK,EACV,KAAK,UAAU,EACf,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EAEf,KAAK,MAAM,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AA4BnD;;;GAGG;AACH,eAAO,MAAM,aAAa,2BAA2B,CAAC;AAEtD,MAAM,WAAW,iBAAiB;IAChC,eAAe,EAAE,MAAM,MAAM,CAAC;IAC9B,eAAe,EAAE;QAAE,KAAK,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;KAAE,EAAE,CAAC;IAC1D,gBAAgB,EAAE,CAChB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,KAAK,MAAM,IAAI,KACtD,IAAI,CAAC;CACX;AAED,UAAU,+BAA+B;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE;QACT,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,QAAQ,EAAE,KAAK,CAAC;YACd,IAAI,EAAE,MAAM,CAAC;YACb,eAAe,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;SACzD,CAAC,CAAC;QACH,eAAe,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACxD,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,QAAQ,EAAE,KAAK,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KACxC,CAAC,CAAC;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,SAAS,EAAE,wBAAwB,CAAC;QACpC,MAAM,EAAE,sBAAsB,CAAC;KAChC,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,CAAC,MAAM,GACxB,qBAAqB,CAEvB;AAED,wBAAgB,eAAe,CAC7B,UAAU,EAAE,qBAAqB,GAChC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CA0BpC;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CA+B3E;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAInD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAKhD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAE/D;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EACxB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,GACvB,OAAO,CAQT;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAC;CAC9B;AAED,wBAAgB,UAAU,CACxB,EAAE,EAAE,OAAO,MAAM,EACjB,IAAI,EAAE,cAAc,GACnB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAYvB;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,CAQzE;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAIjE;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,IAAI,EAAE,EACZ,KAAK,EAAE,OAAO,EACd,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,GAC7B,IAAI,CAWN;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,SAAS,GAAG,IAAI,EAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,gBAAgB,GAAG,IAAI,EACjD,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EACvB,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAuBxB;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAKvE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,IAAI,EAAE,EAClB,qBAAqB,EAAE,GAAG,CAAC,YAAY,CAAC,EACxC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAChC,SAAS,GAAE,SAAS,GAAG,IAAW,GACjC,IAAI,CAkCN;AAED;;;;;GAKG;AAEH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,EAC1C,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,IAAI,CAoCN;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,GACzC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAmCzB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,CAuCxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,wBAAwB,EACvC,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,GAC3C,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAoBrB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAU1C;AAED,eAAO,MAAM,kBAAkB,SAAqB,CAAC"}