@adaptabletools/adaptable 11.0.3 → 11.0.6

package/src/View/License/LicenseWatermark.js

@@ -1,65 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LicenseWatermark = void 0;
-const tslib_1 = require("tslib");
-const React = tslib_1.__importStar(require("react"));
-const Logo_1 = require("../../components/Logo");
-const rebass_1 = require("rebass");
-const style = {
-    border: '1px solid var(--ab-color-error)',
-    padding: '5px',
-    fontWeight: 600,
-    margin: '5px',
-    fontSize: '14px',
-    alignItems: 'center',
-    color: 'var(--ab-color-text-on-defaultbackground)',
-    background: 'var(--ab-color-defaultbackground)',
-};
-const isStyleValid = (element) => {
-    const notAllowedProperties = [
-        ['display', 'none'],
-        ['opacity', '0'],
-        ['position', 'absolute'],
-        ['position', 'fixed'],
-        ['position', 'relative'],
-        ['visibility', 'hidden'],
-    ];
-    for (const [prop, value] of notAllowedProperties) {
-        if (element.style[prop] === value) {
-            return false;
-        }
-    }
-    return true;
-};
-exports.LicenseWatermark = (props) => {
-    const ref = React.useRef(null);
-    React.useEffect(() => {
-        const checkWatermark = () => {
-            var _a, _b;
-            if (!((_a = ref.current) === null || _a === void 0 ? void 0 : _a.isConnected)) {
-                alert('It is not allowed to remove the Adaptable watermark.');
-            }
-            if (!isStyleValid(ref.current)) {
-                alert('It is not allowed to modify the Adaptable watermark.');
-            }
-            if ((_b = ref === null || ref === void 0 ? void 0 : ref.current) === null || _b === void 0 ? void 0 : _b.style) {
-                ref.current.style.border = style.border;
-                ref.current.style.padding = style.padding;
-                ref.current.style.fontWeight = `${style.fontWeight}`;
-                ref.current.style.margin = style.margin;
-                ref.current.style.fontSize = style.fontSize;
-                ref.current.style.color = style.color;
-                ref.current.style.background = style.background;
-                ref.current.style.display = 'flex';
-                ref.current.style.position = 'static';
-                ref.current.style.opacity = '1';
-                ref.current.style.visibility = 'visible';
-            }
-        };
-        const timerId = setInterval(checkWatermark, 5000);
-        return () => clearTimeout(timerId);
-    }, []);
-    return (React.createElement(rebass_1.Flex, { style: style, ref: ref },
-        React.createElement(Logo_1.Logo, { style: { marginRight: 10 } }),
-        React.createElement("div", null, props.children)));
-};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.LicenseWatermark=void 0;const e=require("tslib"),t=e.__importStar(require("react")),r=require("../../components/Logo"),o=require("rebass"),n={border:"1px solid var(--ab-color-error)",padding:"5px",fontWeight:600,margin:"5px",fontSize:"14px",alignItems:"center",color:"var(--ab-color-text-on-defaultbackground)",background:"var(--ab-color-defaultbackground)"},i=e=>{const t=[["display","none"],["opacity","0"],["position","absolute"],["position","fixed"],["position","relative"],["visibility","hidden"]];for(const[r,o]of t)if(e.style[r]===o)return!1;return!0};exports.LicenseWatermark=e=>{const l=t.useRef(null);return t.useEffect((()=>{const e=setInterval((()=>{var e,t;(null===(e=l.current)||void 0===e?void 0:e.isConnected)||alert("It is not allowed to remove the Adaptable watermark."),i(l.current)||alert("It is not allowed to modify the Adaptable watermark."),(null===(t=null==l?void 0:l.current)||void 0===t?void 0:t.style)&&(l.current.style.border=n.border,l.current.style.padding=n.padding,l.current.style.fontWeight=`${n.fontWeight}`,l.current.style.margin=n.margin,l.current.style.fontSize=n.fontSize,l.current.style.color=n.color,l.current.style.background=n.background,l.current.style.display="flex",l.current.style.position="static",l.current.style.opacity="1",l.current.style.visibility="visible")}),5e3);return()=>clearTimeout(e)}),[]),t.createElement(o.Flex,{style:n,ref:l},t.createElement(r.Logo,{style:{marginRight:10}}),t.createElement("div",null,e.children))};

package/src/agGrid/Adaptable.d.ts

