@adaptabletools/adaptable 18.0.0-canary.2 → 18.0.0-canary.21

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -23,7 +23,7 @@ import { FlashingCellState } from './FlashingCellState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
 import { StyledColumnState } from './StyledColumnState';
-import { NotesState } from './NotesState';
+import { NoteState } from './NoteState';
 import { NamedQueryState } from './NamedQueryState';
 import { CommentState } from './CommentState';
 /**
@@ -57,7 +57,7 @@ export interface AdaptablePersistentState {
     Theme: ThemeState;
     ToolPanel: ToolPanelState;
     Charting: ChartingState;
-    Notes: NotesState;
+    Note: NoteState;
     /**
      * @deprecated
      */

package/src/PredefinedConfig/CommentState.d.ts

@@ -1,19 +1,33 @@
-import { AdaptableObject } from '../types';
-import { ConfigState } from './ConfigState';
+import { CellAddress } from '../types';
+import { InternalState } from './InternalState';
+import { TypeUuid } from './Uuid';
 /**
- * Note that can be applied to a Cell in AdapTable
+ * Internal State used for Comments Module
  */
-export interface AdaptableComment extends AdaptableObject {
+export interface CommentState extends InternalState {
     /**
-     * When Note was made
+     * Collection of AdapTable Comments
+     */
+    CommentThreads?: CommentThread[];
+}
+/**
+ * Comment that can be applied to a Cell in AdapTable
+ */
+export interface AdaptableComment {
+    /**
+     * Unique identifier for the Comment
+     */
+    Uuid?: TypeUuid;
+    /**
+     * When Comment was made
      */
     Timestamp: number;
     /**
-     * Value of the Note
+     * Content of the Comment
      */
     Value: string;
     /**
-     * Author of the Note
+     * Author of the Comment
      */
     Author?: {
         UserName: string;
@@ -23,26 +37,16 @@ export interface AdaptableComment extends AdaptableObject {
      */
     AdaptableId?: string;
 }
-export interface CommentThread extends AdaptableObject {
-    /**
-     * Value in Primary Key Column
-     */
-    PrimaryKeyValue: string | number;
+/**
+ * Thread of Comments for an Adaptable Cell
+ */
+export interface CommentThread extends CellAddress {
     /**
-     * Id of Column containing the Note
+     * Unique identifier for Comment
      */
-    ColumnId: string;
+    Uuid?: TypeUuid;
     /**
      * Collection of Comments for this Cell
      */
     Comments: AdaptableComment[];
 }
-/**
- * Predefined Configuration for Notes Module
- */
-export interface CommentState extends ConfigState {
-    /**
-     * Collection of AdapTable Notes
-     */
-    CommentThreads?: CommentThread[];
-}

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

@@ -19,6 +19,10 @@ export interface AdaptableColumnBase extends AdaptableObject {
      * DataType of the Column
      */
     dataType: AdaptableColumnDataType;
+    /**
+     * Column Types of the Column
+     */
+    columnTypes?: string[];
 }
 export declare const isValidOrderForColumnGroups: ({ oldColumns, newColumns, }: {
     oldColumns: AdaptableColumn[];

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

@@ -54,4 +54,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable System Icon names
  */
-export type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'resume' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter';
+export type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'resume' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter' | 'rows';

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

@@ -8,7 +8,10 @@ export type ScopeDataTypes<Type = ScopeDataType> = {
 export type ScopeColumnIds = {
     ColumnIds: string[];
 };
+export type ScopeColumnTypes = {
+    ColumnTypes: string[];
+};
 /**
  * Defines where a given Object / Module is active
  */
-export type AdaptableScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds;
+export type AdaptableScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds | ScopeColumnTypes;

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

@@ -16,3 +16,4 @@ export interface WeightedAverageAggregation {
  * Defines which Columns in a Layout display Aggregated values when Row-Grouped
  */
 export type AggregationColumns = Record<string, string | true | WeightedAverageAggregation>;
+export declare const isWeightedAverageAggregation: (aggFunc: AggregationColumns[keyof AggregationColumns]) => aggFunc is WeightedAverageAggregation;

package/src/PredefinedConfig/Common/AggregationColumns.js

@@ -1 +1,4 @@
 export const WEIGHTED_AVERAGE_AGG_FN_NAME = 'weightedAvg';
+export const isWeightedAverageAggregation = (aggFunc) => {
+    return (aggFunc === null || aggFunc === void 0 ? void 0 : aggFunc.type) === 'weightedAverage';
+};

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

@@ -6,6 +6,10 @@ export interface DataUpdateConfig {
      * Whether data should be updated asynchronously
      */
     runAsync?: boolean;
+    /**
+     * Whether to flush async updates
+     */
+    flushAsync?: boolean;
     /**
      * Callback function invoked when a batch successfully updates
      */

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

@@ -60,7 +60,8 @@ export declare enum SummaryOperation {
     Min = "Min",
     Count = "Count",
     Std_Deviation = "Std Deviation",
-    Only = "Only"
+    Only = "Only",
+    Weighted_Average = "Weighted Avg"
 }
 export declare enum FilterOnDataChangeOptions {
     Always = "Always",

package/src/PredefinedConfig/Common/Enums.js

@@ -75,6 +75,7 @@ export var SummaryOperation;
     SummaryOperation["Count"] = "Count";
     SummaryOperation["Std_Deviation"] = "Std Deviation";
     SummaryOperation["Only"] = "Only";
+    SummaryOperation["Weighted_Average"] = "Weighted Avg";
 })(SummaryOperation || (SummaryOperation = {}));
 export var FilterOnDataChangeOptions;
 (function (FilterOnDataChangeOptions) {

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

@@ -5,12 +5,26 @@ 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];
+/**
+ * List of Shipped Adaptable Column Menu Items
+ */
+export declare const ADAPTABLE_COLUMN_MENU_ITEMS: readonly ["calculated-column-edit", "cell-summary-show", "column-filter-bar-hide", "column-filter-bar-show", "column-filter-clear", "column-filter-on-cell-value", "column-filter-suspend", "column-filter-unsuspend", "column-info-show", "custom-sort-add", "custom-sort-edit", "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-info-show", "layout-column-caption-change", "layout-column-hide", "layout-column-select", "layout-column-select-preserve", "layout-column-select-reset", "layout-edit", "layout-grid-parent", "layout-select-parent", "layout-select-all", "plus-minus-add", "settings-panel-open", "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", "internal", "parent"];
+/**
+ * List of Shipped Adaptable Context Menu Items
+ */
+export declare const ADAPTABLE_CONTEXT_MENU_ITEMS: readonly ["alert-clear", "bulk-update-apply", "calculated-column-edit", "cell-summary-show", "column-filter-on-cell-value", "column-filter-clear", "column-filter-suspend", "column-filter-unsuspend", "column-info-show", "comment-add", "comment-remove", "dashboard-collapse", "dashboard-configure", "dashboard-dock", "dashboard-expand", "dashboard-float", "dashboard-hide", "dashboard-show", "data-import", "export-clipboard", "export-csv", "export-excel", "export-json", "export-table", "export-custom-destination", "fdc3-broadcast", "fdc3-raise-intent", "flashing-cell-clear", "flashing-row-clear", "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 both Column and Context Menus
  */
 export interface AdaptableMenuItem {
     /**
-     * Name that appears in the menu
+     * Unique name for the Menu Item
+     */
+    name: AdaptableColumnMenuItemName | AdaptableContextMenuItemName;
+    /**
+     * Text that appears in the menu
      */
     label: string;
     /**

package/src/PredefinedConfig/Common/Menu.js

@@ -1 +1,97 @@
-export {};
+/**
+ * List of Shipped Adaptable Column Menu Items
+ */
+export const ADAPTABLE_COLUMN_MENU_ITEMS = [
+    'calculated-column-edit',
+    'cell-summary-show',
+    'column-filter-bar-hide',
+    'column-filter-bar-show',
+    'column-filter-clear',
+    'column-filter-on-cell-value',
+    'column-filter-suspend',
+    'column-filter-unsuspend',
+    'column-info-show',
+    'custom-sort-add',
+    'custom-sort-edit',
+    '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-info-show',
+    'layout-column-caption-change',
+    'layout-column-hide',
+    'layout-column-select',
+    'layout-column-select-preserve',
+    'layout-column-select-reset',
+    'layout-edit',
+    'layout-grid-parent',
+    'layout-select-parent',
+    'layout-select-all',
+    'plus-minus-add',
+    'settings-panel-open',
+    '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',
+    'internal',
+    'parent',
+];
+/**
+ * List of Shipped Adaptable Context Menu Items
+ */
+export const ADAPTABLE_CONTEXT_MENU_ITEMS = [
+    'alert-clear',
+    'bulk-update-apply',
+    'calculated-column-edit',
+    'cell-summary-show',
+    'column-filter-on-cell-value',
+    'column-filter-clear',
+    'column-filter-suspend',
+    'column-filter-unsuspend',
+    'column-info-show',
+    'comment-add',
+    'comment-remove',
+    'dashboard-collapse',
+    'dashboard-configure',
+    'dashboard-dock',
+    'dashboard-expand',
+    'dashboard-float',
+    'dashboard-hide',
+    'dashboard-show',
+    'data-import',
+    'export-clipboard',
+    'export-csv',
+    'export-excel',
+    'export-json',
+    'export-table',
+    'export-custom-destination',
+    'fdc3-broadcast',
+    'fdc3-raise-intent',
+    'flashing-cell-clear',
+    'flashing-row-clear',
+    '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/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 ["SUM", "AVG", "MIN", "MAX", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "STD_DEVIATION", "OLDEST", "YOUNGEST", "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 = [
+    'SUM',
+    'AVG',
+    'MIN',
+    'MAX',
+    'COUNT',
+    'MEDIAN',
+    'MODE',
+    'DISTINCT',
+    'ONLY',
+    'STD_DEVIATION',
+    'OLDEST',
+    'YOUNGEST',
+    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/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/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
  */
@@ -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,5 +1,14 @@
 import { AdaptableObject } from '../types';
 import { ConfigState } from './ConfigState';
+/**
+ * Predefined Configuration for Note Module
+ */
+export interface NoteState extends ConfigState {
+    /**
+     * Collection of AdapTable Notes
+     */
+    Notes?: AdaptableNotes;
+}
 /**
  * Note that can be applied to a Cell in AdapTable
  */
@@ -7,17 +16,11 @@ export interface AdaptableNote extends AdaptableObject {
     /**
      * When Note was made
      */
-    Timestamp: number;
-    /**
-     * Value of the Note
-     */
-    Value: string;
+    Timestamp?: number;
     /**
-     * Author of the Note
+     * Content of the Note
      */
-    Author: {
-        UserName: string;
-    };
+    Text: string;
     /**
      * Value in Grid's Primary Key Column
      */
@@ -26,21 +29,8 @@ export interface AdaptableNote extends AdaptableObject {
      * Id of Column containing the Note
      */
     ColumnId: string;
-    /**
-     * Id of this AdapTable instance
-     */
-    AdaptableId: string;
 }
 /**
  * Collection of Cell Notes
  */
 export type AdaptableNotes = AdaptableNote[];
-/**
- * Predefined Configuration for Notes Module
- */
-export interface NotesState extends ConfigState {
-    /**
-     * Collection of AdapTable Notes
-     */
-    Notes?: AdaptableNotes;
-}

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
@@ -44,9 +44,9 @@ export interface PredefinedConfig {
      */
     CustomSort?: CustomSortState;
     /**
-     * Collection of notes that can be edited on cell level
+     * 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/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 { CellAddress, CellDataChangedInfo, 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,6 +106,9 @@ export interface SystemState extends InternalState, IPushPullState, OpenFinState
         focusedEntity?: 'Note' | 'Comment';
         popupPosition?: CellAddress | null;
     };
+    RowSummary?: {
+        rowSummaries?: SystemRowSummary[];
+    };
 }
 export interface ProgressIndicator {
     active: boolean;

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

@@ -30,6 +30,10 @@ export declare const LAYOUT_SELECT = "LAYOUT_SELECT";
  * @ReduxAction A Layout has been (auto)saved
  */
 export declare const LAYOUT_SAVE = "LAYOUT_SAVE";
+/**
+ * @ReduxAction A Column has been added
+ */
+export declare const LAYOUT_ADD_COLUMN = "LAYOUT_ADD_COLUMN";
 /**
  * @ReduxAction A Column has been removed
  */
@@ -145,6 +149,10 @@ export interface LayoutSetColumnCaptionAction extends Redux.Action {
     columnId: string;
     caption: string;
 }
+export interface LayoutAddColumnAction extends Redux.Action {
+    layoutName: string;
+    columnId: string;
+}
 export interface LayoutRemoveColumnAction extends Redux.Action {
     layoutName: string;
     columnId: string;
@@ -163,6 +171,7 @@ export declare const LayoutAdd: (layout: Layout) => LayoutAddAction;
 export declare const LayoutDelete: (layout: Layout) => LayoutDeleteAction;
 export declare const LayoutSave: (layout: Layout) => LayoutSaveAction;
 export declare const LayoutSetColumnCaption: (layoutName: string, columnId: string, caption: string) => LayoutSetColumnCaptionAction;
+export declare const LayoutAddColumn: (layoutName: string, columnId: string) => LayoutAddColumnAction;
 export declare const LayoutRemoveColumn: (layoutName: string, columnId: string) => LayoutRemoveColumnAction;
 export declare const LayoutSelect: (layoutName: string) => LayoutSelectAction;
 export declare const LayoutReady: (layoutState: LayoutState) => LayoutReadyAction;