@adaptabletools/adaptable 10.0.2 → 10.0.4-canary.2

package/src/Api/Implementation/ConfigApiImpl.js

@@ -132,24 +132,35 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
         return adaptableSortState;
     }
     setAdaptableStateKey(adaptableStateKey, config) {
-        this.adaptable.adaptableOptions.adaptableStateKey = adaptableStateKey;
-        const flushCurrentState = !config || config.flushCurrentState !== false;
-        // make sure we persist any "pending" changes to state - since stateOptions.debounceStateDelay can cause
-        // the state to be persisted with a delay, which we dont want in this case
-        const flushStatePromise = flushCurrentState
-            ? this.adaptable.adaptableStore.saveStateNow(this.adaptable)
-            : Promise.resolve(true);
-        return flushStatePromise.then(() => {
-            let predefinedConfig = config === null || config === void 0 ? void 0 : config.predefinedConfig;
-            if (predefinedConfig) {
-                predefinedConfig = AdaptableHelper_1.initPredefinedConfigWithUuids(predefinedConfig);
-            }
-            const promise = this.adaptable.adaptableStore.loadStore(this.adaptable, adaptableStateKey, predefinedConfig);
-            promise.then(() => {
-                this.adaptable.prepareGrid();
-                this.adaptable.api.internalApi.hideLoadingScreen();
+        return new Promise((resolve, reject) => {
+            this.adaptable.api.internalApi.executeWithProgressIndicator(`Initialising...`, () => {
+                this.adaptable.adaptableOptions.adaptableStateKey = adaptableStateKey;
+                const flushCurrentState = !config || config.flushCurrentState !== false;
+                // make sure we persist any "pending" changes to state - since stateOptions.debounceStateDelay can cause
+                // the state to be persisted with a delay, which we dont want in this case
+                const flushStatePromise = flushCurrentState
+                    ? this.adaptable.adaptableStore.saveStateNow(this.adaptable)
+                    : Promise.resolve(true);
+                flushStatePromise.then(() => {
+                    let predefinedConfig = config === null || config === void 0 ? void 0 : config.predefinedConfig;
+                    if (predefinedConfig) {
+                        predefinedConfig = AdaptableHelper_1.initPredefinedConfigWithUuids(predefinedConfig);
+                    }
+                    const promise = this.adaptable.adaptableStore.loadStore(this.adaptable, adaptableStateKey, predefinedConfig);
+                    promise
+                        .then(() => {
+                        this.adaptable.prepareGrid();
+                        this.adaptable.api.internalApi.hideLoadingScreen();
+                    })
+                        .then(() => {
+                        // resolve main(result) promise
+                        resolve();
+                    }, () => {
+                        // reject main(result) promise
+                        reject();
+                    });
+                });
             });
-            return promise;
         });
     }
     getDescriptionForModule(module) {
@@ -168,18 +179,10 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Application)
                     : this.getAdaptableState().Application;
-            case 'BulkUpdate':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().BulkUpdate)
-                    : this.getAdaptableState().BulkUpdate;
             case 'CalculatedColumn':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().CalculatedColumn)
                     : this.getAdaptableState().CalculatedColumn;
-            case 'CellSummary':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().SelectedCells)
-                    : this.getAdaptableState().CellSummary;
             case 'Chart':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Chart)
@@ -200,10 +203,6 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().DataSource)
                     : this.getAdaptableState().DataSource;
-            case 'Entitlement':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().Entitlements)
-                    : this.getAdaptableState().Entitlements;
             case 'Export':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Export)
@@ -244,18 +243,10 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Shortcut)
                     : this.getAdaptableState().Shortcut;
-            case 'SmartEdit':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().SmartEdit)
-                    : this.getAdaptableState().SmartEdit;
             case 'SparklineColumn':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().SparklineColumn)
                     : this.getAdaptableState().SparklineColumn;
-            case 'SystemStatus':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().SystemStatus)
-                    : this.getAdaptableState().SystemStatus;
             case 'Theme':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Theme)
