@datarailsshared/dr_renderer 1.2.48 → 1.2.49

package/package.json

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

package/src/dr_pivottable.js

@@ -385,12 +385,13 @@ let initDRPivotTable = function($, window, document) {
                 pvtData.colKeys = [];
                 tooMuch = true;
                 opts.error_has_occurred = true;
+                opts.error_params = $.pivotUtilities.errorHandling.placeholders.tooMuchData;
             }
-            return SubtotalRenderer(pvtData, opts, charttype, tooMuch);
+            return SubtotalRenderer(pvtData, opts, charttype, tooMuch, opts.error_params);
         }
     }
 
-    SubtotalRenderer = function(pivotData, opts, charttype, tooMuch = false) {
+    SubtotalRenderer = function(pivotData, opts, charttype, tooMuch = false, error_params) {
         var addClass, allTotal, arrowCollapsed, arrowExpanded, buildColHeaderHeader, buildColHeaderHeaders, buildColHeaderHeadersClickEvents, buildColHeaders, buildColTotals, buildColTotalsHeader, buildGrandTotal, buildRowHeaderHeaders, buildRowHeaderHeadersClickEvents, buildRowHeaders, buildRowTotalsHeader, buildValues, classColCollapsed, classColExpanded, classColHide, classColShow, classCollapsed, classExpanded, classRowCollapsed, classRowExpanded, classRowHide, classRowShow, clickStatusCollapsed, clickStatusExpanded, colAttrs, colDisableAfter, colKeys, colTotals, collapseCol, collapseColsAt, collapseHideDescendantRow, collapseRow, collapseRowsAt, collapseShowColSubtotal, collapseShowRowSubtotal, createElement, defaults, expandChildCol, expandChildRow, expandCol, expandColsAt, expandHideColSubtotal, expandHideRowSubtotal, expandRow, expandRowsAt, expandShowColSubtotal, expandShowRowSubtotal, getTableEventHandlers, hasClass, hideDescendantCol, isColDisable, isColDisableExpandCollapse, isColHideOnExpand, isRowDisable, isRowDisableExpandCollapse, isRowHideOnExpand, main, getSubtotalInBrackets, processKeys, encodeHtmlEntities, ref, ref1, ref2, ref3, ref4, ref5, ref6, ref7, removeClass, replaceClass, rowAttrs, rowDisableAfter, rowKeys, rowTotals, setAttributes, showChildCol, showChildRow, toggleCol, toggleColHeaderHeader, toggleRow, toggleRowHeaderHeader, tree, assumptionSubscribe;
         var createTotalValsBolder, createGrandTotalBolder, getHeaderColorProperties, colorizeRowLabelHeaders, colorizeTableIfNeed, valueNoDashes, getColorsWithOffsetForTable, offsetColors, handleFreezePanesScroll, selectFreezableElements, removeRowHeaderNullValue;
         var edit_assumptions;
@@ -2133,7 +2134,9 @@ let initDRPivotTable = function($, window, document) {
             }
 
             if (tooMuch) {
-                resultsArr.push($('<div class="noData"><i class="fa fa-info"></i> There are too many rows to display in the table.<br>Please filter or change the table type in options.</div>'));
+                const defaultPlaceholder = $('<div class="noData"><i class="fa fa-info"></i> There are too many rows to display in the table.<br>Please filter or change the table type in options.</div>');
+
+                resultsArr.push($.pivotUtilities.errorHandling.getErrorPlaceholder(error_params, useNewUx) || defaultPlaceholder);
             } else {
                 var tableContainer = document.createElement("div");
                 tableContainer.className = "pivot-div";

package/src/highcharts_renderer.js

@@ -721,9 +721,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
 
         if (to_match) {
-            resultsArr.push($('<div class="noData"><i class="' + (useNewUx ? 'noData-image' : 'fa fa-info') + '"></i> Too much data to show</div>'));
+            resultsArr.push(highchartsRenderer.getWidgetPlaceholder(highchartsRenderer.widgetPlaceholders.tooMuchData));
         } else {
-            resultsArr.push($('<div class="noData"><i class="' + (useNewUx ? 'noData-image' : 'fa fa-info') + '"></i> no data</div>'));
+            resultsArr.push(highchartsRenderer.getWidgetPlaceholder(highchartsRenderer.widgetPlaceholders.nodata));
         }
 
         temp_result.html(resultsArr);
@@ -731,6 +731,11 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return temp_result;
     };
 
+    highchartsRenderer.getWidgetPlaceholder = function(placeholder) {
+        const defaultPlaceholder = $('<div class="noData"><i class="' + (useNewUx ? 'noData-image' : 'fa fa-info') + '"></i> no data</div>');
+        return $.pivotUtilities.errorHandling.getErrorPlaceholder(placeholder, useNewUx) || defaultPlaceholder;
+    }
+
     highchartsRenderer.ptCreateElementAndDraw = function (chartOptions, opts) {
         if (lodash.get(opts, 'paletteOptions.widgetPalette', null)) {
             const mc_palette = lodash.find(lodash.get(opts.paletteOptions, 'monochromePalettes', []), { selected: true });
@@ -820,9 +825,12 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
 
         if (!seriesDataLength && !chartOptions.onlyText) {
             result = highchartsRenderer.getNoDataResult(chartOptions);
+            opts.error_has_occurred = true;
+            opts.error_params = highchartsRenderer.widgetPlaceholders.nodata;
         } else if (!chartOptions.onlyText && chartOptions.series && toMatch) {
             result = highchartsRenderer.getNoDataResult(chartOptions, toMatch);
             opts.error_has_occurred = true;
+            opts.error_params = highchartsRenderer.widgetPlaceholders.tooMuchData;
         } else {
             chartOptions = highchartsRenderer.updateChartOptions(chartOptions, opts);
             chartOptions = highchartsRenderer.updateChartOptions(chartOptions, {credits: {enabled: false}});
@@ -3777,6 +3785,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 return {};
             }
 
+            options.error_has_occurred = true;
+            options.error_params = highchartsRenderer.widgetPlaceholders.nodata;
             return highchartsRenderer.getNoDataResult(options.rendererOptions);
         }
 
@@ -3785,6 +3795,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 return {};
             }
 
+            options.error_has_occurred = true;
+            options.error_params = highchartsRenderer.widgetPlaceholders.tooMuchData;
             return highchartsRenderer.getNoDataResult(options.rendererOptions, true);
         }
 
@@ -4703,6 +4715,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return valToReturn;
     };
 
