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

package/src/AdaptableState/Common/Fdc3Context.d.ts

@@ -1,6 +1,15 @@
 import { StandardContextType } from '@finos/fdc3';
+/**
+ * Label and icon used for one standard FDC3 context type.
+ */
 interface ContextConfig {
+    /**
+     * Text shown for this context type.
+     */
     label: string;
+    /**
+     * AdapTable icon name shown for this context type.
+     */
     icon: string;
 }
 export declare const ContextConfiguration: Record<StandardContextType, ContextConfig>;

package/src/AdaptableState/Common/Fdc3Intent.d.ts

@@ -1,5 +1,11 @@
 import { StandardIntent } from '@finos/fdc3';
+/**
+ * Icon used for one standard FDC3 intent.
+ */
 interface IntentConfig {
+    /**
+     * AdapTable icon name shown for this intent.
+     */
     icon: string;
 }
 export declare const Fdc3IntentConfiguration: Record<StandardIntent, IntentConfig>;

package/src/AdaptableState/Common/GridFilter.d.ts

@@ -1,6 +1,8 @@
 import { SuspendableObject } from '../../types';
 /**
- * Defines a Grid Filter (essentially a Boolean Expression)
+ * A boolean AdapTableQL expression applied to every row in a layout.
+ *
+ * Rows that do not match `Expression` are hidden. An empty expression, or `IsSuspended: true`, shows every row. This is separate from each column's `ColumnFilter`.
  */
 export interface GridFilter extends SuspendableObject {
     /**

package/src/AdaptableState/Common/MenuItem.d.ts

@@ -3,6 +3,9 @@ import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupP
 import { AdaptableMenuItem, AdaptableContextMenuItemName, AdaptableColumnMenuItemName } from './Menu';
 import { AdaptableModule } from './Types';
 import { AdaptableIcon, AdaptableSystemIconName } from './AdaptableIcon';
+/**
+ * A shipped menu item that dispatches a Redux action when it is clicked.
+ */
 export declare class MenuItemDoReduxAction<MENU_TYPE_NAME extends AdaptableColumnMenuItemName | AdaptableContextMenuItemName = AdaptableColumnMenuItemName | AdaptableContextMenuItemName> implements AdaptableMenuItem<MENU_TYPE_NAME> {
     constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, reduxAction: Redux.Action, icon: AdaptableSystemIconName | AdaptableIcon, isVisible: boolean);
     name: MENU_TYPE_NAME;
@@ -12,6 +15,9 @@ export declare class MenuItemDoReduxAction<MENU_TYPE_NAME extends AdaptableColum
     isVisible: boolean;
     icon: AdaptableIcon;
 }
+/**
+ * A shipped menu item that runs a function when it is clicked.
+ */
 export declare class MenuItemDoClickFunction<MENU_TYPE_NAME extends AdaptableColumnMenuItemName | AdaptableContextMenuItemName = AdaptableColumnMenuItemName | AdaptableContextMenuItemName> implements AdaptableMenuItem<MENU_TYPE_NAME> {
     constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, clickFunction: () => void, icon: AdaptableSystemIconName | AdaptableIcon, isVisible: boolean);
     name: MENU_TYPE_NAME;
@@ -21,6 +27,9 @@ export declare class MenuItemDoClickFunction<MENU_TYPE_NAME extends AdaptableCol
     isVisible: boolean;
     icon: AdaptableIcon;
 }
+/**
+ * A shipped menu item that opens a popup when it is clicked.
+ */
 export declare class MenuItemShowPopup<MENU_TYPE_NAME extends AdaptableColumnMenuItemName | AdaptableContextMenuItemName = AdaptableColumnMenuItemName | AdaptableContextMenuItemName> implements AdaptableMenuItem<MENU_TYPE_NAME> {
     constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, componentName: string, icon: AdaptableSystemIconName | AdaptableIcon, isVisible: boolean, popupParams?: ModuleParams);
     name: MENU_TYPE_NAME;

package/src/AdaptableState/Common/RowHighlightInfo.d.ts

