@adaptabletools/adaptable 11.0.0-canary.3 → 11.0.0-canary.7

package/src/AdaptableOptions/{QueryLanguageOptions.d.ts → AdaptableQLOptions.d.ts}

@@ -1,15 +1,35 @@
 import { ExpressionFunctionMap } from '../parser/src/types';
-import { AdaptableModule } from '../PredefinedConfig/Common/Types';
+import { AdaptableModule, AdaptableQLModules } from '../PredefinedConfig/Common/Types';
+export interface AdaptableQLOptions {
+    /**
+     * Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    caseSensitiveTextComparisons?: boolean;
+    /**
+     * Which searching and filtering options should take place on server
+     *
+     * @defaultValue undefined
+     * @gridInfoItem
+     */
+    externallyEvaluatedModules?: AdaptableQLModules;
+    /**
+     * Options for managing Expressions in AdapTableQL
+     *
+     */
+    expressionOptions?: ExpressionOptions;
+}
 /**
  * Options for managing Expressions using AdapTableQL
  */
-export interface QueryLanguageOptions {
+export interface ExpressionOptions {
     /**
      * Boolean Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#boolean-functions
      */
     defaultBooleanFunctions?: ExpressionFunctionMap;
     /**
@@ -17,7 +37,6 @@ export interface QueryLanguageOptions {
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#scalar-functions
      */
     defaultScalarFunctions?: ExpressionFunctionMap;
     /**
@@ -25,17 +44,22 @@ export interface QueryLanguageOptions {
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#observable-functions
      */
     defaultObservableFunctions?: ExpressionFunctionMap;
     /**
-     * Aggregation Expression Functions available in AdapTableQL
+     * Aggregated Boolean Expression Functions available in AdapTableQL
+     *
+     * @defaultValue null (sets all)
+     * @gridInfoItem
+     */
+    defaultAggregatedBooleanFunctions?: ExpressionFunctionMap;
+    /**
+     * Aggregated Scalar Expression Functions available in AdapTableQL
      *
      * @defaultValue null (sets all)
      * @gridInfoItem
-     * @see https://docs.adaptabletools.com/docs/adaptableql/query#aggregation-functions
      */
-    defaultAggregationFunctions?: ExpressionFunctionMap;
+    defaultAggregatedScalarFunctions?: ExpressionFunctionMap;
     /**
      * Module specific ExpressionFunctions; if not defined, it falls back to the defined default values
      *
@@ -74,5 +98,6 @@ export interface ModuleExpressionFunctions {
     booleanFunctions?: ExpressionFunctionMap;
     scalarFunctions?: ExpressionFunctionMap;
     observableFunctions?: ExpressionFunctionMap;
-    aggregationFunctions?: ExpressionFunctionMap;
+    aggregatedBooleanFunctions?: ExpressionFunctionMap;
+    aggregatedScalarFunctions?: ExpressionFunctionMap;
 }

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -0,0 +1,82 @@
+import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
+import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
+import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
+import { DataChangedInfo } from '../types';
+/**
+ * Options related to Alerts in Adaptable.
+ */
+export interface AlertOptions {
+    /**
+     * How many alerts held in State at any one time; when limit is breached, oldest alert will be removed
+     *
+     * @defaultValue  20
+     * @gridInfoItem
+     */
+    maxAlertsInStore?: number;
+    /**
+     * How long (in ms) a cell will be highlighted
+     *
+     * @defaultValue 3000
+     * @gridInfoItem
+     */
+    cellHighlightDuration?: number;
+    /**
+     * onClick Handlers for Alert Buttons (defined in Alert State)
+     */
+    actionHandlers?: ActionHandler[];
+    /**
+     * Full definitions of Alert Forms - the names of which are provided in Alert State
+     */
+    alertForms?: AlertForm[];
+    /**
+     * Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data
+     *
+     * @defaultValue 'rawValue'
+     * @gridInfoItem
+     */
+    dataChangeDetectionPolicy?: 'rawValue' | 'formattedValue';
+    /**
+     * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
+     */
+    alertMessageText?: (alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo) => string | undefined;
+}
+/**
+ * Handles a Form Button Action
+ */
+export declare type ActionHandler = {
+    /**
+     * Name of the Handler
+     */
+    name: string;
+    /**
+     * Handler function to call when the Button is clicked
+     */
+    handler: (button: AlertButton<AlertButtonContext>, context: AlertButtonContext) => void;
+};
+/**
+ * Form to show in an Alert
+ */
+export declare type AlertForm = {
+    /**
+     * Name of the Form
+     */
+    name: string;
+    /**
+     * The Form to display in the Alert
+     */
+    form: AdaptableForm<AlertButtonContext>;
+};
+/**
+ * Context required by functions when using an Alert Button
+ */
+export interface AlertButtonContext extends ButtonContext {
+    /**
+     * Alert that has been triggered
+     */
+    alert: AdaptableAlert;
+    /**
+     * Data in the Alert Form
+     */
+    formData?: AdaptableFormData;
+}

package/src/AdaptableOptions/AlertOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -17,7 +17,7 @@ export interface ContainerOptions {
      */
     agGridContainer?: string | HTMLElement;
     /**
-     *  how long AdapTable waits for AG Grid before giving up connecting to it; useful when AG Grid is instantiated separately (eg: by React or Angular Wrappers)
+     *  how long AdapTable waits for AG Grid before giving up connecting to it; useful when AG Grid is instantiated separately (eg: by AdapTable React or AdapTable Angular)
      *
      * @defaultValue 60s
      * @gridInfoItem
@@ -29,7 +29,7 @@ export interface ContainerOptions {
      * @defaultValue undefined
      * @gridInfoItem
      */
-    modalContainer?: string;
+    modalContainer?: string | HTMLElement;
     /**
      * Div to show System Status messages - string Id or HTMLElement
      *

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -38,7 +38,7 @@ export interface FilterOptions {
      */
     useAdaptableFilterForm?: boolean | string[];
     /**
-     * Styles Adaptable Filter Form to match AG Grid's current styling
+     * Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)
      *
      * @defaultValue true
      * @gridInfoItem

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -70,13 +70,6 @@ export interface GeneralOptions {
      * CustomSort column comparer functions
      */
     customSortComparers?: ColumnValuesComparer[];
-    /**
-     * Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates
-     *
-     * @defaultValue false
-     * @gridInfoItem
-     */
-    caseSensitiveTextComparisons?: boolean;
 }
 /**
  * Comparer object for Column Values - used for custom sorting

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -1,19 +1,7 @@
-import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
-import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
-import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
-import { DataChangedInfo } from '../types';
 /**
- * Options related to Alerts, System Status Messages and Notifications in Adaptable.
+ * Options related to System Status Messages and Notifications in Adaptable.
  */
 export interface NotificationsOptions {
-    /**
-     * How many alerts held in State at any one time; when limit is breached, oldest alert will be removed
-     *
-     * @defaultValue  20
-     * @gridInfoItem
-     */
-    maxAlertsInStore?: number;
     /**
      * How many Notifications can be displayed at one time
      *
@@ -35,13 +23,6 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     duration?: number | 'always';
-    /**
-     * How long (in ms) a cell will be highlighted
-     *
-     * @defaultValue 3000
-     * @gridInfoItem
-     */
-    cellHighlightDuration?: number;
     /**
      * Shows a Progress Bar in the Notification
      *
@@ -77,21 +58,6 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     transition?: 'Bounce' | 'Slide' | 'Zoom' | 'Flip';
-    /**
-     * onClick Handlers for Alert Buttons (defined in Alert State)
-     */
-    actionHandlers?: ActionHandler[];
-    /**
-     * Full definitions of Alert Forms - the names of which are provided in Alert State
-     */
-    alertForms?: AlertForm[];
-    /**
-     * Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data
-     *
-     * @defaultValue 'rawValue'
-     * @gridInfoItem
-     */
-    dataChangeDetectionPolicy?: 'rawValue' | 'formattedValue';
     /**
      * Display an Alert when a System Status Message is set
      *
@@ -111,49 +77,6 @@ export interface NotificationsOptions {
      * @defaultValue false
      */
     showApplicationIcon?: boolean;
-    /**
-     * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
-     */
-    alertMessageText?: (alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo) => string | undefined;
-}
-/**
- * Handles a Form Button Action
- */
-export declare type ActionHandler = {
-    /**
-     * Name of the Handler
-     */
-    name: string;
-    /**
-     * Handler function to call when the Button is clicked
-     */
-    handler: (button: AlertButton<AlertButtonContext>, context: AlertButtonContext) => void;
-};
-/**
- * Form to show in an Alert
- */
-export declare type AlertForm = {
-    /**
-     * Name of the Form
-     */
-    name: string;
-    /**
-     * The Form to display in the Alert
-     */
-    form: AdaptableForm<AlertButtonContext>;
-};
-/**
- * Context required by functions when using an Alert Button
- */
-export interface AlertButtonContext extends ButtonContext {
-    /**
-     * Alert that has been triggered
-     */
-    alert: AdaptableAlert;
-    /**
-     * Data in the Alert Form
-     */
-    formData?: AdaptableFormData;
 }
 /**
  * Different positions offered by Notifications

package/src/AdaptableOptions/SearchOptions.d.ts

@@ -16,13 +16,6 @@ export interface SearchOptions {
      * @gridInfoItem
      */
     quickSearchPlaceholder?: string;
-    /**
-     * Which searching and filtering options, if any, should take place on server
-     *
-     * @defaultValue undefined
-     * @gridInfoItem
-     */
-    serverSearchOptions?: ServerSearchOptions;
     /**
      * Clears saved searches when AdapTable loads
      *
@@ -38,5 +31,3 @@ export interface SearchOptions {
      */
     filterResultsAfterQuickSearch?: boolean;
 }
-export declare type ServerSearchOptions = ServerSearchOption[];
-export declare type ServerSearchOption = 'Query' | 'Filter' | 'Sort';

package/src/AdaptableOptions/StateOptions.d.ts

@@ -1,30 +1,30 @@
 import { AdaptableState } from '../PredefinedConfig/AdaptableState';
 /**
- * Options related to state hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality.
+ * Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality
  */
 export interface StateOptions {
     /**
-     * Allows the customization of state persistence.
+     * Allows the customization of state persistence
      */
     persistState?: AdaptablePersistStateFunction;
     /**
-     * Allows the customization of state loading.
+     * Allows the customization of Adaptable State loading
      */
     loadState?: AdaptableLoadStateFunction;
     /**
-     * Allows the customization of the state that is going to be persisted
+     * Allows the customization of the Adaptable State that is going to be persisted
      */
     saveState?: AdaptableSaveStateFunction;
     /**
-     * Allows hooking into AdaptableState hydration
+     * Allows hooking into Adaptable State hydration
      */
     applyState?: (state: any) => any;
     /**
-     * Allows clearing of remote state.
+     * Allows clearing of remote Adaptable State
      */
     clearState?: AdaptableClearStateFunction;
     /**
-     * Delay (in ms) to debounce saveState/persistState calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)
+     * Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)
      *
      * **Defaults to: 400**. Also, the wait will be max 1000ms, at which point the save/persist calls will happen anyway.
      *
@@ -44,10 +44,11 @@ export declare type AdaptableStateFunctionConfig = {
  * Used by the `persistState` function property in StateOptions
  *
  * @example
- *
+ * ```
  * persistState = (state, {adaptableId, adaptableStateKey}) => {
  *  localStorage.setItem(adaptableStateKey, JSON.stringify(state))
  * }
+ * ```
  */
 export interface AdaptablePersistStateFunction {
     (state: any, { adaptableId, adaptableStateKey, userName, url }: AdaptableStateFunctionConfig): Promise<any>;

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -11,13 +11,13 @@ export interface TeamSharingOptions {
      */
     enableTeamSharing: boolean;
     /**
-     * Function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State
+     * Async function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State
      *
      * @defaultValue null
      */
     getSharedEntities: (adaptableId: string) => Promise<SharedEntity[]>;
     /**
-     * Function which uploads Shared Entities so they can be downloaded by other members of the team
+     * Async function which uploads Shared Entities so they can be downloaded by other members of the team
      *
      * @defaultValue null
      */

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -31,13 +31,11 @@ export interface ToolPanelOptions {
     /**
      * The initial width of AdapTable ToolPanel
      * @defaultValue var(--ab-cmp-toolpanel__width)
-     * @see https://docs.adaptabletools.com/docs/theming/css-variables#toolpanel
      */
     width?: number;
     /**
      * The min width of AdapTable ToolPanel
      * @defaultValue var(--ab-cmp-toolpanel__width)
-     * @see https://docs.adaptabletools.com/docs/theming/css-variables#toolpanel
      */
     minWidth?: number;
     /**

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -89,7 +89,7 @@ export interface UserInterfaceOptions {
     /**
      * Which sections to show in the Grid Info Screen
      *
-     * @defaultValue ['GridSummary', 'AdaptableOptions','ColumnInfo']
+     * @defaultValue ['GridSummary', 'AdaptableOptions', 'ColumnInfo']
      */
     gridInfoSections?: GridInfoSections;
 }
@@ -120,7 +120,7 @@ export interface EditLookUpPermittedValues extends BasePermittedValues {
 export interface FilterPermittedValues extends BasePermittedValues {
     /**
      * Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
-     * @default false
+     * @defaultValue false
      */
     suppressFilterSearchBar?: boolean;
     values: (params: FilterPermittedValuesParams) => any[] | Promise<any[]>;
@@ -139,7 +139,7 @@ export interface BulkUpdatePermittedValues extends BasePermittedValues {
 }
 /**
  * Use PermittedValues instead
- * @deprecated
+ * @deprecated use PermittedValues instead
  */
 export declare type CellValuesList = PermittedValues;
 /**

package/src/Api/AdaptableApi.d.ts

@@ -35,6 +35,7 @@ import { PredicateApi } from './PredicateApi';
 import { DataChangeHistoryApi } from './DataChangeHistoryApi';
 import { FlashingCellApi } from './FlashingCellApi';
 import { ChartingApi } from './ChartingApi';
+import { SettingsPanelApi } from './SettingsPanelApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -147,6 +148,10 @@ export interface AdaptableApi {
      * Provides access to the Schedule Module
      */
     scheduleApi: ScheduleApi;
+    /**
+     * Provides access to the Settings Panel
+     */
+    settingsPanelApi: SettingsPanelApi;
     /**
      * Manages the `Scope` object - used widely to determine where objects are applied
      */
@@ -185,6 +190,7 @@ export interface AdaptableApi {
     chartingApi: ChartingApi;
     /**
      * Api methods used *internally* within AdapTable.
+     * @internal
      */
     internalApi: InternalApi;
     /**

package/src/Api/AlertApi.d.ts

@@ -4,8 +4,7 @@ import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
-import { AlertButtonContext } from '../AdaptableOptions/NotificationsOptions';
-import { AdaptableMessageType, AlertProperties } from '../types';
+import { AdaptableMessageType, AlertButtonContext, AlertProperties } from '../types';
 /**
  * Provides run-time access to Alert function and associated State
  */
@@ -158,7 +157,7 @@ export interface AlertApi {
     suspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     /**
      * Activates a suspended Alert Definition
-     * @param alertDefinition Alert to Un-suspend (activate)
+     * @param alertDefinition - Alert to Un-suspend (activate)
      * @returns alert definition
      */
     unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;

package/src/Api/CalculatedColumnApi.d.ts

@@ -12,8 +12,8 @@ export interface CalculatedColumnApi {
      */
     getAllCalculatedColumn(): CalculatedColumn[];
     /**
-     * Retrieves Calculated column by id
-     * @param id Calculated column id
+     * Retrieves Calculated Column by the unique identifier of the Adaptable Object in the CalculatedColumnState
+     * @param id - Calculated Column state unique identifier
      * @returns calculated column
      */
     getCalculatedColumnById(id: CalculatedColumn['Uuid']): CalculatedColumn;
@@ -41,13 +41,6 @@ export interface CalculatedColumnApi {
      * @returns calculated columns
      */
     editCalculatedColumns(calcColumns: CalculatedColumn[]): CalculatedColumn[];
-    /**
-     * Replaces Expression in given Calculated Column with new value
-     * @param calcColumn Calculated Column for which Expression should change
-     * @param columnExpression New Expression for Calculated Column
-     * @returns calculated columns
-     */
-    editCalculatedColumnExpression(calcColumn: string, columnExpression: string): CalculatedColumn;
     /**
      * Removes Calculated Column from State
      *

package/src/Api/ColumnApi.d.ts

@@ -35,10 +35,6 @@ export interface ColumnApi {
      * Returns all boolean Columns
      */
     getBooleanColumns(): AdaptableColumn[];
-    /**
-     * Returns all numeric array Columns
-     */
-    getNumericArrayColumns(): AdaptableColumn[];
     /**
      * Returns all Sortable Columns
      */

package/src/Api/EventApi.d.ts

@@ -195,9 +195,14 @@ export interface EventApi {
     off(eventName: 'LiveDataChanged', callback: (liveDataChangedInfo: LiveDataChangedInfo) => void): void;
     /**
      * Fired when Adaptable is up and running - has no arguments.
-     * @param eventName AdaptableReady - use as: adaptableApi.eventApi.on('AdaptableReady', (adaptableReadyInfo: AdaptableReadyInfo) => { .....[do stuff]...})
-     * @param callback An `AdaptableReadyInfo` object which contains the adaptableApi and GridOptions
-     * @returns the unsubscribe function
+     * @param eventName - AdaptableReady
+     * @param callback - An `AdaptableReadyInfo` object which contains the adaptableApi and GridOptions
+     * @returns the unsubscribe function
+     *
+     * @example Use as
+     * ```
+     * adaptableApi.eventApi.on('AdaptableReady', (adaptableReadyInfo: AdaptableReadyInfo) => { .....[do stuff]...})
+     * ```
      */
     on(eventName: 'AdaptableReady', callback: (adaptableReadyInfo: AdaptableReadyInfo) => void): VoidFunction;
     /**

package/src/Api/Events/GridDataChanged.d.ts

@@ -5,13 +5,15 @@ import { BaseEventInfo } from './BaseEventInfo';
  */
 export interface GridDataChangedInfo extends BaseEventInfo {
     /**
-     * Rows that have been added, updated, or deleted
+     * Data rows that have been added, updated, or deleted
      */
     dataRows: any[];
     /**
      * Trigger for row change: 'Add', 'Edit' or 'Delete'
-  }
      */
     rowTrigger: 'Add' | 'Edit' | 'Delete';
+    /**
+     * AG Grid Row Nodes that were affected by the Change
+     */
     rowNodes: RowNode[];
 }

package/src/Api/Events/SystemStatusMessageDisplayed.d.ts

@@ -1,7 +1,7 @@
 import { SystemStatusMessageInfo } from '../../PredefinedConfig/Common/SystemStatusMessageInfo';
 import { BaseEventInfo } from './BaseEventInfo';
 /**
- * Object returned by the `SystemStatusMessageDisplayed' event
+ * Object returned by the `SystemStatusMessageDisplayed` event
  */
 export interface SystemStatusMessageDisplayedInfo extends BaseEventInfo {
     /**

package/src/Api/FreeTextColumnApi.d.ts

@@ -34,18 +34,6 @@ export interface FreeTextColumnApi {
     editFreeTextColumn(freeTextColumn: Partial<FreeTextColumn> & {
         ColumnId: string;
     }): FreeTextColumn;
-    /**
-     * Creates new FreeTextColumn and adds it to Adaptable State
-     * @param columnId the id for the column - try to keep this small and unique (and dont use spaces)
-     * @param param.columnName the name for the column - optional - if not provided, will default to the columnId
-     * @param param.defaultValue the default value that will appear in the Column unless overrident - leave blank if you dont require a default value
-     * @returns free text column
-     */
-    createFreeTextColumn(param: {
-        columnId: string;
-        columnName?: string;
-        defaultValue: string;
-    }): FreeTextColumn;
     /**
      * Deletes existing FreeTextColumn from Adaptable State
      * @param columnId name of FreeTextColumn to delete

package/src/Api/GridApi.d.ts

@@ -5,7 +5,8 @@ import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
 import { GridCell } from '../PredefinedConfig/Selection/GridCell';
 import { DataUpdateConfig } from '../PredefinedConfig/Common/DataUpdateConfig';
 import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
-import { CellHighlightInfo, RowHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
+import { CellHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo';
+import { RowHighlightInfo } from '../PredefinedConfig/Common/RowHighlightInfo';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
 import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
@@ -142,6 +143,16 @@ export interface GridApi {
      * @param clearSelection Whether to clear current selection in grid
      */
     deSelectNode(rowNode: RowNode, clearSelection: boolean): void;
+    /**
+     * Selects a Column in AG Grid
+     * @param columnId Id of Column to Select
+     */
+    selectColumn(columnId: string): void;
+    /**
+     * Selects Columns in AG Grid
+     * @param columnIds Ids of Columns to Select
+     */
+    selectColumns(columnIds: string[]): void;
     /**
      * AG Grid Row Nodes in AdapTable
      * @param rowNodes Nodes to DeSelect
@@ -173,7 +184,7 @@ export interface GridApi {
      */
     deSelectRows(primaryKeyValues: any[], clearSelection: boolean): void;
     /**
-     * Selects a group of cells in a given range
+     * Selects a group of cells in a given range - provide either primary keys or row indexes
      * @param gridCellRange range to select
      */
     selectCellRange(gridCellRange: GridCellRange): void;

package/src/Api/IPushPullApi.d.ts

@@ -59,7 +59,7 @@ export interface IPushPullApi {
     /**
      * Retrieves all the ipushpull domain to which the current user has access
      *
-     * An `IPushPullDomain' contains 3 properties:
+     * An `IPushPullDomain` contains 3 properties:
      *
      * - **Name**: the name of the Domain / Folder
      *

package/src/Api/Implementation/AdaptableApiImpl.d.ts

@@ -1,5 +1,5 @@
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
-import { AdaptableApi } from '../../types';
+import { AdaptableApi, SettingsPanelApi } from '../../types';
 import { AlertApi } from '../AlertApi';
 import { BulkUpdateApi } from '../BulkUpdateApi';
 import { CalculatedColumnApi } from '../CalculatedColumnApi';
@@ -71,6 +71,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     userInterfaceApi: UserInterfaceApi;
     queryApi: QueryApi;
     queryLanguageApi: QueryLanguageApi;
+    settingsPanelApi: SettingsPanelApi;
     toolPanelApi: ToolPanelApi;
     teamSharingApi: TeamSharingApi;
     scopeApi: ScopeApi;