@adaptabletools/adaptable 11.1.2 → 11.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "11.1.2",
+  "version": "11.1.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",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1648639602191;
+declare const _default: 1648804784989;
 export default _default;

package/publishTimestamp.js

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

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 AdapTable React or AdapTable Angular)
+     *  How long AdapTable waits for AG Grid before giving up connecting to it
      *
      * @defaultValue 60s
      * @gridInfoItem

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -59,7 +59,7 @@ export interface NotificationsOptions {
      */
     transition?: 'Bounce' | 'Slide' | 'Zoom' | 'Flip';
     /**
-     * Display an Alert when a System Status Message is set
+     * Display System Status Messages as Notifications
      *
      * @defaultValue false
      * @gridInfoItem
@@ -73,7 +73,7 @@ export interface NotificationsOptions {
      */
     maxSystemMessagesInStore?: number;
     /**
-     * Displays the application icon in Notifications (if provided in `UserInterfaceOptions`)
+     * Displays the application icon in Notifications
      * @defaultValue false
      */
     showApplicationIcon?: boolean;

package/src/Strategy/AlertModule.js

@@ -83,12 +83,31 @@ class AlertModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             // TODO: state does not clear
             this.api.internalApi.clearFlashingCellState();
         }
-        //migrate alert definitions with `AggregationExpression` (now `AggregatedBooleanExpression`)
         (_a = alertState.AlertDefinitions) === null || _a === void 0 ? void 0 : _a.forEach((alertDefinition) => {
-            // @ts-ignore
-            const obsoleteAggregationExpression = alertDefinition.Rule['AggregationExpression'];
-            if (obsoleteAggregationExpression) {
-                alertDefinition.Rule.AggregatedBooleanExpression = obsoleteAggregationExpression;
+            // if ShowPopup then change to DisplayNotificate
+            if (alertDefinition.AlertProperties &&
+                alertDefinition.AlertProperties.ShowPopup &&
+                alertDefinition.AlertProperties.ShowPopup == true &&
+                !alertDefinition.AlertProperties.DisplayNotification) {
+                alertDefinition.AlertProperties.DisplayNotification = true;
+                alertDefinition.AlertProperties.ShowPopup = undefined;
+            }
+            // if no rule but a predicate then use that
+            if (!alertDefinition.Rule) {
+                if (alertDefinition.Predicate && alertDefinition.Predicate != undefined) {
+                    const predicate = alertDefinition.Predicate;
+                    alertDefinition.Rule = {
+                        Predicate: predicate,
+                    };
+                    alertDefinition.Predicate = undefined;
+                }
+            }
+            else {
+                //migrate alert definitions with `AggregationExpression` (now `AggregatedBooleanExpression`)
+                const obsoleteAggregationExpression = alertDefinition.Rule['AggregationExpression'];
+                if (obsoleteAggregationExpression) {
+                    alertDefinition.Rule.AggregatedBooleanExpression = obsoleteAggregationExpression;
+                }
             }
         });
     }

package/src/View/GridInfo/GridInfoPopup.js

