@adaptabletools/adaptable 18.1.0-canary.0 → 18.1.0

package/src/View/Components/FilterForm/QuickFilterValues.js

@@ -1,41 +1,17 @@
+import { isSameDay } from 'date-fns';
+import { Resizable } from 're-resizable';
 import * as React from 'react';
 import { useCallback, useEffect, useRef } from 'react';
+import { Flex } from 'rebass';
 import ArrayExtensions from '../../../Utilities/Extensions/ArrayExtensions';
-import SimpleButton from '../../../components/SimpleButton';
-import { isSameDay } from 'date-fns';
 import OverlayTrigger from '../../../components/OverlayTrigger';
-import { Flex } from 'rebass';
+import SimpleButton from '../../../components/SimpleButton';
 import { ListBoxFilterForm } from './ListBoxFilterForm';
-import { Resizable } from 're-resizable';
 export const QuickFilterValues = (props) => {
     const { api } = props;
     const currentOverlayVisible = useRef(false);
     const valuesDropdownRef = React.useRef(null);
     const [quickFilterValues, setQuickFilterValues] = React.useState({ values: [], suppressClientSideFilter: false, dataLoadIsComplete: false });
-    const quickFilterValuesWithPredicates = React.useMemo(() => {
-        var _a, _b, _c;
-        let values = quickFilterValues.values;
-        const predicateIds = api.columnFilterApi.internalApi.getValuesFitlerPredicateIds(props.currentColumn);
-        if (ArrayExtensions.IsNullOrEmpty(predicateIds)) {
-            return values;
-        }
-        const predicatesPosition = (_c = (_b = (_a = api.optionsApi.getColumnFilterOptions()) === null || _a === void 0 ? void 0 : _a.valuesFilterOptions) === null || _b === void 0 ? void 0 : _b.predicatesPosition) !== null && _c !== void 0 ? _c : 'End';
-        const predicateValues = predicateIds.map(predicateId => {
-            var _a;
-            const predicateDef = api.predicateApi.getPredicateDefById(predicateId);
-            return {
-                value: predicateId,
-                label: ((_a = predicateDef.label) !== null && _a !== void 0 ? _a : predicateId),
-            };
-        });
-        if (predicatesPosition === 'End') {
-            values = [...values, ...predicateValues];
-        }
-        else {
-            values = [...predicateValues, ...values];
-        }
-        return values;
-    }, [quickFilterValues.values]);
     const [isDistinctColumnValuesLoading, setIsDistinctColumnValuesLoading] = React.useState(false);
     const [textFilterValue, setTextFilterValue] = React.useState('');
     const [valuesLoadTrigger, setValuesLoadTrigger] = React.useState({
@@ -72,7 +48,7 @@ export const QuickFilterValues = (props) => {
         let ignore = false;
         setIsDistinctColumnValuesLoading(true);
         api.gridApi.internalApi
-            .getDistinctFilterDisplayValuesForColumn(props.columnFilter.ColumnId, textFilterValue, api.optionsApi.getColumnFilterOptions().valuesFilterOptions.showDistinctFilteredValuesOnly)
+            .getDistinctFilterDisplayValuesForColumnForFiltersUI(props.columnFilter.ColumnId, textFilterValue, api.optionsApi.getColumnFilterOptions().valuesFilterOptions.showCurrentlyFilteredValuesOnly)
             .then((distinctFilterDisplayValues) => {
             if (ignore) {
                 return;
@@ -126,13 +102,13 @@ export const QuickFilterValues = (props) => {
     let selectedValues = props.columnFilter.Predicate.PredicateId === 'Values' ? 'Select Values' : 'Exclude Values';
     if (props.columnFilter.Predicate.Inputs.length) {
         selectedValues = props.columnFilter.Predicate.Inputs.map((input) => {
-            var _a;
-            const label = (_a = quickFilterValuesWithPredicates === null || quickFilterValuesWithPredicates === void 0 ? void 0 : quickFilterValuesWithPredicates.find((distinctValue) => {
+            var _a, _b;
+            const label = (_b = (_a = quickFilterValues.values) === null || _a === void 0 ? void 0 : _a.find((distinctValue) => {
                 if (input instanceof Date) {
                     return isSameDay(input, distinctValue.value);
                 }
                 return distinctValue.value === input;
-            })) === null || _a === void 0 ? void 0 : _a.label;
+            })) === null || _b === void 0 ? void 0 : _b.label;
             return label !== null && label !== void 0 ? label : input;
         }).join(', ');
     }
@@ -147,6 +123,7 @@ export const QuickFilterValues = (props) => {
         }
         return null;
     };
+    const [defaultSize, setDefaultSize] = React.useState(undefined);
     return (React.createElement(OverlayTrigger, { showEvent: showEvent, 
         // cannot hide on blur, because the form input receives the input when this is opened
         hideEvent: "mouseleave", hideDelay: 50, ref: (api) => {
@@ -160,18 +137,24 @@ export const QuickFilterValues = (props) => {
             }
         }, render: ({ targetWidth }) => {
             var _a;
-            return (React.createElement(Resizable, { style: {
+            return (React.createElement(Resizable, { onResizeStop: (_e, _direction, element, _delta) => {
+                    const { width, height } = element.getBoundingClientRect();
+                    setDefaultSize({ width, height });
+                }, defaultSize: defaultSize, style: {
                     fontSize: 'var(--ab-font-size-2)',
                     border: '1px solid var(--ab-color-primarydark)',
                     background: 'var(--ab-color-defaultbackground)',
                     zIndex: 1000,
+                    display: 'flex',
+                    flexFlow: 'column',
+                    flexWrap: 'nowrap',
                 }, enable: {
                     top: false,
                     right: true,
-                    bottom: false,
+                    bottom: true,
                     left: false,
                     topRight: false,
-                    bottomRight: false,
+                    bottomRight: true,
                     bottomLeft: false,
                     topLeft: false,
                 }, minWidth: getPopoverWidth(targetWidth) },
@@ -187,13 +170,7 @@ export const QuickFilterValues = (props) => {
                                 (_a = valuesDropdownRef.current) === null || _a === void 0 ? void 0 : _a.show();
                             });
                         }
-                    }, "data-name": "quick-filter-form", flexDirection: "column", style: {
-                    // fontSize: 'var(--ab-font-size-2)',
-                    // border: '1px solid var(--ab-color-primarydark)',
-                    // background: 'var(--ab-color-defaultbackground)',
-                    // zIndex: 1000,
-                    // width: getPopoverWidth(targetWidth),
-                    } },
+                    }, "data-name": "quick-filter-form", flexDirection: "column", flex: 1, display: 'flex' },
                     React.createElement(Flex, { m: 2 },
                         React.createElement(SimpleButton, { onClick: () => clearColumnFilter() }, "Clear Filter"),
                         ((_a = api.optionsApi.getColumnFilterOptions()) === null || _a === void 0 ? void 0 : _a.autoApplyFilter) == false && (React.createElement(SimpleButton, { ml: 2, onClick: () => {
@@ -201,7 +178,7 @@ export const QuickFilterValues = (props) => {
                                     props.updateColumnFilter(transientColumnFilter);
                                 }
                             } }, "Apply Filter"))),
-                    React.createElement(ListBoxFilterForm, { disabled: props.isFilterDisabled, suppressClientSideFilter: quickFilterValues.suppressClientSideFilter, isLoading: isDistinctColumnValuesLoading, onFilterChange: handleFilterChange, currentColumn: props.currentColumn, columns: [], columnDistinctValues: quickFilterValuesWithPredicates, dataType: props.currentColumn.dataType, uiSelectedColumnValues: props.columnFilter.Predicate.Inputs.filter((input) => input !== ''), useAgGridStyle: true, onColumnValueSelectedChange: (list) => onColumnValueSelectedChange(list) }))));
+                    React.createElement(ListBoxFilterForm, { disabled: props.isFilterDisabled, suppressClientSideFilter: quickFilterValues.suppressClientSideFilter, isLoading: isDistinctColumnValuesLoading, onFilterChange: handleFilterChange, currentColumn: props.currentColumn, columns: [], columnDistinctValues: quickFilterValues.values, dataType: props.currentColumn.dataType, uiSelectedColumnValues: props.columnFilter.Predicate.Inputs.filter((input) => input !== ''), useAgGridStyle: true, onColumnValueSelectedChange: (list) => onColumnValueSelectedChange(list) }))));
         } },
         React.createElement(SimpleButton, { "data-name": 'Select Values', style: {
                 flex: 1,

package/src/View/Components/Selectors/PermittedValuesSelector.js

@@ -18,7 +18,7 @@ export const PermittedValuesSelector = function (props) {
         setIsLoading(true);
         (async () => {
             const { values: distinctColumnValues } = await runIfNotResolvedIn(adaptable.api.gridApi.internalApi.getDistinctFilterDisplayValuesForColumn(props.columnId, filter, adaptable.api.optionsApi.getColumnFilterOptions().valuesFilterOptions
-                .showDistinctFilteredValuesOnly), () => {
+                .showCurrentlyFilteredValuesOnly), () => {
                 setIsLoading(true);
             });
             setIsLoading(false);

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -2,7 +2,7 @@ import { AdaptableOptions } from '../AdaptableOptions/AdaptableOptions';
 import { ChartRef, Column, GridApi, GridOptions, IRowNode, Module, RowModelType } from '@ag-grid-community/core';
 import { AdaptableLogger } from './AdaptableLogger';
 import { AdaptableApi } from '../Api/AdaptableApi';
-import { DistinctValuesParams, IAdaptable } from '../AdaptableInterfaces/IAdaptable';
+import { DistinctColumnValuesParams, IAdaptable } from '../AdaptableInterfaces/IAdaptable';
 import { EmitterCallback } from '../Utilities/Emitter';
 import { AdaptablePlugin } from '../AdaptableOptions/AdaptablePlugin';
 import { AgGridAdapter } from './AgGridAdapter';
@@ -195,6 +195,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
     updateColumnModelAndRefreshGrid(config?: {
         skipColDefsRefresh?: boolean;
+        preemptiveColumnStateRefresh?: boolean;
     }): void;
     redrawBody(): void;
     refreshHeader(): void;
@@ -237,13 +238,12 @@ export declare class AdaptableAgGrid implements IAdaptable {
     autoSizeAllColumns(): void;
     setColumnOrder(VisibleColumnList: string[]): void;
     private getSortedColumnStateForVisibleColumns;
-    getDistinctValuesForColumn(column: AdaptableColumn, distinctValuesParams: DistinctValuesParams): GridCell[];
+    getDistinctValuesForColumn(column: AdaptableColumn, distinctValuesParams: DistinctColumnValuesParams): GridCell[];
     private getGridCellsForPermittedValues;
     private getDistinctGridCellsForColumn;
-    addBlankValueToGridCell(gridCell: GridCell): void;
     private addDistinctColumnValue;
     private getUniqueGridCells;
-    getGridCellsForColumn(columnId: string, includeBlanks?: boolean): GridCell[] | undefined;
+    getGridCellsForColumn(columnId: string, includeBlanks?: boolean, onlyVisibleRows?: boolean): GridCell[] | undefined;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): any[];
     getRowNodeByIndex(index: number): IRowNode;
     getAgGridStatusPanels(): import("@ag-grid-community/core").StatusPanelDef[];

package/src/agGrid/AdaptableAgGrid.js

@@ -8,7 +8,7 @@ import Emitter from '../Utilities/Emitter';
 import { applyDefaultAdaptableOptions } from './defaultAdaptableOptions';
 import { AgGridAdapter } from './AgGridAdapter';
 import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
-import { AB_FDC3_COLUMN, AB_SPECIAL_COLUMN, ADAPTABLE_ROW_ACTION_BUTTONS, AUTOGENERATED_PK_COLUMN, BLANK_DISTINCT_COLUMN_VALUE, DARK_THEME, DEFAULT_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, LIGHT_THEME, } from '../Utilities/Constants/GeneralConstants';
+import { AB_FDC3_COLUMN, AB_SPECIAL_COLUMN, ADAPTABLE_ROW_ACTION_BUTTONS, AUTOGENERATED_PK_COLUMN, DARK_THEME, DEFAULT_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, LIGHT_THEME, } from '../Utilities/Constants/GeneralConstants';
 import { DataService } from '../Utilities/Services/DataService';
 import { AdaptableStore } from '../Redux/Store/AdaptableStore';
 import { AdaptableApiImpl } from '../Api/Implementation/AdaptableApiImpl';
@@ -1815,6 +1815,12 @@ export class AdaptableAgGrid {
         if (result == undefined && rowNode.data) {
             result = rowNode.data[this.adaptableOptions.primaryKey];
         }
+        if (result == undefined && rowNode.id != undefined) {
+            // when getPrimaryKeyValueFromRowNode is called for group rows,
+            // which don't have a rowNode.data object, the result is undefined
+            // but we do have an id property on the rowNode object, so we'll use that
+            result = rowNode.id;
+        }
         return result;
     }
     getRawValueFromRowNode(rowNode, columnId) {
@@ -1892,6 +1898,9 @@ export class AdaptableAgGrid {
         return rawValue;
     }
     updateColumnModelAndRefreshGrid(config) {
+        if (config === null || config === void 0 ? void 0 : config.preemptiveColumnStateRefresh) {
+            this.deriveAdaptableColumnStateFromAgGrid();
+        }
         if (!(config === null || config === void 0 ? void 0 : config.skipColDefsRefresh)) {
             this.refreshColDefs();
         }
@@ -2300,13 +2309,10 @@ export class AdaptableAgGrid {
     }
     getDistinctGridCellsForColumn(column, distinctValuesParams) {
         let gridCells = [];
-        if (distinctValuesParams.visibleRowsOnly) {
+        if (distinctValuesParams.visibleRowsOnly === true) {
             this.agGridAdapter.getAgGridApi().forEachNodeAfterFilter((rowNode) => {
                 const gridCell = this.addDistinctColumnValue(rowNode, column.columnId);
                 if (gridCell && gridCell.rowNode !== distinctValuesParams.skipRowNode) {
-                    if (gridCell.rawValue == undefined && distinctValuesParams.addBlankValue) {
-                        this.addBlankValueToGridCell(gridCell);
-                    }
                     gridCells.push(gridCell);
                 }
             });
@@ -2315,20 +2321,12 @@ export class AdaptableAgGrid {
             this.agGridAdapter.getAgGridApi().forEachNode((rowNode) => {
                 const gridCell = this.addDistinctColumnValue(rowNode, column.columnId);
                 if (gridCell && gridCell.rowNode !== distinctValuesParams.skipRowNode) {
-                    if (gridCell.rawValue == undefined && distinctValuesParams.addBlankValue) {
-                        this.addBlankValueToGridCell(gridCell);
-                    }
                     gridCells.push(gridCell);
                 }
             });
         }
         return gridCells;
     }
-    addBlankValueToGridCell(gridCell) {
-        gridCell.rawValue = BLANK_DISTINCT_COLUMN_VALUE;
-        gridCell.displayValue = BLANK_DISTINCT_COLUMN_VALUE;
-        gridCell.normalisedValue = BLANK_DISTINCT_COLUMN_VALUE;
-    }
     addDistinctColumnValue(rowNode, columnId) {
         // we do not return the values of the aggregates when in grouping mode
         // otherwise they would appear in the filter dropdown etc....
@@ -2355,9 +2353,9 @@ export class AdaptableAgGrid {
         }
         return uniqueVals.slice(0, this.api.columnFilterApi.internalApi.getFilterValuesMaxNumberOfItems(column));
     }
-    getGridCellsForColumn(columnId, includeBlanks = false) {
+    getGridCellsForColumn(columnId, includeBlanks = false, onlyVisibleRows = false) {
         let returnValues = [];
-        this.agGridAdapter.getAgGridApi().forEachNode((rowNode) => {
+        const handler = (rowNode) => {
             const gridCell = this.getGridCellFromRowNode(rowNode, columnId);
             if (gridCell) {
                 if (gridCell.rawValue == undefined || gridCell.rawValue == null) {
@@ -2369,7 +2367,13 @@ export class AdaptableAgGrid {
                     returnValues.push(gridCell);
                 }
             }
-        });
+        };
+        if (onlyVisibleRows) {
+            this.agGridAdapter.getAgGridApi().forEachNodeAfterFilter(handler);
+        }
+        else {
+            this.agGridAdapter.getAgGridApi().forEachNode(handler);
+        }
         return returnValues;
     }
     getRowNodesForPrimaryKeys(primaryKeyValues) {
@@ -3739,6 +3743,7 @@ export class AdaptableAgGrid {
      */
     updateLayoutFromGrid() {
         var _a, _b;
+        this.logger.info('updateLayoutFromGrid()');
         const agGridApi = this.agGridAdapter.getAgGridApi();
         const columnState = agGridApi.getColumnState();
         const expandedState = agGridApi.getState().rowGroupExpansion || { expandedRowGroupIds: [] };

package/src/agGrid/FilterWrapper.js

@@ -27,16 +27,21 @@ export const FilterWrapperFactory = (adaptable) => {
             const [filterProps, setFilterProps] = useState(null);
             const colId = props.column.getId();
             const column = adaptable.api.columnApi.getColumnWithColumnId(colId);
+            const afterGuidAttached = React.useCallback((params) => {
+                var _a;
+                const hidePopup = (_a = params === null || params === void 0 ? void 0 : params.hidePopup) !== null && _a !== void 0 ? _a : null;
+                const filterProps = getFilterProps(colId, !!hidePopup);
+                adaptable.hideFilterFormPopup = hidePopup;
+                setFilterProps(filterProps);
+            }, [colId]);
+            React.useEffect(() => {
+                afterGuidAttached();
+            }, []);
             useImperativeHandle(ref, () => {
                 return {
                     isFilterActive: () => isFilterActive(colId),
-                    afterGuiAttached: (params) => {
-                        var _a;
-                        const hidePopup = (_a = params === null || params === void 0 ? void 0 : params.hidePopup) !== null && _a !== void 0 ? _a : null;
-                        const filterProps = getFilterProps(colId, !!hidePopup);
-                        adaptable.hideFilterFormPopup = hidePopup;
-                        setFilterProps(filterProps);
-                    },
+                    // left here for backward compatibility
+                    afterGuidAttached,
                     getModel: () => { },
                     setModel: () => { },
                     //we do not filter here.... we filter using the doesExternalFilterPass. Not sure there is a difference....

package/src/agGrid/defaultAdaptableOptions.js

@@ -189,10 +189,10 @@ const DefaultAdaptableOptions = {
             valuesFilterTrigger: 'mouseenter',
             sortValuesFilter: false,
             filterValuesUsingTime: false,
-            showDistinctFilteredValuesOnly: false,
+            showCurrentlyFilteredValuesOnly: false,
             maxFilterValuesToDisplay: undefined,
-            includeBlankFilterValues: false,
             showValuesCount: undefined,
+            valuesFilterPredicateOptions: undefined,
         },
         indicateFilteredColumns: true,
         useAdaptableColumnFiltering: true,

package/src/components/ExpressionEditor/EditorInput.js

@@ -17,7 +17,7 @@ function EditorInput(props) {
         if (type === 'aggregatedScalar') {
             const excludeSet = new Set([
                 // we cannot have a hardcodede set of functions,
-                // we need to allow custom expresions
+                // we need to allow custom expressions
                 ...cumulativeAggregatedExpressionFunctions,
                 ...quantileAggregatedExpressionFunctions,
             ]);

package/src/components/ExpressionEditor/index.js

@@ -87,9 +87,7 @@ export function ExpressionEditor(props) {
                     StringExtensions.IsNullOrEmpty(expressionText === null || expressionText === void 0 ? void 0 : expressionText.trim()) && renderQueryHints(type),
                     showDocumentationLinks && (React.createElement(HelpBlock, { "data-name": "query-documentation", mt: 2, mb: 2, fontSize: 3 },
                         React.createElement(ButtonInfo, { mr: 2, onClick: () => window.open(queryDocumentationLink, '_blank') }),
-                        "See ",
-                        StringExtensions.CapitaliseFirstLetter(type),
-                        " Query documentation for more details and examples")),
+                        "See documentation for more details and examples")),
                     React.createElement(Box, { flex: 1 }),
                     showNamedQueryStuff && saveAsNamedQueryElement),
                 React.createElement(Box, { className: `${baseClassName}__sidebar`, "data-name": "expression-sidebar", pb: 2, paddingLeft: 2, pr: 2 },

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1716641872713 || Date.now(),
-    VERSION: "18.1.0-canary.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1717156602322 || Date.now(),
+    VERSION: "18.1.0" || '--current-version--',
 };

package/src/metamodel/adaptable.metamodel.d.ts

@@ -3787,6 +3787,11 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    IsRowFilterableContext: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     Layout: {
         name: string;
         kind: string;
@@ -5475,6 +5480,7 @@ export declare const ADAPTABLE_METAMODEL: {
             noCode: string;
             defVal: string;
             gridInfo?: undefined;
+            ref?: undefined;
         } | {
             name: string;
             kind: string;
@@ -5483,22 +5489,59 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo: string;
             noCode: string;
             defVal: string;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo: string;
+            defVal: string;
+            noCode?: undefined;
+            ref?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
+            ref: string;
             noCode?: undefined;
             defVal?: undefined;
             gridInfo?: undefined;
+        })[];
+    };
+    ValuesFilterPredicateContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+        })[];
+    };
+    ValuesFilterPredicateOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+            defVal?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
-            gridInfo: string;
             defVal: string;
-            noCode?: undefined;
         })[];
     };
     WeightedAverageAggregation: {