@adaptabletools/adaptable-cjs 23.0.0-canary.5 → 23.0.0-canary.7

package/src/View/Layout/Wizard/sections/AggregationsSection.js

@@ -1,24 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AggregationsSection = exports.AggregationsSectionSummary = exports.isAggregationsSectionValid = void 0;
+exports.AggregationsSection = exports.AggregationsSectionSummary = exports.isAggregationsSectionValid = exports.GRAND_TOTAL_ROW_OPTIONS = exports.GRAND_TOTAL_ROW_DESCRIPTIONS = exports.GRAND_TOTAL_ROW_LABELS = void 0;
+exports.getGrandTotalRowKey = getGrandTotalRowKey;
+exports.getGrandTotalRowLabel = getGrandTotalRowLabel;
+exports.getGrandTotalRowDescription = getGrandTotalRowDescription;
+exports.getAggFuncSummaryLabel = getAggFuncSummaryLabel;
 const tslib_1 = require("tslib");
 const jsx_runtime_1 = require("react/jsx-runtime");
 const React = tslib_1.__importStar(require("react"));
-const CheckBox_1 = require("../../../../components/CheckBox");
-const FormLayout_1 = tslib_1.__importStar(require("../../../../components/FormLayout"));
-const Card_1 = require("../../../../components/Card");
 const Tag_1 = require("../../../../components/Tag");
 const AggregationColumns_1 = require("../../../../AdaptableState/Common/AggregationColumns");
 const AdaptableContext_1 = require("../../../AdaptableContext");
 const ValueSelector_1 = require("../../../Components/ValueSelector");
 const OnePageAdaptableWizard_1 = require("../../../Wizard/OnePageAdaptableWizard");
+const CollapsibleWizardCard_1 = require("../../../Wizard/CollapsibleWizardCard");
+const layoutWizardAccordionHelpers_1 = require("./layoutWizardAccordionHelpers");
 const Utilities_1 = require("./Utilities");
 const ColumnGroupTag_1 = require("../../../Components/ColumnGroupTag");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../../../Utilities/Extensions/ArrayExtensions"));
-const StringExtensions_1 = tslib_1.__importDefault(require("../../../../Utilities/Extensions/StringExtensions"));
+const Card_1 = require("../../../../components/Card");
 const Flex_1 = require("../../../../components/Flex");
 const NewSelect_1 = require("../../../../components/NewSelect");
+const layoutWizardColumns_1 = require("./layoutWizardColumns");
+const Radio_1 = tslib_1.__importStar(require("../../../../components/Radio"));
+const TypeRadio_1 = require("../../../Wizard/TypeRadio");
+const aggregationSummaryHelpers_1 = require("../../../../Strategy/Utilities/Layout/aggregationSummaryHelpers");
+const SummaryColorTag_1 = require("../../../Wizard/SummaryColorTag");
 const WEIGHTED_AVERAGE_AGG_FN_NAME = 'weightedAvg';
