@deephaven/iris-grid 0.24.1-beta.3 → 0.25.0

package/dist/IrisGridUtils.js

@@ -13,6 +13,7 @@ import { assertNotNull } from '@deephaven/utils';
 import AggregationUtils from "./sidebar/aggregations/AggregationUtils.js";
 import AggregationOperation from "./sidebar/aggregations/AggregationOperation.js";
 import AdvancedSettings from "./sidebar/AdvancedSettings.js";
+import ColumnHeaderGroup from "./ColumnHeaderGroup.js";
 var log = Log.module('IrisGridUtils');
 /**
  * Checks if an index is valid for the given array
@@ -138,7 +139,8 @@ class IrisGridUtils {
       sorts,
       invertSearchColumns,
       pendingDataMap = new Map(),
-      frozenColumns
+      frozenColumns,
+      columnHeaderGroups
     } = irisGridState;
     assertNotNull(metrics);
     var {
@@ -173,7 +175,12 @@ class IrisGridUtils {
       selectedSearchColumns,
       invertSearchColumns,
       pendingDataMap: IrisGridUtils.dehydratePendingDataMap(columns, pendingDataMap),
-      frozenColumns
+      frozenColumns,
+      columnHeaderGroups: columnHeaderGroups === null || columnHeaderGroups === void 0 ? void 0 : columnHeaderGroups.map(item => ({
+        name: item.name,
+        children: item.children,
+        color: item.color
+      }))
     };
   }
 
@@ -183,6 +190,7 @@ class IrisGridUtils {
    * @param irisGridState The saved IrisGrid state
    */
   static hydrateIrisGridState(model, irisGridState) {
+    var _ref11, _model$layoutHints;
     var {
       advancedFilters,
       aggregationSettings = {
@@ -205,7 +213,8 @@ class IrisGridUtils {
       selectedSearchColumns,
       invertSearchColumns = true,
       pendingDataMap = [],
-      frozenColumns
+      frozenColumns,
+      columnHeaderGroups
     } = irisGridState;
     var {
       columns,
@@ -244,7 +253,8 @@ class IrisGridUtils {
       selectedSearchColumns,
       invertSearchColumns,
       pendingDataMap: IrisGridUtils.hydratePendingDataMap(columns, pendingDataMap),
-      frozenColumns
+      frozenColumns,
+      columnHeaderGroups: IrisGridUtils.parseColumnHeaderGroups(model, (_ref11 = columnHeaderGroups !== null && columnHeaderGroups !== void 0 ? columnHeaderGroups : (_model$layoutHints = model.layoutHints) === null || _model$layoutHints === void 0 ? void 0 : _model$layoutHints.columnGroups) !== null && _ref11 !== void 0 ? _ref11 : []).groups
     };
   }
 
@@ -299,8 +309,8 @@ class IrisGridUtils {
    * @returns The dehydrated quick filters
    */
   static dehydrateQuickFilters(quickFilters) {
-    return [...quickFilters].map(_ref11 => {
-      var [columnIndex, quickFilter] = _ref11;
+    return [...quickFilters].map(_ref12 => {
+      var [columnIndex, quickFilter] = _ref12;
       var {
         text
       } = quickFilter;
@@ -318,8 +328,8 @@ class IrisGridUtils {
    * @returns The quick filters to apply to the columns
    */
   static hydrateQuickFilters(columns, savedQuickFilters, timeZone) {
-    var importedFilters = savedQuickFilters.map(_ref12 => {
-      var [columnIndex, quickFilter] = _ref12;
+    var importedFilters = savedQuickFilters.map(_ref13 => {
+      var [columnIndex, quickFilter] = _ref13;
       var {
         text
       } = quickFilter;
@@ -347,8 +357,8 @@ class IrisGridUtils {
    * @returns The dehydrated advanced filters
    */
   static dehydrateAdvancedFilters(columns, advancedFilters) {
-    return [...advancedFilters].map(_ref13 => {
-      var [columnIndex, advancedFilter] = _ref13;
+    return [...advancedFilters].map(_ref14 => {
+      var [columnIndex, advancedFilter] = _ref14;
       var column = IrisGridUtils.getColumn(columns, columnIndex);
       assertNotNull(column);
       var options = IrisGridUtils.dehydrateAdvancedFilterOptions(column, advancedFilter.options);
@@ -366,8 +376,8 @@ class IrisGridUtils {
    * @returns The advanced filters to apply to the columns
    */
   static hydrateAdvancedFilters(columns, savedAdvancedFilters, timeZone) {
-    var importedFilters = savedAdvancedFilters.map(_ref14 => {
-      var [columnIndex, advancedFilter] = _ref14;
+    var importedFilters = savedAdvancedFilters.map(_ref15 => {
+      var [columnIndex, advancedFilter] = _ref15;
       var column = IrisGridUtils.getColumn(columns, columnIndex);
       assertNotNull(column);
       var options = IrisGridUtils.hydrateAdvancedFilterOptions(column, advancedFilter.options);
@@ -406,13 +416,13 @@ class IrisGridUtils {
     }, otherOptions);
   }
   static dehydratePendingDataMap(columns, pendingDataMap) {
-    return [...pendingDataMap].map(_ref15 => {
+    return [...pendingDataMap].map(_ref16 => {
       var [rowIndex, {
         data
-      }] = _ref15;
+      }] = _ref16;
       return [rowIndex, {
-        data: [...data].map(_ref16 => {
-          var [c, value] = _ref16;
+        data: [...data].map(_ref17 => {
+          var [c, value] = _ref17;
           return [columns[c].name, IrisGridUtils.dehydrateValue(value, columns[c].type)];
         })
       }];
@@ -422,23 +432,23 @@ class IrisGridUtils {
     var columnMap = new Map();
     var getColumnIndex = columnName => {
       if (!columnMap.has(columnName)) {
-        columnMap.set(columnName, columns.findIndex(_ref17 => {
+        columnMap.set(columnName, columns.findIndex(_ref18 => {
           var {
             name
-          } = _ref17;
+          } = _ref18;
           return name === columnName;
         }));
       }
       return columnMap.get(columnName);
     };
-    return new Map(pendingDataMap.map(_ref18 => {
+    return new Map(pendingDataMap.map(_ref19 => {
       var [rowIndex, {
         data
-      }] = _ref18;
+      }] = _ref19;
       return [rowIndex, {
-        data: new Map(data.map(_ref19 => {
+        data: new Map(data.map(_ref20 => {
           var _getColumnIndex;
-          var [columnName, value] = _ref19;
+          var [columnName, value] = _ref20;
           var index = getColumnIndex(columnName);
           assertNotNull(index);
           return [(_getColumnIndex = getColumnIndex(columnName)) !== null && _getColumnIndex !== void 0 ? _getColumnIndex : null, IrisGridUtils.hydrateValue(value, columns[index].type)];
@@ -617,16 +627,16 @@ class IrisGridUtils {
   }
   static getInputFiltersForColumns(columns) {
     var inputFilters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-    return inputFilters.filter(_ref20 => {
+    return inputFilters.filter(_ref21 => {
       var {
         name,
         type
-      } = _ref20;
-      return columns.find(_ref21 => {
+      } = _ref21;
+      return columns.find(_ref22 => {
         var {
           name: columnName,
           type: columnType
-        } = _ref21;
+        } = _ref22;
         return columnName === name && columnType === type;
       });
     });
@@ -634,17 +644,17 @@ class IrisGridUtils {
   static getFiltersFromInputFilters(columns) {
     var inputFilters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
     var timeZone = arguments.length > 2 ? arguments[2] : undefined;
-    return inputFilters.map(_ref22 => {
+    return inputFilters.map(_ref23 => {
       var {
         name,
         type,
         value
-      } = _ref22;
-      var column = columns.find(_ref23 => {
+      } = _ref23;
+      var column = columns.find(_ref24 => {
         var {
           name: columnName,
           type: columnType
-        } = _ref23;
+        } = _ref24;
         return columnName === name && columnType === type;
       });
       if (column) {
@@ -677,11 +687,11 @@ class IrisGridUtils {
    * @returns Array of hidden column indexes
    */
   static getHiddenColumns(userColumnWidths) {
-    return [...userColumnWidths.entries()].filter(_ref24 => {
-      var [, value] = _ref24;
+    return [...userColumnWidths.entries()].filter(_ref25 => {
+      var [, value] = _ref25;
       return value === 0;
-    }).map(_ref25 => {
-      var [key] = _ref25;
+    }).map(_ref26 => {
+      var [key] = _ref26;
       return key;
     });
   }
@@ -697,10 +707,10 @@ class IrisGridUtils {
     return sorts.filter(sort => !columnNames.includes(sort.column.name));
   }
   static removeFiltersInColumns(columns, filters, removedColumnNames) {
-    var columnNames = columns.map(_ref26 => {
+    var columnNames = columns.map(_ref27 => {
       var {
         name
-      } = _ref26;
+      } = _ref27;
       return name;
     });
     var newFilter = new Map(filters);
@@ -708,10 +718,10 @@ class IrisGridUtils {
     return newFilter;
   }
   static removeColumnFromMovedColumns(columns, movedColumns, removedColumnNames) {
-    var columnNames = columns.map(_ref27 => {
+    var columnNames = columns.map(_ref28 => {
       var {
         name
-      } = _ref27;
+      } = _ref28;
       return name;
     });
     var newMoves = [...movedColumns];
@@ -799,10 +809,10 @@ class IrisGridUtils {
   static getColumnsToFetch(tableColumns, viewportColumns, alwaysFetchColumnNames) {
     var columnsToFetch = [...viewportColumns];
     alwaysFetchColumnNames.forEach(columnName => {
-      var column = tableColumns.find(_ref28 => {
+      var column = tableColumns.find(_ref29 => {
         var {
           name
-        } = _ref28;
+        } = _ref29;
         return name === columnName;
       });
       if (column != null && !viewportColumns.includes(column)) {
@@ -970,12 +980,12 @@ class IrisGridUtils {
     var {
       aggregations = []
     } = aggregationSettings !== null && aggregationSettings !== void 0 ? aggregationSettings : {};
-    var aggregationColumns = aggregations.map(_ref29 => {
+    var aggregationColumns = aggregations.map(_ref30 => {
       var {
         operation,
         selected,
         invert
-      } = _ref29;
+      } = _ref30;
       return AggregationUtils.isRollupOperation(operation) ? [] : AggregationUtils.getOperationColumnNames(originalColumns, operation, selected, invert);
     });
     var aggregationMap = {};
@@ -1043,17 +1053,17 @@ class IrisGridUtils {
    * @param  columnName The column name to retrieve
    */
   static getColumnByName(columns, columnName) {
-    var column = columns.find(_ref30 => {
+    var column = columns.find(_ref31 => {
       var {
         name
-      } = _ref30;
+      } = _ref31;
       return name === columnName;
     });
     if (column == null) {
-      log.error('Unable to retrieve column by name', columnName, columns.map(_ref31 => {
+      log.error('Unable to retrieve column by name', columnName, columns.map(_ref32 => {
         var {
           name
-        } = _ref31;
+        } = _ref32;
         return name;
       }));
     }
@@ -1067,11 +1077,11 @@ class IrisGridUtils {
    * @returns Updated filter configs with column names changed to indexes
    */
   static changeFilterColumnNamesToIndexes(columns, filters) {
-    return filters.map(_ref32 => {
+    return filters.map(_ref33 => {
       var {
         name,
         filter
-      } = _ref32;
+      } = _ref33;
       var index = columns.findIndex(column => column.name === name);
       return index < 0 ? null : [index, filter];
     }).filter(filterConfig => filterConfig != null);
@@ -1128,6 +1138,99 @@ class IrisGridUtils {
     }
     return combinedText;
   }
+
+  /**
+   * Parses the column header groups provided.
+   * If undefined, should provide default groups such as from layoutHints
+   *
+   * @returns Object containing groups array, max depth, map of name to parent group, and map of name to group
+   */
+  static parseColumnHeaderGroups(model, groupsParam) {
+    var maxDepth = 1;
+    var parentMap = new Map();
+    var groupMap = new Map();
+
+    // Remove any empty groups before parsing
+    var groups = groupsParam === null || groupsParam === void 0 ? void 0 : groupsParam.filter(_ref34 => {
+      var {
+        children
+      } = _ref34;
+      return children.length > 0;
+    });
+    if (groups.length === 0) {
+      return {
+        groups: [],
+        maxDepth,
+        parentMap,
+        groupMap
+      };
+    }
+    var originalGroupMap = new Map(groups.map(group => [group.name, group]));
+    var seenChildren = new Set();
+    var addGroup = group => {
+      var {
+        name
+      } = group;
+      if (model.getColumnIndexByName(name) != null) {
+        throw new Error("Column header group has same name as column: ".concat(name));
+      }
+      var existingGroup = groupMap.get(name);
+      if (existingGroup) {
+        return existingGroup;
+      }
+      var childIndexes = [];
+      var depth = 1;
+      group.children.forEach(childName => {
+        if (seenChildren.has(childName)) {
+          throw new Error("Column group child ".concat(childName, " specified in multiple groups"));
+        }
+        seenChildren.add(childName);
+        var childGroup = originalGroupMap.get(childName);
+        var childIndex = model.getColumnIndexByName(childName);
+        if (childGroup) {
+          // Adding another column header group
+          var addedGroup = addGroup(childGroup);
+          childIndexes.push(...addedGroup.childIndexes);
+          depth = Math.max(depth, addedGroup.depth + 1);
+        } else if (childIndex != null) {
+          // Adding a base column
+          childIndexes.push(childIndex);
+          depth = Math.max(depth, 1);
+        } else {
+          throw new Error("Unknown child ".concat(childName, " in group ").concat(name));
+        }
+      });
+      var columnHeaderGroup = new ColumnHeaderGroup(_objectSpread(_objectSpread({}, group), {}, {
+        depth,
+        childIndexes: childIndexes.flat()
+      }));
+      groupMap.set(name, columnHeaderGroup);
+      group.children.forEach(childName => parentMap.set(childName, columnHeaderGroup));
+      maxDepth = Math.max(maxDepth, columnHeaderGroup.depth + 1);
+      return columnHeaderGroup;
+    };
+    var groupNames = new Set();
+    groups.forEach(group => {
+      var {
+        name
+      } = group;
+      if (groupNames.has(name)) {
+        throw new Error("Duplicate column group name: ".concat(name));
+      }
+      groupNames.add(name);
+      addGroup(group);
+    });
+    groupMap.forEach(group => {
+      var _parentMap$get;
+      group.setParent((_parentMap$get = parentMap.get(group.name)) === null || _parentMap$get === void 0 ? void 0 : _parentMap$get.name);
+    });
+    return {
+      groups: [...groupMap.values()],
+      maxDepth,
+      groupMap,
+      parentMap
+    };
+  }
 }
 export default IrisGridUtils;
 //# sourceMappingURL=IrisGridUtils.js.map