@adaptabletools/adaptable 24.0.0-canary.8 → 24.0.0

package/src/Api/SmartEditApi.d.ts

@@ -2,7 +2,7 @@ import { SmartEditOperation } from '../AdaptableOptions/EditOptions';
 import { MathOperation } from '../AdaptableState/Common/Enums';
 import { SmartEditCustomOperation } from '../types';
 /**
- * Provides run-time access to the Smart Edit Module
+ * Smart Edit: one change applied to every selected cell.
  **/
 export interface SmartEditApi {
     /**
@@ -17,6 +17,7 @@ export interface SmartEditApi {
     setCustomSmartEditOperation(customOperationName: string): void;
     /**
      * Gets current Smart Edit Operation
+     * @returns Current Smart Edit Operation
      */
     getSmartEditOperation(): SmartEditOperation;
     /**
@@ -26,6 +27,7 @@ export interface SmartEditApi {
     setSmartEditValue(smartEditValue: number): void;
     /**
      * Returns current Smart Edit Value
+     * @returns Current Smart Edit Value
      */
     getSmartEditValue(): number;
     /**
@@ -34,6 +36,7 @@ export interface SmartEditApi {
     openSmartEditSettingsPanel(): void;
     /**
      * Retrieves an Smart Edit Custom Operations (provided in Edit Options)
+     * @returns An Smart Edit Custom Operations (provided in Edit Options)
      */
     getSmartEditCustomOperations(): SmartEditCustomOperation[];
 }

package/src/Api/StateApi.d.ts