@@ -264,10 +255,6 @@ class ConfigApiImpl extends ApiBase_1.ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().ToolPanel)
                     : this.getAdaptableState().ToolPanel;
-            case 'UserInterface':
-                return returnJson
-                    ? JSON.stringify(this.getAdaptableState().UserInterface)
-                    : this.getAdaptableState().UserInterface;
         }
     }
     incrementUerStateRevision(stateKey) {

package/src/Api/Implementation/DashboardApiImpl.js

@@ -18,6 +18,7 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
         // so we debounced to only get tha latest call
         this.fireDashboardChangedEvent = (trigger, oldDashboardState, newDashboardState) => {
             const dashboardChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 actionName: trigger,
                 oldDashboardState: oldDashboardState,
                 newDashboardState: newDashboardState,
@@ -39,7 +40,7 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
     getCustomDashboardButtonByLabel(buttonLabel) {
         const api = this.getAdaptableApi();
         const dashboardContext = {
-            api,
+            adaptableApi: api,
             dashboardState: api.dashboardApi.getDashboardState(),
         };
         return this.getDashboardOptions().customDashboardButtons.find((cb) => {

package/src/Api/Implementation/ExportApiImpl.js

@@ -103,7 +103,6 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
         if (report.ReportRowScope == 'CustomRows' || report.ReportColumnScope == 'CustomColumns') {
             return false;
         }
-        let abColumn = this.adaptable.api.columnApi.getColumnFromId(dataChangedInfo.columnId);
         // Start with the DataChanged Column and go through all possibilities
         switch (report.ReportColumnScope) {
             case 'AllColumns':
@@ -111,21 +110,22 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
                 break;
             case 'ScopeColumns':
                 // use the Scope object which will tell us if the Column is relevant
-                if (!this.adaptable.api.scopeApi.isColumnInScopeColumns(abColumn, report.Scope)) {
+                if (!this.adaptable.api.scopeApi.isColumnInScopeColumns(dataChangedInfo.column, report.Scope)) {
                     return false;
                 }
                 break;
             case 'SelectedColumns':
                 let selectedCellInfo = this.adaptable.api.gridApi.getSelectedCellInfo();
                 if (selectedCellInfo) {
-                    if (selectedCellInfo.columns.find((c) => c.ColumnId == dataChangedInfo.columnId) == null) {
+                    if (selectedCellInfo.columns.find((c) => c.columnId == dataChangedInfo.column.columnId) ==
+                        null) {
                         return false;
                     }
                 }
                 break;
             case 'VisibleColumns':
                 //  hope that visibile column property is updated whenever the layout changes... (need to check!)
-                if (!abColumn.Visible) {
+                if (!dataChangedInfo.column.visible) {
                     return false;
                 }
                 break;

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -243,7 +243,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     }
     getCheckBoxStyleFormatColumn(column) {
         var _a;
-        if (column.DataType != 'Boolean') {
+        if (column.dataType != 'Boolean') {
             return undefined;
         }
         const checkBoxFormatColumns = (_a = this.getFormatColumnState().FormatColumns) === null || _a === void 0 ? void 0 : _a.filter((fc) => { var _a; return (_a = fc.ColumnStyle) === null || _a === void 0 ? void 0 : _a.CheckBoxStyle; });
@@ -256,6 +256,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     }
     fireCheckboxColumnClickedEvent(columnId, rowData, primaryKeyValue, isChecked) {
         let checkboxColumnClickedInfo = {
+            adaptableApi: this.adaptable.api,
             column: this.adaptable.api.columnApi.getColumnFromId(columnId),
             rowData: rowData,
             primaryKeyValue: primaryKeyValue,

package/src/Api/Implementation/FreeTextColumnApiImpl.js

@@ -68,7 +68,8 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
         }
     }
     createFreeTextColumn({ columnName, columnId, defaultValue = null, }) {
-        let freeTextColumn = ObjectFactory_1.ObjectFactory.CreateEmptyFreeTextColumn();
+        let freeTextColumn = ObjectFactory_1.ObjectFactory.CreateEmptyFreeTextColumn(this.adaptable.api.internalApi.getAdaptableOptions().filterOptions
+            .enableFilterOnSpecialColumns);
         freeTextColumn.ColumnId = columnId;
         freeTextColumn.FriendlyName = columnName || columnId;
         freeTextColumn.DefaultValue = defaultValue;
@@ -103,14 +104,19 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
         }
     }
     checkFreeTextColumnForDataChange(dataChangedInfo) {
-        let freeTextColumn = this.getAllFreeTextColumn().find((fc) => fc.ColumnId == dataChangedInfo.columnId);
+        let freeTextColumn = this.getAllFreeTextColumn().find((fc) => fc.ColumnId == dataChangedInfo.column.columnId);
         if (freeTextColumn) {
             let freeTextStoredValue = {
                 PrimaryKey: dataChangedInfo.primaryKeyValue,
                 FreeText: dataChangedInfo.newValue,
             };
             this.addEditFreeTextColumnStoredValue(freeTextColumn, freeTextStoredValue);
-            this.adaptable.refreshCells([dataChangedInfo.rowNode], [dataChangedInfo.columnId], false);
+            var colsToRefresh = [dataChangedInfo.column.columnId];
+            const refencedCalcColumns = this.adaptable.api.calculatedColumnApi.getCalculatedColumnsReferencingColumnId(dataChangedInfo.column.columnId);
+            refencedCalcColumns.forEach((calculatedColumn) => {
+                colsToRefresh.push(calculatedColumn.ColumnId);
+            });
+            this.adaptable.refreshCells([dataChangedInfo.rowNode], colsToRefresh, false);
         }
     }
     getFreeTextColumnModuleReferences(freeTextColumn) {

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

@@ -8,17 +8,24 @@ import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { DataUpdateConfig } from '../../PredefinedConfig/Common/DataUpdateConfig';
 import { DataChangedInfo, AccessLevel, AdaptableModule } from '../../types';
 import { CellHighlightInfo } from '../../PredefinedConfig/Common/CellHighlightInfo';
-import { RowNode } from '@ag-grid-community/all-modules';
+import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
 import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
 export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridState(): GridState;
     setGridData(dataSource: any): void;
+    getGridData(): any[];
+    getFilteredData(): any[];
     loadGridData(dataSource: any): void;
     updateGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
     addGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
     undoCellEdit(dataChangedInfo: DataChangedInfo): boolean;
     deleteGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
     setCellValue(columnId: string, newValue: any, primaryKeyValue: any): void;
+    setCellsValue(gridCells: {
+        columnId: any;
+        newValue: any;
+        primaryKeyValue: any;
+    }[]): void;
     getSelectedCellInfo(): SelectedCellInfo;
     getSelectedRowInfo(): SelectedRowInfo;
     getCellDisplayValue(primaryKeyValue: any, columnId: string): any | undefined;
@@ -27,7 +34,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     hideFilterForm(): void;
     applyGridFiltering(): void;
     clearGridFiltering(): void;
-    getVendorGrid(): any;
+    getAgGridInstance(): GridOptions;
     getColumnSorts(): ColumnSort[];
     getColumnSortForColumn(columnId: string): ColumnSort | undefined;
     setAdaptableSorting(columnSorts: ColumnSort[]): void;
@@ -76,6 +83,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     unhighlightCell(cellHighlightInfo: CellHighlightInfo): void;
     unhighlightAllCells(): void;
     refreshCells(rowNodes: RowNode[], columnIds: string[]): void;
+    refreshRow(primaryKey: string): void;
     areCellsEditable(gridCells: GridCell[]): boolean;
     getRowCount(): number;
     getVisibleRowCount(): number;
@@ -85,4 +93,5 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     selectAll(): void;
     deselectAll(): void;
     destroy(): void;
+    getGridContainerElement(): HTMLElement | null;
 }

package/src/Api/Implementation/GridApiImpl.js

@@ -12,6 +12,12 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     setGridData(dataSource) {
         this.adaptable.setDataSource(dataSource);
     }
+    getGridData() {
+        return this.adaptable.getGridData();
+    }
+    getFilteredData() {
+        return this.adaptable.getFilteredData();
+    }
     loadGridData(dataSource) {
         this.adaptable.loadDataSource(dataSource);
     }
@@ -26,7 +32,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     undoCellEdit(dataChangedInfo) {
         // for the reason of this hacky solution see the comments in DataService
         this.adaptable.api.internalApi.getDataService().logUndoChange(dataChangedInfo);
-        this.setCellValue(dataChangedInfo.columnId, dataChangedInfo.oldValue, dataChangedInfo.primaryKeyValue);
+        this.setCellValue(dataChangedInfo.column.columnId, dataChangedInfo.oldValue, dataChangedInfo.primaryKeyValue);
         return true;
     }
     deleteGridData(dataRows, dataUpdateConfig) {
@@ -36,20 +42,23 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         }
     }
     setCellValue(columnId, newValue, primaryKeyValue) {
-        let gridCell = {
+        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
+        if (!abColumn || abColumn.readOnly) {
+            return;
+        }
+        const gridCell = {
             primaryKeyValue: primaryKeyValue,
-            columnId: columnId,
             rawValue: newValue,
             displayValue: newValue,
             normalisedValue: newValue,
             rowNode: this.getRowNodeForPrimaryKey(primaryKeyValue),
+            column: abColumn,
         };
-        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
-        if (!abColumn || abColumn.ReadOnly) {
-            return;
-        }
         this.adaptable.api.internalApi.setGridCell(gridCell);
     }
+    setCellsValue(gridCells) {
+        gridCells === null || gridCells === void 0 ? void 0 : gridCells.forEach((gridCell) => this.setCellValue(gridCell.columnId, gridCell.newValue, gridCell.primaryKeyValue));
+    }
     getSelectedCellInfo() {
         return this.getGridState().SelectedCellInfo;
     }
@@ -78,7 +87,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         // slightly round the houses but we have to call FilterAPI as it does it properly
         this.adaptable.api.filterApi.clearAllColumnFilter();
     }
-    getVendorGrid() {
+    getAgGridInstance() {
         return this.adaptable.adaptableOptions.vendorGrid;
     }
     getColumnSorts() {
@@ -161,7 +170,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         return gridCell ? gridCell.displayValue : undefined;
     }
     getFormattedValueFromRawValue(columnId, rawValue) {
-        return this.adaptable.getDisplayValueFromRawValue(columnId, rawValue, true);
+        return this.adaptable.getDisplayValueFromRawValue(columnId, rawValue);
     }
     getNormalisedValueFromRowNode(rowNode, columnId) {
         const gridCell = this.getGridCellFromRowNode(rowNode, columnId);
@@ -221,6 +230,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             const adaptableSearchState = this.adaptable.api.configApi.getAdaptableSearchState();
             const adaptableSortState = this.adaptable.api.configApi.getAdaptableSortState();
             const searchChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 searchChangedTrigger,
                 adaptableSearchState: adaptableSearchState,
                 adaptableSortState: adaptableSortState,
@@ -231,6 +241,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     fireCellChangedEvent(dataChangedInfo) {
         if (this.adaptable.isInitialised) {
             const cellChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 cellChange: dataChangedInfo,
             };
             this.adaptable.api.eventApi.emit('CellChanged', cellChangedInfo);
@@ -239,6 +250,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     fireGridDataChangedEvent(dataRows, rowTigger) {
         if (this.adaptable.isInitialised) {
             const gridDataChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 rowTigger: rowTigger,
                 dataRows: dataRows,
             };
@@ -273,19 +285,21 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     refreshCells(rowNodes, columnIds) {
         this.adaptable.refreshCells(rowNodes, columnIds, true);
     }
+    refreshRow(primaryKey) {
+        const rowNode = this.getRowNodeForPrimaryKey(primaryKey);
+        this.adaptable.redrawRow(rowNode);
+    }
     areCellsEditable(gridCells) {
         let returnValue = true;
         gridCells.forEach((gridCell) => {
             if (returnValue) {
-                let abColumn = this.adaptable.api.columnApi.getColumnFromId(gridCell.columnId);
-                if (abColumn.ReadOnly) {
+                if (gridCell.column.readOnly) {
                     returnValue = false;
                     return;
                 }
                 let cellEditableFn = this.adaptable.adaptableOptions.editOptions.isCellEditable;
                 if (cellEditableFn) {
-                    let rowNode = this.adaptable.api.gridApi.getRowNodeForPrimaryKey(gridCell.primaryKeyValue);
-                    let functionReturnValue = cellEditableFn(gridCell, rowNode);
+                    let functionReturnValue = cellEditableFn(gridCell);
                     if (!functionReturnValue) {
                         returnValue = false;
                     }
@@ -318,5 +332,8 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     destroy() {
         this.adaptable.destroy();
     }
+    getGridContainerElement() {
+        return this.adaptable.getAgGridContainerElement();
+    }
 }
 exports.GridApiImpl = GridApiImpl;

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

@@ -73,14 +73,14 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     setGridCells(gridCells: GridCell[]): void;
     setToolbarTitle(): string;
     setGridCell(gridCell: GridCell): void;
-    buildDataChangedInfo(config: Pick<DataChangedInfo, 'newValue' | 'oldValue' | 'columnId' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): DataChangedInfo;
+    buildDataChangedInfo(config: Pick<DataChangedInfo, 'newValue' | 'oldValue' | 'column' | 'primaryKeyValue' | 'rowNode' | 'trigger'>): DataChangedInfo;
     private createDataChangedInfoFromGridCell;
     setLastAppliedShortCut(gridCell: GridCell | undefined): void;
     updateCurrentDraftLayout(layout: Layout): void;
     setDefaultDashboardTab(): void;
     getPrimaryKey(): any;
     getAdaptableInstance(): IAdaptable;
-    getVendorGridInstance(): any;
+    getAgGridInstance(): any;
     getPredefinedConfig(): any;
     getState(): AdaptableState;
     getAdaptableOptions(): AdaptableOptions;
@@ -113,5 +113,7 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar'): void;
     initializeDataChangeHistory(): void;
     isTextComparisonCaseSensitive(): boolean;
+    executeWithProgressIndicator(label: string, executeFn: () => void): void;
+    hideProgressIndicator(): void;
     dispatchReduxAction(action: Action): void;
 }

package/src/Api/Implementation/InternalApiImpl.js

@@ -144,7 +144,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction(GridRedux.GridAddColumns(AdaptableColumns));
     }
     removeAdaptableColumn(colId) {
-        const col = this.getAdaptableState().Grid.Columns.find((c) => c.ColumnId === colId);
+        const col = this.getAdaptableState().Grid.Columns.find((c) => c.columnId === colId);
         if (col) {
             this.dispatchAction(GridRedux.GridRemoveColumn(col));
         }
@@ -175,12 +175,12 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         return Object.assign(Object.assign({}, config), { rowData: (_a = config.rowNode) === null || _a === void 0 ? void 0 : _a.data, changedAt: Date.now() });
     }
     createDataChangedInfoFromGridCell(gridCell) {
-        let currentValue = this.adaptable.getDisplayValue(gridCell.primaryKeyValue, gridCell.columnId);
+        let currentValue = this.adaptable.getDisplayValue(gridCell.primaryKeyValue, gridCell.column.columnId);
         const currentRowNode = this.adaptable.getRowNodeForPrimaryKey(gridCell.primaryKeyValue);
         const dataChangedInfo = this.buildDataChangedInfo({
             oldValue: currentValue,
             newValue: gridCell.rawValue,
-            columnId: gridCell.columnId,
+            column: gridCell.column,
             primaryKeyValue: gridCell.primaryKeyValue,
             rowNode: currentRowNode,
         });
@@ -205,7 +205,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     getAdaptableInstance() {
         return this.adaptable;
     }
-    getVendorGridInstance() {
+    getAgGridInstance() {
         return this.adaptable.adaptableOptions.vendorGrid;
     }
     getPredefinedConfig() {
@@ -272,7 +272,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     }
     getCustomSortComparer(column) {
         var _a;
-        return (_a = this.getGeneralOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => csc.columnId == column.ColumnId);
+        return (_a = this.getGeneralOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => this.adaptable.api.scopeApi.isColumnInScope(column, csc.scope));
     }
     getLabelForButton(button, context) {
         if (!button.label) {
@@ -394,6 +394,22 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     isTextComparisonCaseSensitive() {
         return this.adaptable.adaptableOptions.generalOptions.caseSensitiveTextComparisons;
     }
+    executeWithProgressIndicator(label, executeFn) {
+        this.dispatchReduxAction(SystemRedux_1.SystemProgressIndicatorShow(label));
+        // setTimeout required to give the ProgressIndicator rendering a head-start (see RAF in ProgressIndicator implementation)
+        setTimeout(() => {
+            try {
+                executeFn();
+            }
+            catch (error) {
+                this.hideProgressIndicator();
+                LoggingHelper_1.LogAdaptableError('Unexpected error while executing a function with a progress indicator', error);
+            }
+        }, 16);
+    }
+    hideProgressIndicator() {
+        this.dispatchReduxAction(SystemRedux_1.SystemProgressIndicatorHide());
+    }
     // General way to get to store from inside Adaptable...
     dispatchReduxAction(action) {
         this.dispatchAction(action);

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

@@ -21,10 +21,12 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     createLayout(layoutToCreate: Layout): Layout | undefined;
     cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout;
     cloneLayout(layoutToClone: Layout, layoutName: string): Layout;
+    setColumnCaption(columnId: string, caption: string): void;
     saveLayout(layoutToSave: Layout): void;
     areLayoutsEqual(layout1: Layout, layout2: Layout): boolean;
     getLayoutDescription(layout: Layout): string;
     private getColumnSort;
     createDefaultLayoutIfNeeded(): Layout | null;
     showLayoutPopup(): void;
+    isCurrentLayoutReadOnly(): boolean;
 }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -50,6 +50,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     }
     fireLayoutChangedEvent(trigger, oldSate, newState) {
         const layoutChangedInfo = {
+            adaptableApi: this.adaptable.api,
             actionName: trigger,
             oldLayoutState: oldSate,
             newLayoutState: newState,
@@ -138,6 +139,14 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         this.dispatchAction(LayoutRedux.LayoutAdd(newLayout));
         return this.getLayoutById(newLayout.Uuid);
     }
+    setColumnCaption(columnId, caption) {
+        if (StringExtensions_1.default.IsNotNullOrEmpty(columnId) && StringExtensions_1.default.IsNotNullOrEmpty(caption)) {
+            const currentLayoutName = this.getCurrentLayoutName();
+            if (StringExtensions_1.default.IsNotNullOrEmpty(currentLayoutName)) {
+                this.dispatchAction(LayoutRedux.LayoutSetColumnCaption(currentLayoutName, columnId, caption));
+            }
+        }
+    }
     saveLayout(layoutToSave) {
         if (!this.doesLayoutExist(layoutToSave)) {
             this.addUidToAdaptableObject(layoutToSave);
@@ -188,9 +197,9 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         let gridState = this.getAdaptableApi().gridApi.getGridState();
         let layoutState = this.getLayoutState();
         const isLayoutDefined = (layoutName) => !!layoutState.Layouts.filter((layout) => layout.Name === layoutName)[0];
-        let defaultLayoutColumns = gridState.Columns.filter((column) => column.Visible);
+        let defaultLayoutColumns = gridState.Columns.filter((column) => column.visible);
         const columnsMap = gridState.Columns.reduce((acc, col) => {
-            acc[col.ColumnId] = col;
+            acc[col.columnId] = col;
             return acc;
         }, {});
         let shouldCreateDefaultLayout = this.getLayoutOptions().createDefaultLayout;
@@ -201,7 +210,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             if (!layoutState.Layouts || !isLayoutDefined(GeneralConstants_1.DEFAULT_LAYOUT)) {
                 let defaultLayout = ObjectFactory_1.default.CreateEmptyLayout({
                     Name: GeneralConstants_1.DEFAULT_LAYOUT,
-                    Columns: defaultLayoutColumns.map((c) => c.ColumnId),
+                    Columns: defaultLayoutColumns.map((c) => c.columnId),
                 }, gridState.Columns);
                 this.saveLayout(defaultLayout);
                 return defaultLayout;
@@ -211,5 +220,12 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     showLayoutPopup() {
         this.showModulePopup(ModuleConstants.LayoutModuleId);
     }
+    isCurrentLayoutReadOnly() {
+        const currentLayout = this.getCurrentLayout();
+        if (currentLayout) {
+            return currentLayout.IsReadOnly;
+        }
+        return true;
+    }
 }
 exports.LayoutApiImpl = LayoutApiImpl;

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

@@ -11,8 +11,8 @@ export declare class PluginsApiImpl extends ApiBase implements PluginsApi {
     getPluginState(pluginId: string): any;
     registerPlugin(pluginId: string, initialPluginState: any): void;
     setPluginState(pluginId: string, newPluginState: any): void;
-    getPluginApi(pluginId: string): any | IPushPullApi | Glue42Api | OpenFinApi | FinanceApi | ChartApi;
-    getIpushpullPluginApi(): IPushPullApi;
+    private getPluginApi;
+    getipushpullPluginApi(): IPushPullApi;
     getGlue42PluginApi(): Glue42Api;
     getOpenFinPluginApi(): OpenFinApi;
     getChartsPluginApi(): ChartApi;

package/src/Api/Implementation/PluginsApiImpl.js

@@ -41,7 +41,7 @@ class PluginsApiImpl extends ApiBase_1.ApiBase {
             return null;
         }
     }
-    getIpushpullPluginApi() {
+    getipushpullPluginApi() {
         return this.getPluginApi('ipushpull');
     }
     getGlue42PluginApi() {

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -76,7 +76,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllIPushPullSchedule() {
-        const ippApi = this.adaptable.api.pluginsApi.getPluginApi('ipushpull');
+        const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
         return ippApi ? ippApi.getIPushPullSchedules() : [];
     }
     getAllActiveIPushPullSchedule() {
@@ -105,7 +105,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllGlue42Schedule() {
-        const glue42Api = this.adaptable.api.pluginsApi.getPluginApi('glue42');
+        const glue42Api = this.adaptable.api.pluginsApi.getGlue42PluginApi();
         return glue42Api ? glue42Api.getGlue42Schedules() : [];
     }
     getAllActiveGlue42Schedule() {
@@ -134,7 +134,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         return this.getScheduleById(schedule.Uuid);
     }
     getAllOpenFinSchedule() {
-        const openFinApi = this.adaptable.api.pluginsApi.getPluginApi('openfin');
+        const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
         return openFinApi ? openFinApi.getOpenFinSchedules() : [];
     }
     getAllActiveOpenFinSchedule() {
@@ -185,7 +185,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
             this.adaptable.api.exportApi.sendReport(reportSchedule.ReportName, reportSchedule.ExportDestination);
         }
         else if (scheduleType == 'ipushpull') {
-            const ippApi = this.adaptable.api.pluginsApi.getPluginApi('ipushpull');
+            const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
             const iPushPullSchedule = schedule;
             if (iPushPullSchedule.Transmission == 'Snapshot') {
                 ippApi.sendSnapshot(iPushPullSchedule.IPushPullReport);
@@ -195,12 +195,12 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
             }
         }
         else if (scheduleType == 'Glue42') {
-            const glue42Api = this.adaptable.api.pluginsApi.getPluginApi('glue42');
+            const glue42Api = this.adaptable.api.pluginsApi.getGlue42PluginApi();
             const glue42Schedule = schedule;
             glue42Api.sendSnapshotToDo(glue42Schedule.Glue42Report);
         }
         else if (scheduleType == 'OpenFin') {
-            const openFinApi = this.adaptable.api.pluginsApi.getPluginApi('openfin');
+            const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
             const openFinSchedule = schedule;
             openFinApi.startLiveData(openFinSchedule.OpenFinReport);
         }