@datarailsshared/dr_renderer 1.4.39 → 1.4.42

package/package.json

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

package/src/highcharts_renderer.js

@@ -64,6 +64,7 @@ const CHART_TYPES = {
     GAUGE_CHART_DYNAMIC_GOAL: 'gauge-chart-dynamic-goal',
     GAUGE_CHART_CATEGORIES_SUMMARY: 'gauge-chart-categories-summary',
     KPI_WIDGET: 'kpi-widget',
+    SMART_KPI: 'smart-kpi',
     TEXT_WIDGET: 'text-widget',
     WATERFALL_BREAKDOWN: 'waterfall-chart-breakdown',
     WATERFALL_WALKTHROUGH: 'waterfall-chart-walkthrough',
@@ -6109,6 +6110,12 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         
         if (option) {
             const type = option.category_type;
+
+            const existingOptionValue = lodash.get(existing_options, type);
+            if (!option.elements) {
+                return existingOptionValue || option.default_value;
+            }
+
             lodash.forEach(option.elements, function (elem) {
                 if (existing_options && lodash.has(existing_options, type + '.' + elem.value_name)) {
                     valToReturn[elem.value_name] = lodash.get(existing_options, type + '.' + elem.value_name);
@@ -7593,6 +7600,40 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             ],
             default_value: ''
           }]
+        },
+        gauge_goal: {
+            is_hidden: true,
+            categorys_class: 'google-visualization-charteditor-mini-more',
+            category_label: 'Gauge goal',
+            category_type: 'goal',
+            elements: [
+                {
+                    element_type: 'input',
+                    value_name: 'title',
+                    element_label: 'Goal title',
+                    default_value: 'Goal',
+                },
+                {
+                    element_type: 'input',
+                    value_name: 'value',
+                    element_label: 'Goal value',
+                    default_value: 1000000,
+                },
+            ],
+        },
+        gauge_segments: {
+            is_hidden: true,
+            categorys_class: 'google-visualization-charteditor-mini-more',
+            category_label: 'Gauge segments',
+            category_type: 'segments',
+            default_value: GAUGE_OPTIONS_DEFAULT.segments,
+        },
+        gauge_is_absolute: {
+            is_hidden: true,
+            categorys_class: 'google-visualization-charteditor-mini-more',
+            category_label: 'Gauge is absolute value',
+            category_type: 'isAbsoluteValue',
+            default_value: false,
         }
     };
 
@@ -7826,12 +7867,15 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             axisTooltipTitle: ' Best practice: we recommend no more than one segment.',
             legendTooltipTitle: 'To create a drill-down within this category, drag a field here.',
         },
+
         [highchartsRenderer.CHART_TYPES.GAUGE_CHART_ENHANCED]: {
             name: 'Gauge chart',
             categoryLabel: 'Gauge',
             displayLabelInEditor: highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL),
             label: highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL) ? 'Static goal' : 'Gauge',
-            title: 'Measures progress toward a goal or a KPI.',
+            title: highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL)
+                ? 'Measures progress toward a goal or a KPI.'
+                : 'Track actual performance against targets from your budget or forecast files.',
             axisName: 'X-Axis',
             legendName: 'Data Series',
             startedMessage: 'To get started, drag one field to the value section. Best practice: Drag one field to the filter section, and filter as required.',
@@ -7843,17 +7887,16 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             },
         },
 
-        // TODO: update descriptions if required
         [highchartsRenderer.CHART_TYPES.GAUGE_CHART_DYNAMIC_GOAL]: {
             name: 'Gauge chart with dynamic goal',
             categoryLabel: 'Gauge',
             displayLabelInEditor: true,
             iconType: highchartsRenderer.CHART_TYPES.GAUGE_CHART_ENHANCED,
             label: 'Dynamic goal',
-            title: 'Measures progress toward a goal or a KPI.',
+            title: 'Track actual performance against manually set targets.',
             axisName: 'Goal',
             legendName: 'Data Series',
-            startedMessage: 'To get started, drag one field to the value section. Best practice: Drag one field to the filter section, and filter as required.',
+            startedMessage: 'To get started, drag a field to the Value section and set the Goal with a field that references your planning files (e.g., Scenario or Version Name)',
             categoryContainerSettings: {
                 multiple: false,
                 singleFieldReplacement: true,
@@ -7875,6 +7918,14 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             legendName: 'Data Series',
             startedMessage: '',
         },
+        [highchartsRenderer.CHART_TYPES.SMART_KPI]: {
+            name: 'Smart Kpi',
+            label: 'Smart KPI',
+            title: 'Present a single Key Performance Indicator.',
+            axisName: 'X-Axis',
+            legendName: 'Data Series',
+            startedMessage: 'To get started, drag one field to the value section. Best practice: Drag one field to the filter section, and filter as required.',
+        },
         'kpi-widget': {
             name: 'Kpi ',
             label: 'KPI',
@@ -8285,6 +8336,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                             highchartsRenderer.suboptions["subtitle"],
                             highchartsRenderer.suboptions["table_options_gauge"],
                             highchartsRenderer.suboptions["table_design_options"],
+                            highchartsRenderer.suboptions["gauge_goal"],
+                            highchartsRenderer.suboptions["gauge_segments"],
+                            highchartsRenderer.suboptions["gauge_is_absolute"],
                         ]
                     },
                     {
@@ -8298,6 +8352,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                             highchartsRenderer.suboptions["subtitle"],
                             highchartsRenderer.suboptions["table_options_gauge"],
                             highchartsRenderer.suboptions["table_design_options"],
+                            highchartsRenderer.suboptions["gauge_goal"],
+                            highchartsRenderer.suboptions["gauge_segments"],
+                            highchartsRenderer.suboptions["gauge_is_absolute"],
                         ],
                         hidden: !highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL),
                     },
@@ -8341,6 +8398,23 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                         highchartsRenderer.suboptions["negative_number_format"],
                         highchartsRenderer.suboptions["legends"],
                     ]
+                },
+                {
+                    type: 'smart-kpi',
+                    hidden: true,
+                    name: highchartsRenderer.chartsTypesInfo['smart-kpi'].name,
+                    class: 'google-visualization-charteditor-thumbs-kpi',
+                    render: () => { throw new Error('Smart KPI widget is not implemented yet'); },
+                    suboptions: [
+                        highchartsRenderer.suboptions["value"],
+                        highchartsRenderer.suboptions["range"],
+                        highchartsRenderer.suboptions["widget_library"],
+                        highchartsRenderer.suboptions["name"],
+                        highchartsRenderer.suboptions["table_options_transpose"],
+                        highchartsRenderer.suboptions["table_design_options"],
+                        highchartsRenderer.suboptions["negative_number_format"],
+                        highchartsRenderer.suboptions["legends"],
+                    ]
                 }]
             },
             {