@adaptabletools/adaptable 24.0.0-canary.8 → 24.0.0

package/src/Api/ColumnApi.d.ts

@@ -4,104 +4,128 @@ import { ColDef, ColGroupDef, Column } from 'ag-grid-enterprise';
 import type { AvailableCellDataTypeInfo } from '../agGrid/AgGridCellDataTypeHelper';
 export type { AvailableCellDataTypeInfo } from '../agGrid/AgGridCellDataTypeHelper';
 /**
- * Provides run-time access to AdapTable Column related features
+ * Columns in the grid: lookup by id or friendly name, data type, visibility and which columns can be sorted, filtered, grouped or exported.
  */
 export interface ColumnApi {
     /**
      * Returns all Columns available (including hidden, special)
+     * @returns All Columns available (including hidden, special)
      */
     getColumns(): AdaptableColumn[];
     /**
      * Returns all Columns that can be displayed in UI (excludes always hidden cols)
+     * @returns All Columns that can be displayed in UI (excludes always hidden cols)
      */
     getUIAvailableColumns(): AdaptableColumn[];
     /**
      * Returns all UI available columns excluding Action, FreeText and Calculated Columns
+     * @returns All UI available columns excluding Action, FreeText and Calculated Columns
      */
     getNonSpecialColumns(): AdaptableColumn[];
     /**
      * Returns any Action, FreeText and Calculated Columns
+     * @returns Any Action, FreeText and Calculated Columns
      */
     getSpecialColumns(): AdaptableColumn[];
     /**
      * Returns all visible Columns
+     * @returns All visible Columns
      */
     getVisibleColumns(): AdaptableColumn[];
     /**
      * Returns all numeric Columns
+     * @returns All numeric Columns
      */
     getNumericColumns(): AdaptableColumn[];
     /**
      * Returns all Date Columns
+     * @returns All Date Columns
      */
     getDateColumns(): AdaptableColumn[];
     /**
      * Returns all Text Columns
+     * @returns All Text Columns
      */
     getTextColumns(): AdaptableColumn[];
     /**
      * Returns all string array Columns
+     * @returns All string array Columns
      */
     getTextArrayColumns(): AdaptableColumn[];
     /**
      * Returns all boolean Columns
+     * @returns All boolean Columns
      */
     getBooleanColumns(): AdaptableColumn[];
     /**
      * Returns all array columns (number, tuple-number, object-number & text)
+     * @returns All array columns (number, tuple-number, object-number & text)
      */
     getArrayColumns(): AdaptableColumn[];
     /**
      * Returns all numeric array columns (number, tuple-number, object-number)
+     * @returns All numeric array columns (number, tuple-number, object-number)
      */
     getNumericArrayColumns(): AdaptableColumn[];
     /**
      * Returns all number-array columns
+     * @returns All number-array columns
      */
     getNumberArrayColumns(): AdaptableColumn[];
     /**
      * Returns all tuple-number-array columns e.g. [[1,2],[3,4]]
+     * @returns All tuple-number-array columns e.g. [[1,2],[3,4]]
      */
     getTupleNumberArrayColumns(): AdaptableColumn[];
     /**
      * Returns all object-number-array columns e.g. [{x:1,y:2},{x:3,y:4}]
+     * @returns All object-number-array columns e.g. [{x:1,y:2},{x:3,y:4}]
      */
     getObjectNumberArrayColumns(): AdaptableColumn[];
     /**
      * Returns all Sortable Columns
+     * @returns All Sortable Columns
      */
     getSortableColumns(): AdaptableColumn[];
     /**
-     * Returns all Sortable Columns
+     * Returns all Filterable Columns
+     * @returns All Filterable Columns
      */
     getFilterableColumns(): AdaptableColumn[];
     /**
      * Returns all Groupable Columns
+     * @returns All Groupable Columns
      */
     getGroupableColumns(): AdaptableColumn[];
     /**
      * Returns all Pivotable Columns
+     * @returns All Pivotable Columns
      */
     getPivotableColumns(): AdaptableColumn[];
     /**
      * Returns all Aggregatable Columns
+     * @returns All Aggregatable Columns
      */
     getAggregatableColumns(): AdaptableColumn[];
     /**
      * Returns all Queryable Columns
+     * @returns All Queryable Columns
      */
     getQueryableColumns(): AdaptableColumn[];
     /**
      * Returns Columns that are always hidden in UI (but available for Expressions)
+     * @returns Columns that are always hidden in UI (but available for Expressions)
      */
     getUIHiddenColumns(): AdaptableColumn[];
     /**
      * Returns all Exportable Columns
+     * @returns All Exportable Columns
      */
     getExportableColumns(): AdaptableColumn[];
     /**
      * Returns all Columns that have given DataType
      * @param dataType the DataType of the Columns to retrieve
+     * @returns All Columns that have given DataType
      */
     getColumnsWithDataType(dataType: AdaptableColumnDataType): AdaptableColumn[];
     /**
@@ -155,92 +179,110 @@ export interface ColumnApi {
     /**
      * Checks if Column with given ColumnId is a Selection (Checkbox) Column automatically generated by AG Grid
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a Selection (Checkbox) Column automatically generated by AG Grid
      */
     isSelectionColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a row-group Column automatically generated by AG Grid
      */
     isAutoRowGroupColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'single'
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'single'
      */
     isAutoRowGroupColumnForSingle(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'multi'
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a row-group Column automatically generated by AG Grid, for row-grouping with group display type = 'multi'
      */
     isAutoRowGroupColumnForMulti(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a pivot Column automatically generated by AG Grid
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a pivot Column automatically generated by AG Grid
      */
     isPivotResultColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a pivot aggregation column in a pivot layout with no pivot columns.
      * When PivotColumns is empty, aggregation columns keep their original IDs instead of getting a 'pivot_' prefix.
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a pivot aggregation column in a pivot layout with no pivot columns. When PivotColumns is empty, aggregation columns keep their original IDs instead of getting a 'pivot_' prefix
      */
     isPivotAggColumnWithNoPivotColumns(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a Special (i.e. calculated, freetext or action) Column
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a Special (i.e. calculated, freetext or action) Column
      */
     isSpecialColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a Calculated Column
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a Calculated Column
      */
     isCalculatedColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a Free Text Column
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is a Free Text Column
      */
     isFreeTextColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is an Action Column
      * @param columnId ColumnId to check
+     * @returns `true` when Column with given ColumnId is an Action Column
      */
     isActionColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a FDC3 Column
-     * @param columnId
+     * @param columnId Column to check
+     * @returns `true` when Column with given ColumnId is a FDC3 Column
      */
     isFdc3Column(columnId: string): boolean;
     /**
      * Checks if the Column with the given `columnId` has DataType Number
      * @param columnId Column ID
+     * @returns `true` when the Column with the given `columnId` has DataType Number
      */
     hasNumberDataType(columnId: string): boolean;
     /**
      * Checks if the Column with the given `columnId` has DataType Boolean
      * @param columnId Column ID
+     * @returns `true` when the Column with the given `columnId` has DataType Boolean
      */
     hasBooleanDataType(columnId: string): boolean;
     /**
      * Checks if the Column with the given `columnId` has DataType Date
      * @param columnId Column ID
+     * @returns `true` when the Column with the given `columnId` has DataType Date
      */
     hasDateDataType(columnId: string): boolean;
     /**
      * Checks if the Column with the given `columnId` has an Numeric Array-like DataType (`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`)
      * @param columnId Column ID
+     * @returns `true` when the Column with the given `columnId` has an Numeric Array-like DataType (`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`)
      */
     hasNumericArrayDataType(columnId: string): boolean;
     /**
      * Checks if the Column with the given `columnId` has any Array-like DataType (`TextArray`,`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`)
      * @param columnId Column ID
+     * @returns `true` when the Column with the given `columnId` has any Array-like DataType (`TextArray`,`NumberArray`,`TupleNumberArray` or `ObjectNumberArray`)
      */
     hasArrayDataType(columnId: string): boolean;
     /**
      * Checks if the Column with the given `columnId` has a Text Array-like DataType (`TextArray`)
      * @param columnId Column ID
+     * @returns `true` when the Column with the given `columnId` has a Text Array-like DataType (`TextArray`)
      */
     hasTextArrayDataType(columnId: string): boolean;
     /**
      * Returns Data Type for the Column with given ColumnId
      * @param columnId Column to check
+     * @returns Data Type for the Column with given ColumnId. `undefined` when there is no match
      */
     getColumnDataTypeForColumnId(columnId: string): AdaptableColumnDataType | undefined;
     /**
@@ -248,72 +290,88 @@ export interface ColumnApi {
      * `dataTypeDefinitions`), for optional special-column Cell Data Type settings.
      * Empty when the app has not registered custom types. Does not include
      * AdapTable baselines (number / text / date / boolean / numberArray).
+     * @returns Application-registered AG Grid cell data types (from the app's `dataTypeDefinitions`), for optional special-column Cell Data Type settings. Empty when the app has not registered custom types. Does not include AdapTable baselines (number / text / date / boolean / numberArray)
      */
     getAvailableCellDataTypes(): AvailableCellDataTypeInfo[];
     /**
      * Resolves the AdapTable `DataType` for an AG Grid `cellDataType` key
      * (custom types map via `baseDataType` / `extendsDataType`).
+     * @param cellDataType AG Grid `cellDataType` key
+     * @returns The AdapTable data type for that key. `undefined` when the key is not registered
      */
     getAdaptableDataTypeForCellDataType(cellDataType: string): AdaptableColumnDataType | undefined;
     /**
      * Retrieves Friendly Name of Column with given ColumnId
      * @param columnId ColumnId to lookup
+     * @param layout Layout used when naming an auto row-group column. Defaults to the current Layout
+     * @returns Friendly Name of Column with given ColumnId
      */
     getFriendlyNameForColumnId(columnId: string, layout?: Layout): string;
     /**
      * Checks if Column has already been created
      * @param columnId ColumnId to check
+     * @returns `true` when Column has already been created
      */
     doesColumnExist(columnId: string): boolean;
     /**
      * Retrieves Friendly Names for given ColumnIds
      * @param columnIds ColumnIds to lookup
+     * @returns Friendly Names for given ColumnIds
      */
     getFriendlyNamesForColumnIds(columnIds: string[]): string[];
     /**
      * Retrieves AdapTable Column with given Friendly name
      * @param columnName Friendly Name to lookup
      * @param logWarning Whether to log warning if Column missing
+     * @returns AdapTable Column with given Friendly name
      */
     getColumnWithFriendlyName(columnName: string, logWarning?: boolean): AdaptableColumn;
     /**
      * Retrieves Adaptable Columns with given Friendly names
      * @param friendlyNames Friendly Names to lookup
+     * @returns Adaptable Columns with given Friendly names
      */
     getColumnsWithFriendlyNames(friendlyNames: string[]): AdaptableColumn[];
     /**
      * Retrieves ColumnId for Column with given Friendly Name
      * @param friendlyName Friendly Name to Lookup
+     * @returns ColumnId for Column with given Friendly Name
      */
     getColumnIdForFriendlyName(friendlyName: string): string;
     /**
      * Retrieves ColumnIds for Columns with given Friendly Names
-     * @param friendlyName Friendly Names to Lookup
+     * @param friendlyNames Friendly names to look up
+     * @returns ColumnIds for Columns with given Friendly Names
      */
     getColumnIdsForFriendlyNames(friendlyNames: string[]): string[];
     /**
      * Retrieves Adaptable Columns with given ColumnIds
      * @param columnIds Column Ids to lookup
+     * @returns Adaptable Columns with given ColumnIds
      */
     getColumnsWithColumnIds(columnIds: string[]): AdaptableColumn[];
     /**
      * Retrieves AdapTable Column with given ColumnId
      * @param columnId ColumnId to lookup
      * @param logWarning Whether to log warning if Column missing
+     * @returns AdapTable Column with given ColumnId. `undefined` when there is no match
      */
     getColumnWithColumnId(columnId: string, logWarning?: boolean): AdaptableColumn | undefined;
     /**
      * Returns true if the given Column exists in the Grid
      * @param columnId Column to check
+     * @returns `true` when the given Column exists in the Grid
      */
     isColumnInGrid(columnId: string): boolean;
     /**
      * Retrieves current Primary Key Column in AdapTable. It may be undefined if the primary key is auto-generated, or it is NOT mapped to a column.
+     * @returns Current Primary Key Column in AdapTable. It may be undefined if the primary key is auto-generated, or it is NOT mapped to a column
      */
     getPrimaryKeyColumn(): AdaptableColumn | undefined;
     /**
      * Returns the default Aggregation Function for a Column
      * @param columnId Column to Check
+     * @returns The default Aggregation Function for a Column
      */
     getDefaultAggFunc(columnId: string): string;
     /**
@@ -323,15 +381,18 @@ export interface ColumnApi {
     openColumnInfoSettingsPanel(columnId?: string): void;
     /**
      * Returns available columns types defined under columnOptions.columnTypes
+     * @returns Available columns types defined under columnOptions.columnTypes
      */
     getColumnTypes(): string[];
     /**
      * Returns all columns of a given columnType
      * @param columnType the columnType to filter by
+     * @returns All columns of a given columnType
      */
     getColumnsByColumnType(columnType: string): AdaptableColumn[];
     /**
      * Returns all columns currently Row Grouped
+     * @returns All columns currently Row Grouped
      */
     getRowGroupedColumns(): AdaptableColumn[];
     /**
@@ -343,6 +404,7 @@ export interface ColumnApi {
     /**
      * Returns AG Grid ColDef for a given ColumnId
      * @param columnId Column to use
+     * @returns AG Grid ColDef for a given ColumnId
      */
     getAGGridColDefForColumnId(columnId: string): ColDef | ColGroupDef;
     /**
@@ -350,27 +412,32 @@ export interface ColumnApi {
      *
      * The ColDef is matched to a Column by `colId` (falling back to `field`), mirroring how AG Grid derives a Column's `colId`
      * @param colDef AG Grid ColDef to look up
+     * @returns The AdapTable Column that maps to a given AG Grid ColDef The ColDef is matched to a Column by `colId` (falling back to `field`), mirroring how AG Grid derives a Column's `colId`. `undefined` when there is no match
      */
     getColumnForColDef(colDef: ColDef): AdaptableColumn | undefined;
     /**
      * Returns the AG Grid Column for a given ColumnId
      * @param columnId Column to use
+     * @returns The AG Grid Column for a given ColumnId
      */
     getAGGridColumnForColumnId(columnId: string): Column;
     /**
      * Checks if the Column with given Column Identifier (columnId or ColDef) has a specific Column Type
      * @param columnIdentifier - ColumnId or ColDef to check
      * @param columnType - Column Type to check for
+     * @returns `true` when the Column with given Column Identifier (columnId or ColDef) has a specific Column Type
      */
     hasColumnType(columnIdentifier: string | ColDef, columnType: string): boolean;
     /**
      * Gets summary info for a column including filters and unique values
      * @param columnId Column to summarise
+     * @returns Filters and distinct values for the column
      */
     getColumnSummaryForColumnId(columnId: string): AdaptableColumnSummary;
     /**
      * Whether column is auto generated by AG Grid (for selection, grouping, pivoting etc)
      * @param columnId column to check
+     * @returns `true` when column is auto generated by AG Grid (for selection, grouping, pivoting etc)
      */
     isAgGridGeneratedColumn(columnId: string): boolean;
 }

package/src/Api/ColumnFilterApi.d.ts

@@ -1,6 +1,6 @@
 import { ColumnFilter, InFilterValueResult } from '../types';
 /**
- * Provides run-time access to Filter section of Adaptable State.
+ * Column Filters in the current Layout: read, set and clear them, and test whether a filter is active.
  */
 export interface ColumnFilterApi {
     /**
@@ -17,10 +17,12 @@ export interface ColumnFilterApi {
     hideQuickFilterBar(): void;
     /**
      * Whether Quick Filter is available for use
+     * @returns `true` when Quick Filter is available for use
      */
     isQuickFilterAvailable(): boolean;
     /**
      * Whether Quick Filter Form is currently visible
+     * @returns `true` when Quick Filter Form is currently visible
      */
     isQuickFilterVisible(): boolean;
     /**
@@ -36,11 +38,13 @@ export interface ColumnFilterApi {
     /**
      * Retrieves the Column Filter for the specified Column.
      * @param columnId Column ID to lookup
+     * @returns The Column Filter for the specified Column
      */
     getColumnFilterForColumn(columnId: string): ColumnFilter | undefined;
     /**
      * Retrieves all Column Filters in a given Layout
      * @param layoutName Layout to retrieve Column Filters for
+     * @returns All Column Filters in a given Layout
      */
     getColumnFiltersForLayout(layoutName: string): ColumnFilter[];
     /**
@@ -74,12 +78,15 @@ export interface ColumnFilterApi {
      */
     clearAndSetColumnFilters(columnFilters: ColumnFilter[]): void;
     /**
-     * Checks if a Column Filter is active (i.e. Predicate has no inputs or has inputs with values)
+     * Whether a Column Filter is filtering rows. Active when it is not suspended and its expression is not empty.
+     * @param columnFilter Filter to check
+     * @returns `true` when a Column Filter is filtering rows. Active when it is not suspended and its expression is not empty
      */
     isColumnFilterActive(columnFilter: ColumnFilter): boolean;
     /**
-     * Checks if the given Coumn has an active Column Filter
+     * Whether the given column has an active Column Filter
      * @param columnId Column ID to check
+     * @returns `true` when the given column has an active Column Filter
      */
     isColumnFilterActiveForColumn(columnId: string): boolean;
     /**
@@ -103,11 +110,13 @@ export interface ColumnFilterApi {
     /**
      * Retrieves description of given Column Filter
      * @param columnFilter Column Filter to use
+     * @returns Description of given Column Filter
      */
     columnFilterToString(columnFilter: ColumnFilter): string;
     /**
      * Retrieves descriptions of given Column Filters
      * @param columnFilters Column Filters to use
+     * @returns Descriptions of given Column Filters
      */
     columnFiltersToString(columnFilters: ColumnFilter[]): string;
     /**
@@ -115,6 +124,7 @@ export interface ColumnFilterApi {
      *
      * @param columnId - the ID of the Column for which to refresh filter values.
      * @return a Promise that resolves to the list of filter values, each represented as an object with `value` and `label` properties.
+     * @returns Refresh(reload) the filter values for a given Column (for `IN` Filter)
      */
     refreshFilterValues(columnId: string): Promise<InFilterValueResult>;
     /**

package/src/Api/ColumnMenuApi.d.ts

@@ -1,10 +1,11 @@
 import { AdaptableColumnMenuItemName, AdaptableIcon, AdaptableSystemColumnMenuItem, CustomColumnMenuContext, CustomColumnMenuItem, CustomGroupColumnMenuItem, MenuCategory } from '../types';
 /**
- * Provides run-time access to Column Menu
+ * The menu opened from a column header.
  */
 export interface ColumnMenuApi {
     /**
-     * Show the Column Menu
+     * Opens the Column Menu for a column.
+     * @param columnKey Column whose menu to open
      */
     showColumnMenu(columnKey: string): void;
     /**
@@ -14,54 +15,63 @@ export interface ColumnMenuApi {
     /**
      * Creates default menu structure; useful as final line in custom implementation
      * @param context Current Menu Context
+     * @returns The default menu: the AG Grid items, a separator, then the AdapTable items
      */
     createDefaultMenuStructure(context: CustomColumnMenuContext): any;
     /**
      * Gets all Menu Items in a given category
      * @param category Category to filter on
      * @param context Current Menu Context
+     * @returns All Menu Items in a given category
      */
     getColumnMenuItemsByCategory(category: MenuCategory, context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];
     /**
      * Gets all Menu Items in given categories
      * @param categories Categories to filter on
      * @param context Current Menu Context
+     * @returns All Menu Items in given categories
      */
     getColumnMenuItemsByCategories(categories: MenuCategory[], context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];
     /**
      * Returns the Menu Item with given name
      * @param menuItemName Menu Item to filter on
      * @param context Current Menu Context
+     * @returns The Menu Item with given name
      */
     getColumnMenuItemByName(menuItemName: AdaptableColumnMenuItemName, context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>;
     /**
      * Returns the Menu Items with given names
      * @param menuItemNames Menu Items to filter on
      * @param context Current Menu Context
+     * @returns The Menu Items with given names
      */
     getColumnMenuItemsByNames(menuItemNames: AdaptableColumnMenuItemName[], context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];
     /**
      * Returns Menu Item with given label
      * @param label Label to filter on
      * @param context Current Menu Context
+     * @returns Menu Item with given label
      */
     getColumnMenuItemByLabel(label: string, context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>;
     /**
      * Returns Menu Items with given labels
      * @param labels Labels to filter on
      * @param context Current Menu Context
+     * @returns Menu Items with given labels
      */
     getColumnMenuItemsByLabels(labels: string[], context: CustomColumnMenuContext): AdaptableSystemColumnMenuItem<AdaptableColumnMenuItemName>[];
     /**
      * Removes Menu Item with given name
      * @param menuItemName name of Menu Item to remove
      * @param context Current Menu Context
+     * @returns The menu items that remain
      */
     removeAdaptableColumnMenuItemByName(menuItemName: AdaptableColumnMenuItemName, context: CustomColumnMenuContext): any;
     /**
      * Removes Menu Items with given names
      * @param menuItemNames names of Menu Items to remove
      * @param context Current Menu Context
+     * @returns The menu items that remain
      */
     removeAdaptableColumnMenuItemsByNames(menuItemNames: AdaptableColumnMenuItemName[], context: CustomColumnMenuContext): any;
     /**
@@ -70,6 +80,7 @@ export interface ColumnMenuApi {
      * @param subMenuItems Menu Items to place in Group
      * @param disabled whether group is disabled
      * @param icon icon for the Group Menu Item
+     * @returns The group menu item
      */
     createGroupMenu(label: string, subMenuItems: CustomColumnMenuItem[], disabled?: boolean, icon?: AdaptableIcon): CustomGroupColumnMenuItem;
 }