@adaptabletools/adaptable 24.0.0-canary.8 → 24.0.0

package/src/Api/ExportApi.d.ts

@@ -3,35 +3,42 @@ import { ExportState, Report, ReportFormatType, ReportNameType, ReportSchedule,
 import { CustomDestination, CustomExportParams, ExportConfig, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../AdaptableOptions/ExportOptions';
 import { AdaptableColumn } from '../types';
 /**
- * Provides run-time access to the Export Module and Report state
+ * Reports and scheduled exports: which report and format are selected, where a report can be sent, and running or scheduling an export.
  */
 export interface ExportApi {
     /**
-     * Retrieves Export section from Adaptable State
+     * The Export section of Adaptable State.
+     * @returns Reports, the selected report and format, and scheduled reports
      */
     getExportState(): ExportState;
     /**
-     * Retrieves available System Reports (configured in Export Options)
+     * System report names that Export Options allow.
+     * @returns `'All Data'`, `'Current Layout'` and `'Selected Data'`, limited to those enabled in Export Options
      */
     getAvailableSystemReports(): SystemReportName[];
     /**
-     * Retrieves available System Report Formats (configured in Export Options)
+     * System report formats that Export Options allow.
+     * @returns `'Excel'`, `'VisualExcel'`, `'CSV'` and `'JSON'`, limited to those enabled in Export Options
      */
     getAvailableSystemFormats(): SystemReportFormat[];
     /**
-     * Retrieves available System Export Destinations (configured in Export Options)
+     * System destinations that Export Options allow.
+     * @returns `'Download'` and `'Clipboard'`, limited to those enabled in Export Options
      */
     getAvailableSystemDestinations(): SystemExportDestination[];
     /**
-     * Retrieves available Custom Destinations (configured in Export Options)
+     * Custom destinations supplied in Export Options.
+     * @returns The custom destinations. Empty when none are configured
      */
     getAvailableCustomDestinations(): CustomDestination[];
     /**
-     * Retrieves name of currently selected Report
+     * Name of the report currently selected for export.
+     * @returns The report name, or `undefined` when no report is selected
      */
     getCurrentReportName(): ReportNameType | undefined;
     /**
-     * Retrieves name of currently selected Report
+     * Format currently selected for export.
+     * @returns `'Excel'`, `'VisualExcel'`, `'CSV'`, `'JSON'`, or a custom format name. `undefined` when no format is selected
      */
     getCurrentReportFormat(): ReportFormatType | undefined;
     /**
@@ -57,11 +64,13 @@ export interface ExportApi {
      */
     getAllReports(): Report[];
     /**
-     * Retrieves all Custom Reports that have been created by the User
+     * Reports created by the user. System reports are not included.
+     * @returns The custom reports
      */
     getCustomReports(): Report[];
     /**
-     * Retrieves all Report Formats that are available
+     * Every report format that can be selected, system and custom.
+     * @returns The format names
      */
     getAllFormats(): ReportFormatType[];
     /**
@@ -86,8 +95,8 @@ export interface ExportApi {
      */
     clearReport(): void;
     /**
-     * Selects the Report Format for Export
-     * @param format - format to select
+     * Selects the report format used by the next export.
+     * @param reportFormat Format to select, or `null` to clear the selection
      */
     selectFormat(reportFormat: ReportFormatType | null): void;
     /**
@@ -95,11 +104,13 @@ export interface ExportApi {
      */
     clearFormat(): void;
     /**
-     * If this AdapTable instance can to export to Excel; if false, the Export to Excel option will not be visible
+     * Whether this instance can export to Excel.
+     * @returns `false` when Excel export is turned off. The Excel destination is then hidden
      */
     canExportToExcel(): boolean;
     /**
-     * If this AdapTable instance can to export to CSV; if false, the Export to Csv option will not be visible
+     * Whether this instance can export to CSV.
+     * @returns `false` when CSV export is turned off. The CSV destination is then hidden
      */
     canExportToCsv(): boolean;
     /**
@@ -113,28 +124,33 @@ export interface ExportApi {
      */
     updateReport(report: Report): Report;
     /**
-     * Updates existing reports
-     * @param report reports to edit
-     * @returns reports
+     * Replaces the given custom reports in Export State.
+     * @param reports Reports to update, matched by `Uuid`
+     * @returns The updated reports
      */
     updateReports(reports: Report[]): Report[];
     /**
-     * If the given destination is a System one
-     * @param destination destination to check
+     * Whether the destination is one AdapTable provides (`Download` or `Clipboard`) rather than a custom destination.
+     * @param destinationName Destination to check
+     * @returns `true` for a system destination
      */
     isExportDestinationSystem(destinationName: ExportDestinationType): boolean;
     /**
      * Retrieves the Export Destinations that are supported for the given Report Format
-     * @param reportFormat - report format to check
+     * @param reportFormat Report format to check
+     * @returns Destinations that can receive this format
      */
     getSupportedExportDestinations(reportFormat: ReportFormatType): ExportDestinationType[];
     /**
-     * Form Data entered by the User in the UI for a Custom Destination
-     * @param destination Custom Destination for which to get Form Def
+     * The form a custom destination shows before export.
+     * @param destinationName Destination whose form to read
+     * @returns The form, or `undefined` when the destination has no form
      */
     getExportDestinationForm(destinationName: ExportDestinationType): AdaptableForm<ExportFormContext> | undefined;
     /**
-     * Returns whether the given column is exportable
+     * Whether a column is included in an export.
+     * @param adaptablColumn Column to check
+     * @returns `false` when the column is excluded from reports
      */
     isColumnExportable(adaptablColumn: AdaptableColumn): boolean;
     /**
@@ -152,45 +168,56 @@ export interface ExportApi {
      * @param config - optional configuration
      * @param config.exportParams - function to modify the default export parameters; it will be called with the default export parameters and should return the modified export parameters
      * @param config.showProgressIndicator - whether to show progress indicator
+     * @returns The exported rows in the requested format
      */
     getReportData(reportName: ReportNameType, format: ReportFormatType, config?: {
         exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
         showProgressIndicator?: boolean;
     }): Promise<ExportResultData>;
     /**
-     * All scheduled reports (custom reports and system reports)
+     * Every scheduled report, including suspended ones.
+     * @returns The schedules
      */
     getScheduledReports(): ReportSchedule[];
     /**
-     * All active scheduled reports (custom reports and system reports)
+     * Scheduled reports that are not suspended.
+     * @returns The active schedules
      */
     getActiveScheduledReports(): ReportSchedule[];
     /**
-     * Retrieves a scheduled report by its Uuid
+     * A scheduled report looked up by its id.
+     * @param reportScheduleId `Uuid` of the schedule
+     * @returns The schedule, or `undefined` when no schedule has that id
      */
     getScheduledReportById(reportScheduleId: ReportSchedule['Uuid']): ReportSchedule | undefined;
     /**
-     * Adds a scheduled report
+     * Adds a schedule that runs a report on a cron expression or at one time.
+     * @param reportSchedule Schedule to add
      */
     addScheduledReport(reportSchedule: ReportSchedule): void;
     /**
-     * Edits a scheduled report
+     * Replaces a scheduled report already in state.
+     * @param reportSchedule Schedule to save, matched by `Uuid`
      */
     editScheduledReport(reportSchedule: ReportSchedule): void;
     /**
-     * Deletes a scheduled report
+     * Removes a scheduled report.
+     * @param reportSchedule Schedule to delete
      */
     deleteScheduledReport(reportSchedule: ReportSchedule): void;
     /**
-     * Suspends a scheduled report
+     * Stops a schedule from running until it is unsuspended.
+     * @param reportSchedule Schedule to suspend
      */
     suspendScheduledReport(reportSchedule: ReportSchedule): void;
     /**
-     * Unsuspends a scheduled report
+     * Makes a suspended schedule run again.
+     * @param reportSchedule Schedule to activate
      */
     unSuspendScheduledReport(reportSchedule: ReportSchedule): void;
     /**
-     * Runs a scheduled export and records the job-run action
+     * Runs a scheduled export now and records that the job ran.
+     * @param reportSchedule Schedule to run
      */
     applyScheduledReport(reportSchedule: ReportSchedule): void;
     /**

package/src/Api/ExpressionApi.d.ts

@@ -14,11 +14,16 @@ export interface ExpressionApi {
      * @param expression query to Check
      * @param module module specific query
      * @param validationErrorMessage optional validation error message; if provided, the error will be logged
+     * @returns `true` when the given Expression is valid as a boolean predicate (Alert / Format Column / Grid Filter / etc.). Root `QUERY("x")` is accepted only when the named query's declared ReturnType is boolean (or absent)
      */
     isValidScalarExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     /**
      * Whether the given Expression is a valid value-producing scalar expression
      * (any return type — used by Calculated Column and non-boolean Named Queries).
+     * @param expression Expression to check
+     * @param module Module the expression belongs to
+     * @param validationErrorMessage When set, the validation error is logged with this message
+     * @returns `true` when the given Expression is a valid value-producing scalar expression (any return type — used by Calculated Column and non-boolean Named Queries)
      */
     isValidValueExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     /**
@@ -26,21 +31,27 @@ export interface ExpressionApi {
      * @param expression - AggregatedExpression to check
      * @param module - module specific query
      * @param validationErrorMessage - optional validation error message; if provided, the error will be logged
+     * @returns `true` when the given AggregatedExpression is valid
      */
     isValidAggregatedExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     /**
      * Returns all Columns referenced in an Expression
      * @param expression - expression to check
+     * @returns All Columns referenced in an Expression
      */
     getColumnsFromExpression(expression: string): string[];
     /**
-     * Returns whether a Column is Queryable
+     * Whether a column can be used in an AdapTableQL expression.
+     * @param abColumn Column to check
+     * @returns `true` when a column can be used in an AdapTableQL expression
      */
     isColumnQueryable(abColumn: AdaptableColumn): boolean;
     /**
      * AST for remote / SSRM evaluation. Emits a normalized contract-v2 tree
      * when `expressionOptions.supportedAstContractVersions` includes `2`;
      * otherwise the raw parse tree (v1).
+     * @param expression Expression to parse
+     * @returns AST for remote / SSRM evaluation. Emits a normalized contract-v2 tree when `expressionOptions.supportedAstContractVersions` includes `2`; otherwise the raw parse tree (v1)
      */
     getASTForExpression(expression: string): any;
     /**
@@ -49,11 +60,13 @@ export interface ExpressionApi {
      * `CHANGE_COUNT{[col], WITHIN(5m)}` are scalar. Empty or unparseable text yields `scalar`.
      * @param expression - the AdaptableQL Expression
      * @param module - module whose custom functions are taken into account (default `'Expression'`)
+     * @returns Infers the kind of an Expression from its text: `aggregated` when it contains an aggregation (e.g. `SUM{[col]}`), `scalar` otherwise — observable reads such as `CHANGE_COUNT{[col], WITHIN(5m)}` are scalar. Empty or unparseable text yields `scalar`
      */
     getExpressionKind(expression: string, module?: AdaptableModule): ExpressionKind;
     /**
      * Returns the Expression with Column Headers in place of Column IDs
      * @param expression - the Expression string
+     * @returns The Expression with Column Headers in place of Column IDs
      */
     getExpressionWithColumnFriendlyNames(expression: string | undefined | null): string | undefined;
     /**
@@ -67,6 +80,7 @@ export interface ExpressionApi {
      * Direct API evaluation ignores `expressionOptions.evaluateAdaptableQLExternally`
      * (that option only skips evaluation inside AdapTable features).
      * @param request Expression + exactly one row target (`rowNode` / `primaryKeyValue` / `data`)
+     * @returns Evaluates a Standard Expression against a row. Requires a row target (`rowNode`, `primaryKeyValue`, or `data`) on the request. Never throws — returns a result envelope with `success` / `errorMessage`. The Expression decides the return value: a condition such as `[price] > 100` yields `true` / `false`; `[price] * 1.19` yields a number. Direct API evaluation ignores `expressionOptions.evaluateAdaptableQLExternally` (that option only skips evaluation inside AdapTable features)
      */
     evaluateStandardExpression(request: EvaluateStandardExpressionRequest): ExpressionEvaluationResult<unknown>;
     /**
@@ -85,6 +99,7 @@ export interface ExpressionApi {
      * Under the server-side row model only currently loaded rows are aggregated;
      * inspect `rowCount` to detect partial data.
      * @param request Expression + optional module / dataSet / rowScope / rowFilter
+     * @returns Evaluates an Aggregation Expression (e.g. `SUM{[price]}`, `MAX{[price], GROUP_BY([make])}`, `RANK{OVER([price])}`, `SUM{[price]} > 1000`) and returns a materialized snapshot: the global value, per-group values (for `GROUP_BY`) and a per-row projection (`getValueForRow`). When the Expression is a condition, `matches` is whether at least one aggregation group satisfies it. Default target is all loaded grid rows. Pass `dataSet` to aggregate a caller-supplied array, or `rowScope` / `rowFilter` to narrow the grid set. The snapshot does not update on data changes — re-evaluate when needed. Under the server-side row model only currently loaded rows are aggregated; inspect `rowCount` to detect partial data
      */
     evaluateAggregatedExpression(request: EvaluateAggregatedExpressionRequest): ExpressionEvaluationResult<AggregatedExpressionEvaluationValue>;
     /**
@@ -93,6 +108,7 @@ export interface ExpressionApi {
      * per-row evaluation error fails the whole call. Matching `IRowNode`s are
      * returned in source order.
      * @param request Expression + optional rowScope / rowFilter / cellValueOverride / module
+     * @returns The grid rows matching a boolean Expression, scoped by `rowScope` and optionally pre-narrowed by `rowFilter`. Validation runs once; a per-row evaluation error fails the whole call. Matching `IRowNode`s are returned in source order
      */
     filterRowNodes(request: FilterRowNodesRequest): ExpressionEvaluationResult<IRowNode[]>;
     /**
@@ -100,6 +116,7 @@ export interface ExpressionApi {
      * order and with the same object references. Validation runs once; a
      * per-row evaluation error fails the whole call.
      * @param request Expression + the array to filter
+     * @returns The subset of `dataSet` matching a boolean Expression, in original order and with the same object references. Validation runs once; a per-row evaluation error fails the whole call
      */
     filterDataSet(request: FilterDataSetRequest): ExpressionEvaluationResult<Record<string, unknown>[]>;
     /**
@@ -116,6 +133,9 @@ export interface ExpressionApi {
      * `expressionKind` is the stored module kind. Required for dual-name
      * paren calls (`SUM([x])` scalar vs aggregation). Omit only when the
      * leftover is shape-proven (`GROUP_BY` / `CUMUL` / `TIMEFRAME` / …).
+     * @param expression Expression written in the older syntax
+     * @param options `expressionKind` is the stored module kind. Required for calls such as `SUM([x])` that can be either a scalar or an aggregation
+     * @returns Convert a leftover (pre-v24) AdaptableQL string to the v24 greenfield syntax. Unparseable input is returned unchanged with `error` set. v24 introduced brace aggregations (`SUM{[price]}`), named operands (`CUMULATIVE([d])`, `WITHIN(5m)`), and dropped wrappers such as `CUMUL(...)` and `TIMEFRAME(...)`. Persisted state is rewritten on load by VersionUpgrade24 when `autoMigrateState` is on. Use this for a single programmatic / external-config string that has not gone through that upgrade. The runtime does not accept leftover spellings. `expressionKind` is the stored module kind. Required for dual-name paren calls (`SUM([x])` scalar vs aggregation). Omit only when the leftover is shape-proven (`GROUP_BY` / `CUMUL` / `TIMEFRAME` / …)
      */
     migratePreV24Expression(expression: string, options?: {
         expressionKind?: 'boolean' | 'scalar' | 'aggregatedScalar' | 'aggregatedBoolean';
@@ -126,12 +146,15 @@ export interface ExpressionApi {
     };
     /**
      * Whether Expressions are evaluated using Case Sensitivity
+     * @returns `true` when Expressions are evaluated using Case Sensitivity
      */
     useCaseSensitivity(): boolean;
     /**
      * Whether date comparisons use the full timestamp (exact instant) rather than
      * the calendar day for the given column — governs the `IN` operator on date
      * columns and the date Column Filter's distinct-value tree granularity.
+     * @param column Column id or column to check
+     * @returns `true` when date comparisons use the full timestamp (exact instant) rather than the calendar day for the given column — governs the `IN` operator on date columns and the date Column Filter's distinct-value tree granularity
      */
     shouldEvaluateDatesUsingTime(column: string | AdaptableColumn): boolean;
 }

package/src/Api/Fdc3Api.d.ts

@@ -1,28 +1,32 @@
 import { IRowNode } from 'ag-grid-enterprise';
 import { AppIdentifier, Channel, Context, ContextType, DesktopAgent, Intent, IntentResolution } from '@finos/fdc3';
 /**
- * Provides run-time access to AdapTable's FDC3 functionality
+ * FDC3 intents and context raised from a grid row, and checks for standard FDC3 types.
  */
 export interface Fdc3Api {
     /**
      * Returns the FDC3 Desktop Agent
+     * @returns The FDC3 Desktop Agent
      */
     getDesktopAgent(): DesktopAgent;
     /**
      * Returns the human-friendly label for the given Context Type
      * @param contextType - The FDC3 Context Type
+     * @returns The human-friendly label for the given Context Type
      */
     getContextLabel(contextType: ContextType): string;
     /**
      * Builds FDC3 Context Data based on the given Context Type and Row Node
      * @param contextType - The FDC3 Context Type
      * @param rowNode - The Row Node
+     * @returns Builds FDC3 Context Data based on the given Context Type and Row Node
      */
     buildContextDataFromRow(contextType: ContextType, rowNode: IRowNode): Context;
     /**
      * Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value
      * @param contextType - The FDC3 Context Type
      * @param primaryKeyValue - The Primary Key Value
+     * @returns Builds FDC3 Context Data based on the given Context Type and the Row Node with the given Primary Key Value
      */
     buildContextDataForPrimaryKey(contextType: ContextType, primaryKeyValue: string | number): Context | undefined;
     /**
@@ -31,6 +35,7 @@ export interface Fdc3Api {
      * @param intent - The FDC3 Intent
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
+     * @returns Raises an Intent with the given Context from the given Row Node
      */
     raiseIntentFromRow(rowNode: IRowNode, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     /**
@@ -39,6 +44,7 @@ export interface Fdc3Api {
      * @param intent - The FDC3 Intent
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
+     * @returns Raises an Intent with the given Context from the given Row Node with the given Primary Key Value
      */
     raiseIntentFromPrimaryKey(primaryKeyValue: string | number, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
     /**
@@ -46,6 +52,7 @@ export interface Fdc3Api {
      * @param rowNode - The Row Node
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
+     * @returns The intent resolution from the app that handled it
      */
     raiseIntentForContextFromRow(rowNode: IRowNode, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     /**
@@ -53,6 +60,7 @@ export interface Fdc3Api {
      * @param primaryKeyValue - The Primary Key Value
      * @param contextType - The FDC3 Context Type
      * @param appIdentifier - The App Identifier
+     * @returns The intent resolution, or `undefined` when the row cannot be found
      */
     raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
     /**
@@ -67,14 +75,19 @@ export interface Fdc3Api {
      * @param primaryKeyValue - The Primary Key Value
      * @param contextType - The FDC3 Context Type
      * @param channel - (optional) Channel to broadcast to; if not provided, the Context will be broadcast to whatever User Channel the app is joined to
+     * @returns Broadcasts the given Context from the given Row Node with the given Primary Key Value
      */
     broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, channel?: Channel): Promise<void> | undefined;
     /**
-     * Checks if the given Context Type is a FDC3 standard Context Type
+     * Whether this context type is one of the FDC3 standard types.
+     * @param contextType Context type to check, for example `fdc3.instrument`
+     * @returns `true` when this context type is one of the FDC3 standard types
      */
     isStandardContextType(contextType: string): boolean;
     /**
-     * Checks if the given Intent is a FDC3 standard Intent Type
+     * Whether this intent is one of the FDC3 standard intents.
+     * @param intentType Intent to check, for example `ViewChart`
+     * @returns `true` when this intent is one of the FDC3 standard intents
      */
     isStandardIntentType(intentType: string): boolean;
 }

package/src/Api/FlashingCellApi.d.ts

@@ -2,7 +2,7 @@ import { AdaptableFlashingCell } from '../AdaptableState/Common/AdaptableFlashin
 import { FlashingCellDefinition, FlashingCellState } from '../AdaptableState/FlashingCellState';
 import { AdaptableObjectLookupCriteria } from '../AdaptableState/Common/AdaptableObject';
 /**
- * Provides run-time access to Flashing Cell functionality and associated State
+ * Flashing Cell definitions, and flashing a cell when its value changes.
  */
 export interface FlashingCellApi {
     /**
@@ -12,6 +12,7 @@ export interface FlashingCellApi {
     getFlashingCellState(): FlashingCellState;
     /**
      * Retrieves all Flashing Cell Definitions in Flashing Cell State
+     * @returns All Flashing Cell Definitions in Flashing Cell State
      */
     getFlashingCellDefinitions(): FlashingCellDefinition[];
     /**
@@ -39,6 +40,7 @@ export interface FlashingCellApi {
     /**
      * Returns `FlashTarget` of the given Flashing Cell Definition
      * @param flashingCellDefinition Flashing Cell Definition to check
+     * @returns `FlashTarget` of the given Flashing Cell Definition
      */
     getFlashingCellFlashTarget(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition['FlashTarget'];
     /**
@@ -61,6 +63,7 @@ export interface FlashingCellApi {
     /**
      * Adds a Flashing Cell Definition to State
      * @param flashingCellDefinition Flashing Cell Definition to Add
+     * @returns The Flashing Cell Definition that was added
      */
     addFlashingCellDefinition(flashingCellDefinition: FlashingCellDefinition): FlashingCellDefinition;
     /**
@@ -105,11 +108,13 @@ export interface FlashingCellApi {
     clearAllFlashingCells(): void;
     /**
      * Is there any cells/rows currently being flashed
+     * @returns `true` when there any cells/rows currently being flashed
      */
     isAnyFlashingCellActive(): boolean;
     /**
      * Find all Flashing Cell Definitions which match the given criteria
      * @param flashingCellLookupCriteria lookup criteria
+     * @returns The Flashing Cell Definitions that match
      */
     findFlashingCellDefinitions(flashingCellLookupCriteria: AdaptableObjectLookupCriteria): FlashingCellDefinition[];
 }

package/src/Api/FormatColumnApi.d.ts

@@ -1,11 +1,12 @@
 import { FormatColumn, FormatColumnState } from '../AdaptableState/FormatColumnState';
 import { AdaptableColumn, AdaptableFormat, AdaptableObjectLookupCriteria, FormatColumnConfig } from '../types';
 /**
- * Provides run-time access to the Format Column Module and associated state
+ * Format Columns: the display format and style applied to a column, including which formats are active.
  */
 export interface FormatColumnApi {
     /**
      * Retrieves Format Column section from Adaptable State
+     * @returns Format Column section from Adaptable State
      */
     getFormatColumnState(): FormatColumnState;
     /**
@@ -33,6 +34,8 @@ export interface FormatColumnApi {
     /**
      * Retrieves the first Format Column's Adaptable Format for a given Column
      * @param column Column to check
+     * @param config Which formats to consider. Suspended and read-only formats are excluded unless this says to include them
+     * @returns The first Format Column's Adaptable Format for a given Column
      */
     getDisplayFormatForColumn(column: AdaptableColumn, config?: FormatColumnConfig): AdaptableFormat | undefined;
     /**
@@ -48,7 +51,7 @@ export interface FormatColumnApi {
     addFormatColumn(formatColumn: FormatColumn): FormatColumn;
     /**
     * Adds Format Columns to Format Column State
-    * @param formatColumn Format Columns to Add
+    * @param formatColumns Format Columns to add
     * @returns format columns
     */
     addFormatColumns(formatColumns: FormatColumn[]): FormatColumn[];
@@ -74,9 +77,9 @@ export interface FormatColumnApi {
      */
     suspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
     /**
-     * Suspends an Format column
-     * @param formatColumn The Format Column to suspend
-     * @returns format column
+     * Activates a suspended Format Column.
+     * @param formatColumn The Format Column to activate
+     * @returns The Format Column after it is activated
      */
     unSuspendFormatColumn(formatColumn: FormatColumn): FormatColumn;
     /**
@@ -94,33 +97,37 @@ export interface FormatColumnApi {
     /**
      * Gets all FormatColumns which are defined for the given column
      * @param column The Column for which to retrieve the Format Column
+     * @param config Which formats to include. Suspended and read-only formats are excluded unless this says to include them
      * @returns format column
      */
     getFormatColumnsForColumn(column: AdaptableColumn, config?: FormatColumnConfig): FormatColumn[];
     /**
      * Gets all FormatColumns which are defined for the column with the given columnId
      * @param columnId ColumnId for which to retrieve the Format Column
+     * @param config Which formats to include. Suspended and read-only formats are excluded unless this says to include them
      * @returns format column
      */
     getFormatColumnsForColumnId(columnId: string, config?: FormatColumnConfig): FormatColumn[];
     /**
      * Checks if a Format Column contains a Custom Display Formatter
      * @param formatColumn Format Column
+     * @returns `true` when a Format Column contains a Custom Display Formatter
      */
     hasCustomDisplayFormatter(formatColumn: FormatColumn): boolean;
     /**
-     * Increment the precedence of the given FormatColumn
-     * @param formatColumn
+     * Moves a Format Column up so it is applied before the formats below it.
+     * @param formatColumn Format Column to move up
      */
     incrementFormatColumnPrecedence(formatColumn: FormatColumn): void;
     /**
-     * Decrement the precedence of the given FormatColumn
-     * @param formatColumn
+     * Moves a Format Column down so the formats above it are applied first.
+     * @param formatColumn Format Column to move down
      */
     decrementFormatColumnPrecedence(formatColumn: FormatColumn): void;
     /**
-     * Find all Flashing Cell Definitions which match the given criteria
-     * @param flashingCellLookupCriteria lookup criteria
+     * Format Columns that match the given criteria.
+     * @param formatColumnLookupCriteria Name, id, tag or other lookup values
+     * @returns Format Columns that match the given criteria
      */
     findFormatColumns(formatColumnLookupCriteria: AdaptableObjectLookupCriteria): FormatColumn[];
 }

package/src/Api/FreeTextColumnApi.d.ts

@@ -1,11 +1,12 @@
 import { FreeTextColumn, FreeTextColumnState, FreeTextStoredValue } from '../AdaptableState/FreeTextColumnState';
 import { IRowNode } from 'ag-grid-enterprise';
 /**
- * Provides run-time access to FreeTextColumn Module and associated state
+ * Free Text Columns. Values typed into these columns are stored in AdapTable State.
  */
 export interface FreeTextColumnApi {
     /**
      * Retrieves FreeTextColumn section of Adaptable State
+     * @returns FreeTextColumn section of Adaptable State
      */
     getFreeTextColumnState(): FreeTextColumnState;
     /**
@@ -33,7 +34,7 @@ export interface FreeTextColumnApi {
     addFreeTextColumn(freeTextColumn: FreeTextColumn): FreeTextColumn;
     /**
      * Edits existing FreeTextColumn in Adaptable State
-     * @param freeTextColum to edit (ColumnId is mandatory)
+     * @param freeTextColumn Free Text Column to save. `ColumnId` is required
      * @returns free text column
      */
     editFreeTextColumn(freeTextColumn: FreeTextColumn): FreeTextColumn;
@@ -60,6 +61,7 @@ export interface FreeTextColumnApi {
      * Retrieves a Free Text Column value for a given row node
      * @param freeTextColumn column to lookup
      * @param rowNode row to lookup
+     * @returns A Free Text Column value for a given row node
      */
     getFreeTextColumnValueForRowNode(freeTextColumn: FreeTextColumn, rowNode: IRowNode): any;
     /**