@isoftdata/utility-dashboard-backend 1.5.6 → 1.5.8

package/chart-helper.js

@@ -216,13 +216,19 @@ module.exports = {
 
 		return { cols, rows }
 	},
-	makeDataCumulative: dataTable => {
+	/**
+	 * Replace all null values with the previous non-null value, and optionally make data cumulative
+	 * @param {Object} dataTable - the data table
+	 * @param {Boolean} cumulative - whether to make the data cumulative, or fill remove holes in the data. Defaults to true.
+	 * @returns
+	 */
+	makeDataCumulative: (dataTable, cumulative = true) => {
 		dataTable.rows.forEach((row, rowIndex) => {
 			if (rowIndex > 0) {
 				row.c.forEach((col, colIndex) => {
 					if (colIndex > 0 && col.v == null) {
 						col.v = Number(dataTable.rows[rowIndex - 1].c[colIndex].v)
-					} else if (colIndex > 0) {
+					} else if (cumulative && colIndex > 0) {
 						col.v = Number(col.v) + Number(dataTable.rows[rowIndex - 1].c[colIndex].v)
 					}
 				})

package/index.js

@@ -9,6 +9,7 @@ const {
 	makeDataCumulative,
 	getRactiveTableDataFormat: getRactiveTableDataFormat } = require('./chart-helper.js')
 const { datesFromRange } = require('@isoftdata/utility-date-time')
+const { formatterTemplates } = require('./formatter-templates.json')
 const formatDate = require('date-fns/format')
 const camelcase = require('camelcase')
 
@@ -35,7 +36,7 @@ const handleChartTypeSpecificQuirks = (chartType, resultSet) => {
 	return resultSet
 }
 
-const loadChartData = async(mysqlConnection, { name, query: queryObject, formatting, chartWrapper, multiSeries, table, parameters, supertype, ...theRest }) => { // needs database connection
+const loadChartData = async(mysqlConnection, { query: queryObject, formatting, chartWrapper, multiSeries, table, supertype, cumulative, ...theRest }) => { // needs database connection
 	if (!chartWrapper) {
 		chartWrapper = {
 			chartType: supertype,
@@ -44,7 +45,12 @@ const loadChartData = async(mysqlConnection, { name, query: queryObject, formatt
 			},
 		}
 	}
-	const { dataTable, processedFormatting } = await loadDataTableAndProcessedFormatting(mysqlConnection, { query: queryObject, multiSeries, formatting, chartType: chartWrapper?.chartType })
+
+	// There are area charts in the wild that need to be cumulative but aren't specifically flagged as such,
+	// So make area charts cumulative unless they're explicitly set not to be
+	cumulative = cumulative || (chartWrapper?.chartType === 'AreaChart' && cumulative !== false)
+
+	const { dataTable, processedFormatting } = await loadDataTableAndProcessedFormatting(mysqlConnection, { query: queryObject, multiSeries, formatting, chartType: chartWrapper?.chartType, cumulative })
 
 	if (chartWrapper?.chartType === 'Table') {
 		return {
@@ -57,6 +63,7 @@ const loadChartData = async(mysqlConnection, { name, query: queryObject, formatt
 	}
 	return {
 		...theRest,
+		cumulative,
 		supertype,
 		chartWrapper: {
 			...chartWrapper,
@@ -70,7 +77,7 @@ const loadChartData = async(mysqlConnection, { name, query: queryObject, formatt
 *	Otherwise, it will return data in the google chart Datatable object literal format.
 *	multiSeries, formatting properties should be deconstructed from the chart object, chartType should be deconstructed from the chart's chartWrapper property
 */
-const loadDataTableAndProcessedFormatting = async(mysqlConnection, { query: queryObject, multiSeries, formatting, chartType }) => {
+const loadDataTableAndProcessedFormatting = async(mysqlConnection, { query: queryObject, multiSeries, formatting, chartType, cumulative }) => {
 	let { results: queryResultSet, fields } = (queryObject && queryObject.sql) ? await queryWithFields(mysqlConnection, queryObject) : { fields: [], results: [] }
 	let data = handleChartTypeSpecificQuirks(chartType, queryResultSet)
 
@@ -91,10 +98,10 @@ const loadDataTableAndProcessedFormatting = async(mysqlConnection, { query: quer
 
 	let dataTable = getDataTableFormat(data, fields, multiSeries) //per the Google Charts docs, the DataTable object literal format is the most performant, so we'll turn it into that format before returning
 
-	// Stacked area charts will have holes / jagged lines if there are nulls in the middle of a column
-	// Presumably we'll also want to be able to have non-cumulative area charts at some point
-	if (chartType === 'AreaChart') {
-		dataTable = makeDataCumulative(dataTable)
+	// Stacked area charts will have holes / jagged lines if there are nulls in the middle of a column,
+	// so always do this for those, even if we don't need it to be cumulative.
+	if (cumulative || chartType === 'AreaChart') {
+		dataTable = makeDataCumulative(dataTable, cumulative)
 	}
 
 	return { dataTable, processedFormatting }
@@ -255,4 +262,5 @@ module.exports = {
 	loadDataTableAndProcessedFormatting,
 	parameterizeQuery,
 	handleFormattingTemplates,
+	formatterTemplates,
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@isoftdata/utility-dashboard-backend",
-	"version": "1.5.6",
+	"version": "1.5.8",
 	"description": "A utility for formatting chart and report data to be usable by the frontend dashboard component.",
 	"main": "index.js",
 	"scripts": {