+exports.GRAND_TOTAL_ROW_LABELS = {
+    off: 'None',
+    top: 'Top',
+    bottom: 'Bottom',
+    pinnedTop: 'Pinned Top',
+    pinnedBottom: 'Pinned Bottom',
+};
+exports.GRAND_TOTAL_ROW_DESCRIPTIONS = {
+    off: 'Grand Total Row is not displayed in the grid',
+    top: 'Grand Total Row is displayed at the top of the grid',
+    bottom: 'Grand Total Row is displayed at the bottom of the grid',
+    pinnedTop: 'Grand Total Row is pinned to the top of the grid',
+    pinnedBottom: 'Grand Total Row is pinned to the bottom of the grid',
+};
+exports.GRAND_TOTAL_ROW_OPTIONS = [
+    'off',
+    'top',
+    'bottom',
+    'pinnedTop',
+    'pinnedBottom',
+];
+function getGrandTotalRowKey(layout) {
+    const value = layout.GrandTotalRow;
+    if (value == null || value === false) {
+        return 'off';
+    }
+    return value;
+}
+function getGrandTotalRowLabel(layout) {
+    return exports.GRAND_TOTAL_ROW_LABELS[getGrandTotalRowKey(layout)];
+}
+function getGrandTotalRowDescription(layout) {
+    return exports.GRAND_TOTAL_ROW_DESCRIPTIONS[getGrandTotalRowKey(layout)];
+}
+function getAggFuncSummaryLabel(columnId, aggFunc, aggregationColumnsMap) {
+    if (aggregationColumnsMap[columnId]) {
+        return aggregationColumnsMap[columnId];
+    }
+    if (typeof aggFunc === 'object' && aggFunc.type === 'weightedAverage') {
+        return WEIGHTED_AVERAGE_AGG_FN_NAME;
+    }
+    if (typeof aggFunc === 'string') {
+        return aggFunc;
+    }
+    return 'agg';
+}
 const isAggregationsSectionValid = (data) => {
     const weightedAvg = data.TableAggregationColumns
         ? (data.TableAggregationColumns || []).find(({ AggFunc }) => typeof AggFunc === 'object' &&
@@ -30,18 +84,15 @@ const isAggregationsSectionValid = (data) => {
     return true;
 };
 exports.isAggregationsSectionValid = isAggregationsSectionValid;
-const AggregationsSectionSummary = () => {
+const AggregationsSectionSummary = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
-    const { data: layout } = (0, OnePageAdaptableWizard_1.useOnePageAdaptableWizardContext)();
-    const entries = layout.TableAggregationColumns || [];
-    let content = null;
-    if (entries.length) {
-        content = ((0, jsx_runtime_1.jsx)(FormLayout_1.default, { children: entries.map(({ ColumnId, AggFunc }) => ((0, jsx_runtime_1.jsx)(FormLayout_1.FormRow, { label: adaptable.api.columnApi.getFriendlyNameForColumnId(ColumnId), children: (0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: typeof AggFunc === 'object' ? AggFunc.type : AggFunc }) }, ColumnId))) }));
-    }
-    else {
-        content = (0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: "No Aggregations" });
+    const { data: contextLayout } = (0, OnePageAdaptableWizard_1.useOnePageAdaptableWizardContext)();
+    const layout = props.layout ?? contextLayout;
+    const values = (0, aggregationSummaryHelpers_1.getTableAggregationSummaryValues)(layout, adaptable.api);
+    if (!values.length) {
+        return (0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: "No Aggregations" });
     }
-    return (0, jsx_runtime_1.jsx)(Flex_1.Box, { children: content });
+    return (0, SummaryColorTag_1.renderSummaryStringTags)(values);
 };
 exports.AggregationsSectionSummary = AggregationsSectionSummary;
 const ColumnRow = (props) => {
@@ -109,10 +160,10 @@ const ColumnRow = (props) => {
         label: col.friendlyName,
         value: col.columnId,
     }));
