@adaptabletools/adaptable 12.1.7 → 12.2.0-canary.0

package/src/components/ExpressionEditor/editorButtonsObservable.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.editorButtonsObservable = void 0;
+exports.editorButtonsObservable = [
+    {
+        functionName: 'ROW_CHANGE',
+        data: 'ROW_CHANGE()',
+        text: 'RowChange',
+    },
+    {
+        functionName: 'GRID_CHANGE',
+        data: 'GRID_CHANGE()',
+        text: 'GridChange',
+    },
+    {
+        functionName: 'COUNT',
+        data: 'COUNT()',
+        text: 'Count',
+    },
+    {
+        functionName: 'NONE',
+        data: 'NONE()',
+        text: 'None',
+    },
+    {
+        functionName: 'MIN',
+        data: 'MIN()',
+        text: 'Min',
+    },
+    {
+        functionName: 'MAX',
+        data: 'MAX()',
+        text: 'Max',
+    },
+    {
+        functionName: 'TIMEFRAME',
+        data: 'TIMEFRAME()',
+        text: 'Timeframe',
+    },
+];

package/src/components/ExpressionEditor/index.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { AdaptableApi, AdaptableColumn, AdaptableModule } from '../../types';
 import { NamedQuery } from '../../PredefinedConfig/QueryState';
