@adaptabletools/adaptable-cjs 18.0.0-canary.8 → 18.0.0

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' | 'copy' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'json' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'excel' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'filter-off' | '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' | 'select-all' | 'select-off' | 'select-fwd' | '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' | 'grid-info' | 'csv' | 'rows' | 'expand-all' | 'collapse-all';

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

@@ -1,5 +1,5 @@
 import { TypeUuid } from '../Uuid';
-import { AdaptableScope } from './AdaptableScope';
+import { ColumnScope } from './ColumnScope';
 /**
  * Base interface which all other Adaptable State-related objects extend
  */
@@ -30,9 +30,9 @@ export type AdaptableObjectTag = string;
  */
 export interface AdaptableObjectLookupCriteria {
     /**
-     * AdaptableScope
+     * ColumnScope
      */
-    scope?: AdaptableScope;
+    scope?: ColumnScope;
     /**
      * AdaptableObjectTag
      */
@@ -43,5 +43,5 @@ export interface AdaptableObjectLookupCriteria {
     ids?: AdaptableObject['Uuid'][];
 }
 export interface AdaptableObjectWithScope extends AdaptableObject {
-    Scope: AdaptableScope;
+    Scope: ColumnScope;
 }

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

@@ -1,7 +1,7 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { AdaptableIcon, ColumnFilter } from '../../types';
 import { AdaptableColumn, AdaptableColumnDataType } from './AdaptableColumn';
-import { AdaptableScope } from './AdaptableScope';
+import { ColumnScope } from './ColumnScope';
 import { BaseContext } from './BaseContext';
 /**
  * Predicate object used by AdapTableQL - essentially a boolean function
@@ -40,7 +40,7 @@ export interface AdaptablePredicateDef<PREDICATE_TYPE = string> {
     /**
      * Columns (or DataTypes) where Predicate is active
      */
-    columnScope: AdaptableScope;
+    columnScope: ColumnScope;
     /**
      * Modules where Predicate can run
      */

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

@@ -1,4 +1,5 @@
 import { BaseContext } from '../../../types';
+import { AdaptableColumn } from '../../types';
 import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
 /**
  * Defines the Summary operations provides for Selected Cells
@@ -14,6 +15,8 @@ export interface CellSummmary {
     Count: number | undefined;
     Only: string | undefined;
     Std_Deviation: number | undefined;
+    Oldest: Date | undefined;
+    Newest: Date | undefined;
     [key: string]: any;
 }
 /**
@@ -38,19 +41,7 @@ export interface CellSummaryOperationContext<TData = any> extends BaseContext {
      */
     selectedCellInfo: SelectedCellInfo<TData>;
     /**
-     * All values of selected cells
+     * Currently selected Column
      */
-    allValues: any[];
-    /**
-     * Any numeric columns in current selection
-     */
-    numericColumns: string[];
-    /**
-     * Any numeric values in current selection
-     */
-    numericValues: number[];
-    /**
-     * Count of currently selected cells
-     */
-    distinctCount: number;
+    selectedColumn: AdaptableColumn;
 }

package/src/PredefinedConfig/Common/{AdaptableScope.d.ts → ColumnScope.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 ColumnScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds | ScopeColumnTypes;

package/src/PredefinedConfig/Common/ColumnScope.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -7,11 +7,7 @@ export interface DataUpdateConfig {
      */
     runAsync?: boolean;
     /**
-     * Whether to flush async updates.
-     *
-     * If `true`, any async transactions will be flushed.
-     * This flag can be true even if you runAsync is `false`.
-     * So even if the currenct transaction/operation is synchronous, this will flush existing async transactions.
+     * Whether to flush async updates
      */
     flushAsync?: boolean;
     /**

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

@@ -59,8 +59,11 @@ export declare enum SummaryOperation {
     Max = "Max",
     Min = "Min",
     Count = "Count",
+    Newest = "Newest",
+    Oldest = "Oldest",
     Std_Deviation = "Std Deviation",
-    Only = "Only"
+    Only = "Only",
+    Weighted_Average = "Weighted Avg"
 }
 export declare enum FilterOnDataChangeOptions {
     Always = "Always",

package/src/PredefinedConfig/Common/Enums.js

@@ -76,8 +76,11 @@ var SummaryOperation;
     SummaryOperation["Max"] = "Max";
     SummaryOperation["Min"] = "Min";
     SummaryOperation["Count"] = "Count";
+    SummaryOperation["Newest"] = "Newest";
+    SummaryOperation["Oldest"] = "Oldest";
     SummaryOperation["Std_Deviation"] = "Std Deviation";
     SummaryOperation["Only"] = "Only";
+    SummaryOperation["Weighted_Average"] = "Weighted Avg";
 })(SummaryOperation = exports.SummaryOperation || (exports.SummaryOperation = {}));
 var FilterOnDataChangeOptions;
 (function (FilterOnDataChangeOptions) {

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

@@ -74,7 +74,7 @@ export declare const Fdc3StandardIntents: ("StartCall" | "StartChat" | "StartEma
 /**
  * All FDC3 standard intents
  */
-export type Fdc3StandardIntentType = typeof Fdc3StandardIntents[number];
+export type Fdc3StandardIntentType = (typeof Fdc3StandardIntents)[number];
 /**
  * Custom FDC3 intent
  */
@@ -86,4 +86,4 @@ export type Fdc3IntentType = Fdc3StandardIntentType | Fdc3CustomIntentType;
 /**
  * Valid context for a given FDC3 intent
  */
-export type CompatibleContext<F extends Fdc3StandardIntentType> = typeof Fdc3IntentConfiguration[F]['contexts'][number];
+export type CompatibleContext<F extends Fdc3StandardIntentType> = (typeof Fdc3IntentConfiguration)[F]['contexts'][number];

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,2 +1,128 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADAPTABLE_CONTEXT_MENU_ITEMS = exports.ADAPTABLE_COLUMN_MENU_ITEMS = void 0;
+/**
+ * List of Shipped Adaptable Column Menu Items
+ */
+exports.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
+ */
+exports.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,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.summarySupportedExpressions = exports.WEIGHTED_AVERAGE_AGGREATED_FUNCTION = exports.ROW_SUMMARY_ROW_ID = void 0;
+exports.ROW_SUMMARY_ROW_ID = '__ROW_SUMMARY_ROW_ID';
+exports.WEIGHTED_AVERAGE_AGGREATED_FUNCTION = 'WEIGHTED_AVERAGE';
+exports.summarySupportedExpressions = [
+    'MIN',
+    'MAX',
+    'SUM',
+    'AVG',
+    'COUNT',
+    'MEDIAN',
+    'MODE',
+    'DISTINCT',
+    'ONLY',
+    'OLDEST',
+    'NEWEST',
+    'STD_DEVIATION',
+    exports.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,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -30,6 +30,7 @@ exports.ALL_STATUS_SUB_PANELS = [
     'BulkUpdate',
     'CalculatedColumn',
     'CellSummary',
+    'Comment',
     'CustomSort',
     'Charting',
     'Dashboard',
@@ -44,6 +45,7 @@ exports.ALL_STATUS_SUB_PANELS = [
     'FreeTextColumn',
     'GridInfo',
     'Layout',
+    'Note',
     'PlusMinus',
     'QuickSearch',
     'Schedule',
@@ -81,7 +83,8 @@ exports.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[];
 }