-    return ((0, jsx_runtime_1.jsxs)(Flex_1.Flex, { alignItems: "center", children: [props.column.friendlyName, (0, jsx_runtime_1.jsx)(ColumnGroupTag_1.ColumnGroupTag, { column: props.column }), aggValue && ((0, jsx_runtime_1.jsx)(NewSelect_1.SingleSelect, { className: "twa:min-w-[140px] twa:ml-2", value: currentAggFnName, items: aggFunctionNames.map((fnName) => ({
+    return ((0, jsx_runtime_1.jsxs)(Flex_1.Flex, { alignItems: "center", className: "twa:min-w-0 twa:flex-wrap twa:gap-x-1.5 twa:gap-y-0.5", children: [(0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:truncate", children: props.column.friendlyName }), (0, jsx_runtime_1.jsx)(ColumnGroupTag_1.ColumnGroupTag, { column: props.column }), aggValue && ((0, jsx_runtime_1.jsx)(NewSelect_1.SingleSelect, { size: "small", stopMouseDownPropagation: true, className: "twa:min-w-[6.5rem] twa:shrink-0", value: currentAggFnName, items: aggFunctionNames.map((fnName) => ({
                     label: fnName,
                     value: fnName,
-                })), onValueChange: updateAggFunc })), currentAggFnName === WEIGHTED_AVERAGE_AGG_FN_NAME && ((0, jsx_runtime_1.jsxs)(Flex_1.Flex, { className: "twa:bg-primary twa:ml-3", alignItems: "center", children: [(0, jsx_runtime_1.jsx)(Flex_1.Box, { children: "Weight" }), (0, jsx_runtime_1.jsx)(NewSelect_1.SingleSelect, { className: "twa:min-w-[140px] twa:ml-2", placeholder: "Select Weight", value: weightColumnId, items: weightColumnOptions, onValueChange: updateWeightedColumn })] }))] }));
+                })), onValueChange: updateAggFunc })), currentAggFnName === WEIGHTED_AVERAGE_AGG_FN_NAME && ((0, jsx_runtime_1.jsxs)(Flex_1.Flex, { alignItems: "center", className: "twa:gap-1 twa:shrink-0", children: [(0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:text-3", children: "Weight" }), (0, jsx_runtime_1.jsx)(NewSelect_1.SingleSelect, { size: "small", stopMouseDownPropagation: true, className: "twa:min-w-[6.5rem]", placeholder: "Select Weight", value: weightColumnId, items: weightColumnOptions, onValueChange: updateWeightedColumn })] }))] }));
 };
 const AggregationsSection = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
@@ -180,21 +231,14 @@ const AggregationsSection = (props) => {
             SuppressAggFuncInHeader: checked,
         });
     };
-    return ((0, jsx_runtime_1.jsxs)(Flex_1.Box, { className: "twa:h-full twa:min-h-0 twa:p-2 twa:gap-2 twa:overflow-hidden twa:grid twa:grid-cols-2", children: [(0, jsx_runtime_1.jsxs)(Card_1.Card, { shadow: false, className: "twa:h-full twa:overflow-hidden twa:flex twa:flex-col", children: [(0, jsx_runtime_1.jsxs)(Card_1.Card.Title, { children: [(0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:font-medium", children: "Aggregation Columns" }), (0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:text-xs twa:opacity-70 twa:font-normal twa:max-w-[520px]", children: "Select a column and an aggregation function" })] }), (0, jsx_runtime_1.jsx)(Card_1.Card.Body, { className: "twa:flex-1 twa:min-h-0 twa:overflow-hidden twa:p-1", children: (0, jsx_runtime_1.jsx)(ValueSelector_1.ValueSelector, { style: { minHeight: 0 }, showFilterInput: true, filter: Utilities_1.columnFilter, toIdentifier: (option) => `${option.columnId}`, toLabel: (option) => option.friendlyName ?? option.columnId, toListLabel: (column) => ((0, jsx_runtime_1.jsx)(ColumnRow, { onChangeAggFunction: handleAggregationChange, layout: layout, column: column, aggregationColumnsMap: aggregationColumnsMap, numberColumns: numberColumns })), options: sortedAggregableColumns, value: (layout.TableAggregationColumns || []).map((agg) => agg.ColumnId), allowReorder: () => true, onChange: handleColumnsSelectionChange }) })] }), (0, jsx_runtime_1.jsxs)(Flex_1.Box, { className: "twa:h-full twa:min-h-0 twa:overflow-y-auto twa:flex twa:flex-col twa:gap-2", children: [(0, jsx_runtime_1.jsxs)(Card_1.Card, { shadow: false, children: [(0, jsx_runtime_1.jsx)(Card_1.Card.Title, { children: (0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:font-medium", children: "Omit Aggregation from Header" }) }), (0, jsx_runtime_1.jsx)(Card_1.Card.Body, { className: "twa:p-1", children: (0, jsx_runtime_1.jsx)(CheckBox_1.CheckBox, { checked: layout.SuppressAggFuncInHeader, onChange: handleSuppressAggFuncInHeader, children: "Do not show aggregation function names in column headers" }) })] }), (0, jsx_runtime_1.jsxs)(Card_1.Card, { shadow: false, children: [(0, jsx_runtime_1.jsxs)(Card_1.Card.Title, { children: [(0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:font-medium", children: "Grand Total Row" }), (0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:text-xs twa:opacity-70 twa:font-normal twa:max-w-[520px]", children: "Set position of the grand total row in the grid" })] }), (0, jsx_runtime_1.jsx)(Card_1.Card.Body, { className: "twa:p-1", children: (0, jsx_runtime_1.jsx)(NewSelect_1.SingleSelect, { className: "twa:w-[180px]", items: [
-                                        {
-                                            label: 'Off',
-                                            value: null,
-                                        },
-                                    ].concat(['top', 'bottom', 'pinnedTop', 'pinnedBottom'].map((position) => {
-                                        return {
-                                            label: StringExtensions_1.default.CamelCaseToHumanText(position),
-                                            value: position,
-                                        };
-                                    })), placeholder: "Off", value: layout.GrandTotalRow, onValueChange: (value) => {
-                                        props.onChange({
-                                            ...layout,
-                                            GrandTotalRow: value,
-                                        });
-                                    } }) })] })] })] }));
+    const aggregationEntries = layout.TableAggregationColumns || [];
+    const initialExpandedCardId = (0, layoutWizardAccordionHelpers_1.getLayoutWizardInitialExpandedCardId)(props.layoutWizardMode, 'columns', (0, layoutWizardAccordionHelpers_1.isTableAggregationsSectionConfigured)(layout));
+    const { bindCard, hasExpandedCard, expandedFillsSpace } = (0, CollapsibleWizardCard_1.useWizardCardAccordion)(initialExpandedCardId);
+    return ((0, jsx_runtime_1.jsxs)(Flex_1.Box, { className: (0, CollapsibleWizardCard_1.getWizardAccordionSectionClassName)(hasExpandedCard, expandedFillsSpace), children: [(0, jsx_runtime_1.jsx)(CollapsibleWizardCard_1.CollapsibleWizardCard, { ...bindCard('columns', { fillAvailable: true }), surface: "panel", "data-name": "aggregation-columns", title: "Aggregation Columns", help: "Select a column and an aggregation function", collapsedHelp: "", compactSummary: (0, CollapsibleWizardCard_1.renderCompactColumnTags)(aggregationEntries.map(({ ColumnId }) => ColumnId), (columnId) => adaptable.api.columnApi.getFriendlyNameForColumnId(columnId), { emptyLabel: 'No columns' }), summary: aggregationEntries.length ? ((0, jsx_runtime_1.jsx)(Flex_1.Flex, { flexWrap: "wrap", className: "twa:gap-1", children: aggregationEntries.map(({ ColumnId, AggFunc }) => ((0, jsx_runtime_1.jsxs)(Tag_1.ColumnTag, { children: [adaptable.api.columnApi.getFriendlyNameForColumnId(ColumnId), " (", getAggFuncSummaryLabel(ColumnId, AggFunc, aggregationColumnsMap), ")"] }, ColumnId))) })) : ((0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: "No columns" })), className: "twa:overflow-hidden twa:flex twa:flex-col", bodyClassName: "twa:min-h-[200px] twa:max-h-[420px] twa:overflow-hidden twa:flex twa:flex-col twa:!pt-0 twa:!pb-0 twa:px-1", children: (0, jsx_runtime_1.jsx)(Card_1.Card, { shadow: false, className: "twa:h-full twa:overflow-hidden twa:flex twa:flex-col", children: (0, jsx_runtime_1.jsx)(Card_1.Card.Body, { className: "twa:flex-1 twa:min-h-0 twa:overflow-hidden twa:px-1 twa:pt-0 twa:pb-0", children: (0, jsx_runtime_1.jsx)(Flex_1.Box, { className: "twa:flex twa:flex-col twa:gap-1.5 twa:h-full twa:overflow-hidden twa:flex-1 twa:min-h-0", "data-name": "aggregation-columns-container", children: (0, jsx_runtime_1.jsx)(ValueSelector_1.ValueSelector, { compact: true, showFilterInput: true, filter: Utilities_1.columnFilter, filterPlaceholder: "Search Columns...", compactHeaderClassName: layoutWizardColumns_1.LAYOUT_WIZARD_COLUMN_LIST_HEADER_CLASS, compactFilterClassName: layoutWizardColumns_1.LAYOUT_WIZARD_COLUMN_LIST_SEARCH_CLASS, optionLayout: "label-beside-checkbox", toggleSelectionOnRowClick: true, optionClassName: layoutWizardColumns_1.LAYOUT_WIZARD_COLUMN_LIST_OPTION_CLASS, toIdentifier: (option) => `${option.columnId}`, toLabel: (option) => option.friendlyName ?? option.columnId, toListLabel: (column) => ((0, jsx_runtime_1.jsx)(ColumnRow, { onChangeAggFunction: handleAggregationChange, layout: layout, column: column, aggregationColumnsMap: aggregationColumnsMap, numberColumns: numberColumns })), options: sortedAggregableColumns, value: aggregationEntries.map((agg) => agg.ColumnId), allowReorder: () => true, onChange: handleColumnsSelectionChange }) }) }) }) }), (0, jsx_runtime_1.jsx)(CollapsibleWizardCard_1.CollapsibleWizardCard, { ...bindCard('suppress-header'), surface: "panel", "data-name": "omit-aggregation-from-header", title: "Aggregation Column Header", help: "Set behaviour for aggregation function names", collapsedHelp: "Behaviour for aggregation function names", compactSummary: (0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: layout.SuppressAggFuncInHeader ? 'Hide Function Name in Header' : 'Show Function Name in Header' }), summary: (0, jsx_runtime_1.jsx)(CollapsibleWizardCard_1.CollapsibleWizardValueSummary, { value: (0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: layout.SuppressAggFuncInHeader ? 'Hide Function Name in Header' : 'Show Function Name in Header' }) }), children: (0, jsx_runtime_1.jsxs)(Radio_1.RadioGroup, { orientation: "vertical", value: layout.SuppressAggFuncInHeader ?? false, onRadioChange: handleSuppressAggFuncInHeader, children: [(0, jsx_runtime_1.jsx)(Radio_1.default, { value: false, children: "Show Aggregation function names" }), (0, jsx_runtime_1.jsx)(Radio_1.default, { value: true, children: "Hide Aggregation function names" })] }) }), (0, jsx_runtime_1.jsx)(CollapsibleWizardCard_1.CollapsibleWizardCard, { ...bindCard('grand-total'), surface: "panel", "data-name": "grand-total-row", title: "Grand Total Row", help: "Set position of the Grand Total Row in the grid", collapsedHelp: "Position of the Grand Total Row in the grid", compactSummary: (0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: getGrandTotalRowLabel(layout) }), summary: (0, jsx_runtime_1.jsx)(CollapsibleWizardCard_1.CollapsibleWizardValueSummary, { value: (0, jsx_runtime_1.jsx)(Tag_1.Tag, { children: getGrandTotalRowLabel(layout) }) }), children: (0, jsx_runtime_1.jsx)(Radio_1.RadioGroup, { orientation: "vertical", value: getGrandTotalRowKey(layout), onRadioChange: (key) => {
+                        props.onChange({
+                            ...layout,
+                            GrandTotalRow: key === 'off' ? null : key,
+                        });
+                    }, children: exports.GRAND_TOTAL_ROW_OPTIONS.map((key) => ((0, jsx_runtime_1.jsx)(TypeRadio_1.TypeRadio, { value: key, text: exports.GRAND_TOTAL_ROW_LABELS[key], description: exports.GRAND_TOTAL_ROW_DESCRIPTIONS[key] }, key))) }) })] }));
 };
 exports.AggregationsSection = AggregationsSection;

package/src/View/Layout/Wizard/sections/ColumnsSection.d.ts

@@ -1,8 +1,11 @@
 import * as React from 'react';
 import { Layout } from '../../../../../types';
-export declare const ColumnsSectionSummary: React.FunctionComponent;
+export declare const ColumnsSectionSummary: React.FunctionComponent<{
+    layout?: Layout;
+}>;
 interface ColumnsSectionProps {
     onChange: (data: Layout) => void;
+    layoutWizardMode?: 'create' | 'edit';
 }
 export declare const ColumnsSection: React.FunctionComponent<ColumnsSectionProps>;
 export {};