@adaptabletools/adaptable 24.0.0-canary.8 → 24.0.0

package/src/Api/EventApi.d.ts

@@ -1,6 +1,8 @@
 import { AdaptableReadyInfo, AdaptableStateChangedInfo, AdaptableStateReloadedInfo, BeforeAdaptableStateChangeInfo, AlertFiredInfo, CalculatedColumnChangedInfo, CellChangedInfo, CellSelectionChangedInfo, ChartChangedInfo, ColumnFilterAppliedInfo, ColumnFilterChangedInfo, CommentChangedInfo, NoteChangedInfo, CustomToolbarConfiguredInfo, DashboardChangedInfo, DataImportedInfo, DataSetSelectedInfo, Fdc3MessageInfo, FlashingCellDisplayedInfo, GridFilterAppliedInfo, GridSortedInfo, LayoutChangedInfo, LiveDataChangedInfo, RowChangedInfo, RowFormSubmittedInfo, RowSelectionChangedInfo, ReportScheduleRanInfo, SystemStatusMessageDisplayedInfo, TeamSharingEntityChangedInfo, ThemeChangedInfo, ThemeSelectedInfo } from '../types';
 /**
- * Responsible for publishing the many Events that AdapTable fires
+ * Subscribe to AdapTable events.
+ *
+ * `on` registers a listener and returns a function that removes it. `off` removes a listener that was passed to `on` for the same event. The callback argument is the info object for that event.
  */
 export interface EventApi {
     /**
@@ -13,7 +15,7 @@ export interface EventApi {
     /**
      * Unsubscribe from GridSorted
      * @param eventName GridSorted
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'GridSorted', callback: (gridSortedInfo: GridSortedInfo) => void): void;
     /**
@@ -26,19 +28,20 @@ export interface EventApi {
     /**
      * Unsubscribe from GridFilterApplied
      * @param eventName GridFilterApplied
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'GridFilterApplied', callback: (gridFilterAppliedInfo: GridFilterAppliedInfo) => void): void;
     /**
      * Event fired whenever a Schedule is triggered in AdapTable
      * @param eventName ReportScheduleRan
      * @param callback provides the report schedule and `RanAt` (when this run started)
+     * @returns A function that removes this listener
      */
     on(eventName: 'ReportScheduleRan', callback: (reportScheduleRanInfo: ReportScheduleRanInfo) => void): VoidFunction;
     /**
      * Unsubscribe from ReportScheduleRan
      * @param eventName ReportScheduleRan
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'ReportScheduleRan', callback: (reportScheduleRanInfo: ReportScheduleRanInfo) => void): void;
     /**
@@ -52,7 +55,7 @@ export interface EventApi {
     /**
      * Unsubscribe from ColumnFilterChanged
      * @param eventName ColumnFilterChanged
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'ColumnFilterChanged', callback: (columnFilterChangedInfo: ColumnFilterChangedInfo) => void): void;
     /**
@@ -66,7 +69,7 @@ export interface EventApi {
     /**
      * Unsubscribe from ColumnFilterApplied
      * @param eventName ColumnFilterApplied
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'ColumnFilterApplied', callback: (columnFilterAppliedInfo: ColumnFilterAppliedInfo) => void): void;
     /**
@@ -79,7 +82,7 @@ export interface EventApi {
     /**
      * Unsubscribe from CellChanged
      * @param eventName CellChanged
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'CellChanged', callback: (cellChangedInfo: CellChangedInfo) => void): void;
     /**
@@ -92,7 +95,7 @@ export interface EventApi {
     /**
      * Unsubscribe from RowChanged
      * @param eventName RowChanged
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'RowChanged', callback: (rowChangedInfo: RowChangedInfo) => void): void;
     /**
@@ -105,7 +108,7 @@ export interface EventApi {
     /**
      * Unsubscribe from TeamSharingEntityChanged
      * @param eventName TeamSharingEntityChanged
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'TeamSharingEntityChanged', callback: (TeamSharingEntityChangedInfo: TeamSharingEntityChangedInfo) => void): void;
     /**
@@ -117,6 +120,8 @@ export interface EventApi {
     on(eventName: 'CellSelectionChanged', callback: (cellSelectionChangedInfo: CellSelectionChangedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from CellSelectionChanged
+     * @param eventName CellSelectionChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'CellSelectionChanged', callback: (cellSelectionChangedInfo: CellSelectionChangedInfo) => void): void;
     /**
@@ -128,6 +133,8 @@ export interface EventApi {
     on(eventName: 'RowSelectionChanged', callback: (rowSelectionChangedInfo: RowSelectionChangedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from RowSelectionChanged
+     * @param eventName RowSelectionChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'RowSelectionChanged', callback: (rowSelectionChangedInfo: RowSelectionChangedInfo) => void): void;
     /**
@@ -139,6 +146,8 @@ export interface EventApi {
     on(eventName: 'ThemeSelected', callback: (themeSelectedInfo: ThemeSelectedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from ThemeSelected
+     * @param eventName ThemeSelected
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'ThemeSelected', callback: (themeSelectedInfo: ThemeSelectedInfo) => void): void;
     /**
@@ -152,6 +161,8 @@ export interface EventApi {
     /**
      * Unsubscribe from ThemeChanged
      * @deprecated Use `ThemeSelected` instead.
+     * @param eventName ThemeChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'ThemeChanged', callback: (themeChangedInfo: ThemeChangedInfo) => void): void;
     /**
@@ -163,6 +174,8 @@ export interface EventApi {
     on(eventName: 'SystemStatusMessageDisplayed', callback: (systemStatusMessageDisplayedInfo: SystemStatusMessageDisplayedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from SystemStatusMessageDisplayed
+     * @param eventName SystemStatusMessageDisplayed
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'SystemStatusMessageDisplayed', callback: (SystemStatusMessageDisplayedInfo: SystemStatusMessageDisplayedInfo) => void): void;
     /**
@@ -174,6 +187,8 @@ export interface EventApi {
     on(eventName: 'AlertFired', callback: (alertFiredInfo: AlertFiredInfo) => void): VoidFunction;
     /**
      * Unsubscribe from AlertFired
+     * @param eventName AlertFired
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'AlertFired', callback: (alertFiredInfo: AlertFiredInfo) => void): void;
     /**
@@ -185,6 +200,8 @@ export interface EventApi {
     on(eventName: 'DataImported', callback: (dataImportedInfo: DataImportedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from DataImported
+     * @param eventName DataImported
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'DataImported', callback: (dataImportedInfo: DataImportedInfo) => void): void;
     /**
@@ -196,6 +213,8 @@ export interface EventApi {
     on(eventName: 'FlashingCellDisplayed', callback: (flashingCellDisplayedInfo: FlashingCellDisplayedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from FlashingCellDisplayed
+     * @param eventName FlashingCellDisplayed
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'FlashingCellDisplayed', callback: (flashingCellDisplayedInfo: FlashingCellDisplayedInfo) => void): void;
     /**
@@ -207,6 +226,8 @@ export interface EventApi {
     on(eventName: 'LayoutChanged', callback: (layoutChangedInfo: LayoutChangedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from LayoutChanged
+     * @param eventName LayoutChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'LayoutChanged', callback: (layoutChangedInfo: LayoutChangedInfo) => void): void;
     /**
@@ -218,6 +239,8 @@ export interface EventApi {
     on(eventName: 'CalculatedColumnChanged', callback: (calculatedColumnChangedInfo: CalculatedColumnChangedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from CalculatedColumnChanged
+     * @param eventName CalculatedColumnChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'CalculatedColumnChanged', callback: (calculatedColumnChangedInfo: CalculatedColumnChangedInfo) => void): void;
     /**
@@ -229,6 +252,8 @@ export interface EventApi {
     on(eventName: 'CustomToolbarConfigured', callback: (customToolbarConfiguredInfo: CustomToolbarConfiguredInfo) => void): VoidFunction;
     /**
      * Unsubscribe from CustomToolbarConfigured
+     * @param eventName CustomToolbarConfigured
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'CustomToolbarConfigured', callback: (customToolbarConfiguredInfo: CustomToolbarConfiguredInfo) => void): void;
     /**
@@ -241,6 +266,8 @@ export interface EventApi {
     on(eventName: 'DashboardChanged', callback: (dashboardChangedInfo: DashboardChangedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from DashboardChanged
+     * @param eventName DashboardChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'DashboardChanged', callback: (dashboardChangedInfo: DashboardChangedInfo) => void): void;
     /**
@@ -252,6 +279,8 @@ export interface EventApi {
     on(eventName: 'BeforeAdaptableStateChange', callback: (beforeAdaptableStateChangeInfo: BeforeAdaptableStateChangeInfo) => void): () => void;
     /**
      * Unsubscribe from BeforeAdaptableStateChange
+     * @param eventName BeforeAdaptableStateChange
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'BeforeAdaptableStateChange', callback: (beforeAdaptableStateChangeInfo: BeforeAdaptableStateChangeInfo) => void): void;
     /**
@@ -263,6 +292,8 @@ export interface EventApi {
     on(eventName: 'AdaptableStateChanged', callback: (adaptableStateChangedInfo: AdaptableStateChangedInfo) => void): () => void;
     /**
      * Unsubscribe from AdaptableStateChanged
+     * @param eventName AdaptableStateChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'AdaptableStateChanged', callback: (adaptableStateChangedInfo: AdaptableStateChangedInfo) => void): void;
     /**
@@ -274,6 +305,8 @@ export interface EventApi {
     on(eventName: 'AdaptableStateReloaded', callback: (adaptableStateReloadedInfo: AdaptableStateReloadedInfo) => void): () => void;
     /**
      * Unsubscribe from AdaptableStateReloaded
+     * @param eventName AdaptableStateReloaded
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'AdaptableStateReloaded', callback: (adaptableStateReloadedInfo: AdaptableStateReloadedInfo) => void): void;
     /**
@@ -286,32 +319,36 @@ export interface EventApi {
     on(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): () => void;
     /**
      * Unsubscribe from LiveDataChanged
+     * @param eventName LiveDataChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): void;
     /**
      * Event fired when a Row Form is submitted
      *
      * @param eventName RowFormSubmitted
-     * @param callback RowFormSubmitted
+     * @param callback `RowFormSubmittedInfo` for the submitted form
+     * @returns A function that removes this listener
      */
     on(eventName: 'RowFormSubmitted', callback: (rowFormSubmittedInfo: RowFormSubmittedInfo) => void): () => void;
     /**
      * Unsubscribe from RowFormSubmitted
      * @param eventName RowFormSubmitted
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
-    off(eventName: 'RowFormSubmittedInfo', callback: (rowFormSubmittedInfo: RowFormSubmittedInfo) => void): void;
+    off(eventName: 'RowFormSubmitted', callback: (rowFormSubmittedInfo: RowFormSubmittedInfo) => void): void;
     /**
      * Event fired when a DataSet is Selected
      *
      * @param eventName DataSetSelected
      * @param callback DataSetSelectedInfo
+     * @returns A function that removes this listener
      */
     on(eventName: 'DataSetSelected', callback: (dataSetSelectedInfo: DataSetSelectedInfo) => void): () => void;
     /**
      * Unsubscribe from DataSetSelected
      * @param eventName DataSetSelected
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'DataSetSelected', callback: (dataSetSelectedInfo: DataSetSelectedInfo) => void): void;
     /**
@@ -319,24 +356,26 @@ export interface EventApi {
      *
      * @param eventName ChartChanged
      * @param callback ChartChangedInfo
+     * @returns A function that removes this listener
      */
     on(eventName: 'ChartChanged', callback: (chartChangedInfo: ChartChangedInfo) => void): () => void;
     /**
      * Unsubscribe from ChartChanged
      * @param eventName ChartChanged
-     * @param callbackChartChangedInfo
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'ChartChanged', callback: (chartChangedInfo: ChartChangedInfo) => void): void;
     /**
      * Event fired when a Comment is Changed
      * @param eventName CommentChanged
-     * @param callback
+     * @param callback `CommentChangedInfo` whose `commentThreads` is every thread after the change
+     * @returns A function that removes this listener
      */
     on(eventName: 'CommentChanged', callback: (commentChangedInfo: CommentChangedInfo) => void): () => void;
     /**
      * Unsubscribe from CommentChanged
-     * @param eventName
-     * @param callback
+     * @param eventName CommentChanged
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'CommentChanged', callback: (commentChangedInfo: CommentChangedInfo) => void): void;
     /**
@@ -349,7 +388,7 @@ export interface EventApi {
     /**
      * Unsubscribe from NoteChanged
      * @param eventName NoteChanged
-     * @param callback
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'NoteChanged', callback: (noteChangedInfo: NoteChangedInfo) => void): void;
     /**
@@ -376,8 +415,16 @@ export interface EventApi {
      * ```
      */
     on(eventName: 'AdaptableDestroy', callback: () => void): VoidFunction;
+    /**
+     * Unsubscribe from AdaptableDestroy
+     * @param eventName AdaptableDestroy
+     * @param callback The listener that was passed to `on`
+     */
+    off(eventName: 'AdaptableDestroy', callback: () => void): void;
     /**
      * Unsubscribe from AdaptableReady
+     * @param eventName AdaptableReady
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): void;
     /**
@@ -385,12 +432,13 @@ export interface EventApi {
      *
      * @param eventName Fdc3Message
      * @param callback Fdc3MessageInfo
+     * @returns A function that removes this listener
      */
     on(eventName: 'Fdc3Message', callback: (fdc3MessageInfo: Fdc3MessageInfo) => void): () => void;
     /**
      * Unsubscribe from Fdc3Message
      * @param eventName Fdc3Message
-     * @param callbackFdc3MessageInfo
+     * @param callback The listener that was passed to `on`
      */
     off(eventName: 'Fdc3Message', callback: (fdc3MessageInfo: Fdc3MessageInfo) => void): void;
 }

