@datarailsshared/dr_renderer 1.3.35 → 1.3.38

package/package.json

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

package/src/highcharts_renderer.js

@@ -2,6 +2,7 @@ const helpers = require('./dr-renderer-helpers');
 const { DrGaugeChart, GAUGE_OPTIONS_DEFAULT } = require('./charts/dr_gauge_chart');
 const { DrDonutChart } = require('./charts/dr_donut_chart');
 const seriesPointStylesHelper= require('./seriesPointStyles-helper');
+const smartQueriesHelper = require('./smart_queries_helper');
 const {DrGaugeCategoriesSummaryChart} = require("./charts/dr_gauge_categories_summary_chart");
 
 const mobileBrowserRegex = new RegExp([
@@ -401,6 +402,21 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return  {};
     };
 
+    const isChartTypeSupportedForSmartQuery = (type) => {
+        if (!type) return null;
+        return [
+            'line',
+            'spline',
+            'area',
+            'areaspline',
+            highchartsRenderer.CHART_TYPES.LINE_CHART,
+            highchartsRenderer.CHART_TYPES.LINE_CHART_SMOOTH,
+            highchartsRenderer.CHART_TYPES.AREA_CHART,
+            highchartsRenderer.CHART_TYPES.AREA_CHART_SMOOTH,
+        ].includes(type);
+    };
+
+
     const chartHasVerticalDataLabelsOption = (type) => {
         return ![
             highchartsRenderer.CHART_TYPES.LINE_CHART,
@@ -1404,6 +1420,18 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         chart_series = chart_series.concat(trendSerieses);
 
         highchartsRenderer.moveSeriesToSecondYAxisIfNeeded(chart_series, pivotData, chartOptions, additionOptions, opts, opts.total && opts.totalSeriesSettings && opts.totalSeriesSettings.secondaryAxis);
+        
+        const chartType = chartOptions && chartOptions.chart && chartOptions.chart.type ? chartOptions.chart.type : null;
+        const smartQuerySeries = isChartTypeSupportedForSmartQuery(chartType)
+            ? smartQueriesHelper.createSingleDataSeriesForForecast(chart_series, opts.chartOptions)
+            : null;
+
+        if (smartQuerySeries) {
+            chart_series.push(smartQuerySeries);
+            lodash.remove(chart_series, s => 
+                (s.name && lodash.includes(s.name, 'SQ_Actuals')) || s.name === 'Forecast'
+            );
+        }
 
         return chart_series;
     };
@@ -6610,7 +6638,42 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 value_name: 'showAllLegends',
                 element_label: 'Show legends over 10',
                 default_value: false
-            }]
+            },
+            {
+                element_type: 'devider',
+                element_label: 'Chart Patterns',
+                showFn: isChartTypeSupportedForSmartQuery
+            },
+            {
+                element_type: 'toggle',
+                element_label: 'Smart Queries',
+                value_name: 'smart_query',
+                default_value: true,
+                showFn: isChartTypeSupportedForSmartQuery
+            },
+            {
+                element_type: 'select',
+                value_name: 'actuals',
+                element_label: 'Actuals',
+                element_options: [
+                    {label: 'Solid', value: 'solid'},
+                    {label: 'Dash', value: 'dash'},
+                ],
+                default_value: 'Solid',
+                showFn: isChartTypeSupportedForSmartQuery
+            },
+            {
+                element_type: 'select',
+                value_name: 'forecast',
+                element_label: 'Forecast',
+                element_options: [
+                    {label: 'Solid', value: 'solid'},
+                    {label: 'Dash', value: 'dash'},
+                ],
+                default_value: 'Dash',
+                showFn: isChartTypeSupportedForSmartQuery
+            }
+        ]
         },
         'total_value_label_donut': {
             category_class: 'google-visualization-charteditor-mini-more',
@@ -9802,6 +9865,14 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         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);
+        const seriesData = lodash.get(e.point.series, 'userOptions.data');
+        const initialNameForSmartQueries = seriesData 
+            ? lodash.find(seriesData, obj => obj.name === e.point.name)
+            : null;
+        
+        if (initialNameForSmartQueries && initialNameForSmartQueries.type) {
+            e.point.series.name = initialNameForSmartQueries.type;
+        }
         lodash.set(e, 'point.category.userOptions', e.point.initialName.toString().split(highchartsRenderer.delimer));
     }
 

package/src/smart_queries_helper.js

@@ -0,0 +1,57 @@
+const lodash = require('lodash');
+
+function createSingleDataSeriesForForecast(chart_series, chartOptions) {
+  const { actuals, forecast, smart_query } = chartOptions.chart;
+
+  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');
+  });
+
+  if (!seriesA || !seriesB || !smart_query) return null;
+
+  const indexOfForecastFirstZero = lodash.findIndex(seriesB.data, function(value) {
+    return value.y === 0;
+  });
+  const indexOfActualsFirstZero = lodash.findIndex(seriesA.data, function(value) {
+    return value.y === 0;
+  });
+  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);
+
+  for (let i = 0; i < minLength; i++) {
+    const pointA = seriesA.data[i];
+    const pointB = seriesB.data[i];
+
+    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({
+      x: i,
+      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;
+}
+
+
+module.exports = {
+  createSingleDataSeriesForForecast,
+};

package/tests/highcharts_renderer.test.js

@@ -7082,7 +7082,11 @@ describe('highcharts_renderer', () => {
                 "#70000a"
             ];
             opts = {};
-            chartOptions = {};
+            chartOptions = {
+                chart: {
+                    type: '',
+                }
+            };
             pivotDataMock = {
                 getAggregator: (rows, cols) => {
                     let aggregator = highchartsRenderer.rhPivotAggregatorSum([''], format, true, {}, {});