@deephaven/iris-grid 0.8.2-beta.6 → 0.9.1-beta.5

package/dist/TableUtils.js

@@ -6,8 +6,8 @@ import { PromiseUtils, TextUtils, TimeoutError } from '@deephaven/utils';
 import DateUtils from "./DateUtils.js";
 import { FilterType, FilterOperator } from "./filters/index.js";
 var log = Log.module('TableUtils');
-/** Utility class to provide some functions for working with tables */
 
+/** Utility class to provide some functions for working with tables */
 class TableUtils {
   // Regex looking for a negative or positive integer or decimal number
   static getSortIndex(sort, columnIndex) {
@@ -24,9 +24,9 @@ class TableUtils {
     return null;
   }
   /**
-   * @param {dh.Sort[]} tableSort The sorts from the table to get the sort from
-   * @param {number} columnIndex The index of the column to get the sort for
-   * @return {dh.Sort} The sort for the column, or null if it's not sorted
+   * @param tableSort The sorts from the table to get the sort from
+   * @param columnIndex The index of the column to get the sort for
+   * @return The sort for the column, or null if it's not sorted
    */
 
 
@@ -123,10 +123,10 @@ class TableUtils {
   }
   /**
    * Toggles the sort for the specified column
-   * @param {array} sorts The current sorts from IrisGrid.state
-   * @param {dh.Table} table The table to apply the sort to
-   * @param {number} columnIndex The column index to apply the sort to
-   * @param {boolean} addToExisting Add this sort to the existing sort
+   * @param sorts The current sorts from IrisGrid.state
+   * @param table The table to apply the sort to
+   * @param columnIndex The column index to apply the sort to
+   * @param addToExisting Add this sort to the existing sort
    */
 
 
@@ -151,11 +151,11 @@ class TableUtils {
   }
   /**
    * Sets the sort for the given column *and* removes any reverses
-   * @param {dh.Sort[]} tableSort The current sorts from IrisGrid.state
-   * @param {number} columnIndex The column index to apply the sort to
-   * @param {dh.Sort} sort The sort object to add
-   * @param {boolean} addToExisting Add this sort to the existing sort
-   * @returns {array} Returns the modified array of sorts - removing reverses
+   * @param tableSort The current sorts from IrisGrid.state
+   * @param columnIndex The column index to apply the sort to
+   * @param sort The sort object to add
+   * @param addToExisting Add this sort to the existing sort
+   * @returns Returns the modified array of sorts - removing reverses
    */
 
 
@@ -323,8 +323,8 @@ class TableUtils {
   }
   /**
    * Get base column type
-   * @param {string} columnType Column type
-   * @returns {string} Element type for array columns, original type for non-array columns
+   * @param columnType Column type
+   * @returns Element type for array columns, original type for non-array columns
    */
 
 
@@ -333,9 +333,9 @@ class TableUtils {
   }
   /**
    * Check if the column types are compatible
-   * @param {string} type1 Column type to check
-   * @param {string} type2 Column type to check
-   * @returns {boolean} True, if types are compatible
+   * @param type1 Column type to check
+   * @param type2 Column type to check
+   * @returns True, if types are compatible
    */
 
 
@@ -344,10 +344,10 @@ class TableUtils {
   }
   /**
    * Create filter with the provided column and text. Handles multiple filters joined with && or ||
-   * @param {dh.Column} column The column to set the filter on
-   * @param {string} text The text string to create the filter from
-   * @param {string} timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
-   * @returns {dh.FilterCondition} Returns the created filter, null if text could not be parsed
+   * @param column The column to set the filter on
+   * @param text The text string to create the filter from
+   * @param timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
+   * @returns Returns the created filter, null if text could not be parsed
    */
 
 
@@ -378,7 +378,7 @@ class TableUtils {
         }
       }
 
-      if (orFilter) {
+      if (orFilter && andFilter) {
         orFilter = orFilter.or(andFilter);
       } else {
         orFilter = andFilter;
@@ -389,10 +389,10 @@ class TableUtils {
   }
   /**
    * Create filter with the provided column and text of one component (no multiple conditions)
-   * @param {dh.Column} column The column to set the filter on
-   * @param {string} text The text string to create the filter from
-   * @param {string} timeZone The time zone to make this filter in if it is a date type. E.g. America/New_York
-   * @returns {dh.FilterCondition} Returns the created filter, null if text could not be parsed
+   * @param column The column to set the filter on
+   * @param text The text string to create the filter from
+   * @param timeZone The time zone to make this filter in if it is a date type. E.g. America/New_York
+   * @returns Returns the created filter, null if text could not be parsed
    */
 
 
@@ -436,7 +436,7 @@ class TableUtils {
 
     var overflow = null;
 
-    if (result.length > 3) {
+    if (result !== null && result.length > 3) {
       [, operation, negativeSign, value, abnormalValue, overflow] = result;
     }
 
@@ -449,10 +449,6 @@ class TableUtils {
       operation = '=';
     }
 
-    if (value == null && abnormalValue == null) {
-      return null;
-    }
-
     if (abnormalValue != null) {
       if (!(operation === '=' || operation === '!' || operation === '!=')) {
         // only equal and not equal operations are supported for abnormal value filter
@@ -485,13 +481,17 @@ class TableUtils {
           break;
       }
 
-      if (operation === '!' || operation === '!=') {
+      if (filter !== null && (operation === '!' || operation === '!=')) {
         filter = filter.not();
       }
 
       return filter;
     }
 
+    if (value == null) {
+      return null;
+    }
+
     value = TableUtils.removeCommas(value);
 
     if (TableUtils.isLongType(column.type)) {
@@ -526,7 +526,7 @@ class TableUtils {
     var operation = null;
     var value = null;
 
-    if (result.length > 2) {
+    if (result !== null && result.length > 2) {
       [, operation, value] = result;
 
       if (value != null) {
@@ -621,6 +621,11 @@ class TableUtils {
 
     var regex = /^(!=|=|!)?(.*)/;
     var result = regex.exec("".concat(text).trim());
+
+    if (result === null) {
+      return null;
+    }
+
     var [, operation, value] = result;
     var notEqual = operation === '!' || operation === '!=';
     var cleanValue = value.trim().toLowerCase();
@@ -644,8 +649,9 @@ class TableUtils {
   }
   /**
    * Builds a date filter parsed from the text string which may or may not include an operator.
-   * @param {Column} column The column to build the filter from, with or without a leading operator.
-   * @param {string} text The date string text to parse.
+   * @param column The column to build the filter from, with or without a leading operator.
+   * @param text The date string text to parse.
+   * @param timeZone The time zone to make this filter in if it is a date type. E.g. America/New_York
    */
 
 
@@ -698,10 +704,10 @@ class TableUtils {
   }
   /**
    * Builds a date filter parsed from the text string with the provided filter.
-   * @param {Column} column The column to build the filter from.
-   * @param {string} text The date string text to parse, without an operator.
-   * @param {FilterType} operation The filter operation to use.
-   * @param {string} timeZone The time zone to make this filter with. E.g. America/New_York
+   * @param column The column to build the filter from.
+   * @param text The date string text to parse, without an operator.
+   * @param operation The filter operation to use.
+   * @param timeZone The time zone to make this filter with. E.g. America/New_York
    */
 
 
@@ -718,7 +724,7 @@ class TableUtils {
     var endValue = endDate != null ? dh.FilterValue.ofNumber(endDate) : null;
     var filter = column.filter();
 
-    if (startValue == null && endValue == null) {
+    if (startValue == null) {
       return operation === FilterType.notEq ? filter.isNull().not() : filter.isNull();
     }
 
@@ -790,7 +796,7 @@ class TableUtils {
     var value = null;
     var overflow = null;
 
-    if (result.length > 3) {
+    if (result !== null && result.length > 3) {
       [, operation, value, overflow] = result;
     }
 
@@ -827,10 +833,10 @@ class TableUtils {
     return TableUtils.makeRangeFilterWithOperation(filter, operation, dh.FilterValue.ofString(value));
   }
   /**
-   * @param {dh.FilterValue} filter The column filter to apply the range operation to
-   * @param {string} operation The range operation to run
-   * @param {dh.FilterValue} value The value to use for the operation
-   * @returns {dh.FilterCondition} The condition with the specified operation
+   * @param filter The column filter to apply the range operation to
+   * @param operation The range operation to run
+   * @param value The value to use for the operation
+   * @returns The condition with the specified operation
    */
 
 
@@ -864,7 +870,7 @@ class TableUtils {
   /**
    * Wraps a table promise in a cancelable promise that will close the table if the promise is cancelled.
    * Use in a component that loads a table, and call cancel when unmounting.
-   * @param {Promise<dh.Table> | dh.Table} table The table promise to wrap
+   * @param table The table promise to wrap
    */
 
 
@@ -875,19 +881,19 @@ class TableUtils {
   }
   /**
    * Make a cancelable promise for a one-shot table event with a timeout.
-   * @param {dh.Table|dh.TreeTable} table Table to listen for events on
-   * @param {string} eventName Event to listen for
-   * @param {number} timeout Event timeout in milliseconds, defaults to 0
-   * @param {function} matcher Optional function to determine if the promise can be resolved or stays pending
-   * @returns {Promise} Resolves with the event data
+   * @param table Table to listen for events on
+   * @param eventName Event to listen for
+   * @param timeout Event timeout in milliseconds, defaults to 0
+   * @param matcher Optional function to determine if the promise can be resolved or stays pending
+   * @returns Resolves with the event data
    */
 
 
   static makeCancelableTableEventPromise(table, eventName) {
     var timeout = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
     var matcher = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : null;
-    var eventCleanup = null;
-    var timeoutId = null;
+    var eventCleanup;
+    var timeoutId;
     var isPending = true;
     var wrappedPromise = new Promise((resolve, reject) => {
       timeoutId = setTimeout(() => {
@@ -988,9 +994,9 @@ class TableUtils {
     return value.replace(/[\s|,]/g, '');
   }
   /**
-   * @param {String} columnType The column type to make the filter value from.
-   * @param {String} value The value to make the filter value from.
-   * @returns {dh.FilterValue} The FilterValue item for this column/value combination
+   * @param columnType The column type to make the filter value from.
+   * @param value The value to make the filter value from.
+   * @returns The FilterValue item for this column/value combination
    */
 
 
@@ -1010,9 +1016,9 @@ class TableUtils {
   /**
    * Takes a value and converts it to an `dh.FilterValue`
    *
-   * @param {String} columnType The column type to make the filter value from.
-   * @param {unknown} value The value to actually set
-   * @returns {dh.FilterValue} The FilterValue item for this column/value combination
+   * @param columnType The column type to make the filter value from.
+   * @param value The value to actually set
+   * @returns The FilterValue item for this column/value combination
    */
 
 
@@ -1029,9 +1035,9 @@ class TableUtils {
   }
   /**
    * Converts a string value to a value appropriate for the column
-   * @param {string} columnType The column type to make the value for
-   * @param {string} text The string value to make a type for
-   * @param {string} timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
+   * @param columnType The column type to make the value for
+   * @param text The string value to make a type for
+   * @param timeZone The time zone to make this value in if it is a date type. E.g. America/New_York
    */
 
 
@@ -1192,9 +1198,10 @@ class TableUtils {
    * Create a filter using the selected items
    * Has a flag for invertSelection as we start from a "Select All" state and a user just deselects items.
    * Since there may be millions of distinct items, it's easier to build an inverse filter.
-   * @param {String[]} selectedValues The values that are selected
-   * @param {boolean} invertSelection Invert the selection (eg. All items are selected, then you deselect items)
-   * @returns dh.FilterCondition Returns a `in` or `notIn` FilterCondition as necessary, or null if no filtering should be applied (everything selected)
+   * @param column The column to set the filter on
+   * @param selectedValues The values that are selected
+   * @param invertSelection Invert the selection (eg. All items are selected, then you deselect items)
+   * @returns Returns a `in` or `notIn` FilterCondition as necessary, or null if no filtering should be applied (everything selected)
    */
 
 
@@ -1267,12 +1274,12 @@ class TableUtils {
   }
 
   static isTreeTable(table) {
-    return table && table.expand && table.collapse;
+    return table != null && table.expand !== undefined && table.collapse !== undefined;
   }
   /**
    * Copies the provided array, sorts by column name case insensitive, and returns the sorted array.
-   * @param {Array<dh.Column>}} columns The columns to sort
-   * @param {boolean} isAscending Whether to sort ascending
+   * @param columns The columns to sort
+   * @param isAscending Whether to sort ascending
    */