package/src/Api/Events/AdaptableReady.d.ts

@@ -1,11 +1,15 @@
 import { GridApi } from 'ag-grid-enterprise';
 import { BaseContext } from '../../types';
 /**
- * Object returned by `AdaptableReady` event - fired when AdapTable has loaded
+ * Payload of the `AdaptableReady` event.
+ *
+ * Fires once, when AdapTable has loaded. A listener added after that still runs, because this event replays for late subscribers.
+ *
+ * Extends {@link BaseContext}. Use `adaptableApi` for AdapTable and `agGridApi` for AG Grid.
  */
 export interface AdaptableReadyInfo<TData = any> extends BaseContext {
     /**
-     * Underlying AG Grid API
+     * AG Grid `GridApi` for this grid.
      */
     agGridApi: GridApi<TData>;
 }

package/src/Api/Events/AdaptableStateChanged.d.ts

@@ -2,23 +2,27 @@ import * as Redux from 'redux';
 import { AdaptableState } from '../../AdaptableState/AdaptableState';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `AdaptableStateChanged` event
+ * Payload of the `AdaptableStateChanged` event.
+ *
+ * Fires after each Adaptable State change once the grid is ready. Loading or initialising state does not fire it; that is `AdaptableStateReloaded`.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface AdaptableStateChangedInfo extends BaseContext {
     /**
-     * Name of the Action
+     * Redux action type that was applied (`action.type`).
      */
     actionName: string;
     /**
-     * The Redux Action that was invoked
+     * Redux action that was applied.
      */
     action: Redux.Action;
     /**
-     * Adaptable State before the Action
+     * Full Adaptable State before the action.
      */
     oldState: AdaptableState;
     /**
-     * Adaptable State after the Action
+     * Full Adaptable State after the action.
      */
     newState: AdaptableState;
 }

