@adaptabletools/adaptable-cjs 18.0.0-canary.2 → 18.0.0-canary.21

package/src/Api/Internal/ActionRowInternalApi.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionRowInternalApi = void 0;
+const tslib_1 = require("tslib");
 const ApiBase_1 = require("../Implementation/ApiBase");
+const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
+const UIHelper_1 = tslib_1.__importDefault(require("../../View/UIHelper"));
+const ActionColumnRenderer_1 = require("../../agGrid/ActionColumnRenderer");
 class ActionRowInternalApi extends ApiBase_1.ApiBase {
     buildRowEditForm(rowNode) {
         return this.buildActionRow('rowEdited', rowNode);
@@ -100,7 +104,7 @@ class ActionRowInternalApi extends ApiBase_1.ApiBase {
                 const eventInfo = type === 'rowCreated'
                     ? {
                         type: 'rowCreated',
-                        formData: context.formData,
+                        formData: this.prepareCreateData(formFields, context),
                         adaptableApi: context.adaptableApi,
                         userName: this.getOptions().userName,
                         adaptableId: this.getOptions().adaptableId,
@@ -120,6 +124,17 @@ class ActionRowInternalApi extends ApiBase_1.ApiBase {
         };
         return [cancelButton, saveButton];
     }
+    // private getNullValueForColumn(column: AdaptableColumn) {}
+    prepareCreateData(formFields, context) {
+        // when creating we just omit values that are not set
+        const dataToSave = Object.assign({}, context.formData);
+        for (const formField of formFields) {
+            if (dataToSave[formField.name] === '') {
+                delete dataToSave[formField.name];
+            }
+        }
+        return dataToSave;
+    }
     prepareEditData(formFields, context) {
         const dataToSave = Object.assign({}, context.formData);
         for (const formField of formFields) {
@@ -200,5 +215,108 @@ class ActionRowInternalApi extends ApiBase_1.ApiBase {
             label: value,
         }));
     }
+    getColDefsForActionRowColumns() {
+        const actionButtons = this.getActionRowButtonDefs();
+        if (!actionButtons.length) {
+            return [];
+        }
+        return [
+            {
+                headerName: '',
+                colId: GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS,
+                hide: false,
+                editable: false,
+                // 15px is the icon width + left&right padding + left&right border
+                width: Math.max(actionButtons.length * (UIHelper_1.default.getSimpleButtonPaddingWidth() * 2 + 15) + 2, 
+                // If the width of the column is to small, the width will not be applied
+                // this triggers the setLayout an infinite loop because the width read from the grid is always different
+                40),
+                resizable: false,
+                lockVisible: true,
+                suppressColumnsToolPanel: true,
+                suppressFiltersToolPanel: true,
+                suppressHeaderMenuButton: true,
+                suppressMovable: true,
+                filter: false,
+                sortable: false,
+                enableRowGroup: false,
+                pinned: this.getActionRowOptions().actionRowButtonOptions.position === 'pinnedRight'
+                    ? 'right'
+                    : 'left',
+                cellRenderer: this.getAdaptableVariant() === 'react' ? ActionColumnRenderer_1.ReactActionColumnRenderer : ActionColumnRenderer_1.ActionColumnRenderer,
+                cellClass: GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS,
+                type: [GeneralConstants_1.AB_SPECIAL_COLUMN, 'abColDefObject'],
+            },
+        ];
+    }
+    getActionRowButtonDefs() {
+        const actionRowButtons = this.getActionRowApi().getActionRowButtons();
+        if (!(actionRowButtons === null || actionRowButtons === void 0 ? void 0 : actionRowButtons.length)) {
+            return [];
+        }
+        const defaultActionRowButtonConfiguration = {
+            create: {
+                icon: {
+                    name: 'add',
+                },
+                tooltip: 'Create',
+                onClick: () => {
+                    this.getActionRowApi().displayCreateActionRow();
+                },
+            },
+            edit: {
+                icon: {
+                    name: 'edit',
+                },
+                tooltip: 'Edit',
+                onClick: (button, context) => {
+                    this.getActionRowApi().displayEditActionRow(context.primaryKeyValue);
+                },
+            },
+            clone: {
+                icon: {
+                    name: 'clone',
+                },
+                tooltip: 'Clone',
+                onClick: (button, context) => {
+                    this.getActionRowApi().displayCloneActionRow(context.primaryKeyValue);
+                },
+            },
+            delete: {
+                icon: {
+                    name: 'delete',
+                },
+                tooltip: 'Delete',
+                onClick: (button, context) => {
+                    var _a, _b;
+                    const eventInfo = {
+                        type: 'rowDeleted',
+                        rowNode: context.rowNode,
+                        adaptableApi: context.adaptableApi,
+                        userName: context.userName,
+                        adaptableId: context.adaptableId,
+                    };
+                    this.getEventApi().emit('ActionRowSubmitted', eventInfo);
+                    (_b = (_a = this.getActionRowOptions().actionRowFormOptions).onFormSubmit) === null || _b === void 0 ? void 0 : _b.call(_a, eventInfo);
+                },
+            },
+        };
+        const actionButtons = actionRowButtons
+            .map((actionRowButtonType) => {
+            var _a, _b;
+            const defaultButtonConfig = defaultActionRowButtonConfiguration[actionRowButtonType];
+            if (!defaultButtonConfig) {
+                // should NOT happen unless the user sent some invalid button type in the predefined config
+                return;
+            }
+            const customButtonConfig = (_b = (_a = this.getActionRowOptions().actionRowButtonOptions).customConfiguration) === null || _b === void 0 ? void 0 : _b.call(_a, Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { actionRowButtonType }));
+            if (!customButtonConfig) {
+                return defaultButtonConfig;
+            }
+            return Object.assign(Object.assign({}, defaultButtonConfig), customButtonConfig);
+        })
+            .filter(Boolean);
+        return actionButtons;
+    }
 }
 exports.ActionRowInternalApi = ActionRowInternalApi;

