@adaptabletools/adaptable 24.0.0-canary.8 → 24.0.0

package/src/Api/GridApi.d.ts

@@ -15,49 +15,62 @@ import { AdaptableVariant } from '../AdaptableInterfaces/IAdaptable';
 import { InternalState } from '../AdaptableState/InternalState';
 import { ColumnHighlightInfo } from '../AdaptableState/Common/ColumnHighlightInfo';
 /**
- * Provides access to important properties and functionalities of AdapTable e.g. sorting, selected cells etc.
+ * Grid data and selection.
+ *
+ * Rows and cell values (raw, display and normalised), loading and editing data,
+ * filtering and sorting, the current selection, and row nodes. Prefer these
+ * methods to calling AG Grid directly when AdapTable wraps the behaviour.
  */
 export interface GridApi {
     /**
      * Returns current AdapTable Variant: vanilla, angular, react, vue
+     * @returns Current AdapTable Variant: vanilla, angular, react, vue
      */
     getVariant(): AdaptableVariant;
     /**
      * Returns the Internal section from AdapTable State
+     * @returns The Internal section from AdapTable State
      */
     getInternalState(): InternalState;
     /**
      * Retrieves all data from the grid
+     * @returns All data from the grid
      */
     getGridData(): any[];
     /**
      * Retrieves filtered data from the grid
+     * @returns Filtered data from the grid
      */
     getFilteredData(): any[];
     /**
      * Retrieves visible data from the grid (filtered and sorted from visible columns only)
+     * @returns Visible data from the grid (filtered and sorted from visible columns only)
      */
     getVisibleData(): any[];
     /**
      * Retrieves the displayed (formatted but not styled) data from the grid (filtered and sorted and visible columns only)
+     * @returns The displayed (formatted but not styled) data from the grid (filtered and sorted and visible columns only)
      */
     getDisplayedData(): any[];
     /**
      * Retrieves all the values for a single Column.
      *
      * @param columnId the Column to read the values from
+     * @returns All the values for a single Column
      */
     getColumnData(columnId: string): any[];
     /**
      * Retrieves the filtered values for a single Column.
      *
      * @param columnId the Column to read the values from
+     * @returns The filtered values for a single Column
      */
     getFilteredColumnData(columnId: string): any[];
     /**
      * Retrieves the visible (filtered and sorted) values for a single Column.
      *
      * @param columnId the Column to read the values from
+     * @returns The visible (filtered and sorted) values for a single Column
      */
     getVisibleColumnData(columnId: string): any[];
     /**
@@ -69,6 +82,7 @@ export interface GridApi {
      * Returns an empty array if the Column is unknown.
      *
      * @param columnId the Column to read the values from
+     * @returns The distinct raw values currently in a Column, sorted. Useful when building dropdown options (e.g. Action Column `select`, Forms) from values that already exist in the Grid. Returns an empty array if the Column is unknown
      */
     getDistinctColumnValues(columnId: string): any[];
     /**
@@ -80,12 +94,14 @@ export interface GridApi {
      * Updates AdapTable (and AG Grid) with rows that have changed
      * @param dataRows rows which have been updated - send whole row and AdapTable take cares of the rest
      * @param config batch option and callback function to run post update
+     * @returns The row nodes that were updated
      */
     updateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
      * Adds or Updates AdapTable (and AG Grid) with new and changed rows
      * @param dataRows rows to add or update
      * @param config batch option and callback function to run post change
+     * @returns The row nodes that were added and the row nodes that were updated
      */
     addOrUpdateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<{
         addedRows: IRowNode[];
@@ -95,18 +111,21 @@ export interface GridApi {
      * Adds rows to AdapTable (and AG Grid)
      * @param dataRows rows to add; ensure all 'mandatory' fields are included and Primary Key is unique
      * @param config batch option and callback function to run post addition
+     * @returns The row nodes that were added
      */
     addGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
      * Deletes rows from AdapTable (and AG Grid)
      * @param dataRows rows which should be deleted
      * @param config batch option and callback function to run post deletion
+     * @returns The row nodes that were deleted. Empty when no rows were passed
      */
     deleteGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
      * Adds, Updates or Deletes rows in AdapTable (and AG Grid) in single transaction
      * @param dataRowConfig - Rows to add, update or remove
      * @param dataUpdateConfig - batch option and callback function to run post transaction
+     * @returns The row nodes that were added, updated and removed
      */
     manageGridData(dataRowConfig: DataRowConfig, dataUpdateConfig?: DataUpdateConfig): Promise<{
         addedRows: IRowNode[];
@@ -121,32 +140,39 @@ export interface GridApi {
     setCellValue(cellUpdateRequest: CellUpdateRequest): void;
     /**
      * Updates multiple cells
+     * @param cellUpdateRequests Cells to write, each with a column, row and new value
      */
     setCellValues(cellUpdateRequests: CellUpdateRequest[]): void;
     /**
      * Reverses a data change (if triggered by cell edit)
      * @param cellDataChangedInfo data change to undo
+     * @returns `true` once the previous cell value has been written back
      */
     undoCellEdit(cellDataChangedInfo: CellDataChangedInfo): boolean;
     /**
      * Returns summary info on Selected Cells
+     * @returns Summary info on Selected Cells
      */
     getCellSummaryInfo(): CellSummmaryInfo;
     /**
      * Returns all current Selected Cells in AdapTable
+     * @returns All current Selected Cells in AdapTable
      */
     getSelectedCellInfo(): SelectedCellInfo;
     /**
      * Returns all current Selected Rows in AdapTable
+     * @returns All current Selected Rows in AdapTable
      */
     getSelectedRowInfo(): SelectedRowInfo;
     /**
      * Returns Column Sort information in AdapTable
+     * @returns Column Sort information in AdapTable
      */
     getColumnSorts(): ColumnSort[];
     /**
      * Retrieves ColumnSort for a given Column
      * @param columnId Id of Column to retrieve ColumnSort
+     * @returns ColumnSort for a given Column. `undefined` when there is no match
      */
     getColumnSortForColumn(columnId: string): ColumnSort | undefined;
     /**
@@ -240,15 +266,18 @@ export interface GridApi {
     selectCellRangeByQuery(query: string, gridCellRange?: GridCellRange, clearSelection?: boolean): void;
     /**
      * Retrieves the first Row Node in AdapTable
+     * @returns The first Row Node in AdapTable. `undefined` when there is no match
      */
     getFirstRowNode(): IRowNode | undefined;
     /**
      * Retrieves the first Displayed Row Node in AdapTable
+     * @returns The first Displayed Row Node in AdapTable. `undefined` when there is no match
      */
     getFirstDisplayedRowNode(): IRowNode | undefined;
     /**
      * Retrieves all filtered Row Nodes currently in the Grid (i.e. after applying the current filter)
      * @param config - configuration
+     * @returns All filtered Row Nodes currently in the Grid (i.e. after applying the current filter)
      */
     getVisibleRowNodes(config?: {
         includeGroupRows?: boolean;
@@ -257,6 +286,7 @@ export interface GridApi {
     /**
      * Retrieves all Row Nodes currently in the Grid (by default excluding the group rows)
      * @param config - configuration
+     * @returns All Row Nodes currently in the Grid (by default excluding the group rows)
      */
     getAllRowNodes(config?: {
         includeGroupRows?: boolean;
@@ -265,81 +295,95 @@ export interface GridApi {
     /**
      * Retrieves all Grouped Row Nodes currently in the Grid
      * @param config - configuration
+     * @returns All Grouped Row Nodes currently in the Grid
      */
     getGroupRowNodes(config?: {
         filterFn?(rowNode: IRowNode): boolean;
     }): IRowNode[];
     /**
      * Retrieves Row Nodes that contain given Primary Keys
-     * @param primaryKeyValues Primary Kev Values to look up
+     * @param primaryKeyValues Primary Key Values to look up
+     * @returns Row Nodes that contain given Primary Keys
      */
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): IRowNode[];
     /**
      * Retrieves Row Node that contains given Primary Key
      * @param primaryKeyValue Primary Key Value to look up
+     * @returns Row Node that contains given Primary Key
      */
     getRowNodeForPrimaryKey(primaryKeyValue: any): IRowNode;
     /**
      * Retrieves the displayed RowNode at the given index
      * @param rowIndex row index
+     * @returns The displayed RowNode at the given index. `undefined` when there is no match
      */
     getRowNodeForIndex(rowIndex: number): IRowNode | undefined;
     /**
-     * Returns the Primary Kev Value for a given Row Node
+     * Returns the Primary Key Value for a given Row Node
      * @param rowNode rowNode to look up
+     * @returns The Primary Key Value for a given Row Node
      */
     getPrimaryKeyValueForRowNode(rowNode: IRowNode): any;
     /**
-     * Returns the Primary Kev Values for a given Row Node collection
-     * @param rowNode rowNodes to look up
+     * Returns the Primary Key Values for a given Row Node collection
+     * @param rowNodes Row nodes to look up
+     * @returns The Primary Key Values for a given Row Node collection
      */
     getPrimaryKeyValuesForRowNodes(rowNodes: IRowNode[]): any[];
     /**
      * Retrieves Cell in given Row and Column
      * @param rowNode Row to use
      * @param columnId ColumnId to lookup
+     * @returns Cell in given Row and Column. `undefined` when there is no match
      */
     getGridCellFromRowNode(rowNode: IRowNode, columnId: string): GridCell | undefined;
     /**
      * Retrieves Display Value for a given cell
      * @param primaryKeyValue (unique) value in Primary Key Column
      * @param columnId name of Column which contains the cell
+     * @returns Display Value for a given cell. `undefined` when there is no match
      */
     getCellDisplayValue(primaryKeyValue: any, columnId: string): any | undefined;
     /**
      * Retrieves Raw Value for a given cell
      * @param primaryKeyValue (unique) value in Primary Key Column
      * @param columnId name of Column which contains the cell
+     * @returns Raw Value for a given cell. `undefined` when there is no match
      */
     getCellRawValue(primaryKeyValue: any, columnId: string): any | undefined;
     /**
      * Retrieves Normalised Value for a given cell
      * @param primaryKeyValue (unique) value in Primary Key Column
      * @param columnId name of Column which contains the cell
+     * @returns Normalised Value for a given cell. `undefined` when there is no match
      */
     getCellNormalisedValue(primaryKeyValue: any, columnId: string): any | undefined;
     /**
      * Retrieves Raw Value for Cell in given Row and Column
      * @param rowNode Row to use
      * @param columnId ColumnId to lookup
+     * @returns Raw Value for Cell in given Row and Column. `undefined` when there is no match
      */
     getRawValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;
     /**
      * Returns all the Grid Cells in a Column that have the given Raw Value
      * @param columnId ColumnId to lookup
      * @param rawValue Raw Value to use
+     * @returns Cells whose raw value matches. `undefined` when the column is unknown; an empty array when no cell has that value
      */
     getGridCellsForRawValue(columnId: string, rawValue: any): GridCell[] | undefined;
     /**
      * Gets the count of the cells in a Column that have the given Raw Value
      * @param columnId ColumnId to lookup
      * @param rawValue Raw Value to use
+     * @returns How many cells in the column have that raw value
      */
     getCellRawValueCount(columnId: string, rawValue: any): number;
     /**
      * Returns all the Grid Cells in a Column that have the given Display Value
      * @param columnId ColumnId to lookup
      * @param displayValue Display Value to use
+     * @returns Cells whose display value matches. `undefined` when the column is unknown; an empty array when no cell has that value
      */
     getGridCellsForDisplayValue(columnId: string, displayValue: any): GridCell[] | undefined;
     /**
@@ -347,18 +391,21 @@ export interface GridApi {
      * @param columnId ColumnId to lookup
      * @param rawValue Raw Value
      * @param rowNode Node containig the Column
+     * @returns Formatted Value for a given Raw Value in given Column. `undefined` when there is no match
      */
     getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
     /**
      * Retrieves Display Value for Cell in given Row and Column
      * @param rowNode Row to use
      * @param columnId ColumnId to lookup
+     * @returns Display Value for Cell in given Row and Column. `undefined` when there is no match
      */
     getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;
     /**
      * Retrieves Normalised Value for Cell in given Row and Column
      * @param rowNode Row to use
      * @param columnId ColumnId to lookup
+     * @returns Normalised Value for Cell in given Row and Column. `undefined` when there is no match
      */
     getNormalisedValueFromRowNode(rowNode: IRowNode, columnId: string): any | undefined;
     /**
@@ -385,63 +432,77 @@ export interface GridApi {
     expandRowGroupsForValues(columnValues: any[]): void;
     /**
      * Whether AdapTable instance can be pivoted
+     * @returns `true` when AdapTable instance can be pivoted
      */
     isGridPivotable(): boolean;
     /**
      * Whether AdapTable instance can be Row Grouped
+     * @returns `true` when AdapTable instance can be Row Grouped
      */
     isGridGroupable(): boolean;
     /**
      * Whether AdapTable instance offers row selection
+     * @returns `true` when AdapTable instance offers row selection
      */
     isGridRowSelectable(): boolean;
     /**
      * Whether a Row is selected
      * @param primaryKeyValue pkVaue of Row to check
+     * @returns `true` when a Row is selected
      */
     isGridRowSelected(primaryKeyValue: any): boolean;
     /**
      * Whether AdapTable instance offers cell range selection
+     * @returns `true` when AdapTable instance offers cell range selection
      */
     isGridRangeSelectable(): boolean;
     /**
      * Whether Grid is currently showing Row Groups
+     * @returns `true` when Grid is currently showing Row Groups
      */
     isGridRowGrouped(): boolean;
     /**
      * Whether Grid is currently in Pivot Mode
+     * @returns `true` when Grid is currently in Pivot Mode
      */
     isGridInPivotMode(): boolean;
     /**
      * Whether Grid displays a Tree Data  (structured hierarchical data)
+     * @returns `true` when Grid displays a Tree Data (structured hierarchical data)
      */
     isTreeDataGrid(): boolean;
     /**
      * Whether Grid is a Master Detail Grid
+     * @returns `true` when Grid is a Master Detail Grid
      */
     isMasterDetailGrid(): boolean;
     /**
      * Whether given Row Node is a Row Group
      * @param rowNode Node to check
+     * @returns `true` when given Row Node is a Row Group
      */
     isGroupRowNode(rowNode: IRowNode): boolean;
     /**
      * Whether given Row Node is a Grand Total Row
      * @param rowNode Node to check
+     * @returns `true` when given Row Node is a Grand Total Row
      */
     isGrandTotalRowNode(rowNode: IRowNode): boolean;
     /**
      * Whether given Row Node is visible
      * @param rowNode Node to check
+     * @returns `true` when given Row Node is visible
      */
     isVisibleRowNode(rowNode: IRowNode): boolean;
     /**
      * Whether given Row Node is in a Summary Row
      * @param rowNode Node to check
+     * @returns `true` when given Row Node is in a Summary Row
      */
     isSummaryNode(rowNode: IRowNode): boolean;
     /**
      * Whether Quick Filter is available in the Grid
+     * @returns `true` when Quick Filter is available in the Grid
      */
     isQuickFilterAvailable(): boolean;
     /**
@@ -449,7 +510,7 @@ export interface GridApi {
      */
     redrawGrid(): void;
     /**
-     * Grid will jump to Row containing given Primary Kev Value
+     * Grid will jump to Row containing given Primary Key Value
      * @param primaryKeyValue value in Primary Key Column
      */
     jumpToRow(primaryKeyValue: any): void;
@@ -501,7 +562,7 @@ export interface GridApi {
     highlightRow(rowHighlightInfo: RowHighlightInfo): void;
     /**
      * Highlight rows using an adaptable style
-     * @param rowHighlightInfo highlight instructions
+     * @param rowsHighlightInfo Rows to highlight and the style to apply
      */
     highlightRows(rowsHighlightInfo: RowsHighlightInfo): void;
     /**
@@ -532,12 +593,14 @@ export interface GridApi {
      * Refresh a Cell Value in AdapTable
      * @param rowNode AG Grid RowNode which contains cell to refresh
      * @param columnId ColumnId which contains cell to refresh
+     * @param suppressFlash When `true`, the cell refreshes without flashing
      */
     refreshCell(rowNode: IRowNode, columnId: string, suppressFlash?: boolean): void;
     /**
      * Refresh Cell Values in AdapTable
      * @param rowNode agGrid RowNode which contains cells to refresh
      * @param columnIds ColumnIds which contain cells to refresh
+     * @param suppressFlash When `true`, the cells refresh without flashing
      */
     refreshCells(rowNode: IRowNode, columnIds: string[], suppressFlash?: boolean): void;
     /**
@@ -579,34 +642,41 @@ export interface GridApi {
      */
     refreshGroupRowNodes(): void;
     /**
-     * Returns number of rows in Data Source
+     * Number of data rows, excluding group rows.
+     * @returns Number of data rows, excluding group rows
      */
     getRowCount(): number;
     /**
-     * Returns number of rows in Data Source
+     * Number of rows currently displayed, after filtering.
+     * @returns Number of rows currently displayed, after filtering
      */
     getVisibleRowCount(): number;
     /**
-     * Returns number of columns in Data Source
+     * Number of columns in the grid, including hidden columns.
+     * @returns Number of columns in the grid, including hidden columns
      */
     getColumnCount(): number;
     /**
-     * Returns number of visible columns in Data Source
+     * Number of columns that are currently visible.
+     * @returns Number of columns that are currently visible
      */
     getVisibleColumnCount(): number;
     /**
      * Checks if given Grid Cell is editable
      * @param gridCell Cell to check
+     * @returns `true` when given Grid Cell is editable
      */
     isCellEditable(gridCell: GridCell): boolean;
     /**
      * Checks if given Grid Cell has been edited (uses Data Change History)
      * @param gridCell Cell to check
+     * @returns `true` when given Grid Cell has been edited (uses Data Change History)
      */
     isCellEdited(gridCell: GridCell): boolean;
     /**
      * Checks if all of given Grid Cells are editable
      * @param gridCells cells to check
+     * @returns `true` when all of given Grid Cells are editable
      */
     isEveryCellEditable(gridCells: GridCell[]): boolean;
     /**
@@ -619,6 +689,7 @@ export interface GridApi {
     deselectAll(): void;
     /**
      * Returns the Grid Container in which the AdapTable Instance is present
+     * @returns The Grid Container in which the AdapTable Instance is present
      */
     getGridContainerElement(): HTMLElement | null;
     /**
@@ -627,10 +698,12 @@ export interface GridApi {
     openGridInfoSettingsPanel(): void;
     /**
      * Returns AG Grid Row Model Type
+     * @returns AG Grid Row Model Type
      */
     getAgGridRowModelType(): RowModelType;
     /**
-     * Opens a window with a transposed view of Grid
+     * Opens a window with a transposed view of the grid.
+     * @param transposeConfig Which column, columns and rows to transpose. Omit it to transpose every column, using the primary key column
      */
     showTransposedView(transposeConfig?: TransposeConfig): void;
     /**
@@ -639,6 +712,7 @@ export interface GridApi {
     closeTransposedView(): void;
     /**
      * Return all AG Grid columns
+     * @returns Every AG Grid column, including hidden columns
      */
     getAllAgGridColumns(): Column<any>[];
     /**
@@ -652,19 +726,18 @@ export interface GridApi {
      */
     updateAgGridColumnStates(columnStates: ColumnState[]): void;
     /**
-     * Sets the Column Definitions for the Grid
+     * Replaces the grid's column definitions.
+     * @param columnDefinitions Column definitions to set
      */
     setAgGridColumnDefinitions(columnDefinitions: (ColDef | ColGroupDef)[]): void;
     /**
-     * Updates Column Definition for given Column; use to update NON-STATEFUL AG Grid Column props (which are merged with existing Column Def)
-     * @param columnId - the ColumnId to update
-     * @param columnDefinition - the new Column Definition
+     * Merges non-stateful AG Grid column properties into an existing column definition. The column is matched by `colId`. A column that does not exist yet is added.
+     * @param columnDefinition Column definition to merge. `colId` is required
      */
     updateAgGridColumnDefinition(columnDefinition: ColDefWithId): void;
     /**
-     * Updates Column Definition for given Columns; use to update NON-STATEFUL AG Grid Column props (which are merged with existing Column Def)
-     * @param columnId - the ColumnId to update
-     * @param columnDefinition - the new Column Definition
+     * Merges non-stateful AG Grid column properties into the given column definitions. Each column is matched by `colId`.
+     * @param columnDefinitions Column definitions to merge. Each `colId` is required
      */
     updateAgGridColumnDefinitions(columnDefinitions: ColDefWithId[]): void;
     /**

package/src/Api/IPushPullApi.d.ts

@@ -1,31 +1,37 @@
 import { IPushPullReport } from '../AdaptableState/InternalState';
 import { IPushPullDomain } from '../AdaptableState/IPushPullState';
 /**
- * Provides run-time access to ipushpull Plugin
+ * The ipushpull plugin: login, the current report, and sending a snapshot or live data.
  */
 export interface IPushPullApi {
     /**
      * Retrieves `Username` from ipushpull state - AFTER someone logs in
+     * @returns `Username` from ipushpull state - AFTER someone logs in
      */
     getCurrentIPushPullUsername(): string | undefined;
     /**
      * Retrieves `Password` from ipushpull state -- AFTER someone logs in
+     * @returns `Password` from ipushpull state -- AFTER someone logs in
      */
     getCurrentIPushPullPassword(): string | undefined;
     /**
      * Retrieves `Username` from ipushpull options (if provided)
+     * @returns `Username` from ipushpull options (if provided)
      */
     getIPushPullUsername(): string | undefined;
     /**
      * Retrieves `Password` from ipushpull options (if provided)
+     * @returns `Password` from ipushpull options (if provided)
      */
     getIPushPullPassword(): string | undefined;
     /**
      * Retrieves `AutoLogin` from ipushpull options; if `true` AdapTable will automatically log user in to ipushpull at start-up
+     * @returns `AutoLogin` from ipushpull options; if `true` AdapTable will automatically log user in to ipushpull at start-up
      */
     getAutoLogin(): boolean;
     /**
      * Retrieves current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page
+     * @returns Current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page
      */
     getCurrentLiveIPushPullReport(): IPushPullReport | undefined;
     /**
@@ -50,10 +56,12 @@ export interface IPushPullApi {
     stopLiveData(): void;
     /**
      * Retrieves the current ipushpull instance (if one has been provided by the User at design time in ipushpull state)
+     * @returns The current ipushpull instance (if one has been provided by the User at design time in ipushpull state)
      */
     getIPushPullInstance(): any;
     /**
-     * Sets the current ipushpull instance - this method should not generally be used.
+     * Replaces the ipushpull instance AdapTable is using. Prefer the login methods.
+     * @param ippInstance ipushpull instance to use
      */
     setIPushPullInstance(ippInstance: any): void;
     /**
@@ -66,17 +74,20 @@ export interface IPushPullApi {
      * - **FolderId**: the number of the Domain / Folder
      *
      * - **Pages**: a string array containing the names of all the Pages in the Folder
+     * @returns All the ipushpull domain to which the current user has access An `IPushPullDomain` contains 3 properties: - **Name**: the name of the Domain / Folder - **FolderId**: the number of the Domain / Folder - **Pages**: a string array containing the names of all the Pages in the Folder
      */
     getIPushPullDomains(): IPushPullDomain[];
     /**
      * Retrieves all pages in given ipushpull domain
      * @param domain ipushpull folder which contains the pages
+     * @returns All pages in given ipushpull domain
      */
     getPagesForIPushPullDomain(domain: string): string[];
     /**
      * Gets the Id of the ipushpull folder / Domain with the given name
      *
      * @param folderName the ipushpull folder name
+     * @returns The Id of the ipushpull folder / Domain with the given name
      */
     getFolderIdForName(folderName: string): number;
     /**
@@ -87,6 +98,7 @@ export interface IPushPullApi {
     addNewIPushPullPage(folder: string, page: string): void;
     /**
      * Retrieves Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes)
+     * @returns Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes)
      */
     getIPushPullThrottleTime(): number | undefined;
     /**
@@ -99,6 +111,7 @@ export interface IPushPullApi {
      * Checks if given report is currently 'live' (i.e. sending updates as data changes)
      *
      * @param report the report to check
+     * @returns `true` when given report is currently 'live' (i.e. sending updates as data changes)
      */
     isIPushPullReportLive(report: IPushPullReport): boolean;
     /**
@@ -125,18 +138,22 @@ export interface IPushPullApi {
     logoutFromIPushPull(): void;
     /**
      * Checks if an ipushpull instance has been provided by the user
+     * @returns `true` when an ipushpull instance has been provided by the user
      */
     isIPushPullAvailable(): boolean | undefined;
     /**
      * Checks to see if ipushpull is running (i.e. a user has successfully logged in)
+     * @returns `true` when a user is logged in to ipushpull
      */
     isIPushPullRunning(): boolean | undefined;
     /**
      * Checks if a report is sending Live Data to ipushpull
+     * @returns `true` when a report is sending Live Data to ipushpull
      */
     isIPushPullLiveDataRunning(): boolean | undefined;
     /**
      * Whether to display System Reports in ipushpull toolbar
+     * @returns `true` when to display System Reports in ipushpull toolbar
      */
     includeSystemReports(): boolean;
 }

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

@@ -1,7 +1,7 @@
 import { IRowNode } from 'ag-grid-enterprise';
 import * as Redux from 'redux';
 import { CellDataChangedInfo } from '../../AdaptableState/Common/CellDataChangedInfo';
-import { AdaptableAlert, AdaptableFlashingCell, AdaptablePersistentState, AdaptableSharedEntity, AdaptableState, AdaptableTheme, CalculatedColumn, AdaptableNote, NoteChangedAction, ColumnFilterChangedInfo, CreatedRowInfo, DashboardState, DataImportedInfo, DataSet, DeletedRowInfo, EditedRowInfo, LayoutState, RowDataChangedInfo, ReportSchedule, SystemStatusMessageInfo } from '../../types';
+import { AdaptableAlert, AdaptableFlashingCell, AdaptablePersistentState, AdaptableSharedEntity, AdaptableState, AdaptableTheme, CalculatedColumn, CommentThread, AdaptableNote, NoteChangedAction, ColumnFilterChangedInfo, CreatedRowInfo, DashboardState, DataImportedInfo, DataSet, DeletedRowInfo, EditedRowInfo, LayoutState, RowDataChangedInfo, ReportSchedule, SystemStatusMessageInfo } from '../../types';
 import { SystemThemeName } from '../../AdaptableState/ThemeState';
 import { ApiBase } from '../Implementation/ApiBase';
 import { LayoutChangedAction } from '../Events/LayoutChanged';
@@ -10,6 +10,7 @@ export declare class EventInternalApi extends ApiBase {
     fireCellChangedEvent(cellDataChangedInfo: CellDataChangedInfo): void;
     fireRowChangedEvent(rowDataChangedInfo: RowDataChangedInfo): void;
     fireDashboardChangedEvent(trigger: string, oldDashboardState: DashboardState, newDashboardState: DashboardState): void;
+    fireCommentChangedEvent(commentThreads: CommentThread[]): void;
     fireAlertFiredEvent(alertToFire: AdaptableAlert): void;
     fireThemeSelectedEvent(theme: SystemThemeName): void;
     fireThemeChangedEvent(theme: AdaptableTheme, trigger: 'ThemeSelected' | 'ThemeEdited'): void;

package/src/Api/Internal/EventInternalApi.js

@@ -68,6 +68,13 @@ export class EventInternalApi extends ApiBase {
             });
         }
     }
+    fireCommentChangedEvent(commentThreads) {
+        const commentChangedInfo = {
+            commentThreads: commentThreads ?? [],
+            ...this.getAdaptableInternalApi().buildBaseContext(),
+        };
+        this.getEventApi().emit('CommentChanged', commentChangedInfo);
+    }
     fireAlertFiredEvent(alertToFire) {
         const alertFiredInfo = {
             alert: alertToFire,

package/src/Api/InteropioPluginApi.d.ts

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