package/src/Api/Events/AdaptableStateReloaded.d.ts

@@ -1,15 +1,19 @@
 import { AdaptablePersistentState } from '../../AdaptableState/AdaptableState';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `AdaptableStateReloaded` event
+ * Payload of the `AdaptableStateReloaded` event.
+ *
+ * Fires after persisted state has been loaded and applied. The load and init actions themselves do not emit `AdaptableStateChanged`.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface AdaptableStateReloadedInfo extends BaseContext {
     /**
-     * Adaptable State before the reload
+     * Persisted Adaptable State before the reload.
      */
     oldState: AdaptablePersistentState;
     /**
-     * Adaptable State after the reload
+     * Persisted Adaptable State after the reload.
      */
     newState: AdaptablePersistentState;
 }

package/src/Api/Events/AlertFired.d.ts

@@ -1,11 +1,17 @@
 import { AdaptableAlert } from '../../AdaptableState/Common/AdaptableAlert';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `AlertFired` event
+ * Payload of the `AlertFired` event.
+ *
+ * Fires when an Alert is displayed.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface AlertFiredInfo extends BaseContext {
     /**
-     * Alert which has been fired
+     * Alert that was displayed.
+     *
+     * A cell or row Alert includes the change that triggered it. A generic Alert is the message only.
      */
     alert: AdaptableAlert;
 }

