@datarailsshared/dr_renderer 1.2.307-dragons → 1.2.309

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datarailsshared/dr_renderer",
-  "version": "1.2.307-dragons",
+  "version": "1.2.309",
   "description": "DataRails charts and tables renderer",
   "keywords": [
     "datarails",

package/src/dr_pivottable.js

@@ -91,7 +91,6 @@ let initDRPivotTable = function($, window, document) {
 
         DRPivotData.prototype.arrSort = function(attrs) {
             var a, sortersArr;
-            const sortByValueAttrs = this.sortByValueAttrs;
             sortersArr = (function() {
                 var l, len1, results;
                 results = [];
@@ -101,21 +100,11 @@ let initDRPivotTable = function($, window, document) {
                 }
                 return results;
             }).call(this);
-
             return function(a, b) {
                 var comparison, i, sorter;
                 for (i in sortersArr) {
-                    const index = parseInt(i);
-                    sorter = sortersArr[index];
-                    if (sortByValueAttrs.indexOf(attrs[index]) !== -1) {
-
-                        // For case current Field attrs[index] is sorted by value we are concatenating values passed to sorter function
-                        // Concatenation is done from first field in a block (first axis or first series) until current field index.
-                        // Cause for this case sorting will be as list of these concatenated strings (which is prepared in getSortingByValueOrderList)
-                        comparison = sorter(a.slice(0, index + 1).join(','), b.slice(0, index + 1).join(','));
-                    } else {
-                        comparison = sorter(a[index], b[index]);
-                    }
+                    sorter = sortersArr[i];
+                    comparison = sorter(a[i], b[i]);
                     if (comparison !== 0) {
                         return comparison;
                     }

package/src/highcharts_renderer.js

@@ -1150,7 +1150,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 ob.name = row_n_value.join(highchartsRenderer.delimer)
                     .replace(highchartsRenderer.DR_OTHERS_KEY, othersName);
             }
-
             lodash.forEach(col_n_keys, function (col_n_value, index) {
                 var agg = pivotData.getAggregator(row_n_value, col_n_value);
                 var val = agg.value();
@@ -1392,7 +1391,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             if (opts.trendLine) {
                 const a = ((ySum * squareXSum) - (xSum * xySum)) / ((n * squareXSum) - (xSum * xSum));
                 const b = ((n * xySum) -  (xSum* ySum)) / ((n * squareXSum) - (xSum * xSum));
-
                 const trendSeries = lodash.clone(chart_series[chart_series.length - 1]);
                 trendSeries.className = 'trendSeries';
                 trendSeries.name = highchartsRenderer.getTrendSeriesName(trendSeries);
@@ -1403,7 +1401,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 if (colors && colors[i]) {
                     trendSeries.color = colors[i];
                 }
-
                 trendSerieses.push(trendSeries);
             }
             i++;
@@ -1420,7 +1417,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
 
         let weights = { line: 2,spline: 3 ,area:-2, areaspline: -1, scatter:4, column: 1 };
-
         if (opts.comboOptions && lodash.includes(chartType,'combo') && !lodash.isEqual(row_n_keys, EMPTY_ROW_N_KEYS)) {
             chart_series.forEach((series, seriesIndex) => {
                 const savedSeriesOption = lodash.find(opts.comboOptions.seriesOptions, {series: series.name});
@@ -1640,18 +1636,19 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     ? lodash.get(waterfallOptions, 'colors', {}).increase || baseColor.increase
                     : lodash.get(waterfallOptions, 'colors', {}).decrease || baseColor.decrease;
             }
-
-            resultObject.data.push({
-                y: val,
-                name: lodash.replace(
-                    lodash.unescape(name), highchartsRenderer.DR_OTHERS_KEY, highchartsRenderer.getOthersName(opts)
-                ),
-                totalIndex: value.trend === 'total' ? index : undefined,
-                isSum: value.trend === 'total',
-                isTotal: value.trend === 'total',
-                color,
-                colsForTotal: value.trend === 'total' ? keys : null,
-            });
+            if (val !== 0) {
+                resultObject.data.push({
+                    y: val,
+                    name: lodash.replace(
+                        lodash.unescape(name), highchartsRenderer.DR_OTHERS_KEY, highchartsRenderer.getOthersName(opts)
+                    ),
+                    totalIndex: value.trend === 'total' ? index : undefined,
+                    isSum: value.trend === 'total',
+                    isTotal: value.trend === 'total',
+                    color,
+                    colsForTotal: value.trend === 'total' ? keys : null,
+                });
+            }
         });
         chart_series.push(resultObject);
         chart_series.push(
@@ -2675,7 +2672,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 }
             };
         }
- 
+
         if (lodash.get(chartOptions, 'plotOptions.series.point.events')) {
             chartOptions.plotOptions.series.point.events.mouseOver = opts.trackUserInsightsTooltipFunc;
             chartOptions.plotOptions.series.point.events.mouseOut = opts.trackUserInsightsTooltipFunc;
@@ -4411,42 +4408,72 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return ret_str;
     };
 
-    highchartsRenderer.getSortingByValueOrderList = function (pivotData, sortingOptions, keysArray, attrs, fieldIndex, widget) {
-        let values_names_arr = [];
-        lodash.forEach(keysArray, function (val) {
-            const firstArray = [];
-            const secondArray = val.slice(0, fieldIndex + 1);
-
-            let valueForComparison;
-            if (sortingOptions.sort_by === 'variance') {
-                const varianceConfig = widget.options.chartOptions.delta_column;
-                const data = pivotData.input;
-                const varianceField = varianceConfig.field === 'category' ? widget.cols[0] : widget.rows[0];
-                const varianceRowsForCurrentKey = lodash.filter(data, row => 
-                    row[varianceField.name] === varianceConfig.name 
-                        && lodash.every(secondArray, (item, index) => row[attrs[index]] === item)
-                );
+    highchartsRenderer.getNewAttrSortingForCol = function (pivotData, sortingOptions) {
+        let rowAttrs, rowKeys, colKeys, colAttrs;
+        rowAttrs = pivotData.rowAttrs;
+        rowKeys = pivotData.rowKeys;
+        colKeys = pivotData.colKeys;
+        colAttrs = pivotData.colAttrs;
 
-                valueForComparison = lodash.reduce(varianceRowsForCurrentKey, (a, d) => a + d[widget.vals[0].name], 0);
-            } else {
-                let getAggregatorParams = [firstArray, secondArray];
 
-                if (lodash.includes(pivotData.rowAttrs, attrs[fieldIndex])) {
-                    getAggregatorParams = lodash.reverse(getAggregatorParams);
-                }
-    
-                let aggregator_subtotal = pivotData.getAggregator(...getAggregatorParams);
+        if (!colAttrs || colAttrs.length == 0) {
+            return null;
+        }
+
+        let values_names_arr = [];
+        let keysArray = sortingOptions.field ? rowKeys : colKeys;
+
+        lodash.forEach(keysArray, function (val) {
+            let firstArray = sortingOptions.field ? [val[0]] : [];
+            let secondArray = sortingOptions.field ? sortingOptions.field.split(highchartsRenderer.delimer) : [val[0]];
+            let aggregator_subtotal = pivotData.getAggregator(firstArray, secondArray);
 
-                if (aggregator_subtotal) {
-                    valueForComparison = aggregator_subtotal.value();
+            if (aggregator_subtotal) {
+                let value_subtotal = aggregator_subtotal.value();
+                if (sortingOptions && sortingOptions.is_absolute && !isNaN(parseFloat(value_subtotal))) {
+                    value_subtotal = Math.abs(value_subtotal);
                 }
+                values_names_arr.push({name: val[0], value: value_subtotal});
             }
+        });
+
+        // ORDERING
+        let sorting_vector = ['asc'];
+        if (sortingOptions && sortingOptions.type == 'largestToSmallest') {
+            sorting_vector = ['desc'];
+        }
+        values_names_arr = lodash.orderBy(values_names_arr, ['value'], sorting_vector);
+
+        // map only names
+        let attr_sorted_values = lodash.map(values_names_arr, 'name');
+        return {name: sortingOptions.field ? rowAttrs[0] : colAttrs[0], values: attr_sorted_values};
+    };
 
-            if (!lodash.isNil(valueForComparison)) {
-                if (sortingOptions && sortingOptions.is_absolute && !isNaN(parseFloat(valueForComparison))) {
-                    valueForComparison = Math.abs(valueForComparison);
+    highchartsRenderer.getNewAttrSortingForRow = function (pivotData, sortingOptions) {
+        let rowAttrs, rowKeys, colKeys, colAttrs;
+        rowAttrs = pivotData.rowAttrs;
+        rowKeys = pivotData.rowKeys;
+        colKeys = pivotData.colKeys;
+        colAttrs = pivotData.colAttrs;
+
+        if (!rowAttrs || rowAttrs.length == 0) {
+            return null;
+        }
+
+        let values_names_arr = [];
+        let keysArray = sortingOptions.field ? colKeys : rowKeys;
+
+        lodash.forEach(keysArray, function (val) {
+            let firstArray = sortingOptions.field ? sortingOptions.field.split(highchartsRenderer.delimer) : [val[0]];
+            let secondArray = sortingOptions.field ? [val[0]] : [];
+            let aggregator_subtotal = pivotData.getAggregator(firstArray, secondArray);
+
+            if (aggregator_subtotal) {
+                let value_subtotal = aggregator_subtotal.value();
+                if (sortingOptions && sortingOptions.is_absolute && !isNaN(parseFloat(value_subtotal))) {
+                    value_subtotal = Math.abs(value_subtotal);
                 }
-                values_names_arr.push({name: secondArray.join(','), value: valueForComparison});
+                values_names_arr.push({name: val[0], value: value_subtotal});
             }
         });
 
@@ -4458,33 +4485,36 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         values_names_arr = lodash.orderBy(values_names_arr, ['value'], sorting_vector);
 
         // map only names
-        return lodash.map(values_names_arr, 'name');
+        let attr_sorted_values = lodash.map(values_names_arr, 'name');
+        return {name: sortingOptions.field ? colAttrs[0] : rowAttrs[0], values: attr_sorted_values};
     };
 
-    highchartsRenderer.generateSortingFunctionByValues = function (sortByValueSettings, pivotData, opts, widget) {
+    highchartsRenderer.generateSortingFunctionByValues = function (sortingOptions, pivotData, opts) {
+        let new_map;
+        let axis = highchartsRenderer.getAxis(sortingOptions.axis, opts);
+        if (axis == 'col_total') {
+            new_map = highchartsRenderer.getNewAttrSortingForCol(pivotData, sortingOptions);
+        } else if (axis == 'row_total') {
+            new_map = highchartsRenderer.getNewAttrSortingForRow(pivotData, sortingOptions);
+        }
+
         let old_sorters_function = opts.sorters;
         if (!old_sorters_function) {
             old_sorters_function = function () {
             };
         }
-        return function (attr) {
-            const sortingOptions = lodash.find(sortByValueSettings, fieldSorting => fieldSorting.name === attr);
-            if (sortingOptions) {
-                const axis = highchartsRenderer.getAxis(_.includes(pivotData.colAttrs, attr) ? 'col_total' : 'row_total', opts);
-                const isColumnSort = axis === 'col_total';
-                const fieldIndex = lodash.findIndex(isColumnSort ? pivotData.colAttrs : pivotData.rowAttrs, name => name === attr);
-                const orderedNamesList = highchartsRenderer.getSortingByValueOrderList(
-                    pivotData,
-                    sortingOptions.sorting,
-                    pivotData[isColumnSort ? 'colKeys' : 'rowKeys'],
-                    pivotData[isColumnSort ? 'colAttrs' : 'rowAttrs'],
-                    fieldIndex,
-                    widget
-                );
-                return $.pivotUtilities.sortAs(orderedNamesList);
-            } else {
-                return old_sorters_function(attr);
+        if (new_map) {
+            var sortAs = $.pivotUtilities.sortAs;
+            let new_sorters_function = function (attr) {
+                if (new_map.name == attr) {
+                    return $.pivotUtilities.sortAs(new_map.values);
+                } else {
+                    return old_sorters_function(attr);
+                }
             }
+            return new_sorters_function;
+        } else {
+            return old_sorters_function;
         }
     };
 
@@ -4688,7 +4718,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         result = null;
         try {
             pivotData = $.pivotUtilities.getPivotDataModel(rowData, opts);
-            pivotData.sortByValueAttrs = [];
             try {
                 if (options && options.onlyOptions) {
                     if (!opts.rendererOptions) {
@@ -4696,15 +4725,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     }
                     opts.rendererOptions.onlyOptions = true;
                 }
-
-                const sortByValueSettings = lodash.filter(
-                    lodash.get(widget, 'options.sortingFields', []),
-                    sortingField => lodash.includes(['field_values', 'variance'], lodash.get(sortingField, 'sorting.sort_by'))
-                );
-
-                if (sortByValueSettings.length) {
-                    pivotData.sortByValueAttrs = lodash.map(sortByValueSettings, fieldSorting => fieldSorting.name);
-                    let new_sorting_function = highchartsRenderer.generateSortingFunctionByValues(sortByValueSettings, pivotData, opts, widget);
+                var totalFilters = lodash.get(opts, 'rendererOptions.total_value_options', null);
+                if (totalFilters && totalFilters.sorting_options) {
+                    let new_sorting_function = highchartsRenderer.generateSortingFunctionByValues(totalFilters.sorting_options, pivotData, opts);
                     opts.sorters = new_sorting_function;
                     optsFiltered.sorters = new_sorting_function;
                     pivotData.sorters = new_sorting_function;
@@ -5019,7 +5042,19 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
     };
 
     highchartsRenderer.isSystemField = function (field) {
-        var regex = new RegExp("^(Calc_Model_Name|Calc_Model_ID|Parent_Name|Parent_Id|FileBox_ID|FileBox_Name|DataMapper_Name|Doc_ID|Doc_version|Label|Submission_Date|User|table_id|Latest_In_Dim|Tab_name|CP_Name|DT_.+|VT_.+|System_.+)$", "m");
+        const features = lodash.get(document, 'ReportHippo.user.features', []);
+        const dynamicSystemFields = [];
+
+        const areMultipleAndScenarioTags = lodash.includes(features, 'multiple_dimension_tags')
+            && lodash.includes(features, 'use_new_scenario_tag');
+
+        if (areMultipleAndScenarioTags) {
+            dynamicSystemFields.push('Scenario', 'Budget Cycle');
+        }
+
+        const regexDelimer = '|';
+        const dynamicSystemFieldsRegex = dynamicSystemFields.length ? dynamicSystemFields.join(regexDelimer) + regexDelimer : '';
+        var regex = new RegExp(`^(${dynamicSystemFieldsRegex}Calc_Model_Name|Calc_Model_ID|Parent_Name|Parent_Id|FileBox_ID|FileBox_Name|DataMapper_Name|Doc_ID|Doc_version|Label|Submission_Date|User|table_id|Latest_In_Dim|Tab_name|CP_Name|DT_.+|VT_.+|System_.+)$`, "m");
 
         return (field.category && field.category.includes("")) || regex.test(field.name)
     };
@@ -7055,6 +7090,18 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 value_name: 'is_percentage',
                 default_value: false,
                 hidden: true,
+            }, {
+                element_type: 'checkbox',
+                element_label: 'Sort by variance',
+                value_name: 'sort_by_variance',
+                default_value: false,
+                hidden: true
+            }, {
+                element_type: 'checkbox',
+                element_label: 'Sort by absolute variance',
+                value_name: 'sort_by_absolute_variance',
+                default_value: false,
+                hidden: true
             }]
         },
         'delta_column_for_drill_down': {
@@ -7121,6 +7168,18 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 value_name: 'is_percentage',
                 default_value: false,
                 hidden: true,
+            }, {
+                element_type: 'checkbox',
+                element_label: 'Sort by variance',
+                value_name: 'sort_by_variance',
+                default_value: false,
+                hidden: true
+            }, {
+                element_type: 'checkbox',
+                element_label: 'Sort by absolute variance',
+                value_name: 'sort_by_absolute_variance',
+                default_value: false,
+                hidden: true
             }, {
                 element_type: 'checkbox',
                 element_label: 'Filter zero values',
@@ -8637,9 +8696,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         const isCustomSorting = widget.options.sortingFields && Array.isArray(widget.options.sortingFields) && widget.options.sortingFields.length > 0;
         if (isCustomSorting) {
             lodash.forEach(datesFields, function (field) {
-                const fieldToSort = lodash.find(
-                    widget.options.sortingFields, element => element.id === field.id && lodash.get(element, 'sorting.sort_by') === 'field_items'
-                );
+                const fieldToSort = lodash.find(widget.options.sortingFields, element => element.id === field.id);
                 field.sorting = fieldToSort ? fieldToSort.sorting : field.sorting;
             });
         }
@@ -8721,9 +8778,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             });
         } else if (isCustomSorting) {
             lodash.forEach(rowsAndCols, function (field) {
-                const fieldToSort = lodash.find(
-                    widget.options.sortingFields, element => element.id === field.id && lodash.get(element, 'sorting.sort_by') === 'field_items'
-                );
+                const fieldToSort = lodash.find(widget.options.sortingFields, element => element.id === field.id);
                 field.sorting = fieldToSort ? fieldToSort.sorting : field.sorting;
             });
         }
@@ -8758,9 +8813,61 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
 
         /****** END *******/
-        
-        // TODO: Remove. sortingValues looks like lagacy which is not in use neither in webclient nor in renderer
-        if (widget.options && widget.options.sortingValues) {
+
+        if (lodash.has(widget, "options.chartOptions.delta_column") &&
+            widget.options.chartOptions.delta_column.field != '' &&
+            (widget.options.chartOptions.delta_column.sort_by_variance ||
+                widget.options.chartOptions.delta_column.sort_by_absolute_variance) &&
+            widget.rows.length > 0 &&
+            widget.cols.length > 0 &&
+            widget.vals.length
+        ) {
+            let variance_config = widget.options.chartOptions.delta_column;
+            let val_field = widget.vals[0];
+            let field_for_sorting = null;
+            let field_with_variant = null;
+            if (variance_config.field == "series") {
+                field_for_sorting = widget.cols[0];
+                field_with_variant = widget.rows[0];
+            } else if (variance_config.field == "category") {
+                field_for_sorting = widget.rows[0];
+                field_with_variant = widget.cols[0];
+            }
+
+            let data_sorted = lodash.filter(data, function (data_row) {
+                return data_row[field_with_variant.name] == variance_config.name && data_row[field_for_sorting.name] != undefined;
+            });
+
+            const sorting_variance = widget.options.total_value_options && widget.options.total_value_options.sorting_variance === '' ? 'asc' : 'desc';
+
+            if (widget.options.chartOptions.delta_column.sort_by_absolute_variance) {
+                data_sorted = lodash.sortBy(data_sorted, function (o) {
+                    if (sorting_variance === 'desc') {
+                        return Math.abs(o[val_field.name]) * -1;
+                    }
+
+                    return Math.abs(o[val_field.name]) * 1;
+                });
+            } else {
+                data_sorted = lodash.orderBy(data_sorted, [val_field.name], [sorting_variance]);
+            }
+
+            let values_for_sort = lodash.map(data_sorted, function (data_row) {
+                return data_row[field_for_sorting.name];
+            });
+
+            values_for_sort = lodash.uniq(values_for_sort);
+
+            if (values_for_sort.length > 0) {
+                let field = lodash.find(datesFields, {name: field_for_sorting.name});
+                if (field) {
+                    field.values = values_for_sort;
+                    field.sorting = null;
+                } else {
+                    datesFields.push({name: field_for_sorting.name, values: values_for_sort});
+                }
+            }
+        } else if (widget.options && widget.options.sortingValues) {
             var field = lodash.find(datesFields, {name: widget.options.sortingValues.field});
             if (field) {
                 field.values = widget.options.sortingValues.values;
@@ -9095,17 +9202,19 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
             // if it is not total value - then add it as rowData data row and sum it up
             // else - add total with calculated sum as new rowData data row (totals do not initially exist in BE response)
-            if (value.trend !== 'total') {
+            if (value && value.trend !== 'total') {
                 const rowIndex = lodash.findIndex(rowData, (responseRow) =>
                     lodash.every(categoryFields, (field, fieldKey) => responseRow[field.name] === value.key[fieldKey])
                 );
-                modifiedRowData.push(rowData[rowIndex]);
-                sum += rowData[rowIndex][valueField.name];
-                rowData.splice(rowIndex, 1);
+                if (rowIndex >= 0) {
+                    modifiedRowData.push(rowData[rowIndex]);
+                    sum += rowData[rowIndex][valueField.name];
+                    rowData.splice(rowIndex, 1);
+                }
             } else {
                 const totalRow = {};
                 lodash.forEach(categoryFields, (field, fieldKey) => {
-                    totalRow[field.name] = value.key[fieldKey];
+                    totalRow[field.name] = value && value.key && value.key[fieldKey];
                 });
                 totalRow[valueField.name] = sum;
                 modifiedRowData.push(totalRow);

package/tests/highcharts_renderer.test.js

@@ -1154,6 +1154,18 @@ describe('highcharts_renderer', () => {
             };
             expect(highchartsRenderer.isSystemField(field)).toBe(false);
         });
+
+        describe('dynamic system fields', () => {
+            it('should count Scenario & Budget Cycle as system field', () => {
+                lodash.set(document, 'ReportHippo.user.features', ['multiple_dimension_tags', 'use_new_scenario_tag']);
+
+                const fieldWithScenario = { name: 'Scenario' };
+                expect(highchartsRenderer.isSystemField(fieldWithScenario)).toBe(true);
+
+                const fieldWithBudgetCycle = { name: 'Budget Cycle' };
+                expect(highchartsRenderer.isSystemField(fieldWithBudgetCycle)).toBe(true);
+            });
+        });
     });
 
     describe('function getFieldColorClass', () => {