@datarailsshared/dr_renderer 1.2.333 → 1.2.335

package/package.json

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

package/src/highcharts_renderer.js

@@ -549,7 +549,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         var func = function () {
             var value = parseFloat(this.y);
             if (pivotData) {
-                let series_name = (this.series.name || '') + "";
+                let series_name = highchartsRenderer.getSeriesNameInFormatterContext(this);
                 var rows = series_name.split(highchartsRenderer.delimer);
 
                 if (is_drill_down_pie && highchartsRenderer.selfStartsWith(series_name, "Series ")) {
@@ -562,7 +562,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     rows = [];
                 }
 
-                var cols = lodash.get(this, 'point.options.colsForTotal') || this.key;
+                var cols = highchartsRenderer.getColsInFormatterContext(this);
                 if (typeof (cols) == 'object' && cols.name) {
                     cols = cols.name;
                 }
@@ -730,7 +730,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
             var y = parseFloat(this.y);
             if (pivotData) {
-                let series_name = (this.series.name || '') + "";
+                let series_name = highchartsRenderer.getSeriesNameInFormatterContext(this);
                 var rows = series_name.split(highchartsRenderer.delimer);
                 if (is_drill_down_pie && highchartsRenderer.selfStartsWith(series_name,"Series ")) {
                     rows = [];
@@ -741,7 +741,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     rows = [];
                 }
 
-                var cols = lodash.get(this, 'point.options.colsForTotal') || this.key;
+                var cols = highchartsRenderer.getColsInFormatterContext(this);
                 if (!cols && is_drill_down_pie) {
                     cols = this.name;
                 }
@@ -768,7 +768,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                             ? isWaterfallWalkthrough
                                 ? this.key
                                 : cols[0]
-                            : cols
+                            : highchartsRenderer.isFormattingAxis() && lodash.get(this, 'point.name') || cols
                     );
 
                     highchartsRenderer.replaceDrOthersKeys(cols, rows, drOthersInAxis, othersName);
@@ -3929,11 +3929,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     highchartsRenderer.rhPivotCount = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
         var attr = arg[0];
-        // isCustomValues format need for check in case when customer apply SecondaryAxis and one of them is true
-        // in that case we take formats from seriesOptions and apply those format to each one of them their format from the table
-        // method isCustomValuesFormat check if format was added custom format by self or it's a default format from table
-        const isCustomValuesFormat = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
-
         return function (data, rowKey, colKey) {
             return {
                 sum: 0,
@@ -3993,11 +3988,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                         number_format = 'General';
                     }
 
-                    if (this.widget_values_format && !highchartsRenderer.enabledNewWidgetValueFormatting) {
-                        number_format = this.widget_values_format;
-                    }
-
-                    if (isCustomValuesFormat) {
+                    if (this.widget_values_format && highchartsRenderer.isUsingWidgetValuesFormat(data, render_options, widget_values_format)) {
                         number_format = this.widget_values_format;
                     }
 
@@ -4085,11 +4076,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     highchartsRenderer.rhPivotAggregatorSum = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
         var attr = arg[0];
-        // isCustomValues format need for check in case when customer apply SecondaryAxis and one of them is true
-        // in that case we take formats from seriesOptions and apply those format to each one of them their format from the table
-        // method isCustomValuesFormat check if format was added custom format by self or it's a default format from table
-        const isCustomValuesFormat = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
-
         return function (data, rowKey, colKey) {
             return {
                 sum: 0,
@@ -4161,13 +4147,10 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                         number_format = 'General';
                     }
 
-                    if (this.widget_values_format && !highchartsRenderer.enabledNewWidgetValueFormatting) {
+                    if (this.widget_values_format && highchartsRenderer.isUsingWidgetValuesFormat(data, render_options, widget_values_format)) {
                         number_format = this.widget_values_format;
                     }
 
-                    if (isCustomValuesFormat) {
-                        number_format = this.widget_values_format;
-                    }
                     number_format = highchartsRenderer.getCalculatedValueFormat(this.calculated_formats, rowKey, colKey) || number_format;
                     var formated_value = highchartsRenderer.formatValue('n', number_format, x)
 
@@ -4185,11 +4168,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     highchartsRenderer.rhPivotAggregatorMin = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
         var attr = arg[0];
-        // isCustomValues format need for check in case when customer apply SecondaryAxis and one of them is true
-        // in that case we take formats from seriesOptions and apply those format to each one of them their format from the table
-        // method isCustomValuesFormat check if format was added custom format by self or it's a default format from table
-        const isCustomValuesFormat = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
-
         return function (data, rowKey, colKey) {
             return {
                 val: null,
@@ -4259,11 +4237,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                         number_format = 'General';
                     }
 
-                    if (this.widget_values_format && !highchartsRenderer.enabledNewWidgetValueFormatting) {
-                        number_format = this.widget_values_format;
-                    }
-
-                    if (isCustomValuesFormat) {
+                    if (this.widget_values_format && highchartsRenderer.isUsingWidgetValuesFormat(data, render_options, widget_values_format)) {
                         number_format = this.widget_values_format;
                     }
 
@@ -4284,11 +4258,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     highchartsRenderer.rhPivotAggregatorMax = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
         var attr = arg[0];
-        // isCustomValues format need for check in case when customer apply SecondaryAxis and one of them is true
-        // in that case we take formats from seriesOptions and apply those format to each one of them their format from the table
-        // method isCustomValuesFormat check if format was added custom format by self or it's a default format from table
-        const isCustomValuesFormat = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
-
         return function (data, rowKey, colKey) {
             return {
                 val: null,
@@ -4359,11 +4328,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                         number_format = 'General';
                     }
 
-                    if (this.widget_values_format && !highchartsRenderer.enabledNewWidgetValueFormatting) {
-                        number_format = this.widget_values_format;
-                    }
-
-                    if (isCustomValuesFormat) {
+                    if (this.widget_values_format && highchartsRenderer.isUsingWidgetValuesFormat(data, render_options, widget_values_format)) {
                         number_format = this.widget_values_format;
                     }
 
@@ -4384,11 +4349,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     highchartsRenderer.rhPivotAggregatorAverage = function (arg, widget_values_format, is_graph, render_options, calculated_info) {
         var attr = arg[0];
-        // isCustomValues format need for check in case when customer apply SecondaryAxis and one of them is true
-        // in that case we take formats from seriesOptions and apply those format to each one of them their format from the table
-        // method isCustomValuesFormat check if format was added custom format by self or it's a default format from table
-        const isCustomValuesFormat = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
-
         return function (data, rowKey, colKey) {
             return {
                 sum: 0,
@@ -4466,11 +4426,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                         number_format = 'General';
                     }
 
-                    if (this.widget_values_format && !highchartsRenderer.enabledNewWidgetValueFormatting) {
-                        number_format = this.widget_values_format;
-                    }
-
-                    if (isCustomValuesFormat) {
+                    if (this.widget_values_format && highchartsRenderer.isUsingWidgetValuesFormat(data, render_options, widget_values_format)) {
                         number_format = this.widget_values_format;
                     }
 
@@ -9331,6 +9287,11 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
     }
 
+    // Check if chart has multiple values
+    highchartsRenderer.isChartWithMultiValues = function(pivotData) {
+        return lodash.get(pivotData, 'rowAttrs[0]') === 'DR_Values';
+    }
+
     highchartsRenderer.checkFormats = function(render_options, widget_values_format) {
         let isSecondaryAxis = false;
         let formats = [];
@@ -9353,9 +9314,13 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return formats;
     }
 
-    highchartsRenderer.isCustomValuesFormat = function (render_options, widget_values_format) {
+    // Will be FALSE when all 4 conditions true: 1. User applies SecondaryAxis 2. Format on 'format editor panel' is same as any Value field table format
+    // 3. Chart has more than one value fields in Values block 4. enable_new_widget_value_formatting is turned ON
+    // In that case we apply for both value fields their format from the table
+    // In all other cases we are applying format from editor panel to both of them (specification: DR-20955)
+    highchartsRenderer.isUsingWidgetValuesFormat = function (pivotData, render_options, widget_values_format) {
         const { isSecondaryAxis, isCustomFormat } = highchartsRenderer.checkFormats(render_options, widget_values_format);
-        return highchartsRenderer.enabledNewWidgetValueFormatting && (isCustomFormat || !isSecondaryAxis);
+        return !highchartsRenderer.enabledNewWidgetValueFormatting || !highchartsRenderer.isChartWithMultiValues(pivotData) || !isSecondaryAxis || isCustomFormat;
     }
 
     highchartsRenderer.isFormattingAxis = function () {
@@ -9414,6 +9379,16 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         lodash.set(e, 'point.category.userOptions', e.point.initialName.toString().split(highchartsRenderer.delimer));
     }
 
+    highchartsRenderer.getSeriesNameInFormatterContext = function(context) {
+        return ((highchartsRenderer.isFormattingAxis() && lodash.get(context, 'series.userOptions.initialName')) || context.series.name || '') + "";
+    }
+
+    highchartsRenderer.getColsInFormatterContext = function(context) {
+        return lodash.get(context, 'point.options.colsForTotal') 
+            || highchartsRenderer.isFormattingAxis() && (lodash.get(context, 'point.initialName') || lodash.get(context, 'options.initialName'))
+            || context.key;
+    }
+
     return highchartsRenderer;
 };
 

package/tests/highcharts_renderer.test.js

@@ -4741,8 +4741,18 @@ describe('highcharts_renderer', () => {
         });
     });
 
-    describe('function isCustomValuesFormat', () => {
-        const render_options = {
+    describe('function isChartWithMultiValues', () => {
+        it('should return true if DR_Values in attributes', () => {
+            expect(highchartsRenderer.isChartWithMultiValues({ rowAttrs: ['DR_Values'] })).toEqual(true);
+        });
+
+        it('should return false if no DR_Values in attributes', () => {
+            expect(highchartsRenderer.isChartWithMultiValues({ rowAttrs: ['Profit'] })).toEqual(false);
+        });
+    });
+
+    describe('function isUsingWidgetValuesFormat', () => {
+        const renderOptions = {
             comboOptions: {
                 seriesOptions: [
                     { series: 'Profit', format: '#,###', secondaryAxis: false },
@@ -4751,40 +4761,51 @@ describe('highcharts_renderer', () => {
             }
         };
 
-        it('should return true if new widget value formatting is enabled and the format is custom or there is no secondary axis', () => {
-            const widget_values_format = '$####.##';
-
-            highchartsRenderer.enabledNewWidgetValueFormatting = true;
-
-            const expectedValue = true;
-
-            const result = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
+        it('should return true (enable_new_widget_value_formatting !== true, format is not custom, secondary axis present, >1 value fields)', () => {
+            const widgetValuesFormat = '#,###';
+            const pivotData = { rowAttrs: ['DR_Values'] };
+            highchartsRenderer.enabledNewWidgetValueFormatting = false;
 
-            expect(result).toEqual(expectedValue);
+            const result = highchartsRenderer.isUsingWidgetValuesFormat(pivotData, renderOptions, widgetValuesFormat);
+            expect(result).toEqual(true);
         });
 
-        it('should return false if new widget value formatting is disabled', () => {
-            const widget_values_format = '#,###';
-
-            highchartsRenderer.enabledNewWidgetValueFormatting = false;
+        it('should return true (enable_new_widget_value_formatting === true, format is custom, secondary axis present, >1 value fields)', () => {
+            const widgetValuesFormat = '$#,###';
+            const pivotData = { rowAttrs: ['DR_Values'] };
+            highchartsRenderer.enabledNewWidgetValueFormatting = true;
 
-            const expectedValue = false;
+            const result = highchartsRenderer.isUsingWidgetValuesFormat(pivotData, renderOptions, widgetValuesFormat);
+            expect(result).toEqual(true);
+        });
 
-            const result = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
+        it('should return true (enable_new_widget_value_formatting === true, format is not custom, secondary axis not present, >1 value fields)', () => {
+            const widgetValuesFormat = '#,###';
+            const pivotData = { rowAttrs: ['DR_Values'] };
+            highchartsRenderer.enabledNewWidgetValueFormatting = true;
+            const renderOptionsNoSecondary = lodash.cloneDeep(renderOptions);
+            renderOptionsNoSecondary.comboOptions.seriesOptions[1].secondaryAxis = false;
 
-            expect(result).toEqual(expectedValue);
+            const result = highchartsRenderer.isUsingWidgetValuesFormat(pivotData, renderOptionsNoSecondary, widgetValuesFormat);
+            expect(result).toEqual(true);
         });
 
-        it('should return false if the format is not custom and there is a secondary axis', () => {
-            const widget_values_format = '#,###';
-
+        it('should return true (enable_new_widget_value_formatting === true, format is not custom, secondary axis present, 1 value fields)', () => {
+            const widgetValuesFormat = '#,###';
+            const pivotData = { rowAttrs: ['Profit'] };
             highchartsRenderer.enabledNewWidgetValueFormatting = true;
 
-            const expectedValue = false;
+            const result = highchartsRenderer.isUsingWidgetValuesFormat(pivotData, renderOptions, widgetValuesFormat);
+            expect(result).toEqual(true);
+        });
 
-            const result = highchartsRenderer.isCustomValuesFormat(render_options, widget_values_format);
+        it('should return false (enable_new_widget_value_formatting === true, format is not custom, secondary axis present, >1 value fields)', () => {
+            const widgetValuesFormat = '#,###';
+            const pivotData = { rowAttrs: ['DR_Values'] };
+            highchartsRenderer.enabledNewWidgetValueFormatting = true;
 
-            expect(result).toEqual(expectedValue);
+            const result = highchartsRenderer.isUsingWidgetValuesFormat(pivotData, renderOptions, widgetValuesFormat);
+            expect(result).toEqual(false);
         });
     });
 
@@ -5162,4 +5183,117 @@ describe('highcharts_renderer', () => {
             expect(e.point.category.userOptions).toEqual([event.point.initialName]);
         });
     });
+
+    describe('Function getSeriesNameInFormatterContext', () => {
+
+        const name1 = 'test series name';
+        const name2 = 'test series name 2'; 
+
+        it('should return series.userOptions.initialName if it is present and axis formatting is on', () => {
+            lodash.set(document, 'ReportHippo.user.features', ['use_default_table_format_for_axis']);
+            const context = {
+                series: {
+                    userOptions: {
+                        initialName: name1,
+                    },
+                    name: name2,
+                }
+            }
+            expect(highchartsRenderer.getSeriesNameInFormatterContext(context)).toEqual(name1);
+        });
+
+        it('should return series.name if axis formatting is on but series.userOptions.initialName is not present', () => {
+            lodash.set(document, 'ReportHippo.user.features', ['use_default_table_format_for_axis']);
+            const context = {
+                series: {
+                    name: name2,
+                }
+            }
+            expect(highchartsRenderer.getSeriesNameInFormatterContext(context)).toEqual(name2);
+        });
+
+        it('should return series.name if series.userOptions.initialName is present but axis formatting is off', () => {
+            lodash.set(document, 'ReportHippo.user.features', []);
+            const context = {
+                series: {
+                    userOptions: {
+                        initialName: name1,
+                    },
+                    name: name2,
+                }
+            }
+            expect(highchartsRenderer.getSeriesNameInFormatterContext(context)).toEqual(name2);
+        });
+    });
+
+    describe('Function getColsInFormatterContext', () => {
+
+        const name1 = 'test series name 1';
+        const name2 = 'test series name 2'; 
+        const name3 = 'test series name 3'; 
+
+        it('should return point.options.colsForTotal if it is present', () => {
+            const context = {
+                point: {
+                    initialName: name1,
+                    options: {
+                        colsForTotal: name3
+                    }
+                },
+                key: name2,
+            }
+
+            lodash.forEach(['use_default_table_format_for_axis'], [], features => {
+                lodash.set(document, 'ReportHippo.user.features', features);
+                expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name3);
+            });
+        });
+
+        it('should return point.initialName if it is present and FF is on and colsForTotal is not present', () => {
+            lodash.set(document, 'ReportHippo.user.features', ['use_default_table_format_for_axis']);
+            const context = {
+                point: {
+                    initialName: name1,
+                },
+                options: {
+                    initialName: name3,
+                },
+                key: name2,
+            }
+            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name1);
+        });
+
+        it('should return context.key if FF is off and colsForTotal is not present', () => {
+            lodash.set(document, 'ReportHippo.user.features', []);
+            const context = {
+                point: {
+                    initialName: name1,
+                },
+                options: {
+                    initialName: name3,
+                },
+                key: name2,
+            }
+            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name2);
+        });
+
+        it('should return options.initialName if FF is on, colsForTotal is not present and point.initialName is not present', () => {
+            lodash.set(document, 'ReportHippo.user.features', ['use_default_table_format_for_axis']);
+            const context = {
+                options: {
+                    initialName: name3,
+                },
+                key: name2,
+            }
+            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name3);
+        });
+
+        it('should return context.key if FF is on, no colsForTotal a, no point.initialName no options.initialName', () => {
+            lodash.set(document, 'ReportHippo.user.features', ['use_default_table_format_for_axis']);
+            const context = {
+                key: name2,
+            }
+            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name2);
+        });
+    });
 });