@adaptabletools/adaptable 10.0.0-canary.3 → 10.0.3

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -22,51 +22,32 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         return this.getUserInterfaceOptions().styleClassNames;
     }
     getAllPermittedValuesItems() {
-        return this.getUserInterfaceOptions().permittedValues;
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.permittedValues) !== null && _b !== void 0 ? _b : [];
     }
-    getPermittedValuesItemsWithColumnScope() {
-        return this.getAllPermittedValuesItems().filter((pv) => {
-            return 'ColumnIds' in pv.scope == true;
-        });
-    }
-    getPermittedValuesItemsWithDataTypeScope() {
-        return this.getAllPermittedValuesItems().filter((pv) => {
-            return 'DataTypes' in pv.scope == true;
-        });
-    }
-    getPermittedValuesItemsWithAllScope() {
-        return this.getAllPermittedValuesItems().filter((pv) => {
-            return 'All' in pv.scope == true;
-        });
-    }
-    getPermittedValuesForScope(column) {
+    getPermittedValuesForScope(column, permittedValues) {
         let permittedValuesItem;
-        this.getPermittedValuesItemsWithColumnScope().forEach((pv) => {
-            if (!permittedValuesItem) {
-                if (this.adaptable.api.scopeApi.isColumnInScope(column, pv.scope)) {
-                    permittedValuesItem = pv;
-                }
-            }
+        /**
+         * The previous implementation prioritized column-id, data-types and all
+         */
+        // columns id
+        permittedValuesItem = permittedValues.find((permittedValue) => {
+            return ('ColumnIds' in permittedValue.scope &&
+                this.adaptable.api.scopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
-        this.getPermittedValuesItemsWithDataTypeScope().forEach((pv) => {
-            if (!permittedValuesItem) {
-                if (this.adaptable.api.scopeApi.isColumnInScope(column, pv.scope)) {
-                    permittedValuesItem = pv;
-                }
-            }
+        permittedValuesItem = permittedValues.find((permittedValue) => {
+            return ('DataTypes' in permittedValue.scope &&
+                this.adaptable.api.scopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
-        this.getPermittedValuesItemsWithAllScope().forEach((pv) => {
-            if (!permittedValuesItem) {
-                if (this.adaptable.api.scopeApi.isColumnInScope(column, pv.scope)) {
-                    permittedValuesItem = pv;
-                }
-            }
+        permittedValuesItem = permittedValues.find((permittedValue) => {
+            return ('All' in permittedValue.scope &&
+                this.adaptable.api.scopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
@@ -77,7 +58,8 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(this.getAllPermittedValuesItems())) {
             return undefined;
         }
-        let permittedValuesColumn = this.getPermittedValuesForScope(column);
+        const allPermittedValues = this.getAllPermittedValuesItems();
+        let permittedValuesColumn = this.getPermittedValuesForScope(column, allPermittedValues);
         if (!permittedValuesColumn) {
             return undefined;
         }
@@ -96,58 +78,53 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         }
         return undefined;
     }
-    getAllEditLookUpItems() {
-        return this.getUserInterfaceOptions().editLookUpItems;
+    getAllFilterPermittedValuesItems() {
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.filterPermittedValues) !== null && _b !== void 0 ? _b : [];
     }
-    getEditLookUpItemForColumn(columnId) {
-        const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);
-        if (!abColumn) {
+    getFilterPermittedValuesForColumn(column) {
+        const allFilterPermittedValuesItems = this.getAllFilterPermittedValuesItems();
+        if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(allFilterPermittedValuesItems)) {
             return undefined;
         }
-        let editLookUpItem;
-        let editLookUpItems = this.getAllEditLookUpItems();
-        if (!editLookUpItems) {
+        return this.getPermittedValuesForScope(column, allFilterPermittedValuesItems);
+    }
+    getAllCustomSortPermittedValuesItems() {
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.customSortPermittedValues) !== null && _b !== void 0 ? _b : [];
+    }
+    getCustomSortPermittedValuesForColumn(column) {
+        const allFilterPermittedValuesItems = this.getAllCustomSortPermittedValuesItems();
+        if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(allFilterPermittedValuesItems)) {
             return undefined;
         }
-        // first we get any for the column as that is lower level
-        const columnEditLookItems = editLookUpItems.filter((pv) => {
-            return 'ColumnIds' in pv.scope == true;
-        });
-        columnEditLookItems.forEach((eli) => {
-            if (this.adaptable.api.scopeApi.isColumnInScopeColumns(abColumn, eli.scope)) {
-                editLookUpItem = eli;
-            }
-        });
-        if (editLookUpItem) {
-            return editLookUpItem;
+        return this.getPermittedValuesForScope(column, allFilterPermittedValuesItems);
+    }
+    getAllBulkUpdatePermittedValuesItems() {
+        var _a, _b;
+        return (_b = (_a = this.getUserInterfaceOptions()) === null || _a === void 0 ? void 0 : _a.bulkUpdatePermittedValues) !== null && _b !== void 0 ? _b : [];
+    }
+    getBulkUpdatePermittedValuesForColumn(column) {
+        const allFilterPermittedValuesItems = this.getAllBulkUpdatePermittedValuesItems();
+        if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(allFilterPermittedValuesItems)) {
+            return undefined;
         }
-        // then we get any for the DataType
-        const dateEditLookItems = editLookUpItems.filter((pv) => {
-            return 'DataTypes' in pv.scope == true;
-        });
-        dateEditLookItems.forEach((eli) => {
-            if (this.adaptable.api.scopeApi.isColumnInDateScope(abColumn, eli.scope)) {
-                editLookUpItem = eli;
-            }
-        });
-        if (editLookUpItem) {
-            return editLookUpItem;
+        return this.getPermittedValuesForScope(column, allFilterPermittedValuesItems);
+    }
+    getAllEditLookUpItems() {
+        return this.getUserInterfaceOptions().editLookUpItems || [];
+    }
+    getEditLookUpItemForColumn(column) {
+        if (!column) {
+            return undefined;
         }
-        // then we get any for All
-        const allTypeEditLookItems = editLookUpItems.filter((pv) => {
-            return 'All' in pv.scope == true;
-        });
-        allTypeEditLookItems.forEach((eli) => {
-            if (this.adaptable.api.scopeApi.isColumnInScope(abColumn, eli.scope)) {
-                editLookUpItem = eli;
-            }
-        });
-        if (editLookUpItem) {
-            return editLookUpItem;
+        let editLookUpItems = this.getAllEditLookUpItems();
+        if (!editLookUpItems) {
+            return undefined;
         }
-        return undefined;
+        return this.getPermittedValuesForScope(column, editLookUpItems);
     }
-    getEditLookUpValuesForEditLookUpItem(editLookUpItem, columnId) {
+    getEditLookUpValuesForEditLookUpItem(editLookUpItem, columnId, data) {
         if (!editLookUpItem) {
             return undefined;
         }
@@ -158,7 +135,7 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         let editLookUpValues = editLookUpItem.values;
         // first do the function then get hardcoded items
         if (editLookUpValues != null && typeof editLookUpValues === 'function') {
-            return editLookUpValues(column);
+            return editLookUpValues(column, data);
         }
         else {
             let arr = editLookUpValues;

package/src/Api/InternalApi.d.ts

@@ -116,4 +116,6 @@ export interface InternalApi {
     destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar'): void;
     initializeDataChangeHistory(): void;
     isTextComparisonCaseSensitive(): boolean;
+    executeWithProgressIndicator(label: string, executeFn: () => unknown): void;
+    hideProgressIndicator(): void;
 }

package/src/Api/QueryLanguageApi.d.ts

@@ -1,4 +1,5 @@
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
+import { ExpressionFunctionMap } from '../types';
 /**
  * Manages AdapTableQL (Query Language)
  */
@@ -33,6 +34,10 @@ export interface QueryLanguageApi {
      * Returns all columns that can be used in an Expression
      */
     getQueryableColumnIds(): string[];
+    /**
+     * Returns the current Module Expression Map
+     */
+    getModuleExpressionFunctionMap(): ExpressionFunctionMap;
     /**
      * Runs the AST that AdapTableQL creates for a expression - useful when evaluating remotely
      * @param expression expression to be run

package/src/Api/UserInterfaceApi.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
 import { UserMenuItem } from '../PredefinedConfig/Common/Menu';
-import { ActionColumn, CellValuesList } from '../AdaptableOptions/UserInterfaceOptions';
+import { ActionColumn, BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../AdaptableOptions/UserInterfaceOptions';
 /**
  * Functions relating to User Interface section of Adaptable State
  */
@@ -17,27 +17,36 @@ export interface UserInterfaceApi {
     /**
      * Retrieves `permittedValues` property from User Interface Options
      */
-    getAllPermittedValuesItems(): CellValuesList[];
+    getAllPermittedValuesItems(): PermittedValues[];
     /**
      * Retrieves Permitted Values for a given Column
      * @param column column for which to retrieve Permitted Values
      */
     getPermittedValuesForColumn(column: AdaptableColumn): any[];
+    /**
+     * Retrieves Permitted values for filtering by column values in Floating Filter and dropdown Filter.
+     */
+    getFilterPermittedValuesForColumn(column: AdaptableColumn): FilterPermittedValues | undefined;
+    /**
+     * Retrieves Permitted values for Custom sort.
+     */
+    getCustomSortPermittedValuesForColumn(column: AdaptableColumn): CustomSortPermittedValues | undefined;
+    getBulkUpdatePermittedValuesForColumn(column: AdaptableColumn): BulkUpdatePermittedValues | undefined;
     /**
      * Retrieves `editLookUpItems` property from User Interface Options
      */
-    getAllEditLookUpItems(): CellValuesList[];
+    getAllEditLookUpItems(): EditLookUpPermittedValues[];
     /**
      * Retrieves EditLookUpItems for a given Column
      * @param columnId Column for which to retrieve EditLookUpItems
      */
-    getEditLookUpItemForColumn(columnId: string): CellValuesList | undefined;
+    getEditLookUpItemForColumn(column: AdaptableColumn): EditLookUpPermittedValues | undefined;
     /**
      * Retrieves actual Look Up Values from an EditLookUpItem
      * @param editLookUpItem editLookUpItem to check
      * @param columnId Column to check
      */
-    getEditLookUpValuesForEditLookUpItem(editLookUpItem: CellValuesList, columnId: string): any[] | undefined;
+    getEditLookUpValuesForEditLookUpItem(editLookUpItem: EditLookUpPermittedValues, columnId: string, rowData: any): any[] | undefined;
     /**
      * Adds menu item to Column Menu
      * @param userMenuItem Menu Item to add

package/src/PredefinedConfig/AlertState.d.ts

@@ -11,6 +11,7 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableAggregationQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
 import { ButtonStyle } from './Common/ButtonStyle';
 import { AlertButtonContext } from '../AdaptableOptions/NotificationsOptions';
+import { DataChangedInfo } from './Common/DataChangedInfo';
 /**
  * Predefined Configuration for Alert function
  */
@@ -45,22 +46,27 @@ export interface BaseAlertDefinition extends SuspendableObject {
 export interface FlashingAlertProperties {
     /**
      * Should a cell or whole row flash
+     * @defaultValue  'cell'
      */
     FlashTarget?: 'row' | 'cell';
     /**
      * Style for 'Down' value changes
+     *  @defaultValue  Red BackColour
      */
     DownChangeStyle?: AdaptableStyle;
     /**
      * Style for 'Up' value changes
+     * @defaultValue  Green BackColour
      */
     UpChangeStyle?: AdaptableStyle;
     /**
      * Style for 'Neutral' value changes
+     * @defaultValue  Gray BackColour
      */
     NeutralChangeStyle?: AdaptableStyle;
     /**
      * Duration of Flash - can be number (in ms) or 'always'
+     * @defaultValue 500ms
      */
     FlashDuration?: number | 'always';
 }
@@ -77,6 +83,10 @@ export interface AlertDefinition extends BaseAlertDefinition {
      * Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging
      */
     MessageType: AdaptableMessageType;
+    /**
+     * Alert Message - can be string or function; if not provided AdapTable creates dynamically using Rule & Scope
+     */
+    MessageText?: string | ((scope: AdaptableScope, rule: AlertRule, dataChangedInfo?: DataChangedInfo) => string);
     /**
      * Series of properties which set what happens when Alert is triggered
      */

package/src/PredefinedConfig/CalculatedColumnState.d.ts

@@ -1,6 +1,7 @@
 import { ConfigState } from './ConfigState';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { AdaptableScalarQuery } from './Common/AdaptableQuery';
+import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 /**
  * Predefined Configuration for Calculated Column function
  **/
@@ -24,7 +25,7 @@ export interface CalculatedColumn extends AdaptableObject {
      */
     FriendlyName?: string;
     /**
-     * Addtional optional properties for Column (e.g. filterable, resizable)
+     * Additional optional properties for Column (e.g. filterable, resizable)
      */
     CalculatedColumnSettings?: CalculatedColumnSettings;
     /**
@@ -35,9 +36,9 @@ export interface CalculatedColumn extends AdaptableObject {
 /**
  * Set of optional properties that define a Calculated Column's behaviour
  */
-export interface CalculatedColumnSettings {
+export interface CalculatedColumnSettings extends SpecialColumnSettings {
     /**
-     *  Expression's return value DataType; inferred by AdapTable but setable by User
+     *  Expression's return value DataType; inferred by AdapTable but settable by User
      */
     DataType?: 'String' | 'Number' | 'Boolean' | 'Date';
     /**
@@ -45,38 +46,4 @@ export interface CalculatedColumnSettings {
      * @defaultValue false
      */
     ShowToolTip?: boolean;
-    /**
-     * Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid
-     */
-    Width?: number;
-    /**
-     * Whether Column is filterable
-     * @defaultValue true
-     */
-    Filterable?: boolean;
-    /**
-     * Whether Column can be resized (by dragging column header edges)
-     * @defaultValue true
-     */
-    Resizable?: boolean;
-    /**
-     * Whether Column can be grouped
-     * @defaultValue true
-     */
-    Groupable?: boolean;
-    /**
-     * Whether Column is sortable
-     * @defaultValue true
-     */
-    Sortable?: boolean;
-    /**
-     * Whether Column can be used when grid is in pivot mode
-     * @defaultValue true
-     */
-    Pivotable?: boolean;
-    /**
-     * Whether Column can be used in an aggregation when grouping
-     * @defaultValue true
-     */
-    Aggregatable?: boolean;
 }

package/src/PredefinedConfig/Common/AdaptablePredicate.js

@@ -16,6 +16,7 @@ const isAfter_1 = tslib_1.__importDefault(require("date-fns/isAfter"));
 const isBefore_1 = tslib_1.__importDefault(require("date-fns/isBefore"));
 const isSameDay_1 = tslib_1.__importDefault(require("date-fns/isSameDay"));
 const CalendarHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/CalendarHelper"));
+const DateHelper_1 = require("../../Utilities/Helpers/DateHelper");
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */
@@ -273,7 +274,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isToday_1.default(value),
+        handler: ({ value }) => isToday_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'Yesterday',
@@ -281,7 +282,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isYesterday_1.default(value),
+        handler: ({ value }) => isYesterday_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'Tomorrow',
@@ -289,7 +290,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isTomorrow_1.default(value),
+        handler: ({ value }) => isTomorrow_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'ThisWeek',
@@ -297,7 +298,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isThisWeek_1.default(value),
+        handler: ({ value }) => isThisWeek_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'ThisMonth',
@@ -305,7 +306,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isThisMonth_1.default(value),
+        handler: ({ value }) => isThisMonth_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'ThisQuarter',
@@ -313,7 +314,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isThisQuarter_1.default(value),
+        handler: ({ value }) => isThisQuarter_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'ThisYear',
@@ -321,7 +322,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isThisYear_1.default(value),
+        handler: ({ value }) => isThisYear_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'InPast',
@@ -329,7 +330,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isPast_1.default(value),
+        handler: ({ value }) => isPast_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'InFuture',
@@ -337,7 +338,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value }) => isFuture_1.default(value),
+        handler: ({ value }) => isFuture_1.default(DateHelper_1.parseDateValue(value)),
     },
     {
         id: 'After',
@@ -346,7 +347,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => isAfter_1.default(value, new Date(inputs[0])),
+        handler: ({ value, inputs }) => isAfter_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `> ${inputs[0]}`,
     },
     {
@@ -356,7 +357,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => isBefore_1.default(value, new Date(inputs[0])),
+        handler: ({ value, inputs }) => isBefore_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `< ${inputs[0]}`,
     },
     {
@@ -366,7 +367,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => isSameDay_1.default(value, new Date(inputs[0])),
+        handler: ({ value, inputs }) => isSameDay_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `= ${inputs[0]}`,
     },
     {
@@ -376,7 +377,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => !isSameDay_1.default(value, new Date(inputs[0])),
+        handler: ({ value, inputs }) => !isSameDay_1.default(DateHelper_1.parseDateValue(value), new Date(inputs[0])),
         toString: ({ inputs }) => `!= ${inputs[0]}`,
     },
     {
@@ -385,7 +386,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value, api }) => isSameDay_1.default(value, CalendarHelper_1.default.getNextWorkingDay()),
+        handler: ({ value, api }) => isSameDay_1.default(DateHelper_1.parseDateValue(value), CalendarHelper_1.default.getNextWorkingDay()),
     },
     {
         id: 'LastWorkDay',
@@ -393,7 +394,7 @@ exports.SystemPredicateDefs = [
         icon: { path: 'calendar' },
         columnScope: { DataTypes: ['Date'] },
         moduleScope: ['filter', 'alert', 'conditionalstyle'],
-        handler: ({ value, api }) => isSameDay_1.default(value, CalendarHelper_1.default.getPreviousWorkingDay()),
+        handler: ({ value, api }) => isSameDay_1.default(DateHelper_1.parseDateValue(value), CalendarHelper_1.default.getPreviousWorkingDay()),
     },
     {
         id: 'InRange',

package/src/PredefinedConfig/Common/DataUpdateConfig.d.ts

@@ -3,11 +3,15 @@
  */
 export interface DataUpdateConfig {
     /**
-     * Whether data should be updated aysnchoronously
+     * Whether data should be updated asynchronously
      */
     runAsync?: boolean;
     /**
      * Callback function invoked when a batch successfully updates
      */
     callback?: (res: any) => void;
+    /**
+     * Index where to add new rows
+     */
+    addIndex?: number;
 }

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

@@ -0,0 +1,49 @@
+/**
+ * Base Settings for SpecialColumns
+ */
+export interface SpecialColumnSettings {
+    /**
+     * Preferred width (in pixels) for Column; if unset, calculated dynamically by underlying Grid
+     */
+    Width?: number;
+    /**
+     * Whether Column is filterable
+     * @defaultValue true
+     */
+    Filterable?: boolean;
+    /**
+     * Whether Column can be resized (by dragging column header edges)
+     * @defaultValue true
+     */
+    Resizable?: boolean;
+    /**
+     * Whether Column can be grouped
+     * @defaultValue true
+     */
+    Groupable?: boolean;
+    /**
+     * Whether Column is sortable
+     * @defaultValue true
+     */
+    Sortable?: boolean;
+    /**
+     * Whether Column can be used when grid is in pivot mode
+     * @defaultValue true
+     */
+    Pivotable?: boolean;
+    /**
+     * Whether Column can be used in an aggregation when grouping
+     * @defaultValue true
+     */
+    Aggregatable?: boolean;
+    /**
+     * Whether if 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/PredefinedConfig/FilterState.d.ts

@@ -48,4 +48,4 @@ export interface ColumnFilterPredicate extends AdaptablePredicate {
     PredicateId: TypeHint<string, SystemFilterPredicateId>;
 }
 export declare type SystemFilterPredicateIds = SystemFilterPredicateId[];
-export declare type SystemFilterPredicateId = 'Values' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'InRange' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False';
+export declare type SystemFilterPredicateId = 'Values' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'InRange' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False' | 'BooleanToggle';

package/src/PredefinedConfig/FreeTextColumnState.d.ts

@@ -1,5 +1,6 @@
 import { ConfigState } from './ConfigState';
 import { AdaptableObject } from './Common/AdaptableObject';
+import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 /**
  * Predefined Configuration for the Free Text Column function
  */
@@ -39,6 +40,10 @@ export interface FreeTextColumn extends AdaptableObject {
      * @defaultValue 'String'
      */
     DataType?: 'String' | 'Number' | 'Boolean' | 'Date';
+    /**
+     * Additional optional properties for Column (e.g. filterable, resizable)
+     */
+    FreeTextColumnSettings?: FreeTextColumnSettings;
 }
 /**
  * Defines a cell value stored in a Free Text Column
@@ -53,3 +58,8 @@ export interface FreeTextStoredValue {
      */
     FreeText: any;
 }
+/**
+ * Set of optional properties that define a FreeText Columns behaviour
+ */
+export interface FreeTextColumnSettings extends SpecialColumnSettings {
+}

package/src/PredefinedConfig/Selection/GridRow.d.ts

@@ -25,19 +25,27 @@ export interface GridRow {
  */
 export interface RowInfo {
     /**
-     * Whether Row is a Master Row (in a Master-Detail grid)
+     * Is Row  a Master Row (in a Master-Detail grid)
      */
     isMaster?: boolean;
     /**
-     * Whether - if a Group Row - it is currently expanded
+     * Is Row expanded (if a group row)
      */
     isExpanded?: boolean;
     /**
-     * Whether Row is a Row Group
+     * Is Row grouped
      */
     isGroup?: boolean;
+    /**
+     * Is Row selected
+     */
+    isSelected?: boolean;
+    /**
+     * Is Row displayed (ie. filtered, not necessarily in viewport)
+     */
+    isDisplayed?: boolean;
     /**
      * What level the Row is (if Row Grouping is active)
      */
-    level?: number;
+    rowGroupLevel?: number;
 }