@datarailsshared/dr_renderer 1.4.40 → 1.4.44

package/package.json

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

package/src/charts/dr_gauge_chart.js

@@ -141,9 +141,11 @@ function DrGaugeChart(pivotData, opts, isDynamicGoal) {
         const goalValue = isGoal
             ? `<span style="font-size: 1.125em; color: ${options.gauge.colors.goal};">${formattedValue}</span>`
             : `<span style="color: ${options.label.font_color};">${formattedValue}</span>`;
+
+        const goalTitleText = DrGaugeChart.getGoalTitleText(options);
         const goalTitle =
-            isGoal && options.label.show_goal_name && options.goal.title
-                ? `<span style="font-size: 0.75em; color: ${options.gauge.colors.goal};">${options.goal.title}</span>`
+            isGoal && options.label.show_goal_name && goalTitleText
+                ? `<span style="font-size: 0.75em; color: ${options.gauge.colors.goal};">${goalTitleText}</span>`
                 : "";
         const percentage = options.label.show_percentage_in_segments
             ? `<span style="font-size: 0.75em; color: ${options.gauge.colors.meta}; font-weight: 400;">(${this.toPercent(
@@ -376,7 +378,7 @@ function DrGaugeChart(pivotData, opts, isDynamicGoal) {
             // goal tooltip if lebels are hidden
             if (tick.pos === options.goal.value && !options.label.show) {
                 drTooltip.add(
-                    `${options.label.show_goal_name ? options.goal.title || "" : ""
+                    `${options.label.show_goal_name ? DrGaugeChart.getGoalTitleText(options) || "" : ""
                     }<span style="font-weight: 600">${this.formatValue(options.goal.value)}</span>`,
                     chart.goalIcon.element,
                     {
@@ -470,7 +472,7 @@ function DrGaugeChart(pivotData, opts, isDynamicGoal) {
     this.setGoal = function (pivotData, opts) {
         if (isDynamicGoal) {
             this.options.goal = {
-                title: this.options.goal.title,
+                title: DrGaugeChart.getGoalTitleText(this.options),
                 value: DrGaugeChart.getValue(pivotData, opts, true, true),
             };
         }
@@ -703,6 +705,12 @@ DrGaugeChart.getValue = function (pivotData, opts, isDynamicGoal = false, isForG
     return aggregator.value();
 };
 
+DrGaugeChart.getGoalTitleText = function(options) {
+    return DrGaugeChart.dynamicGoalFeatureEnabled()
+        ? _.get(options, 'label.goal_name') || options.goal.title
+        : options.goal.title;
+}
+
 DrGaugeChart.dynamicGoalFeatureEnabled = function() {
     return DrGaugeChart.highchartsRenderer.hasFeature(helpers.FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL);
 }

package/src/highcharts_renderer.js

@@ -6110,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);
@@ -6969,12 +6975,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 {
                     element_type: 'devider',
                 },
-                {
-                    element_type: 'checkbox',
-                    element_label: 'Goal name',
-                    value_name: 'show_goal_name',
-                    default_value: true,
-                },
                 {
                     element_type: 'checkbox',
                     element_label: 'Value % out of Goal',
@@ -6987,6 +6987,20 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     value_name: 'show_percentage_in_segments',
                     default_value: false,
                 },
+                {
+                    element_type: 'checkbox',
+                    element_label: 'Show Goal label',
+                    value_name: 'show_goal_name',
+                    default_value: true,
+                },
+                {
+                    element_type: 'input',
+                    show_in_one_row: true,
+                    element_label: 'Goal name',
+                    value_name: 'goal_name',
+                    default_value: 'Goal',
+                    hidden: !highchartsRenderer.hasFeature(FEATURES.ENABLE_GAUGE_DYNAMIC_GOAL),
+                },
             ]
         },
         'label_with_percentage': {
@@ -7594,6 +7608,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,
         }
     };
 
@@ -7827,12 +7875,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.',
@@ -7844,17 +7895,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,
@@ -8294,6 +8344,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"],
                         ]
                     },
                     {
@@ -8307,6 +8360,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),
                     },