@adaptabletools/adaptable 18.0.0-canary.9 → 18.0.0

package/src/Api/Implementation/ColumnApiImpl.js

@@ -3,6 +3,17 @@ import * as GeneralConstants from '../../Utilities/Constants/GeneralConstants';
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import { ColumnInternalApi } from '../Internal/ColumnInternalApi';
+import { createBaseContext } from '../../Utilities/ObjectFactory';
+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 === null || columnId === void 0 ? void 0 : columnId.startsWith(GeneralConstants.AG_GRID_GROUPED_COLUMN);
+}
+export function isAutoPivotColumn(columnId) {
+    // put this here as there might be other indicators we are not aware of?
+    return columnId === null || columnId === void 0 ? void 0 : columnId.startsWith(GeneralConstants.AG_GRID_PIVOT_COLUMN);
+}
 export class ColumnApiImpl extends ApiBase {
     constructor(adaptable) {
         super(adaptable);
@@ -10,10 +21,10 @@ export class ColumnApiImpl extends ApiBase {
     }
     getColumns() {
         var _a;
-        return (_a = this.adaptable.api.gridApi.getGridState().Columns) !== null && _a !== void 0 ? _a : [];
+        return (_a = this.getAdaptableApi().gridApi.getGridState().Columns) !== null && _a !== void 0 ? _a : [];
     }
     getVisibleColumns() {
-        const layout = this.adaptable.api.layoutApi.getCurrentLayout();
+        const layout = this.getAdaptableApi().layoutApi.getCurrentLayout();
         const visibleCols = layout.Columns.reduce((acc, colId) => {
             acc[colId] = true;
             return acc;
@@ -51,29 +62,25 @@ export class ColumnApiImpl extends ApiBase {
         this.adaptable.showColumn(columnId);
     }
     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 === null || columnId === void 0 ? void 0 : columnId.startsWith(GeneralConstants.AG_GRID_GROUPED_COLUMN);
+        return isAutoRowGroupColumn(columnId);
     }
     isAutoPivotColumn(columnId) {
-        // put this here as there might be other indicators we are not aware of?
-        return columnId === null || columnId === void 0 ? void 0 : columnId.startsWith(GeneralConstants.AG_GRID_PIVOT_COLUMN);
+        return isAutoPivotColumn(columnId);
     }
     isCalculatedColumn(columnId) {
-        return (this.adaptable.api.calculatedColumnApi
-            .getCalculatedColumns()
+        return (this.getAdaptableApi()
+            .calculatedColumnApi.getCalculatedColumns()
             .find((cc) => cc.ColumnId == columnId) != null);
     }
     isFreeTextColumn(columnId) {
-        return (this.adaptable.api.freeTextColumnApi
-            .getFreeTextColumns()
+        return (this.getAdaptableApi()
+            .freeTextColumnApi.getFreeTextColumns()
             .find((cc) => cc.ColumnId == columnId) != null);
     }
     isActionColumn(columnId) {
         var _a;
-        return (((_a = this.adaptable.api.actionColumnApi
-            .getActionColumns()) === null || _a === void 0 ? void 0 : _a.find((cc) => cc.columnId == columnId)) != null);
+        return (((_a = this.getAdaptableApi()
+            .actionColumnApi.getActionColumns()) === null || _a === void 0 ? void 0 : _a.find((cc) => cc.columnId == columnId)) != null);
     }
     getColumnWithColumnId(columnId, logWarning) {
         if (columnId == undefined) {
@@ -152,7 +159,7 @@ export class ColumnApiImpl extends ApiBase {
         }
         let result = columnId + GeneralConstants.MISSING_COLUMN;
         if (this.isAutoRowGroupColumn(columnId)) {
-            const currentLayout = this.adaptable.api.layoutApi.getCurrentLayout();
+            const currentLayout = this.getAdaptableApi().layoutApi.getCurrentLayout();
             if (currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.RowGroupedColumns) {
                 result = `[Grouped column: ${currentLayout.RowGroupedColumns.join(', ')}]`;
             }
@@ -333,4 +340,27 @@ export class ColumnApiImpl extends ApiBase {
     openColumnInfoSettingsPanel() {
         this.showModulePopup(ModuleConstants.ColumnInfoModuleId);
     }
+    getColumnTypes() {
+        const columnTypes = this.getOptions().columnOptions.columnTypes;
+        if (typeof columnTypes === 'function') {
+            return columnTypes(createBaseContext(this.getAdaptableApi()));
+        }
+        else {
+            return columnTypes;
+        }
+    }
+    getColumnsByColumnType(columnType) {
+        const abColumns = this.getColumns();
+        return abColumns.filter((c) => {
+            var _a;
+            return ((_a = c.columnTypes) !== null && _a !== void 0 ? _a : []).includes(columnType);
+        });
+    }
+    getRowGroupedColumns() {
+        var _a;
+        return (_a = this.getLayoutApi()
+            .getCurrentRowGroupsColumnIds()) === null || _a === void 0 ? void 0 : _a.map((n) => {
+            return this.getColumnWithColumnId(n);
+        });
+    }
 }

package/src/Api/Implementation/ColumnFilterApiImpl.js

@@ -14,7 +14,7 @@ export class ColumnFilterApiImpl extends ApiBase {
         };
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFilterPredicateDefs(scope)
-            .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
+            .filter((predicate) => this.getAdaptableApi().columnScopeApi.isColumnInScope(column, predicate.columnScope));
     }
     getFilterPredicateDefsForColumnId(columnId) {
         const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
@@ -31,11 +31,11 @@ export class ColumnFilterApiImpl extends ApiBase {
     }
     isQuickFilterVisible() {
         return (this.isQuickFilterAvailable() &&
-            this.adaptable.api.internalApi.getSystemState().IsQuickFilterVisible);
+            this.getAdaptableApi().internalApi.getSystemState().IsQuickFilterVisible);
     }
     getColumnFilters() {
         var _a;
-        const currentLayout = this.adaptable.api.layoutApi.getCurrentLayout();
+        const currentLayout = this.getAdaptableApi().layoutApi.getCurrentLayout();
         return (_a = currentLayout.ColumnFilters) !== null && _a !== void 0 ? _a : [];
     }
     getActiveColumnFilters() {
@@ -55,7 +55,7 @@ export class ColumnFilterApiImpl extends ApiBase {
     }
     getColumnFiltersForLayout(layoutName) {
         var _a;
-        const layout = this.adaptable.api.layoutApi.getLayoutByName(layoutName);
+        const layout = this.getAdaptableApi().layoutApi.getLayoutByName(layoutName);
         return (_a = layout.ColumnFilters) !== null && _a !== void 0 ? _a : [];
     }
     setColumnFilters(columnFilters) {
@@ -64,7 +64,7 @@ export class ColumnFilterApiImpl extends ApiBase {
                 this.logWarn('Column Filter has no Predicate', columnFilter);
             }
             else {
-                const isValidPredicate = this.adaptable.api.predicateApi.isValidPredicate(columnFilter.Predicate);
+                const isValidPredicate = this.getAdaptableApi().predicateApi.isValidPredicate(columnFilter.Predicate);
                 if (!isValidPredicate) {
                     this.logWarn('Column Filter Predicate is not valid', columnFilter);
                 }
@@ -118,10 +118,10 @@ export class ColumnFilterApiImpl extends ApiBase {
         if (!filter || !filter.Predicate || !filter.Predicate.PredicateId) {
             return false;
         }
-        const predicateDef = this.adaptable.api.predicateApi.getPredicateDefById(filter === null || filter === void 0 ? void 0 : filter.Predicate.PredicateId);
+        const predicateDef = this.getAdaptableApi().predicateApi.getPredicateDefById(filter === null || filter === void 0 ? void 0 : filter.Predicate.PredicateId);
         if (ArrayExtensions.IsNull(predicateDef.inputs) &&
             // values predicates have no inputs in the definition
-            !this.adaptable.api.predicateApi.internalApi.hasPredicateValues(filter.Predicate)) {
+            !this.getAdaptableApi().predicateApi.internalApi.hasPredicateValues(filter.Predicate)) {
             return true;
         }
         const inputs = filter.Predicate.Inputs;

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

@@ -0,0 +1,8 @@
+import { ColumnMenuApi } from '../ColumnMenuApi';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { ApiBase } from './ApiBase';
+export declare class ColumnMenuApiImpl extends ApiBase implements ColumnMenuApi {
+    constructor(adaptable: IAdaptable);
+    showColumnMenu(columnKey: string): void;
+    hideColumnMenu(): void;
+}

package/src/Api/Implementation/ColumnMenuApiImpl.js

@@ -0,0 +1,12 @@
+import { ApiBase } from './ApiBase';
+export class ColumnMenuApiImpl extends ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+    }
+    showColumnMenu(columnKey) {
+        this.adaptable.agGridAdapter.getAgGridApi().showColumnMenu(columnKey);
+    }
+    hideColumnMenu() {
+        this.adaptable.agGridAdapter.getAgGridApi().hidePopupMenu();
+    }
+}

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

@@ -0,0 +1,33 @@
+import { ApiBase } from './ApiBase';
+import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
+import { ColumnScope, ScopeDataType } from '../../PredefinedConfig/Common/ColumnScope';
+import { ColumnScopeApi } from '../ColumnScopeApi';
+import { CellColorRange } from '../../PredefinedConfig/StyledColumnState';
+export declare class ColumnScopeApiImpl extends ApiBase implements ColumnScopeApi {
+    isColumnInScope(column: AdaptableColumn | undefined, scope: ColumnScope | undefined): boolean;
+    getColumnsForScope(scope: ColumnScope): AdaptableColumn[];
+    getScopeDescription(scope: ColumnScope): string;
+    scopeIsEmpty(scope: ColumnScope): boolean;
+    scopeIsAll(scope: ColumnScope): boolean;
+    scopeHasDataType(scope: ColumnScope): boolean;
+    scopeHasColumnType(scope: ColumnScope): boolean;
+    scopeHasOnlyBooleanDataType(scope: ColumnScope): boolean;
+    scopeHasColumns(scope: ColumnScope): boolean;
+    isSingleColumnScope(scope: ColumnScope): boolean;
+    getSingleColumnInScope(scope: ColumnScope): string | undefined;
+    isSingleNumericColumnScope(scope: ColumnScope): boolean;
+    isSingleBooleanColumnScope(scope: ColumnScope): boolean;
+    areAllBooleanColumnsInScope(scope: ColumnScope): boolean;
+    isColumnInScopeColumns(column: AdaptableColumn, scope: ColumnScope): boolean;
+    isPrimaryKeyColumnInScopeColumns(scope: ColumnScope): boolean;
+    getScopeToString(scope: ColumnScope): string;
+    getColumnIdsInScope(scope: ColumnScope): string[] | undefined;
+    getColumnTypesInScope(scope: ColumnScope): string[] | undefined;
+    getDataTypesInScope(scope: ColumnScope): ScopeDataType[] | undefined;
+    isColumnInNumericScope(column: AdaptableColumn, scope: ColumnScope): boolean;
+    isColumnInStringsScope(column: AdaptableColumn, scope: ColumnScope): boolean;
+    isColumnInDateScope(column: AdaptableColumn, scope: ColumnScope): boolean;
+    isScopeInScope(a: ColumnScope, b: ColumnScope): boolean;
+    createCellColorRangesForScope(scope: ColumnScope): CellColorRange[];
+    private distinctColumnValuesAreEmpty;
+}

package/src/Api/Implementation/{ScopeApiImpl.js → ColumnScopeApiImpl.js}

@@ -1,7 +1,7 @@
 import { ApiBase } from './ApiBase';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import { DARK_GREEN, getHexForName, GRAY, RED } from '../../View/UIHelper';
-export class ScopeApiImpl extends ApiBase {
+export class ColumnScopeApiImpl extends ApiBase {
     isColumnInScope(column, scope) {
         if (!column) {
             return false;
@@ -26,7 +26,7 @@ export class ScopeApiImpl extends ApiBase {
         if (scope == undefined) {
             return [];
         }
-        const columns = this.adaptable.api.columnApi.getColumns();
+        const columns = this.getAdaptableApi().columnApi.getColumns();
         if ('All' in scope) {
             return columns;
         }
@@ -43,7 +43,9 @@ export class ScopeApiImpl extends ApiBase {
             return 'Columns: All';
         }
         if ('ColumnTypes' in scope) {
-            return ((scope.ColumnTypes.length > 0 ? 'ColumnTypes' : 'ColumnType') + ': ' + scope.ColumnTypes.join(', '));
+            return ((scope.ColumnTypes.length > 0 ? 'ColumnTypes' : 'ColumnType') +
+                ': ' +
+                scope.ColumnTypes.join(', '));
         }
         if ('DataTypes' in scope) {
             return ((scope.DataTypes.length > 0 ? 'DataTypes' : 'DataType') + ': ' + scope.DataTypes.join(', '));
@@ -51,8 +53,8 @@ export class ScopeApiImpl extends ApiBase {
         if ('ColumnIds' in scope) {
             return ((scope.ColumnIds.length > 1 ? 'Columns' : 'Column') +
                 ': ' +
-                this.adaptable.api.columnApi
-                    .getFriendlyNamesForColumnIds(scope.ColumnIds)
+                this.getAdaptableApi()
+                    .columnApi.getFriendlyNamesForColumnIds(scope.ColumnIds)
                     .map((c) => {
                     return '"' + c + '"';
                 })
@@ -94,7 +96,7 @@ export class ScopeApiImpl extends ApiBase {
             !this.scopeIsAll(scope) &&
             'ColumnIds' in scope &&
             scope.ColumnIds.length == 1 &&
-            this.adaptable.api.columnApi.hasNumberDataType(scope.ColumnIds[0]));
+            this.getAdaptableApi().columnApi.hasNumberDataType(scope.ColumnIds[0]));
     }
     isSingleBooleanColumnScope(scope) {
         return (this.scopeHasColumns(scope) &&
@@ -102,7 +104,7 @@ export class ScopeApiImpl extends ApiBase {
             !this.scopeIsAll(scope) &&
             'ColumnIds' in scope &&
             scope.ColumnIds.length == 1 &&
-            this.adaptable.api.columnApi.hasBooleanDataType(scope.ColumnIds[0]));
+            this.getAdaptableApi().columnApi.hasBooleanDataType(scope.ColumnIds[0]));
     }
     areAllBooleanColumnsInScope(scope) {
         return (this.scopeHasColumns(scope) &&
@@ -110,7 +112,7 @@ export class ScopeApiImpl extends ApiBase {
             !this.scopeIsAll(scope) &&
             'ColumnIds' in scope &&
             scope.ColumnIds.length &&
-            scope.ColumnIds.every((columnId) => this.adaptable.api.columnApi.hasBooleanDataType(columnId)));
+            scope.ColumnIds.every((columnId) => this.getAdaptableApi().columnApi.hasBooleanDataType(columnId)));
     }
     isColumnInScopeColumns(column, scope) {
         return this.scopeHasColumns(scope) && this.isColumnInScope(column, scope);
@@ -118,7 +120,7 @@ export class ScopeApiImpl extends ApiBase {
     isPrimaryKeyColumnInScopeColumns(scope) {
         return ('ColumnIds' in scope &&
             scope.ColumnIds.length == 1 &&
-            scope.ColumnIds.find((c) => c == this.adaptable.api.optionsApi.getPrimaryKey()) != null);
+            scope.ColumnIds.find((c) => c == this.getAdaptableApi().optionsApi.getPrimaryKey()) != null);
     }
     getScopeToString(scope) {
         if ('All' in scope) {
@@ -133,8 +135,8 @@ export class ScopeApiImpl extends ApiBase {
         if ('ColumnIds' in scope) {
             let text = scope.ColumnIds.length == 1 ? 'Column: ' : 'Columns: ';
             return (text +
-                this.adaptable.api.columnApi
-                    .getFriendlyNamesForColumnIds(scope.ColumnIds)
+                this.getAdaptableApi()
+                    .columnApi.getFriendlyNamesForColumnIds(scope.ColumnIds)
                     .map((c) => {
                     return '"' + c + '"';
                 })
@@ -160,6 +162,7 @@ export class ScopeApiImpl extends ApiBase {
         return undefined;
     }
     isColumnInNumericScope(column, scope) {
+        var _a, _b;
         // if column is not even numeric then return false
         if (column == null || column == undefined || column.dataType !== 'Number') {
             return false;
@@ -176,9 +179,14 @@ export class ScopeApiImpl extends ApiBase {
         if ('DataTypes' in scope && scope.DataTypes.includes('Number')) {
             return true;
         }
+        if ('ColumnTypes' in scope &&
+            ((_b = (_a = scope.ColumnTypes) === null || _a === void 0 ? void 0 : _a.some) === null || _b === void 0 ? void 0 : _b.call(_a, (scopeColumnType) => { var _a, _b; return (_b = (_a = column.columnTypes) === null || _a === void 0 ? void 0 : _a.includes) === null || _b === void 0 ? void 0 : _b.call(_a, scopeColumnType); }))) {
+            return true;
+        }
         return false;
     }
     isColumnInStringsScope(column, scope) {
+        var _a, _b;
         // if column is not even string then return false
         if (column == null || column == undefined || column.dataType !== 'String') {
             return false;
@@ -195,9 +203,14 @@ export class ScopeApiImpl extends ApiBase {
         if ('DataTypes' in scope && scope.DataTypes.includes('String')) {
             return true;
         }
+        if ('ColumnTypes' in scope &&
+            ((_b = (_a = scope.ColumnTypes) === null || _a === void 0 ? void 0 : _a.some) === null || _b === void 0 ? void 0 : _b.call(_a, (scopeColumnType) => { var _a, _b; return (_b = (_a = column.columnTypes) === null || _a === void 0 ? void 0 : _a.includes) === null || _b === void 0 ? void 0 : _b.call(_a, scopeColumnType); }))) {
+            return true;
+        }
         return false;
     }
     isColumnInDateScope(column, scope) {
+        var _a, _b;
         // if column is not even numeric then return false
         if (column == null || column == undefined || column.dataType !== 'Date') {
             return false;
@@ -214,6 +227,10 @@ export class ScopeApiImpl extends ApiBase {
         if ('DataTypes' in scope && scope.DataTypes.includes('Date')) {
             return true;
         }
+        if ('ColumnTypes' in scope &&
+            ((_b = (_a = scope.ColumnTypes) === null || _a === void 0 ? void 0 : _a.some) === null || _b === void 0 ? void 0 : _b.call(_a, (scopeColumnType) => { var _a, _b; return (_b = (_a = column.columnTypes) === null || _a === void 0 ? void 0 : _a.includes) === null || _b === void 0 ? void 0 : _b.call(_a, scopeColumnType); }))) {
+            return true;
+        }
         return false;
     }
     isScopeInScope(a, b) {
@@ -236,14 +253,30 @@ export class ScopeApiImpl extends ApiBase {
             'DataTypes' in b &&
             a.ColumnIds.every((columnId) => {
                 var _a;
-                return b.DataTypes.includes((_a = this.adaptable.api.columnApi.getColumnWithColumnId(columnId)) === null || _a === void 0 ? void 0 : _a.dataType);
+                return b.DataTypes.includes((_a = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId)) === null || _a === void 0 ? void 0 : _a.dataType);
             })) {
             return true;
         }
+        if ('ColumnTypes' in a &&
+            'ColumnTypes' in b &&
+            a.ColumnTypes.every((columnType) => b.ColumnTypes.includes(columnType))) {
+            return true;
+        }
+        // check if each colum in a has column types in b
+        if ('ColumnIds' in a && 'ColumnTypes' in b) {
+            const inScope = a.ColumnIds.every((columnId) => {
+                const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
+                // check if at least one column-type is in scope
+                return column.columnTypes.some((columnColumnType) => b.ColumnTypes.includes(columnColumnType));
+            });
+            if (inScope) {
+                return true;
+            }
+        }
         return false;
     }
     createCellColorRangesForScope(scope) {
-        let distinctColumnsValues = this.adaptable.api.gridApi.internalApi.getDistinctRawValuesForColumn(this.adaptable.api.scopeApi.getSingleColumnInScope(scope));
+        let distinctColumnsValues = this.getAdaptableApi().gridApi.internalApi.getDistinctRawValuesForColumn(this.getAdaptableApi().columnScopeApi.getSingleColumnInScope(scope));
         let minValue = Math.min(...distinctColumnsValues);
         let maxValue = Math.max(...distinctColumnsValues);
         const ranges = [];

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

@@ -1,19 +1,18 @@
 import { ApiBase } from './ApiBase';
-import { CellAddress } from '../../PredefinedConfig/CellAddress';
-import { CommentThread, AdaptableComment } from '../../types';
+import { CommentThread, AdaptableComment, CellAddress } from '../../types';
 import { CommentApi } from '../CommentApi';
 import { CommentsInternalApi } from '../Internal/CommentsInternalApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 export declare class CommentsApiImpl extends ApiBase implements CommentApi {
     internalApi: CommentsInternalApi;
     constructor(adaptable: IAdaptable);
-    getComments(address: CellAddress): AdaptableComment[];
     getCommentThread(address: CellAddress): CommentThread | undefined;
-    getCommentThreads(): CommentThread[];
+    getGridComments(): CommentThread[];
     editComment(comment: AdaptableComment, address: CellAddress): void;
     deleteComment(comment: AdaptableComment, address: CellAddress): void;
     addComment(commentText: AdaptableComment['Value'], address: CellAddress): void;
     addCommentThread(commentThread: CommentThread): void;
     deleteCommentThread(cellAddress: CellAddress): void;
-    loadCommentThreads(cellComments: CommentThread[]): void;
+    setGridComments(cellComments: CommentThread[]): void;
+    clearGridComments(): void;
 }

package/src/Api/Implementation/CommentsApiImpl.js

@@ -8,13 +8,10 @@ export class CommentsApiImpl extends ApiBase {
         super(adaptable);
         this.internalApi = new CommentsInternalApi(adaptable);
     }
-    getComments(address) {
-        return CommentRedux.GetCommentsSelector(this.getAdaptableState().Comment, address);
-    }
     getCommentThread(address) {
         return CommentRedux.GetCellCommentSelector(this.getAdaptableState().Comment, address);
     }
-    getCommentThreads() {
+    getGridComments() {
         var _a;
         return (_a = this.getAdaptableState().Comment.CommentThreads) !== null && _a !== void 0 ? _a : [];
     }
@@ -27,7 +24,7 @@ export class CommentsApiImpl extends ApiBase {
     addComment(commentText, address) {
         this.dispatchAction(CommentRedux.CommentsAdd({
             comment: commentText
-                ? ObjectFactory.CreateAdaptableComment(commentText, this.adaptable.api)
+                ? ObjectFactory.CreateAdaptableComment(commentText, this.getAdaptableApi())
                 : null,
             cellAddress: address,
         }));
@@ -41,7 +38,10 @@ export class CommentsApiImpl extends ApiBase {
     deleteCommentThread(cellAddress) {
         this.dispatchAction(CommentRedux.CommentsCellDelete({ cellAddress }));
     }
-    loadCommentThreads(cellComments) {
+    setGridComments(cellComments) {
         this.dispatchAction(CommentRedux.CommentsSet({ commentThread: cellComments }));
     }
+    clearGridComments() {
+        this.setGridComments([]);
+    }
 }

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

@@ -20,7 +20,7 @@ import { AdaptableModule, AdaptableStateKey } from '../../PredefinedConfig/Commo
 import { AdaptableOptions, AdaptableSearchState, AdaptableSortState, NamedQueryState, ScheduleState } from '../../types';
 import { PredefinedConfig } from '../../PredefinedConfig/PredefinedConfig';
 import { ChartingState } from '../../PredefinedConfig/ChartingState';
-import { NotesState } from '../../PredefinedConfig/NotesState';
+import { NoteState } from '../../PredefinedConfig/NoteState';
 export declare class ConfigApiImpl extends ApiBase implements ConfigApi {
     configInit(): void;
     copyAllStateToClipboard(): void;
@@ -48,7 +48,7 @@ export declare class ConfigApiImpl extends ApiBase implements ConfigApi {
     getApplicationState(returnJson?: boolean): ApplicationState;
     getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;
     getChartingState(returnJson?: boolean): ChartingState;
-    getNotesState(returnJson?: boolean): NotesState;
+    getNoteState(returnJson?: boolean): NoteState;
     getCustomSortState(returnJson?: boolean): CustomSortState;
     getDashboardState(returnJson?: boolean): DashboardState;
     getExportState(returnJson?: boolean): ExportState;

package/src/Api/Implementation/ConfigApiImpl.js

@@ -8,7 +8,7 @@ import * as AlertRedux from '../../Redux/ActionsReducers/AlertRedux';
 import * as BulkUpdateRedux from '../../Redux/ActionsReducers/BulkUpdateRedux';
 import * as CalculatedColumnRedux from '../../Redux/ActionsReducers/CalculatedColumnRedux';
 import * as ChartingRedux from '../../Redux/ActionsReducers/ChartingRedux';
-import * as NotesRedux from '../../Redux/ActionsReducers/NotesRedux';
+import * as NoteRedux from '../../Redux/ActionsReducers/NoteRedux';
 import * as CustomSortRedux from '../../Redux/ActionsReducers/CustomSortRedux';
 import * as ExportRedux from '../../Redux/ActionsReducers/ExportRedux';
 import * as FormatColumnRedux from '../../Redux/ActionsReducers/FormatColumnRedux';
@@ -62,15 +62,9 @@ export class ConfigApiImpl extends ApiBase {
                     flushCurrentState: false,
                 }).then(() => {
                     const newState = this.getPersistedState();
-                    const stateReloadedInfo = {
-                        oldState,
-                        newState,
-                        adaptableStateKey: adaptableOptions.adaptableStateKey,
-                        adaptableId: adaptableOptions.adaptableId,
-                        adaptableApi: this.adaptable.api,
-                        userName: this.adaptable.api.optionsApi.getUserName(),
-                    };
-                    this.adaptable.api.eventApi.emit('AdaptableStateReloaded', stateReloadedInfo);
+                    const stateReloadedInfo = Object.assign({ oldState,
+                        newState, adaptableStateKey: adaptableOptions.adaptableStateKey }, this.getAdaptableApi().internalApi.buildBaseContext());
+                    this.getAdaptableApi().eventApi.emit('AdaptableStateReloaded', stateReloadedInfo);
                 });
             });
         });
@@ -93,21 +87,21 @@ export class ConfigApiImpl extends ApiBase {
         });
     }
     getAdaptableSearchState() {
-        const gridFilter = this.adaptable.api.gridFilterApi.getCurrentGridFilterExpression();
+        const gridFilter = this.getAdaptableApi().gridFilterApi.getCurrentGridFilterExpression();
         const adaptableSearchState = {
-            dataSet: this.adaptable.api.dataSetApi.getCurrentDataSet(),
+            dataSet: this.getAdaptableApi().dataSetApi.getCurrentDataSet(),
             gridFilter: gridFilter,
             gridFilterAST: gridFilter
-                ? this.adaptable.api.expressionApi.getASTForExpression(gridFilter)
+                ? this.getAdaptableApi().expressionApi.getASTForExpression(gridFilter)
                 : null,
-            columnFilters: this.adaptable.api.columnFilterApi.getColumnFilters(),
+            columnFilters: this.getAdaptableApi().columnFilterApi.getColumnFilters(),
         };
         return adaptableSearchState;
     }
     getAdaptableSortState() {
         const adaptableSortState = {
-            columnSorts: this.adaptable.api.gridApi.getColumnSorts(),
-            customSorts: this.adaptable.api.customSortApi.getCustomSorts(),
+            columnSorts: this.getAdaptableApi().gridApi.getColumnSorts(),
+            customSorts: this.getAdaptableApi().customSortApi.getCustomSorts(),
         };
         return adaptableSortState;
     }
@@ -116,7 +110,7 @@ export class ConfigApiImpl extends ApiBase {
     }
     setAdaptableStateKey(adaptableStateKey, config) {
         return new Promise((resolve, reject) => {
-            this.adaptable.api.internalApi.executeWithProgressIndicator(`Initialising...`, () => {
+            this.getAdaptableApi().internalApi.executeWithProgressIndicator(`Initialising...`, () => {
                 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
@@ -133,12 +127,14 @@ export class ConfigApiImpl extends ApiBase {
                         adaptable: this.adaptable,
                         adaptableStateKey,
                         predefinedConfig,
+                        postLoadHook: (state) => {
+                            return this.adaptable.normalizeAdaptableState(state, this.adaptable.agGridAdapter.getLiveGridOptions());
+                        },
                     });
                     promise
                         .then(() => {
                         this.adaptable.updateColumnModelAndRefreshGrid({ skipColDefsRefresh: true });
                         this.adaptable.setLayout();
-                        this.adaptable.api.userInterfaceApi.hideLoadingScreen();
                     })
                         .then(() => {
                         // resolve main(result) promise
@@ -178,10 +174,10 @@ export class ConfigApiImpl extends ApiBase {
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().Charting)
                     : this.getAdaptableState().Charting;
-            case 'Notes':
+            case 'Note':
                 return returnJson
-                    ? JSON.stringify(this.getAdaptableState().Notes)
-                    : this.getAdaptableState().Notes;
+                    ? JSON.stringify(this.getAdaptableState().Note)
+                    : this.getAdaptableState().Note;
             case 'CustomSort':
                 return returnJson
                     ? JSON.stringify(this.getAdaptableState().CustomSort)
@@ -258,8 +254,8 @@ export class ConfigApiImpl extends ApiBase {
     getChartingState(returnJson = false) {
         return this.getUserStateByStateKey('Charting', returnJson);
     }
-    getNotesState(returnJson = false) {
-        return this.getUserStateByStateKey('Notes', returnJson);
+    getNoteState(returnJson = false) {
+        return this.getUserStateByStateKey('Note', returnJson);
     }
     getCustomSortState(returnJson = false) {
         return this.getUserStateByStateKey('CustomSort', returnJson);
@@ -314,8 +310,8 @@ export class ConfigApiImpl extends ApiBase {
             case 'Charting':
                 this.dispatchAction(ChartingRedux.ChartingReady(this.getChartingState()));
                 break;
-            case 'Notes':
-                this.dispatchAction(NotesRedux.NotesReady(this.getNotesState()));
+            case 'Note':
+                this.dispatchAction(NoteRedux.NoteReady(this.getNoteState()));
                 break;
             case 'CustomSort':
                 this.dispatchAction(CustomSortRedux.CustomSortReady(this.getCustomSortState()));

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

@@ -0,0 +1,7 @@
+import { ApiBase } from './ApiBase';
+import { ContextMenuApi } from '../ContextMenuApi';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+export declare class ContextMenuApiImpl extends ApiBase implements ContextMenuApi {
+    constructor(adaptable: IAdaptable);
+    hideContextMenu(): void;
+}

package/src/Api/Implementation/ContextMenuApiImpl.js

@@ -0,0 +1,9 @@
+import { ApiBase } from './ApiBase';
+export class ContextMenuApiImpl extends ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+    }
+    hideContextMenu() {
+        this.adaptable.agGridAdapter.getAgGridApi().hidePopupMenu();
+    }
+}

package/src/Api/Implementation/DashboardApiImpl.js

@@ -20,12 +20,7 @@ export class DashboardApiImpl extends ApiBase {
     }
     getCustomDashboardButtonByLabel(buttonLabel) {
         const api = this.getAdaptableApi();
-        const dashboardContext = {
-            adaptableApi: api,
-            userName: this.getOptions().userName,
-            adaptableId: this.getOptions().adaptableId,
-            dashboardState: api.dashboardApi.getDashboardState(),
-        };
+        const dashboardContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { dashboardState: api.dashboardApi.getDashboardState() });
         return this.getDashboardOptions().customDashboardButtons.find((cb) => {
             api.internalApi.getLabelForButton(cb, dashboardContext) == buttonLabel;
         });

package/src/Api/Implementation/ExportApiImpl.js

@@ -44,13 +44,13 @@ export class ExportApiImpl extends ApiBase {
         return currentDestination && this.getDestinationByName(currentDestination);
     }
     getAvailableSystemReports() {
-        return this.getExportOptions().systemReportNames.filter((s) => this.adaptable.api.internalApi.getReportService().IsSystemReportActive(s));
+        return this.getExportOptions().systemReportNames.filter((s) => this.getAdaptableApi().internalApi.getReportService().IsSystemReportActive(s));
     }
     getAvailableExportDestinations() {
         let systemDestinations = [];
         this.getExportOptions().systemExportDestinations.forEach((exportDestination) => {
-            if (this.adaptable.api.internalApi
-                .getReportService()
+            if (this.getAdaptableApi()
+                .internalApi.getReportService()
                 .IsSystemExportDestinationActive(exportDestination)) {
                 systemDestinations.push(exportDestination);
             }
@@ -143,17 +143,12 @@ export class ExportApiImpl extends ApiBase {
             this.logWarn(`Report '${reportName}' not found!`);
             return undefined;
         }
-        return this.adaptable.api.internalApi.getReportService().getReportData(report);
+        return this.getAdaptableApi().internalApi.getReportService().getReportData(report);
     }
     isColumnExportable(adaptableColumn) {
         const isExportableFn = this.getExportOptions().isColumnExportable;
         if (typeof isExportableFn === 'function') {
-            return isExportableFn({
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                adaptableColumn,
-            });
+            return isExportableFn(Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { adaptableColumn }));
         }
         return true;
     }