@adaptabletools/adaptable 18.0.0-canary.9 → 18.0.0

package/src/Api/LayoutApi.d.ts

@@ -23,6 +23,10 @@ export interface LayoutApi {
      * @returns layout
      */
     getCurrentLayout(): Layout;
+    /**
+     * Returns true if the current layout is a pivot layout
+     */
+    isCurrentLayoutPivot(): boolean;
     /**
      * Retrieves the sort order of a column from the current layout
      * @param columnId Column id
@@ -38,6 +42,10 @@ export interface LayoutApi {
      * Retrieves array of visible ColumnIds in current Layout
      */
     getCurrentVisibleColumnIds(): string[];
+    /**
+     * Retrieves array of visible ColumnIds in current Layout
+     */
+    getCurrentRowGroupsColumnIds(): string[];
     /**
      * Retrieves name of current Layout
      */
@@ -172,17 +180,6 @@ export interface LayoutApi {
     /**
      * Adds a Column to Current Layout
      * @param columnId Column to add
-      */
-    addColumnToCurrentLayout(columnId: string): void;
-    /**
-     * Returns what the layout supports.
-     * This takes into account the data-source.
      */
-    getLayoutSupportedFeatures(): {
-        RowGroupedColumns: boolean;
-        AggregationColumns: boolean;
-        PivotColumns: boolean;
-        ColumnFilters: boolean;
-        ColumnSorts: boolean;
-    };
+    addColumnToCurrentLayout(columnId: string): void;
 }

package/src/Api/NoteApi.d.ts

@@ -0,0 +1,48 @@
+import { AdaptableNote, AdaptableNotes, NoteState } from '../PredefinedConfig/NoteState';
+import { CellAddress } from '../../types';
+/**
+ * Provides run-time access to Notes Module and related State
+ */
+export interface NoteApi {
+    /**
+     * Adds a new Note
+     * @param text
+     * @param primaryKeyValue
+     * @param columnId
+     */
+    addNote(text: string, primaryKeyValue: any, columnId: string): void;
+    /**
+     * Edits a Note
+     * @param note
+     */
+    editNote(note: AdaptableNote): void;
+    /**
+     * Edits text of a Note
+     * @param text
+     * @param note
+     */
+    updateNoteText(text: string, note: AdaptableNote): void;
+    /**
+     * Deletes a Note
+     * @param note
+     */
+    deleteNote(note: AdaptableNote): void;
+    /**
+     * Gets the Note State
+     */
+    getNoteState(): NoteState;
+    /**
+     * Gets all Notes
+     */
+    getAllNotes(): AdaptableNotes;
+    /**
+     * Gets all Notes for a cell
+     * @param CellAddress note position
+     */
+    getNoteForCell(CellAddress: CellAddress): AdaptableNote;
+    /**
+     * Returns a Note by uuid
+     * @param uuid note uuid
+     */
+    getNoteByUuid(uuid: string): AdaptableNote | undefined;
+}

package/src/Api/NoteApi.js

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

package/src/Api/OptionsApi.d.ts

@@ -1,11 +1,11 @@
 import { CustomSortOptions } from '../AdaptableOptions/CustomSortOptions';
 import { DataSetOptions } from '../AdaptableOptions/DataSetOptions';
 import { GroupingOptions } from '../AdaptableOptions/GroupingOptions';
-import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnFilterOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, GridFilterOptions, LayoutOptions, MenuOptions, NotesOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnFilterOptions, ColumnMenuOptions, ColumnOptions, ContainerOptions, ContextMenuOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, GridFilterOptions, LayoutOptions, NoteOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
 import { Fdc3Options } from '../AdaptableOptions/Fdc3Options';
 import { ExpressionOptions } from '../AdaptableOptions/ExpressionOptions';
 import { DataImportOptions } from '../AdaptableOptions/DataImportOptions';
-import { CommentsOptions } from '../AdaptableOptions/CommentOptions';
+import { CommentOptions } from '../AdaptableOptions/CommentOptions';
 /**
  * Range of functions to access Adaptable Options
  */
@@ -75,13 +75,9 @@ export interface OptionsApi {
      */
     getColumnOptions(): Readonly<ColumnOptions>;
     /**
-     * Returns `AdaptableOptions.noteOptions`
-     */
-    getNotesOptions(): Readonly<NotesOptions>;
-    /**
-     * Returns `AdaptableOptions.commentsOptions`
+     * Returns `AdaptableOptions.commentOptions`
      */
-    getCommentsOptions(): Readonly<CommentsOptions>;
+    getCommentOptions(): Readonly<CommentOptions>;
     /**
      * Returns `AdaptableOptions.customSortOptions`
      */
@@ -131,9 +127,13 @@ export interface OptionsApi {
      */
     getLayoutOptions(): Readonly<LayoutOptions>;
     /**
-     * Returns `AdaptableOptions.menuOptions`
+     * Returns `AdaptableOptions.columnMenuOptions`
+     */
+    getColumnMenuOptions(): Readonly<ColumnMenuOptions>;
+    /**
+     * Returns `AdaptableOptions.contextMenuOptions`
      */
-    getMenuOptions(): Readonly<MenuOptions>;
+    getContextMenuOptions(): Readonly<ContextMenuOptions>;
     /**
      * Returns `AdaptableOptions.notificationsOptions`
      */
@@ -146,6 +146,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.formatColumnOptions`
      */
     getFormatColumnOptions(): Readonly<FormatColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.noteOptions`
+     */
+    getNoteOptions(): Readonly<NoteOptions>;
     /**
      * Returns `AdaptableOptions.settingsPanelOptions`
      */

package/src/Api/UserInterfaceApi.d.ts

@@ -1,11 +1,10 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../PredefinedConfig/Common/Menu';
 import { BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../AdaptableOptions/UserInterfaceOptions';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
-import { AdaptableIcon } from '../types';
-import { CustomWindowConfig } from '../AdaptableOptions/AdaptableFrameworkComponent';
+import { AdaptableFrameworkComponent, AdaptableIcon } from '../types';
+import { CustomRenderFunction, CustomWindowConfig } from '../AdaptableOptions/AdaptableFrameworkComponent';
 /**
  * Functions relating to User Interface section of Adaptable State
  */
@@ -54,16 +53,6 @@ export interface UserInterfaceApi {
      * @param  gridCell: the currently edited Grid Cell
      */
     getEditLookUpValuesForEditLookUpItem(editLookUpItem: EditLookUpPermittedValues, gridCell: GridCell): any[] | undefined;
-    /**
-     * Adds menu item to Column Menu
-     * @param userMenuItem Menu Item to add
-     */
-    addColumnMenuItem(userMenuItem: UserMenuItem<ColumnMenuContext>): void;
-    /**
-     * Adds menu item to Context Menu
-     * @param userMenuItem Menu Item to add
-     */
-    addContextMenuItem(userMenuItem: UserMenuItem<ContextMenuContext>): void;
     /**
      * Returns Style set for Editable cells
      */
@@ -83,12 +72,25 @@ export interface UserInterfaceApi {
     getCustomIconDefinition(name: string): AdaptableIcon | undefined;
     /**
      * Displays the popup that says getting data and initialising grid
+     * @deprecated use `showProgressIndicator()` instead
      */
     showLoadingScreen(): void;
     /**
      * Hides the popup that says getting data and initialising grid
+     * @deprecated use `hideProgressIndicator()` instead
      */
     hideLoadingScreen(): void;
+    /**
+     *
+     * @param config
+     */
+    showProgressIndicator(config: {
+        text?: string;
+        render?: CustomRenderFunction;
+        frameworkComponent?: AdaptableFrameworkComponent;
+        delay?: number;
+    }): void;
+    hideProgressIndicator(): void;
     /**
      * Opens window with custom content
      * @param config

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/AlertState.d.ts

@@ -1,5 +1,5 @@
 import { ConfigState } from './ConfigState';
-import { AdaptableScope } from './Common/AdaptableScope';
+import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
 import { TypeHint } from './Common/Types';
 import { AdaptableMessageType } from './Common/AdaptableMessageType';
@@ -27,7 +27,7 @@ export interface AlertDefinition extends SuspendableObject {
     /**
      * Where Alert can be triggered: one, some or all columns or DataTypes
      */
-    Scope: AdaptableScope;
+    Scope: ColumnScope;
     /**
      * When Alert should be triggered
      */

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/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' | 'rows';
+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}

@@ -14,4 +14,4 @@ export type ScopeColumnTypes = {
 /**
  * Defines where a given Object / Module is active
  */
-export type AdaptableScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds | ScopeColumnTypes;
+export type ColumnScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds | ScopeColumnTypes;

package/src/PredefinedConfig/Common/ColumnScope.js

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

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

@@ -73,8 +73,11 @@ export 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 || (SummaryOperation = {}));
 export 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;
+}