@deephaven/iris-grid 0.31.2-beta.3 → 0.31.2-beta.8

package/dist/IrisGrid.js

@@ -14,11 +14,11 @@ import deepEqual from 'deep-equal';
 import Log from '@deephaven/log';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { ContextActions, Stack, Menu, Page, Popper, ThemeExport, Tooltip, Button, ContextActionUtils } from '@deephaven/components';
-import { Grid, GridRange, GridUtils, isEditableGridModel, isExpandableGridModel, getOrThrow } from '@deephaven/grid';
+import { Grid, GridRange, GridUtils, isEditableGridModel, isExpandableGridModel } from '@deephaven/grid';
 import { dhEye, dhFilterFilled, dhGraphLineUp, dhTriangleDownSquare, vsClose, vsCloudDownload, vsEdit, vsFilter, vsMenu, vsReply, vsRuby, vsSearch, vsSplitHorizontal, vsSymbolOperator, vsTools } from '@deephaven/icons';
 import dh from '@deephaven/jsapi-shim';
 import { DateUtils, Formatter, FormatterUtils, TableUtils } from '@deephaven/jsapi-utils';
-import { assertNotNull, copyToClipboard, EMPTY_ARRAY, EMPTY_MAP, Pending, PromiseUtils, ValidationError } from '@deephaven/utils';
+import { assertNotNull, copyToClipboard, EMPTY_ARRAY, EMPTY_MAP, Pending, PromiseUtils, ValidationError, getOrThrow } from '@deephaven/utils';
 import { Type as FilterType } from '@deephaven/filters';
 import throttle from 'lodash.throttle';
 import debounce from 'lodash.debounce';
@@ -28,7 +28,7 @@ import PendingDataBottomBar from "./PendingDataBottomBar.js";
 import IrisGridCopyHandler from "./IrisGridCopyHandler.js";
 import FilterInputField from "./FilterInputField.js";
 import { ClearFilterKeyHandler, CopyKeyHandler, ReverseKeyHandler } from "./key-handlers/index.js";
-import { IrisGridCellOverflowMouseHandler, IrisGridColumnSelectMouseHandler, IrisGridColumnTooltipMouseHandler, IrisGridContextMenuHandler, IrisGridDataSelectMouseHandler, IrisGridFilterMouseHandler, IrisGridRowTreeMouseHandler, IrisGridSortMouseHandler, PendingMouseHandler } from "./mousehandlers/index.js";
+import { IrisGridCellOverflowMouseHandler, IrisGridColumnSelectMouseHandler, IrisGridColumnTooltipMouseHandler, IrisGridContextMenuHandler, IrisGridDataSelectMouseHandler, IrisGridFilterMouseHandler, IrisGridRowTreeMouseHandler, IrisGridSortMouseHandler, IrisGridTokenMouseHandler, PendingMouseHandler } from "./mousehandlers/index.js";
 import ToastBottomBar from "./ToastBottomBar.js";
 import IrisGridMetricCalculator from "./IrisGridMetricCalculator.js";
 import IrisGridModelUpdater from "./IrisGridModelUpdater.js";
@@ -396,6 +396,30 @@ export class IrisGrid extends Component {
         }
       }, "Click to ", expandTooltipDisplayValue, " row", /*#__PURE__*/React.createElement("br", null), ContextActionUtils.isMacPlatform() ? '⌘' : 'Ctrl+', "Click to expand row and all children")));
     }));
