@adaptabletools/adaptable 18.1.7 → 18.1.9

package/src/Utilities/Helpers/Helper.d.ts

@@ -18,6 +18,9 @@ export declare function meanNumberArray(numericValues: number[]): number;
 export declare function medianNumberArray(numericValues: number[]): number;
 export declare function modeNumberArray(numbers: number[]): number;
 export declare function clamp(value: any, boundOne: number, boundTwo: number): number;
+export declare function extractColsFromText(text: string): string[];
+export declare function replaceAll(text: string, toReplace: string, replaceWith: string): string;
+export declare function extractContextKeysFromText(text: string): string[];
 export declare const Helper: {
     objectExists: typeof objectExists;
     objectNotExists: typeof objectNotExists;
@@ -38,5 +41,8 @@ export declare const Helper: {
     medianNumberArray: typeof medianNumberArray;
     modeNumberArray: typeof modeNumberArray;
     clamp: typeof clamp;
+    extractColsFromText: typeof extractColsFromText;
+    replaceAll: typeof replaceAll;
+    extractContextKeysFromText: typeof extractContextKeysFromText;
 };
 export default Helper;

package/src/Utilities/Helpers/Helper.js

@@ -227,6 +227,34 @@ export function clamp(value, boundOne, boundTwo) {
     }
     return value;
 }
+export function extractColsFromText(text) {
+    // rowData.columnName => columnName
+    const regex = /\[rowData\.(.*?)\]/g;
+    let m;
+    const cols = [];
+    while ((m = regex.exec(text)) !== null) {
+        cols.push(m[1]);
+    }
+    return cols;
+}
+export function replaceAll(text, toReplace, replaceWith) {
+    if (!text) {
+        return text;
+    }
+    // fails for []
+    toReplace = toReplace.replace('[', '\\[').replace(']', '\\]');
+    return text.replace(new RegExp(toReplace, 'g'), replaceWith);
+}
+export function extractContextKeysFromText(text) {
+    // context.columnName => columnName
+    const regex = /\[context\.(.*?)\]/g;
+    let m;
+    const contextKeys = [];
+    while ((m = regex.exec(text)) !== null) {
+        contextKeys.push(m[1]);
+    }
+    return contextKeys;
+}
 export const Helper = {
     objectExists,
     objectNotExists,
@@ -247,5 +275,8 @@ export const Helper = {
     medianNumberArray,
     modeNumberArray,
     clamp,
+    extractColsFromText,
+    replaceAll,
+    extractContextKeysFromText,
 };
 export default Helper;

package/src/View/Alert/Wizard/AlertMessageWizardSection.js

@@ -20,6 +20,7 @@ export const AlertMessageWizardSection = (props) => {
     const messageType = data.MessageType;
     const messageText = api.alertApi.internalApi.getAlertDescriptionForDataChange(data);
     const messageHeader = data.MessageHeader;
+    const showDocumentationLinks = api.internalApi.isDocumentationLinksDisplayed();
     const onMessageTextChange = (e) => {
         const { value } = e.target;
         props.onChange(Object.assign(Object.assign({}, data), { MessageText: value }));
@@ -42,7 +43,7 @@ export const AlertMessageWizardSection = (props) => {
         React.createElement(Tabs, { "data-name": "message-text", mt: 2, mb: 3, autoFocus: false },
             React.createElement(Tabs.Tab, null, "Message Text"),
             React.createElement(Tabs.Content, null,
-                React.createElement(Text, { fontSize: 2, mt: 3, mb: 2 }, "The text to display as the Alert Message (leave blank to show automated Message based on Alert Type)"),
+                React.createElement(Text, { fontSize: 2, mt: 3, mb: 2 }, "Text to display as the Alert Message (leave blank to show automated Message based on Alert Type)"),
                 ' ',
                 React.createElement(FormLayout, null,
                     React.createElement(FormRow, { label: "Header" },
@@ -51,10 +52,10 @@ export const AlertMessageWizardSection = (props) => {
                             onChange: (e) => onMessageHeaderChange(e) })),
                     React.createElement(FormRow, { label: "Message" },
                         React.createElement(Textarea, { minWidth: 300, rows: 3, marginTop: 2, type: 'text', autoFocus: false, value: messageText !== null && messageText !== void 0 ? messageText : '', onChange: (e) => onMessageTextChange(e) }))),
-                React.createElement(HelpBlock, { "data-name": "alert-message-documentation", mt: 3, mb: 2, style: {
+                showDocumentationLinks && (React.createElement(HelpBlock, { "data-name": "alert-message-documentation", mt: 3, mb: 2, style: {
                         fontSize: 'var(--ab-font-size-3)',
                         padding: 0,
                     } },
                     React.createElement(ButtonInfo, { mr: 2, onClick: () => window.open(AlertMessageDocsLink, '_blank') }),
-                    "See Alert Message documentation for more details and examples")))));
+                    "See how to create dynamic Alert Messages using placeholders"))))));
 };