@@ -231,6 +231,7 @@ export declare class Adaptable implements IAdaptable {
     getGroupedColDefs(): ColDef[];
     getColumnDefsWithCorrectVisibility: () => ColDef[];
     getFirstRowNode(): RowNode;
+    getFirstDisplayedRowNode(): RowNode;
     destroy(config?: {
         unmount: boolean;
         destroyApi?: boolean;
@@ -312,6 +313,7 @@ export declare class Adaptable implements IAdaptable {
     deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
     getFirstGroupedColumn(): AdaptableColumn | undefined;
     private checkColumnsDataTypeSet;
+    private updateColumnDataTypeIfRowDataIsEmpty;
     private runAdaptableComparerFunction;
     isGridSelectable(): boolean;
     isGridGroupable(): boolean;

package/src/agGrid/Adaptable.js

@@ -2217,11 +2217,16 @@ class Adaptable {
             if (!foundNode) {
                 if (!node.group) {
                     rowNode = node;
+                    foundNode = true;
                 }
             }
         });
         return rowNode;
     }
+    getFirstDisplayedRowNode() {
+        const firstDisplayedRowIndex = this.gridOptions.api.getFirstDisplayedRow();
+        return this.gridOptions.api.getDisplayedRowAtIndex(firstDisplayedRowIndex);
+    }
     destroy(config) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         if (this.gridOptions && this.gridOptions.api) {
@@ -2892,7 +2897,7 @@ class Adaptable {
             const formatColumn = this.api.formatColumnApi.getFormatColumnForColumn(abColumn);
             if (formatColumn && !(formatColumn === null || formatColumn === void 0 ? void 0 : formatColumn.IsSuspended) && formatColumn.ColumnStyle) {
                 if (formatColumn.ColumnStyle.PercentBarStyle) {
-                    return this.agGridHelper.createNumericStyleRendererFunc(formatColumn);
+                    return this.agGridHelper.createPercentBarRendererComp(formatColumn);
                 }
                 if (formatColumn.ColumnStyle.CheckBoxStyle) {
                     return this.agGridHelper.createCheckboxRendererComp(abColumn.columnId, abColumn.readOnly);
@@ -3556,6 +3561,7 @@ class Adaptable {
             this.addSyntheticPrimaryKey(dataSource);
         }
         this.gridOptions.api.setRowData(dataSource);
+        this.updateColumnDataTypeIfRowDataIsEmpty();
     }
     getGridData() {
         var _a;
@@ -3621,11 +3627,13 @@ class Adaptable {
                         dataUpdateConfig.callback(transaction);
                     }
                     resolve(transaction === null || transaction === void 0 ? void 0 : transaction.add);
+                    this.updateColumnDataTypeIfRowDataIsEmpty();
                 });
             });
         }
         else {
             const transaction = this.gridOptions.api.applyTransaction(newData);
+            this.updateColumnDataTypeIfRowDataIsEmpty();
             return Promise.resolve(transaction === null || transaction === void 0 ? void 0 : transaction.add);
         }
     }
