npm - @adaptabletools/adaptable - Versions diffs - 19.2.3 → 20.0.0-canary.0 - Mend

@adaptabletools/adaptable 19.2.3 → 20.0.0-canary.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1665) hide show

package/src/Strategy/CellSummaryModule.js CHANGED Viewed

@@ -1,13 +1,15 @@
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { ArrayExtensions } from '../Utilities/Extensions/ArrayExtensions';
-import { Helper } from '../Utilities/Helpers/Helper';
 import ObjectFactory from '../Utilities/ObjectFactory';
 import { AggregatedScalarLiveValue } from '../Utilities/Services/AggregatedScalarLiveValue';
 import { CellSummaryStatusPanel } from '../View/CellSummary/CellSummaryStatusPanel';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
+/**
+ * Module that provides Cell Summaries on numeric columns
+ */
 export class CellSummaryModule extends AdaptableModuleBase {
     constructor(api) {
-        super(ModuleConstants.CellSummaryModuleId, ModuleConstants.CellSummaryFriendlyName, 'cells', 'CellSummaryPopup', 'See summary information on a group of cells using multiple summary operations', api);
+        super(ModuleConstants.CellSummaryModuleId, ModuleConstants.CellSummaryFriendlyName, 'cells', 'CellSummaryPopup', 'See summary information on a group of numeric cells using multiple summary operations', api);
         this.cachedCellSummary = new WeakMap();
     }
     getViewAccessLevel() {
@@ -17,6 +19,9 @@ export class CellSummaryModule extends AdaptableModuleBase {
         if (!this.isModuleAvailable()) {
             return;
         }
+        if (column.dataType !== 'number') {
+            return;
+        }
         return [
             this.createMainMenuItemShowPopup({
                 Name: 'cell-summary-show',
@@ -34,7 +39,9 @@ export class CellSummaryModule extends AdaptableModuleBase {
         if (!this.isModuleAvailable()) {
             return;
         }
-        if (menuContext.adaptableColumn && menuContext.isSelectedCell) {
+        if (menuContext.adaptableColumn &&
+            menuContext.isSelectedCell &&
+            menuContext.adaptableColumn.dataType === 'number') {
             return [
                 this.createMainMenuItemShowPopup({
                     Name: 'cell-summary-show',
@@ -48,37 +55,31 @@ export class CellSummaryModule extends AdaptableModuleBase {
             ];
         }
     }
-    createCellSummary(selectedCellInfo) {
+    createCellSummaryInfo(selectedCellInfo) {
         if (this.cachedCellSummary.has(selectedCellInfo)) {
             return this.cachedCellSummary.get(selectedCellInfo);
         }
         let selectedCellSummary = ObjectFactory.CreateEmptyCellSummmary();
-        if (selectedCellInfo && ArrayExtensions.GetLength(selectedCellInfo.columns) === 1) {
-            const selectedColumn = selectedCellInfo.columns[0];
-            if (selectedColumn) {
-                const isNumericColumn = selectedColumn.dataType === 'Number';
-                const isDateColumn = selectedColumn.dataType === 'Date';
+        if (selectedCellInfo && ArrayExtensions.hasOneItem(selectedCellInfo.columns)) {
+            let selectedColumn = selectedCellInfo.columns[0];
+            if (selectedColumn && selectedColumn.dataType === 'number') {
+                const numberFormatOptions = this.getNumberFormatOptions(selectedColumn);
                 const rowNodes = selectedCellInfo.gridCells.map((gc) => gc.rowNode);
                 const handleExpression = (functionName) => {
                     const aggScalarValue = new AggregatedScalarLiveValue({
                         aggregatedScalarExpression: `${functionName}([${selectedColumn.columnId}])`,
                     }, ModuleConstants.CellSummaryModuleId, this.api, () => rowNodes);
-                    let value = aggScalarValue.getGlobalAggregatedValue();
-                    if (typeof value === 'number' && !isNaN(value)) {
-                        value = Helper.roundNumber(value, 2);
-                    }
-                    return value;
+                    return this.formatValue(numberFormatOptions, selectedColumn, aggScalarValue.getGlobalAggregatedValue(), rowNodes[0]);
                 };
-                const sumValue = isNumericColumn ? handleExpression('SUM') : null;
-                const avgValue = isNumericColumn ? Helper.roundNumber(handleExpression('AVG'), 2) : null;
-                const modeValue = isNumericColumn ? handleExpression('MODE') : null;
-                const medianValue = isNumericColumn ? handleExpression('MEDIAN') : null;
+                const sumValue = handleExpression('SUM');
+                const avgValue = handleExpression('AVG');
+                const modeValue = handleExpression('MODE');
+                const medianValue = handleExpression('MEDIAN');
                 const distinctValue = handleExpression('DISTINCT');
-                const maxValue = isNumericColumn || isDateColumn ? handleExpression('MAX') : null;
-                const minValue = isNumericColumn || isDateColumn ? handleExpression('MIN') : null;
-                const stdDeviation = isNumericColumn
-                    ? Helper.roundNumberTo4dp(handleExpression('STD_DEVIATION'))
-                    : null;
+                const maxValue = handleExpression('MAX');
+                const minValue = handleExpression('MIN');
+                const countValue = selectedCellInfo.gridCells.length;
+                const stdDeviation = handleExpression('STD_DEVIATION');
                 selectedCellSummary = {
                     Sum: sumValue,
                     Average: avgValue,
@@ -87,19 +88,25 @@ export class CellSummaryModule extends AdaptableModuleBase {
                     Distinct: distinctValue,
                     Max: maxValue,
                     Min: minValue,
-                    Count: selectedCellInfo.gridCells.length,
+                    Count: countValue,
                     Std_Deviation: stdDeviation,
-                    Only: distinctValue == 1 ? JSON.stringify(selectedCellInfo.gridCells[0].rawValue) : '',
+                    Only: distinctValue == 1 ? JSON.stringify(selectedCellInfo.gridCells[0].rawValue) : undefined,
                 };
-                const weightedAverage = this.getWeightedAverageCellSummary(selectedColumn.columnId, rowNodes);
-                if (weightedAverage !== null) {
-                    selectedCellSummary.Weighted_Average = weightedAverage;
+                const weightedAverageConfig = this.getWeightedAverageConfig(selectedColumn.columnId);
+                if (weightedAverageConfig) {
+                    const weightedAverage = this.getWeightedAverageCellSummary(weightedAverageConfig, selectedColumn.columnId, rowNodes);
+                    if (weightedAverage !== null) {
+                        selectedCellSummary.Weighted_Average = this.formatValue(numberFormatOptions, selectedColumn, weightedAverage, rowNodes[0]);
+                    }
                 }
-                const operationDefinitions = this.api.cellSummaryApi.getCellSummaryOperationDefinitions();
-                operationDefinitions === null || operationDefinitions === void 0 ? void 0 : operationDefinitions.forEach((operation) => {
+                const customCellSummaryOperations = this.api.cellSummaryApi.getCustomCellSummaryOperations();
+                customCellSummaryOperations?.forEach((operation) => {
                     if (operation.operationFunction) {
-                        const cellSummaryOperationContext = Object.assign({ selectedCellInfo,
-                            selectedColumn }, this.api.internalApi.buildBaseContext());
+                        const cellSummaryOperationContext = {
+                            selectedCellInfo,
+                            selectedColumn,
+                            ...this.api.internalApi.buildBaseContext(),
+                        };
                         selectedCellSummary[operation.operationName] = operation.operationFunction(cellSummaryOperationContext);
                     }
                 });
@@ -108,25 +115,56 @@ export class CellSummaryModule extends AdaptableModuleBase {
         }
         return selectedCellSummary;
     }
-    getWeightedAverageCellSummary(columnId, rowNodes) {
-        const currentLayout = this.api.layoutApi.getCurrentLayout();
-        if (currentLayout.AggregationColumns == undefined) {
-            return false;
+    getNumberFormatOptions(column) {
+        let columnToFormat = column;
+        let adaptableFormat;
+        // first get any Display Formats applied for the column and if provided, then return those
+        // note: this will automatically include any custom formats
+        adaptableFormat = this.api.formatColumnApi.getDisplayFormatForColumn(columnToFormat);
+        if (adaptableFormat) {
+            return adaptableFormat.Options;
+        }
+        // temporary hack until we get the parent for pivot columns - just in case we dont have time...
+        if (columnToFormat.isGeneratedPivotResultColumn) {
+            const parts = columnToFormat.columnId.split('_');
+            const colid = parts[parts.length - 1];
+            columnToFormat = this.api.columnApi.getColumnWithColumnId(colid);
+            // check if this pivot result column has been give its own Format and if so return it
+            adaptableFormat = this.api.formatColumnApi.getDisplayFormatForColumn(columnToFormat);
+            if (adaptableFormat) {
+                return adaptableFormat.Options;
+            }
         }
-        const weightedAverageConfig = Object.entries(currentLayout.AggregationColumns).find(([colId, aggCol]) => typeof aggCol === 'object' && aggCol.type === 'weightedAverage' && colId === columnId);
-        if (!weightedAverageConfig) {
-            return null;
+        // otherwise get the numeric format in Cell Summary Options (either function or value)
+        const numericDisplayFormat = this.api.optionsApi.getCellSummaryOptions().numericDisplayFormat;
+        if (typeof numericDisplayFormat === 'function') {
+            const context = {
+                column: columnToFormat,
+                ...this.api.internalApi.buildBaseContext(),
+            };
+            return numericDisplayFormat(context);
         }
-        const { weightedColumnId } = weightedAverageConfig[1];
+        else {
+            return numericDisplayFormat;
+        }
+    }
+    formatValue(formatterOptions, column, valueToFormat, node) {
+        return isNaN(valueToFormat)
+            ? valueToFormat
+            : this.api.formatColumnApi.internalApi.getNumberFormattedValue(valueToFormat, node, column, formatterOptions);
+    }
+    getWeightedAverageConfig(columnId) {
+        const weightedAverageConfig = (this.api.layoutApi.getCurrentLayout().TableAggregationColumns || []).find(({ ColumnId, AggFunc }) => typeof AggFunc === 'object' && AggFunc.type === 'weightedAverage' && ColumnId === columnId);
+        return weightedAverageConfig;
+    }
+    getWeightedAverageCellSummary(weightedAverageConfig, columnId, rowNodes) {
+        const weightedColumnId = weightedAverageConfig.AggFunc
+            .weightedColumnId;
         const expression = `AVG([${columnId}], WEIGHT([${weightedColumnId}]))`;
         const aggScalarValue = new AggregatedScalarLiveValue({
             aggregatedScalarExpression: expression,
         }, ModuleConstants.CellSummaryModuleId, this.api, () => rowNodes);
-        let value = aggScalarValue.getGlobalAggregatedValue();
-        if (typeof value === 'number' && !isNaN(value)) {
-            value = Helper.roundNumber(value, 2);
-        }
-        return value;
+        return aggScalarValue.getGlobalAggregatedValue();
     }
     getViewProperties() {
         return {

package/src/Strategy/ChartingModule.d.ts CHANGED Viewed

@@ -1,11 +1,12 @@
 import { AdaptableModuleView, AdaptableObjectView, IModule } from './Interface/IModule';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableApi } from '../Api/AdaptableApi';
-import { ChartDefinition } from '../types';
+import { AdaptableColumn, ChartDefinition } from '../types';
 import { ExternalChartDefinition } from '../PredefinedConfig/ChartingState';
 export declare class ChartingModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
     isModuleAvailable(): boolean;
+    createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "chart-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar" | "separator">[];
     getModuleAdaptableObjects(): (ChartDefinition | ExternalChartDefinition)[];
     toViewAll(): AdaptableObjectView[];
     toView(chart: ChartDefinition | ExternalChartDefinition): AdaptableObjectView;

package/src/Strategy/ChartingModule.js CHANGED Viewed

@@ -4,9 +4,10 @@ import { ShowChartButton } from '../View/Charting/ShowChartButton';
 import { ChartingWizard } from '../View/Charting/ChartingWizard';
 import * as ChartingRedux from '../Redux/ActionsReducers/ChartingRedux';
 import { ChartingStatusBarPopover } from '../View/Charting/ChartingStatusBarPopover';
-import { getObjectTagsViewItems } from './Utilities/getObjectTagsViewItems';
 import { isAgChartDefinition, isExternalChartDefinition, } from '../PredefinedConfig/ChartingState';
 import Helper from '../Utilities/Helpers/Helper';
+import { getObjectTagsViewItems } from '../Utilities/getObjectTagsViewItems';
+import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
 export class ChartingModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ChartingModuleId, ModuleConstants.ChartingFriendlyName, 'chart', 'ChartPopup', 'Create AG Grid Charts in order to see Adaptable Data visually', api);
@@ -16,6 +17,20 @@ export class ChartingModule extends AdaptableModuleBase {
         const externalChartsAvailable = Helper.objectHasKeys(this.api.optionsApi.getChartingOptions().externalChartingOptions);
         return Boolean(agChartsAvailable || externalChartsAvailable);
     }
+    createColumnMenuItems(column) {
+        if (column &&
+            this.isModuleEditable() &&
+            ArrayExtensions.IsNotNullOrEmpty(this.api.chartingApi.getChartDefinitions())) {
+            return [
+                this.createMainMenuItemShowPopup({
+                    Name: 'chart-show',
+                    Label: 'Manage Charts',
+                    ComponentName: this.moduleInfo.Popup,
+                    Icon: this.moduleInfo.Glyph,
+                }),
+            ];
+        }
+    }
     getModuleAdaptableObjects() {
         return [
             ...this.api.chartingApi.getChartDefinitions(),
@@ -40,7 +55,6 @@ export class ChartingModule extends AdaptableModuleBase {
         };
     }
     toViewChartDefinition(chart) {
-        var _a;
         return {
             items: [
                 {
@@ -74,7 +88,7 @@ export class ChartingModule extends AdaptableModuleBase {
                             `Column start: ${typeof chart.Model.cellRange.columnEnd === 'string'
                                 ? this.api.columnApi.getFriendlyNameForColumnId(chart.Model.cellRange.columnEnd)
                                 : this.api.columnApi.getFriendlyNameForColumnId(chart.Model.cellRange.columnEnd.getColId())}`,
-                        ((_a = chart.Model.cellRange.columns) === null || _a === void 0 ? void 0 : _a.length) &&
+                        chart.Model.cellRange.columns?.length &&
                             `Columns ${chart.Model.cellRange.columns
                                 .map((column) => typeof column === 'string'
                                 ? this.api.columnApi.getFriendlyNameForColumnId(column)

package/src/Strategy/ColumnFilterModule.d.ts CHANGED Viewed

@@ -13,9 +13,8 @@ export declare class ColumnFilterModule extends AdaptableModuleBase implements I
     getExplicitlyReferencedColumnIds(columnFilter: ColumnFilter): string[];
     hasNamedQueryReferences(): boolean;
     onAdaptableReady(): void;
-    createColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
+    createColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem<"calculated-column-edit" | "cell-summary-show" | "chart-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar" | "separator">[];
     createContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem<AdaptableContextMenuItemName>[] | undefined;
-    private getExistingColumnFilter;
     getTeamSharingAction(): TeamSharingImportInfo<ColumnFilter>;
     toViewCompact(filter: ColumnFilter): AdaptableObjectCompactView;
     toView(filter: ColumnFilter): AdaptableObjectView;

package/src/Strategy/ColumnFilterModule.js CHANGED Viewed

@@ -1,7 +1,7 @@
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import * as LayoutRedux from '../Redux/ActionsReducers/LayoutRedux';
-import * as SystemRedux from '../Redux/ActionsReducers/SystemRedux';
+import * as InternalRedux from '../Redux/ActionsReducers/InternalRedux';
 import { FilterStatusBarSubPanelPopover } from '../View/Filter/FilterStatusBarSubPanelPopover';
 import { getFilterPreview } from './Utilities/Layout/getLayoutFilterViewItems';
 export class ColumnFilterModule extends AdaptableModuleBase {
@@ -9,16 +9,15 @@ export class ColumnFilterModule extends AdaptableModuleBase {
         super(ModuleConstants.ColumnFilterModuleId, ModuleConstants.ColumnFilterFriendlyName, 'filter', 'FilterPopup', 'Advanced filtering capability allows users to see precisely the data they want', api);
     }
     setModuleEntitlement() {
-        if (!this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
+        if (!this.api.optionsApi.getFilterOptions().useAdaptableFiltering) {
             this.AccessLevel = 'Hidden';
         }
         else {
-            this.AccessLevel = this.api.entitlementApi
-                .getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
+            this.AccessLevel = this.api.entitlementApi.getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
         }
     }
     getModuleAdaptableObjects() {
-        return this.api.columnFilterApi.getColumnFilters();
+        return this.api.filterApi.columnFilterApi.getColumnFilters();
     }
     getExplicitlyReferencedColumnIds(columnFilter) {
         return [columnFilter.ColumnId];
@@ -27,10 +26,13 @@ export class ColumnFilterModule extends AdaptableModuleBase {
         return false;
     }
     onAdaptableReady() {
-        if (this.api.optionsApi.getColumnFilterOptions().quickFilterOptions.showQuickFilter == false) {
-            this.api.columnFilterApi.hideQuickFilterBar();
+        if (this.api.optionsApi.getFilterOptions().columnFilterOptions.showQuickFilter == false) {
+            this.api.filterApi.columnFilterApi.hideQuickFilterBar();
         }
-        const columnFilters = this.api.columnFilterApi.getColumnFilters();
+        else {
+            this.api.filterApi.columnFilterApi.showQuickFilterBar();
+        }
+        const columnFilters = this.api.filterApi.columnFilterApi.getColumnFilters();
         columnFilters.forEach((cf) => {
             if (!this.api.columnApi.isColumnInGrid(cf.ColumnId)) {
                 this.api.logError('Column Filter contains missing column: ' + cf.ColumnId);
@@ -41,17 +43,17 @@ export class ColumnFilterModule extends AdaptableModuleBase {
         let columnFilterMenuItems = [];
         if (column &&
             column.filterable &&
-            this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
+            this.api.optionsApi.getFilterOptions().useAdaptableFiltering) {
             if (this.api.gridApi.isQuickFilterAvailable()) {
-                const isFilterVisible = this.api.columnFilterApi.isQuickFilterVisible();
+                const isFilterVisible = this.api.filterApi.columnFilterApi.isQuickFilterVisible();
                 if (this.isModuleEditable() &&
-                    this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
+                    this.api.optionsApi.getFilterOptions().useAdaptableFiltering) {
                     columnFilterMenuItems.push(this.createMenuItemReduxAction(isFilterVisible ? 'column-filter-bar-hide' : 'column-filter-bar-show', isFilterVisible ? 'Hide Filter Bar' : 'Show Filter Bar', isFilterVisible ? 'filter-off' : 'filter', isFilterVisible
-                        ? SystemRedux.SystemQuickFilterBarHide()
-                        : SystemRedux.SystemQuickFilterBarShow()));
+                        ? InternalRedux.QuickFilterBarHide()
+                        : InternalRedux.QuickFilterBarShow()));
                 }
             }
-            const existingColumnFilter = this.getExistingColumnFilter(column);
+            const existingColumnFilter = this.api.filterApi.columnFilterApi.getColumnFilterForColumn(column.columnId);
             if (existingColumnFilter) {
                 columnFilterMenuItems.push(this.createMenuItemReduxAction('column-filter-clear', 'Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)));
                 columnFilterMenuItems.push(this.createMenuItemReduxAction(existingColumnFilter.IsSuspended ? 'column-filter-unsuspend' : 'column-filter-suspend', existingColumnFilter.IsSuspended ? 'Unsuspend Filter' : 'Suspend Filter', existingColumnFilter.IsSuspended ? 'resume' : 'pause', existingColumnFilter.IsSuspended
@@ -67,17 +69,17 @@ export class ColumnFilterModule extends AdaptableModuleBase {
                 menuContext.adaptableColumn.filterable &&
                 menuContext.isSingleSelectedColumn &&
                 menuContext.gridCell != null &&
-                this.api.optionsApi.getColumnFilterOptions().useAdaptableColumnFiltering) {
-                const existingColumnFilter = this.getExistingColumnFilter(menuContext.adaptableColumn);
+                this.api.optionsApi.getFilterOptions().useAdaptableFiltering) {
+                const existingColumnFilter = this.api.filterApi.columnFilterApi.getColumnFilterForColumn(menuContext.adaptableColumn.columnId);
                 if (!existingColumnFilter) {
                     if (!menuContext.isRowGroupColumn && !menuContext.isGroupedNode) {
                         let isMultiple = menuContext.selectedCellInfo.gridCells.length > 1;
                         let clickFunction = isMultiple
                             ? () => {
-                                this.api.columnFilterApi.internalApi.createValuesColumnFilterForCells(menuContext.selectedCellInfo.gridCells);
+                                this.api.filterApi.columnFilterApi.internalApi.createValuesColumnFilterForCells(menuContext.selectedCellInfo.gridCells);
                             }
                             : () => {
-                                this.api.columnFilterApi.internalApi.createEqualityColumnFilterForCell(menuContext.selectedCellInfo.gridCells[0]);
+                                this.api.filterApi.columnFilterApi.internalApi.createEqualityColumnFilterForCell(menuContext.selectedCellInfo.gridCells[0]);
                             };
                         return [
                             this.createMenuItemClickFunction('column-filter-on-cell-value', isMultiple ? 'Filter on Cell Values' : 'Filter on Cell Value', this.moduleInfo.Glyph, clickFunction),
@@ -91,22 +93,19 @@ export class ColumnFilterModule extends AdaptableModuleBase {
                             ? 'column-filter-unsuspend'
                             : 'column-filter-suspend', existingColumnFilter.IsSuspended ? 'Unsuspend Filter' : 'Suspend Filter', existingColumnFilter.IsSuspended ? 'resume' : 'pause', existingColumnFilter.IsSuspended
                             ? () => {
-                                this.api.columnFilterApi.unSuspendColumnFilter(existingColumnFilter);
+                                this.api.filterApi.columnFilterApi.unSuspendColumnFilter(existingColumnFilter);
                             }
                             : () => {
-                                this.api.columnFilterApi.suspendColumnFilter(existingColumnFilter);
+                                this.api.filterApi.columnFilterApi.suspendColumnFilter(existingColumnFilter);
                             }),
                     ];
                 }
             }
         }
     }
-    getExistingColumnFilter(column) {
-        return this.api.columnFilterApi.getColumnFilters().find((x) => x.ColumnId == column.columnId);
-    }
     getTeamSharingAction() {
         return {
-            ModuleEntities: this.api.columnFilterApi.getColumnFilters(),
+            ModuleEntities: this.api.filterApi.columnFilterApi.getColumnFilters(),
             AddAction: LayoutRedux.LayoutColumnFilterAdd,
             EditAction: LayoutRedux.LayoutColumnFilterEdit, //TODO need to change this to ColumnFilterSet
         };
@@ -114,7 +113,7 @@ export class ColumnFilterModule extends AdaptableModuleBase {
     toViewCompact(filter) {
         return {
             item: {
-                values: [this.api.columnFilterApi.internalApi.columnFilterToString(filter)],
+                values: [this.api.filterApi.columnFilterApi.columnFilterToString(filter)],
             },
             abObject: filter,
         };
@@ -150,13 +149,12 @@ export class ColumnFilterModule extends AdaptableModuleBase {
             getCompactDeleteAction: LayoutRedux.LayoutColumnFilterClear,
             getDeleteAllAction: LayoutRedux.LayoutColumnFilterClearAll,
             emptyView: `
-        There are currently no Column Filters applied. \n
-        Create Column Filters by using the Filter Bar, the Filter Form (in the Column Header Menu) or by editing a Layout.
+        There are no Column Filters applied. \n
+        Create Column Filters by using the Filter Components or by editing a Layout.
       `,
             getStatusBarPanelProps() {
                 let text;
-                const filters = api.columnFilterApi.getColumnFilters();
+                const filters = api.filterApi.columnFilterApi.getColumnFilters();
                 if (filters.length === 0) {
                     text = '0 Filters';
                 }

package/src/Strategy/ColumnInfoModule.d.ts CHANGED Viewed

@@ -6,6 +6,6 @@ import { AdaptableColumn, ContextMenuContext } from '../types';
 export declare class ColumnInfoModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
     getViewAccessLevel(): AccessLevel;
-    createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
-    createContextMenuItems(menuContext: ContextMenuContext): import("../Utilities/MenuItem").MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-visual-data" | "export-visual-data-excel" | "export-all-data-excel" | "export-all-data" | "export-all-data-csv" | "export-all-data-clipboard" | "export-all-data-json" | "export-all-data-table" | "export-current-data" | "export-current-data-excel" | "export-current-data-csv" | "export-current-data-clipboard" | "export-current-data-json" | "export-current-data-table" | "export-selected-cells" | "export-selected-cells-excel" | "export-selected-cells-csv" | "export-selected-cells-clipboard" | "export-selected-cells-json" | "export-selected-cells-table" | "export-selected-rows" | "export-selected-rows-excel" | "export-selected-rows-csv" | "export-selected-rows-clipboard" | "export-selected-rows-json" | "export-selected-rows-table" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
+    createColumnMenuItems(column: AdaptableColumn): import("../Utilities/MenuItem").MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "chart-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar" | "separator">[];
+    createContextMenuItems(menuContext: ContextMenuContext): import("../Utilities/MenuItem").MenuItemShowPopup<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-all-data" | "export-all-data-excel-download" | "export-all-data-visualexcel-download" | "export-all-data-csv" | "export-all-data-csv-download" | "export-all-data-csv-clipboard" | "export-all-data-json" | "export-all-data-json-download" | "export-all-data-json-clipboard" | "export-current-layout" | "export-current-layout-excel-download" | "export-current-layout-visualexcel-download" | "export-current-layout-csv" | "export-current-layout-csv-download" | "export-current-layout-csv-clipboard" | "export-current-layout-json" | "export-current-layout-json-download" | "export-current-layout-json-clipboard" | "export-selected-data" | "export-selected-data-excel-download" | "export-selected-data-visualexcel-download" | "export-selected-data-csv" | "export-selected-data-csv-download" | "export-selected-data-csv-clipboard" | "export-selected-data-json" | "export-selected-data-json-download" | "export-selected-data-json-clipboard" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
 }

package/src/Strategy/ColumnInfoModule.js CHANGED Viewed

@@ -8,7 +8,7 @@ export class ColumnInfoModule extends AdaptableModuleBase {
         return 'Full';
     }
     createColumnMenuItems(column) {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleAvailable() && !column.isTreeColumn) {
             const columnPopUpParams = {
                 source: 'ColumnMenu',
                 column: column,

package/src/Strategy/CommentModule.d.ts CHANGED Viewed

@@ -1,6 +1,5 @@
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { ContextMenuContext } from '../PredefinedConfig/Common/Menu';
-import { MenuItemDoClickFunction } from '../Utilities/MenuItem';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModule } from './Interface/IModule';
 export declare class CommentModule extends AdaptableModuleBase implements IModule {
@@ -8,5 +7,5 @@ export declare class CommentModule extends AdaptableModuleBase implements IModul
     onAdaptableReady(): void;
     isModuleAvailable(): boolean;
     private loadComments;
-    createContextMenuItems(menuContext: ContextMenuContext): MenuItemDoClickFunction<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-visual-data" | "export-visual-data-excel" | "export-all-data-excel" | "export-all-data" | "export-all-data-csv" | "export-all-data-clipboard" | "export-all-data-json" | "export-all-data-table" | "export-current-data" | "export-current-data-excel" | "export-current-data-csv" | "export-current-data-clipboard" | "export-current-data-json" | "export-current-data-table" | "export-selected-cells" | "export-selected-cells-excel" | "export-selected-cells-csv" | "export-selected-cells-clipboard" | "export-selected-cells-json" | "export-selected-cells-table" | "export-selected-rows" | "export-selected-rows-excel" | "export-selected-rows-csv" | "export-selected-rows-clipboard" | "export-selected-rows-json" | "export-selected-rows-table" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
+    createContextMenuItems(menuContext: ContextMenuContext): import("../Utilities/MenuItem").MenuItemDoClickFunction<"calculated-column-edit" | "cell-summary-show" | "column-group" | "column-filter-group" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "grid-group" | "grid-info-show" | "layout-edit" | "settings-panel-open" | "system-status-show" | "menu-group" | "alert-clear" | "bulk-update-apply" | "column-filter-on-cell-value" | "comment-add" | "comment-remove" | "edit-group" | "export-group" | "export-all-data" | "export-all-data-excel-download" | "export-all-data-visualexcel-download" | "export-all-data-csv" | "export-all-data-csv-download" | "export-all-data-csv-clipboard" | "export-all-data-json" | "export-all-data-json-download" | "export-all-data-json-clipboard" | "export-current-layout" | "export-current-layout-excel-download" | "export-current-layout-visualexcel-download" | "export-current-layout-csv" | "export-current-layout-csv-download" | "export-current-layout-csv-clipboard" | "export-current-layout-json" | "export-current-layout-json-download" | "export-current-layout-json-clipboard" | "export-selected-data" | "export-selected-data-excel-download" | "export-selected-data-visualexcel-download" | "export-selected-data-csv" | "export-selected-data-csv-download" | "export-selected-data-csv-clipboard" | "export-selected-data-json" | "export-selected-data-json-download" | "export-selected-data-json-clipboard" | "fdc3-broadcast" | "fdc3-raise-intent" | "flashing-cell-clear" | "flashing-row-clear" | "layout-aggregated-view" | "layout-auto-size" | "layout-clear-selection" | "layout-select-all" | "note-add" | "note-remove" | "smart-edit-apply">[];
 }

package/src/Strategy/CommentModule.js CHANGED Viewed

@@ -1,5 +1,4 @@
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
-import { createBaseContext } from '../Utilities/ObjectFactory';
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 export class CommentModule extends AdaptableModuleBase {
     constructor(api) {
@@ -13,31 +12,33 @@ export class CommentModule extends AdaptableModuleBase {
         if (!options || !options.persistCommentThreads || !options.loadCommentThreads) {
             return false;
         }
-        if (this.api.optionsApi.getAutogeneratePrimaryKey()) {
+        if (this.api.optionsApi.isAutogeneratePrimaryKey()) {
             return false;
         }
         return super.isModuleAvailable();
     }
     async loadComments() {
-        var _a, _b;
-        const commentThreads = await ((_b = (_a = this.api.optionsApi
-            .getCommentOptions()) === null || _a === void 0 ? void 0 : _a.loadCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, createBaseContext(this.api)));
-        this.api.commentApi.setGridComments(commentThreads);
+        const commentThreads = await this.api.optionsApi
+            .getCommentOptions()
+            ?.loadCommentThreads?.(this.api.internalApi.buildBaseContext());
+        this.api.commentApi.setComments(commentThreads);
     }
     createContextMenuItems(menuContext) {
-        var _a, _b, _c, _d, _e;
         if (!this.isModuleAvailable()) {
             return;
         }
-        if (!this.api.commentApi.internalApi.areCommentsSupported()) {
+        if (!this.api.commentApi.internalApi.areCommentsSupportedInLayout()) {
             return;
         }
         if (menuContext.isRowGroupColumn || menuContext.isGroupedNode) {
             return;
         }
         const items = [];
-        const isCellCommentable = typeof ((_b = (_a = this.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getCommentOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable) === 'function'
-            ? (_d = (_c = this.api.optionsApi) === null || _c === void 0 ? void 0 : _c.getCommentOptions()) === null || _d === void 0 ? void 0 : _d.isCellCommentable(Object.assign({ gridCell: menuContext.gridCell }, createBaseContext(this.api)))
+        const isCellCommentable = typeof this.api.optionsApi?.getCommentOptions()?.isCellCommentable === 'function'
+            ? this.api.optionsApi?.getCommentOptions()?.isCellCommentable({
+                gridCell: menuContext.gridCell,
+                ...this.api.internalApi.buildBaseContext(),
+            })
             : true;
         if (!isCellCommentable) {
             return;
@@ -46,7 +47,7 @@ export class CommentModule extends AdaptableModuleBase {
             PrimaryKeyValue: menuContext.primaryKeyValue,
             ColumnId: menuContext.adaptableColumn.columnId,
         };
-        const cellComments = (_e = this.api.commentApi.getCommentThread(cellAddress)) === null || _e === void 0 ? void 0 : _e.Comments;
+        const cellComments = this.api.commentApi.getCommentThreadForCell(cellAddress)?.Comments;
         if (cellComments) {
             return [
                 this.createMenuItemClickFunction('comment-remove', 'Remove Comment', this.moduleInfo.Glyph, () => {
@@ -58,13 +59,16 @@ export class CommentModule extends AdaptableModuleBase {
             return [
                 this.createMenuItemClickFunction('comment-add', 'Add Comment', this.moduleInfo.Glyph, () => {
                     // add an empty one
-                    this.api.commentApi.addCommentThread(Object.assign(Object.assign({}, cellAddress), { Comments: [] }));
+                    this.api.commentApi.addCommentThread({
+                        ...cellAddress,
+                        Comments: [],
+                    });
                     requestAnimationFrame(() => {
-                        this.api.internalApi.getCellPopupService().showPopup({
+                        this.api.internalApi.getAnnotationsService().showPopup({
                             PrimaryKeyValue: menuContext.primaryKeyValue,
                             ColumnId: menuContext.adaptableColumn.columnId,
                         }, true);
-                        this.api.internalApi.getCellPopupService().editFocusedEntity('Comment');
+                        this.api.internalApi.getAnnotationsService().editFocusedEntity('Comment');
                     });
                 }),
             ];

package/src/Strategy/CustomSortModule.d.ts CHANGED Viewed

@@ -1,10 +1,8 @@
-/// <reference types="react" />
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { CustomSort } from '../PredefinedConfig/CustomSortState';
-import * as CustomSortRedux from '../Redux/ActionsReducers/CustomSortRedux';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
-import { AdaptableObjectView, IModule } from './Interface/IModule';
+import { AdaptableModuleView, AdaptableObjectView, IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 export declare class CustomSortModule extends AdaptableModuleBase implements IModule {
@@ -18,15 +16,6 @@ export declare class CustomSortModule extends AdaptableModuleBase implements IMo
     getTeamSharingAction(): TeamSharingImportInfo<CustomSort>;
     toView(customSort: CustomSort): AdaptableObjectView;
     toViewAll(): AdaptableObjectView[];
-    getViewProperties(): {
-        getEditAction: (customSort: CustomSort) => CustomSortRedux.CustomSortEditAction;
-        getDeleteAction: (customSort: CustomSort) => CustomSortRedux.CustomSortDeleteAction;
-        getSuspendAction: (customSort: CustomSort) => CustomSortRedux.CustomSortDeleteAction;
-        getUnSuspendAction: (customSort: CustomSort) => CustomSortRedux.CustomSortDeleteAction;
-        getSuspendAllAction: () => CustomSortRedux.CustomSortSuspendAllAction;
-        getUnSuspendAllAction: () => CustomSortRedux.CustomSortUnSuspendAllAction;
-        emptyView: string;
-        getEditWizard(): (props: import("../View/CustomSort/Wizard/CustomSortWizard").CustomSortWizardProps) => JSX.Element;
-    };
+    getViewProperties(): AdaptableModuleView;
     canBeAssociatedWithLayouts(): boolean;
 }

package/src/Strategy/CustomSortModule.js CHANGED Viewed

@@ -4,7 +4,7 @@ import * as CustomSortRedux from '../Redux/ActionsReducers/CustomSortRedux';
 import { CustomSortWizard } from '../View/CustomSort/Wizard/CustomSortWizard';
 import { getCustomSortColumnViewItems } from './Utilities/CustomSort/getCustomSortColumnViewItems';
 import { getCustomSortSortOrderViewItems } from './Utilities/CustomSort/getCustomSortSortOrderViewItems';
-import { getObjectTagsViewItems } from './Utilities/getObjectTagsViewItems';
+import { getObjectTagsViewItems } from '../Utilities/getObjectTagsViewItems';
 export class CustomSortModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.CustomSortModuleId, ModuleConstants.CustomSortFriendlyName, 'import-export', 'CustomSortPopup', 'Provide bespoke sorting information for Columns (in place of alphabetical sorting)', api);

package/src/Strategy/DashboardModule.js CHANGED Viewed

@@ -15,7 +15,7 @@ export class DashboardModule extends AdaptableModuleBase {
             if (this.api.isDestroyed()) {
                 return;
             }
-            this.api.dashboardApi.internalApi.fireDashboardChangedEvent('ADAPTABLE_READY', null, this.api.dashboardApi.getDashboardState());
+            this.api.eventApi.internalApi.fireDashboardChangedEvent('ADAPTABLE_READY', null, this.api.dashboardApi.getDashboardState());
         }, 20);
     }
     createColumnMenuItems() {