package/src/Api/Internal/AdaptableInternalApi.d.ts

@@ -24,9 +24,9 @@ import { AdaptableFrameworkComponent } from '../../AdaptableOptions/AdaptableFra
 import { IMetamodelService } from '../../Utilities/Services/Interface/IMetamodelService';
 import { IModuleCollection } from '../../Strategy/Interface/IModule';
 import { AdaptableObjectTag, AdaptableObjectWithScope } from '../../PredefinedConfig/Common/AdaptableObject';
-import { IRowEditService } from '../../Utilities/Services/Interface/IRowEditService';
 import { Fdc3Service } from '../../Utilities/Services/Fdc3Service';
 import { CellPopupService } from '../../Utilities/Services/CellPopupService';
+import { RowEditService } from '../../Utilities/Services/RowEditService';
 export declare class AdaptableInternalApi extends ApiBase {
     getSystemState(): SystemState;
     showPopupConfirmation(confirmation: UIConfirmation): void;
@@ -46,8 +46,7 @@ export declare class AdaptableInternalApi extends ApiBase {
     setPivotModeOn(): void;
     setPivotModeOff(): void;
     isGridInPivotMode(): boolean;
-    setTreeModeOn(): void;
-    setTreeModeOff(): void;
+    setTreeMode(mode: boolean): void;
     isGridInTreeMode(): boolean;
     getToolbarTitle(): string;
     buildDataChangedInfo(config: Pick<CellDataChangedInfo, 'newValue' | 'oldValue' | 'column' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): CellDataChangedInfo;
@@ -65,7 +64,7 @@ export declare class AdaptableInternalApi extends ApiBase {
     getAlertService(): IAlertService;
     getTeamSharingService(): ITeamSharingService;
     getMetamodelService(): IMetamodelService;
-    getRowEditService(): IRowEditService;
+    getRowEditService(): RowEditService;
     getFdc3Service(): Fdc3Service;
     getModules(): IModuleCollection;
     getModuleFriendlyName(adaptableModule: AdaptableModule): string;
@@ -73,7 +72,7 @@ export declare class AdaptableInternalApi extends ApiBase {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): void;
-    forAllVisibleRowNodesDo(func: (rowNode: IRowNode) => void, config?: {
+    forAllVisibleRowNodesDo(func: (rowNode: IRowNode, index: number) => void, config?: {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): void;
@@ -106,8 +105,8 @@ export declare class AdaptableInternalApi extends ApiBase {
     getPreviousGroupedColumnsIndex(layoutId: string): {
         [key: string]: number;
     };
-    getValueUsingField(rowData: Record<string, any>, columnValueKey: string): any;
-    setValueUsingField(rowData: Record<string, any>, columnValueKey: string, newValue: any): Record<string, any>;
+    getValueUsingField(rowData: Record<string, any>, fieldName: string): any;
+    setValueUsingField(rowData: Record<string, any>, fieldName: string, newValue: any): Record<string, any>;
     findAdaptableObjectsByLookupCriteria<T extends AdaptableObjectWithScope>({ scope, tag, ids }: AdaptableObjectLookupCriteria, specificAdaptableObjects: T[]): T[];
     buildBaseContext(): BaseContext;
     getActionButtonsAndActionColumn(colDef: ColDef): {

package/src/Api/Internal/AdaptableInternalApi.js

@@ -51,11 +51,13 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     isGridInPivotMode() {
         return this.getAdaptableState().Grid.IsGridInPivotMode;
     }
-    setTreeModeOn() {
-        this.dispatchAction(GridRedux.SetTreeModeOn());
-    }
-    setTreeModeOff() {
-        this.dispatchAction(GridRedux.SetTreeModeOff());
+    setTreeMode(mode) {
+        if (!!mode) {
+            this.dispatchAction(GridRedux.SetTreeModeOn());
+        }
+        else {
+            this.dispatchAction(GridRedux.SetTreeModeOff());
+        }
     }
     isGridInTreeMode() {
         return this.getAdaptableState().Grid.IsGridInTreeMode;
@@ -223,13 +225,13 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
             frameworkComponent,
             componentType,
         });
-        if (this.adaptable.isInitialised) {
+        if (this.adaptable.isReady) {
             createComponentFn();
         }
         else {
             // adaptable may not be initialized yet if the framework component is part of the initial render
             // AFL 2021.10.14 - not really sure if this is necessary anymore?! (see the other changes in this commit)
-            (0, waitForCondition_1.waitForCondition)(() => this.adaptable.isInitialised).then(() => {
+            (0, waitForCondition_1.waitForCondition)(() => this.adaptable.isReady).then(() => {
                 createComponentFn();
             });
         }
@@ -368,17 +370,17 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         return (_a = SystemRedux.SystemPreviousGroupedColumnsSelector(this.getAdaptableState().System)) === null || _a === void 0 ? void 0 : _a[layoutId];
     }
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/utils/object.ts#L205
-    getValueUsingField(rowData, columnValueKey) {
-        if (!rowData || !(columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.length)) {
+    getValueUsingField(rowData, fieldName) {
+        if (!rowData || !(fieldName === null || fieldName === void 0 ? void 0 : fieldName.length)) {
             return;
         }
-        const isColumnValueKeyNested = columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.includes('.');
+        const isColumnValueKeyNested = fieldName === null || fieldName === void 0 ? void 0 : fieldName.includes('.');
         // if no '.', then it's not a deep value
         if (!isColumnValueKeyNested) {
-            return rowData[columnValueKey];
+            return rowData[fieldName];
         }
         // otherwise it is a deep value, so need to dig for it
-        const fields = columnValueKey.split('.');
+        const fields = fieldName.split('.');
         let currentObject = rowData;
         for (let i = 0; i < fields.length; i++) {
             if (currentObject == null) {
@@ -389,22 +391,22 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         return currentObject;
     }
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/valueService/valueService.ts#L236
-    setValueUsingField(rowData, columnValueKey, newValue) {
-        if (!rowData || !(columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.length)) {
+    setValueUsingField(rowData, fieldName, newValue) {
+        if (!rowData || !(fieldName === null || fieldName === void 0 ? void 0 : fieldName.length)) {
             return;
         }
-        const isColumnValueKeyContainsDots = columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.includes('.');
+        const isColumnValueKeyContainsDots = fieldName === null || fieldName === void 0 ? void 0 : fieldName.includes('.');
         let valuesAreSame = false;
         if (!isColumnValueKeyContainsDots) {
             // soft comparison to match strings and numbers
-            valuesAreSame = rowData[columnValueKey] == newValue;
+            valuesAreSame = rowData[fieldName] == newValue;
             if (!valuesAreSame) {
-                rowData[columnValueKey] = newValue;
+                rowData[fieldName] = newValue;
             }
         }
         else {
             // otherwise it is a deep value, so need to dig for it
-            const fieldPieces = columnValueKey.split('.');
+            const fieldPieces = fieldName.split('.');
             let currentObject = rowData;
             while (fieldPieces.length > 0 && currentObject) {
                 const fieldPiece = fieldPieces.shift();
@@ -452,7 +454,7 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         var _a;
         let actionColumn;
         if (colDef.colId == GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS) {
-            const actionButtons = this.adaptable.getActionRowButtonDefs();
+            const actionButtons = this.getActionRowApi().internalApi.getActionRowButtonDefs();
             actionColumn = {
                 columnId: GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS,
                 actionColumnButton: actionButtons,

package/src/Api/Internal/CalculatedColumnInternalApi.d.ts

@@ -1,6 +1,7 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { CalculatedColumn } from '../../PredefinedConfig/CalculatedColumnState';
 import { AdaptableColumn } from '../../types';
+import { ColDef } from '@ag-grid-community/core';
 export declare class CalculatedColumnInternalApi extends ApiBase {
     /**
      * Returns all the references in the AdaptableState of the given CalculatedColumn
@@ -27,4 +28,5 @@ export declare class CalculatedColumnInternalApi extends ApiBase {
     isQuantileAggregatedExpression(input: string): boolean;
     getExpressionFromCalculatedColumn(calculatedColumn: CalculatedColumn): string;
     fireCalculatedColumnChangedEvent(trigger: string, calculatedColumn: CalculatedColumn): void;
+    getColDefsForCalculatedColumns(): ColDef[];
 }

package/src/Api/Internal/CalculatedColumnInternalApi.js

@@ -1,7 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CalculatedColumnInternalApi = void 0;
+const tslib_1 = require("tslib");
 const ApiBase_1 = require("../Implementation/ApiBase");
+const ObjectFactory_1 = require("../../Utilities/ObjectFactory");
+const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
+const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
+const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
     /**
      * Returns all the references in the AdaptableState of the given CalculatedColumn
@@ -90,5 +95,72 @@ class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
         };
         this.adaptable.api.eventApi.emit('CalculatedColumnChanged', calculatedColumnChangedInfo);
     }
+    getColDefsForCalculatedColumns() {
+        const defaultSpecialColumnSettings = this.getGridApi().internalApi.deriveSpecialColumnSettingsFromAgGridDefaultColDef();
+        const defaultCalculatedColumnSettings = (0, ObjectFactory_1.CreateEmptyCalculatedColumn)(defaultSpecialColumnSettings).CalculatedColumnSettings;
+        return this.getCalculatedColumnApi()
+            .getCalculatedColumns()
+            .map((calculatedColumn) => {
+            const calculatedColumnSettings = Object.assign(Object.assign({}, defaultCalculatedColumnSettings), calculatedColumn.CalculatedColumnSettings);
+            if (!calculatedColumnSettings.DataType) {
+                calculatedColumnSettings.DataType = this.getAdaptableApi()
+                    .internalApi.getAdaptableInstance()
+                    .CalculatedColumnExpressionService.getCalculatedColumnDataType(calculatedColumn.Query);
+            }
+            const columnTypes = [
+                GeneralConstants_1.AB_SPECIAL_COLUMN,
+                this.getGridApi().internalApi.getAgGridDataType(calculatedColumnSettings.DataType),
+            ];
+            if (ArrayExtensions_1.default.IsNotNullOrEmpty(calculatedColumnSettings.ColumnTypes)) {
+                columnTypes.push(...calculatedColumnSettings.ColumnTypes);
+            }
+            const isExternalEvaluation = !this.getExpressionApi().internalApi.evaluateExpressionInAdaptableQL('CalculatedColumn', calculatedColumn, this.getExpressionApi().getAdaptableQueryExpression(calculatedColumn.Query));
+            const valueGetter = (params) => {
+                var _a, _b;
+                if (isExternalEvaluation) {
+                    return (_a = params.data) === null || _a === void 0 ? void 0 : _a[calculatedColumn.ColumnId];
+                }
+                // if the grid data is NOT client side, we can aggregate only simple scalar expression (which depend on row data, not on other rows)
+                if (this.getGridApi().getAgGridRowModelType() !== 'clientSide' &&
+                    StringExtensions_1.default.IsNotNullOrEmpty(calculatedColumn.Query.AggregatedScalarExpression)) {
+                    return (_b = params.data) === null || _b === void 0 ? void 0 : _b[calculatedColumn.ColumnId];
+                }
+                return this.getAdaptableApi()
+                    .internalApi.getAdaptableInstance()
+                    .CalculatedColumnExpressionService.evaluateCalculatedColumnQuery(calculatedColumn, params.node);
+            };
+            const newColDef = {
+                headerName: calculatedColumn.FriendlyName
+                    ? calculatedColumn.FriendlyName
+                    : calculatedColumn.ColumnId,
+                colId: calculatedColumn.ColumnId,
+                hide: false,
+                editable: false,
+                width: calculatedColumnSettings.Width,
+                enableValue: calculatedColumnSettings.Aggregatable,
+                filter: calculatedColumnSettings.Filterable,
+                floatingFilter: calculatedColumnSettings.Filterable,
+                resizable: calculatedColumnSettings.Resizable,
+                enableRowGroup: calculatedColumnSettings.Groupable,
+                sortable: calculatedColumnSettings.Sortable,
+                enablePivot: calculatedColumnSettings.Pivotable,
+                suppressHeaderMenuButton: calculatedColumnSettings.SuppressMenu,
+                suppressMovable: calculatedColumnSettings.SuppressMovable,
+                type: columnTypes,
+                valueGetter,
+            };
+            if (calculatedColumnSettings.ShowToolTip != null &&
+                calculatedColumnSettings.ShowToolTip == true) {
+                newColDef.tooltipValueGetter = () => {
+                    return this.getAdaptableApi().internalApi.getAdaptableQueryExpressionText(calculatedColumn.Query);
+                };
+            }
+            if (calculatedColumnSettings.HeaderToolTip) {
+                newColDef.headerTooltip = calculatedColumnSettings.HeaderToolTip;
+            }
+            this.getAdaptableApi().logInfo('Setting up Calculated Column: ' + calculatedColumn.ColumnId);
+            return newColDef;
+        });
+    }
 }
 exports.CalculatedColumnInternalApi = CalculatedColumnInternalApi;

package/src/Api/Internal/ColumnFilterInternalApi.d.ts

@@ -49,6 +49,7 @@ export declare class ColumnFilterInternalApi extends ApiBase {
      * Fires Column Filter Applied Event - typically used to enable filtering on the server
      */
     fireColumnFilterAppliedEvent(): void;
+    fireGridFilterAppliedEvent(): void;
     /**
      * Compares to sets of Column Filters to see if they are identical
      * @param filters1
@@ -56,4 +57,5 @@ export declare class ColumnFilterInternalApi extends ApiBase {
      */
     areColumnFiltersDifferent(oldFilters: ColumnFilter[], newFilters: ColumnFilter[]): boolean;
     getPredicateDefShortcuts(predicateDef: AdaptablePredicateDef): string[];
+    getFilterValuesMaxNumberOfItems(column: AdaptableColumn): number | undefined;
 }

package/src/Api/Internal/ColumnFilterInternalApi.js

@@ -175,7 +175,7 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
      * Fires Column Filter Applied Event - typically used to enable filtering on the server
      */
     fireColumnFilterAppliedEvent() {
-        if (this.adaptable.isLive) {
+        if (this.adaptable.isReady) {
             const adaptableApi = this.getAdaptableApi();
             const columnFilterAppliedInfo = {
                 columnFilters: this.getColumnFilterApi().getColumnFilters(),
@@ -186,6 +186,18 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
             this.adaptable.api.eventApi.emit('ColumnFilterApplied', columnFilterAppliedInfo);
         }
     }
+    fireGridFilterAppliedEvent() {
+        if (this.adaptable.isReady) {
+            const adaptableApi = this.getAdaptableApi();
+            const gridFilterAppliedInfo = {
+                columnFilters: this.getColumnFilterApi().getColumnFilters(),
+                adaptableApi: adaptableApi,
+                userName: adaptableApi.optionsApi.getUserName(),
+                adaptableId: adaptableApi.optionsApi.getAdaptableId(),
+            };
+            this.adaptable.api.eventApi.emit('GridFilterApplied', gridFilterAppliedInfo);
+        }
+    }
     /**
      * Compares to sets of Column Filters to see if they are identical
      * @param filters1
@@ -206,5 +218,15 @@ class ColumnFilterInternalApi extends ApiBase_1.ApiBase {
         }
         return predicateShortcuts;
     }
+    getFilterValuesMaxNumberOfItems(column) {
+        const maxFilterValues = this.getColumnFilterOptions().valuesFilterOptions.maxFilterValuesToDisplay;
+        if (typeof maxFilterValues === 'function') {
+            const columnFilterContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { column: column });
+            return maxFilterValues(columnFilterContext);
+        }
+        else {
+            return maxFilterValues;
+        }
+    }
 }
 exports.ColumnFilterInternalApi = ColumnFilterInternalApi;

package/src/Api/Internal/ColumnInternalApi.d.ts

@@ -1,5 +1,7 @@
 import { ApiBase } from '../Implementation/ApiBase';
-import { Column } from '@ag-grid-community/core';
+import { Column, IRowNode } from '@ag-grid-community/core';
+import { CustomSort } from '../../PredefinedConfig/CustomSortState';
+import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
 export declare class ColumnInternalApi extends ApiBase {
     /**
      * Retrieves 'ColumnType' property for a given Column
@@ -24,4 +26,5 @@ export declare class ColumnInternalApi extends ApiBase {
      */
     getAgGridColumnForAdaptableColumn(columnId: string): Column;
     isActionRowButtonColumn(columnId: string): boolean;
+    getActiveColumnComparator(columnId: string, customSort?: CustomSort, customSortComparer?: ColumnValuesComparer): (valueA: any, valueB: any, nodeA?: IRowNode, nodeB?: IRowNode, isInverted?: boolean) => number | undefined;
 }

package/src/Api/Internal/ColumnInternalApi.js

@@ -42,5 +42,17 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
     isActionRowButtonColumn(columnId) {
         return columnId === GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS;
     }
+    getActiveColumnComparator(columnId, customSort, customSortComparer) {
+        if ((!customSort || (customSort === null || customSort === void 0 ? void 0 : customSort.IsSuspended)) && !customSortComparer) {
+            // defaults to AG-Grid column definition comparator if no CustomSort is defined&active
+            const colDefComparator = this.adaptable.agGridColumnAdapter.getUserColDefProperty(columnId, 'comparator');
+            return colDefComparator;
+        }
+        // CustomSort Comparer function takes precedence over CustomSort SortedValues
+        const comparerFunction = customSortComparer
+            ? customSortComparer.comparer
+            : this.getCustomSortApi().internalApi.getDefaultCustomSortComparer(customSort.ColumnId, customSort.SortedValues);
+        return comparerFunction;
+    }
 }
 exports.ColumnInternalApi = ColumnInternalApi;

package/src/Api/Internal/CommentsInternalApi.d.ts

@@ -0,0 +1,4 @@
+import { ApiBase } from '../Implementation/ApiBase';
+export declare class CommentsInternalApi extends ApiBase {
+    areCommentsAvailable(): boolean;
+}

package/src/Api/Internal/CommentsInternalApi.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsInternalApi = void 0;
+const ApiBase_1 = require("../Implementation/ApiBase");
+class CommentsInternalApi extends ApiBase_1.ApiBase {
+    areCommentsAvailable() {
+        var _a;
+        const currentLayout = this.getLayoutApi().getCurrentLayout();
+        if (currentLayout.EnablePivot) {
+            return false;
+        }
+        if ((_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) {
+            return false;
+        }
+        return true;
+    }
+}
+exports.CommentsInternalApi = CommentsInternalApi;

package/src/Api/Internal/CustomSortInternalApi.d.ts

@@ -1,6 +1,7 @@
 import { ApiBase } from '../Implementation/ApiBase';
-import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
+import { AdaptableComparerFunction } from '../../PredefinedConfig/Common/AdaptableComparerFunction';
 export declare class CustomSortInternalApi extends ApiBase {
-    getCustomSortComparer(column: AdaptableColumn): ColumnValuesComparer | undefined;
+    getCustomSortComparer(columnId: string): ColumnValuesComparer | undefined;
+    getDefaultCustomSortComparer(columnId: string, columnValues: any[]): AdaptableComparerFunction;
 }

package/src/Api/Internal/CustomSortInternalApi.js

@@ -3,9 +3,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomSortInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class CustomSortInternalApi extends ApiBase_1.ApiBase {
-    getCustomSortComparer(column) {
+    getCustomSortComparer(columnId) {
         var _a;
+        const column = this.getColumnApi().getColumnWithColumnId(columnId);
         return (_a = this.getCustomSortOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => this.adaptable.api.scopeApi.isColumnInScope(column, csc.scope));
     }
+    getDefaultCustomSortComparer(columnId, columnValues) {
+        // have to return a function that may not have access to this
+        const adaptable = this.adaptable;
+        return function compareItemsOfCustomSort(valueA, valueB, nodeA, nodeB) {
+            var _a, _b;
+            let firstElementValueString = (_a = (nodeA && adaptable.getDisplayValueFromRowNode(nodeA, columnId))) !== null && _a !== void 0 ? _a : valueA;
+            let secondElementValueString = (_b = (nodeB && adaptable.getDisplayValueFromRowNode(nodeB, columnId))) !== null && _b !== void 0 ? _b : valueB;
+            let indexFirstElement = columnValues.indexOf(firstElementValueString);
+            let containsFirstElement = indexFirstElement >= 0;
+            let indexSecondElement = columnValues.indexOf(secondElementValueString);
+            let containsSecondElement = indexSecondElement >= 0;
+            //if none of the element are in the list we jsut return normal compare
+            if (!containsFirstElement && !containsSecondElement) {
+                if (valueA == valueB) {
+                    return 0;
+                }
+                return valueA < valueB ? -1 : 1;
+            }
+            //if first item not in the list make sure we put it after the second item
+            if (!containsFirstElement) {
+                return 1;
+            }
+            //if second item not in the list make sure we put it after the first item
+            if (!containsSecondElement) {
+                return -1;
+            }
+            //return the comparison from the list if the two items are in the list
+            return indexFirstElement - indexSecondElement;
+        };
+    }
 }
 exports.CustomSortInternalApi = CustomSortInternalApi;

package/src/Api/Internal/DataSetInternalApi.js

@@ -8,7 +8,7 @@ class DataSetInternalApi extends ApiBase_1.ApiBase {
      * @param dataSet Data Set which has been selected
      */
     fireDataSetSelectedEvent(dataSet) {
-        if (this.adaptable.isLive) {
+        if (this.adaptable.isReady) {
             const dataSetSelectedInfo = {
                 adaptableApi: this.adaptable.api,
                 dataSet,

package/src/Api/Internal/ExportInternalApi.d.ts

@@ -2,7 +2,7 @@ import { ApiBase } from '../Implementation/ApiBase';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { Report } from '../../PredefinedConfig/ExportState';
 import { AdaptableColumnType } from '../../PredefinedConfig/Common/Types';
-import { ExcelDataType } from '@ag-grid-community/core';
+import { ExcelDataType, ExcelStyle } from '@ag-grid-community/core';
 import { AdaptableColumnDataType } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { DataFormatType } from '../../AdaptableOptions/ExportOptions';
 export declare class ExportInternalApi extends ApiBase {
@@ -17,4 +17,5 @@ export declare class ExportInternalApi extends ApiBase {
     isDateCellExportedAsFormattedValue(): boolean;
     getCellExportFormatType(columnDataType: AdaptableColumnDataType): DataFormatType;
     isDestinationEnabled(destination: string): boolean;
+    getExcelStylesForVisualDataExport(original_excelStyles: ExcelStyle[]): ExcelStyle[];
 }

package/src/Api/Internal/ExportInternalApi.js

@@ -95,7 +95,7 @@ class ExportInternalApi extends ApiBase_1.ApiBase {
         }
     }
     isVisualDataExportInProgress() {
-        return this.getAdaptableState().System.Export.inProgressVisualData;
+        return this.getAdaptableState().System.Export.visualDataExportInProgress;
     }
     isDateCellExportedAsFormattedValue() {
         return (!!this.getExportOptions().exportDateFormat ||
@@ -126,5 +126,8 @@ class ExportInternalApi extends ApiBase_1.ApiBase {
         }
         return true;
     }
+    getExcelStylesForVisualDataExport(original_excelStyles) {
+        return [];
+    }
 }
 exports.ExportInternalApi = ExportInternalApi;

package/src/Api/Internal/Fdc3InternalApi.js

@@ -42,7 +42,7 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
                 editable: false,
                 width: actionColumnConfig.width,
                 resizable: actionColumnConfig.resizable,
-                suppressMenu: true,
+                suppressHeaderMenuButton: true,
                 suppressMovable: !actionColumnConfig.movable,
                 filter: false,
                 sortable: false,
@@ -62,7 +62,7 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
                 editable: false,
                 width: actionColumnConfig.defaultWidth,
                 resizable: true,
-                suppressMenu: true,
+                suppressHeaderMenuButton: true,
                 suppressMovable: false,
                 filter: false,
                 sortable: false,

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -73,8 +73,9 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
                 // this.getFormatColumnsWithColumnScope(formatColumns)
                 (this.adaptable.api.scopeApi.scopeHasColumns(fc.Scope) ||
                     // this.getFormatColumnsWithDataTypeScope(formatColumns)
-                    this.adaptable.api.scopeApi.scopeHasDataType(fc.Scope) || // this.getFormatColumnsWithAllScope(formatColumns)
-                this.adaptable.api.scopeApi.scopeIsAll(fc.Scope))
+                    this.adaptable.api.scopeApi.scopeHasDataType(fc.Scope) ||
+                    // this.getFormatColumnsWithAllScope(formatColumns)
+                    this.adaptable.api.scopeApi.scopeIsAll(fc.Scope) || this.adaptable.api.scopeApi.scopeHasColumnType(fc.Scope))
             );
         });
     }