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

package/src/Api/Implementation/FlashingCellApiImpl.d.ts

@@ -3,7 +3,7 @@ import { AdaptableFlashingCell } from '../../PredefinedConfig/Common/AdaptableFl
 import { FlashingCellApi } from '../FlashingCellApi';
 import { FlashingCellDefinition, FlashingCellState } from '../../PredefinedConfig/FlashingCellState';
 import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
-import { AdaptableScope } from '../../PredefinedConfig/Common/AdaptableScope';
+import { ColumnScope } from '../../PredefinedConfig/Common/ColumnScope';
 import { FlashingCellInternalApi } from '../Internal/FlashingCellInternalApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AdaptableObjectLookupCriteria } from '../../types';
@@ -23,7 +23,7 @@ export declare class FlashingCellApiImpl extends ApiBase implements FlashingCell
     unSuspendFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     addFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
     editFlashingCellDefinitions(flashingCellDefinitions: FlashingCellDefinition[]): FlashingCellDefinition[];
-    getFlashingCellPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    getFlashingCellPredicateDefsForScope(scope: ColumnScope): AdaptablePredicateDef[];
     clearAllFlashingCells(): void;
     isAnyFlashingCellActive(): boolean;
     findFlashingCellDefinitions(criteria: AdaptableObjectLookupCriteria): FlashingCellDefinition[];

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -34,13 +34,8 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
     }
     showFlashingCell(flashingCellToShow) {
         this.addUidToAdaptableObject(flashingCellToShow);
-        const flashingCellFiredInfo = {
-            adaptableApi: this.adaptable.api,
-            flashingCell: flashingCellToShow,
-            userName: this.adaptable.api.optionsApi.getUserName(),
-            adaptableId: this.adaptable.api.optionsApi.getAdaptableId(),
-        };
-        const results = this.adaptable.api.eventApi.emitSync('FlashingCellDisplayed', flashingCellFiredInfo);
+        const flashingCellFiredInfo = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { flashingCell: flashingCellToShow });
+        const results = this.getAdaptableApi().eventApi.emitSync('FlashingCellDisplayed', flashingCellFiredInfo);
         const shouldShow = results.reduce((endResult, aResult) => {
             return endResult && aResult !== false;
         }, true);