package/src/Api/Events/BeforeAdaptableStateChange.d.ts

@@ -2,11 +2,15 @@ import * as Redux from 'redux';
 import { AdaptableState } from '../../AdaptableState/AdaptableState';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `BeforeAdaptableStateChange` event, fired before the action is processed by the reducer
+ * Payload of the `BeforeAdaptableStateChange` event.
+ *
+ * Fired synchronously, before the reducer runs, once the grid is ready.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface BeforeAdaptableStateChangeInfo extends BaseContext {
     /**
-     * Name of the Action about to be performed
+     * Redux action type about to be applied (`action.type`).
      */
     actionName: string;
     /**

package/src/Api/Events/CalculatedColumnChanged.d.ts

@@ -1,15 +1,19 @@
 import { CalculatedColumn } from '../../AdaptableState/CalculatedColumnState';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by CalculatedColumnChanged event
+ * Payload of the `CalculatedColumnChanged` event.
+ *
+ * Fires when a Calculated Column is added, edited or deleted.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface CalculatedColumnChangedInfo extends BaseContext {
     /**
-     * What caused CalculatedColumn State to change (i.e. Add, Edit, Delete)
+     * Redux action type: `CALCULATED_COLUMN_ADD`, `CALCULATED_COLUMN_EDIT` or `CALCULATED_COLUMN_DELETE`.
      */
     actionName: string;
     /**
-     * Calculated Column that has been added, edited or deleted
+     * Calculated Column that was added, edited or deleted.
      */
     calculatedColumn: CalculatedColumn;
     /**

package/src/Api/Events/CellChanged.d.ts

@@ -1,11 +1,15 @@
 import { CellDataChangedInfo } from '../../AdaptableState/Common/CellDataChangedInfo';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by CellChanged event
+ * Payload of the `CellChanged` event.
+ *
+ * Fires when a cell value changes: an edit, a tick, an undo, an aggregation change, or a Calculated Column update. A live Alert rule does not fire this event; it fires `AlertFired`.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface CellChangedInfo extends BaseContext {
     /**
-     * Object providing full information of the cell (and column and row) that changed
+     * The change: old and new values, column, row and what triggered it. See {@link CellDataChangedInfo}.
      */
     cellDataChange: CellDataChangedInfo;
 }

