@adaptabletools/adaptable-cjs 20.2.11 → 20.3.0-canary.1

package/src/AdaptableState/Common/RowScope.d.ts

@@ -14,4 +14,8 @@ export interface RowScope {
      * Exclude Summary Rows (used in Row Summaries)
      */
     ExcludeSummaryRows?: boolean;
+    /**
+     * Exclude Grand Total Rows
+     */
+    ExcludeTotalRows?: boolean;
 }

package/src/AdaptableState/FormatColumnState.d.ts

@@ -25,6 +25,12 @@ export interface FormatColumn extends SuspendableObject {
      * Where Format will be applied: whole Row, some Columns, or Columns of DataType
      */
     Scope: ColumnScope;
+    /**
+     * Which part of the Column to apply Format to: `cell`, `column header`
+     *
+     * @defaultValue ['cell']
+     */
+    Target?: FormatColumnTarget[];
     /**
      * Rule to decide whether to apply Format; if undefined Format is always applied
      */
@@ -51,6 +57,10 @@ export interface FormatColumn extends SuspendableObject {
      */
     ColumnGroupScope?: ColumnGroupScope;
 }
+/**
+ * Target for Format Column: Specifies which visual elements of the column receive formatting
+ */
+export type FormatColumnTarget = 'cell' | 'columnHeader';
 /**
  * Defines Column Group Scope
  */

package/src/AdaptableState/StyledColumnState.d.ts

@@ -178,6 +178,10 @@ export interface BadgeStyleDefinition {
      * Position of Icon in the Badge - 'Start' or 'End'
      */
     IconPosition?: 'Start' | 'End';
+    /**
+     * Only show an Icon and no Cell text
+     */
+    IconOnly?: boolean;
 }
 /**
  * Collection of Badge Style Definitions to display in a Badge Styled Column

package/src/Api/ColumnApi.d.ts

@@ -323,4 +323,10 @@ export interface ColumnApi {
      * @param columnId Column to use
      */
     getAGGridColumnForColumnId(columnId: string): Column;
+    /**
+     * Checks if the Column with given Column Identifier (columnId or ColDef) has a specific Column Type
+     * @param columnIdentifier - ColumnId or ColDef to check
+     * @param columnType - Column Type to check for
+     */
+    hasColumnType(columnIdentifier: string | ColDef, columnType: string): boolean;
 }

package/src/Api/GridApi.d.ts

