@datarailsshared/dr_renderer 1.2.335 → 1.2.339

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datarailsshared/dr_renderer",
-  "version": "1.2.335",
+  "version": "1.2.339",
   "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 = highchartsRenderer.getSeriesNameInFormatterContext(this);
+                let series_name = highchartsRenderer.getSeriesNameInFormatterContext(this, pivotData);
                 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 = highchartsRenderer.getColsInFormatterContext(this);
+                var cols = highchartsRenderer.getColsInFormatterContext(this, pivotData);
                 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 = highchartsRenderer.getSeriesNameInFormatterContext(this);
+                let series_name = highchartsRenderer.getSeriesNameInFormatterContext(this, pivotData);
                 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 = highchartsRenderer.getColsInFormatterContext(this);
+                var cols = highchartsRenderer.getColsInFormatterContext(this, pivotData);
                 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]
-                            : highchartsRenderer.isFormattingAxis() && lodash.get(this, 'point.name') || cols
+                            : highchartsRenderer.isFormattingAxis(pivotData) && lodash.get(this, 'point.name') || cols
                     );
 
                     highchartsRenderer.replaceDrOthersKeys(cols, rows, drOthersInAxis, othersName);
@@ -3009,7 +3009,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             zoomType: additionOptions && additionOptions.chart && additionOptions.chart.zoom_type ? additionOptions.chart.zoom_type : 'None',
             events: {
                 'drilldown': function (e) {
-                    highchartsRenderer.modifyEventPointForDrilldown(e);
+                    highchartsRenderer.modifyEventPointForDrilldown(e, pivotData);
                     if (drilldownFunc)
                         drilldownFunc(e, this, "drilldown");
 
@@ -3128,7 +3128,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             zoomType: 'x',
             events: {
                 'drilldown': function (e) {
-                    highchartsRenderer.modifyEventPointForDrilldown(e);
+                    highchartsRenderer.modifyEventPointForDrilldown(e, pivotData);
                     if (drilldownFunc)
                         drilldownFunc(e, this, "drilldown");
 
@@ -3286,7 +3286,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             type: 'column',
             events: {
                 'drilldown': function (e) {
-                    highchartsRenderer.modifyEventPointForDrilldown(e);
+                    highchartsRenderer.modifyEventPointForDrilldown(e, pivotData);
                     if (drilldownFunc)
                         drilldownFunc(e, this, "drilldown");
 
@@ -5930,7 +5930,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     opt = {};
                 }
                 opt.drillDownListFunc = (e) => {
-                    highchartsRenderer.modifyEventPointForDrilldown(e);
+                    highchartsRenderer.modifyEventPointForDrilldown(e, pivotData);
                     drillDownListFunc(e);
                 };
                 opt.insightsTooltipFunc = insightsTooltipFunc;
@@ -9323,15 +9323,15 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return !highchartsRenderer.enabledNewWidgetValueFormatting || !highchartsRenderer.isChartWithMultiValues(pivotData) || !isSecondaryAxis || isCustomFormat;
     }
 
-    highchartsRenderer.isFormattingAxis = function () {
-        return lodash.includes(lodash.get(document, 'ReportHippo.user.features', []), FEATURES.FORMAT_AXIS);
+    highchartsRenderer.isFormattingAxis = function (pivotData) {
+        return lodash.includes(lodash.get(document, 'ReportHippo.user.features', []), FEATURES.FORMAT_AXIS) && pivotData.isFormattingAxisLabels;
     }
 
     // Method for getting formatted kyes for Axis (cols, rows)
     // TODO: Move here dates formatting from highchartsRenderer.getWidgetDataSorters. Ticket created: DR-22009
     highchartsRenderer.getFormattedKey = function (initialKey, pivotData, type) {
         const isFlatKey = lodash.isString(initialKey) || lodash.isNumber(initialKey);
-        if (highchartsRenderer.isFormattingAxis() && (isFlatKey || lodash.isArray(initialKey))) {
+        if (highchartsRenderer.isFormattingAxis(pivotData) && (isFlatKey || lodash.isArray(initialKey))) {
             let values = isFlatKey ? initialKey.toString().split(highchartsRenderer.delimer) : lodash.cloneDeep(initialKey);
             if (values) {
                 lodash.forEach(values, (value, key) => {
@@ -9357,7 +9357,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
     highchartsRenderer.getFormattedKeys = function(pivotData, isCols, keys) {
         keys = keys || (isCols ? pivotData.getColKeys() : pivotData.getRowKeys());
-        return highchartsRenderer.isFormattingAxis()
+        return highchartsRenderer.isFormattingAxis(pivotData)
             ? lodash.map(keys, key => highchartsRenderer.getFormattedKey(key, pivotData, isCols ? 'colFormats' : 'rowFormats'))
             : keys;
     }
@@ -9370,22 +9370,23 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return highchartsRenderer.getFormattedKeys(pivotData, false, keys);
     }
 
-    highchartsRenderer.modifyEventPointForDrilldown = function(e) {
-        if (!highchartsRenderer.isFormattingAxis()) {
+    highchartsRenderer.modifyEventPointForDrilldown = function(e, pivotData) {
+        if (!highchartsRenderer.isFormattingAxis(pivotData)) {
             return;
         }
         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.getSeriesNameInFormatterContext = function(context, pivotData) {
+        return ((highchartsRenderer.isFormattingAxis(pivotData) && lodash.get(context, 'series.userOptions.initialName')) || context.series.name || '') + "";
     }
 
-    highchartsRenderer.getColsInFormatterContext = function(context) {
+    highchartsRenderer.getColsInFormatterContext = function(context, pivotData) {
         return lodash.get(context, 'point.options.colsForTotal') 
-            || highchartsRenderer.isFormattingAxis() && (lodash.get(context, 'point.initialName') || lodash.get(context, 'options.initialName'))
+            || highchartsRenderer.isFormattingAxis(pivotData) && (lodash.get(context, 'point.initialName') || lodash.get(context, 'options.initialName'))
             || context.key;
     }
 

package/src/pivottable.js

@@ -696,6 +696,7 @@ let initPivotTable = function($, window, document) {
             this.sortByValueAttrs = opts.sortByValueAttrs || [];
             this.colFormats = opts.colFormats || [];
             this.rowFormats = opts.rowFormats || [];
+            this.isFormattingAxisLabels = opts.rendererOptions && opts.rendererOptions.isFormattingAxisLabels;
             this.getFormattedColKeys = (keys) => opts.getFormattedColKeys(this, keys);
             this.getFormattedRowKeys = (keys) => opts.getFormattedRowKeys(this, keys);
 

package/tests/highcharts_renderer.test.js

@@ -4842,13 +4842,21 @@ describe('highcharts_renderer', () => {
 
     describe('Function isFormattingAxis', () => {
         it('should return true if FF is true', () => {
+            const pivotData = { isFormattingAxisLabels: true };
             lodash.set(document, 'ReportHippo.user.features', ['use_default_table_format_for_axis']);
-            expect(highchartsRenderer.isFormattingAxis()).toEqual(true);
+            expect(highchartsRenderer.isFormattingAxis(pivotData)).toEqual(true);
         });
 
         it('should return false if FF is false', () => {
+            const pivotData = { isFormattingAxisLabels: true };
             lodash.set(document, 'ReportHippo.user.features', []);
-            expect(highchartsRenderer.isFormattingAxis()).toEqual(false);
+            expect(highchartsRenderer.isFormattingAxis(pivotData)).toEqual(false);
+        });
+
+        it('should return false if FF is true but isFormattingAxisLabels for chart is false', () => {
+            const pivotData = { isFormattingAxisLabels: false };
+            lodash.set(document, 'ReportHippo.user.features', []);
+            expect(highchartsRenderer.isFormattingAxis(pivotData)).toEqual(false);
         });
     });
 
@@ -4863,6 +4871,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
                     rowFormats: ['€####.##', '£####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4874,6 +4883,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['€####.##', '£####.##'],
                     rowFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'rowFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4885,6 +4895,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
                     rowFormats: ['€####.##', '£####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4896,6 +4907,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['€####.##', '£####.##'],
                     rowFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'rowFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4906,6 +4918,7 @@ describe('highcharts_renderer', () => {
                 const initialKey = '1000 , 2000';
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4916,6 +4929,7 @@ describe('highcharts_renderer', () => {
                 const initialKey = ['1000', '2000'];
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4926,6 +4940,7 @@ describe('highcharts_renderer', () => {
                 const initialKey = ['1000', '2000'];
                 const pivotData = {
                     colFormats: ['$####.##', null],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4936,6 +4951,7 @@ describe('highcharts_renderer', () => {
                 const initialKey = ['1000', '2000'];
                 const pivotData = {
                     colFormats: [null, '$####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4953,6 +4969,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
                     rowFormats: ['€####.##', '£####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type,);
@@ -4964,6 +4981,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['€####.##', '£####.##'],
                     rowFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'rowFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4975,6 +4993,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
                     rowFormats: ['€####.##', '£####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4986,6 +5005,7 @@ describe('highcharts_renderer', () => {
                 const pivotData = {
                     colFormats: ['€####.##', '£####.##'],
                     rowFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'rowFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -4996,6 +5016,7 @@ describe('highcharts_renderer', () => {
                 const initialKey = '1000 , 2000';
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -5006,6 +5027,7 @@ describe('highcharts_renderer', () => {
                 const initialKey = ['1000', '2000'];
                 const pivotData = {
                     colFormats: ['$####.##', '₪####.##'],
+                    isFormattingAxisLabels: true,
                 };
                 const type = 'colFormats';
                 const formattedKey = highchartsRenderer.getFormattedKey(initialKey, pivotData, type);
@@ -5036,6 +5058,7 @@ describe('highcharts_renderer', () => {
         const pivotData = {
             getColKeys: () => testKeys,
             getRowKeys: () => testKeys,
+            isFormattingAxisLabels: true,
         };
 
         beforeEach(() => {
@@ -5158,9 +5181,19 @@ describe('highcharts_renderer', () => {
                 category: {
                     userOptions: ['key4'],
                 },
+                series: {
+                    name: 'key5',
+                    userOptions: {
+                        initialName: 'key6',
+                    }
+                }
             }
         };
 
+        const pivotData = {
+            isFormattingAxisLabels: true,
+        };
+
         beforeEach(() => {
             spyOn(highchartsRenderer, 'getFormattedKeys').and.returnValue(null);
         });
@@ -5169,8 +5202,9 @@ describe('highcharts_renderer', () => {
             const e = lodash.cloneDeep(event);
             lodash.set(document, 'ReportHippo.user.features', []);
 
-            highchartsRenderer.modifyEventPointForDrilldown(e);
+            highchartsRenderer.modifyEventPointForDrilldown(e, pivotData);
             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);
         });
 
@@ -5178,8 +5212,9 @@ describe('highcharts_renderer', () => {
             const e = lodash.cloneDeep(event);
             lodash.set(document, 'ReportHippo.user.features', ['use_default_table_format_for_axis']);
 
-            highchartsRenderer.modifyEventPointForDrilldown(e);
+            highchartsRenderer.modifyEventPointForDrilldown(e, pivotData);
             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]);
         });
     });
@@ -5189,6 +5224,10 @@ describe('highcharts_renderer', () => {
         const name1 = 'test series name';
         const name2 = 'test series name 2'; 
 
+        const pivotData = {
+            isFormattingAxisLabels: true,
+        };
+
         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 = {
@@ -5199,7 +5238,7 @@ describe('highcharts_renderer', () => {
                     name: name2,
                 }
             }
-            expect(highchartsRenderer.getSeriesNameInFormatterContext(context)).toEqual(name1);
+            expect(highchartsRenderer.getSeriesNameInFormatterContext(context, pivotData)).toEqual(name1);
         });
 
         it('should return series.name if axis formatting is on but series.userOptions.initialName is not present', () => {
@@ -5209,7 +5248,7 @@ describe('highcharts_renderer', () => {
                     name: name2,
                 }
             }
-            expect(highchartsRenderer.getSeriesNameInFormatterContext(context)).toEqual(name2);
+            expect(highchartsRenderer.getSeriesNameInFormatterContext(context, pivotData)).toEqual(name2);
         });
 
         it('should return series.name if series.userOptions.initialName is present but axis formatting is off', () => {
@@ -5222,7 +5261,7 @@ describe('highcharts_renderer', () => {
                     name: name2,
                 }
             }
-            expect(highchartsRenderer.getSeriesNameInFormatterContext(context)).toEqual(name2);
+            expect(highchartsRenderer.getSeriesNameInFormatterContext(context, pivotData)).toEqual(name2);
         });
     });
 
@@ -5230,7 +5269,10 @@ describe('highcharts_renderer', () => {
 
         const name1 = 'test series name 1';
         const name2 = 'test series name 2'; 
-        const name3 = 'test series name 3'; 
+        const name3 = 'test series name 3';
+        const pivotData = {
+            isFormattingAxisLabels: true,
+        };
 
         it('should return point.options.colsForTotal if it is present', () => {
             const context = {
@@ -5245,7 +5287,7 @@ describe('highcharts_renderer', () => {
 
             lodash.forEach(['use_default_table_format_for_axis'], [], features => {
                 lodash.set(document, 'ReportHippo.user.features', features);
-                expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name3);
+                expect(highchartsRenderer.getColsInFormatterContext(context, pivotData)).toEqual(name3);
             });
         });
 
@@ -5260,7 +5302,7 @@ describe('highcharts_renderer', () => {
                 },
                 key: name2,
             }
-            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name1);
+            expect(highchartsRenderer.getColsInFormatterContext(context, pivotData)).toEqual(name1);
         });
 
         it('should return context.key if FF is off and colsForTotal is not present', () => {
@@ -5273,8 +5315,8 @@ describe('highcharts_renderer', () => {
                     initialName: name3,
                 },
                 key: name2,
-            }
-            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name2);
+            };
+            expect(highchartsRenderer.getColsInFormatterContext(context, pivotData)).toEqual(name2);
         });
 
         it('should return options.initialName if FF is on, colsForTotal is not present and point.initialName is not present', () => {
@@ -5285,7 +5327,7 @@ describe('highcharts_renderer', () => {
                 },
                 key: name2,
             }
-            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name3);
+            expect(highchartsRenderer.getColsInFormatterContext(context, pivotData)).toEqual(name3);
         });
 
         it('should return context.key if FF is on, no colsForTotal a, no point.initialName no options.initialName', () => {
@@ -5293,7 +5335,7 @@ describe('highcharts_renderer', () => {
             const context = {
                 key: name2,
             }
-            expect(highchartsRenderer.getColsInFormatterContext(context)).toEqual(name2);
+            expect(highchartsRenderer.getColsInFormatterContext(context, pivotData)).toEqual(name2);
         });
     });
 });