@adaptabletools/adaptable 20.2.6 → 20.2.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.2.6",
+  "version": "20.2.7",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/Api/GridApi.d.ts

@@ -503,10 +503,10 @@ export interface GridApi {
      */
     refreshRowNode(rowNode: IRowNode): void;
     /**
-     * Forces a re-render of the given rows
+     * Forces re-render of given rows (if none provided, all rows are refreshed)
      * @param rowNodes AG Grid rows
      */
-    refreshRowNodes(rowNodes: IRowNode[]): void;
+    refreshRowNodes(rowNodes?: IRowNode[]): void;
     /**
      * Forces a re-render of all Group Rows (including aggregations)
      */

package/src/Api/GridFilterApi.d.ts

@@ -1,4 +1,4 @@
-import { GridFilter } from '../types';
+import { GridFilter, NamedQuery } from '../types';
 /**
  * Provides run-time access to Grid Filter section of Adaptable State.
  */
@@ -8,6 +8,10 @@ export interface GridFilterApi {
      * @returns Grid Filter
      */
     getCurrentGridFilter(): GridFilter | undefined;
+    /**
+     * Re-applies the Grid Filter
+     */
+    reApplyGridFilter(): void;
     /**
      * Retrieves the Grid Filter's Expression from the current layout
      * @returns Grid Filter Expression
@@ -18,6 +22,11 @@ export interface GridFilterApi {
      * @param expression filter string
      */
     setGridFilterExpression(expression: string): void;
+    /**
+     * Sets the Grid Filter (for the current layout)
+     * @param namedQuery: NamedQuery to use
+     */
+    setGridFilterExpressionUsingNamedQuery(namedQuery: NamedQuery): void;
     /**
      * Clears the Grid Filter (for the current Layout)
      */

package/src/Api/Implementation/GridApiImpl.d.ts

@@ -126,7 +126,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     refreshColumns(columnIds: string[]): void;
     refreshRowByPrimaryKey(primaryKey: any): void;
     refreshRowNode(rowNode: IRowNode): void;
-    refreshRowNodes(rowNodes: IRowNode[]): void;
+    refreshRowNodes(rowNodes?: IRowNode[]): void;
     refreshGroupRowNodes(): void;
     isCellEditable(gridCell: GridCell): boolean;
     isCellEdited(gridCell: GridCell): boolean;

package/src/Api/Implementation/GridFilterApiImpl.d.ts

@@ -2,13 +2,15 @@ import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { GridFilterApi } from '../GridFilterApi';
 import { GridFilterInternalApi } from '../Internal/GridFilterInternalApi';
 import { ApiBase } from './ApiBase';
-import { GridFilter } from '../../types';
+import { GridFilter, NamedQuery } from '../../types';
 export declare class GridFilterApiImpl extends ApiBase implements GridFilterApi {
     internalApi: GridFilterInternalApi;
     constructor(_adaptable: IAdaptable);
+    reApplyGridFilter(): void;
     getCurrentGridFilter(): GridFilter | undefined;
     getCurrentGridFilterExpression(): string | undefined;
     setGridFilterExpression(filter: string): void;
+    setGridFilterExpressionUsingNamedQuery(namedQuery: NamedQuery): void;
     clearGridFilter(): void;
     openUIEditorForGridFilter(expression?: string): void;
     suspendGridFilter(): void;

package/src/Api/Implementation/GridFilterApiImpl.js

@@ -8,6 +8,12 @@ export class GridFilterApiImpl extends ApiBase {
         super(_adaptable);
         this.internalApi = new GridFilterInternalApi(_adaptable);
     }
+    reApplyGridFilter() {
+        const currentGridFilter = this.getCurrentGridFilter();
+        if (currentGridFilter?.Expression) {
+            this.setGridFilterExpression(currentGridFilter.Expression);
+        }
+    }
     getCurrentGridFilter() {
         return this.getLayoutApi().getCurrentLayout()?.GridFilter;
     }
@@ -21,6 +27,10 @@ export class GridFilterApiImpl extends ApiBase {
     setGridFilterExpression(filter) {
         this.dispatchAction(LayoutRedux.LayoutGridFilterSet(filter));
     }
+    setGridFilterExpressionUsingNamedQuery(namedQuery) {
+        const expressionString = 'QUERY("' + namedQuery.Name + '")';
+        this.setGridFilterExpression(expressionString);
+    }
     clearGridFilter() {
         this.dispatchAction(LayoutRedux.LayoutGridFilterClear());
     }

package/src/Api/Implementation/LayoutHelpers.js

@@ -161,7 +161,7 @@ export const tableLayoutToTableLayoutModel = (tableLayout) => {
         };
     });
     const result = simplifyTableLayoutModel({
-        Ignore_Name: tableLayout.Name,
+        Name: tableLayout.Name,
         SuppressAggFuncInHeader: tableLayout.SuppressAggFuncInHeader,
         TableColumns: tableLayout.TableColumns,
         ColumnWidths: tableLayout.ColumnWidths,
@@ -223,7 +223,7 @@ export const pivotLayoutToPivotLayoutModel = (pivotLayout) => {
     pivotLayout = structuredClone(pivotLayout);
     cleanupAdaptableObjectPrimitives(pivotLayout);
     const result = simplifyPivotLayoutModel({
-        Ignore_Name: pivotLayout.Name,
+        Name: pivotLayout.Name,
         SuppressAggFuncInHeader: pivotLayout.SuppressAggFuncInHeader,
         ColumnWidths: pivotLayout.ColumnWidths,
         ColumnVisibility: pivotLayout.ColumnVisibility,
@@ -292,7 +292,7 @@ function toAggFunc(aggFunc) {
 }
 export const tableLayoutModelToTableLayout = (layoutModel) => {
     const tableLayout = {
-        Name: layoutModel.Ignore_Name,
+        Name: layoutModel.Name,
         TableColumns: layoutModel.TableColumns,
         ColumnWidths: layoutModel.ColumnWidths,
         ColumnVisibility: layoutModel.ColumnVisibility,
@@ -395,7 +395,7 @@ function toAggregationColumnValue(columnAggregationModel) {
 }
 export const pivotLayoutModelToPivotLayout = (layoutModel) => {
     const pivotLayout = {
-        Name: layoutModel.Ignore_Name,
+        Name: layoutModel.Name,
         PivotColumns: layoutModel.PivotColumns,
         TableColumns: layoutModel.TableColumns,
         ColumnWidths: layoutModel.ColumnWidths,

package/src/Api/Implementation/StateApiImpl.d.ts

@@ -31,6 +31,7 @@ export declare class StateApiImpl extends ApiBase implements StateApi {
     reloadInitialState(newInitialState?: InitialState): void;
     getAllState(): AdaptableState;
     getPersistedState(): AdaptablePersistentState;
+    getPersistentState(): AdaptablePersistentState;
     getAllUserState(): BaseState[];
     loadUserState(state: InitialState): void;
     getAdaptableFilterState(): AdaptableFilterState;

package/src/Api/Implementation/StateApiImpl.js

@@ -53,7 +53,7 @@ export class StateApiImpl extends ApiBase {
     }
     reloadInitialState(newInitialState) {
         const adaptableOptions = this.getOptions();
-        const oldState = this.getPersistedState();
+        const oldState = this.getPersistentState();
         // clearing filters so that AG Grid doesnt display the filter icon in a column header after grid reloads
         // but this is a hack so would be nicer if there was a better way to do this
         this.getGridApi().clearFiltering();
@@ -71,7 +71,7 @@ export class StateApiImpl extends ApiBase {
                     initialState: newInitialState || adaptableOptions.initialState,
                     flushCurrentState: false,
                 }).then(() => {
-                    const newState = this.getPersistedState();
+                    const newState = this.getPersistentState();
                     this.getEventApi().internalApi.fireAdaptableStateReloadedEvent(oldState, newState);
                 });
             });
@@ -81,11 +81,14 @@ export class StateApiImpl extends ApiBase {
         return this.getAdaptableState();
     }
     getPersistedState() {
-        // no assertion should be required here as soon as we make order in our state typings
+        logDeprecation(this.getAdatableLogger(), 'StateApi', 'getPersistedState', 'getPersistentState');
+        return this.getPersistentState();
+    }
+    getPersistentState() {
         return this.getAdaptableStore().getCurrentStorageState();
     }
     getAllUserState() {
-        return Object.values(this.getPersistedState());
+        return Object.values(this.getPersistentState());
     }
     loadUserState(state) {
         this.setAdaptableStateKey(this.getOptions().adaptableStateKey, {

package/src/Api/StateApi.d.ts

@@ -69,8 +69,15 @@ export interface StateApi {
     getAllState(): AdaptableState;
     /**
      * Retrieves persisted state in AdapTable, i.e. state last stored with `StateOptions.persistState()` function
+     *
+     * @deprecated use `getPersistentState()` instead
      */
     getPersistedState(): AdaptablePersistentState;
+    /**
+     * Retrieves the persistent state in Adaptable, i.e. state that is passed to the `StateOptions.persistState()` function.
+     *
+     */
+    getPersistentState(): AdaptablePersistentState;
     /**
      * Gets filter-related sections of Adaptable State
      */

package/src/View/Components/ReorderDraggable/index.js

@@ -13,7 +13,8 @@ export function ReorderDraggable(props) {
             return (React.createElement(Flex, { className: `${baseClassName}__option`, alignItems: "center", mt: index ? 1 : 0, key: identifier ?? index, backgroundColor: 'primary', padding: 2, "data-index": index, "data-id": identifier, "data-name": "option", ...flexProps },
                 React.createElement(Flex, { flex: 1, flexDirection: "row", alignItems: "center" },
                     reorderable ? (React.createElement(Box, { mr: 3, ...dragHandleProps },
-                        React.createElement(Icon, { name: "drag", style: { cursor: 'grab' } }))) : null,
+                        React.createElement(Icon, { name: "drag", style: { cursor: 'grab' } }))) : (React.createElement(Box, { mr: 3 },
+                        React.createElement(Icon, { name: "drag", style: { cursor: 'not-allowed', opacity: 0.3 } }))),
                     props.renderOption(option, index))));
         };
         const reorderable = isOptionDraggable ? isOptionDraggable(option) : true;

package/src/View/Layout/Wizard/sections/ColumnsSection.js

@@ -376,7 +376,9 @@ export const ColumnsSection = (props) => {
                 React.createElement(Box, null,
                     React.createElement(NaturallySizedIcon, { name: "info" })),
                 React.createElement(Text, { ml: 1 }, "Expand each Column to set Width, Pinnning and a custom Header")),
-            React.createElement(ReorderDraggable, { toIdentifier: (option) => `${option.columnId}`, order: currentOrder, renderOption: (option) => {
+            React.createElement(ReorderDraggable, { toIdentifier: (option) => `${option.columnId}`, isOptionDraggable: (option) => {
+                    return option.moveable;
+                }, order: currentOrder, renderOption: (option) => {
                     return (React.createElement(ColumnRow, { onColumnNameChange: handleColumnNameChange, onColumnWidthChange: handleColumnWidthChange, onColumnVisibilityChange: handleColumnVisibilityChange, onPinChange: handlePinChange, layout: layout, column: option }));
                 }, onChange: handleColumnsChange }),
             renderSelectionSection({

package/src/View/Layout/Wizard/sections/PivotRowGroupingSection.js

@@ -22,7 +22,7 @@ export const PivotRowGroupingSection = (props) => {
     const { data: layout } = useOnePageAdaptableWizardContext();
     const allGroupableColumns = adaptable.api.columnApi.getGroupableColumns();
     const sortedGroupableColumns = React.useMemo(() => {
-        return ArrayExtensions.sortArrayWithOrder(allGroupableColumns.map((col) => col.columnId), layout.RowGroupedColumns ?? [], { sortUnorderedItems: false }).map((colId) => adaptable.api.columnApi.getColumnWithColumnId(colId));
+        return ArrayExtensions.sortArrayWithOrder(allGroupableColumns.map((col) => col.columnId), layout.PivotGroupedColumns ?? [], { sortUnorderedItems: false }).map((colId) => adaptable.api.columnApi.getColumnWithColumnId(colId));
     }, [layout, allGroupableColumns]);
     const onChange = (layout) => {
         props.onChange(normalizeLayout(layout));

package/src/View/StateManagement/components/ExportDropdown.js

@@ -5,7 +5,7 @@ export const ExportDropdown = (props) => {
     const handleChange = (destination) => {
         switch (props.type) {
             case 'adaptableState':
-                const adaptableState = props.api.stateApi.getPersistedState();
+                const adaptableState = props.api.stateApi.getPersistentState();
                 handleExportState(destination, 'adaptableState', adaptableState);
                 break;
             case 'initialState':

package/src/agGrid/AgGridAdapter.js

@@ -621,8 +621,8 @@ export class AgGridAdapter {
         return false;
     }
     isColumnSortable(colDef) {
-        if (colDef && colDef.sortable != null) {
-            return colDef.sortable;
+        if (colDef) {
+            return colDef.sortable ?? true;
         }
         return false;
     }

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_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: 1751633635859 || Date.now(),
-    VERSION: "20.2.6" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1751978297635 || Date.now(),
+    VERSION: "20.2.7" || '--current-version--',
 };

package/src/layout-manager/src/LayoutManagerModel.d.ts

@@ -40,10 +40,6 @@ export interface BaseLayoutModel {
      * Same as RowSummaries, but for Pivot Layout
      */
     Ignore_RowSummaries?: any;
-    /**
-     * Same as above, but
-     */
-    Ignore_Name?: string;
     /**
      * Same as above, but for Column Headers
      */
@@ -51,6 +47,10 @@ export interface BaseLayoutModel {
     Ignore_Source?: string;
     Ignore_AdaptableVersion?: string;
     Ignore_Uuid?: string;
+    /**
+     * The Layout Name
+     */
+    Name?: string;
     ColumnVisibility?: {
         [columnId: string]: false;
     };

package/src/layout-manager/src/index.js

@@ -276,7 +276,7 @@ export class LayoutManager extends LMEmitter {
         }
         delete layout.TableColumns;
         const pivotLayout = {
-            Ignore_Name: layout.Ignore_Name,
+            Name: layout.Name,
             Ignore_GridFilter: layout.Ignore_GridFilter,
             Ignore_ColumnFilters: layout.Ignore_ColumnFilters,
             Ignore_ColumnHeaders: layout.Ignore_ColumnHeaders,
@@ -595,7 +595,7 @@ export class LayoutManager extends LMEmitter {
             }
         }
         const layout = simplifyTableLayoutModel({
-            Ignore_Name: this.currentLayout?.Ignore_Name || 'Default',
+            Name: this.currentLayout?.Name || 'Default',
             Ignore_GridFilter: this.currentLayout?.Ignore_GridFilter,
             Ignore_ColumnFilters: this.currentLayout?.Ignore_ColumnFilters,
             Ignore_ColumnHeaders: this.currentLayout?.Ignore_ColumnHeaders,

package/src/layout-manager/src/isLayoutEqual.js

@@ -49,7 +49,6 @@ export function isTableLayoutEqual(l1, l2) {
 function clearIgnoredProperties(layout) {
     delete layout.Ignore_GridFilter;
     delete layout.Ignore_ColumnFilters;
-    delete layout.Ignore_Name;
     delete layout.Ignore_ColumnHeaders;
     delete layout.Ignore_AutoSizeColumns;
     delete layout.Ignore_RowSummaries;