@deephaven/dashboard-core-plugins 1.0.1-beta.0 → 1.1.0

package/dist/linker/Linker.js

@@ -13,12 +13,14 @@ import { DateTimeColumnFormatter, DateUtils, TableUtils } from '@deephaven/jsapi
 import Log from '@deephaven/log';
 import { Type as FilterType } from '@deephaven/filters';
 import { getActiveTool, getApi, getTimeZone, setActiveTool as setActiveToolAction } from '@deephaven/redux';
+import { assertNotNull } from '@deephaven/utils';
 import { getIsolatedLinkerPanelIdForDashboard, getLinksForDashboard, setDashboardLinks as setDashboardLinksAction, addDashboardLinks as addDashboardLinksAction, deleteDashboardLinks as deleteDashboardLinksAction, setDashboardIsolatedLinkerPanelId as setDashboardIsolatedLinkerPanelIdAction, setDashboardColumnSelectionValidator as setDashboardColumnSelectionValidatorAction } from "../redux/index.js";
 import ToolType from "./ToolType.js";
-import { ChartEvent, IrisGridEvent, InputFilterEvent } from "../events/index.js";
+import { ChartEvent, IrisGridEvent } from "../events/index.js";
 import LinkerOverlayContent from "./LinkerOverlayContent.js";
 import LinkerUtils, { isLinkablePanel, isLinkableColumn } from "./LinkerUtils.js";
 import { listenForFilterColumnsChanged } from "../FilterEvents.js";
