@datarailsshared/dr_renderer 1.3.39 → 1.3.41

package/package.json

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

package/src/highcharts_renderer.js

@@ -406,6 +406,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         if (!type) return null;
         return [
             'line',
+            'line-chart-forecast',
             'spline',
             'area',
             'areaspline',
@@ -1419,14 +1420,18 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         
         const chartType = chartOptions && chartOptions.chart && chartOptions.chart.type ? chartOptions.chart.type : null;
         const smartQuerySeries = isChartTypeSupportedForSmartQuery(chartType)
-            ? smartQueriesHelper.createSingleDataSeriesForForecast(chart_series, opts.chartOptions)
+            ? smartQueriesHelper.createSingleDataSeriesForForecast(chart_series, opts.chartOptions, pivotData)
             : null;
 
         if (smartQuerySeries) {
-            chart_series.push(smartQuerySeries);
-            lodash.remove(chart_series, s => 
+            if (chart_series.length > 1) {
+                lodash.remove(chart_series, s => 
                 (s.name && lodash.includes(s.name, 'SQ_Actuals')) || s.name === 'Forecast'
-            );
+                );
+            } else {
+                chart_series = []
+            }
+            chart_series.push(smartQuerySeries);
         }
 
         return chart_series;
@@ -6657,7 +6662,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             },
             {
                 element_type: 'toggle',
-                element_label: 'Smart Queries',
+                element_label: 'Forecast Chart',
                 value_name: 'smart_query',
                 default_value: true,
                 showFn: isChartTypeSupportedForSmartQuery
@@ -7660,6 +7665,17 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             axisTooltipTitle: 'Drag one or more fields here to create your x-axis.',
             legendTooltipTitle: 'Adding a field in this section will display lines for each item in that field.',
         },
+        'line-chart-forecast': {
+            name: 'Combined Line',
+            label: 'Combined Line',
+            title: 'Show forecast over time.',
+            description: 'For example, see how your Monthly Revenue evolves over a given period.',
+            axisName: 'X - Axis',
+            legendName: 'Data series',
+            startedMessage: '“To get started, drag the Reporting Month field to the x-axis, include the Scenario Cycle field in the data series, and add one field to the value section.”',
+            axisTooltipTitle: 'Drag one or more fields here to create your x-axis.',
+            legendTooltipTitle: 'Adding a field in this section will display lines for each item in that field.',
+        },
         'scatter-chart': {
             name: 'Scatter chart',
             label: 'Scatter Chart',
@@ -7853,6 +7869,27 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                             highchartsRenderer.suboptions["legends"],
                         ]
                     },
+                    {
+                        type: 'line-chart-forecast',
+                        name: highchartsRenderer.chartsTypesInfo['line-chart-forecast'].name,
+                        class: 'google-visualization-charteditor-thumbs-linechart-forecast',
+                        render: highchartsRenderer.ptRenderSpLine,
+                        suboptions: [
+                            highchartsRenderer.suboptions["axisY"],
+                            highchartsRenderer.suboptions["axisX"],
+                            highchartsRenderer.suboptions["tooltips"],
+                            highchartsRenderer.suboptions["label"],
+                            highchartsRenderer.suboptions["subtitle"],
+                            highchartsRenderer.suboptions["widget_library"],
+                            highchartsRenderer.suboptions["table_options_transpose"],
+                            highchartsRenderer.suboptions["table_design_options"],
+                            highchartsRenderer.suboptions["chart_grid"],
+                            highchartsRenderer.suboptions["negative_number_format"],
+                            highchartsRenderer.suboptions["delta_column"],
+                            highchartsRenderer.suboptions["advanced"],
+                            highchartsRenderer.suboptions["legends"],
+                        ]
+                    },
                     {
                         type: 'scatter-chart',
                         name: highchartsRenderer.chartsTypesInfo['scatter-chart'].name,
@@ -9880,9 +9917,8 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         const initialNameForSmartQueries = seriesData 
             ? lodash.find(seriesData, obj => obj.name === e.point.name)
             : null;
-        
         if (initialNameForSmartQueries && initialNameForSmartQueries.type) {
-            e.point.series.name = initialNameForSmartQueries.type;
+            e.point.series.name = initialNameForSmartQueries.type === "SQ_Actuals" ? 'Actuals' : 'Forecast';
         }
         lodash.set(e, 'point.category.userOptions', e.point.initialName.toString().split(highchartsRenderer.delimer));
     }

