@adaptabletools/adaptable 24.0.0-canary.0 → 24.0.0-canary.10

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;
     /**

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[];
 }