@@ -17,7 +17,7 @@ import { ToolPanelState } from '../AdaptableState/ToolPanelState';
 import { AdaptableModule, AdaptableStateKey } from '../AdaptableState/Common/Types';
 import { AdaptableFilterState, AdaptableSortState, ChartingState, FlashingCellState, InitialState, NamedQueryState, NoteState, StatusBarState, StyledColumnState } from '../types';
 /**
- * Range of functions to access Initial and Full Adaptable State
+ * Adaptable State: the initial state, the full state, the persisted user state, and each module's section.
  */
 export interface StateApi {
     /**
@@ -35,6 +35,7 @@ export interface StateApi {
     }): Promise<void>;
     /**
      * Returns the Initial Adaptable State
+     * @returns The Initial Adaptable State
      */
     getInitialState(): InitialState | any;
     /**
@@ -72,40 +73,47 @@ export interface StateApi {
     copyUserStateToClipboard(): void;
     /**
      * Loads supplied user state, replacing (NOT merging) existing User(persisted) State.
-     * @param state
+     * @param state User state to load. Replaces the persisted state. It is not merged with it
      */
     loadUserState(state: InitialState): Promise<void>;
     /**
      * Retrieves ALL state which is currently stored by Adaptable (both persistent and transient/internal)
+     * @returns ALL state which is currently stored by Adaptable (both persistent and transient/internal)
      */
     getAllState(): AdaptableState;
     /**
     * Retrieves the persistent state in Adaptable, i.e. state that is passed to the `StateOptions.persistState()` function.
     *
+    * @returns The persistent state in Adaptable, i.e. state that is passed to the `StateOptions.persistState()` function
     */
     getPersistentState(): AdaptablePersistentState;
     /**
      * Gets filter-related sections of Adaptable State
+     * @returns Filter-related sections of Adaptable State
      */
     getAdaptableFilterState(): AdaptableFilterState;
     /**
      * Gets sort-related sections of Adaptable State
+     * @returns Sort-related sections of Adaptable State
      */
     getAdaptableSortState(): AdaptableSortState;
     /**
      * Retrieves a brief description of an AdapTable Module
      * @param adaptableModule Adaptable Module to get description for
+     * @returns A brief description of an AdapTable Module
      */
     getDescriptionForModule(adaptableModule: AdaptableModule): string;
     /**
      * Retrieves the help page for an AdapTable Module
      * @param adaptableModule Adaptable Module to get help page for
+     * @returns The help page for an AdapTable Module
      */
     getHelpPageForModule(adaptableModule: AdaptableModule): string;
     /**
      * Returns given section of Adaptable State (as JSON or object)
      * @param stateKey section of State to return
      * @param returnJson whether to return section as JSON or object
+     * @returns Given section of Adaptable State (as JSON or object)
      */
     getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): BaseState | string;
     /**
@@ -116,101 +124,121 @@ export interface StateApi {
     /**
      * Returns Alert section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Alert section of Adaptable State
      */
     getAlertState(returnJson?: boolean): AlertState;
     /**
      * Returns Application section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Application section of Adaptable State
      */
     getApplicationState(returnJson?: boolean): ApplicationState;
     /**
      * Returns Calculated Column section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Calculated Column section of Adaptable State
      */
     getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;
     /**
      * Returns Charting section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Charting section of Adaptable State
      */
     getChartingState(returnJson?: boolean): ChartingState;
     /**
      * Returns Note section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Note section of Adaptable State
      */
     getNoteState(returnJson?: boolean): NoteState;
     /**
      * Returns Custom Sort section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Custom Sort section of Adaptable State
      */
     getCustomSortState(returnJson?: boolean): CustomSortState;
     /**
      * Returns Dashboard section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Dashboard section of Adaptable State
      */
     getDashboardState(returnJson?: boolean): DashboardState;
     /**
      * Returns Export section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Export section of Adaptable State
      */
     getExportState(returnJson?: boolean): ExportState;
     /**
      * Returns Flashing Cell section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Flashing Cell section of Adaptable State
      */
     getFlashingCellState(returnJson?: boolean): FlashingCellState;
     /**
      * Returns Format Column section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Format Column section of Adaptable State
      */
     getFormatColumnState(returnJson?: boolean): FormatColumnState;
     /**
      * Returns FreeText Column section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns FreeText Column section of Adaptable State
      */
     getFreeTextColumnState(returnJson?: boolean): FreeTextColumnState;
     /**
      * Returns Layout section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Layout section of Adaptable State
      */
     getLayoutState(returnJson?: boolean): LayoutState;
     /**
      * Returns Plus Minus section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Plus Minus section of Adaptable State
      */
     getPlusMinusState(returnJson?: boolean): PlusMinusState;
     /**
      * Returns Query section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Query section of Adaptable State
      */
     getNamedQueryState(returnJson?: boolean): NamedQueryState;
     /**
      * Returns Quick Search section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Quick Search section of Adaptable State
      */
     getQuickSearchState(returnJson?: boolean): QuickSearchState;
     /**
      * Returns Shortcut section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Shortcut section of Adaptable State
      */
     getShortcutState(returnJson?: boolean): ShortcutState;
     /**
      * Returns StatusBar section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns StatusBar section of Adaptable State
      */
     getStatusBarState(returnJson?: boolean): StatusBarState;
     /**
      * Returns StyledColumn section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns StyledColumn section of Adaptable State
      */
     getStyledColumnState(returnJson?: boolean): StyledColumnState;
     /**
      * Returns Theme section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Theme section of Adaptable State
      */
     getThemeState(returnJson?: boolean): ThemeState;
     /**
      * Returns Tool Panel section of Adaptable State
      * @param returnJson return as JSON rather than object
+     * @returns Tool Panel section of Adaptable State
      */
     getToolPanelState(returnJson?: boolean): ToolPanelState;
     /**

package/src/Api/StatusBarApi.d.ts

@@ -6,10 +6,12 @@ import { AdaptableStatusBar } from '../AdaptableState/StatusBarState';
 export interface StatusBarApi {
     /**
      * Retrieves current AG Grid Status Bar Panels
+     * @returns Current AG Grid Status Bar Panels
      */
     getAgGridStatusPanels(): StatusPanelDef[];
     /**
      * Retrieves current AdapTable Status Bar Panels
+     * @returns Current AdapTable Status Bar Panels
      */
     getAdaptableStatusBars(): AdaptableStatusBar[];
     /**

package/src/Api/StyledColumnApi.d.ts

@@ -2,11 +2,12 @@ import type { AgChartInstance, AgSparklineOptions } from 'ag-charts-types';
 import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { StyledColumn, StyledColumnState } from '../AdaptableState/StyledColumnState';
 /**
- * Provides run-time access to Styled Column Module and associated state
+ * Styled Columns: badges, bars, sparklines and the other styles AdapTable draws in a cell.
  */
 export interface StyledColumnApi {
     /**
      * Retrieves Styled Column section from Adaptable State
+     * @returns Styled Column section from Adaptable State
      */
     getStyledColumnState(): StyledColumnState;
     /**
@@ -28,7 +29,7 @@ export interface StyledColumnApi {
     getStyledColumnByName(name: StyledColumn['Name']): StyledColumn | undefined;
     /**
      * Retrieves Styled Column for given Column Id
-     * @param columnId Styled Column id
+     * @param columnId Column the Styled Column is drawn in
      * @returns Styled Column
      */
     getStyledColumnForColumnId(columnId: StyledColumn['ColumnId']): StyledColumn;
@@ -43,13 +44,14 @@ export interface StyledColumnApi {
      */
     getSuspendedStyledColumns(): StyledColumn[];
     /**
-     * Delete a Styled column
-     * @param styledColumn
+     * Deletes a Styled Column from state.
+     * @param styledColumn Styled Column to delete
      */
     deleteStyledColumn(styledColumn: StyledColumn): void;
     /**
      * Edits a Styled Column
      * @param styledColumn Styled Column to edit
+     * @returns The Styled Column after it is saved
      */
     editStyledColumn(styledColumn: StyledColumn): StyledColumn;
     /**
@@ -57,18 +59,18 @@ export interface StyledColumnApi {
      */
     deleteAllStyledColumns(): void;
     /**
-     * Create a Styled column
-     * @param styledColumn
+     * Adds a Styled Column to state.
+     * @param styledColumn Styled Column to add
      */
     addStyledColumn(styledColumn: StyledColumn): void;
     /**
-     * Suspends an active Styled Column
-     * @param styledColumn
+     * Suspends an active Styled Column so its style is no longer drawn.
+     * @param styledColumn Styled Column to suspend
      */
     suspendStyledColumn(styledColumn: StyledColumn): void;
     /**
-     * Activates a suspended Styled Column
-     * @param styledColumn
+     * Activates a suspended Styled Column so its style is drawn again.
+     * @param styledColumn Styled Column to activate
      */
     unSuspendStyledColumn(styledColumn: StyledColumn): void;
     /**
@@ -82,31 +84,37 @@ export interface StyledColumnApi {
     /**
      * Checks whether Column with given `columnId` has a PercentBar Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Percent Bar style
      */
     hasPercentBarStyle(columnId: string): boolean;
     /**
      * Checks whether Column with given `columnId` has a Gradient Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Gradient style
      */
     hasGradientStyle(columnId: string): boolean;
     /**
      * Checks whether Column with given `columnId` has a Bullet Chart Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Bullet Chart style
      */
     hasBulletChartStyle(columnId: string): boolean;
     /**
      * Checks whether Column with given `columnId` has a Rating Style applied
      * @param columnId column ID
+     * @returns `true` when the column has a Rating style
      */
     hasRatingStyle(columnId: string): boolean;
     /**
-     * Checks whether Column is a Sparkline Column
-     * @param columnId column ID
+     * Whether this column is drawn as a sparkline.
+     * @param column Column to check
+     * @returns `true` when this column is drawn as a sparkline
      */
     isSparklineStyleStyledColumn(column: AdaptableColumn): boolean;
     /**
      * Returns a Styled Column for a given column
      * @param column Column to check
+     * @returns A Styled Column for a given column
      */
     getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;
     /**
@@ -115,6 +123,7 @@ export interface StyledColumnApi {
     openStyledColumnSettingsPanel(): void;
     /**
      * Can this AdapTable instance display Sparklines (e.g. is AG Grid SparklinesModule installed)
+     * @returns `true` when this instance can draw sparklines
      */
     canDisplaySparklines(): boolean;
     /**
@@ -128,6 +137,8 @@ export interface StyledColumnApi {
      * The caller owns the returned instance and is responsible for its lifecycle: call `update()` to
      * re-render it when the data or options change, and `destroy()` to dispose of it (e.g. when the
      * `container` is removed) to avoid memory leaks. AdapTable does not track or clean it up for you.
+     * @param options Where to render and what to plot. `container` and `data` are required
+     * @returns Renders a standalone [Sparkline](https://www.ag-grid.com/javascript-data-grid/sparklines-overview/) into a DOM element you provide, using the same AG Charts engine as Sparkline Styled Columns. Provide at least `container` (where to render) and `data` (what to plot) on `options`; see [AgSparklineOptions](https://www.ag-grid.com/javascript-data-grid/sparklines-overview/) for the full set (`type`, `width`/`height`, `min`/`max`, etc.). The caller owns the returned instance and is responsible for its lifecycle: call `update()` to re-render it when the data or options change, and `destroy()` to dispose of it (e.g. when the `container` is removed) to avoid memory leaks. AdapTable does not track or clean it up for you
      */
     renderSparkline(options: AgSparklineOptions): AgChartInstance<AgSparklineOptions> | null;
 }

package/src/Api/SystemStatusApi.d.ts

@@ -4,23 +4,34 @@ import { SystemStatusMessageInfo } from '../AdaptableState/Common/SystemStatusMe
  */
 export interface SystemStatusApi {
     /**
-     * Sets a new System Status message; appears in System Status toolbar, tool panel (and popup).
+     * Sets the System Status message shown in the System Status toolbar, tool panel and popup.
+     * @param statusMessage Text of the message
+     * @param messageType `Success`, `Info`, `Warning` or `Error`. Sets the colour of the message
+     * @param statusFurtherInformation Optional longer text shown with the message
      */
     setSystemStatus(statusMessage: string, messageType: 'Success' | 'Info' | 'Warning' | 'Error', statusFurtherInformation?: string): void;
     /**
-     * Sets an **Error** System Status Message
+     * Sets an Error System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setErrorSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
-     * Sets a **Warning** System Status Message
+     * Sets a Warning System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setWarningSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
-     * Sets a **Success** System Status Message
+     * Sets a Success System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setSuccessSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
-     * Sets an **Info** System Status Message
+     * Sets an Info System Status message.
+     * @param statusMessage Text of the message
+     * @param furtherInformation Optional longer text shown with the message
      */
     setInfoSystemStatus(statusMessage: string, furtherInformation?: string): void;
     /**
@@ -28,7 +39,8 @@ export interface SystemStatusApi {
      */
     openSystemStatusSettingsPanel(): void;
     /**
-     * Retrieves current System Status Message
+     * The System Status message currently on display.
+     * @returns The current message, or `undefined` when none is set
      */
     getCurrentSystemStatusMessageInfo(): SystemStatusMessageInfo | undefined;
     /**

package/src/Api/TeamSharingApi.d.ts

@@ -2,25 +2,29 @@ import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { AdaptableSharedEntity, CustomSharedEntity, CustomSharedEntityConfig, SharedEntity } from '../AdaptableState/TeamSharingState';
 import { AdaptableModule, AdaptableSharedEntityConfig } from '../types';
 /**
- * Provides run-time access to Team Sharing Module and associated state
+ * Team Sharing: load shared objects, share an object, and import an entry someone else shared.
  */
 export interface TeamSharingApi {
     /**
      * Retrieves all currently shared entities; async operation leveraging `TeamSharingOptions.loadSharedEntities(...)` method
+     * @returns All currently shared entities; async operation leveraging `TeamSharingOptions.loadSharedEntities(...)` method
      */
     loadSharedEntities(): Promise<SharedEntity[]>;
     /**
      * Sets currently shared entities; async operation leveraging `TeamSharingOptions.persistSharedEntities(...)` method
      * @param sharedEntities the shared entities
      * @return either TRUE if the shared entities were successfully set or FALSE if the shared entities were not set
+     * @returns `true` after the entities are saved. `false` when Team Sharing is not available
      */
     persistSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
     /**
      * Whether Team Sharing is available to use
+     * @returns `true` when Team Sharing is available to use
      */
     isTeamSharingAvailable(): boolean;
     /**
      * Whether current user has full Team Sharing rights (for creating & updating shared items)
+     * @returns `true` when current user has full Team Sharing rights (for creating & updating shared items)
      */
     hasTeamSharingFullRights(): boolean;
     /**
@@ -57,14 +61,17 @@ export interface TeamSharingApi {
     importSharedEntry(sharedEntity: SharedEntity): void;
     /**
      * Retrieves all locally loaded shared entries (`AdaptableSharedEntity` & `CustomSharedEntity`).
+     * @returns All locally loaded shared entries (`AdaptableSharedEntity` & `CustomSharedEntity`)
      */
     getLoadedSharedEntities(): SharedEntity[];
     /**
      * Retrieves locally loaded Adaptable Shared Entries.
+     * @returns Locally loaded Adaptable Shared Entries
      */
     getLoadedAdaptableSharedEntities(): AdaptableSharedEntity[];
     /**
      * Retrieves locally loaded Custom Shared Entries.
+     * @returns Locally loaded Custom Shared Entries
      */
     getLoadedCustomSharedEntities(): CustomSharedEntity[];
     /**

package/src/Api/ThemeApi.d.ts

@@ -1,14 +1,15 @@
 import { AdaptableTheme, SystemThemeEntry, ThemeState } from '../AdaptableState/ThemeState';
 /**
- * Provides run-time access to the Theme Module and associated state
+ * The theme currently applied, and the system and user themes in state.
  */
 export interface ThemeApi {
     /**
      * Retrieves Theme section from Adaptable State
+     * @returns Theme section from Adaptable State
      */
     getThemeState(): ThemeState;
     /**
-     * Applies the Current Theme
+     * Applies the Current Theme.
      */
     applyCurrentTheme(): void;
     /**
@@ -26,14 +27,17 @@ export interface ThemeApi {
     loadDarkTheme(): void;
     /**
      * Retrieves name of Current Theme
+     * @returns Name of Current Theme
      */
     getCurrentTheme(): string;
     /**
      * Retrieves the current theme object
+     * @returns The current theme object
      */
     getCurrentThemeObject(): AdaptableTheme;
     /**
-     * Edits an existing theme
+     * Replaces a theme already in state.
+     * @param theme Theme to save
      */
     editTheme(theme: AdaptableTheme): void;
     /**
@@ -50,33 +54,37 @@ export interface ThemeApi {
      */
     setUserThemes(userThemes: AdaptableTheme[]): void;
     /**
-     * Adds a User Theme to State
-     * @param theme
+     * Adds a user theme to state.
+     * @param theme Theme to add
      * @deprecated Will be removed in the next major version.
      */
     addUserTheme(theme: AdaptableTheme): void;
     /**
-     * Deletes a User Theme from State
-     * @param theme
+     * Removes a user theme from state.
+     * @param theme Theme to delete
      * @deprecated Will be removed in the next major version.
      */
     deleteUserTheme(theme: AdaptableTheme): void;
     /**
      * Retrieves System Themes in State
+     * @returns System Themes in State
      */
     getSystemThemes(): AdaptableTheme[];
     /**
      * Retrieves User Themes in State
      * @deprecated Will be removed in the next major version.
+     * @returns User Themes in State
      */
     getUserThemes(): AdaptableTheme[];
     /**
      * Retrieves all Themes (both System &  User) in State
+     * @returns All Themes (both System & User) in State
      */
     getThemes(): AdaptableTheme[];
     /**
-     * Retrieves a Theme by name
-     * @param themeName
+     * A theme looked up by name, system or user.
+     * @param themeName Name of the theme
+     * @returns A theme looked up by name, system or user
      */
     getThemeByName(themeName: string): AdaptableTheme;
     /**
@@ -87,6 +95,7 @@ export interface ThemeApi {
      * Get the name of the current AG Grid theme
      *
      * @deprecated required only for legacy AG Grid themes, see https://www.ag-grid.com/javascript-data-grid/theming-v32/
+     * @returns The name of the current AG Grid theme
      */
     getAgGridCurrentThemeName(): string;
 }

package/src/Api/ToolPanelApi.d.ts

@@ -8,6 +8,7 @@ import { AdaptableModuleButtons, AdaptableToolPanel } from '../AdaptableState/Co
 export interface ToolPanelApi {
     /**
      * Retrieves Tool Panel section from Tool Panel State
+     * @returns Tool Panel section from Tool Panel State
      */
     getToolPanelState(): ToolPanelState;
     /**
@@ -24,27 +25,30 @@ export interface ToolPanelApi {
     closeAdapTableToolPanel(): void;
     /**
      * Retrieves all Custom Tool Panels defined in ToolPanelOptions
+     * @returns All Custom Tool Panels defined in ToolPanelOptions
      */
     getCustomToolPanels(): CustomToolPanel[];
     /**
      * Retrieves all Custom Tool Panel Buttons defined in ToolPanelOptions
+     * @returns All Custom Tool Panel Buttons defined in ToolPanelOptions
      */
     getCustomToolPanelButtons(): AdaptableButton<ToolPanelButtonContext>[];
     /**
      * Retrieves the CustomToolPanel with the given name (or undefined if no match is found)
      * @param name the CustomToolPanel name
+     * @returns The CustomToolPanel with the given name (or undefined if no match is found)
      */
     getCustomToolPanelByName(name: string): CustomToolPanel | undefined;
     /**
-     * Sets the given Adaptable ToolPanel with the provided visibilityMode (expanded / collapsed)
-     * @param adaptableToolPanel
-     * @param visibilityMode
+     * Expands or collapses one of the AdapTable tool panels.
+     * @param adaptableToolPanel Which AdapTable tool panel
+     * @param visibilityMode `'expanded'` or `'collapsed'`
      */
     setAdaptableToolPanelVisibilityMode(adaptableToolPanel: AdaptableToolPanel, visibilityMode: ToolPanelVisibilityMode): void;
     /**
-     * Sets the Custom ToolPanel with the given name with the provided visibilityMode (expanded / collapsed)
-     * @param customToolPanelName
-     * @param visibilityMode
+     * Expands or collapses a custom tool panel.
+     * @param customToolPanelName Name of the custom tool panel
+     * @param visibilityMode `'expanded'` or `'collapsed'`
      */
     setCustomToolPanelVisibilityMode(customToolPanelName: string, visibilityMode: ToolPanelVisibilityMode): void;
     /**
@@ -53,7 +57,8 @@ export interface ToolPanelApi {
      */
     setModuleButtons(moduleButtons: AdaptableModuleButtons): void;
     /**
-     * Sets the Module buttons from the Adaptable ToolPanel
+     * The module buttons currently shown in the AdapTable tool panel.
+     * @returns The module buttons currently shown in the AdapTable tool panel
      */
     getModuleButtons(): AdaptableModuleButtons;
 }

package/src/Api/UserInterfaceApi.d.ts

@@ -5,37 +5,44 @@ import { CustomWindowConfig } from '../AdaptableState/Common/CustomWindowConfig'
 import { ProgressIndicatorConfig } from '../AdaptableState/Common/ProgressIndicatorConfig';
 import { UserInterfaceState } from '../AdaptableState/UserInterfaceState';
 /**
- * Functions relating to User Interface section of Adaptable State
+ * Icons, editable and read-only styles, the progress indicator, custom windows, and showing or hiding the UI.
  */
 export interface UserInterfaceApi {
     /**
      * Retrieves Custom Icons provided by users
+     * @returns Custom Icons provided by users
      */
     getCustomIcons(): CustomIcon[];
     /**
      * Retrieves any Style Class Names from User Interface Options
+     * @returns Any Style Class Names from User Interface Options
      */
     getStyleClassNames(): string[] | undefined;
     /**
      * Returns Style set for Editable cells
+     * @returns Style set for Editable cells
      */
     getEditableCellStyle(): AdaptableStyle | undefined;
     /**
      * Returns Style for Cells that have been edited
+     * @returns Style for Cells that have been edited
      */
     getEditedCellStyle(): AdaptableStyle | undefined;
     /**
      * Returns Style set for ReadOnly Cells
+     * @returns Style set for ReadOnly Cells
      */
     getReadOnlyCellStyle(): AdaptableStyle | undefined;
     /**
      * Retrieves any Object Tags (provided in User Interface Options)
+     * @returns Any Object Tags (provided in User Interface Options)
      */
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
     /**
      * Retrieves all objects in list which contain the given Tag
      * @param tag Tag to check
      * @param adaptableModule optional Module to check
+     * @returns All objects in list which contain the given Tag
      */
     getAdaptableObjectsWithTag(tag: AdaptableObjectTag, adaptableModule?: AdaptableModule): AdaptableObject[] | undefined;
     /**
@@ -77,10 +84,12 @@ export interface UserInterfaceApi {
     closeCustomWindowPopup(windowId: string): void;
     /**
      * Retrieves the current User Interface State
+     * @returns The current User Interface State
      */
     getUserInterfaceState(): UserInterfaceState;
     /**
      * Returns whether the AdapTable UI is currently visible
+     * @returns `true` when the AdapTable UI is currently visible
      */
     isAdaptableUIVisible(): boolean;
     /**

package/src/Redux/Store/AdaptableStore.js

@@ -1002,7 +1002,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         adaptable.api.gridApi.refreshCell(rowNode, columnId, true);
                         requestAnimationFrame(() => {
                             const commentThreads = adaptable.api.commentApi.getAllComments();
-                            adaptable.api.eventApi.emit('CommentChanged', commentThreads);
+                            adaptable.api.eventApi.internalApi.fireCommentChangedEvent(commentThreads);
                             adaptable.api.optionsApi
                                 .getCommentOptions()
                                 ?.persistCommentThreads?.(commentThreads);