@adaptabletools/adaptable 24.0.0-canary.7 → 24.0.0-canary.9

package/src/Api/LayoutApi.d.ts

@@ -2,11 +2,12 @@ import { AdaptableColumn, ColumnSort, PivotLayout, TableLayout } from '../../typ
 import { ExtendedLayout, LayoutExtensionInfo, LayoutExtensionModule, LayoutExtensionObject } from '../AdaptableState/Common/ExtendedLayout';
 import { LayoutState, Layout } from '../AdaptableState/LayoutState';
 /**
- * Provides run-time access to the Layout Module and associated state
+ * Table and Pivot Layouts: the layout that is selected, its columns, sorts and row groups, and creating, cloning, editing and deleting layouts.
  */
 export interface LayoutApi {
     /**
-     * Retrieves Layout section from Adaptable State
+     * The Layout section of Adaptable State.
+     * @returns Layouts and the name of the current Layout
      */
     getLayoutState(): LayoutState;
     /**
@@ -20,34 +21,41 @@ export interface LayoutApi {
      */
     getCurrentLayout(): Layout;
     /**
-     * Returns true if current Layout is a Pivot Layout
+     * Whether the current Layout is a Pivot Layout.
+     * @returns `true` when the current Layout is a Pivot Layout
      */
     isCurrentLayoutPivot(): boolean;
     /**
-     * Retrieves the sort order of a column from the current layout
-     * @param columnId Column id
+     * The sort direction of a column in the current Layout.
+     * @param columnId Column to read
+     * @returns `'Asc'` or `'Desc'`, or `null` when the column is not sorted in this Layout
      */
     getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
     /**
-     * Retrieves map with visible columns in current Table Layout
+     * Column ids in the current Table Layout.
+     * @returns Each Table Layout column id mapped to `true`. An empty object when the current Layout is a Pivot Layout
      */
     getCurrentVisibleColumnIdsMapForTableLayout(): {
         [key: string]: boolean;
     };
     /**
-     * Retrieves array of visible ColumnIds in current Table Layout
+     * Column ids currently displayed in a Table Layout.
+     * @returns The displayed column ids. Empty when the current Layout is a Pivot Layout
      */
     getCurrentVisibleColumnIdsForTableLayout(): string[];
     /**
-     * Retrieves array of visible ColumnIds in current Pivot Layout
+     * Column ids currently displayed in a Pivot Layout.
+     * @returns The displayed column ids, including pivot result columns. Empty when the current Layout is a Table Layout
      */
     getCurrentVisibleColumnIdsForPivotLayout(): string[];
     /**
-     * Retrieves array of visible ColumnIds in current Layout
+     * Columns that group rows in the current Layout.
+     * @returns `RowGroupedColumns` for a Table Layout, or `PivotGroupedColumns` for a Pivot Layout
      */
     getCurrentRowGroupsColumnIds(): string[];
     /**
-     * Retrieves name of current Layout
+     * Name of the Layout that is selected.
+     * @returns The current Layout name
      */
     getCurrentLayoutName(): string;
     /**
@@ -65,6 +73,7 @@ export interface LayoutApi {
      * Retrieves the Layout with the given name, together with the objects extended into it
      * (global objects, which apply in every Layout, are not included)
      * @param layoutName Layout to retrieve
+     * @returns The Layout and the objects extended into it, or `undefined` when no Layout has that name. Objects that apply in every Layout are not included
      */
     getExtendedLayoutByName(layoutName: string): ExtendedLayout | undefined;
     /**
@@ -77,6 +86,7 @@ export interface LayoutApi {
      * Clones an Extended Layout - the new Layout is extended with the same objects
      * @param extendedLayoutToClone ExtendedLayout to Clone
      * @param layoutName New name for Layout being cloned
+     * @returns The cloned Extended Layout, or `false` when the source does not exist or the new name is already used
      */
     cloneExtendedLayout(extendedLayoutToClone: ExtendedLayout, layoutName: string): ExtendedLayout | false;
     /**
@@ -89,6 +99,7 @@ export interface LayoutApi {
     /**
      * Retrieves the names of the objects, per Module, extended into a Layout
      * @param layoutName Layout to check
+     * @returns Object names grouped by module. Empty when the Layout has no extensions
      */
     getLayoutExtensions(layoutName: string): LayoutExtensionInfo;
     /**
@@ -116,6 +127,7 @@ export interface LayoutApi {
      * Retrieves the names of the Layouts an object is extended into (empty when the object is global)
      * @param object Object to check
      * @param module Module the object belongs to
+     * @returns Layout names the object is extended into. Empty when the object applies in every Layout
      */
     getLayoutsForObject(object: LayoutExtensionObject, module: LayoutExtensionModule): string[];
     /**
@@ -177,8 +189,9 @@ export interface LayoutApi {
      */
     cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout | false;
     /**
-     * Checks whether this Layout exists in the Adaptable State (by comparing Uuid property)
+     * Whether this Layout is already in Layout State. Compared by `Uuid`.
      * @param layout Layout to check
+     * @returns `true` when a Layout with the same `Uuid` is in state
      */
     doesLayoutExist(layout: Layout): boolean;
     /**
@@ -187,8 +200,9 @@ export interface LayoutApi {
     openLayoutSettingsPanel(): void;
     /**
      * Opens Layout Editor - for Current or a named Layout
-     * @param layoutName Name of Layout to be edited or cloned; if not specified, uses Current Layout
-     * @param action Whether to edit, clone, or create a new Layout
+     * @param layoutName Name of the Layout to edit or clone. Omit it to use the current Layout
+     * @param layoutType `'table'` or `'pivot'`. Used when `action` is `'New'`
+     * @param action `'Edit'`, `'Clone'` or `'New'`. Defaults to `'Edit'`
      */
     showLayoutEditor(layoutName?: string, layoutType?: 'table' | 'pivot', 
     /**
@@ -207,8 +221,8 @@ export interface LayoutApi {
      */
     deleteLayout(layout: Layout): void;
     /**
-     * Deletes an existing Layout provided by Name (if not Default or only existing Layout)
-     * @param layout Name of the Layout to delete
+     * Deletes a Layout by name. Does nothing when it is the only Layout.
+     * @param layoutName Name of the Layout to delete
      */
     deleteLayoutByName(layoutName: string): void;
     /**

package/src/Api/NamedQueryApi.d.ts

@@ -1,35 +1,39 @@
 import { NamedQuery, NamedQueryState } from '../types';
 /**
- * Provides run-time access to Named Queries
+ * Named Queries saved in AdapTable State, and running a query by object or by name.
  */
 export interface NamedQueryApi {
     /**
      * Adds a new Named Query to Adaptable State
-     * @param namedQueries
+     * @param namedQueries Named Query to add
      */
     addNamedQuery(namedQueries: NamedQuery): void;
     /**
-     * Adds multiple new Named Query to Adaptable State
-     * @param namedQueries
+     * Adds several Named Queries to Adaptable State.
+     * @param namedQueries Named Queries to add
      */
     addNamedQueries(namedQueries: NamedQuery[]): void;
     /**
      * Retrieves Query section from Adaptable State
      *
+     * @returns Query section from Adaptable State
      */
     getNamedQueryState(): NamedQueryState;
     /**
      * Gets all Named Queries in Adaptable State
+     * @returns All Named Queries in Adaptable State
      */
     getNamedQueries(): NamedQuery[];
     /**
      * Retrieves Named Query with given name from State
      * @param namedQueryName Name of Named Query
+     * @returns Named Query with given name from State
      */
     getNamedQueryByName(namedQueryName: string): NamedQuery | undefined;
     /**
-     * Checks if the given Named Query has a valid name
-     * @param namedQueryName Named Query
+     * Whether this Named Query can be saved. The name is required and must not already be used.
+     * @param namedQuery Named Query to check
+     * @returns `true` when this Named Query can be saved. The name is required and must not already be used
      */
     isValidNamedQuery(namedQuery: NamedQuery): NamedQueryValidationResult;
     /**

package/src/Api/NoteApi.d.ts

@@ -1,27 +1,27 @@
 import { AdaptableNote, AdaptableNotes, NoteState } from '../AdaptableState/NoteState';
 import { AdaptableMessageType, CellAddress } from '../../types';
 /**
- * Provides run-time access to Notes Module and related State
+ * Notes attached to cells. Each note has text, a type, and the cell it belongs to.
  */
 export interface NoteApi {
     /**
      * Adds a new Note
-     * @param text
-     * @param primaryKeyValue
-     * @param columnId
+     * @param text Note text
+     * @param primaryKeyValue Primary key of the row
+     * @param columnId Column the note belongs to
      * @param extra optional additional Note properties (e.g. `Author`, `Metadata`, `IsReadOnly`);
      *  `Author` and `CreatedAt` are stamped automatically when not supplied
      */
     addNote(text: string, primaryKeyValue: any, columnId: string, extra?: Partial<AdaptableNote>): void;
     /**
-     * Edits a Note
-     * @param note
+     * Replaces a note already in state.
+     * @param note Note to save
      */
     editNote(note: AdaptableNote): void;
     /**
-     * Edits text of a Note
-     * @param text
-     * @param note
+     * Replaces the text of a note.
+     * @param text New note text
+     * @param note Note to update
      */
     updateNoteText(text: string, note: AdaptableNote): void;
     /**
@@ -31,26 +31,30 @@ export interface NoteApi {
      */
     setNoteType(note: AdaptableNote, noteType: AdaptableMessageType): void;
     /**
-     * Deletes a Note
-     * @param note
+     * Removes a note from state.
+     * @param note Note to delete
      */
     deleteNote(note: AdaptableNote): void;
     /**
      * Gets the Note State
+     * @returns The Note State
      */
     getNoteState(): NoteState;
     /**
      * Gets all Notes
+     * @returns All Notes
      */
     getAllNotes(): AdaptableNotes;
     /**
      * Gets all Notes for a cell
      * @param cellAddress note position
+     * @returns All Notes for a cell
      */
     getNoteForCell(cellAddress: CellAddress): AdaptableNote;
     /**
      * Returns a Note by uuid
      * @param uuid note uuid
+     * @returns A Note by uuid
      */
     getNoteByUuid(uuid: string): AdaptableNote | undefined;
 }

package/src/Api/OpenFinApi.d.ts

@@ -2,23 +2,27 @@ import { OpenFinReport, OpenFinState } from '../AdaptableState/OpenFinState';
 import { AdaptableAlert } from '../AdaptableState/Common/AdaptableAlert';
 import { OpenFinPluginOptions } from '../AdaptableOptions/OpenFinPluginOptions';
 /**
- * Provides run-time access to the OpenFin Plugin
+ * The OpenFin plugin: notifications, and starting or stopping live data.
  */
 export interface OpenFinApi {
     /**
      * Retrieves the OpenFinPlugOptions provided in OpenFin Plugin
+     * @returns The OpenFinPlugOptions provided in OpenFin Plugin
      */
     getPluginOptions(): OpenFinPluginOptions;
     /**
      * Retrieves the OpenFin section of System State
+     * @returns The OpenFin section of System State
      */
     getOpenFinState(): OpenFinState | undefined;
     /**
      * Whether OpenFin is available
+     * @returns `true` when OpenFin is available
      */
     isOpenFinAvailable(): boolean;
     /**
      * Whether OpenFin is currently running
+     * @returns `true` when OpenFin is currently running
      */
     isOpenFinRunning(): boolean;
     /**
@@ -28,15 +32,17 @@ export interface OpenFinApi {
     showNotificationForAlert(alert: AdaptableAlert): void;
     /**
      * Shows a notification in OpenFin
-     * @param notification
+     * @param notification OpenFin notification to show
      */
     showNotification(notification: any): void;
     /**
      * Retrieves the Throttle time for live updates
+     * @returns The Throttle time for live updates
      */
     getOpenFinThrottleTime(): number | undefined;
     /**
      * Retrieves the OpenFin currently sending live data to Excel
+     * @returns The OpenFin currently sending live data to Excel
      */
     getCurrentLiveOpenFinReport(): OpenFinReport | undefined;
     /**

package/src/Api/OptionsApi.d.ts

@@ -1,174 +1,216 @@
 import { ActionColumnOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, CalculatedColumnOptions, ColumnMenuOptions, ColumnOptions, CommentOptions, ContainerOptions, ContextMenuOptions, CustomSortOptions, DashboardOptions, DataChangeHistoryOptions, DataImportOptions, DataSetOptions, EditOptions, EntitlementOptions, ExportOptions, ExpressionOptions, Fdc3Options, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, NoteOptions, NotificationsOptions, QuickSearchOptions, RowFormOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
 /**
- * Range of functions to access Adaptable Options
+ * The Adaptable Options for this instance, including each module's options and the values stored in Adaptable context.
  */
 export interface OptionsApi {
     /**
      * Returns `AdaptableOptions.adaptableId`
+     * @returns `AdaptableOptions.adaptableId`
      */
     getAdaptableId(): string;
     /**
      * Returns `AdaptableOptions.adaptableStateKey`
+     * @returns `AdaptableOptions.adaptableStateKey`
      */
     getAdaptableStateKey(): string;
     /**
      * Returns `AdaptableOptions.autogeneratePrimaryKey`
+     * @returns `AdaptableOptions.autogeneratePrimaryKey`
      */
     isAutogeneratePrimaryKey(): boolean;
     /**
      * Returns `AdaptableOptions.licenseKey`
+     * @returns `AdaptableOptions.licenseKey`
      */
     getLicenseKey(): string;
     /**
      * Returns `AdaptableOptions.primaryKey`
+     * @returns `AdaptableOptions.primaryKey`
      */
     getPrimaryKey(): string;
     /**
      * Returns `AdaptableOptions.userName`
+     * @returns `AdaptableOptions.userName`
      */
     getUserName(): string;
     /**
      * Returns provided `AdaptableOptions`
+     * @returns Provided `AdaptableOptions`
      */
     getAdaptableOptions(): Readonly<AdaptableOptions>;
     /**
      * Returns `AdaptableOptions.actionColumnOptions`
+     * @returns `AdaptableOptions.actionColumnOptions`
      */
     getActionColumnOptions(): Readonly<ActionColumnOptions>;
     /**
      * Returns `AdaptableOptions.alertOptions`
+     * @returns `AdaptableOptions.alertOptions`
      */
     getAlertOptions(): Readonly<AlertOptions>;
     /**
      * Returns `AdaptableOptions.expressionOptions`
+     * @returns `AdaptableOptions.expressionOptions`
      */
     getExpressionOptions(): Readonly<ExpressionOptions>;
     /**
      * Returns `AdaptableOptions.calendarOptions`
+     * @returns `AdaptableOptions.calendarOptions`
      */
     getCalendarOptions(): Readonly<CalendarOptions>;
     /**
      * Returns `AdaptableOptions.cellSummaryOptions`
+     * @returns `AdaptableOptions.cellSummaryOptions`
      */
     getCellSummaryOptions(): Readonly<CellSummaryOptions>;
     /**
      * Returns `AdaptableOptions.chartingOptions`
+     * @returns `AdaptableOptions.chartingOptions`
      */
     getChartingOptions(): Readonly<ChartingOptions>;
     /**
      * Returns `AdaptableOptions.containerOptions`
+     * @returns `AdaptableOptions.containerOptions`
      */
     getContainerOptions(): Readonly<ContainerOptions>;
     /**
      * Returns `AdaptableOptions.columnOptions`
+     * @returns `AdaptableOptions.columnOptions`
      */
     getColumnOptions(): Readonly<ColumnOptions>;
     /**
      * Returns `AdaptableOptions.commentOptions`
+     * @returns `AdaptableOptions.commentOptions`
      */
     getCommentOptions(): Readonly<CommentOptions>;
     /**
      * Returns `AdaptableOptions.calculatedColumnOptions`
+     * @returns `AdaptableOptions.calculatedColumnOptions`
      */
     getCalculatedColumnOptions(): Readonly<CalculatedColumnOptions>;
     /**
      * Returns `AdaptableOptions.customSortOptions`
+     * @returns `AdaptableOptions.customSortOptions`
      */
     getCustomSortOptions(): Readonly<CustomSortOptions>;
     /**
      * Returns `AdaptableOptions.dashboardOptions`
+     * @returns `AdaptableOptions.dashboardOptions`
      */
     getDashboardOptions(): Readonly<DashboardOptions>;
     /**
      * Returns `AdaptableOptions.dataChangeHistoryOptions`
+     * @returns `AdaptableOptions.dataChangeHistoryOptions`
      */
     getDataChangeHistoryOptions(): Readonly<DataChangeHistoryOptions>;
     /**
      * Returns `AdaptableOptions.dataSetOptions`
+     * @returns `AdaptableOptions.dataSetOptions`
      */
     getDataSetOptions(): Readonly<DataSetOptions>;
     /**
      * Returns `AdaptableOptions.editOptions`
+     * @returns `AdaptableOptions.editOptions`
      */
     getEditOptions(): Readonly<EditOptions>;
     /**
      * Returns `AdaptableOptions.entitlementOptions`
+     * @returns `AdaptableOptions.entitlementOptions`
      */
     getEntitlementOptions(): Readonly<EntitlementOptions>;
     /**
      * Returns `AdaptableOptions.exportOptions`
+     * @returns `AdaptableOptions.exportOptions`
      */
     getExportOptions(): Readonly<ExportOptions>;
     /**
      * Returns `AdaptableOptions.filterOptions`
+     * @returns `AdaptableOptions.filterOptions`
      */
     getFilterOptions(): Readonly<FilterOptions>;
     /**
      * Returns `AdaptableOptions.flashingCellOptions`
+     * @returns `AdaptableOptions.flashingCellOptions`
      */
     getFlashingCellOptions(): Readonly<FlashingCellOptions>;
     /**
      * Returns `AdaptableOptions.layoutOptions`
+     * @returns `AdaptableOptions.layoutOptions`
      */
     getLayoutOptions(): Readonly<LayoutOptions>;
     /**
      * Returns `AdaptableOptions.columnMenuOptions`
+     * @returns `AdaptableOptions.columnMenuOptions`
      */
     getColumnMenuOptions(): Readonly<ColumnMenuOptions>;
     /**
      * Returns `AdaptableOptions.contextMenuOptions`
+     * @returns `AdaptableOptions.contextMenuOptions`
      */
     getContextMenuOptions(): Readonly<ContextMenuOptions>;
     /**
      * Returns `AdaptableOptions.notificationsOptions`
+     * @returns `AdaptableOptions.notificationsOptions`
      */
     getNotificationsOptions(): Readonly<NotificationsOptions>;
     /**
      * Returns `AdaptableOptions.rowFormOptions`
+     * @returns `AdaptableOptions.rowFormOptions`
      */
     getRowFormOptions(): Readonly<RowFormOptions>;
     /**
      * Returns `AdaptableOptions.quickSearchOptions`
+     * @returns `AdaptableOptions.quickSearchOptions`
      */
     getQuickSearchOptions(): Readonly<QuickSearchOptions>;
     /**
      * Returns `AdaptableOptions.formatColumnOptions`
+     * @returns `AdaptableOptions.formatColumnOptions`
      */
     getFormatColumnOptions(): Readonly<FormatColumnOptions>;
     /**
      * Returns `AdaptableOptions.noteOptions`
+     * @returns `AdaptableOptions.noteOptions`
      */
     getNoteOptions(): Readonly<NoteOptions>;
     /**
      * Returns `AdaptableOptions.settingsPanelOptions`
+     * @returns `AdaptableOptions.settingsPanelOptions`
      */
     getSettingsPanelOptions(): Readonly<SettingsPanelOptions>;
     /**
      * Returns `AdaptableOptions.stateOptions`
+     * @returns `AdaptableOptions.stateOptions`
      */
     getStateOptions(): Readonly<StateOptions>;
     /**
      * Returns `AdaptableOptions.teamSharingOptions`
+     * @returns `AdaptableOptions.teamSharingOptions`
      */
     getTeamSharingOptions(): Readonly<TeamSharingOptions>;
     /**
      * Returns `AdaptableOptions.toolPanelOptions`
+     * @returns `AdaptableOptions.toolPanelOptions`
      */
     getToolPanelOptions(): Readonly<ToolPanelOptions>;
     /**
      * Returns `AdaptableOptions.userInterfaceOptions`
+     * @returns `AdaptableOptions.userInterfaceOptions`
      */
     getUserInterfaceOptions(): Readonly<UserInterfaceOptions>;
     /**
      * Returns `AdaptableOptions.fdc3Options`
+     * @returns `AdaptableOptions.fdc3Options`
      */
     getFdc3Options(): Readonly<Fdc3Options>;
     /**
      * Returns `AdaptableOptions.dataImportOptions`
+     * @returns `AdaptableOptions.dataImportOptions`
      */
     getDataImportOptions(): Readonly<DataImportOptions>;
     /**
      * Returns `AdaptableOptions.adaptableContext`
+     * @returns `AdaptableOptions.adaptableContext`
      */
     getAdaptableContext<TContext = Record<string, any>>(): TContext;
     /**

package/src/Api/PluginsApi.d.ts

@@ -3,16 +3,18 @@ import { IPushPullApi } from './IPushPullApi';
 import { OpenFinApi } from './OpenFinApi';
 import { InteropioPluginApi } from './InteropioPluginApi';
 /**
- * API methods dealing with AdapTable plugins
+ * The loaded plugins, and the OpenFin, ipushpull and interop.io plugin APIs.
  */
 export interface PluginsApi {
     /**
      * Retrieves the Plugin State (internal only)
+     * @returns The Plugin State (internal only)
      */
     getPluginsState(): PluginsState;
     /**
      * Gets the State for a given Plugin
      * @param pluginId plugin state to retrieve
+     * @returns The State for a given Plugin
      */
     getPluginState(pluginId: string): any;
     /**
@@ -29,14 +31,17 @@ export interface PluginsApi {
     setPluginState(pluginId: string, pluginState: any): void;
     /**
      * Returns ipushpull API class in Adaptable API
+     * @returns Ipushpull API class in Adaptable API
      */
     getipushpullPluginApi(): IPushPullApi;
     /**
      * Returns OpenFin API class in Adaptable API
+     * @returns OpenFin API class in Adaptable API
      */
     getOpenFinPluginApi(): OpenFinApi;
     /**
      * Returns Interopio API class in Adaptable API
+     * @returns Interopio API class in Adaptable API
      */
     getInteropioPluginApi(): InteropioPluginApi;
 }

package/src/Api/PlusMinusApi.d.ts

@@ -1,13 +1,14 @@
 import { PlusMinusState, PlusMinusNudge } from '../AdaptableState/PlusMinusState';
 import { CellUpdateRequest, GridCell } from '../AdaptableState/Selection/GridCell';
 /**
- * Provides run-time access to the Plus / Minus Module and associated state
+ * Plus Minus nudges that change a numeric cell by a configured amount.
  */
 export interface PlusMinusApi {
     /**
      * Retrieves Plus Minus section from Adaptable State (nudge rules only).
      * Keyboard triggers are optional on each {@link PlusMinusNudge}; unset fields fall back to
      * `AdaptableOptions.plusMinusOptions`, then `+` / `-`.
+     * @returns Plus Minus section from Adaptable State (nudge rules only). Keyboard triggers are optional on each {@link PlusMinusNudge}; unset fields fall back to `AdaptableOptions.plusMinusOptions`, then `+` / `-`
      */
     getPlusMinusState(): PlusMinusState;
     /**

package/src/Api/QuickSearchApi.d.ts

@@ -1,11 +1,12 @@
 import { AdaptableStyle } from '../AdaptableState/Common/AdaptableStyle';
 import { QuickSearchState } from '../AdaptableState/QuickSearchState';
 /**
- * Provides run-time access to Quick Search Module
+ * Quick Search: the current search text, the next and previous match, and the match styles.
  */
 export interface QuickSearchApi {
     /**
      * Retrieves Quick Search section from Adaptable State
+     * @returns Quick Search section from Adaptable State
      */
     getQuickSearchState(): QuickSearchState;
     /**
@@ -27,18 +28,22 @@ export interface QuickSearchApi {
     gotoPreviousMatch(): void;
     /**
      * Retrieves current Quick Search text
+     * @returns Current Quick Search text
      */
     getQuickSearchValue(): string;
     /**
      * Retrieves whole-cell style for matching Quick Search cells (undefined when unset on client-side)
+     * @returns Whole-cell style for matching Quick Search cells (undefined when unset on client-side)
      */
     getQuickSearchCellMatchStyle(): AdaptableStyle | undefined;
     /**
      * Retrieves the style for matched text within Quick Search results (includes run-time default when unset)
+     * @returns The style for matched text within Quick Search results (includes run-time default when unset)
      */
     getQuickSearchTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'>;
     /**
      * Retrieves the style for the active Quick Search match (includes run-time default when unset)
+     * @returns The style for the active Quick Search match (includes run-time default when unset)
      */
     getQuickSearchCurrentTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'>;
     /**

package/src/Api/RowFormApi.d.ts

@@ -1,10 +1,11 @@
 /**
- * Functions for accessing Action Columns
+ * Row Forms. Opens the form used to create, clone or edit a row, and deletes a row by primary key.
+ * Deleting does not open a form.
  */
 export interface RowFormApi {
     /**
-     * Open edit dialog for row with the given primary key value
-     * @param primaryKey - the primary key of the edited row
+     * Opens the Row Form to edit the row with this primary key.
+     * @param primaryKey Primary key of the row to edit
      */
     displayEditRowForm(primaryKey: any): Promise<void>;
     /**
@@ -12,13 +13,13 @@ export interface RowFormApi {
      */
     displayCreateRowForm(): Promise<void>;
     /**
-     * Open create dialog for cloning an existing row
-     * @param primaryKey - Primary Key of the duplicated row
+     * Opens the Row Form to create a row, prefilled from an existing row.
+     * @param primaryKey Primary key of the row to clone. Omit it to open an empty clone form
      */
     displayCloneRowForm(primaryKey?: any): Promise<void>;
     /**
-     * Deletes row from grid (with event fired) - note: no visible Row Form is displayed
-     * @param primaryKey - Primary Key of the deleted row
+     * Deletes a row and fires the Row Form submitted event. No form is shown.
+     * @param primaryKey Primary key of the row to delete
      */
     displayDeleteRowForm(primaryKey?: any): void;
 }

package/src/Api/ShortcutApi.d.ts

@@ -1,10 +1,11 @@
 import { ShortcutState, Shortcut } from '../AdaptableState/ShortcutState';
 /**
- * Provides run-time access to Shortcut Module and associated state
+ * Keyboard shortcuts that change a cell value.
  */
 export interface ShortcutApi {
     /**
      * Retrieves Shortcut section from Adaptable State
+     * @returns Shortcut section from Adaptable State
      */
     getShortcutState(): ShortcutState;
     /**
@@ -48,6 +49,7 @@ export interface ShortcutApi {
     /**
      * Edits Shortcut in state
      * @param shortcut Shortcut to edit
+     * @returns The shortcut after it is saved
      */
     editShortcut(shortcut: Shortcut): Shortcut;
     /**