@deephaven/js-plugin-pivot 0.0.3-dev.984 → 0.1.0

package/dist/index.js

@@ -9920,10 +9920,10 @@ _defineProperty(GridRenderer, "getCachedColorWithAlpha", memoizeClear$1(GridColo
 _defineProperty(GridRenderer, "getCachedColorIsDark", memoizeClear$1(ColorUtils$1.isDark, {
   max: 1e3
 }));
-function isExpandableColumnHeaderGroup(group) {
-  return group instanceof ExpandableColumnHeaderGroup;
+function isPivotColumnHeaderGroup(group) {
+  return group instanceof PivotColumnHeaderGroup;
 }
-class ExpandableColumnHeaderGroup extends irisGrid.ColumnHeaderGroup {
+class PivotColumnHeaderGroup extends irisGrid.ColumnHeaderGroup {
   constructor({
     name,
     displayName,
@@ -10022,10 +10022,10 @@ function makeGrandTotalColumnName(valueSource) {
   return `__GRAND_TOTAL/${valueSource.name}`;
 }
 function makeColumnName(keys2, depth) {
-  return keys2.slice(0, depth + 1).filter((k) => k != null).join("/");
+  return keys2.slice(0, depth + 1).filter((k) => k != null).map((k) => encodeURIComponent(String(k))).join("/");
 }
 function makeColumnGroupName(keys2, columnSources, depth) {
-  return keys2.slice(0, depth + 1).map((k, i) => k == null ? columnSources[i].name : k).join("/");
+  return keys2.slice(0, depth + 1).map((k, i) => k == null ? columnSources[i].name : k).map((k) => encodeURIComponent(String(k))).join("/");
 }
 function makeValueSourceColumnName(columnName, valueSource) {
   return `${columnName}/${valueSource.name}`;
@@ -10072,11 +10072,11 @@ function checkColumnsChanged(prevColumns, newColumns) {
 }
 function getKeyColumnGroups(columnSources, rowSources) {
   const groups = columnSources.length === 0 ? [
-    new ExpandableColumnHeaderGroup({
-      // TODO:
-      name: "__All",
+    new PivotColumnHeaderGroup({
+      name: "/",
       displayName: "",
-      // TODO: what if rowSources is empty?
+      // For empty row sources we will render a "dead column"
+      // or a Groups column, depending on the table settings
       children: rowSources.map((c) => c.name),
       childIndexes: [],
       isKeyColumnGroup: true,
@@ -10084,7 +10084,7 @@ function getKeyColumnGroups(columnSources, rowSources) {
       isExpandable: false
     })
   ] : columnSources.map(
-    (source, i) => new ExpandableColumnHeaderGroup({
+    (source, i) => new PivotColumnHeaderGroup({
       name: source.name,
       displayName: source.name,
       children: i === columnSources.length - 1 ? rowSources.map((c) => c.name) : [columnSources[i + 1].name],
@@ -10102,20 +10102,15 @@ function getKeyColumnGroups(columnSources, rowSources) {
 function getTotalsColumnGroups(columnSources, valueSources, isRootColumnExpanded) {
   const groupName = pluralize(valueSources.length, GRAND_TOTALS_GROUP_NAME);
   return columnSources.length === 0 ? [
-    new ExpandableColumnHeaderGroup({
-      // TODO:
-      name: "TMP__GrandTotals",
+    new PivotColumnHeaderGroup({
+      name: "/GrandTotals",
       displayName: groupName,
       children: valueSources.map((v) => makeGrandTotalColumnName(v)),
       childIndexes: [],
       depth: 1
-      // Only the top level is expandable
-      // TODO:
-      // isExpandable: i === 0,
-      // isExpanded: isRootColumnExpanded,
     })
   ] : columnSources.map(
-    (source, i) => new ExpandableColumnHeaderGroup({
+    (source, i) => new PivotColumnHeaderGroup({
       name: makeGrandTotalColumnName(source),
       displayName: i === 0 ? groupName : "",
       children: i === columnSources.length - 1 ? valueSources.map((v) => makeGrandTotalColumnName(v)) : [makeGrandTotalColumnName(columnSources[i + 1])],
@@ -10141,7 +10136,7 @@ function getSnapshotColumnGroups(snapshotColumns, columnSources, valueSources, f
       const isTotalGroup = keys2[i] == null;
       const parentKey = i > 0 ? keys2[i - 1] : null;
       const totalsGroupDisplayName = parentKey == null ? "" : groupName;
-      const group = groupMap.get(name) ?? new ExpandableColumnHeaderGroup({
+      const group = groupMap.get(name) ?? new PivotColumnHeaderGroup({
         name,
         displayName: isTotalGroup ? totalsGroupDisplayName : keys2[i],
         isTotalGroup,
@@ -10189,6 +10184,9 @@ const SET_VIEWPORT_THROTTLE = 150;
 const APPLY_VIEWPORT_THROTTLE = 0;
 const ROW_BUFFER_PAGES = 1;
 const COLUMN_BUFFER_PAGES = 1;
+function isIrisGridPivotModel(model) {
+  return typeof model === "object" && model !== null && "pivotTable" in model && "keyColumns" in model && "expandAll" in model && "collapseAll" in model && "hasExpandableRows" in model && "hasExpandableColumns" in model;
+}
 class IrisGridPivotModel extends irisGrid.IrisGridModel {
   constructor(dh, pivotTable, formatter = new jsapiUtils.Formatter(dh), config = {}) {
     if (!isCorePlusDh(dh)) {
@@ -10484,27 +10482,6 @@ class IrisGridPivotModel extends irisGrid.IrisGridModel {
   async export() {
     throw new Error("Method not implemented.");
   }
-  async showFilter() {
-    throw new Error("Method not implemented.");
-  }
-  async quickFilter() {
-    throw new Error("Method not implemented.");
-  }
-  async autoResizeColumns() {
-    throw new Error("Method not implemented.");
-  }
-  async applySort() {
-    throw new Error("Method not implemented.");
-  }
-  async clearFilter() {
-    throw new Error("Method not implemented.");
-  }
-  async applyFilter() {
-    throw new Error("Method not implemented.");
-  }
-  async copy() {
-    throw new Error("Method not implemented.");
-  }
   get totalsColumns() {
     return this.getCachedTotalsColumns(
       this.pivotTable,
@@ -10554,7 +10531,7 @@ class IrisGridPivotModel extends irisGrid.IrisGridModel {
     } = irisGrid.IrisGridUtils.parseColumnHeaderGroups(
       this,
       groups,
-      (args) => new ExpandableColumnHeaderGroup(args)
+      (args) => new PivotColumnHeaderGroup(args)
     );
     this._columnHeaderGroups = newGroups;
     this.columnHeaderMaxDepth = maxDepth;
@@ -10569,14 +10546,14 @@ class IrisGridPivotModel extends irisGrid.IrisGridModel {
   }
   textForColumnHeader(x, depth = 0) {
     const header = this.columnAtDepth(x, depth);
-    if (isExpandableColumnHeaderGroup(header)) {
+    if (isPivotColumnHeaderGroup(header)) {
       return header.isNew ? "" : header.displayName ?? header.name;
     }
     return (header == null ? void 0 : header.displayName) ?? (header == null ? void 0 : header.name);
   }
   colorForColumnHeader(x, depth = 0, theme = {}) {
     const column = this.columnAtDepth(x, depth);
-    if (isExpandableColumnHeaderGroup(column)) {
+    if (isPivotColumnHeaderGroup(column)) {
       if (column.isTotalGroup != null && column.isTotalGroup) {
         return theme.totalsHeaderBackground ?? null;
       }
@@ -10588,7 +10565,7 @@ class IrisGridPivotModel extends irisGrid.IrisGridModel {
   }
   getColumnHeaderGroup(modelIndex, depth) {
     const group = this.columnAtDepth(modelIndex, depth);
-    if (isExpandableColumnHeaderGroup(group)) {
+    if (isPivotColumnHeaderGroup(group)) {
       return group;
     }
     return void 0;
@@ -11233,6 +11210,26 @@ class PivotColumnGroupMouseHandler extends GridMouseHandler {
     }
     return null;
   }
+  setCursor(gridPoint, grid) {
+    const { column, columnHeaderDepth } = gridPoint;
+    if (this.isExpandableColumnGroup(column, columnHeaderDepth)) {
+      this.cursor = "pointer";
+      return { stopPropagation: false, preventDefault: false };
+    }
+    this.cursor = null;
+    return false;
+  }
+  isExpandableColumnGroup(column, columnHeaderDepth = 0) {
+    const { model } = this.irisGrid.props;
+    if (column == null || model == null) {
+      return false;
+    }
+    const group = model.getColumnHeaderGroup(column, columnHeaderDepth);
+    return group != null && isPivotColumnHeaderGroup(group) && group.isExpandable;
+  }
+  onMove(gridPoint, grid) {
+    return this.setCursor(gridPoint, grid);
+  }
   // We need to remember where the down started, because the canvas element will trigger a click wherever mouseUp is
   onDown(gridPoint) {
     this.column = this.getColumnGroupFromGridPoint(gridPoint);
@@ -11240,7 +11237,7 @@ class PivotColumnGroupMouseHandler extends GridMouseHandler {
   }
   onClick(gridPoint, grid, event) {
     const column = this.getColumnGroupFromGridPoint(gridPoint);
-    if (column != null && column === this.column) {
+    if (column != null && column === this.column && this.isExpandableColumnGroup(column, gridPoint.columnHeaderDepth)) {
       this.irisGrid.toggleExpandColumn(column);
       return true;
     }
@@ -11399,6 +11396,9 @@ class IrisGridPivotRenderer extends irisGrid.IrisGridRenderer {
   }
   drawColumnHeadersAtDepth(context, state, range, bounds, depth) {
     const { metrics, model, theme } = state;
+    if (!isIrisGridPivotModel(model)) {
+      throw new Error("Unsupported model type");
+    }
     const {
       modelColumns,
       allColumnXs,
@@ -11432,10 +11432,14 @@ class IrisGridPivotRenderer extends irisGrid.IrisGridRenderer {
       while (columnIndex <= endIndex) {
         const { columnCount } = metrics;
         const modelColumn = getOrThrow(modelColumns, columnIndex);
-        const columnGroupColor = isExpandableColumnGridModel(model) ? model.colorForColumnHeader(modelColumn, depth, theme) : model.colorForColumnHeader(modelColumn, depth);
+        const columnGroupColor = model.colorForColumnHeader(
+          modelColumn,
+          depth,
+          theme
+        );
         const headerGroup = model.getColumnHeaderGroup(modelColumn, depth ?? 0);
-        const isExpandable = isExpandableColumnHeaderGroup(headerGroup) && headerGroup.isExpandable;
-        const isExpanded = isExpandableColumnHeaderGroup(headerGroup) && headerGroup.isExpanded;
+        const isExpandable = isPivotColumnHeaderGroup(headerGroup) && headerGroup.isExpandable;
+        const isExpanded = isPivotColumnHeaderGroup(headerGroup) && headerGroup.isExpanded;
         const columnGroupName = getColumnGroupName(model, modelColumn, depth);
         let columnGroupLeft = getOrThrow(allColumnXs, columnIndex) + gridX;
         let columnGroupRight = columnGroupLeft + getOrThrow(allColumnWidths, columnIndex);
@@ -11686,7 +11690,7 @@ function useHydratePivotGrid(fetch, id, metadata) {
   const loadPlugin = dashboardCorePlugins.useLoadTablePlugin();
   const fetchTable = React.useCallback(
     () => fetch().then((result) => {
-      log$1.debug("pivotWidget fetch result:", result);
+      log$1.debug("Pivot fetch result:", result);
       if (!isCorePlusDh(api)) {
         throw new Error("CorePlus is not available");
       }
@@ -11716,34 +11720,36 @@ function useHydratePivotGrid(fetch, id, metadata) {
       },
       metadata,
       mouseHandlers,
-      renderer,
-      theme: pivotTheme
+      renderer
     }),
-    [
-      api,
-      fetchTable,
-      id,
-      loadPlugin,
-      metadata,
-      mouseHandlers,
-      renderer,
-      pivotTheme
-    ]
+    [api, fetchTable, id, loadPlugin, metadata, mouseHandlers, renderer]
   );
-  return hydratedProps;
-}
-function PivotPanel(props) {
-  const { localDashboardId, fetch, metadata } = props;
-  const hydratedProps = useHydratePivotGrid(fetch, localDashboardId, metadata);
-  return /* @__PURE__ */ jsxRuntimeExports.jsx(
-    dashboardCorePlugins.IrisGridPanel,
-    {
-      ...props,
-      ...hydratedProps
-    }
+  const hydratedPropsWithTheme = React.useMemo(
+    () => ({ ...hydratedProps, theme: pivotTheme }),
+    [hydratedProps, pivotTheme]
   );
+  return hydratedPropsWithTheme;
 }
-PivotPanel.COMPONENT = "PivotPanel";
+const PivotPanel = React.forwardRef(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  (props, ref) => {
+    const { localDashboardId, fetch, metadata } = props;
+    const hydratedProps = useHydratePivotGrid(
+      fetch,
+      localDashboardId,
+      metadata
+    );
+    return /* @__PURE__ */ jsxRuntimeExports.jsx(
+      dashboardCorePlugins.IrisGridPanel,
+      {
+        ref,
+        ...props,
+        ...hydratedProps
+      }
+    );
+  }
+);
+PivotPanel.displayName = "PivotPanel";
 const PivotPlugin = {
   name: "@deephaven/js-plugin-pivot",
   type: plugin.PluginType.WIDGET_PLUGIN,
@@ -11784,7 +11790,7 @@ function DashboardPlugin({
       log.info("Panel opened of type", type);
       const config = {
         type: "react-component",
-        component: PivotPanel.COMPONENT,
+        component: PivotPanel.displayName,
         props: {
           localDashboardId: id,
           id: panelId,
@@ -11803,7 +11809,8 @@ function DashboardPlugin({
     [id, layout]
   );
   React.useEffect(() => {
-    const cleanups = [registerComponent(PivotPanel.COMPONENT, PivotPanel)];
+    assertNotNull(PivotPanel.displayName);
+    const cleanups = [registerComponent(PivotPanel.displayName, PivotPanel)];
     return () => {
       cleanups.forEach((cleanup) => cleanup());
     };

package/package.json

@@ -1,14 +1,20 @@
 {
   "name": "@deephaven/js-plugin-pivot",
-  "version": "0.0.3-dev.984+0d63a3d6",
+  "version": "0.1.0",
   "description": "Pivot plugin for Deephaven",
   "keywords": [
     "Deephaven",
-    "plugin"
+    "plugin",
+    "deephaven-js-plugin",
+    "pivot"
   ],
-  "author": "Deephaven Data Labs",
+  "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
   "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/deephaven/deephaven-plugins"
+  },
   "scripts": {
     "start": "vite build --watch",
     "build": "vite build"
@@ -48,11 +54,10 @@
     "nanoid": "^5.1.5"
   },
   "publishConfig": {
-    "access": "public",
-    "provenance": false
+    "access": "public"
   },
   "files": [
     "dist/index.js"
   ],
-  "gitHead": "0d63a3d64a19349448965fc689a3b0e4511fb7b2"
+  "gitHead": "457bb8bac2d812477ce1907e642b310c854a4e7e"
 }