+    _defineProperty(this, "getLinkHoverTooltip", memoize(linkHoverTooltipProps => {
+      if (linkHoverTooltipProps == null) {
+        return null;
+      }
+      var {
+        linkHoverDisplayValue
+      } = this.state;
+      var wrapperStyle = _objectSpread(_objectSpread({
+        position: 'absolute'
+      }, linkHoverTooltipProps), {}, {
+        pointerEvents: 'none'
+      });
+      var popperOptions = {
+        placement: 'bottom'
+      };
+      return /*#__PURE__*/React.createElement("div", {
+        style: wrapperStyle
+      }, /*#__PURE__*/React.createElement(Tooltip, {
+        options: popperOptions,
+        ref: this.handleTooltipRef
+      }, /*#__PURE__*/React.createElement("div", {
+        className: "link-hover-tooltip"
+      }, linkHoverDisplayValue, " - Click once to follow.", /*#__PURE__*/React.createElement("br", null), "Click and hold to select this cell.")));
+    }));
     _defineProperty(this, "handleGotoValueChanged", input => {
       this.setState({
         gotoValue: input
@@ -550,7 +574,7 @@ export class IrisGrid extends Component {
     if (canCopy) {
       keyHandlers.push(new CopyKeyHandler(this));
     }
-    var mouseHandlers = [new IrisGridCellOverflowMouseHandler(this), new IrisGridRowTreeMouseHandler(this), new IrisGridColumnSelectMouseHandler(this), new IrisGridColumnTooltipMouseHandler(this), new IrisGridSortMouseHandler(this), new IrisGridFilterMouseHandler(this), new IrisGridContextMenuHandler(this), new IrisGridDataSelectMouseHandler(this), new PendingMouseHandler(this)];
+    var mouseHandlers = [new IrisGridCellOverflowMouseHandler(this), new IrisGridRowTreeMouseHandler(this), new IrisGridTokenMouseHandler(this), new IrisGridColumnSelectMouseHandler(this), new IrisGridColumnTooltipMouseHandler(this), new IrisGridSortMouseHandler(this), new IrisGridFilterMouseHandler(this), new IrisGridContextMenuHandler(this), new IrisGridDataSelectMouseHandler(this), new PendingMouseHandler(this)];
     var _movedColumns = movedColumnsProp.length > 0 ? movedColumnsProp : _model.initialMovedColumns;
     var movedRows = movedRowsProp.length > 0 ? movedRowsProp : _model.initialMovedRows;
     var _metricCalculator = new IrisGridMetricCalculator({
@@ -629,6 +653,8 @@ export class IrisGrid extends Component {
       overflowButtonTooltipProps: null,
       expandCellTooltipProps: null,
       expandTooltipDisplayValue: 'expand',
+      linkHoverTooltipProps: null,
+      linkHoverDisplayValue: '',
       isGotoShown: false,
       gotoRow: '',
       gotoRowError: '',
@@ -1536,9 +1562,8 @@ export class IrisGrid extends Component {
     });
   }
   handleAnimationLoop() {
-    var _this$grid7, _this$grid8;
-    (_this$grid7 = this.grid) === null || _this$grid7 === void 0 ? void 0 : _this$grid7.updateCanvasScale();
-    (_this$grid8 = this.grid) === null || _this$grid8 === void 0 ? void 0 : _this$grid8.updateCanvas();
+    var _this$grid7;
+    (_this$grid7 = this.grid) === null || _this$grid7 === void 0 ? void 0 : _this$grid7.updateCanvas();
     if (this.isAnimating) {
       this.animationFrame = requestAnimationFrame(this.handleAnimationLoop);
     }
@@ -1595,7 +1620,7 @@ export class IrisGrid extends Component {
     onError(error);
   }
   showAllColumns() {
-    var _this$grid9;
+    var _this$grid8;
     var {
       metricCalculator
     } = this.state;
@@ -1607,7 +1632,7 @@ export class IrisGrid extends Component {
         metricCalculator.resetColumnWidth(modelIndex);
       }
     }
-    (_this$grid9 = this.grid) === null || _this$grid9 === void 0 ? void 0 : _this$grid9.forceUpdate();
+    (_this$grid8 = this.grid) === null || _this$grid8 === void 0 ? void 0 : _this$grid8.forceUpdate();
   }
   toggleSort(columnIndex, addToExisting) {
     log.info('Toggling sort for column', columnIndex);
@@ -1623,15 +1648,15 @@ export class IrisGrid extends Component {
     this.updateSorts(sorts);
   }
   updateSorts(sorts) {
-    var _this$grid10;
+    var _this$grid9;
     this.startLoading('Sorting...');
     this.setState({
       sorts
     });
-    (_this$grid10 = this.grid) === null || _this$grid10 === void 0 ? void 0 : _this$grid10.forceUpdate();
+    (_this$grid9 = this.grid) === null || _this$grid9 === void 0 ? void 0 : _this$grid9.forceUpdate();
   }
   sortColumn(modelColumn) {
-    var _this$grid11;
+    var _this$grid10;
     var direction = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : TableUtils.sortDirection.none;
     var isAbs = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var addToExisting = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
@@ -1644,15 +1669,15 @@ export class IrisGrid extends Component {
     this.setState({
       sorts
     });
-    (_this$grid11 = this.grid) === null || _this$grid11 === void 0 ? void 0 : _this$grid11.forceUpdate();
+    (_this$grid10 = this.grid) === null || _this$grid10 === void 0 ? void 0 : _this$grid10.forceUpdate();
   }
   reverse(reverseType) {
-    var _this$grid12;
+    var _this$grid11;
     this.startLoading('Reversing...');
     this.setState({
       reverseType
     });
-    (_this$grid12 = this.grid) === null || _this$grid12 === void 0 ? void 0 : _this$grid12.forceUpdate();
+    (_this$grid11 = this.grid) === null || _this$grid11 === void 0 ? void 0 : _this$grid11.forceUpdate();
   }
   isReversible() {
     var {
@@ -1693,8 +1718,8 @@ export class IrisGrid extends Component {
         this.focusFilterBar(columnIndex);
       }
     } else {
-      var _this$grid13;
-      (_this$grid13 = this.grid) === null || _this$grid13 === void 0 ? void 0 : _this$grid13.focus();
+      var _this$grid12;
+      (_this$grid12 = this.grid) === null || _this$grid12 === void 0 ? void 0 : _this$grid12.focus();
     }
   }
   isTableSearchAvailable() {
@@ -1728,13 +1753,13 @@ export class IrisGrid extends Component {
         var _this$crossColumnRef2;
         (_this$crossColumnRef2 = this.crossColumnRef) === null || _this$crossColumnRef2 === void 0 ? void 0 : _this$crossColumnRef2.current.focus();
       } else {
-        var _this$grid14;
-        (_this$grid14 = this.grid) === null || _this$grid14 === void 0 ? void 0 : _this$grid14.focus();
+        var _this$grid13;
+        (_this$grid13 = this.grid) === null || _this$grid13 === void 0 ? void 0 : _this$grid13.focus();
       }
     });
   }
   toggleGotoRow() {
-    var _this$grid15, _this$grid16;
+    var _this$grid14, _this$grid15;
     var row = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
     var value = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
     var columnName = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
@@ -1754,8 +1779,8 @@ export class IrisGrid extends Component {
       this.focusRowInGrid(row);
       return;
     }
-    var cursorRow = (_this$grid15 = this.grid) === null || _this$grid15 === void 0 ? void 0 : _this$grid15.state.cursorRow;
-    var cursorColumn = (_this$grid16 = this.grid) === null || _this$grid16 === void 0 ? void 0 : _this$grid16.state.cursorColumn;
+    var cursorRow = (_this$grid14 = this.grid) === null || _this$grid14 === void 0 ? void 0 : _this$grid14.state.cursorRow;
+    var cursorColumn = (_this$grid15 = this.grid) === null || _this$grid15 === void 0 ? void 0 : _this$grid15.state.cursorColumn;
     if (cursorRow == null || cursorColumn == null) {
       // if a cell is not selected / grid is not rendered
       this.setState({
@@ -1910,7 +1935,7 @@ export class IrisGrid extends Component {
     this.setAdvancedFilter(index, filter, options);
   }
   handleAdvancedFilterSortChange(column, direction) {
-    var _this$grid17;
+    var _this$grid16;
     var addToExisting = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var {
       model
@@ -1933,11 +1958,11 @@ export class IrisGrid extends Component {
     this.setState({
       sorts
     });
-    (_this$grid17 = this.grid) === null || _this$grid17 === void 0 ? void 0 : _this$grid17.forceUpdate();
+    (_this$grid16 = this.grid) === null || _this$grid16 === void 0 ? void 0 : _this$grid16.forceUpdate();
   }
   handleAdvancedFilterDone() {
-    var _this$grid18;
-    (_this$grid18 = this.grid) === null || _this$grid18 === void 0 ? void 0 : _this$grid18.focus();
+    var _this$grid17;
+    (_this$grid17 = this.grid) === null || _this$grid17 === void 0 ? void 0 : _this$grid17.focus();
   }
   handleAdvancedMenuOpened(column) {
     this.setState({
@@ -2018,8 +2043,8 @@ export class IrisGrid extends Component {
     var setGridFocus = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
     var defocusInput = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
     if (setGridFocus) {
-      var _this$grid19;
-      (_this$grid19 = this.grid) === null || _this$grid19 === void 0 ? void 0 : _this$grid19.focus();
+      var _this$grid18;
+      (_this$grid18 = this.grid) === null || _this$grid18 === void 0 ? void 0 : _this$grid18.focus();
     }
     if (defocusInput) {
       this.setState({
@@ -2109,7 +2134,7 @@ export class IrisGrid extends Component {
     }
   }
   handleUpdate() {
-    var _this$grid20;
+    var _this$grid19;
     this.stopLoading();
     log.debug2('Received model update');
     var {
@@ -2139,16 +2164,16 @@ export class IrisGrid extends Component {
     } else {
       this.lastLoadedConfig = null;
     }
-    (_this$grid20 = this.grid) === null || _this$grid20 === void 0 ? void 0 : _this$grid20.forceUpdate();
+    (_this$grid19 = this.grid) === null || _this$grid19 === void 0 ? void 0 : _this$grid19.forceUpdate();
   }
   handleViewChanged(metrics) {
-    var _this$grid$state, _this$grid21;
+    var _this$grid$state, _this$grid20;
     var {
       model
     } = this.props;
     var {
       selectionEndRow = 0
-    } = (_this$grid$state = (_this$grid21 = this.grid) === null || _this$grid21 === void 0 ? void 0 : _this$grid21.state) !== null && _this$grid$state !== void 0 ? _this$grid$state : {};
+    } = (_this$grid$state = (_this$grid20 = this.grid) === null || _this$grid20 === void 0 ? void 0 : _this$grid20.state) !== null && _this$grid$state !== void 0 ? _this$grid$state : {};
     var pendingRowCount = 0;
     if (isEditableGridModel(model) && model.isEditable) {
       assertNotNull(metrics);
@@ -2205,8 +2230,8 @@ export class IrisGrid extends Component {
     this.setState({
       columnHeaderGroups: IrisGridUtils.parseColumnHeaderGroups(model, columnHeaderGroups).groups
     }, () => {
-      var _this$grid22;
-      return (_this$grid22 = this.grid) === null || _this$grid22 === void 0 ? void 0 : _this$grid22.forceUpdate();
+      var _this$grid21;
+      return (_this$grid21 = this.grid) === null || _this$grid21 === void 0 ? void 0 : _this$grid21.forceUpdate();
     });
   }
   handleTooltipRef(tooltip) {
@@ -2345,9 +2370,9 @@ export class IrisGrid extends Component {
       isReady
     } = this.state;
     if (isReady) {
-      var _this$grid23;
+      var _this$grid22;
       this.stopLoading();
-      (_this$grid23 = this.grid) === null || _this$grid23 === void 0 ? void 0 : _this$grid23.forceUpdate();
+      (_this$grid22 = this.grid) === null || _this$grid22 === void 0 ? void 0 : _this$grid22.forceUpdate();
     } else {
       this.initState();
     }
@@ -2359,7 +2384,7 @@ export class IrisGrid extends Component {
     return this.discardPending();
   }
   handlePendingDataUpdated() {
-    var _this$grid24;
+    var _this$grid23;
     log.debug('pending data updated');
     var {
       model
@@ -2373,7 +2398,7 @@ export class IrisGrid extends Component {
       pendingDataErrors,
       pendingSaveError: null
     });
-    (_this$grid24 = this.grid) === null || _this$grid24 === void 0 ? void 0 : _this$grid24.forceUpdate();
+    (_this$grid23 = this.grid) === null || _this$grid23 === void 0 ? void 0 : _this$grid23.forceUpdate();
   }
 
   /**
@@ -2729,22 +2754,22 @@ export class IrisGrid extends Component {
         gotoRowError: 'Invalid row index'
       });
     } else if (rowInt === 0) {
-      var _this$grid25;
+      var _this$grid24;
       this.setState({
         gotoRowError: '',
         gotoValueError: ''
       });
-      (_this$grid25 = this.grid) === null || _this$grid25 === void 0 ? void 0 : _this$grid25.setFocusRow(0);
+      (_this$grid24 = this.grid) === null || _this$grid24 === void 0 ? void 0 : _this$grid24.setFocusRow(0);
     } else if (rowInt < 0) {
-      var _this$grid26;
+      var _this$grid25;
       this.setState({
         gotoRowError: '',
         gotoValueError: ''
       });
-      (_this$grid26 = this.grid) === null || _this$grid26 === void 0 ? void 0 : _this$grid26.setFocusRow(rowInt + rowCount);
+      (_this$grid25 = this.grid) === null || _this$grid25 === void 0 ? void 0 : _this$grid25.setFocusRow(rowInt + rowCount);
     } else {
-      var _this$grid27;
-      (_this$grid27 = this.grid) === null || _this$grid27 === void 0 ? void 0 : _this$grid27.setFocusRow(rowInt - 1);
+      var _this$grid26;
+      (_this$grid26 = this.grid) === null || _this$grid26 === void 0 ? void 0 : _this$grid26.setFocusRow(rowInt - 1);
       this.setState({
         gotoRowError: '',
         gotoValueError: ''
@@ -2843,11 +2868,11 @@ export class IrisGrid extends Component {
     })));
   }
   handleGotoValueSelectedColumnNameChanged(columnName) {
-    var _this$grid28;
+    var _this$grid27;
     var {
       model
     } = this.props;
-    var cursorRow = (_this$grid28 = this.grid) === null || _this$grid28 === void 0 ? void 0 : _this$grid28.state.cursorRow;
+    var cursorRow = (_this$grid27 = this.grid) === null || _this$grid27 === void 0 ? void 0 : _this$grid27.state.cursorRow;
     if (cursorRow != null) {
       var _index = model.getColumnIndexByName(columnName);
       var _column3 = IrisGridUtils.getColumnByName(model.columns, columnName);
@@ -2883,8 +2908,8 @@ export class IrisGrid extends Component {
     var _rollupConfig$columns3,
       _rollupConfig$columns4,
       _this6 = this,
-      _this$grid30,
-      _this$grid30$state$dr,
+      _this$grid29,
+      _this$grid29$state$dr,
       _openOptions;
     var {
       children,
@@ -2962,6 +2987,7 @@ export class IrisGrid extends Component {
       overflowText,
       overflowButtonTooltipProps,
       expandCellTooltipProps,
+      linkHoverTooltipProps,
       isGotoShown,
       gotoRow,
       gotoRowError,
@@ -2999,7 +3025,7 @@ export class IrisGrid extends Component {
       var columnX = allColumnXs.get(focusedFilterBarColumn);
       var columnWidth = allColumnWidths.get(focusedFilterBarColumn);
       if (columnX != null && columnWidth != null) {
-        var _theme$filterBarHeigh, _theme$filterBarHeigh2, _this$grid29;
+        var _theme$filterBarHeigh, _theme$filterBarHeigh2, _this$grid28;
         var x = gridX + columnX;
         var y = gridY - ((_theme$filterBarHeigh = theme.filterBarHeight) !== null && _theme$filterBarHeigh !== void 0 ? _theme$filterBarHeigh : 0);
         var fieldWidth = columnWidth + 1; // cover right border
@@ -3040,7 +3066,7 @@ export class IrisGrid extends Component {
           onChange: this.handleFilterBarChange,
           onDone: this.handleFilterBarDone,
           onTab: this.handleFilterBarTab,
-          onContextMenu: (_this$grid29 = this.grid) === null || _this$grid29 === void 0 ? void 0 : _this$grid29.handleContextMenu,
+          onContextMenu: (_this$grid28 = this.grid) === null || _this$grid28 === void 0 ? void 0 : _this$grid28.handleContextMenu,
           debounceMs: debounceMs,
           value: _value5
         });
@@ -3408,7 +3434,7 @@ export class IrisGrid extends Component {
       movedColumns: movedColumns,
       customColumns: customColumns,
       hiddenColumns: hiddenColumns,
-      alwaysFetchColumns: this.getAlwaysFetchColumns(alwaysFetchColumns, model.columns, movedColumns, model.floatingLeftColumnCount, model.floatingRightColumnCount, (_this$grid30 = this.grid) === null || _this$grid30 === void 0 ? void 0 : (_this$grid30$state$dr = _this$grid30.state.draggingColumn) === null || _this$grid30$state$dr === void 0 ? void 0 : _this$grid30$state$dr.range),
+      alwaysFetchColumns: this.getAlwaysFetchColumns(alwaysFetchColumns, model.columns, movedColumns, model.floatingLeftColumnCount, model.floatingRightColumnCount, (_this$grid29 = this.grid) === null || _this$grid29 === void 0 ? void 0 : (_this$grid29$state$dr = _this$grid29.state.draggingColumn) === null || _this$grid29$state$dr === void 0 ? void 0 : _this$grid29$state$dr.range),
       formatColumns: this.getCachedPreviewFormatColumns(this.getCachedModelColumns(model, customColumns), conditionalFormats, conditionalFormatPreview,
       // Disable the preview format when we press Back on the format edit page
       ((_openOptions = openOptions[openOptions.length - 1]) === null || _openOptions === void 0 ? void 0 : _openOptions.type) === OptionType.CONDITIONAL_FORMATTING_EDIT ? conditionalFormatEditIndex !== null && conditionalFormatEditIndex !== void 0 ? conditionalFormatEditIndex : undefined : undefined),
@@ -3430,7 +3456,7 @@ export class IrisGrid extends Component {
         transform: "up-1"
       }),
       tooltip: "Table Options"
-    })), focusField, loadingElement, filterBar, columnTooltip, advancedFilterMenus, overflowButtonTooltipProps && this.getOverflowButtonTooltip(overflowButtonTooltipProps), expandCellTooltipProps && this.getExpandCellTooltip(expandCellTooltipProps)), /*#__PURE__*/React.createElement(GotoRow, {
+    })), focusField, loadingElement, filterBar, columnTooltip, advancedFilterMenus, overflowButtonTooltipProps && this.getOverflowButtonTooltip(overflowButtonTooltipProps), expandCellTooltipProps && this.getExpandCellTooltip(expandCellTooltipProps), linkHoverTooltipProps && this.getLinkHoverTooltip(linkHoverTooltipProps)), /*#__PURE__*/React.createElement(GotoRow, {
       model: model,
       isShown: isGotoShown,
       gotoRow: gotoRow,