@@ -1,6 +1,8 @@
 import { AdaptableStyle } from '../../../types';
 /**
- * Define how to highlight a Row
+ * A highlight on one row.
+ *
+ * `primaryKeyValue` is the row. `highlightStyle` is the colours and font. `timeout` is milliseconds; omit it and the highlight stays until it is cleared.
  */
 export interface RowHighlightInfo {
     /**
@@ -8,7 +10,7 @@ export interface RowHighlightInfo {
      */
     primaryKeyValue: any;
     /**
-     * Timeout after which Row should be unhighlighted
+     * Milliseconds before the highlight is removed. Omit it and the highlight stays until it is cleared.
      */
     timeout?: number;
     /**

package/src/AdaptableState/Common/RowScope.d.ts

@@ -1,5 +1,7 @@
 /**
- * Defines which types of Rows to exclude when rendering Format Columns, Action Columns and Badges
+ * Row kinds to skip.
+ *
+ * Each flag, when true, skips that kind. A flag left unset includes that kind. When the whole `RowScope` is omitted, the feature decides: a Format Column includes every kind.
  */
 export interface RowScope {
     /**

package/src/AdaptableState/Common/RowSummary.d.ts

@@ -3,22 +3,32 @@ import { SuspendableObject } from './SuspendableObject';
 export declare const ROW_SUMMARY_ROW_ID = "__ROW_SUMMARY_ROW_ID";
 export declare const WEIGHTED_AVERAGE_AGGREGATED_FUNCTION = "WEIGHTED_AVERAGE";
 export declare const summarySupportedExpressions: readonly ["MIN", "MAX", "SUM", "PRODUCT", "AVG", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "STD_DEVIATION", "WEIGHTED_AVERAGE"];
+/**
+ * Built-in summary names: `MIN`, `MAX`, `SUM`, `PRODUCT`, `AVG`, `COUNT`, `MEDIAN`, `MODE`, `DISTINCT`, `ONLY`, `STD_DEVIATION`, `WEIGHTED_AVERAGE`.
+ */
 export type SystemSummarySupportedExpression = (typeof summarySupportedExpressions)[number];
+/**
+ * Summary written into a row-summary cell. One of {@link SystemSummarySupportedExpression}.
+ *
+ * `WEIGHTED_AVERAGE` uses the weighted column from that column's layout aggregation when the aggregation is a weighted average.
+ */
 export type SummarySupportedExpression = TypeHint<string, SystemSummarySupportedExpression>;
 /**
- * Position of Row Summary - 'Top' or 'Bottom'
+ * Which edge a row summary is pinned to. `'Top'` or `'Bottom'`. When omitted, the summary is pinned to the bottom.
  */
 export type RowSummaryPosition = 'Top' | 'Bottom';
 /**
- * Defines a Row Summary used in a Layout
+ * A pinned row of column summaries in a table layout.
+ *
+ * `ColumnsMap` is required: each key is a column id and each value is a summary name such as `'SUM'` or `'AVG'`. `Position` is `'Top'` or `'Bottom'`; omit it to pin the row to the bottom. `IncludeOnlyFilteredRows` defaults to true, so the summary uses the rows that pass the current filter. Suspend with `IsSuspended`. Requires AG Grid `PinnedRowModule`.
  */
 export interface RowSummary extends SuspendableObject {
     /**
-     * Where Row Summary appears - 'Top' or 'Bottom'
+     * `'Top'` pins the summary above the rows. `'Bottom'` pins it below them. When omitted, the summary is pinned to the bottom.
      */
     Position?: RowSummaryPosition;
     /**
-     * Map of Columns with Summary Expressions
+     * Column id to summary name. Each value is a {@link SummarySupportedExpression}, for example `'SUM'` or `'AVG'`.
      */
     ColumnsMap: Record<string, SummarySupportedExpression>;
     /**

package/src/AdaptableState/Common/RowsHighlightInfo.d.ts

@@ -1,14 +1,16 @@
 import { AdaptableStyle } from '../../../types';
 /**
- * Defines how to highlight a set of Rows
+ * One highlight applied to several rows.
+ *
+ * `primaryKeyValues` are the rows. `highlightStyle` is the colours and font. `timeout` is milliseconds; omit it and the highlight stays until it is cleared.
  */
 export interface RowsHighlightInfo {
     /**
-     * Primary key valuse for the rows to be highlighted
+     * Primary key values of the rows to highlight.
      */
     primaryKeyValues: any[];
     /**
-     * Timeout after which the highlight is removed
+     * Milliseconds before the highlight is removed. Omit it and the highlight stays until it is cleared.
      */
     timeout?: number;
     /**

package/src/AdaptableState/Common/Schedule.d.ts

@@ -1,9 +1,11 @@
 /**
- * Defines when an action will run — either once or recurring
+ * When a scheduled alert or export runs.
+ *
+ * `IsOneOff: true` runs once at `RunAt` (an ISO date-time). `IsOneOff: false` repeats on `CronExpression`, a 5-field cron (minute, hour, day of month, month, day of week). Weekdays in that cron are 0–6 with Sunday as 0; `1-5` is Monday to Friday.
  */
 export interface Schedule {
     /**
-     * If true, the schedule runs once (using RunAt)
+     * `true` runs once, at `RunAt`. `false` repeats on `CronExpression`.
      */
     IsOneOff: boolean;
     /**
@@ -15,5 +17,11 @@ export interface Schedule {
      */
     CronExpression?: string;
 }
+/**
+ * Day names used when a cron expression is built from selected weekdays. Sunday is cron day 0.
+ */
 export type Weekdays = Weekday[];
+/**
+ * A weekday name. Sunday is cron day 0 and Saturday is cron day 6.
+ */
 export type Weekday = 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';

package/src/AdaptableState/Common/SpecialColumnSettings.d.ts

@@ -1,6 +1,8 @@
 import { AdaptableColumnDataType } from './AdaptableColumn';
 /**
- * Base Settings for both Calculated and FreeText Columns
+ * Column behaviour for a Calculated Column or a Free Text Column.
+ *
+ * `DataType` is required and is the type AdapTable uses for filters and expressions. `Filterable`, `Resizable`, `Groupable`, `Sortable`, `Pivotable` and `Aggregatable` each default to false. `SuppressMenu` and `SuppressMovable` default to false, so the header menu is shown and the column can be dragged.
  */
 export interface SpecialColumnSettings {
     /**

package/src/AdaptableState/Common/SystemStatusMessageInfo.d.ts

@@ -1,7 +1,9 @@
 import { AdaptableMessageType } from './AdaptableMessageType';
 import { Identifiable } from '../../types';
 /**
- * Wraps a System Status Message
+ * One message in the System Status panel.
+ *
+ * `statusMessage` is the text. `statusType` is `'Success'`, `'Info'`, `'Warning'` or `'Error'` and sets the colour. `statusFurtherInformation` is optional extra text. `timestamp` is when it was raised.
  */
 export interface SystemStatusMessageInfo extends Identifiable {
     /**
@@ -13,7 +15,7 @@ export interface SystemStatusMessageInfo extends Identifiable {
      */
     statusFurtherInformation?: string;
     /**
-     * Type of Message i.e. Succcess, Warning, Error, Info
+     * Message type: `Success`, `Info`, `Warning` or `Error`
      */
     statusType: AdaptableMessageType;
     /**

package/src/AdaptableState/Common/TransposeConfig.d.ts

@@ -20,7 +20,7 @@ export interface TransposeConfig {
      */
     columnsToTranspose?: string[] | ((context: AdaptableColumnsContext) => string[]);
     /**
-     * Rows to Transpose: All, Visible or via Expression
+     * Which rows are transposed. `'All'` (the default, also used when omitted) takes every row. `'VisibleOnly'` takes the rows currently visible. Any other string is a boolean AdapTableQL expression, and only matching rows are transposed.
      * @defaultValue All
      */
     rowsToTranspose?: TypeHint<string, 'VisibleOnly' | 'All'>;

package/src/AdaptableState/Common/Types.d.ts

@@ -29,7 +29,13 @@ export type AdaptableModuleButtons = AdaptableModuleButton[];
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
  */
 export type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'NamedQuery' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'Note' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
+/**
+ * Names of Adaptable State sections.
+ */
 export type AdaptableStateKeys = AdaptableStateKey[];
+/**
+ * One Adaptable State section name: a persisted section, or `'OpenFin'` or `'IPushPull'`.
+ */
 export type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFin' | 'IPushPull';
 /**
  * Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State
@@ -40,6 +46,9 @@ export declare const ALL_MODULES: AdaptableModule[];
  * Modules which can appear in the Settings Panel
  */
 export type AdaptableSettingsPanel = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'SmartEdit' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comment';
+/**
+ * A string (or other base type) that editors treat as one of `Literals`, while still accepting any value of the base type.
+ */
 export type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/AdaptableState/CustomSortState.d.ts

@@ -1,16 +1,20 @@
 import { BaseState } from './BaseState';
 import { SuspendableObject } from '../types';
 /**
- * Adaptable State Section for Custom Sort Module
+ * Custom Sort section of Adaptable State, including Initial State.
+ *
+ * Each entry replaces the normal sort of one column with the order in `SortedValues`. Values in that list sort in list order. Values absent from the list sort after them, using the normal comparison. A custom sort comparer registered for the column is used instead of `SortedValues`.
  */
 export interface CustomSortState extends BaseState {
     /**
-     * Collection of Custom Sort objects.
+     * Custom Sorts to apply. One column uses the first Custom Sort whose `ColumnId` matches.
      */
     CustomSorts?: CustomSort[];
 }
 /**
- * Custom Sort object used in Custom Sort function.
+ * A column sorted in a fixed order instead of the normal comparison.
+ *
+ * `ColumnId` is the column. `SortedValues` is the order: listed values come first, in that order, and any other value sorts after them. Date values are stored as ISO dates (`yyyy-MM-dd`). Suspend with `IsSuspended`.
  */
 export interface CustomSort extends SuspendableObject {
     /**
@@ -22,8 +26,7 @@ export interface CustomSort extends SuspendableObject {
      */
     ColumnId: string;
     /**
-     * Order of values by which Column will be sorted; Date values are persisted as ISO strings ('yyyy-MM-dd')
-     *
+     * Sort order. Listed values come first, in this order. Any other value sorts after them. Dates are stored as ISO strings (`yyyy-MM-dd`).
      */
     SortedValues?: (string | number)[];
 }

package/src/AdaptableState/DashboardState.d.ts

@@ -2,20 +2,22 @@ import { BaseState } from './BaseState';
 import { AdaptableDashboardToolbars, AdaptableModuleButtons } from './Common/Types';
 import { AdaptableObject } from './Common/AdaptableObject';
 /**
- * Adaptable State Section for the AdapTable Dashboard
+ * Dashboard section of Adaptable State, including Initial State.
+ *
+ * The Dashboard sits above the grid. `Tabs` are named groups of toolbars (the default is an empty list). `PinnedToolbars` sit above the grid and are not inside a tab. `ActiveTabIndex` is the zero-based index of the open tab. `IsCollapsed` leaves the header visible and hides the tab contents. `IsFloating` shows a draggable dashboard; `FloatingPosition` is its pixel position. `IsHidden` removes it until it is shown again from the Column Menu or Tool Panel.
  */
 export interface DashboardState extends BaseState {
     /**
-     * Named group of Toolbars
+     * Named groups of toolbars. Each tab has a `Name` and the `Toolbars` it shows.
      * @defaultValue Empty Array
      */
     Tabs?: DashboardTab[];
     /**
-     * Toolbars displayed above Grid (and not in Tab)
+     * Toolbars shown above the grid, outside any tab.
      */
     PinnedToolbars?: AdaptableDashboardToolbars | string[];
     /**
-     * Index of Active Tab (in Tabs collection)
+     * Zero-based index into `Tabs` of the tab that is open.
      */
     ActiveTabIndex?: number;
     /**
@@ -24,7 +26,7 @@ export interface DashboardState extends BaseState {
      */
     IsCollapsed?: boolean;
     /**
-     * Is Dashboard floating; if true, appears in draggable, minmised form (double-click to revert to default position)
+     * Is Dashboard floating; if true, it appears in a draggable form (double-click to revert to the default position)
      *  @defaultValue false
      */
     IsFloating?: boolean;
@@ -34,7 +36,7 @@ export interface DashboardState extends BaseState {
      */
     IsHidden?: boolean;
     /**
-     * Position of Dashboard when in Floating mode
+     * Pixel position of the Dashboard while `IsFloating` is true. `x` and `y` are offsets in pixels.
      */
     FloatingPosition?: AdaptableCoordinate;
     /**
@@ -53,7 +55,9 @@ export interface DashboardState extends BaseState {
     DashboardTitle?: string;
 }
 /**
- * Defines a named set of Toolbars in the AdapTable Dashboard
+ * One Dashboard tab.
+ *
+ * `Name` is the label in the header. `Toolbars` are the toolbars shown while this tab is the active one (`ActiveTabIndex`).
  */
 export interface DashboardTab extends AdaptableObject {
     /**
@@ -66,15 +70,15 @@ export interface DashboardTab extends AdaptableObject {
     Toolbars: AdaptableDashboardToolbars | string[];
 }
 /**
- * Used by AdapTable to remember position of Floating Dashboard
+ * Pixel position of the floating Dashboard.
  */
 export interface AdaptableCoordinate extends AdaptableObject {
     /**
-     * x axis number
+     * Horizontal offset, in pixels.
      */
     x: number;
     /**
-     * y axis number
+     * Vertical offset, in pixels.
      */
     y: number;
 }

package/src/AdaptableState/ExportState.d.ts

@@ -7,7 +7,9 @@ import { TypeHint } from './Common/Types';
 import { ExportDestinationType } from '../AdaptableOptions/ExportOptions';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Adaptable State Section for Export Module with Schedules
+ * Export section of Adaptable State, including Initial State.
+ *
+ * `Reports` are reports you define. AdapTable also provides the system reports `'All Data'`, `'Current Layout'` and `'Selected Data'`. `CurrentReport` and `CurrentFormat` are the report and format selected in the Export toolbar. `ReportSchedules` run a report on a `Schedule`.
  */
 export interface ExportState extends BaseState {
     /**
@@ -28,7 +30,9 @@ export interface ExportState extends BaseState {
     ReportSchedules?: ReportSchedule[];
 }
 /**
- * A Report which can export data from AdapTable
+ * A report you define.
+ *
+ * `ReportColumnScope` chooses the columns. Set `Scope` only when that is `'ScopeColumns'`. `ReportRowScope` chooses the rows. Set `Expression` only when that is `'ExpressionRows'`. The system reports are separate from this list.
  */
 export interface Report extends AdaptableObject {
     /**
@@ -144,11 +148,15 @@ export type SystemReportFormat =
  */
  | 'JSON';
 /**
- * Columns to be included in a Report
+ * Which columns a report exports.
+ *
+ * `'AllColumns'` exports every column. `'VisibleColumns'` exports the columns currently on screen. `'ScopeColumns'` exports the columns in `Scope`. `'SelectedColumns'` exports the selected columns and is not offered in the report wizard.
  */
 export type ReportColumnScope = 'AllColumns' | 'VisibleColumns' | 'ScopeColumns' | 'SelectedColumns';
 /**
- * AG Grid Row Data to be included in a Report
+ * Which rows a report exports.
+ *
+ * `'AllRows'` exports every row. `'VisibleRows'` exports the rows that are currently visible. `'ExpressionRows'` exports rows matching `Expression`. `'SelectedRows'` exports the selected rows and is not offered in the report wizard.
  */
 export type ReportRowScope = 'AllRows' | 'VisibleRows' | 'ExpressionRows' | 'SelectedRows';
 /**

package/src/AdaptableState/FlashingCellState.d.ts

@@ -3,11 +3,13 @@ import { AdaptableStyle } from './Common/AdaptableStyle';
 import { ColumnScope } from '../types';
 import { AdaptableObject, SuspendableObject } from '../../types';
 /**
- * Adaptable State Section for Flashing Cell module
+ * Flashing Cell section of Adaptable State, including Initial State.
+ *
+ * Each definition watches columns in `Scope` and flashes when `Rule` is true. `FlashTarget` is `'cell'` (the default), `'row'`, `'aggFuncCell'`, or a list of those. `UpChangeStyle`, `DownChangeStyle` and `NeutralChangeStyle` colour the flash. `FlashDuration` is milliseconds or `'always'` (the default is 500).
  */
 export interface FlashingCellState extends BaseState {
     /**
-     * Flashing Cell Definitions - will flash cells/rows when rule is met
+     * Flashing Cell definitions. Each one names a column scope, a boolean rule, and what flashes.
      */
     FlashingCellDefinitions?: FlashingCellDefinition[];
 }
@@ -22,7 +24,9 @@ export type FlashTargetTypes = 'row' | 'cell' | 'aggFuncCell';
  */
 export type FlashingCellType = 'Change' | 'Observable';
 /**
- * The Flashing Cell Definition
+ * Flashes a cell, a row, or an aggregated cell when a rule matches.
+ *
+ * `Scope` and `Rule` are required. `Type` is `'Change'` (this edit against the previous value) or `'Observable'` (change history such as `CHANGE_COUNT`). When `Type` is omitted it is treated as `'Change'`. Suspend with `IsSuspended`.
  */
 export interface FlashingCellDefinition extends AdaptableObject, SuspendableObject {
     /**
@@ -30,8 +34,7 @@ export interface FlashingCellDefinition extends AdaptableObject, SuspendableObje
      */
     Name: string;
     /**
-     * Rule flavour — Change (default) or Observable.
-     * Existing definitions without a Type are stamped `Change` on upgrade.
+     * `'Change'` compares this edit with the previous value. `'Observable'` evaluates the rule against change history. When omitted, the definition is treated as `'Change'`.
      */
     Type?: FlashingCellType;
     /**

package/src/AdaptableState/FormatColumnState.d.ts

@@ -5,16 +5,20 @@ import { ColumnScope } from './Common/ColumnScope';
 import { RowScope } from './Common/RowScope';
 import { SuspendableObject } from '../types';
 /**
- * Adaptable State Section for Format Column Module
+ * Format Column section of Adaptable State, including Initial State.
+ *
+ * Each entry styles cells, changes how a value is displayed, or both. `Scope` says where it applies. `Rule` limits it to matching rows; omit `Rule` to apply it on every row. `Style` sets colours and fonts. `DisplayFormat` changes the displayed value.
  */
 export interface FormatColumnState extends BaseState {
     /**
-     * Collection of Format Columns
+     * Format Columns to apply. Several can match the same cell. Their styles are combined, and the first definition in this list wins on a property both set. A Styled Column wins over a Format Column where both set the same property.
      */
     FormatColumns?: FormatColumn[];
 }
 /**
- * Object used in Format Column function
+ * Colours a cell, changes how its value is displayed, or both.
+ *
+ * `Scope` is required. `Style` and `DisplayFormat` can be set together. Omit `Rule` to apply the format on every row in scope. `Target` defaults to `'cell'` (`'columnHeader'` formats the header). Suspend with `IsSuspended`.
  */
 export interface FormatColumn extends SuspendableObject {
     /**
@@ -36,7 +40,7 @@ export interface FormatColumn extends SuspendableObject {
      */
     Rule?: string;
     /**
-     * AdapTable Style to apply
+     * Colours, font and CSS class applied to the cell or header. Can be set together with `DisplayFormat`.
      */
     Style?: AdaptableStyle;
     /**
@@ -47,28 +51,44 @@ export interface FormatColumn extends SuspendableObject {
      */
     DisplayFormat?: DisplayFormat;
     /**
-     * Which types of Rows to apply format (data, grouped, summary, total)
+     * Row kinds to skip. Each flag excludes that kind. When omitted, data, group, summary and total rows are all included.
      */
     RowScope?: RowScope;
     /**
-     * When to format Columns in Column Groups ('Expanded', 'Collapsed', 'Both')
+     * When a format applies to a column inside a column group.
      *
+     * Omit it to apply the format whether the parent group is expanded or collapsed. `'Expanded'` applies only while the parent group is expanded. `'Collapsed'` applies only while it is collapsed. `'Both'` applies in either state. A column that is the only leaf of a top-level group ignores an explicit scope.
      */
     ColumnGroupScope?: ColumnGroupScope;
 }
 /**
- * Specifies whether Column's cells or header is formatted
+ * Where a Format Column is drawn. `'cell'` formats the cells (the default). `'columnHeader'` formats the column header. Header formats are not applied to column group headers.
  */
 export type FormatColumnTarget = 'cell' | 'columnHeader';
 /**
- * Defines Column Group Scope
+ * Whether a Format Column applies while its parent column group is expanded, collapsed, or either.
  */
 export type ColumnGroupScope = 'Expanded' | 'Collapsed' | 'Both';
 /**
  * Config for api methods that get Format Columns
  */
 export interface FormatColumnConfig {
+    /**
+     * Include Format Columns that are suspended.
+     *
+     * When omitted or `false`, suspended definitions are left out.
+     */
     includeSuspended?: boolean;
+    /**
+     * Include Format Columns that are read-only.
+     *
+     * When omitted or `false`, read-only definitions are left out.
+     */
     includeReadOnly?: boolean;
+    /**
+     * Only Format Columns whose `Target` is this value (`cell` or `columnHeader`).
+     *
+     * When omitted, both targets are returned.
+     */
     target?: FormatColumnTarget;
 }

package/src/AdaptableState/FreeTextColumnState.d.ts

@@ -2,20 +2,24 @@ import { BaseState } from './BaseState';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 /**
- * Adaptable State Section for the Free Text Column Module
+ * Free Text Column section of Adaptable State, including Initial State.
+ *
+ * Each entry adds an editable column whose values are stored in Adaptable State, not in the grid data source. A cell shows the `FreeTextStoredValues` entry for its primary key. When that row has no stored value, it shows `DefaultValue`. Group rows are empty.
  */
 export interface FreeTextColumnState extends BaseState {
     /**
-     * Collection of Free Text Columns
+     * Free Text Columns to add. `ColumnId` is the id of the column AdapTable creates.
      */
     FreeTextColumns?: FreeTextColumn[];
 }
 /**
- * The FreeTextColumn object used in the Free Text Column function
+ * An editable column whose values live in Adaptable State.
+ *
+ * `ColumnId` is the id of the new column. `FreeTextColumnSettings.DataType` is required. `TextEditor` applies to string columns: `'Inline'` (the default) edits in the cell, `'Large'` opens AG Grid's large text editor.
  */
 export interface FreeTextColumn extends AdaptableObject {
     /**
-     * Id of Column
+     * Id of the column AdapTable creates. It is not the id of a column already in the data source.
      */
     ColumnId: string;
     /**
@@ -23,15 +27,15 @@ export interface FreeTextColumn extends AdaptableObject {
      */
     FriendlyName?: string;
     /**
-     * Initial value to use for each cell in the Column
+     * Value shown for a data row that has no `FreeTextStoredValues` entry for its primary key.
      */
     DefaultValue?: any;
     /**
-     * Collection of Stored Values to aplly in the Column
+     * Values stored for this column, keyed by the row primary key. A stored value is shown instead of `DefaultValue`.
      */
     FreeTextStoredValues?: FreeTextStoredValue[];
     /**
-     * Cell editor to use when editing a string Free Text Column
+     * Editor for a string Free Text Column. `'Inline'` edits in the cell. `'Large'` opens AG Grid's large text editor.
      * @defaultValue 'Inline'
      */
     TextEditor?: 'Inline' | 'Large';
@@ -41,7 +45,9 @@ export interface FreeTextColumn extends AdaptableObject {
     FreeTextColumnSettings: FreeTextColumnSettings;
 }
 /**
- * Defines a cell value stored in a Free Text Column
+ * One stored Free Text cell.
+ *
+ * `PrimaryKey` is the row. `FreeText` is the value shown for that row. A row with no entry shows `DefaultValue`.
  */
 export interface FreeTextStoredValue {
     /**