@adaptabletools/adaptable 10.0.2 → 10.0.3

package/base.css

@@ -1362,6 +1362,19 @@
   --ab-cmp-datepicker__font-size: var(--ab-font-size-2);
   --ab-cmp-datepicker__font-family: var(--ab__font-family);
   --ab-cmp-datepicker__cell-size: 30px; }
+:root {
+  --ab-cmp-loader__background: var(--ab-color-primarydark);
+  --ab-cmp-loader__border: var(--ab-color-text-on-primary);
+  --ab-cmp-loader__font-size: var(--ab-font-size-2); }
+:root {
+  --ab-cmp-progress-indicator__delay: 1s;
+  --ab-cmp-progress-indicator__z-index: 9999;
+  --ab-cmp-progress-indicator__font-size: var(--ab-font-size-4);
+  --ab-cmp-progress-indicator__font-style: italic;
+  --ab-cmp-progress-indicator__font-family: var(--ab__font-family);
+  --ab-cmp-progress-indicator__padding: var(--ab-space-3);
+  --ab-cmp-progress-indicator__background: var(--ab-color-primary);
+  --ab-cmp-progress-indicator__color: var(--ab-color-text-on-primary); }
 :root {
   --ab-cmp-wizard__padding: var(--ab-space-5);
   --ab-cmp-wizard__margin: var(--ab-space-1);
@@ -1471,6 +1484,8 @@
   --ab-cmp-toolpanel-header__grid-gap: 3px;
   --ab-cmp-toolpanel__color: var(--ab-dashboard__color);
   --ab-cmp-toolpanel__font-family: var(--ab__font-family); }
+:root {
+  --ab-cmp-custom-sort-wizard-loader__font-size: var(--ab-font-size-4); }
 .ab-Radio-input:focus + svg rect {
   stroke: var(--ab-color-accent);
   stroke-width: 2; }
@@ -2255,6 +2270,55 @@ input[type="number"].ab-Input:hover::-webkit-inner-spin-button:active {
   box-shadow: var(--ab-focus__box-shadow); }
 .ab-ToggleButton__input:disabled + .ab-ToggleButton__slider {
   opacity: 0.5; }
+.ab-Loader {
+  font-size: var(--ab-cmp-loader__font-size);
+  margin-top: 8px;
+  font-style: italic; }
+.ab-Loader__text, .ab-Loader__Spinner {
+  vertical-align: middle; }
+.ab-Loader .ab-Loader__Spinner {
+  margin-right: 5px; }
+.ab-Loader__Spinner {
+  display: inline-block;
+  border-radius: 50%;
+  border: 2px solid var(--ab-cmp-loader__background);
+  border-top: 2px solid var(--ab-cmp-loader__border);
+  width: 10px;
+  height: 10px;
+  bottom: 0;
+  animation: spin 1.5s linear infinite; }
+@keyframes spin {
+  0% {
+    transform: rotate(0deg); }
+  100% {
+    transform: rotate(360deg); } }
+.ab-progress-indicator-wrapper {
+  align-items: center;
+  display: flex;
+  justify-content: center;
+  position: fixed;
+  top: 0;
+  left: 0;
+  height: 0;
+  width: 0;
+  z-index: var(--ab-cmp-progress-indicator__z-index);
+  opacity: 0;
+  transition-delay: var(--ab-cmp-progress-indicator__delay);
+  transition-property: opacity;
+  transition-duration: 0.3s; }
+.ab-progress-indicator-wrapper--visible {
+    opacity: 1; }
+.ab-progress-indicator-wrapper .ab-progress-indicator-body {
+    padding: var(--ab-cmp-progress-indicator__padding);
+    background: var(--ab-cmp-progress-indicator__background);
+    color: var(--ab-cmp-progress-indicator__color);
+    border-style: none;
+    border-width: 0px;
+    border-radius: var(--ab__border-radius);
+    box-shadow: var(--ab-focus__box-shadow);
+    font-size: var(--ab-cmp-progress-indicator__font-size);
+    font-style: var(--ab-cmp-progress-indicator__font-style);
+    font-family: var(--ab-cmp-progress-indicator__font-family); }
 .ab-ObjectCollection__list > * {
   background: var(--ab-cmp-listgroupitem__background);
   color: var(--ab-cmp-listgroupitem__color); }