-declare type ExpressionEditorType = 'boolean' | 'scalar' | 'observable' | 'aggregatedBoolean' | 'aggregatedScalar';
+declare type ExpressionEditorType = 'boolean' | 'scalar' | 'observable' | 'aggregatedBoolean' | 'aggregatedScalar' | 'cumulativeAggregatedScalar';
 interface ExpressionEditorProps {
     value: string;
     onChange: (value: string) => void;

package/src/components/ExpressionEditor/index.js

@@ -13,7 +13,7 @@ const EditorButton_1 = tslib_1.__importDefault(require("./EditorButton"));
 const AdaptableInput_1 = tslib_1.__importDefault(require("../../View/Components/AdaptableInput"));
 const Radio_1 = tslib_1.__importDefault(require("../Radio"));
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
-const EditorInputReactive_1 = tslib_1.__importDefault(require("./EditorInputReactive"));
+const EditorInputWithWhereClause_1 = tslib_1.__importDefault(require("./EditorInputWithWhereClause"));
 const EditorInput_1 = tslib_1.__importDefault(require("./EditorInput"));
 const EditorContext_1 = require("./EditorContext");
 const ExpressionFunctionDocumentation_1 = require("./ExpressionFunctionDocumentation");
@@ -24,6 +24,7 @@ const CodeBlock_1 = require("../CodeBlock");
 const NamedQueryContext_1 = require("./NamedQueryContext");
 const ModuleConstants_1 = require("../../Utilities/Constants/ModuleConstants");
 const DateHelper_1 = require("../../Utilities/Helpers/DateHelper");
+const AdaptableFormControlTextClear_1 = require("../../View/Components/Forms/AdaptableFormControlTextClear");
 function ExpressionEditor(props) {
     var _a;
     const { type, module } = props;
@@ -35,11 +36,11 @@ function ExpressionEditor(props) {
     const { namedQuery, setNamedQuery } = NamedQueryContext_1.useNamedQueryContext();
     const textAreaRef = react_1.useRef(null);
     const allowSaveNamedQuery = (_a = props.allowSaveNamedQuery) !== null && _a !== void 0 ? _a : type === 'boolean';
-    const editorInput = type === 'observable' || type === 'aggregatedBoolean' ? (React.createElement(EditorInputReactive_1.default, { type: type, module: module, value: props.value, onChange: (value) => {
+    const editorInput = type === 'observable' || type === 'aggregatedBoolean' ? (React.createElement(EditorInputWithWhereClause_1.default, { type: type, module: module, value: props.value, onChange: (value) => {
             setExpressionText(value);
             props.onChange(value);
         }, testData: data, api: props.api })) : (
-    // 'boolean','scalar' or 'aggregatedScalar'
+    // 'boolean','scalar' or 'aggregatedScalar'/'cumulativeAggregatedScalar'
     React.createElement(EditorInput_1.default, { type: type, module: module, value: props.value, onChange: (value) => {
             setExpressionText(value);
             props.onChange(value);
@@ -99,6 +100,7 @@ function ExpressionEditor(props) {
             ? new Date(colValue).toISOString().substr(0, 10)
             : '';
     };
+    const [searchInputValue, setSearchInputValue] = React.useState('');
     const dataTableEditor = (React.createElement(React.Fragment, null,
         React.createElement(rebass_1.Flex, { flexDirection: "column", alignItems: "start", style: { marginTop: 2 } },
             React.createElement(CheckBox_1.CheckBox, { checked: showColumnIds, onChange: (checked) => setShowColumnIds(checked), style: {
@@ -106,8 +108,17 @@ function ExpressionEditor(props) {
                     margin: 0,
                     paddingTop: 'var(--ab-space-1)',
                     paddingBottom: 'var(--ab-space-1)',
-                } }, 'Show Column IDs')),
-        React.createElement(FormLayout_1.default, { className: "ab-ExpressionEditor__columns", gridColumnGap: "var(--ab-space-1)", gridRowGap: "var(--ab-space-1)", sizes: ['auto', '100px'], style: { alignItems: 'stretch' } }, queryableColumns.map((column) => (React.createElement(FormLayout_1.FormRow, { key: column.columnId, label: React.createElement(EditorButton_1.default, { width: "100%", height: "100%", style: {
+                } }, 'Show Column IDs'),
+            React.createElement(AdaptableFormControlTextClear_1.AdaptableFormControlTextClear, { value: searchInputValue, OnTextChange: setSearchInputValue, placeholder: "Filter columns...", style: { flex: 1, marginBottom: 3 } })),
+        React.createElement(FormLayout_1.default, { className: "ab-ExpressionEditor__columns", gridColumnGap: "var(--ab-space-1)", gridRowGap: "var(--ab-space-1)", sizes: ['auto', '100px'], style: { alignItems: 'stretch' } }, queryableColumns
+            .filter((column) => {
+            if (!searchInputValue) {
+                return true;
+            }
+            return (column.columnId.includes(searchInputValue) ||
+                column.friendlyName.includes(searchInputValue));
+        })
+            .map((column) => (React.createElement(FormLayout_1.FormRow, { key: column.columnId, label: React.createElement(EditorButton_1.default, { width: "100%", height: "100%", style: {
                     background: 'var(--ab-color-primary)',
                     cursor: 'grab',
                     marginRight: 'var(--ab-space-1)',
@@ -115,20 +126,30 @@ function ExpressionEditor(props) {
                 React.createElement(rebass_1.Flex, { flexDirection: "column", alignItems: "start" }, showColumnIds ? `[${column.columnId}]` : column.friendlyName)) }, column.dataType === 'Number' ? (React.createElement(Input_1.default, { type: "number", "data-name": "column-input", "data-value": column.columnId, value: getColValue(column), onChange: (e) => setData(updateColValue(data, column, Number(e.target.value))), width: "100%", disabled: column.readOnly })) : column.dataType === 'String' ? (React.createElement(Input_1.default, { type: "text", "data-name": "column-input", "data-value": column.columnId, value: getColValue(column), onChange: (e) => setData(updateColValue(data, column, e.target.value)), width: "100%", disabled: column.readOnly })) : column.dataType === 'Date' ? (React.createElement(AdaptableInput_1.default, { type: "date", "data-name": "column-input", "data-value": column.columnId, value: getColDateValue(column), onChange: (e) => {
                 setData(updateColValue(data, column, new Date(e.target.value)));
             }, style: { width: '100%' }, disabled: column.readOnly })) : column.dataType === 'Boolean' ? (React.createElement(CheckBox_1.CheckBox, { "data-name": "column-input", "data-value": column.columnId, checked: getColValue(column), onChange: (checked) => setData(updateColValue(data, column, checked)), disabled: column.readOnly })) : null))))));
-    const namedQueries = (React.createElement("div", null, props.namedQueries.map((namedQuery) => (React.createElement(rebass_1.Flex, { key: namedQuery.Uuid, flexDirection: "column", alignItems: "start", style: {
-            padding: 3,
-            marginTop: 'var(--ab-space-2)',
-            marginBottom: 'var(--ab-space-2)',
-        }, backgroundColor: "primarylight" },
-        ' ',
-        React.createElement(EditorButton_1.default, { width: "100%", height: "100%", style: {
-                background: 'var(--ab-color-primary)',
-                cursor: 'grab',
-            }, data: `QUERY("${namedQuery.Name}")`, "data-name": "column", icon: "drag" },
-            React.createElement(rebass_1.Flex, { flexDirection: "column", alignItems: "start" }, namedQuery.Name)),
-        React.createElement(rebass_1.Flex, { alignItems: "start", style: {
-                padding: 5,
-            } }, namedQuery.BooleanExpression))))));
+    const namedQueries = (React.createElement(rebass_1.Flex, { flexDirection: "column", alignItems: "start", style: { marginTop: 2 } },
+        React.createElement(CheckBox_1.CheckBox, { checked: showColumnIds, onChange: (checked) => setShowColumnIds(checked), style: {
+                float: 'right',
+                margin: 0,
+                paddingTop: 'var(--ab-space-1)',
+                paddingBottom: 'var(--ab-space-1)',
+            } }, 'Show Column IDs'),
+        props.namedQueries.map((namedQuery) => (React.createElement(rebass_1.Flex, { key: namedQuery.Uuid, flexDirection: "column", alignItems: "start", style: {
+                padding: 3,
+                marginTop: 'var(--ab-space-2)',
+                marginBottom: 'var(--ab-space-2)',
+                width: '100%',
+            }, backgroundColor: "primarylight" },
+            ' ',
+            React.createElement(EditorButton_1.default, { width: "100%", height: "100%", style: {
+                    background: 'var(--ab-color-primary)',
+                    cursor: 'grab',
+                }, data: `QUERY("${namedQuery.Name}")`, "data-name": "column", icon: "drag" },
+                React.createElement(rebass_1.Flex, { flexDirection: "column", alignItems: "start" }, namedQuery.Name)),
+            React.createElement(rebass_1.Flex, { alignItems: "start", style: {
+                    padding: 5,
+                } }, showColumnIds
+                ? namedQuery.BooleanExpression
+                : props.api.queryLanguageApi.getAdaptableQueryExpressionWithColumnFriendlyNames(namedQuery)))))));
     const showDocumentationLinks = props.api.internalApi.isDocumentationLinksDisplayed();
     const queryDocumentationLink = queryDocumentationLinks[type];
     return (React.createElement(EditorContext_1.ExpressionEditorContext.Provider, { value: {
@@ -219,6 +240,15 @@ const renderQueryHints = (type) => {
         examples.push({
             code: 'AVG([stargazers_count], GROUP_BY([language]))',
             description: 'Average popularity (number of stars) of all the Github repositories, grouped by programming language',
+        }, {
+            code: 'MAX([PnL]), GROUP_BY([currency], [country])',
+            description: "The maximum 'PnL' value, grouped by currency and country",
+        });
+    }
+    if (type === 'cumulativeAggregatedScalar') {
+        examples.push({
+            code: 'CUMUL(AVG([stargazers_count], GROUP_BY([language])), OVER([TradeDate]))',
+            description: "The cumulative average popularity (number of stars) of all the Github repositories, grouped by programming language in the order given by the 'TradeDate' column",
         }, {
             code: 'CUMUL( SUM([PnL]), OVER([TradeDate]))',
             description: "The cumulative sum of all 'PnL' columns in the order given by the 'TradeDate' column",
@@ -247,4 +277,5 @@ const queryDocumentationLinks = {
     observable: DocumentationLinkConstants_1.ObservableQueryDocsLink,
     aggregatedBoolean: DocumentationLinkConstants_1.AggregatedBooleanQueryDocsLink,
     aggregatedScalar: DocumentationLinkConstants_1.AggregatedScalarQueryDocsLink,
+    cumulativeAggregatedScalar: DocumentationLinkConstants_1.CumulativeAggregatedScalarQueryDocsLink,
 };

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

@@ -245,6 +245,11 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         }[];
     };
+    AdaptableClearStateFunction: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     AdaptableColumn: {
         name: string;
         kind: string;
@@ -684,6 +689,15 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo?: undefined;
             defaultValue?: undefined;
             reference?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+            defaultValue: string;
+            gridInfo?: undefined;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;
@@ -733,6 +747,11 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         }[];
     };
+    AdaptableSaveStateFunction: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     AdaptableScope: {
         name: string;
         kind: string;
@@ -783,6 +802,24 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         })[];
     };
+    AdaptableStateFunctionConfig: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: ({
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+        })[];
+    };
     AdaptableStatusBar: {
         name: string;
         kind: string;
@@ -1205,6 +1242,13 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
             isOptional: boolean;
             reference?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+            isOptional?: undefined;
         })[];
     };
     CalculatedColumnApi: {
@@ -1227,7 +1271,7 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             description: string;
             uiLabel: string;
-            isOptional: boolean;
+            isOptional?: undefined;
             defaultValue?: undefined;
         } | {
             name: string;
@@ -2582,22 +2626,22 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             description: string;
             uiLabel: string;
-            isOptional: boolean;
+            isOptional?: undefined;
             reference?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
-            reference: string;
-            isOptional?: undefined;
+            isOptional: boolean;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
+            reference: string;
             isOptional?: undefined;
-            reference?: undefined;
         } | {
             name: string;
             kind: string;
@@ -2642,6 +2686,15 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
         properties: ({
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+            gridInfo?: undefined;
+            defaultValue?: undefined;
+            reference?: undefined;
+        } | {
             name: string;
             kind: string;
             description: string;
@@ -3475,12 +3528,21 @@ export declare const ADAPTABLE_METAMODEL: {
             description: string;
             uiLabel: string;
             isOptional: boolean;
+            reference: string;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
             isOptional?: undefined;
+            reference?: undefined;
         })[];
     };
     LayoutApi: {
@@ -3547,6 +3609,15 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo: string;
             defaultValue: string;
             reference?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+            gridInfo?: undefined;
+            defaultValue?: undefined;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;
@@ -4186,6 +4257,11 @@ export declare const ADAPTABLE_METAMODEL: {
             isOptional?: undefined;
         })[];
     };
+    ReportColumnScope: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     ReportContext: {
         name: string;
         kind: string;
@@ -4209,6 +4285,11 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
         }[];
     };
+    ReportRowScope: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     ReportSchedule: {
         name: string;
         kind: string;