@adaptabletools/adaptable 24.0.0-canary.8 → 24.0.0

package/src/AdaptableOptions/ContextMenuOptions.d.ts

@@ -40,10 +40,25 @@ export type CustomContextMenuItem = AgGridMenuItem<AgGridContextMenuItemType> |
  * Defines a Grouped Menu Item in the Context Menu
  */
 export type CustomGroupContextMenuItem = {
+    /**
+     * Always `Group`. The item is a submenu, not a clickable command.
+     */
     menuType: 'Group';
+    /**
+     * Text of the submenu.
+     */
     label: string;
+    /**
+     * Items shown when the submenu opens.
+     */
     subMenuItems: CustomContextMenuItem[];
+    /**
+     * When `true`, the submenu cannot be opened.
+     */
     disabled?: boolean;
+    /**
+     * Icon drawn next to the submenu label.
+     */
     icon?: AdaptableIcon;
 };
 /**
@@ -126,12 +141,27 @@ export type AgGridContextMenuItemType = 'autoSizeAll' | 'expandAll' | 'contractA
  */
 export type DefaultAdaptableMenuStructure = (AdaptableSystemContextMenuItem<AdaptableContextMenuItemName> | MenuSeparator)[];
 /**
- * AG Grid section of Context Menu provided by AadapTable by default
+ * AG Grid section of the Context Menu that AdapTable provides by default.
  */
 export type DefaultAgGridMenuStructure = (AgGridMenuItem<AgGridContextMenuItemType> | {
+    /**
+     * Always `Group`. The item is a submenu of AG Grid context-menu entries.
+     */
     menuType: 'Group';
+    /**
+     * Text of the submenu.
+     */
     label: string;
+    /**
+     * AG Grid context-menu entries shown when the submenu opens.
+     */
     subMenuItems: AgGridMenuItem<AgGridContextMenuItemType>[];
+    /**
+     * When `true`, the submenu cannot be opened.
+     */
     disabled?: boolean;
+    /**
+     * Icon drawn next to the submenu label.
+     */
     icon?: AdaptableIcon;
 })[];

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -11,14 +11,12 @@ export interface DashboardOptions {
      * Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode
      *
      * @defaultValue true
-     * @noCodeItem
      */
     canFloat?: boolean;
     /**
      * Shows Quick Search input in Dashboard Header
      *
      * @defaultValue true
-     * @noCodeItem
      */
     showQuickSearchInHeader?: boolean;
     /**
@@ -32,7 +30,6 @@ export interface DashboardOptions {
     /**
      * Where in Dashboard to display Module and Custom Buttons
      * @defaultValue 'right'
-     * @noCodeItem
      */
     buttonsLocation?: DashboardButtonsLocation;
 }

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -8,7 +8,6 @@ export interface DataChangeHistoryOptions<TData = any> {
      * Make Data Change History active by default
      *
      * @defaultValue false
-     * @noCodeItem
      */
     activeByDefault?: boolean;
     /**
@@ -32,7 +31,6 @@ export interface DataChangeHistoryOptions<TData = any> {
      * How many data changes are held in State at any one time; when limit is reached, oldest change(s) are deleted from memory
      *
      * @defaultValue undefined (all data changes are logged)
-     * @noCodeItem
      */
     maxDataChangesInStore?: number;
 }
@@ -69,5 +67,8 @@ export interface DataChangeHistoryContext<TData = any> extends ActionColumnConte
  * A custom AdaptableButton which provides a build in `undo` action
  */
 export interface DataChangeHistoryButton<TData = any> extends AdaptableButton<DataChangeHistoryContext<TData>> {
+    /**
+     * Built-in action the button runs. `'undo'` restores the previous value. `'clear'` removes the change from the log.
+     */
     action?: AdaptableDataChangeHistoryAction;
 }

package/src/AdaptableOptions/EditOptions.d.ts