@@ -3657,11 +3665,24 @@ class Adaptable {
     }
     checkColumnsDataTypeSet() {
         // check that we have no unknown columns - if we do then ok
-        const firstCol = this.api.columnApi.getColumns()[0];
-        if (firstCol && firstCol.dataType == Enums_1.DataType.Unknown) {
+        const colDefs = this.api.columnApi.getColumns();
+        if (colDefs.some((colDef) => colDef.dataType === Enums_1.DataType.Unknown)) {
             this.updateColumnsIntoStore();
         }
     }
+    updateColumnDataTypeIfRowDataIsEmpty() {
+        var _a, _b;
+        // gridOptions?.rowData is not updated when setting data via the api
+        if (!((_b = (_a = this.gridOptions) === null || _a === void 0 ? void 0 : _a.rowData) === null || _b === void 0 ? void 0 : _b.length)) {
+            // the columns dataType is based on the rawData, when type is not set on the column
+            // when data is loaded async, the dataType initially is dataType=unknown
+            // to fix this, we need to update the columnDefs when we data is loaded
+            this.checkColumnsDataTypeSet();
+            // this influences the floating filter
+            // need to trigger header redraw, if not, the columnDef update is not picked-up
+            this.redrawHeader();
+        }
+    }
     runAdaptableComparerFunction(columnId, columnValues) {
         let adaptable = this;
         return function compareItemsOfCustomSort(valueA, valueB, nodeA, nodeB) {

package/src/agGrid/PercentBarRenderer.d.ts

@@ -0,0 +1,3 @@
+import { FormatColumn } from '../PredefinedConfig/FormatColumnState';
+import { AdaptableApi } from '../Api/AdaptableApi';
+export declare const getPercentBarRendererForColumn: (formatColumn: FormatColumn, api: AdaptableApi) => any;

package/src/agGrid/PercentBarRenderer.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPercentBarRendererForColumn = void 0;
+const tslib_1 = require("tslib");
+const Helper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/Helper"));
+const clamp_1 = tslib_1.__importDefault(require("lodash/clamp"));
+const FormatHelper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/FormatHelper"));
+exports.getPercentBarRendererForColumn = (formatColumn, api) => {
+    var _a;
+    if (!((_a = formatColumn === null || formatColumn === void 0 ? void 0 : formatColumn.ColumnStyle) === null || _a === void 0 ? void 0 : _a.PercentBarStyle)) {
+        return;
+    }
+    return class PercentBarRenderer {
+        init(params) {
+            if (!formatColumn.IncludeGroupedRows && api.gridApi.isGroupRowNode(params.node)) {
+                return;
+            }
+            const min = api.formatColumnApi.getNumericStyleMinValue(formatColumn.ColumnStyle, params.node, params.value);
+            const max = api.formatColumnApi.getNumericStyleMaxValue(formatColumn.ColumnStyle, params.node, params.value);
+            let value = params.value;
+            if (Helper_1.default.objectNotExists(value)) {
+                value = 0;
+            }
+            const clampedValue = clamp_1.default(value, min, max);
+            const percentageValue = ((clampedValue - min) / (max - min)) * 100;
+            let cellBackColor;
+            const percentBarStyle = formatColumn.ColumnStyle.PercentBarStyle;
+            if (percentBarStyle.ColumnComparison) {
+                cellBackColor = percentBarStyle.ColumnComparison.Color;
+            }
+            else {
+                const matchingRange = percentBarStyle.CellRanges.find((r) => r.Min <= clampedValue && r.Max >= clampedValue);
+                if (matchingRange) {
+                    cellBackColor = matchingRange.Color;
+                }
+            }
+            if (cellBackColor) {
+                this.eGui = document.createElement('div');
+                this.eGui.className = 'ab-PercentBar__wrapper';
+                this.eGui.style.height = percentBarStyle.CellText ? '80%' : '100%';
+                this.eGui.style.display = 'flex';
+                this.eGui.style.flexDirection = 'column';
+                this.eGui.style.justifyContent = 'center';
+                const barEl = document.createElement('div');
+                barEl.className = 'ab-PercentBar__bar';
+                barEl.style.background = percentBarStyle.BackColor;
+                barEl.style.flex = '1';
+                const barInsideEl = document.createElement('div');
+                barInsideEl.className = 'ab-PercentBar__barInside';
+                barInsideEl.style.background = cellBackColor;
+                barInsideEl.style.height = '100%';
+                barInsideEl.style.width = `${percentageValue.toFixed(0)}%`;
+                barEl.append(barInsideEl);
+                this.eGui.append(barEl);
+                if (percentBarStyle.CellText) {
+                    const textEl = document.createElement('div');
+                    textEl.className = 'ab-PercentBar__text';
+                    textEl.style.lineHeight = '1.2';
+                    if (percentBarStyle.CellText.includes('CellValue')) {
+                        if (formatColumn.DisplayFormat) {
+                            const options = formatColumn.DisplayFormat
+                                .Options;
+                            if (options) {
+                                value = FormatHelper_1.default.NumberFormatter(params.value, options);
+                            }
+                        }
+                        textEl.innerText = value;
+                    }
+                    if (percentBarStyle.CellText.includes('PercentageValue')) {
+                        textEl.innerText += ' ' + `(${percentageValue.toFixed(0)}%)`;
+                    }
+                    this.eGui.append(textEl);
+                }
+            }
+        }
+        getGui() {
+            return this.eGui;
+        }
+        refresh(params) {
+            return true;
+        }
+    };
+};

package/src/agGrid/agGridHelper.d.ts

@@ -22,7 +22,7 @@ export declare class agGridHelper {
     setUpModules(): Map<AdaptableModule, IModule>;
     TrySetUpNodeIds(): boolean;
     createCheckboxRendererComp(columnId: string, isColumnReadOnly: boolean): ICellRendererFunc | undefined;
-    createNumericStyleRendererFunc(formatColumn: FormatColumn): ICellRendererFunc;
+    createPercentBarRendererComp(formatColumn: FormatColumn): ICellRendererFunc;
     getCleanValue(value: string): string | undefined;
     getRenderedValue(colDef: ColDef, valueToRender: any): any;
     createAdaptableColumnFromAgGridColumn(agGridColumn: Column, colsToGroups: Record<string, AdaptableColumnGroup>): AdaptableColumn;

package/src/agGrid/agGridHelper.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.agGridHelper = void 0;
 const tslib_1 = require("tslib");
-const clamp_1 = tslib_1.__importDefault(require("lodash/clamp"));
 const Enums_1 = require("../PredefinedConfig/Common/Enums");
 const Uuid_1 = require("../PredefinedConfig/Uuid");
 const AlertModule_1 = require("../Strategy/AlertModule");
@@ -33,14 +32,13 @@ const ToolPanelModule_1 = require("../Strategy/ToolPanelModule");
 const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
 const ArrayExtensions_1 = require("../Utilities/Extensions/ArrayExtensions");
 const StringExtensions_1 = require("../Utilities/Extensions/StringExtensions");
-const Helper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/Helper"));
 const LoggingHelper_1 = require("../Utilities/Helpers/LoggingHelper");
-const FormatHelper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/FormatHelper"));
 const CheckboxRenderer_1 = require("./CheckboxRenderer");
 const DataChangeHistoryModule_1 = require("../Strategy/DataChangeHistoryModule");
 const FlashingCellModule_1 = require("../Strategy/FlashingCellModule");
 const SettingsPanelModule_1 = require("../Strategy/SettingsPanelModule");
 const ChartingModule_1 = require("../Strategy/ChartingModule");
+const PercentBarRenderer_1 = require("./PercentBarRenderer");
 const tinycolor = require('tinycolor2');
 /**
  * Adaptable AG Grid implementation is getting really big and unwieldy
@@ -121,77 +119,8 @@ class agGridHelper {
     createCheckboxRendererComp(columnId, isColumnReadOnly) {
         return CheckboxRenderer_1.getCheckboxRendererForColumn(columnId, isColumnReadOnly, this.adaptable.api);
     }
-    createNumericStyleRendererFunc(formatColumn) {
-        const numericStyle = formatColumn.ColumnStyle;
-        if (!numericStyle || numericStyle.CheckBoxStyle) {
-            return;
-        }
-        const cellRendererFunc = (params) => {
-            if (!formatColumn.IncludeGroupedRows && this.adaptable.isGroupRowNode(params.node)) {
-                return;
-            }
-            const min = this.adaptable.api.formatColumnApi.getNumericStyleMinValue(numericStyle, params.node, params.value);
-            const max = this.adaptable.api.formatColumnApi.getNumericStyleMaxValue(numericStyle, params.node, params.value);
-            let value = params.value;
-            if (Helper_1.default.objectNotExists(value)) {
-                value = 0;
-            }
-            const percentBarStyle = numericStyle.PercentBarStyle;
-            if (percentBarStyle) {
-                const clampedValue = clamp_1.default(value, min, max);
-                const percentageValue = ((clampedValue - min) / (max - min)) * 100;
-                let cellBackColor;
-                if (percentBarStyle.ColumnComparison) {
-                    cellBackColor = percentBarStyle.ColumnComparison.Color;
-                }
-                else {
-                    const matchingRange = percentBarStyle.CellRanges.find((r) => r.Min <= clampedValue && r.Max >= clampedValue);
-                    if (matchingRange) {
-                        cellBackColor = matchingRange.Color;
-                    }
-                }
-                if (cellBackColor) {
-                    const wrapperEl = document.createElement('div');
-                    wrapperEl.className = 'ab-PercentBar__wrapper';
-                    wrapperEl.style.height = percentBarStyle.CellText ? '80%' : '100%';
-                    wrapperEl.style.display = 'flex';
-                    wrapperEl.style.flexDirection = 'column';
-                    wrapperEl.style.justifyContent = 'center';
-                    const barEl = document.createElement('div');
-                    barEl.className = 'ab-PercentBar__bar';
-                    barEl.style.background = percentBarStyle.BackColor;
-                    barEl.style.flex = '1';
-                    const barInsideEl = document.createElement('div');
-                    barInsideEl.className = 'ab-PercentBar__barInside';
-                    barInsideEl.style.background = cellBackColor;
-                    barInsideEl.style.height = '100%';
-                    barInsideEl.style.width = `${percentageValue.toFixed(0)}%`;
-                    barEl.append(barInsideEl);
-                    wrapperEl.append(barEl);
-                    if (percentBarStyle.CellText) {
-                        const textEl = document.createElement('div');
-                        textEl.className = 'ab-PercentBar__text';
-                        textEl.style.lineHeight = '1.2';
-                        if (percentBarStyle.CellText.includes('CellValue')) {
-                            if (formatColumn.DisplayFormat) {
-                                const options = formatColumn.DisplayFormat
-                                    .Options;
-                                if (options) {
-                                    value = FormatHelper_1.default.NumberFormatter(params.value, options);
-                                }
-                            }
-                            textEl.innerText = value;
-                        }
-                        if (percentBarStyle.CellText.includes('PercentageValue')) {
-                            textEl.innerText += ' ' + `(${percentageValue.toFixed(0)}%)`;
-                        }
-                        wrapperEl.append(textEl);
-                    }
-                    return wrapperEl;
-                }
-            }
-        };
-        return cellRendererFunc;
+    createPercentBarRendererComp(formatColumn) {
+        return PercentBarRenderer_1.getPercentBarRendererForColumn(formatColumn, this.adaptable.api);
     }
     getCleanValue(value) {
         if (value == null || value == 'null' || value == undefined || value == 'undefined') {

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

@@ -497,6 +497,11 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         })[];
     };
+    AdaptableQuery: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     AdaptableReadyInfo: {
         name: string;
         kind: string;
@@ -1998,15 +2003,6 @@ export declare const ADAPTABLE_METAMODEL: {
             defaultValue: string;
             gridInfo?: undefined;
             reference?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            isOptional: boolean;
-            gridInfo?: undefined;
-            defaultValue?: undefined;
-            reference?: undefined;
         } | {
             name: string;
             kind: string;

package/src/metamodel/adaptable.metamodel.js

@@ -1328,6 +1328,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "AdaptableQuery": {
+        "name": "AdaptableQuery",
+        "kind": "TypeAlias",
+        "description": "An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"
+    },
     "AdaptableReadyInfo": {
         "name": "AdaptableReadyInfo",
         "kind": "Interface",
@@ -2433,6 +2438,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves currently selected Cell Summary Operation",
                 "uiLabel": "Get Current Cell Summary Operation"
             },
+            {
+                "name": "setCurrentCellSummaryOperation",
+                "kind": "function",
+                "description": "Sets the currently selected Cell Summary Operation",
+                "uiLabel": "Set Current Cell Summary Operation"
+            },
             {
                 "name": "showCellSummaryPopup",
                 "kind": "function",
@@ -5685,9 +5696,11 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "quickFilterHeight",
                 "kind": "number",
-                "description": "TODO: add comment",
+                "description": "Sets a height for Quick Filter Bar (if not provided AG Grid's default is used)",
                 "uiLabel": "Quick Filter Height",
-                "isOptional": true
+                "isOptional": true,
+                "gridInfo": "item",
+                "defaultValue": "null"
             },
             {
                 "name": "quickFilterTrigger",
@@ -7033,6 +7046,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Retrieves filtered data from the grid",
                 "uiLabel": "Get Filtered Data"
             },
+            {
+                "name": "getFirstDisplayedRowNode",
+                "kind": "function",
+                "description": "Retrieves the first Displayed Row Node in AdapTable",
+                "uiLabel": "Get First Displayed Row Node"
+            },
             {
                 "name": "getFirstRowNode",
                 "kind": "function",
@@ -7373,7 +7392,7 @@ exports.ADAPTABLE_METAMODEL = {
             {
                 "name": "column",
                 "kind": "REFERENCE",
-                "description": "Column in which cell is situtated",
+                "description": "Column in which cell is situated",
                 "uiLabel": "Column",
                 "reference": "AdaptableColumn"
             },

package/src/types.d.ts

@@ -104,6 +104,7 @@ export type { AdaptableFormat, DateFormatterOptions, NumberFormatterOptions, Str
 export type { AdaptableMessageType } from './PredefinedConfig/Common/AdaptableMessageType';
 export type { AdaptableObject } from './PredefinedConfig/Common/AdaptableObject';
 export type { SuspendableObject } from './PredefinedConfig/Common/SuspendableObject';
+export type { AdaptableQuery, AdaptableAggregatedBooleanQuery, AdaptableAggregatedScalarQuery, AdaptableBooleanQuery, AdaptableObservableQuery, AdaptableScalarQuery, } from './PredefinedConfig/Common/AdaptableQuery';
 export type { AdaptablePredicate, AdaptablePredicateDef, ModuleScope, PredicateDefHandlerParams, PredicateDefInput, PredicateDefToStringParams, } from './PredefinedConfig/Common/AdaptablePredicate';
 export type { FDC3Context, InstrumentContext } from './PredefinedConfig/Common/FDC3Context';
 export type { AdaptableScope } from './PredefinedConfig/Common/AdaptableScope';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.0.3";
+declare const _default: "11.0.6";
 export default _default;

package/version.js

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