@adaptabletools/adaptable 14.0.2 → 14.0.4

package/src/Api/Implementation/ChartingApiImpl.js

@@ -7,7 +7,13 @@ const ChartingRedux = tslib_1.__importStar(require("./../../Redux/ActionsReducer
 const ChartingRedux_1 = require("./../../Redux/ActionsReducers/ChartingRedux");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 const logDeprecation_1 = require("../../Utilities/logDeprecation");
+const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
+const ChartingInternalApi_1 = require("../Internal/ChartingInternalApi");
 class ChartingApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new ChartingInternalApi_1.ChartingInternalApi(adaptable);
+    }
     isChartingEnabled() {
         return this.adaptable.canGenerateCharts();
     }
@@ -39,24 +45,70 @@ class ChartingApiImpl extends ApiBase_1.ApiBase {
     getChartDefinitionByUuid(uuid) {
         return this.getChartDefinitions().find((c) => c.Uuid == uuid);
     }
+    getChartDefinitionByName(name) {
+        if (StringExtensions_1.default.IsNotNullOrEmpty(name)) {
+            let chartDefinition = this.getChartDefinitions().find((c) => c.Name == name);
+            if (this.checkItemExists(chartDefinition, name, 'Chart')) {
+                return chartDefinition;
+            }
+        }
+    }
     showPersistedCharts() {
         return this.adaptable.showCharts(this.getChartDefinitions());
     }
     showChartDefinition(chartDefiniton, container) {
-        return this.adaptable.showChart(chartDefiniton, container);
+        let containerElement = container;
+        if (typeof containerElement === 'string') {
+            containerElement = this.internalApi.getContainerElemetnByName(containerElement);
+        }
+        return this.adaptable.showChart(chartDefiniton, containerElement);
     }
     showChartDefinitionOnce(chartDefinition, container) {
-        const chartRef = this.adaptable.api.chartingApi.getChartRef(chartDefinition.Model.chartId);
+        var _a;
+        const chartRef = this.adaptable.api.chartingApi.getChartRef((_a = chartDefinition === null || chartDefinition === void 0 ? void 0 : chartDefinition.Model) === null || _a === void 0 ? void 0 : _a.chartId);
         if (chartRef) {
             return;
         }
         return this.showChartDefinition(chartDefinition, container);
     }
+    closeChartDefinition(chartDefinition) {
+        const chartRef = this.getChartRef(chartDefinition.Model.chartId);
+        if (chartRef) {
+            chartRef.destroyChart();
+        }
+    }
     editChartDefinition(editedChartDefinition) {
         this.dispatchAction(ChartingRedux.ChartingEditChart(editedChartDefinition));
     }
     addChartDefinition(chart) {
         this.dispatchAction(ChartingRedux.ChartingAddChart(chart));
     }
+    getChartingOpenState() {
+        return {
+            charts: this.getChartDefinitions().map((chartDefinition) => {
+                var _a, _b;
+                return {
+                    chartDefinition,
+                    isOpen: this.getChartRef((_a = chartDefinition === null || chartDefinition === void 0 ? void 0 : chartDefinition.Model) === null || _a === void 0 ? void 0 : _a.chartId) != null,
+                    containerName: (_b = this.getOpenChartContainer(chartDefinition)) === null || _b === void 0 ? void 0 : _b.name,
+                };
+            }),
+        };
+    }
+    getOpenChartContainer(chartDefinition) {
+        var _a, _b, _c;
+        const containerOptions = (_b = (_a = this.adaptable.api.optionsApi.getAdaptableOptions()) === null || _a === void 0 ? void 0 : _a.chartingOptions) === null || _b === void 0 ? void 0 : _b.chartContainers;
+        if (!containerOptions || !containerOptions.length) {
+            return null;
+        }
+        return ((_c = containerOptions.find((container) => {
+            const chartRef = this.getChartRef(chartDefinition.Model.chartId);
+            const containerElement = this.internalApi.getContainerElement(container);
+            if (!(chartRef === null || chartRef === void 0 ? void 0 : chartRef.chartElement) || !containerElement) {
+                return false;
+            }
+            return containerElement.contains(chartRef.chartElement);
+        })) !== null && _c !== void 0 ? _c : null);
+    }
 }
 exports.ChartingApiImpl = ChartingApiImpl;

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

@@ -72,6 +72,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getPivotableColumns(): AdaptableColumn[];
     getAggregatableColumns(): AdaptableColumn[];
     getQueryableColumns(): AdaptableColumn[];
+    getExportableColumns(): AdaptableColumn[];
     private logMissingColumnWarning;
     getDistinctDisplayValuesForColumn(columnId: string): any[];
     getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string, showFilteredRowsOnly: boolean): Promise<{

package/src/Api/Implementation/ColumnApiImpl.js

@@ -367,6 +367,9 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     getQueryableColumns() {
         return this.getColumns().filter((c) => c.queryable);
     }
+    getExportableColumns() {
+        return this.getColumns().filter((c) => c.exportable);
+    }
     logMissingColumnWarning(columnId) {
         if (this.adaptable.adaptableOptions.columnOptions.showMissingColumnsWarning === true) {
             if (!this.isAutoRowGroupColumn(columnId) &&

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

@@ -7,6 +7,7 @@ import { CustomDestination, ExportFormContext, ServerReport } from '../../Adapta
 import { ExportDestination } from '../../PredefinedConfig/Common/Enums';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { ExportInternalApi } from '../Internal/ExportInternalApi';
+import { AdaptableColumnBase } from '../../types';
 export declare class ExportApiImpl extends ApiBase implements ExportApi {
     internalApi: ExportInternalApi;
     constructor(adaptable: IAdaptable);
@@ -42,4 +43,5 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     isServerReport(report: Report): boolean;
     runServerReport(serverReportName: string): ReportData | undefined;
     getReportDataForReport(reportName: string): ReportData | undefined;
+    isColumnExportable(adaptableColumn: AdaptableColumnBase): boolean;
 }

package/src/Api/Implementation/ExportApiImpl.js

@@ -168,5 +168,15 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         }
         return this.adaptable.api.internalApi.getReportService().getReportData(report);
     }
+    isColumnExportable(adaptableColumn) {
+        const isExportableFn = this.getExportOptions().isColumnExportable;
+        if (typeof isExportableFn === 'function') {
+            return isExportableFn({
+                adaptableApi: this.adaptable.api,
+                adaptableColumn,
+            });
+        }
+        return true;
+    }
 }
 exports.ExportApiImpl = ExportApiImpl;

package/src/Api/Implementation/FilterApiImpl.js

@@ -137,11 +137,9 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
         return this.internalApi.createEqualityColumnFilterForCell(gridCell);
     }
     columnFilterToString(columnFilter) {
-        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'columnFilterToString');
         return this.internalApi.columnFilterToString(columnFilter);
     }
     columnFiltersToString(columnFilters) {
-        (0, logDeprecation_1.logDeprecationInternal)('FilterApi', 'columnFiltersToString');
         return this.internalApi.columnFiltersToString(columnFilters);
     }
     evaluateColumnFilter(columnFilter, node) {

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

@@ -1,7 +1,7 @@
 import { ApiBase } from './ApiBase';
 import { PredicateApi } from '../PredicateApi';
-import { AdaptablePredicate, AdaptablePredicateDef, PredicateDefHandlerParams, PredicateModuleScope } from '../../PredefinedConfig/Common/AdaptablePredicate';
-import { AdaptableColumnDataType, SystemFilterPredicateId } from '../../types';
+import { PredicateDefHandlerParams, PredicateModuleScope } from '../../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicate, AdaptablePredicateDef, AdaptableColumnDataType, AdaptableColumnPredicate, SystemFilterPredicateId } from '../../types';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { PredicateInternalApi } from '../Internal/PredicateInternalApi';
 export declare class PredicateApiImpl extends ApiBase implements PredicateApi {
@@ -14,10 +14,12 @@ export declare class PredicateApiImpl extends ApiBase implements PredicateApi {
     getPredicateDefById(predicateId: string): AdaptablePredicateDef;
     getSystemPredicateDefById(predicateId: string): AdaptablePredicateDef;
     getCustomPredicateDefById(predicateId: string): AdaptablePredicateDef;
-    predicateToString(predicate: AdaptablePredicate): string | undefined;
-    isValidPredicate(predicate: AdaptablePredicate | undefined): boolean;
+    predicateToString(predicate: AdaptableColumnPredicate): string | undefined;
+    isValidPredicate(predicate: AdaptableColumnPredicate | undefined): boolean;
     arePredicatesValid(predicates: AdaptablePredicate[]): boolean;
     isEveryPredicateValid(predicates: AdaptablePredicate[]): boolean;
+    handleColumnPredicate(predicate: AdaptableColumnPredicate | undefined, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
+    handleColumnPredicates(predicates: AdaptableColumnPredicate[], params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
     handlePredicate(predicate: AdaptablePredicate | undefined, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
     handlePredicates(predicates: AdaptablePredicate[], params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
     getEqualityPredicateForDataType(dataType: AdaptableColumnDataType): SystemFilterPredicateId;

package/src/Api/Implementation/PredicateApiImpl.js

@@ -42,9 +42,13 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
             (0, LoggingHelper_1.LogAdaptableWarning)('Cannot find Predicate with Id:' + predicate.PredicateId);
             return '[Predicate Not found]';
         }
-        return predicateDef.hasOwnProperty('toString')
+        let strPredicate = predicateDef.hasOwnProperty('toString')
             ? predicateDef.toString({ inputs: predicate.Inputs })
             : predicateDef.label;
+        if ('ColumnId' in predicate) {
+            strPredicate = `[${predicate.ColumnId}] ${strPredicate}`;
+        }
+        return strPredicate;
     }
     isValidPredicate(predicate) {
         if (!predicate) {
@@ -71,6 +75,21 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
     isEveryPredicateValid(predicates) {
         return predicates.every((predicate) => this.isValidPredicate(predicate));
     }
+    handleColumnPredicate(predicate, params, defaultReturn) {
+        if (!predicate.ColumnId) {
+            return this.handlePredicate(predicate, params, defaultReturn);
+        }
+        const paramsForColumn = Object.assign(Object.assign({}, params), { column: this.adaptable.api.columnApi.getColumnWithColumnId(predicate.ColumnId), 
+            // value: params?.node?.data?.[predicate.ColumnId],
+            value: this.adaptable.api.gridApi.getRawValueFromRowNode(params.node, predicate.ColumnId) });
+        if ('oldValue' in paramsForColumn) {
+            delete paramsForColumn.oldValue;
+        }
+        return this.handlePredicate(predicate, paramsForColumn, defaultReturn);
+    }
+    handleColumnPredicates(predicates, params, defaultReturn) {
+        return predicates.every((predicate) => this.handleColumnPredicate(predicate, params, defaultReturn));
+    }
     handlePredicate(predicate, params, defaultReturn) {
         var _a;
         if (!predicate) {

package/src/Api/Implementation/QueryApiImpl.js

@@ -67,8 +67,14 @@ class QueryApiImpl extends ApiBase_1.ApiBase {
     }
     expandCurrentQuery(query) {
         const preparedQuery = query !== null && query !== void 0 ? query : this.getCurrentQuery();
-        this.getAdaptableApi().internalApi.showPopupWindow(windowFactory_1.WINDOW_QUERY_EDITOR, 'Current Query', 'query', {
-            value: preparedQuery,
+        this.getAdaptableApi().internalApi.showPopupWindow({
+            id: windowFactory_1.WINDOW_QUERY_EDITOR,
+            title: 'Current Query',
+            icon: 'query',
+            factoryId: windowFactory_1.WINDOW_QUERY_EDITOR,
+            popupProps: {
+                value: preparedQuery,
+            },
         });
     }
     fireQueryRunEvent() {

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

@@ -34,7 +34,13 @@ export declare class AdaptableInternalApi extends ApiBase {
     showPopupScreen(module: AdaptableModule, componentName: string, popupParams?: ModuleParams, popupProps?: {
         [key: string]: any;
     }): void;
-    showPopupWindow(id: string, title: string, icon: string, popupProps: any): void;
+    showPopupWindow({ id, title, icon, popupProps, factoryId, }: {
+        id: string;
+        title: string;
+        icon?: string;
+        popupProps: any;
+        factoryId: string;
+    }): void;
     hidePopupScreen(): void;
     setSettingPanelModuleMenuItems(menuItems: AdaptableMenuItem[]): void;
     setModuleButtonMenuItems(menuItems: AdaptableMenuItem[]): void;

package/src/Api/Internal/AdaptableInternalApi.js

@@ -30,12 +30,13 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     showPopupScreen(module, componentName, popupParams, popupProps) {
         this.dispatchAction(PopupRedux.PopupShowScreen(module, componentName, popupParams, popupProps));
     }
-    showPopupWindow(id, title, icon, popupProps) {
+    showPopupWindow({ id, title, icon, popupProps, factoryId, }) {
         this.dispatchAction(PopupRedux.PopupShowWindow({
             Id: id,
             Title: title,
             Icon: icon,
             PopupProps: popupProps,
+            FactoryId: factoryId,
         }));
     }
     hidePopupScreen() {

package/src/Api/Internal/AlertInternalApi.js

@@ -461,7 +461,7 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
     }
     isAlertPredicateTriggered(alert, dataChangedEvent, defaultNoPredicateReturn = false) {
         var _a;
-        return this.getAdaptableApi().predicateApi.handlePredicates((_a = alert.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, {
+        return this.getAdaptableApi().predicateApi.handleColumnPredicates((_a = alert.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, {
             value: dataChangedEvent.newValue,
             oldValue: dataChangedEvent.oldValue,
             // TODO send real display value

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

@@ -1,5 +1,6 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { CalculatedColumn } from '../../PredefinedConfig/CalculatedColumnState';
+import { AdaptableColumn } from '../../types';
 export declare class CalculatedColumnInternalApi extends ApiBase {
     /**
      * Returns all the references in the AdaptableState of the given CalculatedColumn
@@ -21,4 +22,5 @@ export declare class CalculatedColumnInternalApi extends ApiBase {
      * @param calculatedColumnId CalculatedColumnId to check
      */
     getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId: string): string[];
+    getCalculatedColumnsDependentOnColumn(column: AdaptableColumn): string[];
 }

package/src/Api/Internal/CalculatedColumnInternalApi.js

@@ -53,5 +53,14 @@ class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
             return this.getReferencedColumnIdsForCalculatedColumn(calculatedColumn);
         }
     }
+    getCalculatedColumnsDependentOnColumn(column) {
+        const calculatedColumns = this.adaptable.api.calculatedColumnApi.getCalculatedColumns();
+        return calculatedColumns
+            .filter((calculatedColumn) => {
+            const dependentColumns = this.getReferencedColumnIdsForCalculatedColumnId(calculatedColumn.ColumnId);
+            return dependentColumns.includes(column.columnId);
+        })
+            .map((calculatedColumn) => calculatedColumn.ColumnId);
+    }
 }
 exports.CalculatedColumnInternalApi = CalculatedColumnInternalApi;

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

@@ -0,0 +1,6 @@
+import { ApiBase } from '../Implementation/ApiBase';
+import { ChartContainer } from '../../types';
+export declare class ChartingInternalApi extends ApiBase {
+    getContainerElement(chartContainer: ChartContainer): HTMLElement | null;
+    getContainerElemetnByName(containerName: string): HTMLElement | null;
+}

package/src/Api/Internal/ChartingInternalApi.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChartingInternalApi = void 0;
+const ApiBase_1 = require("../Implementation/ApiBase");
+const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
+class ChartingInternalApi extends ApiBase_1.ApiBase {
+    getContainerElement(chartContainer) {
+        const element = typeof (chartContainer === null || chartContainer === void 0 ? void 0 : chartContainer.element) === 'string'
+            ? document.querySelector(chartContainer.element)
+            : chartContainer === null || chartContainer === void 0 ? void 0 : chartContainer.element;
+        if (!element && typeof (chartContainer === null || chartContainer === void 0 ? void 0 : chartContainer.element) === 'string') {
+            (0, LoggingHelper_1.ConsoleLogByMessageType)(`Chart container element not found: ${chartContainer.element}`, 'Error');
+            return null;
+        }
+        return element;
+    }
+    getContainerElemetnByName(containerName) {
+        var _a, _b, _c;
+        const chartContainers = (_c = (_b = (_a = this.adaptable.api.optionsApi.getAdaptableOptions()) === null || _a === void 0 ? void 0 : _a.chartingOptions) === null || _b === void 0 ? void 0 : _b.chartContainers) !== null && _c !== void 0 ? _c : [];
+        const chartContainer = chartContainers.find((container) => container.name === containerName);
+        return this.getContainerElement(chartContainer);
+    }
+}
+exports.ChartingInternalApi = ChartingInternalApi;

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

@@ -117,4 +117,9 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @returns Format Columns with Expression
      */
     getFormatColumnsWithExpression(): FormatColumn[];
+    getFormatColumnsDependentOnColumns(columnSet: Set<string>): FormatColumn[];
+    /**
+     * Retrieves the columns that need rerendering based on format column predicates.
+     */
+    getFormatColumnColumnsDependentOnColumnChange(column: AdaptableColumn): string[];
 }

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -193,7 +193,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             node: node,
             column: column,
         };
-        return this.adaptable.api.predicateApi.handlePredicates((_a = formatColumn.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, params, false);
+        return this.adaptable.api.predicateApi.handleColumnPredicates((_a = formatColumn.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, params, false);
     }
     evaluateExpression(formatColumn, node) {
         const isValidExpression = this.adaptable.api.queryLanguageApi.isValidBooleanExpression(formatColumn.Rule.BooleanExpression, ModuleConstants.FormatColumnModuleId, `Invalid format column rule '${formatColumn.Rule.BooleanExpression}'`);
@@ -231,5 +231,29 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             .getFormatColumns()
             .filter((fc) => { var _a; return !!((_a = fc.Rule) === null || _a === void 0 ? void 0 : _a.BooleanExpression); });
     }
+    getFormatColumnsDependentOnColumns(columnSet) {
+        return this.getFormatColumnApi()
+            .getFormatColumns()
+            .filter((fc) => { var _a, _b; return (_b = (_a = fc.Rule) === null || _a === void 0 ? void 0 : _a.Predicates) === null || _b === void 0 ? void 0 : _b.some((p) => columnSet.has(p.ColumnId)); });
+    }
+    /**
+     * Retrieves the columns that need rerendering based on format column predicates.
+     */
+    getFormatColumnColumnsDependentOnColumnChange(column) {
+        const impactedColumnIds = new Set();
+        impactedColumnIds.add(column.columnId);
+        this.getCalculatedColumnApi()
+            .internalApi.getCalculatedColumnsDependentOnColumn(column)
+            .forEach((calculatedColumnId) => {
+            impactedColumnIds.add(calculatedColumnId);
+        });
+        const columnsThatNeedRefresh = new Set();
+        this.getFormatColumnsDependentOnColumns(impactedColumnIds).forEach((formatColumn) => {
+            this.adaptable.api.scopeApi.getColumnsForScope(formatColumn.Scope).forEach((col) => {
+                columnsThatNeedRefresh.add(col.columnId);
+            });
+        });
+        return [...columnsThatNeedRefresh];
+    }
 }
 exports.FormatColumnInternalApi = FormatColumnInternalApi;

package/src/Api/PredicateApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableColumnDataType, SystemFilterPredicateId } from '../../types';
+import { AdaptableColumnDataType, AdaptableColumnPredicate, SystemFilterPredicateId } from '../../types';
 import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, PredicateModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
 /**
  * Functions which manage the Predicate object in AdapTable
@@ -51,6 +51,22 @@ export interface PredicateApi {
      * @param predicates Predicates Definitions to check
      */
     isEveryPredicateValid(predicates: AdaptablePredicate[]): boolean;
+    /**
+     * Same has handle predicate but it tales into account predicate column id.
+     *
+     * @param predicate
+     * @param params
+     * @param defaultReturn
+     */
+    handleColumnPredicate(predicate: AdaptableColumnPredicate, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
+    /**
+     * Same has handle predicates but it tales into account predicate column id.
+     *
+     * @param predicate
+     * @param params
+     * @param defaultReturn
+     */
+    handleColumnPredicates(predicate: AdaptableColumnPredicate[], params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
     /**
      * Main Handler function for a Predicate Definition - used by AdapTableQL
      * @param predicate Predicate to handle

package/src/PredefinedConfig/AlertState.d.ts

@@ -1,6 +1,6 @@
 import { ConfigState } from './ConfigState';
 import { AdaptableScope } from './Common/AdaptableScope';
-import { AdaptablePredicate } from './Common/AdaptablePredicate';
+import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
 import { TypeHint } from './Common/Types';
 import { AdaptableMessageType } from './Common/AdaptableMessageType';
 import { AdaptableForm } from './Common/AdaptableForm';
@@ -56,7 +56,7 @@ export interface AlertDefinition extends SuspendableObject {
 export declare type AlertButtonForm = Omit<AdaptableForm<AlertFormContext>, 'title' | 'buttons' | 'description'> & {
     Buttons?: AlertButton<AlertFormContext>[];
 };
-export interface AlertDefinitionPredicate extends AdaptablePredicate {
+export interface AlertDefinitionPredicate extends AdaptableColumnPredicate {
     PredicateId: TypeHint<string, SystemAlertPredicateId>;
 }
 /**
@@ -69,6 +69,9 @@ export declare type AlertRule = XOR<{
  *  Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression
  */
 export declare type AdaptableAlertQuery = XOR<AdaptableBooleanQuery, XOR<AdaptableObservableQuery, AdaptableAggregatedBooleanQuery>>;
+/**
+ * Actions available in an Alert
+ */
 export declare type AdaptableAlertAction = 'highlight-cell' | 'highlight-row' | 'jump-to-cell' | 'jump-to-row' | 'jump-to-column' | 'suspend' | 'undo';
 /**
  * Defines a button that appears in an Alert Form

package/src/PredefinedConfig/Common/AdaptableAlert.d.ts

@@ -6,7 +6,13 @@ import { AlertDefinition } from '../AlertState';
  * Defines an Alert fired by AdapTable
  */
 export declare type AdaptableAlert = AdaptableCellChangedAlert | AdaptableRowChangedAlert | AdaptableGenericAlert;
+/**
+ * Type of AdapTable Alert: generic, cellChange or rowChange
+ */
 export declare type AdaptableAlertType = 'generic' | 'cellChange' | 'rowChange';
+/**
+ * Defines a generic AdapTable Alert
+ */
 export interface AdaptableGenericAlert extends AdaptableAlertBase<'generic'> {
 }
 /**

package/src/PredefinedConfig/Common/AdaptableColumn.d.ts

@@ -16,7 +16,7 @@ export interface AdaptableColumnBase extends AdaptableObject {
      */
     friendlyName: string;
     /**
-     * DataType of the column
+     * DataType of the Column
      */
     dataType: AdaptableColumnDataType;
 }
@@ -34,15 +34,15 @@ export interface AdaptableColumnGroup {
     groupCount: number;
 }
 /**
- * Defines an Adaptable Column - created at run-time based on AG Grid column definition
+ * Defines an Adaptable Column - created at run-time based on AG Grid ColDef
  */
 export interface AdaptableColumn extends AdaptableColumnBase {
     /**
-     * Is the field of the row to get the cell data from
+     * Field in the row to get cell data from
      */
     field?: string;
     /**
-     * Is this the Primary Key column
+     * Is this the Primary Key Column
      */
     isPrimaryKey: boolean;
     /**
@@ -50,11 +50,11 @@ export interface AdaptableColumn extends AdaptableColumnBase {
      */
     width?: number;
     /**
-     * Flex details of the column
+     * Flex details of the Column
      */
     flex?: number;
     /**
-     * Is the column editable; returns FALSE if the column has conditional/dynamic editability, assuming some rows are editable
+     * Is Column editable; returns FALSE if Column has conditional/dynamic editability, assuming some rows are editable
      */
     readOnly: boolean;
     /**
@@ -94,15 +94,19 @@ export interface AdaptableColumn extends AdaptableColumnBase {
      */
     queryable: boolean;
     /**
-     * Available aggregations for the Column
+     * Whether the Column can be included in Reports
+     */
+    exportable: boolean;
+    /**
+     * Available Aggregations for the Column
      */
     availableAggregationFunctions?: string[];
     /**
-     * Custom aggregation function for the Column
+     * Custom Aggregation function for the Column
      */
     aggregationFunction?: string;
     /**
-     * Is Column currently grouped
+     * Is Column currently Row-Grouped
      */
     isGrouped: boolean;
     /**
@@ -110,7 +114,7 @@ export interface AdaptableColumn extends AdaptableColumnBase {
      */
     isFixed: boolean;
     /**
-     * The pinned position of the column
+     * The pinned position of the Column
      */
     pinned: 'left' | 'right' | false;
     /**
@@ -122,7 +126,7 @@ export interface AdaptableColumn extends AdaptableColumnBase {
      */
     isExcludedFromQuickSearch: boolean;
     /**
-     * The parent column group, if the column belongs to one
+     * The parent Column group (if Column belongs to one)
      */
     columnGroup?: AdaptableColumnGroup;
 }

package/src/PredefinedConfig/Common/AdaptableForm.d.ts

@@ -1,5 +1,8 @@
 import { AdaptableButton } from './AdaptableButton';
 import { BaseContext } from '../../types';
+/**
+ * Data which appears in an AdapTable Form
+ */
 export declare type AdaptableFormData = Record<string, any>;
 /**
  * Defines a form which appears dynamically; used by Alerts & Export Custom Destinations
@@ -50,5 +53,8 @@ export interface AdaptableFormField {
         label: string;
     }[];
 }
+/**
+ * Types of Controls used in an AdapTable Form
+ */
 export declare type AdaptableFormFieldType = 'text' | 'select' | 'date' | 'number' | 'checkbox' | 'textOutput';
 export declare function getDefaultAdaptableFormData<T extends BaseContext = BaseContext>(formDef?: AdaptableForm<T>): AdaptableFormData;

package/src/PredefinedConfig/Common/AdaptableIcon.d.ts

@@ -51,4 +51,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable internal icon names
  */
-export declare type AdaptableInternalIconName = 'add' | 'add-row' | 'alert' | 'align-justify' | 'analysis' | 'application' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrowexpand' | 'attach-file' | 'blanks' | 'boolean-list' | 'broadcast' | 'brush' | 'build' | 'bulk-update' | 'calculated-column' | 'calendar' | 'call' | 'campaign' | 'cell-summary' | 'cell-validation' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clear' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'column-chooser' | 'column-filter' | 'comment' | 'contains' | 'custom-sort' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equal' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'flashing-cell' | 'folder' | 'folder-open' | 'folder-shared' | 'format-column' | 'freetext-column' | 'function' | 'gradient-column' | 'greater-than' | 'greater-than-or-equal' | 'hide-column' | 'history' | 'home' | 'import-export' | 'info' | 'instrument' | 'invalid' | 'ipushpull' | 'justify' | 'layout' | 'less-than' | 'less-than-or-equal' | 'list' | 'login' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'non-blanks' | 'not-contains' | 'not-equal' | 'ok' | 'open-in-new' | 'pause' | 'percent' | 'percent-bar' | 'person' | 'pie-chart' | 'play' | 'plus' | 'plus-minus' | 'query' | 'quick-search' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'shortcut' | 'show-column' | 'smart-edit' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'state-management' | 'statusbar' | 'stop' | 'system-status' | 'tab-unselected' | 'team-share' | 'theme' | 'tool-panel' | 'track-changes' | 'trash' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'updated-row' | 'upload' | 'warning';
+export declare type AdaptableInternalIconName = 'add' | 'add-row' | 'alert' | 'align-justify' | 'analysis' | 'application' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrowexpand' | 'attach-file' | 'blanks' | 'boolean-list' | 'broadcast' | 'brush' | 'build' | 'bulk-update' | 'calculated-column' | 'calendar' | 'call' | 'campaign' | 'cell-summary' | 'cell-validation' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clear' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'column-chooser' | 'column-filter' | 'comment' | 'contains' | 'custom-sort' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equal' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'flashing-cell' | 'folder' | 'folder-open' | 'folder-shared' | 'format-column' | 'freetext-column' | 'function' | 'gradient-column' | 'greater-than' | 'greater-than-or-equal' | 'hide-column' | 'history' | 'home' | 'import-export' | 'info' | 'instrument' | 'invalid' | 'ipushpull' | 'justify' | 'layout' | 'less-than' | 'less-than-or-equal' | 'list' | 'login' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'non-blanks' | 'not-contains' | 'not-equal' | 'ok' | 'open-in-new' | 'pause' | 'percent' | 'percent-bar' | 'person' | 'pie-chart' | 'play' | 'plus' | 'plus-minus' | 'query' | 'quick-search' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'shortcut' | 'show-column' | 'smart-edit' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'state-management' | 'statusbar' | 'stop' | 'system-status' | 'tab-unselected' | 'team-share' | 'theme' | 'tool-panel' | 'track-changes' | 'trash' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'updated-row' | 'upload' | 'warning' | 'visibility' | 'visibility-off';

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -15,6 +15,12 @@ export interface AdaptablePredicate {
      */
     Inputs?: any[];
 }
+export interface AdaptableColumnPredicate extends AdaptablePredicate {
+    /**
+     * If specified, ColumnId restricts the predicate evaluation to the given column
+     */
+    ColumnId?: string;
+}
 /**
  * Defines a Predicate - include where it can run and what it does
  */

package/src/PredefinedConfig/Common/AdaptableQuery.d.ts

@@ -1,16 +1,31 @@
 import { XOR } from '../../Utilities/Extensions/TypeExtensions';
+/**
+ * Wraps an AdapTableQL Boolean Expression
+ */
 export interface AdaptableBooleanQuery {
     BooleanExpression: string;
 }
+/**
+ * Wraps an AdapTableQL Scalar Expression
+ */
 export interface AdaptableScalarQuery {
     ScalarExpression: string;
 }
+/**
+ * Wraps an AdapTableQL Observable Expression
+ */
 export interface AdaptableObservableQuery {
     ObservableExpression: string;
 }
+/**
+ * Wraps an AdapTableQL Aggregated Boolean Expression
+ */
 export interface AdaptableAggregatedBooleanQuery {
     AggregatedBooleanExpression: string;
 }
+/**
+ * Wraps an AdapTableQL Aggregated Scalar Expression
+ */
 export interface AdaptableAggregatedScalarQuery {
     AggregatedScalarExpression: string;
 }

package/src/PredefinedConfig/Common/Enums.d.ts

@@ -8,7 +8,8 @@ export declare enum ExportDestination {
     Excel = "Excel",
     CSV = "CSV",
     Clipboard = "Clipboard",
-    JSON = "JSON"
+    JSON = "JSON",
+    Table = "Table"
 }
 export declare enum ScheduleType {
     Report = "Report",