@@ -29,11 +29,15 @@ export interface EditOptions<TData = any> {
      */
     customEditColumnValues?: (context: CustomEditColumnValuesContext<TData>) => CustomEditColumnValueInfo[] | Promise<CustomEditColumnValueInfo[]>;
     /**
-     * Options for Plus Minus module (keyboard increment / decrement)
+     * Keys that nudge a numeric cell up or down.
+     *
+     * A Plus Minus rule can set its own key. These are the keys used when it does not.
      */
     plusMinusOptions?: PlusMinusOptions;
     /**
-     * Options for Smart Edit module
+     * Extra Smart Edit operations, beyond the ones AdapTable ships.
+     *
+     * A Smart Edit applies one operation to every selected cell.
      */
     smartEditOptions?: SmartEditOptions<TData>;
 }
@@ -58,14 +62,26 @@ export interface CustomEditColumnValuesContext<TData = any> extends AdaptableCol
  * Information about items in the Edit Controls
  */
 export interface EditColumnValueInfo {
+    /**
+     * Value written into the cell when this item is chosen.
+     */
     value: any;
+    /**
+     * Text shown for this item. The value is shown when this is omitted.
+     */
     label?: string;
 }
 /**
  * Information about items in the custom Edit Controls
  */
 export interface CustomEditColumnValueInfo {
+    /**
+     * Value written into the cell when this item is chosen.
+     */
     value: any;
+    /**
+     * Text shown for this item. The value is shown when this is omitted.
+     */
     label?: string;
 }
 /**

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -257,14 +257,37 @@ export interface ExportFormContext extends FormContext {
 /**
  * Type of Export result data: string (CSV), ReportData (JSON), or Blob (Excel)
  */
+/**
+ * Data produced by an export, or returned from `processExport` to replace AdapTable's output.
+ *
+ * `type` selects the shape of `data`.
+ */
 export type ExportResultData = {
+    /**
+     * CSV export.
+     */
     type: 'csv';
+    /**
+     * CSV text.
+     */
     data: string;
 } | {
+    /**
+     * JSON export.
+     */
     type: 'json';
+    /**
+     * Columns and rows of the report.
+     */
     data: ReportData;
 } | {
+    /**
+     * Excel export.
+     */
     type: 'excel';
+    /**
+     * Excel file contents. A `Blob`, or a base64 string.
+     */
     data: Blob | string;
 };
 /**

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -166,14 +166,12 @@ export interface ExpressionOptions<TData = any> {
      * Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)
      *
      * @defaultValue true
-     * @noCodeItem
      */
     displayColumnFriendlyNamesForExpressions?: boolean;
     /**
      * Perform case-sensitive text comparisons when evaluating Expressions
      *
      * @defaultValue false
-     * @noCodeItem
      */
     caseSensitiveExpressions?: boolean;
     /**
@@ -186,7 +184,6 @@ export interface ExpressionOptions<TData = any> {
      * When an `IN` right-hand value is an ISO string containing `T`, the exact instant is used regardless.
      *
      * @defaultValue false
-     * @noCodeItem
      */
     evaluateDatesUsingTime?: boolean | ((context: AdaptableColumnContext) => boolean);
     /**

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/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;
     /**
@@ -125,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[];
 }
 /**
@@ -147,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 | '-')[];
 }
 /**

package/src/AdaptableOptions/ToolPanelOptions.d.ts

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

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -85,7 +85,6 @@ export interface UserInterfaceOptions<TData = any> {
     /**
      * Hides confirmation dialog which displays whenever an AdaptableObject is deleted
      * @defaultValue false
-     * @noCodeItem
      */
     disableDeleteConfirmation?: boolean;
     /**
@@ -114,7 +113,6 @@ export interface LoadingScreenOptions<TData = any> {
     /**
      * Display Loading Screen when AdapTable initialises
      * @defaultValue true
-     * @noCodeItem
      */
     showLoadingScreen?: boolean;
     /**
@@ -208,7 +206,13 @@ export interface ColourPickerFilterContext {
  * Colours to show - must be in list provided (otherwise ignored)
  */
 export interface ColourPickerFilterResult {
+    /**
+     * Theme colours to keep. A colour not in the supplied list is ignored.
+     */
     themeColours: ColourPickerColour[];
+    /**
+     * Palette colours to keep. A colour not in the supplied list is ignored.
+     */
     paletteColours: ColourPickerColour[];
 }
 /**