@@ -100,10 +100,10 @@ exports.GridInfoPopup = (props) => {
     const showRadioButtons = [showGridSummary, showAdaptableOptions, showColumnInfo, showAdaptableObjects].filter((item) => item).length > 1;
     return (React.createElement(PopupPanel_1.PopupPanel, { headerText: 'Grid Info', glyphicon: 'info-sign' },
         React.createElement(rebass_1.Flex, { marginBottom: 2, padding: 3 }, showRadioButtons && (React.createElement(React.Fragment, null,
-            showGridSummary && (React.createElement(Radio_1.default, { "data-name": "radioButton-GridSummary", marginRight: 3, value: "GridSummary", checked: state.ActiveTab == 'GridSummary', onChange: (_, e) => onShowGridSummaryChanged('GridSummary') }, "Grid Summary")),
-            showAdaptableOptions && (React.createElement(Radio_1.default, { "data-name": "radioButton-AdaptableOptions", marginRight: 3, value: "AdaptableOptions", checked: state.ActiveTab == 'AdaptableOptions', onChange: (_, e) => onShowGridSummaryChanged('AdaptableOptions') }, "Adaptable Options")),
-            showColumnInfo && (React.createElement(Radio_1.default, { "data-name": "radioButton-Column", marginRight: 3, value: "Column", checked: state.ActiveTab == 'ColumnInfo', onChange: (_, e) => onShowGridSummaryChanged('ColumnInfo') }, "Column Info")),
-            showAdaptableObjects && (React.createElement(Radio_1.default, { "data-name": "radioButton-Column", value: "Column", checked: state.ActiveTab == 'AdaptableObjectsSummary', onChange: (_, e) => onShowGridSummaryChanged('AdaptableObjectsSummary') }, "Adaptable Objects"))))),
+            showGridSummary && (React.createElement(Radio_1.default, { "data-name": "radioButton-GridSummary", marginRight: 3, value: "GridSummary", checked: state.ActiveTab == 'GridSummary', onChange: (_, e) => onShowGridSummaryChanged('GridSummary') }, "Summary")),
+            showAdaptableOptions && (React.createElement(Radio_1.default, { "data-name": "radioButton-AdaptableOptions", marginRight: 3, value: "AdaptableOptions", checked: state.ActiveTab == 'AdaptableOptions', onChange: (_, e) => onShowGridSummaryChanged('AdaptableOptions') }, "Options")),
+            showColumnInfo && (React.createElement(Radio_1.default, { "data-name": "radioButton-Column", marginRight: 3, value: "Column", checked: state.ActiveTab == 'ColumnInfo', onChange: (_, e) => onShowGridSummaryChanged('ColumnInfo') }, "Columns")),
+            showAdaptableObjects && (React.createElement(Radio_1.default, { "data-name": "radioButton-Column", value: "Column", checked: state.ActiveTab == 'AdaptableObjectsSummary', onChange: (_, e) => onShowGridSummaryChanged('AdaptableObjectsSummary') }, "Objects"))))),
         state.ActiveTab == 'GridSummary' && (React.createElement(rebass_1.Box, { margin: 2 },
             React.createElement(AdaptableObjectCollection_1.AdaptableObjectCollection, { colItems: propValueColItems, items: gridSummaries }))),
         state.ActiveTab == 'AdaptableOptions' && React.createElement(AdaptableOptionsComponent_1.AdaptableOptionsComponent, { api: props.api }),

package/src/View/Layout/Wizard/LayoutEditor/index.js

