@adaptabletools/adaptable 18.0.0-canary.8 → 18.0.0

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

@@ -5,18 +5,40 @@ import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../Selection/SelectedRowInfo';
 import { Column, IRowNode } from '@ag-grid-community/core';
 import { AdaptableIcon, BaseContext } from '../../types';
+export type AdaptableColumnMenuItemName = (typeof ADAPTABLE_COLUMN_MENU_ITEMS)[number];
+export type AdaptableContextMenuItemName = (typeof ADAPTABLE_CONTEXT_MENU_ITEMS)[number];
 /**
- * Menu item used by Adaptable in both Column and Context Menus
+ * List of Shipped Adaptable Column Menu Items
  */
-export interface AdaptableMenuItem {
+export declare const ADAPTABLE_COLUMN_MENU_ITEMS: readonly ["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"];
+/**
+ * List of Shipped Adaptable Context Menu Items
+ */
+export declare const ADAPTABLE_CONTEXT_MENU_ITEMS: readonly ["menu-group", "alert-clear", "bulk-update-apply", "calculated-column-edit", "cell-summary-show", "column-group", "column-filter-group", "column-filter-on-cell-value", "column-filter-clear", "column-filter-suspend", "column-filter-unsuspend", "column-info-show", "comment-add", "comment-remove", "dashboard-group", "dashboard-collapse", "dashboard-configure", "dashboard-dock", "dashboard-expand", "dashboard-float", "dashboard-hide", "dashboard-show", "data-import", "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", "grid-group", "grid-info-show", "layout-aggregated-view", "layout-auto-size", "layout-clear-selection", "layout-edit", "layout-select-all", "note-add", "note-remove", "settings-panel-open", "smart-edit-apply", "system-status-show"];
+/**
+ *  Menu item used by Adaptable in Context Menus
+ */
+export type AdaptableContextMenuItem = AdaptableMenuItem<AdaptableColumnMenuItemName>;
+/**
+ * Menu item used by Adaptable in Column Menus
+ */
+export type AdaptableColumnMenuItem = AdaptableMenuItem<AdaptableContextMenuItemName>;
+/**
+ * Generic Menu item used by Adaptable in Column or Context Menus
+ */
+export interface AdaptableMenuItem<MENU_TYPE_NAME extends AdaptableColumnMenuItemName | AdaptableContextMenuItemName = AdaptableColumnMenuItemName | AdaptableContextMenuItemName> {
     /**
-     * Name that appears in the menu
+     * Unique name for the Menu Item
+     */
+    name: MENU_TYPE_NAME;
+    /**
+     * Text that appears in the menu
      */
     label: string;
     /**
      * Adaptable Module associated with (Adaptable) menu item.
      */
-    module: AdaptableModule | 'General' | 'CustomSettingsPanel';
+    module: AdaptableModule | 'General' | 'CustomSettingsPanel' | 'Group';
     /**
      * Function to invoke when (custom) menu item is clicked
      */
@@ -137,3 +159,16 @@ export interface ContextMenuContext<TData = any> extends BaseContext {
      */
     selectedRowInfo: SelectedRowInfo<TData>;
 }
+/**
+ * Menu Item that is provided by AG Grid
+ */
+export interface AgGridMenuItem<MENU_TYPE> {
+    /**
+     * Type of Menu - always 'AgGrid'
+     */
+    menuType: 'AgGrid';
+    /**
+     * Name of the Menu Type
+     */
+    name: MENU_TYPE;
+}

package/src/PredefinedConfig/Common/Menu.js

@@ -1 +1,125 @@
-export {};
+/**
+ * List of Shipped Adaptable Column Menu Items
+ */
+export const ADAPTABLE_COLUMN_MENU_ITEMS = [
+    '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', // used in SettingsPanel navigation bar and in Dashboard Module buttons
+];
+/**
+ * List of Shipped Adaptable Context Menu Items
+ */
+export const ADAPTABLE_CONTEXT_MENU_ITEMS = [
+    'menu-group',
+    'alert-clear',
+    'bulk-update-apply',
+    'calculated-column-edit',
+    'cell-summary-show',
+    'column-group',
+    'column-filter-group',
+    'column-filter-on-cell-value',
+    'column-filter-clear',
+    'column-filter-suspend',
+    'column-filter-unsuspend',
+    'column-info-show',
+    'comment-add',
+    'comment-remove',
+    'dashboard-group',
+    'dashboard-collapse',
+    'dashboard-configure',
+    'dashboard-dock',
+    'dashboard-expand',
+    'dashboard-float',
+    'dashboard-hide',
+    'dashboard-show',
+    'data-import',
+    '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',
+    'grid-group',
+    'grid-info-show',
+    'layout-aggregated-view',
+    'layout-auto-size',
+    'layout-clear-selection',
+    'layout-edit',
+    'layout-select-all',
+    'note-add',
+    'note-remove',
+    'settings-panel-open',
+    'smart-edit-apply',
+    'system-status-show',
+];

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

@@ -0,0 +1,17 @@
+/**
+ * Defines which types of Rows to exclude when rendering Format Columns, Action Columns, Badges
+ */
+export type RowScope = {
+    /**
+     * Exclude regular data rows
+     */
+    ExcludeDataRows?: boolean;
+    /**
+     * Exclude Group Rows
+     */
+    ExcludeGroupRows?: boolean;
+    /**
+     * Exclude Summary Rows (used in Row Summaries)
+     */
+    ExcludeSummaryRows?: boolean;
+};

package/src/PredefinedConfig/Common/RowScope.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,21 @@
+export declare const ROW_SUMMARY_ROW_ID = "__ROW_SUMMARY_ROW_ID";
+export declare const WEIGHTED_AVERAGE_AGGREATED_FUNCTION = "WEIGHTED_AVERAGE";
+export declare const summarySupportedExpressions: readonly ["MIN", "MAX", "SUM", "AVG", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "OLDEST", "NEWEST", "STD_DEVIATION", "WEIGHTED_AVERAGE"];
+export type SummarySupportedExpression = (typeof summarySupportedExpressions)[number];
+/**
+ * Position of Row Summary - 'Top' or 'Bottom'
+ */
+export type RowSummaryPosition = 'Top' | 'Bottom';
+/**
+ * Defines a Row Summary used in a Layout
+ */
+export interface RowSummary {
+    /**
+     * Where Row Summary appears - 'Top' or 'Bottom'
+     */
+    Position?: RowSummaryPosition;
+    /**
+     * Map of Columns with Summary Expressions
+     */
+    ColumnsMap: Record<string, SummarySupportedExpression>;
+}

package/src/PredefinedConfig/Common/RowSummary.js

@@ -0,0 +1,17 @@
+export const ROW_SUMMARY_ROW_ID = '__ROW_SUMMARY_ROW_ID';
+export const WEIGHTED_AVERAGE_AGGREATED_FUNCTION = 'WEIGHTED_AVERAGE';
+export const summarySupportedExpressions = [
+    'MIN',
+    'MAX',
+    'SUM',
+    'AVG',
+    'COUNT',
+    'MEDIAN',
+    'MODE',
+    'DISTINCT',
+    'ONLY',
+    'OLDEST',
+    'NEWEST',
+    'STD_DEVIATION',
+    WEIGHTED_AVERAGE_AGGREATED_FUNCTION,
+];

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

@@ -0,0 +1,30 @@
+/**
+ * Config used when transposing a Grid
+ */
+export interface TransposeConfig {
+    /**
+     * Column to use to do transposition
+     * @defaultValue Primary Key Column
+     */
+    transposedColumnId?: string;
+    /**
+     * Hide the Transposed Column
+     * @defaultValue true
+     */
+    hideTransposedColumn?: boolean;
+    /**
+     * Only show curerntly visible Columns
+     * @defaultValue false
+     */
+    visibleColumns?: boolean;
+    /**
+     * Only show curerntly visible Rows
+     * @defaultValue false
+     */
+    visibleRows?: boolean;
+    /**
+     * Autosize columns in transposed view
+     * @defaultValue true
+     */
+    autosize?: boolean;
+}

package/src/PredefinedConfig/Common/TransposeConfig.js

@@ -0,0 +1 @@
+export {};

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

@@ -11,7 +11,7 @@ export declare const ALL_TOOLBARS: AdaptableDashboardToolbar[];
 /**
  * Modules which can appear in the AdapTable Status Bar
  */
-export type AdaptableStatusBarPanel = 'Alert' | 'CalculatedColumn' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'SmartEdit' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export type AdaptableStatusBarPanel = 'Alert' | 'CalculatedColumn' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'Note' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'SmartEdit' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
 export declare const ALL_STATUS_SUB_PANELS: AdaptableStatusBarPanel[];
 export type AdaptableToolPanels = AdaptableToolPanel[];
 /**
@@ -28,18 +28,18 @@ export type AdaptableModuleButtons = AdaptableModuleButton[];
 /**
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
  */
-export type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'NamedQuery' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
+export type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'NamedQuery' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'Note' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
 export type AdaptableStateKeys = AdaptableStateKey[];
 export type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFin' | 'IPushPull';
 /**
  * Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config
  */
-export type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Notes' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comments';
+export type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery';
 export declare const ALL_MODULES: AdaptableModule[];
 /**
  * Modules which can appear in the Settings Panel
  */
-export type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Notes' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comments';
+export type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comment';
 export type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/PredefinedConfig/Common/Types.js

@@ -26,6 +26,7 @@ export const ALL_STATUS_SUB_PANELS = [
     'BulkUpdate',
     'CalculatedColumn',
     'CellSummary',
+    'Comment',
     'CustomSort',
     'Charting',
     'Dashboard',
@@ -40,6 +41,7 @@ export const ALL_STATUS_SUB_PANELS = [
     'FreeTextColumn',
     'GridInfo',
     'Layout',
+    'Note',
     'PlusMinus',
     'QuickSearch',
     'Schedule',
@@ -77,7 +79,8 @@ export const ALL_MODULES = [
     ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.CalculatedColumnModuleId,
     ModuleConstants.CellSummaryModuleId,
-    ModuleConstants.NotesModuleId,
+    ModuleConstants.NoteModuleId,
+    ModuleConstants.CommentModuleId,
     ModuleConstants.ChartingModuleId,
     ModuleConstants.CustomSortModuleId,
     ModuleConstants.DashboardModuleId,

package/src/PredefinedConfig/ExportState.d.ts

@@ -1,6 +1,6 @@
 import { ConfigState } from './ConfigState';
 import { BaseSchedule } from './Common/Schedule';
-import { AdaptableScope } from './Common/AdaptableScope';
+import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableColumnBase } from './Common/AdaptableColumn';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { AdaptableFormData } from './Common/AdaptableForm';
@@ -42,7 +42,7 @@ export interface Report extends AdaptableObject {
     /**
      * Columns Scope; only required if `ReportColumnScope` is 'ScopeColumns'
      */
-    Scope?: AdaptableScope;
+    Scope?: ColumnScope;
     /**
      * Query to use; only required if `ReportRowScope` is 'ExpressionRows'
      */

package/src/PredefinedConfig/FlashingCellState.d.ts

@@ -1,6 +1,6 @@
 import { ConfigState } from './ConfigState';
 import { AdaptableStyle } from './Common/AdaptableStyle';
-import { AdaptableColumnPredicate, AdaptableScope } from '../types';
+import { AdaptableColumnPredicate, ColumnScope } from '../types';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { TypeHint } from './Common/Types';
@@ -34,7 +34,7 @@ export interface FlashingCellDefinition extends SuspendableObject {
     /**
      * Where Flashing Cell can display: Column[s] or DataType[s]
      */
-    Scope: AdaptableScope;
+    Scope: ColumnScope;
     /**
      * When Flashing Cell should be triggered
      */

package/src/PredefinedConfig/FormatColumnState.d.ts

@@ -1,7 +1,8 @@
 import { ConfigState } from './ConfigState';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { AdaptableFormat } from './Common/AdaptableFormat';
-import { AdaptableScope } from './Common/AdaptableScope';
+import { ColumnScope } from './Common/ColumnScope';
+import { RowScope } from './Common/RowScope';
 import { SuspendableObject } from './Common/SuspendableObject';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { TypeHint } from './Common/Types';
@@ -23,7 +24,7 @@ export interface FormatColumn extends SuspendableObject {
     /**
      * Where Format will be applied - whole Row, some Columns or all Columns of given DataType
      */
-    Scope: AdaptableScope;
+    Scope: ColumnScope;
     /**
      * Rule used to decide whether to apply the Format; if undefined Format is always applied
      */
@@ -41,10 +42,13 @@ export interface FormatColumn extends SuspendableObject {
      */
     CellAlignment?: 'Left' | 'Right' | 'Center';
     /**
-     * Whether to Format the Column in Grouped Rows
-     * @defaultValue false
+     * Which types of Rows should be formatted (data, grouped, summary)
      */
-    IncludeGroupedRows?: boolean;
+    RowScope?: RowScope;
+    /**
+     * @deprecated FormatColumns now apply to Group Rows by default; use RowScope for more control
+     */
+    IncludeGroupedRows?: never;
 }
 /**
  * The Format Column Rule - can be either a Predicate or a BooleanExpression

package/src/PredefinedConfig/LayoutState.d.ts

@@ -3,6 +3,7 @@ import { AdaptableObject } from './Common/AdaptableObject';
 import { ColumnSort } from './Common/ColumnSort';
 import { ColumnFilter, GridFilter } from '../types';
 import { AggregationColumns } from './Common/AggregationColumns';
+import { RowSummary } from './Common/RowSummary';
 /**
  * Predefined Configuration for the Layout Module
  */
@@ -55,7 +56,7 @@ export interface Layout extends AdaptableObject {
      */
     ExpandedRowGroupValues?: any[];
     /**
-     * Columns showing aggregated values in grouped rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc)
+     * Columns showing aggregated values in Group Rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc)
      */
     AggregationColumns?: AggregationColumns;
     /**
@@ -82,4 +83,8 @@ export interface Layout extends AdaptableObject {
      * Whether to include the aggFunc name in the column header: e.g. 'sum(Bank Balance)' will just be 'Bank Balance'
      */
     SuppressAggFuncInHeader?: boolean;
+    /**
+     * Row Summaries - Pinned Rows that display Aggregation Info for a whole column
+     */
+    RowSummaries?: RowSummary[];
 }

package/src/PredefinedConfig/{NotesState.d.ts → NoteState.d.ts}

@@ -1,9 +1,9 @@
 import { AdaptableObject } from '../types';
 import { ConfigState } from './ConfigState';
 /**
- * Predefined Configuration for Notes Module
+ * Predefined Configuration for Note Module
  */
-export interface NotesState extends ConfigState {
+export interface NoteState extends ConfigState {
     /**
      * Collection of AdapTable Notes
      */
@@ -16,9 +16,9 @@ export interface AdaptableNote extends AdaptableObject {
     /**
      * When Note was made
      */
-    Timestamp: number;
+    Timestamp?: number;
     /**
-     * Value of the Note
+     * Content of the Note
      */
     Text: string;
     /**

package/src/PredefinedConfig/NoteState.js

@@ -0,0 +1 @@
+export {};

package/src/PredefinedConfig/PlusMinusState.d.ts

@@ -1,5 +1,5 @@
 import { ConfigState } from './ConfigState';
-import { AdaptableScope } from './Common/AdaptableScope';
+import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
@@ -18,7 +18,7 @@ export interface PlusMinusNudge extends SuspendableObject {
     /**
      * Where Rule is applied
      */
-    Scope: AdaptableScope;
+    Scope: ColumnScope;
     /**
      * Amount by which to update cell when Rule is applied
      */

package/src/PredefinedConfig/PopupState.d.ts

@@ -1,4 +1,4 @@
-import { ScreenPopup, ConfirmationPopup, PromptPopup, LoadingPopup, WindowPopup, FormPopup } from '../Utilities/Interface/MessagePopups';
+import { ScreenPopup, ConfirmationPopup, PromptPopup, WindowPopup, FormPopup } from '../Utilities/Interface/MessagePopups';
 import { InternalState } from './InternalState';
 /**
  * Internal state to manage open popups - NOT persisted by Redux
@@ -9,5 +9,4 @@ export interface PopupState extends InternalState {
     FormPopup: FormPopup;
     ConfirmationPopup: ConfirmationPopup;
     PromptPopup: PromptPopup;
-    LoadingPopup: LoadingPopup;
 }

package/src/PredefinedConfig/PredefinedConfig.d.ts

@@ -17,7 +17,7 @@ import { ToolPanelState } from './ToolPanelState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
 import { StyledColumnState } from './StyledColumnState';
-import { NotesState } from './NotesState';
+import { NoteState } from './NoteState';
 import { NamedQueryState } from '../types';
 /**
  * This is the main Predefined Config interface which developers will populate at design-time
@@ -46,7 +46,7 @@ export interface PredefinedConfig {
     /**
      * Collection of personal Notes that are edited at Cell level
      */
-    Notes?: NotesState;
+    Note?: NoteState;
     /**
      * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons
      */

package/src/PredefinedConfig/Selection/GridCell.d.ts

@@ -1,5 +1,18 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { AdaptableColumn } from '../Common/AdaptableColumn';
+/**
+ * Very lightweight object to define an AdapTable Cell
+ */
+export type CellAddress = {
+    /**
+     * Value in Primary Key Column
+     */
+    PrimaryKeyValue: string | number;
+    /**
+     * Id of Column containing the Note
+     */
+    ColumnId: string;
+};
 /**
  * Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value
  */

package/src/PredefinedConfig/ShortcutState.d.ts

@@ -1,5 +1,5 @@
 import { ConfigState } from './ConfigState';
-import { AdaptableScope } from './Common/AdaptableScope';
+import { ColumnScope } from './Common/ColumnScope';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
  * Predefined Configuration for Shortcut Module
@@ -21,7 +21,7 @@ export interface Shortcut extends SuspendableObject {
     /**
      * Numeric Columns where Shortcut is applied
      */
-    Scope: AdaptableScope<ShortcutScopeDataType>;
+    Scope: ColumnScope<ShortcutScopeDataType>;
     /**
      * Key which triggers the Shortcut when pressed
      */

package/src/PredefinedConfig/StyledColumnState.d.ts

@@ -3,6 +3,7 @@ import { SuspendableObject } from './Common/SuspendableObject';
 import { SparklineOptions } from '@ag-grid-community/core';
 import { AdaptableCustomIcon, AdaptableSystemIcon, AdaptablePredicate, AdaptableStyle } from '../types';
 import { TypeHint } from './Common/Types';
+import { RowScope } from "./Common/RowScope";
 /**
  * Predefined Configuration for Styled Column Module
  */
@@ -36,11 +37,6 @@ export interface StyledColumn extends SuspendableObject {
      * Displays cell values in Column as a Badge
      */
     BadgeStyle?: BadgeStyle;
-    /**
-     * Includes Styled Column in Grouped Rows
-     * @defaultValue false
-     */
-    IncludeGroupedRows?: boolean;
 }
 /**
  * Style used to display Percent Bars in Special Column Style
@@ -190,4 +186,8 @@ export interface BadgeStyle {
      * Collection of Badge Style Definitions
      */
     Badges?: BadgeStyleDefinition[];
+    /**
+     * Which types of Rows should contain a Badge (data, grouped, summary)
+     */
+    RowScope?: RowScope;
 }

package/src/PredefinedConfig/SystemState.d.ts

@@ -1,7 +1,7 @@
 import { PreviewInfo } from '../Utilities/Interface/Preview';
 import { InternalState } from './InternalState';
 import { BulkUpdateValidationResult } from '../Strategy/Interface/IBulkUpdateModule';
-import { CellDataChangedInfo, GridCell, SmartEditOperation } from '../types';
+import { AdaptableFrameworkComponent, CellAddress, CellDataChangedInfo, CustomRenderFunction, GridCell, SmartEditOperation } from '../types';
 import type { IPushPullState, IPushPullReport, IPushPullDomain } from './IPushPullState';
 import { OpenFinState, OpenFinReport } from './OpenFinState';
 import { AdaptableAlert } from './Common/AdaptableAlert';
@@ -12,7 +12,6 @@ import { AdaptableFlashingCell } from './Common/AdaptableFlashingCell';
 import { TypeUuid } from './Uuid';
 import { SummaryOperation } from './Common/Enums';
 import { ChartModel } from '@ag-grid-community/core';
-import { CellAddress } from './CellAddress';
 import { ExternalChartDefinition } from './ChartingState';
 import { CachedQuery } from './NamedQueryState';
 export type { IPushPullReport, IPushPullDomain };
@@ -20,6 +19,10 @@ export type { OpenFinReport };
 type ROW_PRIMARY_KEY = string;
 type COLUMN_ID_OR_WHOLE_ROW_LABEL = string;
 export type DataChangeHistoryMode = 'ACTIVE' | 'INACTIVE' | 'SUSPENDED';
+export type SystemRowSummary = {
+    Position: 'Top' | 'Bottom';
+    RowData: Record<string, any>;
+};
 /**
  * Internal state, used by Adaptable during a session; none of it is provided through Predefined Config, nor is it persisted
  */
@@ -93,7 +96,7 @@ export interface SystemState extends InternalState, IPushPullState, OpenFinState
      */
     DisableDeleteConfirmation: boolean;
     Export: {
-        inProgressVisualData: boolean;
+        visualDataExportInProgress: boolean;
     };
     QuickSearch?: {
         floatingVisible?: boolean;
@@ -103,8 +106,13 @@ export interface SystemState extends InternalState, IPushPullState, OpenFinState
         focusedEntity?: 'Note' | 'Comment';
         popupPosition?: CellAddress | null;
     };
+    RowSummary?: {
+        rowSummaries?: SystemRowSummary[];
+    };
 }
 export interface ProgressIndicator {
     active: boolean;
-    label: string;
+    text?: string;
+    render?: CustomRenderFunction;
+    frameworkComponent?: AdaptableFrameworkComponent;
 }