@@ -382,9 +382,14 @@ export interface GridApi {
      */
     isGroupRowNode(rowNode: IRowNode): boolean;
     /**
-  * Whether given Row Node is visible
-  * @param rowNode Node to check
-  */
+     * Whether given Row Node is a Grand Total Row
+     * @param rowNode Node to check
+     */
+    isGrandTotalRowNode(rowNode: IRowNode): boolean;
+    /**
+     * Whether given Row Node is visible
+     * @param rowNode Node to check
+     */
     isVisibleRowNode(rowNode: IRowNode): boolean;
     /**
      * Whether given Row Node is in a Summary Row

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

@@ -78,10 +78,11 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getPrimaryKeyColumn(): AdaptableColumn<any>;
     getDefaultAggFunc(columnId: string): string;
     openColumnInfoSettingsPanel(): void;
-    getColumnTypes(): string[];
+    getColumnTypes(): import("../../AdaptableState/Common/Types").TypeHint<string, import("../../types").AdaptableColumnType>[];
     getColumnsByColumnType(columnType: string): AdaptableColumn[];
     getRowGroupedColumns(): AdaptableColumn[];
     setColumnCaption(columnId: string, caption: string): void;
     getAGGridColDefForColumnId(columnId: string): ColDef | ColGroupDef;
     getAGGridColumnForColumnId(columnId: string): Column;
+    hasColumnType(columnIdentifier: string | ColDef, columnType: string): boolean;
 }

package/src/Api/Implementation/ColumnApiImpl.js

@@ -510,5 +510,22 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     getAGGridColumnForColumnId(columnId) {
         return this.getAgGridApi().getColumn(columnId);
     }
+    hasColumnType(columnIdentifier, columnType) {
+        if (!columnIdentifier) {
+            return false;
+        }
+        const colDef = typeof columnIdentifier === 'string'
+            ? this.getAgGridApi().getColumnDef(columnIdentifier)
+            : columnIdentifier;
+        if (!colDef?.type) {
+            return false;
+        }
+        if (Array.isArray(colDef.type)) {
+            return colDef.type.includes(columnType);
+        }
+        else {
+            return colDef.type === columnType;
+        }
+    }
 }
 exports.ColumnApiImpl = ColumnApiImpl;

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

@@ -99,6 +99,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     isMasterDetailGrid(): boolean;
     isTreeDataGrid(): boolean;
     isGroupRowNode(rowNode: IRowNode): boolean;
+    isGrandTotalRowNode(rowNode: IRowNode): boolean;
     isVisibleRowNode(rowNode: IRowNode): boolean;
     isSummaryNode(rowNode: IRowNode): boolean;
     isQuickFilterAvailable(): boolean;

package/src/Api/Implementation/GridApiImpl.js

@@ -386,6 +386,9 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     isGroupRowNode(rowNode) {
         return this._adaptable.isGroupRowNode(rowNode);
     }
+    isGrandTotalRowNode(rowNode) {
+        return this._adaptable.isGrandTotalRowNode(rowNode);
+    }
     isVisibleRowNode(rowNode) {
         return this._adaptable.isRowNodeVisible(rowNode);
     }

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

@@ -9,7 +9,7 @@ export declare class PredicateApiImpl extends ApiBase implements PredicateApi {
     getPredicateDefs(): AdaptablePredicateDef<string>[];
     getSystemPredicateDefs(): AdaptablePredicateDef<string>[];
     getSystemPredicateDefsByModuleScope<PREDICATE_TYPE extends string = string>(moduleScope: PredicateModuleScope): AdaptablePredicateDef<PREDICATE_TYPE>[];
-    getCustomPredicateDefs(): AdaptablePredicateDef<string>[];
+    getCustomPredicateDefs(): AdaptablePredicateDef[];
     getPredicateDefsByModuleScope(moduleScope: PredicateModuleScope): AdaptablePredicateDef[];
     getPredicateDefById(predicateId: string): AdaptablePredicateDef;
     getSystemPredicateDefById(predicateId: string): AdaptablePredicateDef;

package/src/Api/Implementation/PredicateApiImpl.js

@@ -22,7 +22,31 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
         return AdaptablePredicate_1.SystemPredicateDefs.filter((p) => p.moduleScope.includes(moduleScope));
     }
     getCustomPredicateDefs() {
-        return this.getPredicateOptions().customPredicateDefs;
+        const predicateDefsMap = new Map(this.getSystemPredicateDefs().map((p) => [p.id, p]));
+        const customPredicateDefs = this.getPredicateOptions().customPredicateDefs || [];
+        return customPredicateDefs
+            .map((p) => {
+            if ('extends' in p) {
+                const foundPredicateDef = predicateDefsMap.get(p.extends);
+                if (!foundPredicateDef) {
+                    this.logWarn(`Custom predicate with ID '${p.id}' references a missing 'extends' target '${p.extends}'. No such system or custom predicate found.`);
+                    return null;
+                }
+                else {
+                    const { extends: _, ...rest } = p;
+                    const result = {
+                        ...foundPredicateDef,
+                        ...rest,
+                        id: rest.id,
+                    };
+                    predicateDefsMap.set(result.id, result);
+                    return result;
+                }
+            }
+            predicateDefsMap.set(p.id, p);
+            return p;
+        })
+            .filter((p) => p !== null);
     }
     getPredicateDefsByModuleScope(moduleScope) {
         return this.getPredicateDefs().filter((p) => p.moduleScope.includes(moduleScope));

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

@@ -17,7 +17,9 @@ export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfa
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
     getAdaptableObjectsWithTag(tag: AdaptableObjectTag, adaptableModule?: AdaptableModule): AdaptableObject[] | undefined;
     getCustomIconDefinition(iconName: string): import("../../types").AdaptableIcon | import("../../types").CustomIcon;
-    showProgressIndicator(config: ProgressIndicatorConfig): void;
+    showProgressIndicator(config: ProgressIndicatorConfig): {
+        close: () => void;
+    };
     hideProgressIndicator(): void;
     openCustomWindowPopup(config: CustomWindowConfig): {
         close: () => void;

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -87,6 +87,9 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         return customIcon;
     }
     showProgressIndicator(config) {
+        const close = () => {
+            this.hideProgressIndicator();
+        };
         if (config.delay) {
             this.showProgressIndicatorTimeout = setTimeout(() => {
                 this.dispatchAction((0, PopupRedux_1.ProgressIndicatorShow)(config));
@@ -95,6 +98,7 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         else {
             this.dispatchAction((0, PopupRedux_1.ProgressIndicatorShow)(config));
         }
+        return { close };
     }
     hideProgressIndicator() {
         if (this.showProgressIndicatorTimeout) {
@@ -115,6 +119,8 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
                 render: config.render,
                 frameworkComponent: config.frameworkComponent,
                 onFrameworkComponentDestroyed: config.onFrameworkComponentDestroyed,
+                size: config.size,
+                position: config.position,
             },
             Icon: config.icon,
         });

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

@@ -1,5 +1,5 @@
 import { ApiBase } from '../Implementation/ApiBase';
-import { Column, HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
+import { ColDef, Column, HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
 import { CustomSort } from '../../AdaptableState/CustomSortState';
 import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
 import { AdaptableColumn } from '../../types';
@@ -33,5 +33,7 @@ export declare class ColumnInternalApi extends ApiBase {
     isSpecialColumn(columnId: string, column?: AdaptableColumn): boolean;
     getColumnHeaderName(params: HeaderValueGetterParams): string;
     private buildColumnHeaderContext;
+    hasArrayDataType(column: AdaptableColumn): boolean;
     getQueryableColumnsForUIEditor(): AdaptableColumn[];
+    isAlwaysHiddenColumn(columnIdentifier: string | ColDef): boolean;
 }

package/src/Api/Internal/ColumnInternalApi.js

@@ -10,6 +10,7 @@ const ColumnApiImpl_1 = require("../Implementation/ColumnApiImpl");
 const destructurePivotColumnId_1 = require("../../layout-manager/src/destructurePivotColumnId");
 const isPivotColumnTotal_1 = require("../../layout-manager/src/isPivotColumnTotal");
 const isPivotAggTotalColumn_1 = require("../../layout-manager/src/isPivotAggTotalColumn");
+const AdaptableColumn_1 = require("../../AdaptableState/Common/AdaptableColumn");
 function getAutoRowGroupColumnIdFor(columnId) {
     return `${GeneralConstants_1.AG_GRID_GROUPED_COLUMN}-${columnId}`;
 }
@@ -287,10 +288,16 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
         // if nothing matched, we skip this column[group]
         return 'skip';
     }
+    hasArrayDataType(column) {
+        return ['textArray', 'numberArray', 'tupleArray', 'objectArray'].includes(column.dataType);
+    }
     getQueryableColumnsForUIEditor() {
         return this.getColumnApi()
             .getQueryableColumns()
             .filter((column) => !column.isGeneratedPivotResultColumn && !column.isGeneratedRowGroupColumn);
     }
+    isAlwaysHiddenColumn(columnIdentifier) {
+        return this.getColumnApi().hasColumnType(columnIdentifier, AdaptableColumn_1.HIDDEN_COLUMN_TYPE);
+    }
 }
 exports.ColumnInternalApi = ColumnInternalApi;

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

@@ -1,5 +1,5 @@
 import { IRowNode } from 'ag-grid-enterprise';
-import { AdaptableColumn, AdaptableFormat, AdaptablePredicateDef, ColumnScope, FormatColumn, StringFormatterOptions } from '../../types';
+import { AdaptableColumn, AdaptableFormat, AdaptablePredicateDef, ColumnScope, FormatColumn, FormatColumnTarget, StringFormatterOptions } from '../../types';
 import { ApiBase } from '../Implementation/ApiBase';
 export declare class FormatColumnInternalApi extends ApiBase {
     /**
@@ -28,7 +28,8 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param config
      * @returns list of FormatColumn
      */
-    getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config?: {
+    getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config: {
+        target: FormatColumnTarget;
         includeSuspended?: boolean;
     }): FormatColumn[];
     /**
@@ -36,8 +37,9 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param column The Column for which to retrieve the Format Column
      * @returns format columns
      */
-    getFormatColumnWithStyleClassNameForColumn(column: AdaptableColumn, config?: {
+    getFormatColumnWithStyleClassNameForColumn(column: AdaptableColumn, config: {
         includeSuspended?: boolean;
+        target: FormatColumnTarget;
     }): FormatColumn[];
     getFormatColumnWithColumnInScope(formatColumns: FormatColumn[], column: AdaptableColumn): FormatColumn[];
     private getFormatColumnInColumnScope;
@@ -85,7 +87,14 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param column
      * @param params
      */
-    formatColumnShouldRender(formatColumn: FormatColumn, column: AdaptableColumn, rowNode: IRowNode, cellValue: any): boolean;
+    formatColumnShouldRenderInCell(formatColumn: FormatColumn, column: AdaptableColumn, rowNode: IRowNode, cellValue: any): boolean;
+    /**
+     * Checks if format column is relevant for a given Column Header
+     *
+     * @param formatColumn
+     * @param column
+     */
+    formatColumnShouldRenderInHeader(formatColumn: FormatColumn, column: AdaptableColumn): boolean;
     private evaluatePredicate;
     private evaluateExpression;
     /**

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -79,7 +79,13 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @returns list of FormatColumn
      */
     getFormatColumnsWithStyleForColumn(column, config) {
-        const formatColumns = this.getAllFormatColumnWithStyleAndCellAlignment().filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
+        const formatColumns = this.getAllFormatColumnWithStyleAndCellAlignment()
+            .filter((formatColumn) => {
+            // FormatColumn default target is 'cell', so if no target is specified, we assume 'cell'
+            const fcTarget = formatColumn.Target ?? ['cell'];
+            return fcTarget.includes(config.target);
+        })
+            .filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
         return this.getFormatColumnWithColumnInScope(formatColumns, column);
     }
     /**
@@ -214,15 +220,20 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @param column
      * @param params
      */
-    formatColumnShouldRender(formatColumn, column, rowNode, cellValue) {
+    formatColumnShouldRenderInCell(formatColumn, column, rowNode, cellValue) {
         // suspended is important to be first
         if (formatColumn.IsSuspended) {
             return false;
         }
         const isSummaryNode = this.getGridApi().isSummaryNode(rowNode);
         const isGroupedRowNode = this.getGridApi().isGroupRowNode(rowNode);
-        // For Summary Rows cannot be excluded
-        if (isSummaryNode) {
+        const isGrandTotalRowNode = this.getGridApi().isGrandTotalRowNode(rowNode);
+        if (isGrandTotalRowNode) {
+            if (formatColumn.RowScope?.ExcludeTotalRows) {
+                return false;
+            }
+        }
+        else if (isSummaryNode) {
             if (formatColumn.RowScope?.ExcludeSummaryRows) {
                 return false;
             }
@@ -262,6 +273,22 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         // nothing has passed then return false
         return false;
     }
+    /**
+     * Checks if format column is relevant for a given Column Header
+     *
+     * @param formatColumn
+     * @param column
+     */
+    formatColumnShouldRenderInHeader(formatColumn, column) {
+        if (formatColumn.IsSuspended) {
+            return false;
+        }
+        if (formatColumn.ColumnGroupScope &&
+            !this.getFormatColumnApi().internalApi.formatColumnWithColumnGroupScopeShouldRender(formatColumn, column)) {
+            return false;
+        }
+        return true;
+    }
     evaluatePredicate(formatColumn, predicateDefHandlerContext) {
         return this.getPredicateApi().handleColumnPredicates(formatColumn.Rule?.Predicates, predicateDefHandlerContext, false);
     }
@@ -286,7 +313,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @param params
      */
     getFormatColumnsRelevantForColumn(formatColumns, column, params) {
-        return formatColumns.filter((formatColumn) => this.formatColumnShouldRender(formatColumn, column, params.node, params.value));
+        return formatColumns.filter((formatColumn) => this.formatColumnShouldRenderInCell(formatColumn, column, params.node, params.value));
     }
     /**
      * Extract from the given FormatColumns the one which is the most relevant  for a given cell (intersection of given AdaptableColumn and RowNode)
@@ -296,7 +323,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @param params
      */
     getMostRelevantFormatColumnForColumn(formatColumns, column, params) {
-        return formatColumns.find((formatColumn) => this.formatColumnShouldRender(formatColumn, column, params.node, params.value));
+        return formatColumns.find((formatColumn) => this.formatColumnShouldRenderInCell(formatColumn, column, params.node, params.value));
     }
     /**
      * Retrieves all Format Columns which have an Expression

package/src/Api/UserInterfaceApi.d.ts

@@ -46,17 +46,29 @@ export interface UserInterfaceApi {
      * Displays a progress indicator
      * @param config.progressText - text to display in the progress indicator
      * @param config.render - render function for a custom progress indicator (if not using a framework component)
-     * @param config.frameworkComponent - the framework (React/Angular) component to render as progress indicator
+     * @param config.frameworkComponent - the framework (React/Angular/Vue) component to render as progress indicator
+     * @param config.renderMode - how to render the custom component ('content' or 'dialog'). Applies to both render and frameworkComponent.
      * @param config.delay - delay before showing the progress indicator (in milliseconds)
+     * @returns An object with a close method to close the window
      */
-    showProgressIndicator(config: ProgressIndicatorConfig): void;
+    showProgressIndicator(config: ProgressIndicatorConfig): {
+        close: () => void;
+    };
     /**
      * Hides the progress indicator
      */
     hideProgressIndicator(): void;
     /**
-     * Opens window with custom content
-     * @param config
+     * Opens a custom window popup
+     * @param config - The configuration for the custom window
+     * @param config.id - Unique identifier for the custom window
+     * @param config.title - Title of the custom window
+     * @param config.icon - Icon to display in the custom window heading
+     * @param config.render - Render function to display custom content in the window (if not using a framework component)
+     * @param config.frameworkComponent - A React, Angular or Vue Framework component to use for the custom window content
+     * @param config.onFrameworkComponentDestroyed - Callback function to be called when the framework component is destroyed
+     * @param config.renderMode - How to render the custom component ('content' or 'dialog'). Applies to both render and frameworkComponent.
+     * @returns An object with a close method to close the window
      */
     openCustomWindowPopup(config: CustomWindowConfig): {
         close: () => void;

package/src/Redux/ActionsReducers/LayoutRedux.d.ts

@@ -169,12 +169,16 @@ export declare const getColumnFilterSelector: (state: AdaptableState, columnId:
     PredicatesOperator?: import("../../types").PredicatesOperator;
     IsSuspended?: boolean;
     Uuid?: string;
+    /**
+     * @ReduxAction Layout Module is ready
+     */
     Source?: "InitialState" | "User";
+    /**
+     * @ReduxAction A Layout has been edited
+     */
     AdaptableVersion?: `${string}.${string}.${string}`;
     IsReadOnly?: boolean;
     Tags?: string[];
-    Metadata?: any; /**
-     * @ReduxAction A Column Filter has been edited
-     */
+    Metadata?: any;
 };
 export declare const LayoutReducer: Redux.Reducer<LayoutState>;

package/src/Redux/ActionsReducers/PopupRedux.js

@@ -337,6 +337,7 @@ const PopupReducer = (state = initialState, action) => {
                     text: actionTypedAdd.progressIndicatorConfig.text,
                     render: actionTypedAdd.progressIndicatorConfig.render,
                     frameworkComponent: actionTypedAdd.progressIndicatorConfig.frameworkComponent,
+                    renderMode: actionTypedAdd.progressIndicatorConfig.renderMode,
                 },
             };
             return Object.assign({}, state, updatedState);

package/src/Strategy/StyledColumnModule.js

@@ -10,6 +10,7 @@ const StyledColumnWizardStyleSection_1 = require("../View/StyledColumn/Wizard/St
 const ObjectFactory_1 = tslib_1.__importDefault(require("../Utilities/ObjectFactory"));
 const StyledColumnBadgePreview_1 = require("../View/StyledColumn/Wizard/StyledColumnWizardStyleSection/Components/StyledColumnBadgePreview");
 const getObjectTagsViewItems_1 = require("../Utilities/getObjectTagsViewItems");
+const StyledColumnBadgeSettings_1 = require("../View/StyledColumn/Wizard/StyledColumnWizardStyleSection/Components/StyledColumnBadgeSettings");
 class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.StyledColumnModuleId, ModuleConstants.StyledColumnFriendlyName, 'brush', 'StyledColumnPopup', // to change
@@ -147,9 +148,8 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                             returnColumnMenuItems.push(...[newGrandientButton, newPercentBarButton, newBadgeButton]);
                             break;
                         case 'text':
-                            returnColumnMenuItems.push(newBadgeButton);
-                            break;
                         case 'textArray':
+                        case 'numberArray':
                             returnColumnMenuItems.push(newBadgeButton);
                             break;
                     }
@@ -192,15 +192,20 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         if (styledColumn.BadgeStyle) {
             specificTypeItems.push({
-                name: 'Settings',
+                name: 'Rows',
                 values: [
                     `Data Rows: ${styledColumn.BadgeStyle?.RowScope?.ExcludeDataRows ? 'No' : 'Yes'}`,
                     `Group Rows: ${styledColumn.BadgeStyle?.RowScope?.ExcludeGroupRows ? 'No' : 'Yes'}`,
                     `Summary Rows: ${styledColumn.BadgeStyle?.RowScope?.ExcludeSummaryRows ? 'No' : 'Yes'}`,
+                    `Total Rows: ${styledColumn.BadgeStyle?.RowScope?.ExcludeTotalRows ? 'No' : 'Yes'}`,
                 ],
             });
         }
         if (styledColumn.BadgeStyle) {
+            specificTypeItems.push({
+                name: 'Settings',
+                view: StyledColumnBadgeSettings_1.StyledColumnBadgeSettings,
+            });
             specificTypeItems.push({
                 name: 'Preview',
                 view: StyledColumnBadgePreview_1.StyledColumnBadgePreview,

package/src/Strategy/Utilities/FormatColumn/getFormatColumnSettingsViewItems.js

@@ -16,6 +16,12 @@ const getFormatColumnSettingsViewItems = (formatColumn) => {
         if (formatColumn.RowScope.ExcludeSummaryRows) {
             values.push('Exclude Summary Rows');
         }
+        if (formatColumn.RowScope.ExcludeTotalRows) {
+            values.push('Exclude Total Rows');
+        }
+    }
+    if (formatColumn.ColumnGroupScope) {
+        values.push(`Column Groups: ${formatColumn.ColumnGroupScope === 'Both' ? 'Always' : formatColumn.ColumnGroupScope}`);
     }
     return {
         name: 'Settings',

package/src/Utilities/Constants/GeneralConstants.d.ts

@@ -26,6 +26,7 @@ export declare const AG_GRID_SELECTION_COLUMN: string;
 export declare const AG_GRID_PIVOT_COLUMN: string;
 export declare const AG_GRID_PIVOT_GRAND_TOTAL_COLUMN: string;
 export declare const AG_GRID_CHART_WINDOW = "AG Grid Window";
+export declare const AG_GRID_GRAND_TOTAL_ROW_ID = "rowGroupFooter_ROOT_NODE_ID";
 export declare const ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = "(FDC3ActionColumn)";
 export declare const DEFAULT_DATE_FORMAT_PATTERN = "dd-MM-yyyy";
 export declare const DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = "dd-MM-yyyy HH:mm:ss";

package/src/Utilities/Constants/GeneralConstants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LAYOUT_NEW_TABLE_TOOLTIP = exports.THEME_STYLE = exports.SYSTEM_EXPORT_DESTINATIONS = exports.CLIPBOARD_EXPORT_DESTINATION = exports.DOWNLOAD_EXPORT_DESTINATION = exports.SELECT_REPORT_FORMAT_STRING = exports.SELECT_REPORT_STRING = exports.SYSTEM_REPORT_FORMATS = exports.JSON_FORMAT_REPORT = exports.CSV_FORMAT_REPORT = exports.VISUAL_EXCEL_FORMAT_REPORT = exports.EXCEL_FORMAT_REPORT = exports.SYSTEM_REPORT_NAMES = exports.SELECTED_DATA_REPORT = exports.CURRENT_LAYOUT_REPORT = exports.ALL_DATA_REPORT = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.MENU_SEPARATOR = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_SELECTION_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.QUARTER_SECOND = exports.HALF_SECOND = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.READ_ONLY_STYLE = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE_ID = exports.ADAPTABLE = exports.ERROR_LAYOUT = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
-exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = exports.OBSERVABLE_EXPRESSION_ROW_ADDED = exports.STANDALONE_MODULE_POPUPS = exports.LAYOUT_DELETE_TOOLTIP = exports.LAYOUT_CLONE_TOOLTIP = exports.LAYOUT_EDIT_TOOLTIP = exports.LAYOUT_SAVE_TOOLTIP = exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = exports.LAYOUT_NEW_PIVOT_TOOLTIP = void 0;
+exports.THEME_STYLE = exports.SYSTEM_EXPORT_DESTINATIONS = exports.CLIPBOARD_EXPORT_DESTINATION = exports.DOWNLOAD_EXPORT_DESTINATION = exports.SELECT_REPORT_FORMAT_STRING = exports.SELECT_REPORT_STRING = exports.SYSTEM_REPORT_FORMATS = exports.JSON_FORMAT_REPORT = exports.CSV_FORMAT_REPORT = exports.VISUAL_EXCEL_FORMAT_REPORT = exports.EXCEL_FORMAT_REPORT = exports.SYSTEM_REPORT_NAMES = exports.SELECTED_DATA_REPORT = exports.CURRENT_LAYOUT_REPORT = exports.ALL_DATA_REPORT = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.MENU_SEPARATOR = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.AG_GRID_GRAND_TOTAL_ROW_ID = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_SELECTION_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.QUARTER_SECOND = exports.HALF_SECOND = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.READ_ONLY_STYLE = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE_ID = exports.ADAPTABLE = exports.ERROR_LAYOUT = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
+exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = exports.OBSERVABLE_EXPRESSION_ROW_ADDED = exports.STANDALONE_MODULE_POPUPS = exports.LAYOUT_DELETE_TOOLTIP = exports.LAYOUT_CLONE_TOOLTIP = exports.LAYOUT_EDIT_TOOLTIP = exports.LAYOUT_SAVE_TOOLTIP = exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = exports.LAYOUT_NEW_PIVOT_TOOLTIP = exports.LAYOUT_NEW_TABLE_TOOLTIP = void 0;
 const normalizeLayoutModel_1 = require("../../layout-manager/src/normalizeLayoutModel");
 exports.AUTOGENERATED_PK_COLUMN = '__ADAPTABLE_PK__';
 exports.MISSING_COLUMN = ' [MISSING]';
@@ -30,6 +30,7 @@ exports.AG_GRID_SELECTION_COLUMN = 'ag-Grid-SelectionColumn';
 exports.AG_GRID_PIVOT_COLUMN = 'pivot_';
 exports.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN = 'PivotRowTotal_pivot_';
 exports.AG_GRID_CHART_WINDOW = 'AG Grid Window';
+exports.AG_GRID_GRAND_TOTAL_ROW_ID = 'rowGroupFooter_ROOT_NODE_ID';
 exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = '(FDC3ActionColumn)';
 // FIXME AFL - load this from DateInputOptions
 exports.DEFAULT_DATE_FORMAT_PATTERN = 'dd-MM-yyyy';

package/src/Utilities/Helpers/FormatHelper.js

@@ -64,6 +64,9 @@ function NumberFormatter(input, options = {}, rowNode, column, api) {
     if (options.Floor) {
         n = Math.floor(n);
     }
+    if (options.Empty) {
+        return ' ';
+    }
     let s;
     let digitsToUse;
     if (options.Truncate || options.Ceiling || options.Round || options.Floor) {

package/src/Utilities/Services/ModuleService.js

@@ -107,7 +107,7 @@ class ModuleService {
             case 'ColumnFilter':
                 return learnUrl + 'handbook-column-filter';
             case 'ColumnInfo':
-                return learnUrl + 'dev-guide-tutorial-grid-column-info';
+                return learnUrl + 'dev-guide-column-grid-column-info';
             case 'Comment':
                 return learnUrl + 'handbook-comments';
             case 'CustomSort':
@@ -133,7 +133,7 @@ class ModuleService {
             case 'GridFilter':
                 return learnUrl + 'handbook-grid-filter';
             case 'GridInfo':
-                return learnUrl + 'dev-guide-tutorial-grid-column-info';
+                return learnUrl + 'dev-guide-column-grid-column-info';
             case 'Layout':
                 return learnUrl + 'handbook-layouts';
             case 'NamedQuery':

package/src/Utilities/getScopeViewItems.js

@@ -17,7 +17,7 @@ const getScopeViewItems = (scope, api) => {
         values = scope.ColumnTypes;
     }
     return {
-        label: 'Target',
+        label: 'Scope & Target',
         name: 'Target',
         values,
     };

package/src/View/Components/ColumnFilter/utils.js

@@ -18,10 +18,15 @@ dataType) => {
     const inputs = (adaptablePredicateDef?.inputs ?? [])?.map((input) => {
         return input.type;
     });
-    if ((adaptablePredicateDef.id === 'In' || adaptablePredicateDef.id === 'NotIn') &&
-        ['text', 'number', 'date'].includes(dataType)) {
-        // add array type
-        inputs.push(`${dataType}[]`);
+    if (adaptablePredicateDef.id === 'In' || adaptablePredicateDef.id === 'NotIn') {
+        if (['text', 'number', 'date'].includes(dataType)) {
+            // add array type
+            inputs.push(`${dataType}[]`);
+        }
+        if (['text[]', 'number[]'].includes(dataType)) {
+            // add array type
+            inputs.push(dataType);
+        }
     }
     const qlPredicateDef = {
         operator: adaptablePredicateDef.id,

package/src/View/Components/Popups/AdaptablePopupConfirmation.js

@@ -57,9 +57,8 @@ const AdaptablePopupConfirmation = (props) => {
                 props.showInputBox && (React.createElement(rebass_1.Box, { padding: 2, "data-name": "body" },
                     React.createElement("p", null, "Please enter a comment to confirm"),
                     React.createElement(Input_1.default, { marginTop: 2, width: '100%', value: promptText, type: "string", placeholder: "Enter text", onChange: (e) => changeContent(e) }))),
-                React.createElement(rebass_1.Flex, { marginTop: 3, padding: 2, "data-name": "footer" },
-                    React.createElement(SimpleButton_1.default, { tone: "error", "data-name": "delete", variant: "raised", disabled: !canConfirm(), onClick: () => onConfirmmForm() }, props.confirmButtonText),
-                    React.createElement("div", { style: { flex: 1 } }),
-                    props.cancelButtonText != null ? (React.createElement(SimpleButton_1.default, { "data-name": "cancel", tone: "neutral", variant: "raised", onClick: () => onCancelForm() }, props.cancelButtonText)) : null)))));
+                React.createElement(rebass_1.Flex, { marginTop: 3, padding: 2, "data-name": "footer", justifyContent: "space-between" },
+                    props.cancelButtonText != null ? (React.createElement(SimpleButton_1.default, { "data-name": "cancel", tone: "neutral", variant: "raised", onClick: () => onCancelForm() }, props.cancelButtonText)) : (React.createElement("div", null)),
+                    React.createElement(SimpleButton_1.default, { tone: "error", "data-name": "delete", variant: "raised", disabled: !canConfirm(), onClick: () => onConfirmmForm() }, props.confirmButtonText))))));
 };
 exports.AdaptablePopupConfirmation = AdaptablePopupConfirmation;

package/src/View/Components/Popups/AdaptablePopupPrompt.js

@@ -40,9 +40,8 @@ const AdaptablePopupPrompt = (props) => {
                 })))),
             React.createElement(Input_1.default, { autoFocus: true, marginTop: 3, mx: 3, value: promptText, type: "string", placeholder: "Enter text", onChange: (e) => changeContent(e) }),
             React.createElement(rebass_1.Box, { marginTop: 3 },
-                React.createElement(rebass_1.Flex, { padding: 2 },
-                    React.createElement(SimpleButton_1.default, { tone: "accent", "data-name": "ok", variant: "raised", disabled: StringExtensions_1.StringExtensions.IsNullOrEmpty(promptText), onClick: () => onConfirmForm() }, "OK"),
-                    React.createElement("div", { style: { flex: 1 } }),
-                    React.createElement(SimpleButton_1.default, { tone: "neutral", variant: "raised", onClick: () => onCloseForm(), "data-name": "cancel" }, "Cancel"))))));
+                React.createElement(rebass_1.Flex, { padding: 2, "data-name": "footer", justifyContent: "space-between" },
+                    React.createElement(SimpleButton_1.default, { tone: "neutral", variant: "raised", onClick: () => onCloseForm(), "data-name": "cancel" }, "Cancel"),
+                    React.createElement(SimpleButton_1.default, { tone: "accent", "data-name": "ok", variant: "raised", disabled: StringExtensions_1.StringExtensions.IsNullOrEmpty(promptText), onClick: () => onConfirmForm() }, "OK"))))));
 };
 exports.AdaptablePopupPrompt = AdaptablePopupPrompt;