package/src/View/FormatColumn/Wizard/FormatColumnFormatWizardSection.js

@@ -17,6 +17,9 @@ import { useAdaptable } from '../../AdaptableContext';
 import FormatHelper from '../../../Utilities/Helpers/FormatHelper';
 import { Toggle, ToggleGroup } from '../../../components/Toggle';
 import { DEFAULT_DOUBLE_DISPLAY_VALUE, DEFAULT_STRING_DISPLAY_VALUE, } from '../../../Utilities/Constants/GeneralConstants';
+import Textarea from '../../../components/Textarea';
+import { ButtonInfo } from '../../Components/Buttons/ButtonInfo';
+import { FormatColumnPlaceholderDocsLink } from '../../../Utilities/Constants/DocumentationLinkConstants';
 const DOLLAR_OPTIONS = {
     FractionDigits: 2,
     FractionSeparator: '.',
@@ -201,8 +204,8 @@ const renderDateFormat = (data, _onChange, setFormatOption, scopedCustomFormatte
                         },
                     ] })))))));
 };
-const renderNumberFormat = (data, onChange, setFormatOption, scopedCustomFormatters, formatColumnApi) => {
-    var _a, _b, _c, _d, _e;
+const renderNumberFormat = (data, onChange, setFormatOption, scopedCustomFormatters, api) => {
+    var _a, _b, _c, _d, _e, _f;
     if (data.DisplayFormat.Formatter !== 'NumberFormatter') {
         return null;
     }
@@ -254,6 +257,7 @@ const renderNumberFormat = (data, onChange, setFormatOption, scopedCustomFormatt
         data.DisplayFormat.Options.Multiplier === MILLION_OPTIONS.Multiplier; //isEqual(data.DisplayFormat.Options, MILLION_OPTIONS);
     const IS_DOLLAR = data.DisplayFormat.Options.Prefix === '$'; //isEqual(data.DisplayFormat.Options, DOLLAR_OPTIONS);
     const IS_STERLING = data.DisplayFormat.Options.Prefix === '£'; //isEqual(data.DisplayFormat, STERLING_OPTIONS);
+    const showDocumentationLinks = api.internalApi.isDocumentationLinksDisplayed();
     return (React.createElement(Box, { "data-name": 'format-column-display-format', padding: 2 },
         React.createElement(Tabs, null,
             React.createElement(Tabs.Tab, null, "Format"),
@@ -261,7 +265,8 @@ const renderNumberFormat = (data, onChange, setFormatOption, scopedCustomFormatt
                 React.createElement(Flex, { flexDirection: "row" },
                     React.createElement(FormLayout, { mr: 3 },
                         React.createElement(FormRow, { label: "Fraction Separator" },
-                            React.createElement(Input, { "data-name": "fraction-separator", value: (_a = data.DisplayFormat.Options.FractionSeparator) !== null && _a !== void 0 ? _a : '', onChange: (e) => setFormatOption('FractionSeparator', e.currentTarget.value) })),
+                            React.createElement(Input, { "data-name": "fraction-separator", value: (_a = data.DisplayFormat.Options.FractionSeparator) !== null && _a !== void 0 ? _a : '', onChange: (e) => setFormatOption('FractionSeparator', e.currentTarget.value) }),
+                            ' '),
                         React.createElement(FormRow, { label: "Integer Separator" },
                             React.createElement(Input, { "data-name": "integer-separator", value: (_b = data.DisplayFormat.Options.IntegerSeparator) !== null && _b !== void 0 ? _b : '', onChange: (e) => setFormatOption('IntegerSeparator', e.currentTarget.value) })),
                         React.createElement(FormRow, { label: "Prefix" },
@@ -291,9 +296,6 @@ const renderNumberFormat = (data, onChange, setFormatOption, scopedCustomFormatt
                         React.createElement(FormRow, { label: "Multiplier" },
                             React.createElement(Input, { "data-name": "multiplier", type: "number", value: data.DisplayFormat.Options.Multiplier, onChange: (e) => setFormatOption('Multiplier', Number(e.currentTarget.value)) })),
                         ' ',
-                        React.createElement(FormRow, { label: "Content" },
-                            React.createElement(Input, { "data-name": "content", value: (_e = data.DisplayFormat.Options.Content) !== null && _e !== void 0 ? _e : '', onChange: (e) => setFormatOption('Content', e.currentTarget.value) })),
-                        ' ',
                         React.createElement(FormRow, { label: "Parentheses" },
                             React.createElement(CheckBox, { "data-name": "parentheses-checkbox", checked: data.DisplayFormat.Options.Parentheses, onChange: (checked) => setFormatOption('Parentheses', checked) })),
                         React.createElement(FormRow, { label: "Floor" },
@@ -317,6 +319,20 @@ const renderNumberFormat = (data, onChange, setFormatOption, scopedCustomFormatt
                             React.createElement(Radio, { "data-name": "preset-million", marginLeft: 3, checked: IS_MILLION, onChange: () => setDivideMillionPreset() }, "M (Million)"),
                             React.createElement(Radio, { "data-name": "preset-dollar", marginLeft: 3, checked: IS_DOLLAR, onChange: () => setDollarPreset() }, "Dollar"),
                             React.createElement(Radio, { "data-name": "preset-sterling", marginLeft: 3, checked: IS_STERLING, onChange: () => setSterlingPreset() }, "Sterling")))))),
+        React.createElement(Tabs, { marginTop: 2, autoFocus: false, keyboardNavigation: false },
+            React.createElement(Tabs.Tab, null, "Dynamic Content"),
+            React.createElement(Tabs.Content, null,
+                React.createElement(Text, { padding: 2, fontSize: 2 }, "Provide dynamic content through the use of Placeholders"),
+                React.createElement(FormLayout, { margin: 2 },
+                    React.createElement(FormRow, { label: "" },
+                        React.createElement(Textarea, { minWidth: 300, rows: 3, placeholder: "", marginTop: 2, type: 'text', autoFocus: false, value: (_f = (_e = data.DisplayFormat.Options.Content) === null || _e === void 0 ? void 0 : _e.toString()) !== null && _f !== void 0 ? _f : '', onChange: (e) => setFormatOption('Content', e.currentTarget.value) }),
+                        showDocumentationLinks && (React.createElement(HelpBlock, { "data-name": "query-documentation", mt: 3, mb: 2, style: {
+                                fontSize: 'var(--ab-font-size-3)',
+                                padding: 0,
+                            } },
+                            React.createElement(ButtonInfo, { mr: 2, onClick: () => window.open(FormatColumnPlaceholderDocsLink, '_blank') }),
+                            "Learn more about using placeholders"))),
+                    ' '))),
         React.createElement(Tabs, { marginTop: 2, autoFocus: false, keyboardNavigation: false },
             React.createElement(Tabs.Tab, null, "Examples"),
             React.createElement(Tabs.Content, null,
@@ -346,11 +362,12 @@ const renderNumberFormat = (data, onChange, setFormatOption, scopedCustomFormatt
                         },
                     ] })))));
 };
-const renderStringFormat = (data, _onChange, setFormatOption, scopedCustomFormatters, formatColumnApi) => {
+const renderStringFormat = (data, _onChange, setFormatOption, scopedCustomFormatters, api) => {
     var _a, _b, _c;
     if (data.DisplayFormat.Formatter !== 'StringFormatter') {
         return null;
     }
+    const showDocumentationLinks = api.internalApi.isDocumentationLinksDisplayed();
     return (React.createElement(Box, { "data-name": 'format-column-display-format', padding: 2 },
         React.createElement(Tabs, null,
             React.createElement(Tabs.Tab, null, "Format"),
@@ -369,7 +386,13 @@ const renderStringFormat = (data, _onChange, setFormatOption, scopedCustomFormat
                         React.createElement(FormRow, { label: "Suffix" },
                             React.createElement(Input, { "data-name": "suffix", value: (_b = data.DisplayFormat.Options.Suffix) !== null && _b !== void 0 ? _b : '', onChange: (e) => setFormatOption('Suffix', e.currentTarget.value) })),
                         React.createElement(FormRow, { label: "Content" },
-                            React.createElement(Input, { "data-name": "content", value: (_c = data.DisplayFormat.Options.Content) !== null && _c !== void 0 ? _c : '', onChange: (e) => setFormatOption('Content', e.currentTarget.value) })),
+                            React.createElement(Textarea, { minWidth: 300, rows: 3, placeholder: "", marginTop: 2, type: 'text', autoFocus: false, value: (_c = data.DisplayFormat.Options.Content) !== null && _c !== void 0 ? _c : '', onChange: (e) => setFormatOption('Content', e.currentTarget.value) }),
+                            showDocumentationLinks && (React.createElement(HelpBlock, { "data-name": "query-documentation", mt: 3, mb: 2, style: {
+                                    fontSize: 'var(--ab-font-size-3)',
+                                    padding: 0,
+                                } },
+                                React.createElement(ButtonInfo, { mr: 2, onClick: () => window.open(FormatColumnPlaceholderDocsLink, '_blank') }),
+                                "See how to create dynamic Display Format using placeholders"))),
                         React.createElement(FormRow, { label: "Empty" },
                             React.createElement(CheckBox, { "data-name": "empty-checkbox", checked: data.DisplayFormat.Options.Empty, onChange: (checked) => setFormatOption('Empty', checked) })))))),
         scopedCustomFormatters.length > 0 && (React.createElement(Tabs, { marginTop: 2, keyboardNavigation: false },
@@ -412,13 +435,13 @@ export const FormatColumnFormatWizardSection = (props) => {
     const Type = data.DisplayFormat && data.DisplayFormat.Formatter;
     const customScopedFormatters = customDisplayFormatters.filter((displayFormatter) => adaptable.api.columnScopeApi.isScopeInScope(data.Scope, displayFormatter.scope));
     if (Type === 'NumberFormatter') {
-        return renderNumberFormat(data, update, setFormatOption, customScopedFormatters, formatColumnApi);
+        return renderNumberFormat(data, update, setFormatOption, customScopedFormatters, adaptable.api);
     }
     if (Type === 'DateFormatter') {
         return renderDateFormat(data, update, setFormatOption, customScopedFormatters);
     }
     if (Type === 'StringFormatter') {
-        return renderStringFormat(data, update, setFormatOption, customScopedFormatters, formatColumnApi);
+        return renderStringFormat(data, update, setFormatOption, customScopedFormatters, adaptable.api);
     }
     return (React.createElement(HelpBlock, { margin: 3 },
         "Setting a Display Format is only possible if ",

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -243,7 +243,8 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private getDistinctGridCellsForColumn;
     private addDistinctColumnValue;
     private getUniqueGridCells;
-    getGridCellsForColumn(columnId: string, includeBlanks?: boolean, onlyVisibleRows?: boolean): GridCell[] | undefined;
+    getGridCellsForColumn(columnId: string, onlyVisibleRows?: boolean): GridCell[] | undefined;
+    getGridCellsForColumnTemp(columnId: string, onlyVisibleRows: boolean): GridCell[] | undefined;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): any[];
     getRowNodeByIndex(index: number): IRowNode;
     getAgGridStatusPanels(): import("@ag-grid-community/core").StatusPanelDef[];

package/src/agGrid/AdaptableAgGrid.js

@@ -276,6 +276,7 @@ export class AdaptableAgGrid {
         this.adaptableOptions = this.normalizeAdaptableOptions(this.adaptableOptions);
         const { showLoadingScreen, loadingScreenDelay, loadingScreenText, loadingScreenTitle } = this.adaptableOptions.userInterfaceOptions;
         if (showLoadingScreen) {
+            this.logger.info(`Show Loading Screen`);
             const portalElement = ensurePortalElement();
             if (portalElement) {
                 this.unmountLoadingScreen = this.renderReactRoot(createElement(AdaptableLoadingScreen, {
@@ -285,6 +286,9 @@ export class AdaptableAgGrid {
                     loadingScreenTitle,
                 }), portalElement);
             }
+            else {
+                this.logger.consoleError(`Adaptable failed to show the loading screen!`);
+            }
         }
         this.forPlugins((plugin) => plugin.afterInitOptions(this, this.adaptableOptions));
         this.api = new AdaptableApiImpl(this);
@@ -350,6 +354,7 @@ export class AdaptableAgGrid {
             this.logger.consoleError(`Adaptable failed to initialize AG Grid!`);
             return Promise.reject('Adaptable failed to initialize AG Grid!');
         }
+        this.logger.info(`Hide Loading Screen`);
         (_b = this.unmountLoadingScreen) === null || _b === void 0 ? void 0 : _b.call(this);
         perfInitAgGrid.end();
         // we need to intercept several AG Grid Api methods and trigger Adaptale state changes
@@ -2356,17 +2361,33 @@ export class AdaptableAgGrid {
         }
         return uniqueVals.slice(0, this.api.columnFilterApi.internalApi.getFilterValuesMaxNumberOfItems(column));
     }
-    getGridCellsForColumn(columnId, includeBlanks = false, onlyVisibleRows = false) {
+    getGridCellsForColumn(columnId, onlyVisibleRows = false) {
         let returnValues = [];
         const handler = (rowNode) => {
-            const gridCell = this.getGridCellFromRowNode(rowNode, columnId);
-            if (gridCell) {
-                if (gridCell.rawValue == undefined || gridCell.rawValue == null) {
-                    if (includeBlanks) {
-                        returnValues.push(gridCell);
-                    }
+            if (!this.isGroupRowNode(rowNode)) {
+                const gridCell = this.getGridCellFromRowNode(rowNode, columnId);
+                if (gridCell && gridCell.rawValue !== undefined && gridCell.rawValue !== null) {
+                    returnValues.push(gridCell);
                 }
-                else {
+            }
+        };
+        if (onlyVisibleRows) {
+            this.agGridAdapter.getAgGridApi().forEachNodeAfterFilter(handler);
+        }
+        else {
+            this.agGridAdapter.getAgGridApi().forEachNode(handler);
+        }
+        return returnValues;
+    }
+    // This horrible method is temporary until we can get rid of having predicates inside values which is coming soon
+    // We need it in case Blanks is requested
+    // once we go to the new multi predicate screen then we wont show blanks any more - which we should never have done
+    getGridCellsForColumnTemp(columnId, onlyVisibleRows) {
+        let returnValues = [];
+        const handler = (rowNode) => {
+            if (!this.isGroupRowNode(rowNode)) {
+                const gridCell = this.getGridCellFromRowNode(rowNode, columnId);
+                if (gridCell) {
                     returnValues.push(gridCell);
                 }
             }

package/src/agGrid/AgGridMenuAdapter.js

@@ -470,6 +470,20 @@ export class AgGridMenuAdapter {
                 ...gridInfoMenuItems,
             ],
         };
+        /*
+            const calculatedColumnMenuItem: AdaptableMenuItem = {
+              name: 'calculated-column-group',
+              label: 'Calculated Column',
+              module: 'CalculatedColumn',
+              isVisible: true,
+              icon: {
+                name: 'columns',
+              },
+              subItems: [
+                ...calculatedColumnMenuItems,
+              ],
+            };
+            */
         const columnMenuItem = {
             name: 'column-group',
             label: 'Column',
@@ -480,7 +494,6 @@ export class AgGridMenuAdapter {
             },
             subItems: [
                 ...columnActionGroup,
-                ...calculatedColumnMenuItems,
                 ...freeTextColumnMenuItems,
                 ...customSortMenuItems,
                 ...plusMinusMenuItems,
@@ -499,6 +512,7 @@ export class AgGridMenuAdapter {
             subItems: [...formatColumnMenuItems, ...styledColumnMenuItems, ...flashingCellMenuItems],
         };
         return this.removeConsecutiveSeparators([
+            ...calculatedColumnMenuItems,
             ...settingsPanelMenuItems,
             ...dashboardMenuItems,
             ...columnFilterGroup,

package/src/agGrid/defaultAdaptableOptions.js

@@ -294,6 +294,7 @@ const DefaultAdaptableOptions = {
         activeByDefault: false,
         showDataChange: undefined,
         changeHistoryButton: undefined,
+        showLastDataChangeOnly: true
     },
     settingsPanelOptions: {
         popupType: 'window',

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1720099744173 || Date.now(),
-    VERSION: "18.1.7" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1721129456634 || Date.now(),
+    VERSION: "18.1.9" || '--current-version--',
 };

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

@@ -2751,6 +2751,14 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo: string;
             defVal: string;
             noCode?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            gridInfo?: undefined;
+            noCode?: undefined;
+            defVal?: undefined;
         })[];
     };
     DataFormatDataType: {