@@ -88,7 +83,7 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
     getFlashingCellPredicateDefsForScope(scope) {
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFlashingCellPredicateDefs(scope)
-            .filter((predicateDef) => this.adaptable.api.scopeApi.isScopeInScope(scope, predicateDef.columnScope));
+            .filter((predicateDef) => this.getAdaptableApi().scopeApi.isScopeInScope(scope, predicateDef.columnScope));
     }
     clearAllFlashingCells() {
         this.dispatchAction(SystemRedux.SystemFlashingCellDeleteAll());

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -69,7 +69,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         return this.internalApi.getFormatColumnWithColumnInScope(formatColumns, column);
     }
     getFormatColumnsForColumnId(columnId, config) {
-        const abColumn = this.adaptable.api.columnApi.getColumnWithColumnId(columnId);
+        const abColumn = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
         if (!abColumn) {
             return [];
         }
@@ -79,13 +79,13 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
         this.showModulePopup(ModuleConstants.FormatColumnModuleId);
     }
     getFormatColumnsWithAllScope(formatColumns) {
-        return formatColumns.filter((fc) => this.adaptable.api.scopeApi.scopeIsAll(fc.Scope));
+        return formatColumns.filter((fc) => this.getAdaptableApi().scopeApi.scopeIsAll(fc.Scope));
     }
     getFormatColumnsWithDataTypeScope(formatColumns) {
-        return formatColumns.filter((fc) => this.adaptable.api.scopeApi.scopeHasDataType(fc.Scope));
+        return formatColumns.filter((fc) => this.getAdaptableApi().scopeApi.scopeHasDataType(fc.Scope));
     }
     getFormatColumnsWithColumnScope(formatColumns) {
-        return formatColumns.filter((fc) => this.adaptable.api.scopeApi.scopeHasColumns(fc.Scope));
+        return formatColumns.filter((fc) => this.getAdaptableApi().scopeApi.scopeHasColumns(fc.Scope));
     }
     hasCustomDisplayFormatter(formatColumn) {
         var _a;

package/src/Api/Implementation/FreeTextColumnApiImpl.js

@@ -89,7 +89,7 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
     }
     getFreeTextColumnValueForRowNode(freeTextColumn, rowNode) {
         try {
-            if (this.adaptable.api.gridApi.isGroupRowNode(rowNode)) {
+            if (this.getAdaptableApi().gridApi.isGroupRowNode(rowNode)) {
                 return null;
             }
             if (ArrayExtensions_1.default.IsNotNullOrEmpty(freeTextColumn.FreeTextStoredValues)) {

package/src/Api/Implementation/GridApiImpl.d.ts

@@ -8,20 +8,23 @@ import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { DataUpdateConfig } from '../../PredefinedConfig/Common/DataUpdateConfig';
 import { CellHighlightInfo } from '../../PredefinedConfig/Common/CellHighlightInfo';
 import { RowHighlightInfo } from '../../PredefinedConfig/Common/RowHighlightInfo';
-import { GridOptions, IRowNode, RowModelType } from '@ag-grid-community/core';
+import { Column, IRowNode, RowModelType } from '@ag-grid-community/core';
 import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { RowsHighlightInfo } from '../../PredefinedConfig/Common/RowsHighlightInfo';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { GridInternalApi } from '../Internal/GridInternalApi';
+import { TransposeConfig } from '../../PredefinedConfig/Common/TransposeConfig';
 export declare class GridApiImpl extends ApiBase implements GridApi {
     internalApi: GridInternalApi;
     constructor(adaptable: IAdaptable);
     getGridState(): GridState;
+    loadGridData(dataSource: any): void;
     resetGridData(dataSource: any[]): void;
     setInitialGridData(data: any): void;
     getGridData(): any[];
     getFilteredData(): any[];
+    getVisibleData(): any[];
     updateGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
     addOrUpdateGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<{
         addedRows: IRowNode[];
@@ -40,7 +43,6 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     hideFilterForm(): void;
     applyGridFiltering(): void;
     clearGridFiltering(): void;
-    getAgGridInstance(): GridOptions;
     getColumnSorts(): ColumnSort[];
     getColumnSortForColumn(columnId: string): ColumnSort | undefined;
     setAdaptableSorting(columnSorts: ColumnSort[]): void;
@@ -92,7 +94,10 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     isGridPivotable(): boolean;
     isGridGroupable(): boolean;
     isGridSelectable(): boolean;
+    isGridRowSelectable(): boolean;
+    isGridRangeSelectable(): boolean;
     isGridRowGrouped(): boolean;
+    isGridInPivotMode(): boolean;
     isGroupRowNode(rowNode: IRowNode): boolean;
     isQuickFilterAvailable(): boolean;
     redrawGrid(): void;
@@ -120,7 +125,6 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     isCellEditable(gridCell: GridCell): boolean;
     isEveryCellEditable(gridCells: GridCell[]): boolean;
     getRowCount(): number;
-    getVisibleRowCount(): number;
     getRowsInViewport(): IRowNode[];
     getColumnCount(): number;
     getVisibleColumnCount(): number;
@@ -130,4 +134,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridContainerElement(): HTMLElement | null;
     openGridInfoSettingsPanel(): void;
     getAgGridRowModelType(): RowModelType;
+    getVisibleRowCount(): number;
+    showTransposedView(transposeConfig?: TransposeConfig): void;
+    getAllAgGridColumns(): Column<any>[];
 }

package/src/Api/Implementation/GridApiImpl.js

@@ -8,6 +8,8 @@ const SystemRedux_1 = require("../../Redux/ActionsReducers/SystemRedux");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const GridInternalApi_1 = require("../Internal/GridInternalApi");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
+const windowFactory_1 = require("../../View/Components/Popups/WindowPopups/windowFactory");
 class GridApiImpl extends ApiBase_1.ApiBase {
     constructor(adaptable) {
         super(adaptable);
@@ -16,13 +18,23 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     getGridState() {
         return this.getAdaptableState().Grid;
     }
-    resetGridData(dataSource) {
+    loadGridData(dataSource) {
+        // we intentionally set an initial empty array,
+        // to prevent `cellchanged` events from being triggered for rows that have
+        // the same primary key with existing rows
+        // see #testprevent_cellchanged_event_on_load_grid_data
+        this.adaptable.agGridAdapter.setGridOption('rowData', []);
         this.adaptable.setGridData(dataSource);
         const allRowNodes = this.getAllRowNodes();
-        this.internalApi.fireGridDataChangedEvent(dataSource, allRowNodes, 'Add');
+        this.internalApi.fireGridDataChangedEvent(dataSource, allRowNodes, 'Load');
+    }
+    resetGridData(dataSource) {
+        (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'GridApi', 'resetGridData', 'loadGridData');
+        this.loadGridData(dataSource);
     }
     setInitialGridData(data) {
-        this.adaptable.setGridData(data);
+        (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'GridApi', 'setInitialGridData', 'loadGridData');
+        this.loadGridData(data);
     }
     getGridData() {
         return this.adaptable.getGridData();
@@ -30,6 +42,15 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     getFilteredData() {
         return this.adaptable.getFilteredData();
     }
+    getVisibleData() {
+        const data = [];
+        this.adaptable.forAllVisibleRowNodesDo((rowNode) => {
+            if (!this.isGroupRowNode(rowNode)) {
+                data.push(rowNode.data);
+            }
+        });
+        return data;
+    }
     async updateGridData(dataRows, dataUpdateConfig) {
         const rowNodes = await this.adaptable.updateRows(dataRows, dataUpdateConfig);
         this.internalApi.fireGridDataChangedEvent(dataRows, rowNodes, 'Edit');
@@ -55,7 +76,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     undoCellEdit(cellDataChangedInfo) {
         // for the reason of this hacky solution see the comments in DataService
-        this.adaptable.api.internalApi.getDataService().logUndoChange(cellDataChangedInfo);
+        this.getAdaptableApi().internalApi.getDataService().logUndoChange(cellDataChangedInfo);
         const cellUpdateRequest = {
             columnId: cellDataChangedInfo.column.columnId,
             newValue: cellDataChangedInfo.oldValue,
@@ -75,7 +96,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     setCellValue(cellUpdateRequest) {
         var _a;
-        const abColumn = this.adaptable.api.columnApi.getColumnWithColumnId(cellUpdateRequest.columnId);
+        const abColumn = this.getAdaptableApi().columnApi.getColumnWithColumnId(cellUpdateRequest.columnId);
         if (!abColumn) {
             this.logWarn(`setCellValue() - column not found for columnId: ${cellUpdateRequest.columnId}`);
             return;
@@ -116,10 +137,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     clearGridFiltering() {
         // slightly round the houses but we have to call ColumnFilterAPI as it does it properly
-        this.adaptable.api.columnFilterApi.clearColumnFilters();
-    }
-    getAgGridInstance() {
-        return this.adaptable.gridOptions;
+        this.getAdaptableApi().columnFilterApi.clearColumnFilters();
     }
     getColumnSorts() {
         return this.getAdaptableState().Grid.ColumnSorts;
@@ -206,8 +224,8 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     selectCellRangeByQuery(query, gridCellRange, clearSelection) {
         const filteredRowNodes = [];
-        const isRowNodeInQuery = (rowNode) => this.adaptable.api.internalApi
-            .getQueryLanguageService()
+        const isRowNodeInQuery = (rowNode) => this.getAdaptableApi()
+            .internalApi.getQueryLanguageService()
             .evaluateBooleanExpression(query, 'GridInfo', rowNode);
         if (gridCellRange) {
             const [startNode, endNode] = this.getSelectionStartEndNodes(gridCellRange);
@@ -230,7 +248,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             /**
              * Select all rows and all columns
              */
-            const currentLayout = this.adaptable.api.layoutApi.getCurrentLayout();
+            const currentLayout = this.getAdaptableApi().layoutApi.getCurrentLayout();
             preapredGridCellRange = {
                 columnIds: currentLayout.Columns,
             };
@@ -266,7 +284,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         this.selectColumns([columnId]);
     }
     selectColumns(columnIds) {
-        this.adaptable.api.columnApi.selectColumns(columnIds);
+        this.getAdaptableApi().columnApi.selectColumns(columnIds);
     }
     getFirstRowNode() {
         return this.adaptable.getFirstRowNode();
@@ -275,7 +293,9 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         return this.adaptable.getFirstDisplayedRowNode();
     }
     getVisibleRowNodes(config) {
-        return this.adaptable.getVisibleRowNodes();
+        const rowNodes = [];
+        this.adaptable.forAllVisibleRowNodesDo((rowNode) => rowNodes.push(rowNode), config);
+        return rowNodes;
     }
     getAllRowNodes(config) {
         return this.adaptable.getAllRowNodes(config);
@@ -297,7 +317,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     getNormalisedValueFromRowNode(rowNode, columnId) {
         const rawValue = this.adaptable.getRawValueFromRowNode(rowNode, columnId);
-        const abColumn = this.adaptable.api.columnApi.getColumnWithColumnId(columnId);
+        const abColumn = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
         return this.adaptable.getNormalisedValueFromRawValue(rawValue, abColumn);
     }
     getRowNodesForPrimaryKeys(primaryKeyValues) {
@@ -334,17 +354,27 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         this.adaptable.expandRowGroupsForValues(columnValues);
     }
     isGridPivotable() {
-        return this.adaptable.isGridPivotable();
+        return !this.getAdaptableApi().internalApi.isGridInTreeMode();
     }
     isGridGroupable() {
-        return this.adaptable.isGridGroupable();
+        return !this.getAdaptableApi().internalApi.isGridInTreeMode();
     }
     isGridSelectable() {
-        return this.adaptable.isGridSelectable();
+        (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'GridApi', 'isGridSelectable', 'isGridRowSelectable');
+        return this.isGridRowSelectable();
+    }
+    isGridRowSelectable() {
+        return this.adaptable.isGridRowSelectable();
+    }
+    isGridRangeSelectable() {
+        return this.adaptable.isGridRangeSelectable();
     }
     isGridRowGrouped() {
         return this.adaptable.isGridGroupingActive();
     }
+    isGridInPivotMode() {
+        return this.getLayoutApi().isCurrentLayoutPivot();
+    }
     isGroupRowNode(rowNode) {
         return this.adaptable.isGroupRowNode(rowNode);
     }
@@ -353,7 +383,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     redrawGrid() {
         this.adaptable.redrawBody();
-        this.adaptable.redrawHeader();
+        this.adaptable.refreshHeader();
     }
     getGridCellsForRawValue(columnId, rawValue) {
         const gridCells = this.adaptable.getGridCellsForColumn(columnId);
@@ -456,7 +486,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     }
     refreshGroupRowNodes() {
         // see https://www.ag-grid.com/javascript-data-grid/client-side-row-stages/#refreshing-the-client-side-model
-        this.getAgGridInstance().api.refreshClientSideRowModel('group');
+        this.getAdaptableApi().agGridApi.refreshClientSideRowModel('group');
         this.adaptable.updateRowGroupsExpandedState();
     }
     isCellEditable(gridCell) {
@@ -483,9 +513,6 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     getRowCount() {
         return this.adaptable.getRowCount();
     }
-    getVisibleRowCount() {
-        return this.adaptable.getVisibleRowCount();
-    }
     getRowsInViewport() {
         return this.adaptable.getRowsInViewport();
     }
@@ -513,5 +540,33 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     getAgGridRowModelType() {
         return this.adaptable.getAgGridRowModelType();
     }
+    getVisibleRowCount() {
+        (0, logDeprecation_1.logDeprecation)(this.adaptable.logger, 'GridApi', 'getVisibleRowCount', 'getRowCount');
+        return this.getRowCount();
+    }
+    showTransposedView(transposeConfig = {}) {
+        var _a, _b, _c, _d, _e;
+        const transposedColumnId = (_a = transposeConfig.transposedColumnId) !== null && _a !== void 0 ? _a : this.getAdaptableApi().optionsApi.getPrimaryKey();
+        const hideTransposedColumn = (_b = transposeConfig.hideTransposedColumn) !== null && _b !== void 0 ? _b : true;
+        const visibleColumns = (_c = transposeConfig.visibleColumns) !== null && _c !== void 0 ? _c : false;
+        const visibleRows = (_d = transposeConfig.visibleRows) !== null && _d !== void 0 ? _d : false;
+        const autosize = (_e = transposeConfig.autosize) !== null && _e !== void 0 ? _e : true;
+        this.getAdaptableApi().internalApi.showPopupWindow({
+            id: windowFactory_1.WINDOW_SHOW_TRANSPOSED_VIEW,
+            factoryId: windowFactory_1.WINDOW_SHOW_TRANSPOSED_VIEW,
+            title: 'Transposed View',
+            icon: 'grid',
+            popupProps: {
+                transposedColumnId,
+                hideTransposedColumn,
+                visibleColumns,
+                visibleRows,
+                autosize,
+            },
+        });
+    }
+    getAllAgGridColumns() {
+        return this.adaptable.getAllGridColumns();
+    }
 }
 exports.GridApiImpl = GridApiImpl;

package/src/Api/Implementation/LayoutApiImpl.d.ts

@@ -9,12 +9,14 @@ import { LayoutInternalApi } from '../Internal/LayoutInternalApi';
 export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     internalApi: LayoutInternalApi;
     constructor(adaptable: IAdaptable);
+    isCurrentLayoutPivot(): boolean;
     getLayoutState(): LayoutState;
     shouldAutoSaveLayouts: () => boolean;
     getCurrentVisibleColumnIdsMap(): {
         [key: string]: boolean;
     };
     getCurrentVisibleColumnIds(): string[];
+    getCurrentRowGroupsColumnIds(): string[];
     setLayout(layoutName: string): void;
     getCurrentLayout(): Layout;
     getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
@@ -41,11 +43,6 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     removeColumnFromCurrentLayout(columnId: string): void;
     removeColumnFromAllLayouts(columnId: string): void;
     removeColumnFromLayout(columnId: string, layoutName: string): void;
-    getLayoutSupportedFeatures(): {
-        RowGroupedColumns: boolean;
-        AggregationColumns: boolean;
-        PivotColumns: boolean;
-        ColumnFilters: boolean;
-        ColumnSorts: boolean;
-    };
+    addColumnToLayout(columnId: string, layoutName: string): void;
+    addColumnToCurrentLayout(columnId: string): void;
 }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -22,6 +22,9 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
         };
         this.internalApi = new LayoutInternalApi_1.LayoutInternalApi(adaptable);
     }
+    isCurrentLayoutPivot() {
+        return this.getCurrentLayout().EnablePivot;
+    }
     getLayoutState() {
         return this.getAdaptableState().Layout;
     }
@@ -35,6 +38,9 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     getCurrentVisibleColumnIds() {
         return this.getCurrentLayout().Columns;
     }
+    getCurrentRowGroupsColumnIds() {
+        return this.getCurrentLayout().RowGroupedColumns;
+    }
     setLayout(layoutName) {
         if (StringExtensions_1.default.IsNotNullOrEmpty(layoutName) &&
             layoutName !== this.getCurrentLayoutName()) {
@@ -225,20 +231,20 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             }
         }
     }
-    getLayoutSupportedFeatures() {
-        const layoutSupportedFeatures = {
-            RowGroupedColumns: true,
-            AggregationColumns: true,
-            PivotColumns: true,
-            ColumnFilters: true,
-            ColumnSorts: true,
-        };
-        if (this.getGridApi().getAgGridRowModelType() === 'viewport') {
-            layoutSupportedFeatures.RowGroupedColumns = false;
-            layoutSupportedFeatures.AggregationColumns = false;
-            layoutSupportedFeatures.PivotColumns = false;
+    addColumnToLayout(columnId, layoutName) {
+        const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnId);
+        if (column) {
+            const layout = this.getLayoutByName(layoutName);
+            if (layout) {
+                if (!layout.Columns.includes(columnId)) {
+                    this.dispatchAction(LayoutRedux.LayoutAddColumn(layoutName, columnId));
+                    this.getAdaptableApi().columnApi.showColumn(columnId);
+                }
+            }
         }
-        return layoutSupportedFeatures;
+    }
+    addColumnToCurrentLayout(columnId) {
+        this.addColumnToLayout(columnId, this.getCurrentLayoutName());
     }
 }
 exports.LayoutApiImpl = LayoutApiImpl;

package/src/Api/Implementation/NoteApiImpl.d.ts

@@ -0,0 +1,18 @@
+import { ApiBase } from './ApiBase';
+import { NoteApi } from '../NoteApi';
+import { AdaptableNote, AdaptableNotes, NoteState } from '../../PredefinedConfig/NoteState';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { NoteInternalApi } from '../Internal/NoteInternalApi';
+import { CellAddress } from '../../types';
+export declare class NoteApiImpl extends ApiBase implements NoteApi {
+    internalApi: NoteInternalApi;
+    constructor(adaptable: IAdaptable);
+    addNote(noteStr: string, primaryKeyValue: any, columnId: string): void;
+    editNote(note: AdaptableNote): void;
+    updateNoteText(noteStr: string, note: AdaptableNote): void;
+    deleteNote(note: AdaptableNote): void;
+    getNoteState(): NoteState;
+    getAllNotes(): AdaptableNotes;
+    getNotesForCell(address: CellAddress): AdaptableNote[];
+    getNoteByUuid(uuid: string): AdaptableNote | undefined;
+}

package/src/Api/Implementation/NoteApiImpl.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteApiImpl = void 0;
+const tslib_1 = require("tslib");
+const ApiBase_1 = require("./ApiBase");
+const NoteRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/NoteRedux"));
+const NoteInternalApi_1 = require("../Internal/NoteInternalApi");
+class NoteApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new NoteInternalApi_1.NoteInternalApi(adaptable);
+    }
+    addNote(noteStr, primaryKeyValue, columnId) {
+        const note = {
+            Text: noteStr,
+            PrimaryKeyValue: primaryKeyValue,
+            ColumnId: columnId,
+            Timestamp: Date.now(),
+        };
+        this.dispatchAction(NoteRedux.NoteAdd(note));
+    }
+    editNote(note) {
+        note.Timestamp = Date.now();
+        this.dispatchAction(NoteRedux.NoteEdit(note));
+    }
+    updateNoteText(noteStr, note) {
+        this.editNote(Object.assign(Object.assign({}, note), { Text: noteStr }));
+    }
+    deleteNote(note) {
+        this.dispatchAction(NoteRedux.NoteDelete(note));
+    }
+    getNoteState() {
+        return this.getAdaptableState().Note;
+    }
+    getAllNotes() {
+        return this.getNoteState().Notes;
+    }
+    getNotesForCell(address) {
+        return NoteRedux.GetNotesSelector(this.getAdaptableState().Note, address);
+    }
+    getNoteByUuid(uuid) {
+        return this.getAllNotes().find((note) => note.Uuid === uuid);
+    }
+}
+exports.NoteApiImpl = NoteApiImpl;

package/src/Api/Implementation/OptionsApiImpl.d.ts

@@ -1,11 +1,11 @@
 import { ApiBase } from './ApiBase';
-import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, NotesOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, OptionsApi, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions, GridFilterOptions } from '../../types';
+import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, NoteOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, OptionsApi, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions, GridFilterOptions } from '../../types';
 import { GroupingOptions } from '../../AdaptableOptions/GroupingOptions';
 import { CustomSortOptions } from '../../AdaptableOptions/CustomSortOptions';
 import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
 import { ExpressionOptions } from '../../AdaptableOptions/ExpressionOptions';
 import { ColumnFilterOptions } from '../../AdaptableOptions/ColumnFilterOptions';
-import { CommentsOptions } from '../../AdaptableOptions/CommentsOptions';
+import { CommentOptions } from '../../AdaptableOptions/CommentOptions';
 export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
     getAdaptableId(): string;
     getAdaptableStateKey(): string;
@@ -19,8 +19,8 @@ export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
     getCellSummaryOptions(): CellSummaryOptions;
     getCalendarOptions(): CalendarOptions;
     getColumnOptions(): ColumnOptions;
-    getNotesOptions(): NotesOptions;
-    getCommentsOptions(): Readonly<CommentsOptions<any>>;
+    getNoteOptions(): NoteOptions;
+    getCommentOptions(): Readonly<CommentOptions<any>>;
     getCustomSortOptions(): CustomSortOptions;
     getContainerOptions(): ContainerOptions;
     getDataSetOptions(): DataSetOptions;

package/src/Api/Implementation/OptionsApiImpl.js

@@ -39,11 +39,11 @@ class OptionsApiImpl extends ApiBase_1.ApiBase {
     getColumnOptions() {
         return this.getOptions().columnOptions;
     }
-    getNotesOptions() {
-        return this.getOptions().notesOptions;
+    getNoteOptions() {
+        return this.getOptions().noteOptions;
     }
-    getCommentsOptions() {
-        return this.getOptions().commentsOptions;
+    getCommentOptions() {
+        return this.getOptions().commentOptions;
     }
     getCustomSortOptions() {
         return this.getOptions().customSortOptions;

package/src/Api/Implementation/PredicateApiImpl.js

@@ -75,9 +75,9 @@ class PredicateApiImpl extends ApiBase_1.ApiBase {
         if (!predicate.ColumnId) {
             return this.handlePredicate(predicate, context, defaultReturn);
         }
-        const paramsForColumn = Object.assign(Object.assign({}, context), { column: this.adaptable.api.columnApi.getColumnWithColumnId(predicate.ColumnId), 
+        const paramsForColumn = Object.assign(Object.assign({}, context), { column: this.getAdaptableApi().columnApi.getColumnWithColumnId(predicate.ColumnId), 
             // value: params?.node?.data?.[predicate.ColumnId],
-            value: this.adaptable.api.gridApi.getRawValueFromRowNode(context.node, predicate.ColumnId) });
+            value: this.getAdaptableApi().gridApi.getRawValueFromRowNode(context.node, predicate.ColumnId) });
         if ('oldValue' in paramsForColumn) {
             delete paramsForColumn.oldValue;
         }

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -56,7 +56,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
     }
     getReportSchedules(config) {
         var _a;
-        return ((_a = this.handleLayoutAssociatedObjects(this.adaptable.api.exportApi.getReportSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
+        return ((_a = this.handleLayoutAssociatedObjects(this.getAdaptableApi().exportApi.getReportSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
     }
     getActiveReportSchedules() {
         return this.getReportSchedules().filter((schedule) => !schedule.IsSuspended);
@@ -85,7 +85,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
     }
     getIPushPullSchedules(config) {
         var _a;
-        const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
+        const ippApi = this.getAdaptableApi().pluginsApi.getipushpullPluginApi();
         return ((_a = this.handleLayoutAssociatedObjects(ippApi === null || ippApi === void 0 ? void 0 : ippApi.getIPushPullSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
     }
     getActiveIPushPullSchedules() {
@@ -115,7 +115,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
     }
     getOpenFinSchedules(config) {
         var _a;
-        const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
+        const openFinApi = this.getAdaptableApi().pluginsApi.getOpenFinPluginApi();
         return ((_a = this.handleLayoutAssociatedObjects(openFinApi === null || openFinApi === void 0 ? void 0 : openFinApi.getOpenFinSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
     }
     getActiveOpenFinSchedules() {
@@ -167,10 +167,10 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         }
         else if (scheduleType == 'Report') {
             const reportSchedule = schedule;
-            this.adaptable.api.exportApi.runReport(reportSchedule.ReportName, reportSchedule.ExportDestination);
+            this.getAdaptableApi().exportApi.runReport(reportSchedule.ReportName, reportSchedule.ExportDestination);
         }
         else if (scheduleType == 'ipushpull') {
-            const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
+            const ippApi = this.getAdaptableApi().pluginsApi.getipushpullPluginApi();
             const iPushPullSchedule = schedule;
             if (iPushPullSchedule.Transmission == 'Snapshot') {
                 ippApi.sendSnapshot(iPushPullSchedule.IPushPullReport);
@@ -180,7 +180,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
             }
         }
         else if (scheduleType == 'OpenFin') {
-            const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
+            const openFinApi = this.getAdaptableApi().pluginsApi.getOpenFinPluginApi();
             const openFinSchedule = schedule;
             openFinApi.startLiveData(openFinSchedule.OpenFinReport);
         }