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

package/src/AdaptableOptions/Fdc3Options.d.ts

@@ -181,77 +181,151 @@ export interface HandleFdc3IntentContext extends HandleFdc3Context {
 }
 export declare const ColumnRefTypePrefix = "_colId.";
 export declare const FieldRefTypePrefix = "_field.";
+/**
+ * Points one FDC3 context field at a grid column or a row field.
+ *
+ * `` `_colId.${columnId}` `` reads the column. `` `_field.${fieldName}` `` reads a field that is not a column.
+ */
 export type GridDataRef = `_colId.${string}` | `_field.${string}`;
+/**
+ * Maps each field of an FDC3 context (other than `type`) to a {@link GridDataRef}.
+ *
+ * AdapTable builds the context for a row by reading those columns and fields.
+ */
 export type Fdc3ContentMapping<T> = PropertiesToGridRefs<Omit<T, 'type'>>;
 /**
- * Mapping of FDC3 Context Types to Grid Data/Columns
+ * Which grid columns fill each standard FDC3 context, keyed by the context type.
+ *
+ * Set `custom` for a context type that is not one of the standard names.
  */
 export interface GridDataContextMapping {
+    /** Maps an `fdc3.action` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.action'?: Fdc3ContentMapping<Action>;
+    /** Maps an `fdc3.chart` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.chart'?: Fdc3ContentMapping<Chart>;
+    /** Maps an `fdc3.chat.initSettings` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.chat.initSettings'?: Fdc3ContentMapping<ChatInitSettings>;
+    /** Maps an `fdc3.chat.message` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.chat.message'?: Fdc3ContentMapping<ChatMessage>;
+    /** Maps an `fdc3.chat.room` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.chat.room'?: Fdc3ContentMapping<ChatRoom>;
+    /** Maps an `fdc3.chat.searchCriteria` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.chat.searchCriteria'?: Fdc3ContentMapping<ChatSearchCriteria>;
+    /** Maps an `fdc3.contact` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.contact'?: Fdc3ContentMapping<Contact>;
+    /** Maps an `fdc3.contactList` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.contactList'?: Fdc3ContentMapping<ContactList>;
+    /** Maps an `fdc3.country` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.country'?: Fdc3ContentMapping<Country>;
+    /** Maps an `fdc3.currency` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.currency'?: Fdc3ContentMapping<Currency>;
+    /** Maps an `fdc3.email` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.email'?: Fdc3ContentMapping<Email>;
+    /** Maps an `fdc3.instrument` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.instrument'?: Fdc3ContentMapping<Instrument>;
+    /** Maps an `fdc3.instrumentList` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.instrumentList'?: Fdc3ContentMapping<InstrumentList>;
+    /** Maps an `fdc3.interaction` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.interaction'?: Fdc3ContentMapping<Interaction>;
+    /** Maps an `fdc3.message` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.message'?: Fdc3ContentMapping<Message>;
+    /** Maps an `fdc3.organization` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.organization'?: Fdc3ContentMapping<Organization>;
+    /** Maps an `fdc3.portfolio` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.portfolio'?: Fdc3ContentMapping<Portfolio>;
+    /** Maps an `fdc3.position` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.position'?: Fdc3ContentMapping<Position>;
+    /** Maps an `fdc3.timerange` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.timerange'?: Fdc3ContentMapping<TimeRange>;
+    /** Maps an `fdc3.transactionResult` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.transactionResult'?: Fdc3ContentMapping<TransactionResult>;
+    /** Maps an `fdc3.valuation` context. Each field is a `_colId.` or `_field.` reference. */
     'fdc3.valuation'?: Fdc3ContentMapping<Valuation>;
+    /**
+     * Column mapping for a context type that is not one of the standard names. The key is the context type.
+     */
     custom?: {
         [key: string]: Fdc3ContentMapping<Context>;
     };
 }
 /**
- * Defines config options for Raising FDC3 Intents
+ * When each standard FDC3 intent is raised from the grid. The property name is the intent.
+ *
+ * Each value lists the grid actions that raise it (for example a cell click or a button). Use `custom` for an intent that is not a standard name.
  */
 export interface RaiseIntentConfiguration {
+    /** Grid actions that raise the standard `StartCall` intent. */
     StartCall?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `StartChat` intent. */
     StartChat?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `StartEmail` intent. */
     StartEmail?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewAnalysis` intent. */
     ViewAnalysis?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewChart` intent. */
     ViewChart?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewContact` intent. */
     ViewContact?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewHoldings` intent. */
     ViewHoldings?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewInstrument` intent. */
     ViewInstrument?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewInteractions` intent. */
     ViewInteractions?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewNews` intent. */
     ViewNews?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewOrders` intent. */
     ViewOrders?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewProfile` intent. */
     ViewProfile?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewQuote` intent. */
     ViewQuote?: RaiseIntentConfig[];
+    /** Grid actions that raise the standard `ViewResearch` intent. */
     ViewResearch?: RaiseIntentConfig[];
+    /**
+     * When to raise an intent that is not one of the standard names. The key is the intent name.
+     */
     custom?: {
         [customIntent: string]: RaiseIntentConfig[];
     };
 }
 /**
- * Defines config options for Broadcasting FDC3 Context
+ * When each standard FDC3 context is broadcast from the grid. The property name is the context type.
+ *
+ * Use `custom` for a context type that is not a standard name.
  */
 export interface BroadcastConfiguration {
+    /** When to broadcast an `fdc3.chart` context. */
     'fdc3.chart'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.chat.initSettings` context. */
     'fdc3.chat.initSettings'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.contact` context. */
     'fdc3.contact'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.contactList` context. */
     'fdc3.contactList'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.country` context. */
     'fdc3.country'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.currency` context. */
     'fdc3.currency'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.email` context. */
     'fdc3.email'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.instrument` context. */
     'fdc3.instrument'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.instrumentList` context. */
     'fdc3.instrumentList'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.organization` context. */
     'fdc3.organization'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.portfolio` context. */
     'fdc3.portfolio'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.position` context. */
     'fdc3.position'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.timerange` context. */
     'fdc3.timerange'?: BroadcastConfig;
+    /** When to broadcast an `fdc3.valuation` context. */
     'fdc3.valuation'?: BroadcastConfig;
+    /**
+     * When to broadcast a context type that is not one of the standard names. The key is the context type.
+     */
     custom?: {
         [customContext: string]: BroadcastConfig;
     };

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -3,18 +3,19 @@ import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { AdaptableColumnContext } from '../AdaptableState/Common/AdaptableColumnContext';
 import { IRowNode } from 'ag-grid-enterprise';
 /**
- * Options for managing Column & Grid Filters in AdapTable
+ * Column Filters (one column) and the Grid Filter (a query across columns).
+ *
+ * The filters a user creates are stored on the Layout. These options change how filtering works for the whole grid.
  */
 export interface FilterOptions<TData = any> {
     /**
-     * Options for managing Column Filters
+     * The filter row under the column headers, and the operator offered first for each data type.
      */
     columnFilterOptions?: ColumnFilterOptions;
     /**
      * Clear Grid and Column Filters when AdapTable loads
      *
      * @defaultValue false
-     * @noCodeItem
      */
     clearFiltersOnStartUp?: boolean;
     /**
@@ -38,7 +39,6 @@ export interface FilterOptions<TData = any> {
     isRowFilterable?: (context: IsRowFilterableContext) => boolean;
     /**
      * Show Date Picker (or Date Input) in Filter controls
-     * @noCodeItem
      * @defaultValue true
      */
     showDatePicker?: boolean;
@@ -46,7 +46,6 @@ export interface FilterOptions<TData = any> {
      * Use Adaptable's Column & Grid Filters in preference to AG Grid's filtering
      *
      * @defaultValue true
-     * @noCodeItem
      */
     useAdaptableFiltering?: boolean;
 }
@@ -58,14 +57,12 @@ export interface ColumnFilterOptions<TData = any> {
      * Make Column Header distinctive for filtered columns, helps users see currently filtered columns
      *
      * @defaultValue true
-     * @noCodeItem
      */
     indicateFilteredColumns?: boolean;
     /**
      * Manually apply Column Filters; an Apply Filter button is displayed and Quick Filter is disabled
      *
      * @defaultValue false
-     * @noCodeItem
      */
     manuallyApplyColumnFilter?: boolean | ((context: AdaptableColumnContext) => boolean);
     /**
@@ -110,7 +107,6 @@ export interface ColumnFilterOptions<TData = any> {
     /**
      * Display Quick Filter Bar between Column Header and Grid (provided its been setup)
      * @defaultValue  true
-     * @noCodeItem
      */
     showQuickFilter?: boolean;
     /**
@@ -201,7 +197,13 @@ export interface InFilterValue<ValueType = any> {
      * Tooltip for Item (if true, the label is used as tooltip)
      */
     tooltip?: boolean | string;
+    /**
+     * Depth of this item when the list is a tree. `0` is the root.
+     */
     level?: number;
+    /**
+     * Child items, used for a grouped or date tree. Selecting a parent selects its leaves.
+     */
     children?: InFilterValue<ValueType>[];
 }
 /**
@@ -286,6 +288,9 @@ export interface InFilterValueInfo extends InFilterValue {
      * Whether Item is currently visible in Grid (i.e. in filtered rows)
      */
     visible?: boolean;
+    /**
+     * Child items, with the same counts and selection state as this item.
+     */
     children?: InFilterValueInfo[];
     /**
      * For the grouping scenario, how many leafs are there under this item

package/src/AdaptableOptions/FlashingCellOptions.d.ts

@@ -10,17 +10,17 @@ export interface FlashingCellOptions {
     defaultFlashTarget?: FlashTarget;
     /**
      * Style for 'Down' value changes
-     *  @defaultValue  Red BackColour
+     * @defaultValue  BackColor of `var(--ab-color-flash-down)` (red in the shipped themes)
      */
     defaultDownChangeStyle?: AdaptableStyle;
     /**
      * Style for 'Up' value changes
-     * @defaultValue  Green BackColour
+     * @defaultValue  BackColor of `var(--ab-color-flash-up)` (green in the shipped themes)
      */
     defaultUpChangeStyle?: AdaptableStyle;
     /**
      * Style for 'Neutral' value changes
-     * @defaultValue  Gray BackColour
+     * @defaultValue  BackColor of `var(--ab-color-flash-neutral)` (gray in the shipped themes)
      */
     defaultNeutralChangeStyle?: AdaptableStyle;
     /**

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -18,7 +18,11 @@ export interface LayoutOptions<TData = any> {
      */
     enableLayoutExtensionsUI?: boolean;
     /**
-     * @deprecated Layouts now extended through `Layout.LayoutExtensions` in Adaptable State
+     * Tag-based layout extensions. Do not set this.
+     *
+     * Extend an object into a Layout with `Layout.LayoutExtensions` in Adaptable State.
+     *
+     * @deprecated Layouts are extended through `Layout.LayoutExtensions` in Adaptable State
      */
     layoutTagOptions?: LayoutTagOptions;
     /**
@@ -138,9 +142,16 @@ export interface LayoutRowSelectionContext<TData = any> extends AdaptableColumnC
 /**
  * @deprecated since v24 Layouts are extended through `Layout.LayoutExtensions`; will be removed in v25
  */
+/**
+ * Unused. Extend objects into a Layout with `Layout.LayoutExtensions`.
+ *
+ * @deprecated Layouts are extended through `Layout.LayoutExtensions` in Adaptable State
+ */
 export interface LayoutTagOptions {
     /**
-     * @deprecated no longer generates Tags (v24)
+     * Not called. Extend objects with `Layout.LayoutExtensions`.
+     *
+     * @deprecated no longer generates Tags
      */
     autoGenerateTagsForLayouts?: boolean | ((context: any) => AdaptableObjectTag[]);
     /**
@@ -150,7 +161,9 @@ export interface LayoutTagOptions {
      */
     autoCheckTagsForLayouts?: boolean;
     /**
-     * @deprecated no longer called (v24) - define extensions in `Layout.LayoutExtensions` instead
+     * Not called. Extend objects with `Layout.LayoutExtensions`.
+     *
+     * @deprecated no longer called. Define extensions in `Layout.LayoutExtensions` instead
      */
     isObjectExtendedInLayout?: (context: any) => boolean;
 }

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -6,7 +6,6 @@ export interface NotificationsOptions {
      * How many Notifications can be displayed at one time
      *
      * @defaultValue  3
-     * @noCodeItem
      */
     maxNotifications?: number;
     /**

package/src/AdaptableOptions/QuickSearchOptions.d.ts

@@ -29,14 +29,12 @@ export interface QuickSearchOptions<TData = any> {
      * Filters Grid after quick search so only matching rows are displayed
      *
      * @defaultValue false
-     * @noCodeItem
      */
     filterGridAfterQuickSearch?: boolean;
     /**
      * Run Quick Search using Case Sensitivity
      *
      * @defaultValue false
-     * @noCodeItem
      */
     isQuickSearchCaseSensitive?: boolean;
 }

package/src/AdaptableOptions/RowFormOptions.d.ts

@@ -129,13 +129,22 @@ export interface EditRowFormContext<TData = any> extends FormContext {
  * Context used for overriding Title and Description of Row Form
  */
 export interface RowFormTitleContext<TData = any> extends BaseContext {
+    /**
+     * Which form is open. `'rowCreated'` is create or clone. `'rowEdited'` is edit. Delete does not use this context.
+     */
     type: Extract<RowFormType, 'rowEdited' | 'rowCreated'>;
+    /**
+     * Row being edited or cloned. Absent when the form creates a new row.
+     */
     rowNode?: IRowNode<TData>;
 }
 /**
  * Context used for overriding Field elements in Row Form
  */
 export interface RowFormFieldContext<TData = any> extends RowFormTitleContext {
+    /**
+     * Column the field is being built for. Return a partial field to override the default for this column only.
+     */
     column: AdaptableColumn<TData>;
 }
 /**

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -31,11 +31,15 @@ export interface SettingsPanelOptions {
      */
     displayOptions?: SettingsPanelDisplayOptions;
     /**
+     * Whether module icons show in the navigation. Set `displayOptions.showModuleIcons` instead.
+     *
      * @deprecated Use `displayOptions.showModuleIcons` instead.
      * @defaultValue true
      */
     showModuleIcons?: boolean;
     /**
+     * Whether module descriptions show under each name. Set `displayOptions.showModuleDescriptions` instead.
+     *
      * @deprecated Use `displayOptions.showModuleDescriptions` instead.
      * @defaultValue true
      */
@@ -43,7 +47,6 @@ export interface SettingsPanelOptions {
     /**
      * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel
      * @defaultValue false
-     *  @noCodeItem
      */
     alwaysShowInToolPanel?: boolean;
     /**
@@ -74,9 +77,11 @@ export interface SettingsPanelOptions {
      */
     customSettingsPanels?: CustomSettingsPanel[];
     /**
-     * Which Tabs can be used to display Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'
+     * Which Tabs to show in Grid Info: 'Grid Summary', 'Layout', 'Grid State' or 'Grid Options'
      *
-     * @defaultValue ['Grid Options', 'Grid Summary', 'Grid State']
+     * Tab labels in the UI are Summary, Layout, State and Options
+     *
+     * @defaultValue ['Grid Summary', 'Layout', 'Grid State', 'Grid Options']
      */
     gridInfoTabs?: GridInfoTabs;
 }
@@ -123,6 +128,9 @@ export interface SettingsPanelNavigationGroup {
  * Grouped Settings Panel navigation structure.
  */
 export interface SettingsPanelNavigation {
+    /**
+     * Groups, in the order they appear. Each group has a heading and the modules inside it.
+     */
     groups: SettingsPanelNavigationGroup[];
 }
 /**
@@ -145,6 +153,9 @@ export type SettingsPanelNavigationConfigurer = (context: SettingsPanelNavigatio
  * removed in the next major release.
  */
 export interface LegacyFlatSettingsPanelNavigation {
+    /**
+     * Modules in one list. The string `'-'` starts a new group.
+     */
     items?: (AdaptableSettingsPanel | string | '-')[];
 }
 /**
@@ -182,6 +193,6 @@ export type PopupType = 'modal' | 'window';
  */
 export type GridInfoTabs = GridInfoTab[];
 /**
- * Tab to use for Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State'
+ * Tab to use for Grid Info: 'Grid Summary', 'Layout', 'Grid State' or 'Grid Options'
  */
-export type GridInfoTab = 'Grid Options' | 'Grid Summary' | 'Grid State';
+export type GridInfoTab = 'Grid Summary' | 'Layout' | 'Grid State' | 'Grid Options';

package/src/AdaptableOptions/StateOptions.d.ts

@@ -1,12 +1,22 @@
-import { AdaptableState } from '../AdaptableState/AdaptableState';
+import { AdaptablePersistentState } from '../AdaptableState/AdaptableState';
 import { AdaptableApi } from '../Api/AdaptableApi';
 /**
  * Options related to Adaptable State hydration / dehydration; allows users to intercept state persistence and loading with custom functionality
+ *
+ * All functions deal with `AdaptablePersistentState` - the persisted subset of `AdaptableState`.
+ * Transient sections (`Internal`, `Popup`, `Comment`, `Plugins`) are never passed to, nor expected from, these functions.
+ *
+ * Hydration flow: `loadState()` -> (merge with `initialState`) -> `applyState()`
+ *
+ * Dehydration flow: `saveState()` -> `persistState()`
+ *
+ * To store Adaptable State in a custom format (e.g. wrapped in an envelope, compressed, encrypted) do the wrapping in `persistState()` and the unwrapping in `loadState()` - these are the only functions which own the storage format.
+ * `saveState()` and `applyState()` always operate on Adaptable State, as `loadState()`'s result is merged with `initialState` section by section before `applyState()` is called.
  */
 export interface StateOptions {
     /**
      * Retrieves saved Adaptable State from storage or external source
-     * @returns Promise resolving to the retrieved state object
+     * @returns Promise resolving to the retrieved (possibly partial) state object, or to nothing if no state was persisted yet
      */
     loadState?: AdaptableLoadStateFunction;
     /**
@@ -15,7 +25,7 @@ export interface StateOptions {
      */
     persistState?: AdaptablePersistStateFunction;
     /**
-     * Transforms state before applying it to the application. Called after `loadState()` but before the state is used.
+     * Transforms state before applying it to the application. Called after `loadState()` (and after merging with `initialState`) but before the state is used.
      * @returns The transformed state object
      */
     applyState?: AdaptableApplyStateFunction;
@@ -74,63 +84,77 @@ export interface AdaptableStateFunctionConfig {
      */
     actionName?: string;
     /**
-     * Previous state before the action was applied.
+     * Previous (persistent) state before the action was applied.
      * This is useful for comparing changes or reverting if necessary.
      */
-    previousState?: AdaptableState;
+    previousState?: AdaptablePersistentState;
 }
 /**
  * Function that handles persisting state to storage systems (localStorage, server, etc.).
  * Called after `saveState()` to store the prepared state.
  *
+ * This is the place to apply any custom storage format (envelope, compression, encryption, etc.); the matching `loadState()` is expected to undo it.
+ *
  * @example
  * ```
  * persistState = (state, stateFunctionConfig) => {
- *  localStorage.setItem(stateFunctionConfig.adaptableStateKey, JSON.stringify(state))
+ *  localStorage.setItem(stateFunctionConfig.adaptableStateKey, JSON.stringify(state));
+ *  return Promise.resolve();
  * }
  * ```
  *
  * @param state The state to be persisted
  * @param adaptableStateFunctionConfig Configuration details for the current Adaptable instance
- * @returns Promise resolving once persistence is complete
+ * @returns Promise resolving once persistence is complete; the resolved value is ignored
  */
 export interface AdaptablePersistStateFunction {
-    (state: any, adaptableStateFunctionConfig: AdaptableStateFunctionConfig): Promise<any>;
+    (state: AdaptablePersistentState, adaptableStateFunctionConfig: AdaptableStateFunctionConfig): Promise<unknown>;
 }
 /**
  * Function that clears persisted state from the storage system.
  * Only invoked during `StateApi.reloadInitialState()` operations.
+ *
+ * @returns Promise resolving once the persisted state is cleared; the resolved value is ignored
  */
 export interface AdaptableClearStateFunction {
-    (adaptableStateFunctionConfig: AdaptableStateFunctionConfig): Promise<any>;
+    (adaptableStateFunctionConfig: AdaptableStateFunctionConfig): Promise<unknown>;
 }
 /**
  * Function that transforms state before persistence. Called first in the persistence flow, before `persistState()`.
  *
+ * The received state is the full persistent state of the current Adaptable instance (transient sections are already stripped).
+ *
  * @param state The Adaptable state to transform before saving
  * @param adaptableStateFunctionConfig Configuration details for the current Adaptable instance
  * @returns The modified state ready for persistence
  */
 export interface AdaptableSaveStateFunction {
-    (state: AdaptableState, adaptableStateFunctionConfig: AdaptableStateFunctionConfig): any;
+    (state: AdaptablePersistentState, adaptableStateFunctionConfig: AdaptableStateFunctionConfig): AdaptablePersistentState;
 }
 /**
  * Function that retrieves Adaptable state from storage or external source. Called during initialization to hydrate the application state.
  *
+ * The result is merged with `AdaptableOptions.initialState` before being passed to `applyState()`, so it may be partial (only the sections which were persisted) or empty / nullish (nothing was persisted yet).
+ *
+ * This is the place to undo any custom storage format applied in `persistState()`.
+ *
  * @param config Configuration details for the current Adaptable instance
  * @returns Promise resolving to the retrieved state object
  */
 export interface AdaptableLoadStateFunction {
-    (config: AdaptableStateFunctionConfig): Promise<any>;
+    (config: AdaptableStateFunctionConfig): Promise<Partial<AdaptablePersistentState> | null | void>;
 }
 /**
- * Function that applies the loaded state to the application. Called after `loadState()` but before the state is used.
+ * Function that applies the loaded state to the application. Called after `loadState()` (and after the result was merged with `initialState`) but before the state is used.
  * This allows for any necessary transformations or adjustments before the state is applied.
+ *
+ * The state is partial, as only the sections present in either the persisted state or `initialState` are available at this point; missing sections are initialised with their defaults afterwards.
+ *
  * @param state The loaded state to transform
  * @param adaptableStateFunctionConfig Configuration details for the current Adaptable instance
  *
  * @returns The transformed state object
  */
 export interface AdaptableApplyStateFunction {
-    (state: any, adaptableStateFunctionConfig: AdaptableStateFunctionConfig): any;
+    (state: Partial<AdaptablePersistentState>, adaptableStateFunctionConfig: AdaptableStateFunctionConfig): Partial<AdaptablePersistentState>;
 }

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -10,7 +10,6 @@ export interface ToolPanelOptions {
      * Display the Tool Panels dropdown
      *
      * @defaultValue true
-     * @noCodeItem
      */
     showToolPanelsDropdown?: boolean;
     /**