@adaptabletools/adaptable 20.1.7 → 20.2.0-canary.0

package/src/Api/ExportApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableForm } from '../AdaptableState/Common/AdaptableForm';
 import { ExportState, Report, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../AdaptableState/ExportState';
-import { CustomDestination, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../AdaptableOptions/ExportOptions';
+import { CustomDestination, CustomExportParams, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../AdaptableOptions/ExportOptions';
 import { AdaptableColumn } from '../types';
 /**
  * Provides run-time access to the Export Module and Report state
@@ -25,18 +25,22 @@ export interface ExportApi {
     /**
      * Retrieves name of currently selected Report
      */
-    getCurrentReportName(): string;
+    getCurrentReportName(): ReportNameType | undefined;
+    /**
+     * Retrieves name of currently selected Report
+     */
+    getCurrentReportFormat(): ReportFormatType | undefined;
     /**
      * Retrieves currently selected Report in Adaptable State
      * @returns report that is currently selected
      */
-    getCurrentReport(): Report;
+    getCurrentReport(): Report | undefined;
     /**
      * Retrieves Report with the given name
      * @param reportName report to retrieve
      * @returns report
      */
-    getReportByName(reportName: string): Report | undefined;
+    getReportByName(reportName: ReportNameType): Report | undefined;
     /**
      * Retrieves Report by Id
      * @param id report id
@@ -139,12 +143,24 @@ export interface ExportApi {
      * @param reportName - name of the report
      * @param format - format of the report
      * @param destination - destination to export to
+     * @param config - optional configuration
+     * @param config.exportParams - function to modify the default export parameters; it will be called with the default export parameters and should return the modified export parameters
+     * @param config.showProgressIndicator - whether to show progress indicator
      */
-    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType): Promise<void>;
+    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType, config?: {
+        exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
+        showProgressIndicator?: boolean;
+    }): Promise<void>;
     /**
      * Gets the data for the Report with the given Name in the given Format
      * @param reportName - name of the report
      * @param format - format of the report
-     */
-    getReportData(reportName: ReportNameType, format: ReportFormatType): Promise<ExportResultData>;
+     * @param config - optional configuration
+     * @param config.exportParams - function to modify the default export parameters; it will be called with the default export parameters and should return the modified export parameters
+     * @param config.showProgressIndicator - whether to show progress indicator
+     */
+    getReportData(reportName: ReportNameType, format: ReportFormatType, config?: {
+        exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
+        showProgressIndicator?: boolean;
+    }): Promise<ExportResultData>;
 }

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

@@ -5,7 +5,6 @@ import { ColumnApi } from '../ColumnApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { ColumnInternalApi } from '../Internal/ColumnInternalApi';
 import { ColDef, ColGroupDef, Column, GridApi } from 'ag-grid-enterprise';
-export declare function isAutoRowGroupColumn(columnId: string): boolean;
 export declare function generateAutoRowGroupSingleColumn(): AdaptableColumn;
 export declare function generateAutoTreeSingleColumn(): AdaptableColumn;
 export declare function generateAutoRowGroupColumnForColumn(column: AdaptableColumn): AdaptableColumn;
@@ -30,8 +29,9 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     autosizeAllColumns(): void;
     hideColumn(columnId: string): void;
     showColumn(columnId: string): void;
-    isAutoRowGroupColumn(columnId: string): boolean;
     isPivotResultColumn(columnId: string): boolean;
+    isSelectionColumn(columnId: string): boolean;
+    isAutoRowGroupColumn(columnId: string): boolean;
     isAutoRowGroupColumnForSingle(columnId: string): boolean;
     isAutoRowGroupColumnForMulti(columnId: string): boolean;
     isCalculatedColumn(columnId: string): boolean;

package/src/Api/Implementation/ColumnApiImpl.js

@@ -1,29 +1,11 @@
 import { ApiBase } from './ApiBase';
 import * as GeneralConstants from '../../Utilities/Constants/GeneralConstants';
