@adaptabletools/adaptable 18.0.0-canary.3 → 18.0.0-canary.31

package/src/Api/Internal/LayoutInternalApi.js

@@ -13,19 +13,11 @@ export class LayoutInternalApi extends ApiBase {
      * @param newState Layout State after change
      */
     fireLayoutChangedEvent(trigger, oldSate, newState, skipEqualityCheck) {
-        const adaptableApi = this.getAdaptableApi();
-        const layoutChangedInfo = {
-            adaptableApi: adaptableApi,
-            actionName: trigger,
-            oldLayoutState: oldSate,
-            newLayoutState: newState,
-            userName: adaptableApi.optionsApi.getUserName(),
-            adaptableId: adaptableApi.optionsApi.getAdaptableId(),
-        };
+        const layoutChangedInfo = Object.assign({ actionName: trigger, oldLayoutState: oldSate, newLayoutState: newState }, this.getAdaptableApi().internalApi.buildBaseContext());
         if (!skipEqualityCheck && isEqual(oldSate, newState)) {
             return;
         }
-        this.adaptable.api.eventApi.emit('LayoutChanged', layoutChangedInfo);
+        this.getAdaptableApi().eventApi.emit('LayoutChanged', layoutChangedInfo);
     }
     /**
      * Compares 2 Layouts for equality
@@ -66,7 +58,7 @@ export class LayoutInternalApi extends ApiBase {
             if (!layoutState.Layouts || !isLayoutDefined(DEFAULT_LAYOUT)) {
                 // augogroup columns are not in columns list
                 // the code that adds column ok grid state explicitly ignores autoColumns
-                const allGridColumns = this.adaptable.getAgGridAllGridColumns();
+                const allGridColumns = this.getAdaptableApi().gridApi.getAllAgGridColumns();
                 let defaultLayout = ObjectFactory.CreateEmptyLayout({
                     Name: DEFAULT_LAYOUT,
                     Columns: defaultLayoutColumns.map((c) => c.columnId),
@@ -110,6 +102,7 @@ export class LayoutInternalApi extends ApiBase {
      * This takes into account the data-source.
      */
     getLayoutSupportedFeatures() {
+        var _a, _b;
         const layoutSupportedFeatures = {
             RowGroupedColumns: true,
             AggregationColumns: true,
@@ -117,6 +110,7 @@ export class LayoutInternalApi extends ApiBase {
             ColumnFilters: true,
             ColumnSorts: true,
             GridFilter: true,
+            RowSummaries: true,
         };
         if (this.getGridApi().getAgGridRowModelType() === 'viewport') {
             layoutSupportedFeatures.RowGroupedColumns = false;
@@ -130,6 +124,9 @@ export class LayoutInternalApi extends ApiBase {
         if (this.getEntitlementApi().getEntitlementAccessLevelForModule(GridFilterModuleId) == 'Hidden') {
             layoutSupportedFeatures.GridFilter = false;
         }
+        if (((_b = (_a = this.adaptable) === null || _a === void 0 ? void 0 : _a.getAgGridRowModelType) === null || _b === void 0 ? void 0 : _b.call(_a)) !== 'clientSide') {
+            layoutSupportedFeatures.RowSummaries = false;
+        }
         return layoutSupportedFeatures;
     }
     updateCurrentDraftLayout(layout) {
@@ -155,14 +152,8 @@ export class LayoutInternalApi extends ApiBase {
         if ((layoutTagOptions === null || layoutTagOptions === void 0 ? void 0 : layoutTagOptions.autoCheckTagsForLayouts) == true) {
             return ArrayExtensions.IsNullOrEmpty(object.Tags) ? true : (_a = object.Tags) === null || _a === void 0 ? void 0 : _a.includes(layout.Name);
         }
-        const context = {
-            adaptableObject: object,
-            module,
-            layout,
-            adaptableApi: this.getAdaptableApi(),
-            userName: this.getOptions().userName,
-            adaptableId: this.getOptions().adaptableId,
-        };
+        const context = Object.assign({ adaptableObject: object, module,
+            layout }, this.getAdaptableApi().internalApi.buildBaseContext());
         return layoutTagOptions === null || layoutTagOptions === void 0 ? void 0 : layoutTagOptions.isObjectAvailableInLayout(context);
     }
     showLayoutNotAssociatedObjects() {
@@ -175,4 +166,20 @@ export class LayoutInternalApi extends ApiBase {
         }
         return ((_a = layout === null || layout === void 0 ? void 0 : layout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) > 0;
     }
+    setupRowSummaries() {
+        var _a, _b, _c;
+        const rowSummaries = (_c = (_b = (_a = this.getAdaptableState().System) === null || _a === void 0 ? void 0 : _a.RowSummary) === null || _b === void 0 ? void 0 : _b.rowSummaries) !== null && _c !== void 0 ? _c : [];
+        const { top, bottom } = rowSummaries.reduce((acc, summaryRow) => {
+            const row = summaryRow.RowData;
+            if (summaryRow.Position === 'Bottom' || !summaryRow.Position) {
+                acc.bottom.push(row);
+            }
+            else {
+                acc.top.push(row);
+            }
+            return acc;
+        }, { top: [], bottom: [] });
+        this.adaptable.agGridAdapter.setGridOption('pinnedTopRowData', top);
+        this.adaptable.agGridAdapter.setGridOption('pinnedBottomRowData', bottom);
+    }
 }

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

@@ -0,0 +1,4 @@
+import { ApiBase } from '../Implementation/ApiBase';
+export declare class NoteInternalApi extends ApiBase {
+    areNotesSupported(): boolean;
+}

package/src/Api/Internal/NoteInternalApi.js

@@ -0,0 +1,14 @@
+import { ApiBase } from '../Implementation/ApiBase';
+export class NoteInternalApi extends ApiBase {
+    areNotesSupported() {
+        var _a;
+        const currentLayout = this.getLayoutApi().getCurrentLayout();
+        if (currentLayout.EnablePivot) {
+            return false;
+        }
+        if ((_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length) {
+            return false;
+        }
+        return true;
+    }
+}

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

@@ -2,7 +2,7 @@ import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptablePredicate, AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { SystemFilterPredicateId } from '../../PredefinedConfig/Common/ColumnFilter';
 import { AdaptableColumnDataType } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableScope } from '../../types';
+import { ColumnScope } from '../../types';
 export declare class PredicateInternalApi extends ApiBase {
     /**
      * Returns true if the predicate has a dropdown.
@@ -13,23 +13,23 @@ export declare class PredicateInternalApi extends ApiBase {
     /**
      * Get all Filter Predicate Definitions - System and Custom
      */
-    getFilterPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFilterPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemFilterPredicateIds;
     /**
      * Get all Alert Predicate Definitions - System and Custom
      */
-    getAlertPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getAlertPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemAlertPredicateIds;
     private getSystemBadgeStylePredicateIds;
     /**
      * Get all Format Column Predicate Definitions - System and Custom
      */
-    getFormatColumnPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFormatColumnPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemFormatColumnPredicateIds;
     /**
      * Get all Flashing Cell Predicate Definitions - System and Custom
      */
-    getFlashingCellPredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFlashingCellPredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     private getSystemFlashingCellPredicateIds;
     /**
      * Gets the correct Equality-type System Predicate for a particular DataType
@@ -39,7 +39,7 @@ export declare class PredicateInternalApi extends ApiBase {
     /**
      * Get all Badge Style Predicate Definitions - System and Custom
      */
-    getBadgeStylePredicateDefs(scope: AdaptableScope): AdaptablePredicateDef[];
+    getBadgeStylePredicateDefs(scope: ColumnScope): AdaptablePredicateDef[];
     /**
      * Merges System and Custom Predicate Definitions but ensures that Custom ones take precedence
      * (i.e. if there is a Custom Predicate with the same Id as a System one, the Custom one is used)

package/src/Api/Internal/PredicateInternalApi.js

@@ -18,14 +18,7 @@ export class PredicateInternalApi extends ApiBase {
     getSystemFilterPredicateIds(scope) {
         const systemFilterPredicates = this.getPredicateOptions().systemFilterPredicates;
         if (typeof systemFilterPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('columnFilter'),
-                moduleScope: 'columnFilter',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('columnFilter'), moduleScope: 'columnFilter', columnScope: scope });
             return systemFilterPredicates(systemPredicateContext);
         }
         return systemFilterPredicates;
@@ -40,14 +33,7 @@ export class PredicateInternalApi extends ApiBase {
     getSystemAlertPredicateIds(scope) {
         const systemAlertPredicates = this.getPredicateOptions().systemAlertPredicates;
         if (typeof systemAlertPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('alert'),
-                moduleScope: 'alert',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('alert'), moduleScope: 'alert', columnScope: scope });
             return systemAlertPredicates(systemPredicateContext);
         }
         return systemAlertPredicates;
@@ -55,14 +41,7 @@ export class PredicateInternalApi extends ApiBase {
     getSystemBadgeStylePredicateIds(scope) {
         const systemBadgeStylePredicates = this.getPredicateOptions().systemBadgeStylePredicates;
         if (typeof systemBadgeStylePredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('badgeStyle'),
-                moduleScope: 'badgeStyle',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('badgeStyle'), moduleScope: 'badgeStyle', columnScope: scope });
             return systemBadgeStylePredicates(systemPredicateContext);
         }
         return systemBadgeStylePredicates;
@@ -77,14 +56,7 @@ export class PredicateInternalApi extends ApiBase {
     getSystemFormatColumnPredicateIds(scope) {
         const systemFormatColumnPredicates = this.getPredicateOptions().systemFormatColumnPredicates;
         if (typeof systemFormatColumnPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('formatColumn'),
-                moduleScope: 'formatColumn',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('formatColumn'), moduleScope: 'formatColumn', columnScope: scope });
             return systemFormatColumnPredicates(systemPredicateContext);
         }
         return systemFormatColumnPredicates;
@@ -99,14 +71,7 @@ export class PredicateInternalApi extends ApiBase {
     getSystemFlashingCellPredicateIds(scope) {
         const systemFlashingCellPredicates = this.getPredicateOptions().systemFlashingCellPredicates;
         if (typeof systemFlashingCellPredicates === 'function') {
-            const systemPredicateContext = {
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('flashingcell'),
-                moduleScope: 'flashingcell',
-                columnScope: scope,
-            };
+            const systemPredicateContext = Object.assign({ systemPredicateDefs: this.getPredicateApi().getSystemPredicateDefsByModuleScope('flashingcell'), moduleScope: 'flashingcell', columnScope: scope }, this.getAdaptableApi().internalApi.buildBaseContext());
             return systemFlashingCellPredicates(systemPredicateContext);
         }
         return systemFlashingCellPredicates;

package/src/Api/Internal/ScheduleInternalApi.js

@@ -5,12 +5,7 @@ export class ScheduleInternalApi extends ApiBase {
      */
     fireScheduleTriggeredEvent(schedule) {
         const adaptableApi = this.getAdaptableApi();
-        const scheduleTriggeredInfo = {
-            adaptableApi: adaptableApi,
-            userName: adaptableApi.optionsApi.getUserName(),
-            adaptableId: adaptableApi.optionsApi.getAdaptableId(),
-            schedule: schedule,
-        };
+        const scheduleTriggeredInfo = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { schedule: schedule });
         adaptableApi.eventApi.emit('ScheduleTriggered', scheduleTriggeredInfo);
     }
 }

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

@@ -1,6 +1,6 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { BadgeStyleDefinition, CellColorRange, ColumnComparison, NumericStyledColumn, StyledColumn } from '../../PredefinedConfig/StyledColumnState';
+import { BadgeStyle, BadgeStyleDefinition, CellColorRange, ColumnComparison, NumericStyledColumn, StyledColumn } from '../../PredefinedConfig/StyledColumnState';
 import { IRowNode } from '@ag-grid-community/core';
 import { PredicateDefHandlerContext } from '../../types';
 export declare class StyledColumnInternalApi extends ApiBase {
@@ -57,6 +57,6 @@ export declare class StyledColumnInternalApi extends ApiBase {
      * @param styledColumn Styled Column to Add
      */
     hasStyledColumnRelativeCellRange(styledColumn: StyledColumn): boolean;
-    getApplicableBadge(styledColumn: StyledColumn, context: PredicateDefHandlerContext): BadgeStyleDefinition | null;
+    getApplicableBadge(badgeStyle: BadgeStyle, context: PredicateDefHandlerContext): BadgeStyleDefinition | null;
     getBadgePredicateDefsForColumn(columnId: string): import("../../types").AdaptablePredicateDef<string>[];
 }

package/src/Api/Internal/StyledColumnInternalApi.js

@@ -30,11 +30,11 @@ export class StyledColumnInternalApi extends ApiBase {
             }
             else {
                 let columnId = columnComparison.MinValue;
-                if (!this.adaptable.api.columnApi.isColumnInGrid(columnId)) {
+                if (!this.getAdaptableApi().columnApi.isColumnInGrid(columnId)) {
                     return 0;
                 }
                 else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
+                    return this.getAdaptableApi().gridApi.getRawValueFromRowNode(rowNode, columnId);
                 }
             }
         }
@@ -93,11 +93,11 @@ export class StyledColumnInternalApi extends ApiBase {
             }
             else {
                 let columnId = columnComparison.MaxValue;
-                if (!this.adaptable.api.columnApi.isColumnInGrid(columnId)) {
+                if (!this.getAdaptableApi().columnApi.isColumnInGrid(columnId)) {
                     return 0;
                 }
                 else {
-                    return this.adaptable.api.gridApi.getRawValueFromRowNode(rowNode, columnId);
+                    return this.getAdaptableApi().gridApi.getRawValueFromRowNode(rowNode, columnId);
                 }
             }
         }
@@ -241,15 +241,14 @@ export class StyledColumnInternalApi extends ApiBase {
                 return cellColorRange.Min == 'Col-Min' || cellColorRange.Max == 'Col-Max';
             })))) !== null && _e !== void 0 ? _e : false);
     }