+    highchartsRenderer.widgetPlaceholders = Object.assign({}, $.pivotUtilities.errorHandling.placeholders);
+
     highchartsRenderer.suboptions = {
         'default_show': {
             category_class: 'google-visualization-charteditor-mini-more',

package/src/pivottable.js

@@ -7,7 +7,7 @@ let initPivotTable = function($, window, document) {
     /*
     Utilities
      */
-    var PivotData, addSeparators, aggregatorTemplates, aggregators, dayNamesEn, derivers, getSort, locales, mthNamesEn, naturalSort, numberFormat, pivotTableRenderer, rd, renderers, rx, rz, sortAs, usFmt, usFmtInt, usFmtPct, zeroPad;
+    var PivotData, addSeparators, aggregatorTemplates, aggregators, dayNamesEn, derivers, getSort, locales, mthNamesEn, naturalSort, numberFormat, pivotTableRenderer, rd, renderers, rx, rz, sortAs, usFmt, usFmtInt, usFmtPct, zeroPad, errorHandling;
     addSeparators = function(nStr, thousandsSep, decimalSep) {
         var rgx, x, x1, x2;
         nStr += '';
@@ -610,6 +610,47 @@ let initPivotTable = function($, window, document) {
         }
         return naturalSort;
     };
+    errorHandling = {
+        placeholders: {
+            nodata: {
+                title: 'No Data Available',
+                text: 'This might happen because of a global filter or a change in the underlying data',
+                btnText: '',
+                class: 'nodata',
+            },
+            noPermission: {
+                title: 'No Permission',
+                text: 'You do not have permission to view the data',
+                btnText: 'Request Permission',
+                class: 'no-permission',
+            },
+            tooMuchData: {
+                title: 'There is too much data. Please edit this widget',
+                text: '',
+                btnText: 'Edit Widget',
+                class: 'too-much-data',
+            },
+            noPublishItem: {
+                title: 'We can’t find the published item in the source file',
+                text: '',
+                btnText: 'Go to filebox',
+                class: 'no-publish-item',
+            },
+        },
+        getErrorPlaceholder: function(placeholder, useNewUx = true) {
+            if (placeholder && typeof placeholder === 'object') {
+                return $(`
+                    <div class="noData">
+                        <div class="noData-title">${placeholder.title}</div>
+                        <i class="noData-image ${useNewUx ? placeholder.class : 'fa fa-info'}"></i>
+                        <div class="noData-text">${placeholder.text}</div>
+                        <div class="noData-error-action"></div>
+                    </div>
+                `);
+            }
+            return null;
+        },
+    };
 
     /*
     Data Model class
@@ -890,7 +931,8 @@ let initPivotTable = function($, window, document) {
         naturalSort: naturalSort,
         numberFormat: numberFormat,
         sortAs: sortAs,
-        PivotData: PivotData
+        PivotData: PivotData,
+        errorHandling: errorHandling,
     };
 
     /*