+import { AG_GRID_SELECTION_COLUMN } from '../../Utilities/Constants/GeneralConstants';
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 import { ColumnInternalApi } from '../Internal/ColumnInternalApi';
-import { GROUP_COLUMN_ID__MULTI_PREFIX, GROUP_COLUMN_ID__SINGLE, } from '../../layout-manager/src/normalizeLayoutModel';
+import { AUTO_GROUP_COLUMN_ID__MULTI_PREFIX, AUTO_GROUP_COLUMN_ID__SINGLE, } from '../../layout-manager/src/normalizeLayoutModel';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import { isPivotColumnTotal } from '../../layout-manager/src/isPivotColumnTotal';
-import { isPivotAggTotalColumn } from '../../layout-manager/src/isPivotAggTotalColumn';
-export function isAutoRowGroupColumn(columnId) {
-    // put this here as there might be other indicators we are not aware of
-    // perhaps with non auto groups ?
-    //https://www.ag-grid.com/javascript-grid-grouping/
-    return columnId?.startsWith(GeneralConstants.AG_GRID_GROUPED_COLUMN);
-}
-// TODO AFL: consolidate this logic with LayoutManager
-const isPivotAggregationTotalColumn = (colId, agGridApi) => {
-    if (!isPivotResultColumn(colId) || !agGridApi) {
-        return false;
-    }
-    const allPivotAggTotalColumnIds = agGridApi
-        .getPivotResultColumns()
-        .map((agColumn) => agColumn.getColDef())
-        .filter((colDef) => isPivotAggTotalColumn(colDef))
-        .map((colDef) => colDef.colId);
-    return allPivotAggTotalColumnIds.includes(colId);
-};
 const ROW_GROUP_COLUMN_DEFAULTS = {
     columnId: '',
     isTreeColumn: false,
@@ -57,14 +39,14 @@ const ROW_GROUP_COLUMN_DEFAULTS = {
 export function generateAutoRowGroupSingleColumn() {
     return {
         ...ROW_GROUP_COLUMN_DEFAULTS,
-        columnId: GROUP_COLUMN_ID__SINGLE,
+        columnId: AUTO_GROUP_COLUMN_ID__SINGLE,
     };
 }
 const TREE_COLUMN_FRIENDLY_NAME = '[Tree Column]';
 export function generateAutoTreeSingleColumn() {
     return {
         ...ROW_GROUP_COLUMN_DEFAULTS,
-        columnId: GROUP_COLUMN_ID__SINGLE,
+        columnId: AUTO_GROUP_COLUMN_ID__SINGLE,
         isTreeColumn: true,
         friendlyName: TREE_COLUMN_FRIENDLY_NAME,
     };
@@ -72,7 +54,7 @@ export function generateAutoTreeSingleColumn() {
 export function generateAutoRowGroupColumnForColumn(column) {
     return {
         ...ROW_GROUP_COLUMN_DEFAULTS,
-        columnId: GROUP_COLUMN_ID__MULTI_PREFIX + column.columnId,
+        columnId: AUTO_GROUP_COLUMN_ID__MULTI_PREFIX + column.columnId,
         friendlyName: column.friendlyName,
         dataType: column.dataType,
     };
@@ -175,17 +157,20 @@ export class ColumnApiImpl extends ApiBase {
     showColumn(columnId) {
         this._adaptable.showColumn(columnId);
     }
-    isAutoRowGroupColumn(columnId) {
-        return isAutoRowGroupColumn(columnId);
-    }
     isPivotResultColumn(columnId) {
         return isPivotResultColumn(columnId) || isPivotGrandTotal(columnId);
     }
+    isSelectionColumn(columnId) {
+        return columnId === AG_GRID_SELECTION_COLUMN;
+    }
+    isAutoRowGroupColumn(columnId) {
+        return (this.isAutoRowGroupColumnForSingle(columnId) || this.isAutoRowGroupColumnForMulti(columnId));
+    }
     isAutoRowGroupColumnForSingle(columnId) {
-        return columnId === GROUP_COLUMN_ID__SINGLE;
+        return columnId === AUTO_GROUP_COLUMN_ID__SINGLE;
     }
     isAutoRowGroupColumnForMulti(columnId) {
-        return columnId.startsWith(GROUP_COLUMN_ID__MULTI_PREFIX);
+        return columnId.startsWith(AUTO_GROUP_COLUMN_ID__MULTI_PREFIX);
     }
     isCalculatedColumn(columnId) {
         return (this.getCalculatedColumnApi()
@@ -263,7 +248,7 @@ export class ColumnApiImpl extends ApiBase {
         return column?.dataType === 'date' || column?.dataType === 'dateString';
     }
     getColumnDataTypeForColumnId(columnId) {
-        const column = this.getColumnWithColumnId(columnId); // this.getColumns().find(c => c.ColumnId === columnId);
+        const column = this.getColumnWithColumnId(columnId);
         if (!column) {
             return undefined;
         }
@@ -293,7 +278,7 @@ export class ColumnApiImpl extends ApiBase {
             if (currentLayout?.RowGroupedColumns?.length) {
                 const groupedByLabel = this.isAutoRowGroupColumnForSingle(columnId)
                     ? currentLayout.RowGroupedColumns.map((colId) => this.getFriendlyNameForColumnId(colId, layout)).join(', ')
-                    : this.getFriendlyNameForColumnId(columnId.replace(GROUP_COLUMN_ID__MULTI_PREFIX, ''), layout);
+                    : this.getFriendlyNameForColumnId(columnId.replace(AUTO_GROUP_COLUMN_ID__MULTI_PREFIX, ''), layout);
                 result = `[Grouped Column: ${groupedByLabel}]`;
                 return result;
             }

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

@@ -2,7 +2,7 @@ import { ExportApi } from '../ExportApi';
 import { ExportState, Report, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../../AdaptableState/ExportState';
 import { ApiBase } from './ApiBase';
 import { AdaptableForm } from '../../AdaptableState/Common/AdaptableForm';
-import { CustomDestination, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
+import { CustomDestination, CustomExportParams, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { ExportInternalApi } from '../Internal/ExportInternalApi';
 import { AdaptableColumn } from '../../types';
@@ -10,7 +10,8 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     internalApi: ExportInternalApi;
     constructor(_adaptable: IAdaptable);
     getExportState(): ExportState;
-    getCurrentReportName(): string;
+    getCurrentReportName(): ReportNameType;
+    getCurrentReportFormat(): ReportFormatType | undefined;
     getCurrentReport(): Report;
     getReportByName(reportName: string): Report | undefined;
     getReportById(id: Report['Uuid']): Report;
@@ -36,7 +37,13 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getCustomReports(): Report[];
     isColumnExportable(adaptableColumn: AdaptableColumn): boolean;
     getSupportedExportDestinations(reportFormat: ReportFormatType): ExportDestinationType[];
-    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType): Promise<void>;
-    getReportData(reportName: ReportNameType, format: ReportFormatType): Promise<ExportResultData>;
+    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType, config?: {
+        exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
+        showProgressIndicator?: boolean;
+    }): Promise<void>;
+    getReportData(reportName: ReportNameType, format: ReportFormatType, config?: {
+        exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
+        showProgressIndicator?: boolean;
+    }): Promise<ExportResultData>;
     private processExport;
 }

package/src/Api/Implementation/ExportApiImpl.js

@@ -2,7 +2,7 @@ import * as ExportRedux from '../../Redux/ActionsReducers/ExportRedux';
 import { ApiBase } from './ApiBase';
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 import { ExportInternalApi } from '../Internal/ExportInternalApi';
-import { EMPTY_STRING } from '../../Utilities/Constants/GeneralConstants';
+import { ALL_DATA_REPORT, EMPTY_STRING, SYSTEM_EXPORT_DESTINATIONS, SYSTEM_REPORT_FORMATS, SYSTEM_REPORT_NAMES, VISUAL_EXCEL_FORMAT_REPORT, } from '../../Utilities/Constants/GeneralConstants';
 export class ExportApiImpl extends ApiBase {
     constructor(_adaptable) {
         super(_adaptable);
@@ -14,6 +14,9 @@ export class ExportApiImpl extends ApiBase {
     getCurrentReportName() {
         return this.getExportState().CurrentReport;
     }
+    getCurrentReportFormat() {
+        return this.getExportState().CurrentFormat;
+    }
     getCurrentReport() {
         const reportName = this.getCurrentReportName();
         return this.getReportByName(reportName);
@@ -38,20 +41,57 @@ export class ExportApiImpl extends ApiBase {
         return this.getCustomDestinations().find((destination) => destination.name === destinationName);
     }
     getAvailableSystemReports() {
-        return this.getExportOptions().systemReportNames.filter((s) => this.internalApi.isSystemReportActive(s));
+        const systemReportNamesOption = this.getExportOptions().systemReportNames;
+        const reportNames = typeof systemReportNamesOption === 'function'
+            ? systemReportNamesOption({
+                ...this.getAdaptableInternalApi().buildBaseContext(),
+                defaultSystemReportNames: SYSTEM_REPORT_NAMES,
+                currentLayoutName: this.getLayoutApi().getCurrentLayoutName(),
+            })
+            : systemReportNamesOption;
+        return reportNames.filter((s) => this.internalApi.isSystemReportActive(s));
     }
     getAvailableSystemFormats() {
-        const availableReportFormats = this.getExportOptions().systemReportFormats;
-        return availableReportFormats.filter((format) => {
+        const systemReportFormatsOption = this.getExportOptions().systemReportFormats;
+        const reportFormats = typeof systemReportFormatsOption === 'function'
+            ? systemReportFormatsOption({
+                ...this.getAdaptableInternalApi().buildBaseContext(),
+                defaultSystemReportFormats: SYSTEM_REPORT_FORMATS,
+                currentLayoutName: this.getLayoutApi().getCurrentLayoutName(),
+                currentReportName: this.getExportApi().getCurrentReportName(),
+            })
+            : systemReportFormatsOption;
+        return reportFormats.filter((format) => {
             // JSON format doesn't support Master Detail Grid
             if (this.getGridApi().isMasterDetailGrid()) {
                 return format !== 'JSON';
             }
+            // PivotLayout & AllData can't be exported as VisualExcel
+            if (this.getExportApi().getCurrentReportName() === ALL_DATA_REPORT &&
+                this.getLayoutApi().isCurrentLayoutPivot()) {
+                return format !== 'VisualExcel';
+            }
             return true;
         });
     }
     getAvailableSystemDestinations() {
-        return this.getExportOptions().systemExportDestinations;
+        const systemExportDestinationsOption = this.getExportOptions().systemExportDestinations;
+        const systemExportDestinations = typeof systemExportDestinationsOption === 'function'
+            ? systemExportDestinationsOption({
+                ...this.getAdaptableInternalApi().buildBaseContext(),
+                defaultSystemExportDestinations: SYSTEM_EXPORT_DESTINATIONS,
+                currentLayoutName: this.getLayoutApi().getCurrentLayoutName(),
+                currentReportName: this.getExportApi().getCurrentReportName(),
+                currentReportFormat: this.getExportApi().getCurrentReportFormat(),
+            })
+            : systemExportDestinationsOption;
+        return systemExportDestinations.filter((destination) => {
+            // VisualExcel format can't be exported to custom destinations
+            if (this.getExportApi().getCurrentReportFormat() === VISUAL_EXCEL_FORMAT_REPORT) {
+                return false;
+            }
+            return true;
+        });
     }
     getAllExportDestinations() {
         const destinationItems = [
@@ -139,7 +179,7 @@ export class ExportApiImpl extends ApiBase {
             return true;
         });
     }
-    async exportReport(reportName, format, destination = 'Download') {
+    async exportReport(reportName, format, destination = 'Download', config) {
         let report = this.getReportByName(reportName);
         if (!this.checkItemExists(report, reportName, 'Report')) {
             return;
@@ -157,7 +197,8 @@ export class ExportApiImpl extends ApiBase {
                 report,
                 format,
                 destination,
-                showProgressIndicator: true,
+                showProgressIndicator: config?.showProgressIndicator === false ? false : true,
+                customExportParams: config?.exportParams,
             });
             if (!exportedReport) {
                 // for destination 'Download' and format 'Excel', 'VisualExcel' or 'Csv', AG Grid handles the download as well
@@ -176,7 +217,7 @@ export class ExportApiImpl extends ApiBase {
         }
         this.logInfo(`Finished Export of ${reportName} in format ${format} to ${destination}`);
     }
-    async getReportData(reportName, format) {
+    async getReportData(reportName, format, config) {
         let report = this.getReportByName(reportName);
         if (!this.checkItemExists(report, reportName, 'Report')) {
             return;
@@ -193,7 +234,8 @@ export class ExportApiImpl extends ApiBase {
                 report,
                 format,
                 destination: 'Clipboard',
-                showProgressIndicator: false,
+                showProgressIndicator: config?.showProgressIndicator === false ? false : true,
+                customExportParams: config?.exportParams,
             });
         }
         this.logInfo(`Finished getting Report Data for ${reportName} in format ${format}`);

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

@@ -17,6 +17,7 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
         [key: string]: boolean;
     };
     getCurrentVisibleColumnIdsForTableLayout(): string[];
+    getCurrentVisibleColumnIdsForPivotLayout(): string[];
     getCurrentRowGroupsColumnIds(): string[];
     setLayout(layoutName: string): void;
     getCurrentLayout(): Layout;

package/src/Api/Implementation/LayoutApiImpl.js

@@ -43,6 +43,15 @@ export class LayoutApiImpl extends ApiBase {
         }
         return layout.TableColumns.filter((colId) => !layout.ColumnVisibility || layout.ColumnVisibility?.[colId] !== false);
     }
+    getCurrentVisibleColumnIdsForPivotLayout() {
+        const layout = this.getCurrentLayout();
+        if (!isPivotLayout(layout)) {
+            return [];
+        }
+        return this.getAgGridApi()
+            .getAllDisplayedColumns()
+            .map((col) => col.getColId());
+    }
     getCurrentRowGroupsColumnIds() {
         const layout = this.getCurrentLayout();
         if (isPivotLayout(layout)) {

package/src/Api/Implementation/LayoutHelpers.js

@@ -108,6 +108,17 @@ export const tableLayoutToTableLayoutModel = (tableLayout) => {
                     Values: tableLayout.RowGroupValues.ExceptionGroupKeys || [],
                 }
             : undefined,
+        ColumnGroupValues: tableLayout.ColumnGroupValues
+            ? tableLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-expanded' ||
+                tableLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-collapsed'
+                ? {
+                    ColumnGroupDisplay: tableLayout.ColumnGroupValues.ColumnGroupDefaultBehavior,
+                }
+                : {
+                    ColumnGroupDisplay: tableLayout.ColumnGroupValues.ColumnGroupDefaultBehavior,
+                    Values: tableLayout.ColumnGroupValues.ExceptionGroupKeys || [],
+                }
+            : undefined,
         TableAggregationColumns: TableAggregationColumns,
         GrandTotalRow: tableLayout.GrandTotalRow,
     });
@@ -180,6 +191,17 @@ export const pivotLayoutToPivotLayoutModel = (pivotLayout) => {
                     Values: pivotLayout.RowGroupValues.ExceptionGroupKeys || [],
                 }
             : undefined,
+        ColumnGroupValues: pivotLayout.ColumnGroupValues
+            ? pivotLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-expanded' ||
+                pivotLayout.ColumnGroupValues.ColumnGroupDefaultBehavior === 'always-collapsed'
+                ? {
+                    ColumnGroupDisplay: pivotLayout.ColumnGroupValues.ColumnGroupDefaultBehavior,
+                }
+                : {
+                    ColumnGroupDisplay: pivotLayout.ColumnGroupValues.ColumnGroupDefaultBehavior,
+                    Values: pivotLayout.ColumnGroupValues.ExceptionGroupKeys || [],
+                }
+            : undefined,
     });
     if (pivotLayout.ColumnFilters) {
         result.Ignore_ColumnFilters = pivotLayout.ColumnFilters;
@@ -286,6 +308,17 @@ export const tableLayoutModelToTableLayout = (layoutModel) => {
     else {
         delete tableLayout.RowGroupValues;
     }
+    if (layoutModel.ColumnGroupValues) {
+        tableLayout.ColumnGroupValues = {
+            ColumnGroupDefaultBehavior: layoutModel.ColumnGroupValues.ColumnGroupDisplay,
+        };
+        if ((layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'collapsed' ||
+            layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'expanded') &&
+            layoutModel.ColumnGroupValues.Values) {
+            // @ts-ignore
+            tableLayout.ColumnGroupValues.ExceptionGroupKeys = layoutModel.ColumnGroupValues.Values;
+        }
+    }
     if (layoutModel.TableAggregationColumns) {
         tableLayout.TableAggregationColumns = layoutModel.TableAggregationColumns.map(({ ColumnId, AggFunc }) => {
             return {
@@ -405,6 +438,17 @@ export const pivotLayoutModelToPivotLayout = (layoutModel) => {
     else {
         delete pivotLayout.PivotAggregationColumns;
     }
+    if (layoutModel.ColumnGroupValues) {
+        pivotLayout.ColumnGroupValues = {
+            ColumnGroupDefaultBehavior: layoutModel.ColumnGroupValues.ColumnGroupDisplay,
+        };
+        if ((layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'collapsed' ||
+            layoutModel.ColumnGroupValues.ColumnGroupDisplay === 'expanded') &&
+            layoutModel.ColumnGroupValues.Values) {
+            // @ts-ignore
+            pivotLayout.ColumnGroupValues.ExceptionGroupKeys = layoutModel.ColumnGroupValues.Values;
+        }
+    }
     return pivotLayout;
 };
 export const isPivotLayout = (layout) => Array.isArray(layout.PivotColumns);

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

@@ -6,8 +6,12 @@ export declare class QuickSearchApiImpl extends ApiBase implements QuickSearchAp
     getQuickSearchState(): QuickSearchState;
     runQuickSearch(quickSearchText: string): void;
     clearQuickSearch(): void;
+    gotoNextMatch(): void;
+    gotoPreviousMatch(): void;
     getQuickSearchValue(): string;
     getQuickSearchStyle(): AdaptableStyle;
+    getQuickSearchTextMatchStyle(): AdaptableStyle | undefined;
+    getQuickSearchCurrentTextMatchStyle(): AdaptableStyle | undefined;
     setQuickSearchStyle(style: AdaptableStyle): void;
     openQuickSearchSettingsPanel(): void;
     showFloatingQuickSearch(): void;

package/src/Api/Implementation/QuickSearchApiImpl.js

@@ -12,12 +12,24 @@ export class QuickSearchApiImpl extends ApiBase {
     clearQuickSearch() {
         this.dispatchAction(QuickSearchRedux.QuickSearchRun(''));
     }
+    gotoNextMatch() {
+        this.getAdaptableApi().agGridApi.findNext();
+    }
+    gotoPreviousMatch() {
+        this.getAdaptableApi().agGridApi.findPrevious();
+    }
     getQuickSearchValue() {
         return this.getQuickSearchState().QuickSearchText;
     }
     getQuickSearchStyle() {
         return this.getQuickSearchState().Style;
     }
+    getQuickSearchTextMatchStyle() {
+        return this.getQuickSearchState().TextMatchStyle;
+    }
+    getQuickSearchCurrentTextMatchStyle() {
+        return this.getQuickSearchState().CurrentTextMatchStyle;
+    }
     setQuickSearchStyle(style) {
         this.dispatchAction(QuickSearchRedux.QuickSearchSetStyle(style));
     }

package/src/Api/Internal/AlertInternalApi.js

@@ -606,7 +606,7 @@ export class AlertInternalApi extends ApiBase {
         const rule = alertDefinition.Rule;
         if (rule) {
             if (rule.Predicates) {
-                return this.getExpressionApi().internalApi.evaluatePredicatesInAdaptableQL('Alert', alertDefinition, alertDefinition.Rule.Predicates);
+                return this.getExpressionApi().internalApi.shouldEvaluatePredicatesInAdaptableQL('Alert', alertDefinition, alertDefinition.Rule.Predicates);
             }
             else {
                 var expression = this.getExpressionForAlertRule(rule);

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

@@ -1,9 +1,9 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { CellDataChangedInfo } from '../../AdaptableState/Common/CellDataChangedInfo';
 import { Report, ReportData, ReportFormatType, ReportNameType, SystemReportName } from '../../AdaptableState/ExportState';
-import { CsvCell, ExcelCell, ExcelDataType, IRowNode } from 'ag-grid-enterprise';
-import { AdaptableColumn, AdaptableColumnDataType } from '../../AdaptableState/Common/AdaptableColumn';
-import { BaseExportContext, DataFormatType, ExportDestinationType, ExportResultData, ProcessExportContext } from '../../AdaptableOptions/ExportOptions';
+import { CsvCell, ExcelCell, ExcelDataType } from 'ag-grid-enterprise';
+import { AdaptableColumn } from '../../AdaptableState/Common/AdaptableColumn';
+import { BaseExportContext, ExportDestinationType, ExportResultData, ProcessExportContext } from '../../AdaptableOptions/ExportOptions';
 import { ExportProcessData } from '../../agGrid/AgGridExportAdapter';
 export declare class ExportInternalApi extends ApiBase {
     /**
@@ -14,7 +14,6 @@ export declare class ExportInternalApi extends ApiBase {
     setExportInProgress(reportName: ReportNameType, reportFormat: ReportFormatType, exportDestination: ExportDestinationType): void;
     setExportComplete(): void;
     isVisualDataExportInProgress(): boolean;
-    getCellExportFormatType(column: AdaptableColumn, columnDataType: AdaptableColumnDataType): DataFormatType;
     createSystemReport(systemReportName: SystemReportName): Report;
     isSystemReport(reportName: ReportNameType): boolean;
     isSystemDestination(destination: ExportDestinationType): boolean;
@@ -24,11 +23,7 @@ export declare class ExportInternalApi extends ApiBase {
     getReportExpressionDescription(report: Report, cols: AdaptableColumn[]): string;
     convertReportDataToArray(reportData: ReportData): any[][];
     publishLiveLiveDataChangedEvent(reportDestination: 'ipushpull' | 'OpenFin', liveDataTrigger: 'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated', liveReport?: any): void;
-    getCellExportValueFromRowNode(rowNode: IRowNode, columnId: string, isVisualReport?: boolean): any;
-    getCellExportValueFromRawValue(rowNode: IRowNode, cellRawValue: any, columnId: string, isVisualReport?: boolean): any;
     getReportFileName(reportName: string, reportFormat: ReportFormatType, destination: ExportDestinationType): string;
-    private getCustomExportDateFormat;
-    private getCellExportValueFromRawValueByType;
     sendReportToDestination(reportResult: ExportResultData, report: Report, format: ReportFormatType, destination: ExportDestinationType): void;
     private sendReportToCustomDestination;
     buildBaseExportContext(reportName: ReportNameType, reportFormat: ReportFormatType, exportDestination?: ExportDestinationType): BaseExportContext;

package/src/Api/Internal/ExportInternalApi.js

@@ -3,7 +3,7 @@ import { createGrid, } from 'ag-grid-enterprise';
 import { createUuid } from '../../AdaptableState/Uuid';
 import { ALL_DATA_REPORT, CURRENT_LAYOUT_REPORT, SELECTED_DATA_REPORT, SYSTEM_EXPORT_DESTINATIONS, SYSTEM_REPORT_NAMES, } from '../../Utilities/Constants/GeneralConstants';
 import StringExtensions from '../../Utilities/Extensions/StringExtensions';
-import FormatHelper, { DateFormatter } from '../../Utilities/Helpers/FormatHelper';
+import { DateFormatter } from '../../Utilities/Helpers/FormatHelper';
 import Helper from '../../Utilities/Helpers/Helper';
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
 import { SystemExportBegin, SystemExportEnd } from '../../Redux/ActionsReducers/InternalRedux';
@@ -82,43 +82,6 @@ export class ExportInternalApi extends ApiBase {
     isVisualDataExportInProgress() {
         return this.getAdaptableState().Internal.Export.inProgress?.reportFormat === 'VisualExcel';
     }
-    getCellExportFormatType(column, columnDataType) {
-        const exportOptions = this.getExportOptions();
-        const exportDataFormat = exportOptions.exportDataFormat;
-        // First check if a function was provided and return the result
-        if (exportDataFormat != null && typeof exportDataFormat === 'function') {
-            const context = {
-                ...this.getAdaptableInternalApi().buildBaseContext(),
-                column: column,
-            };
-            return exportDataFormat(context);
-        }
-        // Next Check if a "hard-coded" value has been provided and return that
-        if (exportDataFormat === 'rawValue') {
-            return 'rawValue';
-        }
-        if (exportDataFormat === 'formattedValue') {
-            return 'formattedValue';
-        }
-        // Finally test if a DataType object has been provided and return the relevant property
-        const dataFormatDataType = exportDataFormat;
-        if (dataFormatDataType) {
-            // format is customized based on column data type
-            switch (columnDataType) {
-                case 'text':
-                    return dataFormatDataType.text;
-                case 'number':
-                    return dataFormatDataType.number;
-                case 'date':
-                case 'dateString':
-                    return dataFormatDataType.date;
-                default:
-                    // default to rawValue for all other column types
-                    return 'rawValue';
-            }
-        }
-        return 'rawValue';
-    }
     createSystemReport(systemReportName) {
         switch (systemReportName) {
             case ALL_DATA_REPORT:
@@ -222,31 +185,6 @@ export class ExportInternalApi extends ApiBase {
         };
         this.getAdaptableApi().eventApi.emit('LiveDataChanged', liveDataChangedInfo);
     }
-    getCellExportValueFromRowNode(rowNode, columnId, isVisualReport) {
-        return this.getCellExportValueFromRawValue(rowNode, this.getAdaptableApi().gridApi.getRawValueFromRowNode(rowNode, columnId), columnId, isVisualReport);
-    }
-    getCellExportValueFromRawValue(rowNode, cellRawValue, columnId, isVisualReport) {
-        if (StringExtensions.IsNullOrEmpty(cellRawValue)) {
-            return cellRawValue;
-        }
-        const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
-        const columnDataType = column.dataType;
-        // 1. if it is a VisualExcel report format, we always ONLY send the formatted value and ignore all other properties
-        if (isVisualReport) {
-            return this.getCellExportValueFromRawValueByType(rowNode, cellRawValue, columnId, 'formattedValue');
-        }
-        const isDateColumn = columnDataType === 'date' || columnDataType === 'dateString';
-        // 2. if this is a date column and there is a custom export date format provided, that will next take precedence
-        if (isDateColumn && !!this.getCustomExportDateFormat()) {
-            const exportDateFormat = this.getCustomExportDateFormat();
-            return FormatHelper.DateFormatter(cellRawValue, {
-                Pattern: exportDateFormat,
-            });
-        }
-        // 3. in all other cases check the general export format types
-        const cellExportFormat = this.getAdaptableApi().exportApi.internalApi.getCellExportFormatType(column, columnDataType);
-        return this.getCellExportValueFromRawValueByType(rowNode, cellRawValue, columnId, cellExportFormat);
-    }
     getReportFileName(reportName, reportFormat, destination) {
         let fileName = StringExtensions.ReplaceEmptySpacesWithUnderscore(`${reportName}-${reportFormat}`);
         const reportFilename = this.getAdaptableApi().optionsApi.getExportOptions().reportFilename;
@@ -266,17 +204,6 @@ export class ExportInternalApi extends ApiBase {
         }
         return fileName;
     }
-    getCustomExportDateFormat() {
-        return this.getAdaptableApi().optionsApi.getExportOptions().exportDateFormat;
-    }
-    getCellExportValueFromRawValueByType(rowNode, cellRawValue, columnId, 
-    // default to rawValue if, for some reason, the configs provide invalid values
-    type = 'rawValue') {
-        return type === 'rawValue'
-            ? cellRawValue
-            : // type === formattedValue
-                this.getAdaptableApi().gridApi.getDisplayValueFromRawValue(rowNode, columnId, cellRawValue);
-    }
     sendReportToDestination(reportResult, report, format, destination) {
         if (!reportResult?.data) {
             this.logWarn(`No report result to send to destination for report '${report.Name}, format '${format}' and destination '${destination}'`);

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

@@ -9,7 +9,7 @@ export declare class ExpressionInternalApi extends ApiBase {
      */
     isColumnReferencedInExpression(columnId: string, expression: string): boolean;
     evaluateExpressionInAdaptableQL(module: AdaptableQLModule, object?: AdaptableObject, expression?: string): boolean;
-    evaluatePredicatesInAdaptableQL(module: AdaptableQLModule, object?: AdaptableObject, predicates?: AdaptablePredicate[]): boolean;
+    shouldEvaluatePredicatesInAdaptableQL(module: AdaptableQLModule, object?: AdaptableObject, predicates?: AdaptablePredicate[]): boolean;
     private getFieldsFromOptions;
     getAvailableFields(data?: Record<string, any>): AdaptableField[];
     getFieldType(field: string): AdaptableField['dataType'];