package/src/Api/Events/CellSelectionChanged.d.ts

@@ -1,11 +1,15 @@
 import { SelectedCellInfo } from '../../AdaptableState/Selection/SelectedCellInfo';
 import { BaseContext } from '../../types';
 /**
- * Event Info published by CellSelectionChanged event
+ * Payload of the `CellSelectionChanged` event.
+ *
+ * Fires when the cell selection changes, after AdapTable has updated its selected-cell state. Row selection does not fire this event.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface CellSelectionChangedInfo extends BaseContext {
     /**
-     * Details of Cells currently selected in the Grid
+     * Cells selected after this change. `gridCells` is empty when nothing is selected.
      */
     selectedCellInfo: SelectedCellInfo;
 }

package/src/Api/Events/ChartChanged.d.ts

@@ -1,36 +1,44 @@
 import { BaseContext, ChartDefinition } from '../../types';
 /**
- * Info used in Chart Changed Event
+ * Payload of the `ChartChanged` event.
+ *
+ * Fires when an AdapTable chart is created, opened, closed or deleted.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface ChartChangedInfo extends BaseContext {
     /**
-     * Details of Open Charts
+     * Every chart definition, with whether that chart is currently displayed.
      */
     chartingOpenState: ChartingOpenState;
 }
 /**
- * Currently opened Charts
+ * Open-state snapshot included in {@link ChartChangedInfo}.
+ *
+ * One entry per chart definition, including charts that are closed.
  */
 export interface ChartingOpenState {
     /**
-     * Displayed Charts
+     * Every chart definition and its current display state.
      */
     charts: ChartDisplayedInfo[];
 }
 /**
- * Defines a Displayed Chart
+ * One chart definition and whether it is displayed.
  */
 export interface ChartDisplayedInfo {
     /**
-     * Definition of the Chart
+     * Chart definition this entry describes.
      */
     chartDefinition: ChartDefinition;
     /**
-     * Whether Chart is Open
+     * Whether AG Grid currently has this chart open.
      */
     isOpen: boolean;
     /**
-     * Container where Chart is displayed
+     * Name of the configured chart container whose element contains this chart.
+     *
+     * Absent when the chart is closed, shown only in the AG Grid chart container, or no chart containers are configured.
      */
     containerName: string | null;
 }