+import { listenForLinkPointSelected, listenForLinkSourceDataSelected, listenForRegisterLinkTarget } from "./LinkerEvent.js";
 import { jsx as _jsx } from "react/jsx-runtime";
 var log = Log.module('Linker');
 var mapState = (state, ownProps) => ({
@@ -39,6 +41,7 @@ var connector = connect(mapState, {
 export class Linker extends Component {
   constructor(props) {
     super(props);
+    _defineProperty(this, "linkTargetPropMap", new Map());
     _defineProperty(this, "removerFns", []);
     _defineProperty(this, "getCachedLinks", memoize((links, linkInProgress, isolateForPanelId) => {
       var combinedLinks = [...links];
@@ -57,7 +60,6 @@ export class Linker extends Component {
     this.handleCancel = this.handleCancel.bind(this);
     this.handleDone = this.handleDone.bind(this);
     this.handlePanelCloned = this.handlePanelCloned.bind(this);
-    this.handleFilterColumnSelect = this.handleFilterColumnSelect.bind(this);
     this.handleColumnsChanged = this.handleColumnsChanged.bind(this);
     this.handlePanelClosed = this.handlePanelClosed.bind(this);
     this.handleLayoutStateChanged = this.handleLayoutStateChanged.bind(this);
@@ -69,6 +71,8 @@ export class Linker extends Component {
     this.handleUpdateValues = this.handleUpdateValues.bind(this);
     this.handleStateChange = this.handleStateChange.bind(this);
     this.handleExited = this.handleExited.bind(this);
+    this.handleLinkPointSelected = this.handleLinkPointSelected.bind(this);
+    this.handleTargetRegistered = this.handleTargetRegistered.bind(this);
     this.handleLinkSelected = this.handleLinkSelected.bind(this);
     this.handlePanelDragging = this.handlePanelDragging.bind(this);
     this.handlePanelDropped = this.handlePanelDropped.bind(this);
@@ -121,8 +125,7 @@ export class Linker extends Component {
     eventHub.on(IrisGridEvent.STATE_CHANGED, this.handleStateChange);
     eventHub.on(ChartEvent.COLUMN_SELECTED, this.handleChartColumnSelect);
     eventHub.on(PanelEvent.CLONED, this.handlePanelCloned);
-    eventHub.on(InputFilterEvent.COLUMN_SELECTED, this.handleFilterColumnSelect);
-    this.removerFns.push(listenForFilterColumnsChanged(eventHub, this.handleColumnsChanged));
+    this.removerFns = [listenForFilterColumnsChanged(eventHub, this.handleColumnsChanged), listenForLinkPointSelected(eventHub, this.handleLinkPointSelected), listenForLinkSourceDataSelected(eventHub, this.handleUpdateValues), listenForRegisterLinkTarget(eventHub, this.handleTargetRegistered)];
     eventHub.on(PanelEvent.CLOSE, this.handlePanelClosed);
     eventHub.on(PanelEvent.CLOSED, this.handlePanelClosed);
     eventHub.on(PanelEvent.DRAGGING, this.handlePanelDragging);
@@ -138,7 +141,6 @@ export class Linker extends Component {
     eventHub.off(IrisGridEvent.STATE_CHANGED, this.handleStateChange);
     eventHub.off(ChartEvent.COLUMN_SELECTED, this.handleChartColumnSelect);
     eventHub.off(PanelEvent.CLONED, this.handlePanelCloned);
-    eventHub.off(InputFilterEvent.COLUMN_SELECTED, this.handleFilterColumnSelect);
     eventHub.off(PanelEvent.CLOSE, this.handlePanelClosed);
     eventHub.off(PanelEvent.CLOSED, this.handlePanelClosed);
     eventHub.off(PanelEvent.DRAGGING, this.handlePanelDragging);
@@ -173,37 +175,9 @@ export class Linker extends Component {
     setActiveTool(ToolType.DEFAULT);
   }
   handleChartColumnSelect(panel, column) {
-    this.columnSelected(panel, column, true);
-  }
-  handleFilterColumnSelect(panel, column) {
-    log.debug('handleFilterColumnSelect', this.isOverlayShown());
-    var {
-      links,
-      localDashboardId,
-      setActiveTool,
-      setDashboardIsolatedLinkerPanelId
-    } = this.props;
     var panelId = LayoutUtils.getIdFromPanel(panel);
-    var panelLinks = links.filter(link => {
-      var _link$start2, _link$end2;
-      return ((_link$start2 = link.start) === null || _link$start2 === void 0 ? void 0 : _link$start2.panelId) === panelId || ((_link$end2 = link.end) === null || _link$end2 === void 0 ? void 0 : _link$end2.panelId) === panelId;
-    });
-    if (!this.isOverlayShown() && panelId != null) {
-      // Initial click on the filter source button with linker inactive
-      // Show linker in isolated mode for panel
-      setActiveTool(ToolType.LINKER);
-      setDashboardIsolatedLinkerPanelId(localDashboardId, panelId);
-      if (panelLinks.length === 0) {
-        // Source not linked - start new link in isolated linker mode
-        // Need to pass panelId for overrideIsolatedLinkerPanelId
-        // as redux prop update at this point not yet propagated
-        this.columnSelected(panel, column, true, panelId);
-      }
-      return;
-    }
-
-    // Filter source clicked with linker active
-    this.columnSelected(panel, column, true);
+    assertNotNull(panelId);
+    this.columnSelected(panelId, column, 'chartLink', true);
   }
   handleColumnsChanged(sourceId, columns) {
     log.debug('handleColumnsChanged', sourceId, columns);
@@ -236,19 +210,56 @@ export class Linker extends Component {
       log.debug2('Column is not filterable');
       return;
     }
-    this.columnSelected(panel, column);
+    var panelId = LayoutUtils.getIdFromPanel(panel);
+    assertNotNull(panelId);
+    this.columnSelected(panelId, column, 'tableLink');
+  }
+  handleLinkPointSelected(sourceId, column, options) {
+    var {
+      type
+    } = options;
+    var isIsolatedLinker = type === 'filterSource';
+    var isAlwaysEnd = type === 'chartLink' || type === 'filterSource';
+
+    // filterSource type should open in isolated linker mode
+    if (!this.isOverlayShown() && sourceId != null && isIsolatedLinker) {
+      var {
+        links,
+        localDashboardId,
+        setActiveTool,
+        setDashboardIsolatedLinkerPanelId
+      } = this.props;
+      var panelLinks = links.filter(link => {
+        var _link$start2, _link$end2;
+        return ((_link$start2 = link.start) === null || _link$start2 === void 0 ? void 0 : _link$start2.panelId) === sourceId || ((_link$end2 = link.end) === null || _link$end2 === void 0 ? void 0 : _link$end2.panelId) === sourceId;
+      });
+
+      // Initial click on the filter source button with linker inactive
+      // Show linker in isolated mode for panel
+      setActiveTool(ToolType.LINKER);
+      setDashboardIsolatedLinkerPanelId(localDashboardId, sourceId);
+      if (panelLinks.length === 0) {
+        // Source not linked - start new link in isolated linker mode
+        // Need to pass panelId for overrideIsolatedLinkerPanelId
+        // as redux prop update at this point not yet propagated
+        this.columnSelected(sourceId, column, type, isAlwaysEnd, sourceId);
+      }
+      return;
+    }
+    this.columnSelected(sourceId, column, type, isAlwaysEnd);
   }
 
   /**
    * Track a column selection and build the link from it.
-   * @param panel The panel component that is the source for the column selection
+   * @param sourceId The ID of the source for the column selection
    * @param column The column that was selected
+   * @param type The type of the link point
    * @param isAlwaysEndPoint True if the selection is always the end point, even if it's the first column selected. Defaults to false.
    * @param overrideIsolatedLinkerPanelId isolatedLinkerPanelId to use when method is called before prop changes propagate
    */
-  columnSelected(panel, column) {
-    var isAlwaysEndPoint = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-    var overrideIsolatedLinkerPanelId = arguments.length > 3 ? arguments[3] : undefined;
+  columnSelected(sourceId, column, type) {
+    var isAlwaysEndPoint = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+    var overrideIsolatedLinkerPanelId = arguments.length > 4 ? arguments[4] : undefined;
     if (overrideIsolatedLinkerPanelId === undefined && !this.isOverlayShown()) {
       return;
     }
@@ -258,11 +269,6 @@ export class Linker extends Component {
     var {
       linkInProgress
     } = this.state;
-    var panelId = LayoutUtils.getIdFromPanel(panel);
-    if (panelId == null) {
-      return;
-    }
-    var panelComponent = LayoutUtils.getComponentNameFromPanel(panel);
     var {
       name: columnName,
       type: columnType
@@ -271,36 +277,47 @@ export class Linker extends Component {
       var newLink = {
         id: nanoid(),
         start: {
-          panelId,
-          panelComponent,
+          panelId: sourceId,
           columnName,
           columnType
         },
-        // Link starts with type Invalid as linking a source to itself is not allowed
         type: 'invalid',
         isReversed: isAlwaysEndPoint
       };
+      if (isAlwaysEndPoint) {
+        newLink.endType = type;
+      }
       log.debug('starting link', newLink);
       this.setState({
         linkInProgress: newLink
       });
     } else {
+      var _linkInProgress$endTy;
       var {
         links
       } = this.props;
       var {
         start,
         id,
-        isReversed
+        isReversed = false
       } = linkInProgress;
       var end = {
-        panelId,
-        panelComponent,
+        panelId: sourceId,
         columnName,
         columnType
       };
-      var type = LinkerUtils.getLinkType(isReversed !== undefined && isReversed ? end : start, isReversed !== undefined && isReversed ? start : end, overrideIsolatedLinkerPanelId !== null && overrideIsolatedLinkerPanelId !== void 0 ? overrideIsolatedLinkerPanelId : isolatedLinkerPanelId);
-      switch (type) {
+      var isValid = !(isReversed && isAlwaysEndPoint) &&
+      // Cannot add a point which is only an end when we already have an end
+      LinkerUtils.isLinkValid(isReversed ? end : start, isReversed ? start : end, overrideIsolatedLinkerPanelId !== null && overrideIsolatedLinkerPanelId !== void 0 ? overrideIsolatedLinkerPanelId : isolatedLinkerPanelId);
+      if (!isValid) {
+        log.debug('Ignore invalid link connection', linkInProgress, end);
+        return;
+      }
+
+      // The end point is what determines the type
+      // If the link is reversed, we already set the type on the linkInProgress
+      var finalType = (_linkInProgress$endTy = linkInProgress.endType) !== null && _linkInProgress$endTy !== void 0 ? _linkInProgress$endTy : type;
+      switch (finalType) {
         case 'invalid':
           log.debug('Ignore invalid link connection', linkInProgress, end);
           return;
@@ -347,10 +364,10 @@ export class Linker extends Component {
 
       // Create a completed link from link in progress
       var _newLink = {
-        start: isReversed !== undefined && isReversed ? end : start,
-        end: isReversed !== undefined && isReversed ? start : end,
+        start: isReversed ? end : start,
+        end: isReversed ? start : end,
         id,
-        type,
+        type: finalType,
         operator: FilterType.eq
       };
       log.info('creating link', _newLink);
@@ -370,6 +387,7 @@ export class Linker extends Component {
       panelManager
     } = this.props;
     if (link.end) {
+      var _linkTargetPropMap$ge;
       var {
         end
       } = link;
@@ -378,9 +396,17 @@ export class Linker extends Component {
         columnName,
         columnType
       } = end;
+      var {
+        linkTargetPropMap
+      } = this;
+      var unsetFilterValue = (_linkTargetPropMap$ge = linkTargetPropMap.get(panelId)) === null || _linkTargetPropMap$ge === void 0 ? void 0 : _linkTargetPropMap$ge.unsetFilterValue;
+      if (unsetFilterValue) {
+        unsetFilterValue(columnName, columnType);
+        return;
+      }
       var endPanel = panelManager.getOpenedPanelById(panelId);
       if (!endPanel) {
-        log.debug('endPanel no longer exists, ignoring unsetFilterValue', panelId);
+        log.debug('endPanel no longer exists or target is not a panel. Ignoring unsetFilterValue', panelId);
       } else if (isLinkablePanel(endPanel)) {
         endPanel.unsetFilterValue(columnName, columnType);
       } else {
@@ -395,13 +421,22 @@ export class Linker extends Component {
    * @param filterMap Map of column name to column type, text, and value
    */
   setPanelFilterMap(panelId, filterMap) {
+    var _linkTargetPropMap$ge2;
     log.debug('Set filter data for panel:', panelId, filterMap);
     var {
       panelManager
     } = this.props;
+    var {
+      linkTargetPropMap
+    } = this;
+    var setFilterValues = (_linkTargetPropMap$ge2 = linkTargetPropMap.get(panelId)) === null || _linkTargetPropMap$ge2 === void 0 ? void 0 : _linkTargetPropMap$ge2.setFilterValues;
+    if (setFilterValues) {
+      setFilterValues(filterMap);
+      return;
+    }
     var panel = panelManager.getOpenedPanelById(panelId);
     if (!panel) {
-      log.debug('panel no longer exists, ignoring setFilterMap', panelId);
+      log.debug('panel no longer exists or target is not a panel. Ignoring setFilterMap', panelId);
     } else if (isLinkablePanel(panel)) {
       panel.setFilterMap(filterMap);
     } else {
@@ -465,8 +500,17 @@ export class Linker extends Component {
       log.error('Unable to find link to delete', linkId);
     }
   }
-  handleUpdateValues(panel, dataMap) {
-    var panelId = LayoutUtils.getIdFromPanel(panel);
+  handleTargetRegistered(sourceId, handlers) {
+    var {
+      linkTargetPropMap
+    } = this;
+    if (handlers == null) {
+      linkTargetPropMap.delete(sourceId);
+    } else {
+      linkTargetPropMap.set(sourceId, handlers);
+    }
+  }
+  handleUpdateValues(sourceId, dataMap) {
     var {
       dh,
       links,
@@ -482,15 +526,17 @@ export class Linker extends Component {
         end,
         operator
       } = links[i];
-      if (start.panelId === panelId && end != null) {
+      if (start.panelId === sourceId && end != null && operator != null) {
+        var _filterMap$get$filter, _filterMap$get;
         var {
           panelId: endPanelId,
           columnName,
           columnType
         } = end;
         // Map of column name to column type and filter value
-        var filterMap = panelFilterMap.has(endPanelId) ? panelFilterMap.get(endPanelId) : new Map();
-        var filterList = filterMap.has(columnName) === true ? filterMap.get(columnName).filterList : [];
+        var existingFilterMap = panelFilterMap.get(endPanelId);
+        var filterMap = existingFilterMap !== null && existingFilterMap !== void 0 ? existingFilterMap : new Map();
+        var filterList = (_filterMap$get$filter = (_filterMap$get = filterMap.get(columnName)) === null || _filterMap$get === void 0 ? void 0 : _filterMap$get.filterList) !== null && _filterMap$get$filter !== void 0 ? _filterMap$get$filter : [];
         var {
           visibleIndex: startColumnIndex,
           isExpandable,
@@ -514,13 +560,12 @@ export class Linker extends Component {
           // The values are Dates for dateType values, not string like everything else
           text = dateFilterFormatter.format(value);
         }
-        var filter = {
+        filterList.push({
           operator,
           text,
           value,
           startColumnIndex
-        };
-        filterList.push(filter);
+        });
         filterMap.set(columnName, {
           columnType,
           filterList
@@ -658,17 +703,23 @@ export class Linker extends Component {
       return null;
     });
   }
-  isColumnSelectionValid(panel, tableColumn) {
+  isColumnSelectionValid(panelOrId, tableColumn, options) {
+    var _linkInProgress$endTy2;
     var {
       linkInProgress
     } = this.state;
     var {
       isolatedLinkerPanelId
     } = this.props;
+    // This is backwards compatibility for Grizzly Enterprise panels
+    // IrisGridPanel is the only allowed start point for a link
+    // The enterprise panels will not call this method with options
+    // They are also JS and removed in sanluis, so figure this is best for now
+    var isAlwaysEnd = typeof panelOrId === 'string' ? options.type === 'filterSource' || options.type === 'chartLink' : LayoutUtils.getComponentNameFromPanel(panelOrId) !== 'IrisGridPanel';
     if (tableColumn == null) {
       if ((linkInProgress === null || linkInProgress === void 0 ? void 0 : linkInProgress.start) != null) {
         // Link started, end point is not a valid target
-        this.updateLinkInProgressType();
+        this.updateLinkInProgressType('invalid');
       }
       return false;
     }
@@ -687,22 +738,27 @@ export class Linker extends Component {
       return true;
     }
     var {
-      isReversed,
+      isReversed = false,
       start
     } = linkInProgress;
-    var panelId = LayoutUtils.getIdFromPanel(panel);
+    var panelId = typeof panelOrId === 'string' ? panelOrId : LayoutUtils.getIdFromPanel(panelOrId);
     if (panelId == null) {
       return false;
     }
+
+    // We've already selected an end point, so we can't select another one
+    if (isReversed && isAlwaysEnd) {
+      this.updateLinkInProgressType('invalid');
+      return false;
+    }
     var end = {
       panelId,
-      panelComponent: LayoutUtils.getComponentNameFromPanel(panel),
       columnName: tableColumn.name,
       columnType: tableColumn.type
     };
-    var type = isReversed !== undefined && isReversed ? LinkerUtils.getLinkType(end, start, isolatedLinkerPanelId) : LinkerUtils.getLinkType(start, end, isolatedLinkerPanelId);
-    this.updateLinkInProgressType(type);
-    return type !== 'invalid';
+    var isValid = isReversed ? LinkerUtils.isLinkValid(end, start, isolatedLinkerPanelId) : LinkerUtils.isLinkValid(start, end, isolatedLinkerPanelId);
+    this.updateLinkInProgressType(isValid ? (_linkInProgress$endTy2 = linkInProgress.endType) !== null && _linkInProgress$endTy2 !== void 0 ? _linkInProgress$endTy2 : options.type : 'invalid');
+    return isValid;
   }
   render() {
     var {
@@ -734,7 +790,8 @@ export class Linker extends Component {
         onAllLinksDeleted: this.handleAllLinksDeleted,
         onLinksUpdated: this.handleLinksUpdated,
         onDone: this.handleDone,
-        onCancel: this.handleCancel
+        onCancel: this.handleCancel,
+        linkTargetPropMap: this.linkTargetPropMap
       })
     }) : null;
   }