@datarailsshared/dr_renderer 1.2.334 → 1.2.337

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datarailsshared/dr_renderer",
-  "version": "1.2.334",
+  "version": "1.2.337",
   "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);
@@ -9376,9 +9376,20 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
         e.point = lodash.cloneDeep(e.point);
         e.point.name = e.point.initialName;
+        e.point.series.name = lodash.get(e.point.series, 'userOptions.initialName', e.point.series.name);
         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

@@ -5158,6 +5158,12 @@ describe('highcharts_renderer', () => {
                 category: {
                     userOptions: ['key4'],
                 },
+                series: {
+                    name: 'key5',
+                    userOptions: {
+                        initialName: 'key6',
+                    }
+                }
             }
         };
 
@@ -5171,6 +5177,7 @@ describe('highcharts_renderer', () => {
 
             highchartsRenderer.modifyEventPointForDrilldown(e);
             expect(e.point.name).toEqual(event.point.name);
+            expect(e.point.series.name).toEqual(event.point.series.name);
             expect(e.point.category.userOptions).toEqual(event.point.category.userOptions);
         });
 
@@ -5180,7 +5187,121 @@ describe('highcharts_renderer', () => {
 
             highchartsRenderer.modifyEventPointForDrilldown(e);
             expect(e.point.name).toEqual(event.point.initialName);
+            expect(e.point.series.name).toEqual(event.point.series.userOptions.initialName);
             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);
+        });
+    });
 });