@deephaven/iris-grid 0.13.3-beta.2 → 0.13.5

package/dist/IrisGridUtils.js

@@ -15,7 +15,7 @@ import { GridUtils } from '@deephaven/grid';
 import dh from '@deephaven/jsapi-shim';
 import { DateUtils, TableUtils } from '@deephaven/jsapi-utils';
 import Log from '@deephaven/log';
-import { assertNotNull } from '@deephaven/utils';
+import AdvancedSettings from "./sidebar/AdvancedSettings.js";
 import AggregationUtils from "./sidebar/aggregations/AggregationUtils.js";
 import AggregationOperation from "./sidebar/aggregations/AggregationOperation.js";
 var log = Log.module('IrisGridUtils');
@@ -23,9 +23,9 @@ var log = Log.module('IrisGridUtils');
 class IrisGridUtils {
   /**
    * Exports the state from Grid component to a JSON stringifiable object
-   * @param model The table model to export the Grid state for
-   * @param gridState The state of the Grid to export
-   * @returns An object that can be stringified and imported with {{@link hydrateGridState}}
+   * @param {IrisGridModel} model The table model to export the Grid state for
+   * @param {Object} gridState The state of the Grid to export
+   * @returns {Object} An object that can be stringified and imported with {{@link hydrateGridState}}
    */
   static dehydrateGridState(model, gridState) {
     var {
@@ -61,9 +61,9 @@ class IrisGridUtils {
   }
   /**
    * Import a state for Grid that was exported with {{@link dehydrateGridState}}
-   * @param model The table model to import the state for
-   * @param gridState The state of the panel that was saved
-   * @returns The gridState props to set on the Grid
+   * @param {IrisGridModel} model The table model to import the state for
+   * @param {Object} gridState The state of the panel that was saved
+   * @returns {Object} The gridState props to set on the Grid
    */
 
 
@@ -101,8 +101,6 @@ class IrisGridUtils {
           };
         }
 
-        if (typeof to === 'string') throw Error('string');
-        if (typeof from === 'string') throw Error('string');
         return {
           to,
           from
@@ -119,8 +117,8 @@ class IrisGridUtils {
   }
   /**
    * Exports the state from IrisGrid to a JSON stringifiable object
-   * @param model The table model to export the state for
-   * @param irisGridState The current state of the IrisGrid
+   * @param {IrisGridModel} model The table model to export the state for
+   * @param {Object} irisGridState The current state of the IrisGrid
    */
 
 
@@ -130,6 +128,7 @@ class IrisGridUtils {
         aggregations: [],
         showOnTop: false
       },
+      advancedSettings = [],
       advancedFilters,
       customColumnFormatMap,
       isFilterBarShown,
@@ -138,17 +137,16 @@ class IrisGridUtils {
       customColumns,
       conditionalFormats = [],
       reverseType,
-      rollupConfig = undefined,
+      rollupConfig = null,
       showSearchBar,
       searchValue,
-      selectDistinctColumns = [],
+      selectDistinctColumns,
       selectedSearchColumns,
       sorts,
       invertSearchColumns,
       pendingDataMap = new Map(),
       frozenColumns
     } = irisGridState;
-    assertNotNull(metrics);
     var {
       userColumnWidths,
       userRowHeights
@@ -158,11 +156,12 @@ class IrisGridUtils {
     } = model;
     return {
       advancedFilters: IrisGridUtils.dehydrateAdvancedFilters(columns, advancedFilters),
+      advancedSettings: [...advancedSettings],
       aggregationSettings,
       customColumnFormatMap: [...customColumnFormatMap],
       isFilterBarShown,
       quickFilters: IrisGridUtils.dehydrateQuickFilters(quickFilters),
-      sorts: IrisGridUtils.dehydrateSort(sorts),
+      sorts: IrisGridUtils.dehydrateSort(sorts, model),
       userColumnWidths: [...userColumnWidths].filter(_ref6 => {
         var [columnIndex] = _ref6;
         return columnIndex != null && columnIndex >= 0 && columnIndex < columns.length;
@@ -186,14 +185,15 @@ class IrisGridUtils {
   }
   /**
    * Import a state for IrisGrid that was exported with {{@link dehydrateIrisGridState}}
-   * @param model The table model to import the state with
-   * @param irisGridState The saved IrisGrid state
+   * @param {IrisGridModel} model The table model to import the state with
+   * @param {Object} irisGridState The saved IrisGrid state
    */
 
 
   static hydrateIrisGridState(model, irisGridState) {
     var {
       advancedFilters,
+      advancedSettings = [],
       aggregationSettings = {
         aggregations: [],
         showOnTop: false
@@ -207,7 +207,7 @@ class IrisGridUtils {
       userColumnWidths,
       userRowHeights,
       reverseType,
-      rollupConfig = undefined,
+      rollupConfig = null,
       showSearchBar,
       searchValue,
       selectDistinctColumns,
@@ -222,6 +222,7 @@ class IrisGridUtils {
     } = model;
     return {
       advancedFilters: IrisGridUtils.hydrateAdvancedFilters(columns, advancedFilters, formatter.timeZone),
+      advancedSettings: new Map([...AdvancedSettings.DEFAULTS, ...advancedSettings]),
       aggregationSettings,
       customColumnFormatMap: new Map(customColumnFormatMap),
       isFilterBarShown,
@@ -260,9 +261,9 @@ class IrisGridUtils {
   }
   /**
    * Export the IrisGridPanel state.
-   * @param model The table model the state is being dehydrated with
-   * @param irisGridPanelState The current IrisGridPanel state
-   * @returns The dehydrated IrisGridPanel state
+   * @param {IrisGridModel} model The table model the state is being dehydrated with
+   * @param {Object} irisGridPanelState The current IrisGridPanel state
+   * @returns {Object} The dehydrated IrisGridPanel state
    */
 
 
@@ -280,9 +281,9 @@ class IrisGridUtils {
   }
   /**
    * Import the saved IrisGridPanel state.
-   * @param model The model the state is being hydrated with
-   * @param irisGridPanelState Exported IrisGridPanel state
-   * @returns The state to apply to the IrisGridPanel
+   * @param {IrisGridModel} model The model the state is being hydrated with
+   * @param {Object} irisGridPanelState Exported IrisGridPanel state
+   * @returns {Object} The state to apply to the IrisGridPanel
    */
 
 
@@ -303,8 +304,8 @@ class IrisGridUtils {
   }
   /**
    * Export the quick filters to JSON striginfiable object
-   * @param quickFilters The quick filters to dehydrate
-   * @returns The dehydrated quick filters
+   * @param {AdvancedFilter[]} quickFilters The quick filters to dehydrate
+   * @returns {Object} The dehydrated quick filters
    */
 
 
@@ -321,10 +322,10 @@ class IrisGridUtils {
   }
   /**
    * Import the saved quick filters to apply to the columns. Does not actually apply the filters.
-   * @param  columns The columns the filters will be applied to
-   * @param  savedQuickFilters Exported quick filters definitions
-   * @param  timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
-   * @returns The quick filters to apply to the columns
+   * @param {dh.Column[]} columns The columns the filters will be applied to
+   * @param {Object[]} savedQuickFilters Exported quick filters definitions
+   * @param {string} timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
+   * @returns {QuickFilter[]} The quick filters to apply to the columns
    */
 
 
@@ -355,18 +356,16 @@ class IrisGridUtils {
   }
   /**
    * Export the advanced filters from the provided columns to JSON striginfiable object
-   * @param columns The columns for the filters
-   * @param advancedFilters The advanced filters to dehydrate
-   * @returns The dehydrated advanced filters
+   * @param {dh.Column[]} columns The columns for the filters
+   * @param {AdvancedFilter[]} advancedFilters The advanced filters to dehydrate
+   * @returns {Object} The dehydrated advanced filters
    */
 
 
   static dehydrateAdvancedFilters(columns, advancedFilters) {
     return [...advancedFilters].map(_ref13 => {
       var [columnIndex, advancedFilter] = _ref13;
-      var column = IrisGridUtils.getColumn(columns, columnIndex);
-      assertNotNull(column);
-      var options = IrisGridUtils.dehydrateAdvancedFilterOptions(column, advancedFilter.options);
+      var options = IrisGridUtils.dehydrateAdvancedFilterOptions(IrisGridUtils.getColumn(columns, columnIndex), advancedFilter.options);
       return [columnIndex, {
         options
       }];
@@ -374,25 +373,23 @@ class IrisGridUtils {
   }
   /**
    * Import the saved advanced filters to apply to the columns. Does not actually apply the filters.
-   * @param  columns The columns the filters will be applied to
-   * @param  savedAdvancedFilters Exported advanced filters definitions
-   * @param  timeZone The time zone to make this filter in if it is a date type. E.g. America/New_York
-   * @returns The advanced filters to apply to the columns
+   * @param {dh.Columns[]} columns The columns the filters will be applied to
+   * @param {Object[]} savedAdvancedFilters Exported advanced filters definitions
+   * @param {string} timeZone The time zone to make this filter in if it is a date type. E.g. America/New_York
+   * @returns {AdvancedFilter[]} The advanced filters to apply to the columns
    */
 
 
   static hydrateAdvancedFilters(columns, savedAdvancedFilters, timeZone) {
     var importedFilters = savedAdvancedFilters.map(_ref14 => {
       var [columnIndex, advancedFilter] = _ref14;
-      var column = IrisGridUtils.getColumn(columns, columnIndex);
-      assertNotNull(column);
-      var options = IrisGridUtils.hydrateAdvancedFilterOptions(column, advancedFilter.options);
+      var options = IrisGridUtils.hydrateAdvancedFilterOptions(IrisGridUtils.getColumn(columns, columnIndex), advancedFilter.options);
       var filter = null;
 
       try {
-        var columnRetrieved = IrisGridUtils.getColumn(columns, columnIndex);
+        var column = IrisGridUtils.getColumn(columns, columnIndex);
 
-        if (columnRetrieved != null) {
+        if (column != null) {
           filter = TableUtils.makeAdvancedFilter(column, options, timeZone);
         }
       } catch (error) {
@@ -414,7 +411,7 @@ class IrisGridUtils {
         otherOptions = _objectWithoutProperties(options, _excluded);
 
     return _objectSpread({
-      selectedValues: selectedValues === null || selectedValues === void 0 ? void 0 : selectedValues.map(value => IrisGridUtils.dehydrateValue(value, column === null || column === void 0 ? void 0 : column.type))
+      selectedValues: selectedValues.map(value => IrisGridUtils.dehydrateValue(value, column === null || column === void 0 ? void 0 : column.type))
     }, otherOptions);
   }
 
@@ -425,7 +422,7 @@ class IrisGridUtils {
         otherOptions = _objectWithoutProperties(options, _excluded2);
 
     return _objectSpread({
-      selectedValues: selectedValues === null || selectedValues === void 0 ? void 0 : selectedValues.map(value => IrisGridUtils.hydrateValue(value, column === null || column === void 0 ? void 0 : column.type))
+      selectedValues: selectedValues.map(value => IrisGridUtils.hydrateValue(value, column === null || column === void 0 ? void 0 : column.type))
     }, otherOptions);
   }
 
@@ -465,20 +462,16 @@ class IrisGridUtils {
       }] = _ref18;
       return [rowIndex, {
         data: new Map(data.map(_ref19 => {
-          var _getColumnIndex;
-
           var [columnName, value] = _ref19;
-          var index = getColumnIndex(columnName);
-          assertNotNull(index);
-          return [(_getColumnIndex = getColumnIndex(columnName)) !== null && _getColumnIndex !== void 0 ? _getColumnIndex : null, IrisGridUtils.hydrateValue(value, columns[index].type)];
+          return [getColumnIndex(columnName), IrisGridUtils.hydrateValue(value, columns[getColumnIndex(columnName)].type)];
         }))
       }];
     }));
   }
   /**
    * Dehydrates/serializes a value for storage.
-   * @param  value The value to dehydrate
-   * @param  columnType The column type
+   * @param {Any} value The value to dehydrate
+   * @param {String} columnType The column type
    */
 
 
@@ -495,8 +488,8 @@ class IrisGridUtils {
   }
   /**
    * Hydrate a value from it's serialized state
-   * @param  value The dehydrated value that needs to be hydrated
-   * @param  columnType The type of column
+   * @param {Any} value The dehydrated value that needs to be hydrated
+   * @param {String} columnType The type of column
    */
 
 
@@ -529,8 +522,8 @@ class IrisGridUtils {
   }
   /**
    * Export the sorts from the provided table sorts to JSON stringifiable object
-   * @param  sorts The table sorts
-   * @returns The dehydrated sorts
+   * @param {dh.Sort[]} sorts The table sorts
+   * @returns {Object} The dehydrated sorts
    */
 
 
@@ -550,9 +543,9 @@ class IrisGridUtils {
   }
   /**
    * Import the saved sorts to apply to the table. Does not actually apply the sort.
-   * @param  columns The columns the sorts will be applied to
-   * @param  sorts Exported sort definitions
-   * @returns The sorts to apply to the table
+   * @param {dh.Column[]} columns The columns the sorts will be applied to
+   * @param {Object[]} sorts Exported sort definitions
+   * @returns {dh.Sort[]} The sorts to apply to the table
    */
 
 
@@ -594,8 +587,8 @@ class IrisGridUtils {
   }
   /**
    * Pulls just the table settings from the panel state, eg. filters/sorts
-   * @param  panelState The dehydrated panel state
-   * @returns A dehydrated table settings object, { partition, partitionColumn, advancedFilters, quickFilters, sorts }
+   * @param {Object} panelState The dehydrated panel state
+   * @returns {Object} A dehydrated table settings object, { partition, partitionColumn, advancedFilters, quickFilters, sorts }
    */
 
 
@@ -625,9 +618,9 @@ class IrisGridUtils {
   }
   /**
    * Applies the passed in table settings directly to the provided table
-   * @param  table The table to apply the settings to
-   * @param  tableSettings Dehydrated table settings extracted with `extractTableSettings`
-   * @param  timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
+   * @param {dh.Table} table The table to apply the settings to
+   * @param {Object} tableSettings Dehydrated table settings extracted with `extractTableSettings`
+   * @param {string} timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
    */
 
 
@@ -635,25 +628,10 @@ class IrisGridUtils {
     var {
       columns
     } = table;
-    var quickFilters = [];
-
-    if (tableSettings.quickFilters) {
-      quickFilters = IrisGridUtils.getFiltersFromFilterMap(IrisGridUtils.hydrateQuickFilters(columns, tableSettings.quickFilters, timeZone));
-    }
-
-    var advancedFilters = [];
-
-    if (tableSettings.advancedFilters) {
-      advancedFilters = IrisGridUtils.getFiltersFromFilterMap(IrisGridUtils.hydrateAdvancedFilters(columns, tableSettings.advancedFilters, timeZone));
-    }
-
+    var quickFilters = IrisGridUtils.getFiltersFromFilterMap(IrisGridUtils.hydrateQuickFilters(columns, tableSettings.quickFilters, timeZone));
+    var advancedFilters = IrisGridUtils.getFiltersFromFilterMap(IrisGridUtils.hydrateAdvancedFilters(columns, tableSettings.advancedFilters, timeZone));
     var inputFilters = IrisGridUtils.getFiltersFromInputFilters(columns, tableSettings.inputFilters, timeZone);
-    var sorts = [];
-
-    if (tableSettings.sorts) {
-      sorts = IrisGridUtils.hydrateSort(columns, tableSettings.sorts);
-    }
-
+    var sorts = IrisGridUtils.hydrateSort(columns, tableSettings.sorts);
     var filters = [...quickFilters, ...advancedFilters];
     var {
       partition,
@@ -718,7 +696,7 @@ class IrisGridUtils {
       }
 
       return null;
-    }).filter(filter => filter != null);
+    }).filter(filter => filter);
   }
 
   static getFiltersFromFilterMap(filterMap) {
@@ -729,7 +707,7 @@ class IrisGridUtils {
       var key = keys[i];
       var item = filterMap.get(key);
 
-      if (item && item.filter != null) {
+      if (item.filter != null) {
         filters.push(item.filter);
       }
     }
@@ -738,8 +716,8 @@ class IrisGridUtils {
   }
   /**
    * Get array of hidden column indexes
-   * @param  userColumnWidths Map of user column widths
-   * @returns Array of hidden column indexes
+   * @param {Map} userColumnWidths Map of user column widths
+   * @returns {number[]} Array of hidden column indexes
    */
 
 
@@ -904,7 +882,8 @@ class IrisGridUtils {
     return columnsToFetch;
   }
 
-  static getModelViewportColumns(columns, left, right, movedColumns) {
+  static getModelViewportColumns(columns, left, right) {
+    var movedColumns = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
     var hiddenColumns = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
     var alwaysFetchColumnNames = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : [];
     var bufferPages = arguments.length > 6 && arguments[6] !== undefined ? arguments[6] : 0;
@@ -924,23 +903,17 @@ class IrisGridUtils {
    * Get the dh.RangeSet representation of the provided ranges.
    * Ranges are sorted prior to creating the RangeSet. Only the rows are taken into account,
    * RangeSet does not have an option for columns.
-   * @param  ranges The ranges to get the range set for
-   * @returns The rangeset for the provided ranges
+   * @param {GridRange[]} ranges The ranges to get the range set for
+   * @returns {dh.RangeSet} The rangeset for the provided ranges
    */
 
 
   static rangeSetFromRanges(ranges) {
-    var rangeSets = ranges.slice().sort((a, b) => {
-      assertNotNull(a.startRow);
-      assertNotNull(b.startRow);
-      return a.startRow - b.startRow;
-    }).map(range => {
+    var rangeSets = ranges.slice().sort((a, b) => a.startRow - b.startRow).map(range => {
       var {
         startRow,
         endRow
       } = range;
-      assertNotNull(startRow);
-      assertNotNull(endRow);
       return dh.RangeSet.ofRange(startRow, endRow);
     });
     return dh.RangeSet.ofRanges(rangeSets);
@@ -949,8 +922,8 @@ class IrisGridUtils {
    * Validate whether the ranges passed in are valid to take a snapshot from.
    * Multiple selections are valid if all of the selected rows have the same columns selected.
    *
-   * @param ranges The ranges to validate
-   * @returns True if the ranges are valid, false otherwise
+   * @param {GridRange[]} ranges The ranges to validate
+   * @returns {boolean} True if the ranges are valid, false otherwise
    */
 
 
@@ -988,26 +961,18 @@ class IrisGridUtils {
   }
   /**
    * Check if the provided value is a valid table index
-   * @param  value A value to check if it's a valid table index
+   * @param {any} value A value to check if it's a valid table index
    */
 
 
   static isValidIndex(value) {
-    if (!Number.isInteger(value)) {
-      return false;
-    }
-
-    if (!(typeof value === 'number')) {
-      return false;
-    }
-
-    return value >= 0;
+    return Number.isInteger(value) && value >= 0;
   }
   /**
    * Returns all columns used in any of the ranges provided
-   * @param  ranges The model ranges to get columns for
-   * @param  allColumns All the columns to pull from
-   * @returns The columns selected in the range
+   * @param {GridRange[]} ranges The model ranges to get columns for
+   * @param {dh.Column[]} allColumns All the columns to pull from
+   * @returns {dh.Column[]} The columns selected in the range
    */
 
 
@@ -1025,8 +990,6 @@ class IrisGridUtils {
 
     for (var i = 0; i < ranges.length; i += 1) {
       var range = ranges[i];
-      assertNotNull(range.startColumn);
-      assertNotNull(range.endColumn);
 
       for (var c = (_range$startColumn = range.startColumn) !== null && _range$startColumn !== void 0 ? _range$startColumn : 0; c <= ((_range$endColumn = range.endColumn) !== null && _range$endColumn !== void 0 ? _range$endColumn : allColumns.length - 1); c += 1) {
         var _range$startColumn, _range$endColumn;
@@ -1039,8 +1002,8 @@ class IrisGridUtils {
   }
   /**
    * Transforms an iris data snapshot into a simple data matrix
-   * @param  data The Iris formatted table data
-   * @returns A matrix of the values of the data
+   * @param {dh.TableData} data The Iris formatted table data
+   * @returns {unknown[][]} A matrix of the values of the data
    */
 
 
@@ -1068,10 +1031,10 @@ class IrisGridUtils {
   }
   /**
    * Hydrate model rollup config
-   * @param  originalColumns Original model columns
-   * @param  config Dehydrated rollup config
-   * @param  aggregationSettings Aggregation settings
-   * @returns Rollup config for the model
+   * @param {Array} originalColumns Original model columns
+   * @param {Object} config Dehydrated rollup config
+   * @param {Object} aggregationSettings Aggregation settings
+   * @returns {Object} Rollup config for the model
    */
 
 
@@ -1128,15 +1091,15 @@ class IrisGridUtils {
     };
   }
   /**
-   * @param  pendingDataMap Map of pending data
-   * @returns A map with the errors in the pending data
+   * @param {Map} pendingDataMap Map of pending data
+   * @returns {Map} A map with the errors in the pending data
    */
 
 
   static getPendingErrors(pendingDataMap) {
     pendingDataMap.forEach((row, rowIndex) => {
       if (!IrisGridUtils.isValidIndex(rowIndex)) {
-        throw new Error("Invalid rowIndex ".concat(rowIndex));
+        throw new Error('Invalid rowIndex', rowIndex);
       }
 
       var {
@@ -1144,7 +1107,7 @@ class IrisGridUtils {
       } = row;
       data.forEach((value, columnIndex) => {
         if (!IrisGridUtils.isValidIndex(columnIndex)) {
-          throw new Error("Invalid columnIndex ".concat(columnIndex));
+          throw new Error('Invalid columnIndex', columnIndex);
         }
       });
     });
@@ -1152,8 +1115,8 @@ class IrisGridUtils {
   /**
    * Retrieves a column from the provided array at the index, or `null` and logs an error if it's invalid
    *
-   * @param  columns The columns to get the column from
-   * @param  columnIndex The column index to get
+   * @param {dh.Columns[]} columns The columns to get the column from
+   * @param {Number} columnIndex The column index to get
    */
 
 
@@ -1167,8 +1130,8 @@ class IrisGridUtils {
   }
   /**
    * Retrieves a column from the provided array matching the name, or `null` and logs an error if not found
-   * @param  columns The columns to get the column from
-   * @param  columnName The column name to retrieve
+   * @param {dh.Column[]} columns The columns to get the column from
+   * @param {String} columnName The column name to retrieve
    */
 
 
@@ -1193,9 +1156,9 @@ class IrisGridUtils {
   }
   /**
    * Get filter configs with column names changed to indexes, exclude missing columns
-   * @param  columns The columns to get column indexes from
-   * @param  filters Filter configs
-   * @returns Updated filter configs with column names changed to indexes
+   * @param {dh.Column[]} columns The columns to get column indexes from
+   * @param {Object[]} filters Filter configs
+   * @returns {Object[]} Updated filter configs with column names changed to indexes
    */