@@ -347,10 +347,7 @@ exports.LayoutEditor = React.memo((props) => {
                                 React.createElement(icons_1.Icon, { name: "clear" }))));
                     } })),
             React.createElement(ListPanel, { className: "ab-LayoutEditor__PivotListPanel", header: React.createElement(rebass_1.Flex, { width: "100%", flexDirection: "row", justifyContent: "space-between", alignItems: "center" },
-                    React.createElement(rebass_1.Text, null, "Pivoted Columns"),
-                    React.createElement(CheckBox_1.CheckBox, { mt: 0, mb: 0, checked: layout.EnablePivot, onChange: (checked) => {
-                            setLayout(Object.assign(Object.assign({}, layout), { EnablePivot: checked }));
-                        } }, "Enable")), bodyProps: { padding: 0 } },
+                    React.createElement(rebass_1.Text, null, "Pivoted Columns")), bodyProps: { padding: 0 } },
                 React.createElement(PivotList_1.PivotList, { pivotColumns: layout.PivotColumns, onPivotColumnsChange: onPivotColumnsChange, isDropDisabled: state.dropDisabledOnPivot, onReady: (dragEnd) => {
                         onDragEndRef.current.pivotList = dragEnd;
                     }, renderItem: (colId, clear) => {

package/src/View/Layout/Wizard/LayoutEditorWizard.js

@@ -12,6 +12,7 @@ const AdaptablePopover_1 = require("../../AdaptablePopover");
 const rebass_1 = require("rebass");
 const Panel_1 = tslib_1.__importDefault(require("../../../components/Panel"));
 const ColumnLabels_1 = require("./LayoutEditor/ColumnLabels");
+const CheckBox_1 = require("../../../components/CheckBox");
 class LayoutEditorWizard extends React.Component {
     constructor(props) {
         super(props);
@@ -80,7 +81,11 @@ class LayoutEditorWizard extends React.Component {
                                 ' '),
                             this.state.errorMessage ? (React.createElement(FormLayout_1.FormRow, { label: "" },
                                 React.createElement(ErrorBox_1.default, null, this.state.errorMessage))) : null)),
-                    React.createElement(rebass_1.Flex, { flex: 1, pr: 2, alignItems: "center", justifyContent: "end" },
+                    React.createElement(rebass_1.Flex, { flex: 1, alignItems: "center", justifyContent: "flex-end" },
+                        React.createElement(CheckBox_1.CheckBox, { mt: 0, mb: 0, checked: this.state.layout.EnablePivot, onChange: (checked) => {
+                                this.updateLayout({ EnablePivot: checked });
+                            } }, "Enable Pivot Layout")),
+                    React.createElement(rebass_1.Flex, { width: 120, pr: 2, alignItems: "center", justifyContent: "end" },
                         React.createElement(rebass_1.Text, { mr: 2 }, "Legend"),
                         React.createElement(AdaptablePopover_1.AdaptablePopover, { popoverMinWidth: 200, bodyText: [
                                 React.createElement(Panel_1.default, { variant: "modern", header: "Legend: Column Behaviour", className: "ab-LayoutEditor__LegendPanel", style: {

package/src/agGrid/Adaptable.d.ts

@@ -131,6 +131,7 @@ export declare class Adaptable implements IAdaptable {
     private getAlertRowClass;
     private getAlertRowStyle;
     private getFlashingCellStyle;
+    private getFlashingCellClass;
     private getCellHighlightStyle;
     private getRowHighlightStyle;
     private getRowHighlightClass;

package/src/agGrid/Adaptable.js

@@ -903,6 +903,20 @@ class Adaptable {
                 ? flashingCell.flashingCellDefinition.DownChangeStyle
                 : flashingCell.flashingCellDefinition.NeutralChangeStyle)) !== null && _a !== void 0 ? _a : {});
     }
+    getFlashingCellClass(col, params) {
+        var _a, _b, _c;
+        const primaryKey = params.node.aggData
+            ? params.node.id
+            : this.getPrimaryKeyValueFromRowNode(params.node);
+        const flashingCell = this.api.internalApi.getAdaptableFlashingCellFor(primaryKey, col.columnId);
+        if (!flashingCell) {
+            return;
+        }
+        return flashingCell.direction === 'up'
+            ? (_a = flashingCell.flashingCellDefinition.UpChangeStyle) === null || _a === void 0 ? void 0 : _a.ClassName : flashingCell.direction === 'down'
+            ? (_b = flashingCell.flashingCellDefinition.DownChangeStyle) === null || _b === void 0 ? void 0 : _b.ClassName : flashingCell.direction === 'neutral'
+            ? (_c = flashingCell.flashingCellDefinition.NeutralChangeStyle) === null || _c === void 0 ? void 0 : _c.ClassName : undefined;
+    }
     getCellHighlightStyle(col, params) {
         const primaryKeyValue = this.getPrimaryKeyValueFromRowNode(params.node);
         const cellHightlight = this.api.internalApi
@@ -994,8 +1008,7 @@ class Adaptable {
                 return (_b = conditionalStyle.Style) === null || _b === void 0 ? void 0 : _b.ClassName;
             }
         })
-            .filter((x) => !!x)
-            .join(' ');
+            .filter((x) => !!x);
         return classNames;
     }
     getEditableCellClass(abColumn, params) {
@@ -2092,7 +2105,10 @@ class Adaptable {
                     if (newlyCreatedSpecialColDef) {
                         // if it's a special column and we have a special col def for it, return the special col def
                         processedSpecialColDefIds.push(colDef.colId);
-                        return newlyCreatedSpecialColDef;
+                        // merge the user defined colDef with the special col def
+                        // this way the user may provide some custom settings for the special col def (tooltip, etc)
+                        const mergedColDef = Object.assign(Object.assign({}, colDef), newlyCreatedSpecialColDef);
+                        return mergedColDef;
                     }
                     else {
                         // otherwise, return the original col def
@@ -2841,14 +2857,13 @@ class Adaptable {
             const hasConditionalStylesWithClassNames = ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(conditionalStyles);
             const quickSearchStyleClassName = this.api.quickSearchApi.getQuickSearchStyle().ClassName;
             const hasQuickSearchStyleClassName = StringExtensions_1.StringExtensions.IsNotNullOrEmpty(quickSearchStyleClassName);
-            const classNameMap = {};
             const cellClass = (params) => {
-                var _a;
                 const isQuickSearchActive = hasQuickSearchStyleClassName && this.isQuickSearchActive(abColumn, params);
                 const primaryKeyValue = this.getPrimaryKeyValueFromRowNode(params.node);
                 const editableClassName = this.getEditableCellClass(abColumn, params);
                 const readonlyClassName = this.getReadonlyCellClass(abColumn, params);
                 const highlightAlertClassName = this.getAlertCellClass(abColumn, params);
+                const flashingClassName = this.getFlashingCellClass(abColumn, params);
                 const returnValue = [
                     this.getExcelClassNameForCell(colId, primaryKeyValue),
                     typeof userCellClass === 'function' ? userCellClass(params) : userCellClass,
@@ -2860,29 +2875,11 @@ class Adaptable {
                     editableClassName,
                     readonlyClassName,
                     highlightAlertClassName,
+                    flashingClassName,
                 ]
-                    // we flatten the array because 'userCellClass' might return a string[]
+                    // we flatten the array because some rules ('userCellClass',conditionalStyles etc)  might return a string[]
                     .flat()
                     .filter((x) => !!x);
-                const returnValueHash = returnValue.join(' ');
-                const primaryKey = this.getPrimaryKeyValueFromRowNode(params.node);
-                const key = `${primaryKey}:${params.colDef.colId}`;
-                if (classNameMap[key] &&
-                    classNameMap[key] !== returnValueHash &&
-                    // only hard-reset when removing class-names
-                    // ag-grid does not remove class-names, it accumulates them
-                    // https://www.ag-grid.com/javascript-data-grid/cell-styles/#refresh-of-styles
-                    returnValueHash.length < ((_a = classNameMap[key]) === null || _a === void 0 ? void 0 : _a.length)) {
-                    setTimeout(() => {
-                        /**
-                         * This is called inside a getter function, inside ag-grid.
-                         * To allow ag-grid run it's logic, the redraw is done inside an timeout
-                         * to make sure it is not done in an inappropriate time.
-                         */
-                        params.api.redrawRows({ rowNodes: [params.node] });
-                    }, 0);
-                }
-                classNameMap[key] = returnValueHash;
                 return returnValue.length ? returnValue : undefined;
             };
             return cellClass;

package/src/metamodel/adaptable.metamodel.d.ts

@@ -3601,6 +3601,11 @@ export declare const ADAPTABLE_METAMODEL: {
             isOptional: boolean;
         }[];
     };
+    TOAST_POSITIONS: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     ToolPanelApi: {
         name: string;
         kind: string;

package/src/metamodel/adaptable.metamodel.js

@@ -3574,7 +3574,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "agGridContainerWaitTimeout",
                 "kind": "number",
-                "description": "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)",
+                "description": "How long AdapTable waits for AG Grid before giving up connecting to it",
                 "uiLabel": "Ag Grid Container Wait Timeout",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -8599,12 +8599,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "gridInfo": "item",
                 "defaultValue": "'BottomRight'",
-                "reference": "unknown"
+                "reference": "TOAST_POSITIONS"
             },
             {
                 "name": "showApplicationIcon",
                 "kind": "boolean",
-                "description": "Displays the application icon in Notifications (if provided in `UserInterfaceOptions`)",
+                "description": "Displays the application icon in Notifications",
                 "uiLabel": "Show Application Icon",
                 "isOptional": true,
                 "defaultValue": "false"
@@ -8621,7 +8621,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "showSystemStatusMessageNotifications",
                 "kind": "boolean",
-                "description": "Display an Alert when a System Status Message is set",
+                "description": "Display System Status Messages as Notifications",
                 "uiLabel": "Show System Status Message Notifications",
                 "isOptional": true,
                 "gridInfo": "item",
@@ -11179,6 +11179,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "TOAST_POSITIONS": {
+        "name": "TOAST_POSITIONS",
+        "kind": "TypeAlias",
+        "description": "Different positions offered by Notifications"
+    },
     "ToolPanelApi": {
         "name": "ToolPanelApi",
         "kind": "Interface",

package/src/types.d.ts

@@ -9,7 +9,7 @@ export type { AdaptableOptions } from './AdaptableOptions/AdaptableOptions';
 export { AdaptablePlugin } from './AdaptableOptions/AdaptablePlugin';
 export type { ContainerOptions } from './AdaptableOptions/ContainerOptions';
 export type { FlashingCellOptions } from './AdaptableOptions/FlashingCellOptions';
-export type { NotificationsOptions } from './AdaptableOptions/NotificationsOptions';
+export type { TOAST_POSITIONS, NotificationsOptions, } from './AdaptableOptions/NotificationsOptions';
 export type { AlertOptions, ActionHandler, AlertForm, AlertButtonContext, } from './AdaptableOptions/AlertOptions';
 export type { DashboardOptions, CustomToolbar, DashboardButtonContext, CustomToolbarButtonContext, } from './AdaptableOptions/DashboardOptions';
 export type { EditOptions, ValidationResult } from './AdaptableOptions/EditOptions';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.1.2";
+declare const _default: "11.1.3";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '11.1.2'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '11.1.3'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version