@@ -2364,6 +2428,8 @@ html.ab--theme-dark .ab-ListBoxFilterForm--vendor-style {
     flex-direction: row;
     flex-wrap: wrap;
     grid-gap: var(--ab-cmp-toolpanel-header__grid-gap); }
+.ab-CustomSortWizard__SortOrder .ab-Loader__text {
+  font-size: var(--ab-cmp-custom-sort-wizard-loader__font-size); }
 .ab-alert--error {
   background: var(--ab-color-error); }
 .ab-alert--success {
@@ -2488,31 +2554,7 @@ html.ab--theme-dark .ab-ListBoxFilterForm--vendor-style {
   flex-flow: column; }
 .ag-details-row .ag-details-grid {
     flex: 1; }
-div.ab-progress-indicator-wrapper {
-  align-items: center;
-  display: flex;
-  height: 100vh;
-  justify-content: center;
-  left: 0;
-  position: fixed;
-  top: 0;
-  width: 100%;
-  z-index: 9999;
-  opacity: 0;
-  transition-delay: 0.5s;
-  transition-property: opacity;
-  transition-duration: 0.3s; }
-div.ab-progress-indicator-wrapper--visible {
-    opacity: 1; }
-div.ab-progress-indicator-wrapper .ab-progress-indicator-text {
-    padding: var(--ab-space-3);
-    background: var(--ab-color-primary);
-    color: var(--ab-color-text-on-primary);
-    border-style: none;
-    border-width: 0px;
-    border-radius: var(--ab__border-radius);
-    box-shadow: var(--ab-focus__box-shadow);
-    font-size: var(--ab-font-size-3);
-    font-family: var(--ab__font-family); }
+.ab-wait-for-progress-indicator.ab-Grid {
+  pointer-events: none; }
 
 /*# sourceMappingURL=base.css.map */

package/index.css

@@ -1941,6 +1941,21 @@ template {
   --ab-cmp-datepicker__font-family: var(--ab__font-family);
   --ab-cmp-datepicker__cell-size: 30px; }
 
+:root {
+  --ab-cmp-loader__background: var(--ab-color-primarydark);
+  --ab-cmp-loader__border: var(--ab-color-text-on-primary);
+  --ab-cmp-loader__font-size: var(--ab-font-size-2); }
+
+:root {
+  --ab-cmp-progress-indicator__delay: 1s;
+  --ab-cmp-progress-indicator__z-index: 9999;
+  --ab-cmp-progress-indicator__font-size: var(--ab-font-size-4);
+  --ab-cmp-progress-indicator__font-style: italic;
+  --ab-cmp-progress-indicator__font-family: var(--ab__font-family);
+  --ab-cmp-progress-indicator__padding: var(--ab-space-3);
+  --ab-cmp-progress-indicator__background: var(--ab-color-primary);
+  --ab-cmp-progress-indicator__color: var(--ab-color-text-on-primary); }
+
 :root {
   --ab-cmp-wizard__padding: var(--ab-space-5);
   --ab-cmp-wizard__margin: var(--ab-space-1);
@@ -2072,6 +2087,9 @@ template {
   --ab-cmp-toolpanel__color: var(--ab-dashboard__color);
   --ab-cmp-toolpanel__font-family: var(--ab__font-family); }
 
+:root {
+  --ab-cmp-custom-sort-wizard-loader__font-size: var(--ab-font-size-4); }
+
 .ab-Radio-input:focus + svg rect {
   stroke: var(--ab-color-accent);
   stroke-width: 2; }
@@ -3053,6 +3071,63 @@ input[type="number"].ab-Input:hover::-webkit-inner-spin-button:active {
 .ab-ToggleButton__input:disabled + .ab-ToggleButton__slider {
   opacity: 0.5; }
 
+.ab-Loader {
+  font-size: var(--ab-cmp-loader__font-size);
+  margin-top: 8px;
+  font-style: italic; }
+
+.ab-Loader__text, .ab-Loader__Spinner {
+  vertical-align: middle; }
+
+.ab-Loader .ab-Loader__Spinner {
+  margin-right: 5px; }
+
+.ab-Loader__Spinner {
+  display: inline-block;
+  border-radius: 50%;
+  border: 2px solid var(--ab-cmp-loader__background);
+  border-top: 2px solid var(--ab-cmp-loader__border);
+  width: 10px;
+  height: 10px;
+  bottom: 0;
+  animation: spin 1.5s linear infinite; }
+
+@keyframes spin {
+  0% {
+    transform: rotate(0deg); }
+  100% {
+    transform: rotate(360deg); } }
+
+.ab-progress-indicator-wrapper {
+  align-items: center;
+  display: flex;
+  justify-content: center;
+  position: fixed;
+  top: 0;
+  left: 0;
+  height: 0;
+  width: 0;
+  z-index: var(--ab-cmp-progress-indicator__z-index);
+  opacity: 0;
+  transition-delay: var(--ab-cmp-progress-indicator__delay);
+  transition-property: opacity;
+  transition-duration: 0.3s; }
+
+.ab-progress-indicator-wrapper--visible {
+    opacity: 1; }
+
+.ab-progress-indicator-wrapper .ab-progress-indicator-body {
+    padding: var(--ab-cmp-progress-indicator__padding);
+    background: var(--ab-cmp-progress-indicator__background);
+    color: var(--ab-cmp-progress-indicator__color);
+    border-style: none;
+    border-width: 0px;
+    border-radius: var(--ab__border-radius);
+    box-shadow: var(--ab-focus__box-shadow);
+    font-size: var(--ab-cmp-progress-indicator__font-size);
+    font-style: var(--ab-cmp-progress-indicator__font-style);
+    font-family: var(--ab-cmp-progress-indicator__font-family); }
+
 .ab-ObjectCollection__list > * {
   background: var(--ab-cmp-listgroupitem__background);
   color: var(--ab-cmp-listgroupitem__color); }
@@ -3191,6 +3266,9 @@ html.ab--theme-dark .ab-ListBoxFilterForm--vendor-style {
     flex-wrap: wrap;
     grid-gap: var(--ab-cmp-toolpanel-header__grid-gap); }
 
+.ab-CustomSortWizard__SortOrder .ab-Loader__text {
+  font-size: var(--ab-cmp-custom-sort-wizard-loader__font-size); }
+
 .ab-alert--error {
   background: var(--ab-color-error); }
 
@@ -3346,34 +3424,8 @@ html.ab--theme-dark .ab-ListBoxFilterForm--vendor-style {
 .ag-details-row .ag-details-grid {
     flex: 1; }
 
-div.ab-progress-indicator-wrapper {
-  align-items: center;
-  display: flex;
-  height: 100vh;
-  justify-content: center;
-  left: 0;
-  position: fixed;
-  top: 0;
-  width: 100%;
-  z-index: 9999;
-  opacity: 0;
-  transition-delay: 0.5s;
-  transition-property: opacity;
-  transition-duration: 0.3s; }
-
-div.ab-progress-indicator-wrapper--visible {
-    opacity: 1; }
-
-div.ab-progress-indicator-wrapper .ab-progress-indicator-text {
-    padding: var(--ab-space-3);
-    background: var(--ab-color-primary);
-    color: var(--ab-color-text-on-primary);
-    border-style: none;
-    border-width: 0px;
-    border-radius: var(--ab__border-radius);
-    box-shadow: var(--ab-focus__box-shadow);
-    font-size: var(--ab-font-size-3);
-    font-family: var(--ab__font-family); }
+.ab-wait-for-progress-indicator.ab-Grid {
+  pointer-events: none; }
 
 html.ab--theme-light {
   --ab-theme-loaded: light; }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "10.0.2",
+  "version": "10.0.3",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "main": "index.js",
   "typings": "index.d.ts",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1636016021593;
+declare const _default: 1637681957931;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1636016021593;
+exports.default = 1637681957931;

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -114,7 +114,10 @@ export interface IAdaptable {
     jumpToRow(rowNode: RowNode): void;
     jumpToColumn(columnId: string): void;
     jumpToCell(columnId: string, rowNode: RowNode): void;
+    getGridContainerElement(): HTMLElement | null;
     setDataSource(dataSource: any): void;
+    getGridData(): any[];
+    getFilteredData(): any[];
     loadDataSource(dataSource: any): void;
     updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
     addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
@@ -136,12 +139,17 @@ export interface IAdaptable {
         [key: string]: boolean;
     }): any[];
     getDistinctValuesForColumn(column: AdaptableColumn, visibleRowsOnly: boolean, skipRowNode?: RowNode): GridCell[];
+    getDistinctFilterValuesForColumn(column: AdaptableColumn, visibleRowsOnly: boolean, filter: string, skipRowNode?: RowNode): Promise<{
+        gridCells: GridCell[];
+        suppressClientSideFilter?: boolean;
+    }>;
+    getDistinctCustomSortValuesForColumn(column: AdaptableColumn, visibleRowsOnly: boolean, skipRowNode?: RowNode): Promise<GridCell[]>;
+    getDistinctBulkUpdateValuesForColumn(column: AdaptableColumn, visibleRowsOnly: boolean, selectedGridCells: GridCell[], skipRowNode?: RowNode): Promise<GridCell[]>;
     getDisplayValue(id: any, columnId: string): string;
     getGridCellFromRowNode(rowNode: RowNode, columnId: string): GridCell | undefined;
     getRawValueFromRowNode(rowNode: RowNode, columnId: string): any;
     getDisplayValueFromRowNode(rowNode: RowNode, columnId: string): string | undefined;
-    getFormattedValueFromRawValue(rawValue: any, columnId: string): string | undefined;
-    getDisplayValueFromRawValue(columnId: string, rawValue: any, skipCellRenderers?: boolean): string | undefined;
+    getDisplayValueFromRawValue(columnId: string, rawValue: any): string | undefined;
     getDataRowFromRowNode(rowNode: RowNode): any;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): RowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): RowNode;
@@ -205,6 +213,8 @@ export interface IAdaptable {
     closeAllRowGroups(): void;
     expandRowGroupsForValues(columnValues: any[]): void;
     getExpandRowGroupsKeys(): any[];
+    getAdaptableContainerElement(): HTMLElement | null;
+    getGridContainerElement(): HTMLElement | null;
     buildStandaloneColumnHeader(adaptableColumn: AdaptableColumn): AdaptableMenuItem[];
     setupColumns(): void;
     updateColDefsForSpecialColumns({ skipSetupColumns }?: {

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -58,6 +58,13 @@ export interface FilterOptions {
      * @gridInfoItem
      */
     quickFilterTrigger?: 'mouseenter' | 'click';
+    /**
+     * Whether to open Quick Filter Values dropdown with mouse hover or click
+     *
+     * @defaultValue 'mouseenter'
+     * @gridInfoItem
+     */
+    quickFilterValuesTrigger?: 'mouseenter' | 'click';
     /**
      * When to re-filter grid after user edits data: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')
      *
@@ -92,26 +99,26 @@ export interface FilterOptions {
      */
     sortColumnValuesInFilter?: boolean;
     /**
-     * Default filter type for numeric Columns in Quick Filter
+     * Default filter type for numeric Columns
      *
      * @defaultValue Equals
      * @gridInfoItem
      */
-    defaultNumericColumnFilter?: 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals';
+    defaultNumericColumnFilter?: 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | ((column: AdaptableColumn) => 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals');
     /**
-     * Default filter type for string Columns in Quick Filter
+     * Default filter type for string Columns
      *
      * @defaultValue Contains
      * @gridInfoItem
      */
-    defaultStringColumnFilter?: 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex';
+    defaultStringColumnFilter?: 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | ((column: AdaptableColumn) => 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex');
     /**
-     * Default filter type for date Columns in Quick Filter
+     * Default filter type for date Columns
      *
      * @defaultValue On
      * @gridInfoItem
      */
-    defaultDateColumnFilter?: 'After' | 'Before' | 'On' | 'NotOn';
+    defaultDateColumnFilter?: 'After' | 'Before' | 'On' | 'NotOn' | ((column: AdaptableColumn) => 'After' | 'Before' | 'On' | 'NotOn');
     /**
      * Whether to open the Filter Form on the Values or Predicates tab
      *
@@ -120,7 +127,7 @@ export interface FilterOptions {
      */
     defaultFilterFormTab?: 'Values' | 'Predicates';
     /**
-     * Allows filtering on Calculated, Action & FreeText columns
+     * Allows filtering on Calculated & FreeText columns
      *
      * @defaultValue true
      * @gridInfoItem

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -32,7 +32,7 @@ export interface LayoutOptions {
      */
     autoSizeColumnsInPivotLayout?: boolean;
     /**
-     * Whether a "Default Layout" will be created in addition to Layouts in Config (if none there, Default Layout is always created)
+     * Whether a "Default Layout" will be created in addition to Layouts provided in Config
      *
      * @defaultValue false
      * @gridInfoItem

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -6,6 +6,7 @@ import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/Adapt
 import { RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
+import { GridCell } from '../../types';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -30,11 +31,27 @@ export interface UserInterfaceOptions {
     /**
      * List of values which are permitted (e.g. to show in filter)
      */
-    permittedValues?: CellValuesList[];
+    permittedValues?: PermittedValues[];
     /**
-     * Dropdown values displayed when column is being edited
+     * Dropdown values displayed when column is being edited.
+     * When not defined it defaults to permittedValues.
      */
-    editLookUpItems?: CellValuesList[];
+    editLookUpItems?: EditLookUpPermittedValues[];
+    /**
+     * Dropdown values for filter options inside floating and header filter.
+     * When not defined it defaults to permittedValues.
+     */
+    filterPermittedValues?: FilterPermittedValues[];
+    /**
+     * Custom column values for defining custom sort.
+     * When not defined it defaults to permittedValues.
+     */
+    customSortPermittedValues?: CustomSortPermittedValues[];
+    /**
+     * Custom column values for editing via bulk-update.
+     * When not defined it defaults to permittedValues.
+     */
+    bulkUpdatePermittedValues?: BulkUpdatePermittedValues[];
     /**
      * Colours to display in Colour Picker (in place of AdapTable's default set)
      */
@@ -65,16 +82,56 @@ export interface UserInterfaceOptions {
      */
     showDocumentationLinks?: boolean;
 }
-export interface CellValuesList {
+export interface BasePermittedValues {
     /**
      * Scope where Values will appear (Mandatory property)
      */
     scope: AdaptableScope;
+}
+/**
+ * Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)
+ */
+export interface PermittedValues extends BasePermittedValues {
     /**
      * Values to display: either hardcoded list or a function
      */
     values?: any[] | ((column: AdaptableColumn) => any[]);
 }
+/**
+ * Used to define permitted values for inline column editor
+ */
+export interface EditLookUpPermittedValues extends BasePermittedValues {
+    values?: any[] | ((column: AdaptableColumn, rowData: any) => any[]);
+}
+/**
+ * Used to define values inside the floating filter and floating filter (quick filter)
+ */
+export interface FilterPermittedValues extends BasePermittedValues {
+    /**
+     * Prevents adaptable from filtering the list of values client-side.
+     * When true, values is called each time filtering is done, via the search bar.
+     * @default false
+     */
+    suppressClientSideFiltering?: boolean;
+    values: (column: AdaptableColumn, filter: string) => any[] | Promise<any[]>;
+}
+/**
+ * Custom column values for custom sort.
+ */
+export interface CustomSortPermittedValues extends BasePermittedValues {
+    values: (column: AdaptableColumn) => any[] | Promise<any[]>;
+}
+/**
+ * User to define permitted values for when updating cells via bulk update
+ */
+export interface BulkUpdatePermittedValues extends BasePermittedValues {
+    values: (column: AdaptableColumn, selectedGridCells: GridCell[]) => any[] | Promise<any[]>;
+}
+/**
+ * Use PermittedValues instead
+ * @deprecated
+ */
+export declare type CellValuesList = PermittedValues;
 /**
  * A Special Column that wraps an AdapTable Button
  */
@@ -95,6 +152,10 @@ export interface ActionColumn extends AdaptableObject {
      * Shows Action Column also in grouped rows
      */
     includeGroupedRows?: boolean;
+    /**
+     * Additional optional properties for Column (e.g. filterable, resizable)
+     */
+    actionColumnSettings?: ActionColumnSettings;
 }
 /**
  * Context required by functions when using an Action Column Button
@@ -113,3 +174,27 @@ export interface ActionColumnButtonContext extends ButtonContext {
      */
     rowNode: RowNode;
 }
+/**
+ * Set of optional properties that define an Action Columns behaviour
+ */
+export interface ActionColumnSettings {
+    /**
+     * Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid
+     */
+    width?: number;
+    /**
+     * Whether Column can be resized (by dragging column header edges)
+     * @defaultValue true
+     */
+    resizable?: boolean;
+    /**
+     * Whether no menu should be shown for this Column header.
+     * @defaultValue false
+     */
+    suppressMenu?: boolean;
+    /**
+     * Whether if this Column should be movable via dragging
+     * @defaultValue false
+     */
+    suppressMovable?: boolean;
+}

package/src/Api/AlertApi.d.ts

@@ -241,7 +241,7 @@ export interface AlertApi {
      * Returns a description of an Alert Definition
      * @param alertDefinition Alert Definition to use
      */
-    getAlertDescription(alertDefinition: AlertDefinition): string;
+    getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
     /**
      * Returns a description of an Alert Definition's Rule
      * @param alertDefinition Alert Definition to use

package/src/Api/ColumnApi.d.ts

@@ -1,6 +1,7 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { DataType } from '../PredefinedConfig/Common/Enums';
 import { RowNode } from '@ag-grid-community/all-modules';
+import { GridCell } from '../../types';
 /**
  * A large range of column-related functions in AdapTable
  */
@@ -131,6 +132,10 @@ export interface ColumnApi {
      * @param columnId Column to check
      */
     isNumericColumn(column: AdaptableColumn): boolean;
+    /**
+     * Is Column Boolean
+     * @param columnId Column to check
+     */
     isBooleanColumn(column: AdaptableColumn): boolean;
     /**
      * Is Column a Date
@@ -205,6 +210,26 @@ export interface ColumnApi {
      * @param columnId Column to check
      */
     getDistinctDisplayValuesForColumn(columnId: string): any[];
+    /**
+     * Gets all distinct display values in for filter column, used for Floating Filter and Column Header filter
+     * @param columnId Column to check
+     * @param columnFilter Current applied filter
+     */
+    getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string): Promise<{
+        values: any[];
+        suppressClientSideFilter: boolean;
+    }>;
+    /**
+     * Gets all distinct column display values in for custom sort.
+     * @param columnId Column to check
+     */
+    getDistinctCustomSortDisplayValuesForColumn(columnId: string): Promise<any[]>;
+    /**
+     * Gets all distinct column display values for bulk update.
+     * @param columnId Column to check
+     * @param selectedGridCells Selected grid cells
+     */
+    getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
     /**
      * Gets all distinct visible display values in the Column
      * @param columnId Column to check
@@ -234,6 +259,14 @@ export interface ColumnApi {
      * @param columnId string
      */
     getVendorGridColumnFieldForColumn(columnId: string): string;
+    /**
+     * Does Column use AdapTable's Filter Form
+     * @param columnId Column to Check
+     */
     usesAdaptableFilterForm(columnId: string): boolean;
+    /**
+     * Does Column use AdapTable's Quick Filter
+     * @param columnId Column to Check
+     */
     usesAdaptableQuickFilter(columnId: string): boolean;
 }

package/src/Api/ConfigApi.d.ts

@@ -94,6 +94,10 @@ export interface ConfigApi {
      * @param returnJson whether to return section as JSON or object
      */
     getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson: boolean): ConfigState | string;
+    /**
+     * Adds '1' to current revision number of State element
+     * @param stateKey Adaptable State Key to update
+     */
     incrementUerStateRevision(stateKey: AdaptableStateKey): void;
     /**
      * Returns Alert section of Adaptable State
@@ -200,5 +204,9 @@ export interface ConfigApi {
      * @param returnJson return as JSON rather than object
      */
     getToolPanelState(returnJson: boolean): ToolPanelState;
+    /**
+     * Sent by each Module when it is Ready
+     * @param module Module which is Ready
+     */
     dispatchStateReadyAction(module: AdaptableModule): void;
 }