package/src/smart_queries_helper.js

@@ -1,16 +1,49 @@
 const lodash = require('lodash');
 
-function createSingleDataSeriesForForecast(chart_series, chartOptions) {
+function createSingleDataSeriesForForecast(chart_series, chartOptions, pivotData) {
   const { actuals, forecast, smart_query } = chartOptions.chart;
+  const input = pivotData.input;
 
-  const seriesA = lodash.find(chart_series, function(s) {
-    return s.name && lodash.includes(s.name, 'SQ_Actuals');
-  });
-  const seriesB = lodash.find(chart_series, function(s) {
-    return s.name && lodash.includes(s.name, 'Forecast');
-  });
+  const hasSQActuals = input.some(item => item.Scenario && item.Scenario.indexOf('SQ_Actuals') !== -1);
+  if (!smart_query || !hasSQActuals) return null;
+
+  const midMonthOffset = 0.5
+  return chart_series.length === 1
+    ? buildChartSeriesFromPivotInputOnly(input, actuals, forecast, midMonthOffset)
+    : buildChartSeriesFromSeries(chart_series, actuals, forecast, midMonthOffset);
+}
+
+function buildChartSeriesFromPivotInputOnly(input, actuals, forecast, midMonthOffset) {
+  const filtered = input.filter(item =>
+    (item.Scenario === 'SQ_Actuals' || item.Scenario === 'Forecast') &&
+    item.Amount !== 0
+  );
+
+  const data = filtered.map(item => ({
+    y: item.Amount,
+    name: item.Reporting_Month,
+    initialName: item.Reporting_Month,
+    type: item.Scenario,
+  })).sort((a, b) => new Date(a.name) - new Date(b.name));
+
+  const sqCount = input.filter(item => item.Scenario === 'SQ_Actuals').length;
+
+  return {
+    name: "Forecast Smart Query",
+    data,
+    zoneAxis: "x",
+    zones: [
+      { value: sqCount - midMonthOffset, dashStyle: actuals },
+      { dashStyle: forecast },
+    ],
+  };
+}
 
-  if (!seriesA || !seriesB || !smart_query) return null;
+function buildChartSeriesFromSeries(chart_series, actuals, forecast, midMonthOffset) {
+  const seriesA = lodash.find(chart_series, s => s.name && lodash.includes(s.name, 'SQ_Actuals'));
+  const seriesB = lodash.find(chart_series, s => s.name && lodash.includes(s.name, 'Forecast'));
+
+  if (!seriesA || !seriesB) return null;
 
   const indexOfForecastFirstZero = lodash.findIndex(seriesB.data, function(value) {
     return value.y === 0;
@@ -20,17 +53,9 @@ function createSingleDataSeriesForForecast(chart_series, chartOptions) {
   });
   const cutoffIndex = Math.max(indexOfForecastFirstZero, indexOfActualsFirstZero);
 
-  const derivedSeries = {
-    name: "Forecast Smart Query",
-    data: [],
-    zoneAxis: "x",
-    zones: [
-      { value: cutoffIndex - 1, dashStyle: actuals },
-      { dashStyle: forecast },
-    ],
-  };
 
   const minLength = Math.min(seriesA.data.length, seriesB.data.length);
+  const data = [];
 
   for (let i = 0; i < minLength; i++) {
     const pointA = seriesA.data[i];
@@ -39,19 +64,26 @@ function createSingleDataSeriesForForecast(chart_series, chartOptions) {
     const yA = (pointA && pointA.y !== null && typeof pointA.y !== undefined) ? pointA.y : pointA;
     const yB = (pointB && pointB.y !== null && typeof pointB.y !== undefined) ? pointB.y : pointB;
 
-    derivedSeries.data.push({
+    data.push({
       x: i,
-      y: yA || yB,
+      y: yA + yB,
       name: pointA && pointA.name ? pointA.name : null,
       initialName: (pointA && pointA.name) ? pointA.name : 'Point ' + (i + 1),
       type: yA ? "SQ_Actuals" : "Forecast",
     });
   }
 
-  return derivedSeries;
+  return {
+    name: "Forecast Smart Query",
+    data,
+    zoneAxis: "x",
+    zones: [
+      { value: cutoffIndex - midMonthOffset, dashStyle: actuals },
+      { dashStyle: forecast },
+    ],
+  };
 }
 
-
 module.exports = {
   createSingleDataSeriesForForecast,
 };