package/src/Api/Events/CommentChanged.d.ts

@@ -1,10 +1,16 @@
 import { BaseContext, CommentThread } from '../../types';
 /**
- * Event fired when a Comment has changed
+ * Payload of the `CommentChanged` event.
+ *
+ * Fires when a comment or comment thread is added, edited or deleted. Loading threads does not fire it.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface CommentChangedInfo extends BaseContext {
     /**
-     * All current Comment Threads
+     * Every comment thread after the change.
+     *
+     * This is the full list `commentApi.getAllComments()` returns, not only the thread that changed.
      */
     commentThreads: CommentThread[];
 }

package/src/Api/Events/CustomToolbarConfigured.d.ts

@@ -1,11 +1,15 @@
 import { CustomToolbar } from '../../AdaptableOptions/DashboardOptions';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by the CustomToolbarConfigured event
+ * Payload of the `CustomToolbarConfigured` event.
+ *
+ * Fires when the user clicks Configure on a custom toolbar that includes the configure action.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface CustomToolbarConfiguredInfo extends BaseContext {
     /**
-     * Custom Toolbar in which the 'Configure' button has been clicked
+     * Custom toolbar whose Configure button was clicked.
      */
     customToolbar: CustomToolbar;
 }

package/src/Api/Events/DashboardChanged.d.ts

@@ -1,27 +1,48 @@
 import { DashboardState } from '../../AdaptableState/DashboardState';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `DashboardChanged` event
+ * Payload of the `DashboardChanged` event.
+ *
+ * Fires when Dashboard State changes, and once shortly after startup (`actionName` `ADAPTABLE_READY`). It is not fired when the old and new state are equal.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface DashboardChangedInfo extends BaseContext {
     /**
-     * What caused Dashboard State to change
+     * What changed.
+     *
+     * `ADAPTABLE_READY` is the first event, shortly after startup.
+     *
+     * Otherwise it is the Redux action type:
+     * `DASHBOARD_SET_IS_COLLAPSED`, `DASHBOARD_SET_IS_HIDDEN`, `DASHBOARD_SET_IS_FLOATING`, `DASHBOARD_SET_FLOATING_POSITION`, `DASHBOARD_SET_MODULE_BUTTONS`, `DASHBOARD_SET_TABS`, `DASHBOARD_ACTIVE_TAB_INDEX_CHANGE`, `DASHBOARD_CLOSE_TOOLBAR`.
      */
     actionName: string;
     /**
-     * Previous Dashboard State
+     * Dashboard State before this change.
+     *
+     * `null` when `actionName` is `ADAPTABLE_READY`.
      */
     oldDashboardState: DashboardState;
     /**
-     * Current Dashboard State
+     * Dashboard State after this change.
      */
     newDashboardState: DashboardState;
     /**
-     * Check if given Toolbar was just changed to visible state
+     * Whether `toolbarName` became visible because of this change.
+     *
+     * True when the toolbar entered the active tab, or it was already in the active tab and the Dashboard was expanded or unhidden.
+     *
+     * @param toolbarName Toolbar to test
+     * @returns `true` when the toolbar became visible
      */
     isToolbarStateChangedToVisible(toolbarName: string): boolean;
     /**
-     * Check if given Toolbar was just changed to hidden state
+     * Whether `toolbarName` became hidden because of this change.
+     *
+     * True when the toolbar left the active tab, or it stayed in the active tab and the Dashboard was collapsed or hidden.
+     *
+     * @param toolbarName Toolbar to test
+     * @returns `true` when the toolbar became hidden
      */
     isToolbarStateChangedToHidden(toolbarName: string): boolean;
 }