-    getApplicableBadge(styledColumn, context) {
-        var _a, _b;
-        if (!((_a = styledColumn.BadgeStyle) === null || _a === void 0 ? void 0 : _a.Badges.length)) {
+    getApplicableBadge(badgeStyle, context) {
+        if (!badgeStyle.Badges.length) {
             return null;
         }
         // first that matches, sort last ones without predicate
         const badgesWithoutAll = [];
         const badgesWithAll = [];
-        for (let badge of (_b = styledColumn.BadgeStyle) === null || _b === void 0 ? void 0 : _b.Badges) {
+        for (let badge of badgeStyle.Badges) {
             if (!badge.Predicate) {
                 badgesWithAll.push(badge);
             }
@@ -275,6 +274,6 @@ export class StyledColumnInternalApi extends ApiBase {
         };
         return this.getAdaptableApi()
             .predicateApi.internalApi.getBadgeStylePredicateDefs(scope)
-            .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
+            .filter((predicate) => this.getAdaptableApi().scopeApi.isColumnInScope(column, predicate.columnScope));
     }
 }

package/src/Api/Internal/SystemStatusInternalApi.js

@@ -6,13 +6,7 @@ export class SystemStatusInternalApi extends ApiBase {
      * @param systemStatusMessageInfo Info about new System Status Message
      */
     fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo) {
-        const adaptableApi = this.getAdaptableApi();
-        const systemStatusMessageDisplayedInfo = {
-            adaptableApi,
-            systemStatusMessageInfo: systemStatusMessageInfo,
-            userName: adaptableApi.optionsApi.getUserName(),
-            adaptableId: adaptableApi.optionsApi.getAdaptableId(),
-        };
+        const systemStatusMessageDisplayedInfo = Object.assign({ systemStatusMessageInfo: systemStatusMessageInfo }, this.getAdaptableApi().internalApi.buildBaseContext());
         this.getAdaptableApi().eventApi.emit('SystemStatusMessageDisplayed', systemStatusMessageDisplayedInfo);
     }
     addSystemStatusMessageInfo(systemStatusMessageInfo) {

package/src/Api/Internal/TeamSharingInternalApi.js

@@ -5,13 +5,8 @@ export class TeamSharingInternalApi extends ApiBase {
      * @param sharedEntity Entity that has been changed
      */
     fireTeamSharingEntityChangedEvent(sharedEntity) {
-        if (this.adaptable.isLive) {
-            const teamSharingEntityChangedInfo = {
-                adaptableApi: this.adaptable.api,
-                sharedEntity: sharedEntity,
-                userName: this.adaptable.api.optionsApi.getUserName(),
-                adaptableId: this.adaptable.api.optionsApi.getAdaptableId(),
-            };
+        if (this.adaptable.isReady) {
+            const teamSharingEntityChangedInfo = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { sharedEntity: sharedEntity });
             this.getAdaptableApi().eventApi.emit('TeamSharingEntityChanged', teamSharingEntityChangedInfo);
         }
     }
@@ -38,7 +33,7 @@ export class TeamSharingInternalApi extends ApiBase {
                 reject(false);
             }, waitThreshold);
             // poll state for changes:
-            const unsubscribe = this.adaptable.api.eventApi.on('AdaptableStateChanged', () => {
+            const unsubscribe = this.getAdaptableApi().eventApi.on('AdaptableStateChanged', () => {
                 clearTimeout(pollTimer);
                 pollTimer = setTimeout(() => {
                     // state is stable, cleanup all subscriptions before returning

package/src/Api/Internal/ThemeInternalApi.js

@@ -10,7 +10,7 @@ export class ThemeInternalApi extends ApiBase {
         return `ab--theme-${theme}`;
     }
     openInWindow() {
-        this.adaptable.api.internalApi.showPopupWindow({
+        this.getAdaptableApi().internalApi.showPopupWindow({
             id: SHOW_THEME_EDITOR,
             title: 'Theme',
             icon: 'theme',

package/src/Api/Internal/UserInterfaceInternalApi.js

@@ -3,7 +3,7 @@ export class UserInterfaceInternalApi extends ApiBase {
     prepareAdaptableIconDef(icon) {
         if (icon && 'name' in icon) {
             let customIcon = icon && 'name' in icon
-                ? this.adaptable.api.userInterfaceApi.getCustomIconDefinition(icon.name)
+                ? this.getAdaptableApi().userInterfaceApi.getCustomIconDefinition(icon.name)
                 : null;
             if (customIcon) {
                 icon = customIcon;

package/src/Api/InteropioPluginApi.d.ts

@@ -1,10 +1,10 @@
 import { InteropioPluginOptions } from '../AdaptableOptions/InteropioPluginOptions';
 /**
- * Provides run-time access to the Glue42Web Plugin
+ * Provides run-time access to the Interopio Plugin
  */
 export interface InteropioPluginApi {
     /**
-     * Retrieves the Glue42WebPlugOptions provided in Glue42Web Plugin
+     * Retrieves the InteropioPlugOptions provided in interopio Plugin
      */
     getPluginOptions(): InteropioPluginOptions;
 }

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
      */
@@ -164,14 +172,14 @@ export interface LayoutApi {
      */
     removeColumnFromLayout(columnId: string, layoutName: string): void;
     /**
-     * Returns what the layout supports.
-     * This takes into account the data-source.
+     * Adds a Column to a given Layout
+     * @param columnId Column to add
+     * @param layoutName layout to which to add Column
      */
-    getLayoutSupportedFeatures(): {
-        RowGroupedColumns: boolean;
-        AggregationColumns: boolean;
-        PivotColumns: boolean;
-        ColumnFilters: boolean;
-        ColumnSorts: boolean;
-    };
+    addColumnToLayout(columnId: string, layoutName: string): void;
+    /**
+     * Adds a Column to Current Layout
+     * @param columnId Column to add
+     */
+    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
+     */
+    getNotesForCell(CellAddress: CellAddress): AdaptableNote[];
+    /**
+     * Returns a Note by uuid
+     * @param uuid note uuid
+     */
+    getNoteByUuid(uuid: string): AdaptableNote | undefined;
+}

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, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, GridFilterOptions, LayoutOptions, MenuOptions, 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/CommentsOptions';
+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`
      */
@@ -146,6 +142,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.formatColumnOptions`
      */
     getFormatColumnOptions(): Readonly<FormatColumnOptions>;
+    /**
+     * Returns `AdaptableOptions.noteOptions`
+     */
+    getNoteOptions(): Readonly<NoteOptions>;
     /**
      * Returns `AdaptableOptions.settingsPanelOptions`
      */