@dhis2/analytics 26.8.6 → 26.9.0

package/build/cjs/visualizations/config/adapters/dhis_highcharts/subtitle/index.js

@@ -10,6 +10,9 @@ var _visTypes = require("../../../../../modules/visTypes.js");
 var _getFilterText = _interopRequireDefault(require("../../../../util/getFilterText.js"));
 var _getTextAlignOption = require("../getTextAlignOption.js");
 var _yearOverYear = _interopRequireDefault(require("../title/yearOverYear.js"));
+var _singleValue = _interopRequireWildcard(require("./singleValue.js"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const DASHBOARD_SUBTITLE = {
   style: {
@@ -23,18 +26,33 @@ const DASHBOARD_SUBTITLE = {
   }
 };
 function getDefault(layout, dashboard, filterTitle) {
-  return {
-    text: dashboard || (0, _isString.default)(layout.title) ? filterTitle : undefined
-  };
+  return dashboard || (0, _isString.default)(layout.title) ? filterTitle : undefined;
 }
-function _default(series, layout, metaData, dashboard) {
-  const fontStyle = (0, _fontStyle.mergeFontStyleWithDefault)(layout.fontStyle && layout.fontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE], _fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE);
-  let subtitle = {
-    text: undefined
-  };
+function _default(series, layout, metaData, extraOptions) {
   if (layout.hideSubtitle) {
     return null;
   }
+  const {
+    dashboard,
+    legendSets
+  } = extraOptions;
+  const legendOptions = layout.legend;
+  const fontStyle = (0, _fontStyle.mergeFontStyleWithDefault)(layout.fontStyle && layout.fontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE], _fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE);
+  const subtitle = Object.assign({
+    text: undefined
+  }, dashboard ? DASHBOARD_SUBTITLE : {
+    align: (0, _getTextAlignOption.getTextAlignOption)(fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_ALIGN], _fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE, (0, _visTypes.isVerticalType)(layout.type)),
+    style: {
+      // DHIS2-578: dynamically truncate subtitle when it's taking more than 1 line
+      color: undefined,
+      fontSize: `${fontStyle[_fontStyle.FONT_STYLE_OPTION_FONT_SIZE]}px`,
+      fontWeight: fontStyle[_fontStyle.FONT_STYLE_OPTION_BOLD] ? _fontStyle.FONT_STYLE_OPTION_BOLD : 'normal',
+      fontStyle: fontStyle[_fontStyle.FONT_STYLE_OPTION_ITALIC] ? _fontStyle.FONT_STYLE_OPTION_ITALIC : 'normal',
+      whiteSpace: 'nowrap',
+      overflow: 'hidden',
+      textOverflow: 'ellipsis'
+    }
+  });
 
   // DHIS2-578: allow for optional custom subtitle
   const customSubtitle = layout.subtitle && layout.displaySubtitle || layout.subtitle;
@@ -43,6 +61,9 @@ function _default(series, layout, metaData, dashboard) {
   } else {
     const filterTitle = (0, _getFilterText.default)(layout.filters, metaData);
     switch (layout.type) {
+      case _visTypes.VIS_TYPE_SINGLE_VALUE:
+        subtitle.text = (0, _singleValue.default)(layout, metaData);
+        break;
       case _visTypes.VIS_TYPE_YEAR_OVER_YEAR_LINE:
       case _visTypes.VIS_TYPE_YEAR_OVER_YEAR_COLUMN:
         subtitle.text = (0, _yearOverYear.default)(layout, metaData, Boolean(!dashboard));
@@ -51,20 +72,33 @@ function _default(series, layout, metaData, dashboard) {
         subtitle.text = filterTitle;
         break;
       default:
-        subtitle = getDefault(layout, dashboard, filterTitle);
+        subtitle.text = getDefault(layout, dashboard, filterTitle);
     }
   }
-  return subtitle ? Object.assign({}, dashboard ? DASHBOARD_SUBTITLE : {
-    align: (0, _getTextAlignOption.getTextAlignOption)(fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_ALIGN], _fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE, (0, _visTypes.isVerticalType)(layout.type)),
-    style: {
-      // DHIS2-578: dynamically truncate subtitle when it's taking more than 1 line
-      color: fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR],
-      fontSize: `${fontStyle[_fontStyle.FONT_STYLE_OPTION_FONT_SIZE]}px`,
-      fontWeight: fontStyle[_fontStyle.FONT_STYLE_OPTION_BOLD] ? _fontStyle.FONT_STYLE_OPTION_BOLD : 'normal',
-      fontStyle: fontStyle[_fontStyle.FONT_STYLE_OPTION_ITALIC] ? _fontStyle.FONT_STYLE_OPTION_ITALIC : 'normal',
-      whiteSpace: 'nowrap',
-      overflow: 'hidden',
-      textOverflow: 'ellipsis'
-    }
-  }, subtitle) : subtitle;
+  switch (layout.type) {
+    case _visTypes.VIS_TYPE_SINGLE_VALUE:
+      {
+        var _defaultFontStyle$FON, _layout$fontStyle, _layout$fontStyle$FON;
+        const defaultColor = _fontStyle.defaultFontStyle === null || _fontStyle.defaultFontStyle === void 0 ? void 0 : (_defaultFontStyle$FON = _fontStyle.defaultFontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE]) === null || _defaultFontStyle$FON === void 0 ? void 0 : _defaultFontStyle$FON[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR];
+        const customColor = layout === null || layout === void 0 ? void 0 : (_layout$fontStyle = layout.fontStyle) === null || _layout$fontStyle === void 0 ? void 0 : (_layout$fontStyle$FON = _layout$fontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_SUBTITLE]) === null || _layout$fontStyle$FON === void 0 ? void 0 : _layout$fontStyle$FON[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR];
+        subtitle.style.color = (0, _singleValue.getSingleValueSubtitleColor)(customColor, defaultColor, series[0], legendOptions, legendSets);
+        if (dashboard) {
+          // Single value subtitle text should be multiline
+          /* TODO: The default color of the subtitle now is #4a5768 but the
+           * original implementation used #666, which is a lighter grey.
+           * If we want to keep this color, changes are needed here. */
+          Object.assign(subtitle.style, {
+            wordWrap: 'normal',
+            whiteSpace: 'normal',
+            overflow: 'visible',
+            textOverflow: 'initial'
+          });
+        }
+      }
+      break;
+    default:
+      subtitle.style.color = fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR];
+      break;
+  }
+  return subtitle;
 }

package/build/cjs/visualizations/config/adapters/dhis_highcharts/subtitle/singleValue.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = getSingleValueSubtitle;
+Object.defineProperty(exports, "getSingleValueSubtitleColor", {
+  enumerable: true,
+  get: function () {
+    return _getSingleValueTitleColor.getSingleValueTitleColor;
+  }
+});
+var _getFilterText = _interopRequireDefault(require("../../../../util/getFilterText.js"));
+var _getSingleValueTitleColor = require("../customSVGOptions/singleValue/getSingleValueTitleColor.js");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function getSingleValueSubtitle(layout, metaData) {
+  if (layout.hideSubtitle || 1 === 0) {
+    return '';
+  }
+  if (typeof layout.subtitle === 'string' && layout.subtitle.length) {
+    return layout.subtitle;
+  }
+  if (layout.filters) {
+    return (0, _getFilterText.default)(layout.filters, metaData);
+  }
+  return '';
+}

package/build/cjs/visualizations/config/adapters/dhis_highcharts/title/__tests__/singleValue.spec.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _singleValue = require("../singleValue.js");
+jest.mock('../../../../../util/getFilterText', () => () => 'The filter text');
+describe('getSingleValueTitle', () => {
+  it('returns empty title when flag hideTitle exists', () => {
+    expect((0, _singleValue.getSingleValueTitleText)({
+      hideTitle: true
+    })).toEqual('');
+  });
+  it('returns the title provided in the layout', () => {
+    const title = 'The title was already set';
+    expect((0, _singleValue.getSingleValueTitleText)({
+      title
+    })).toEqual(title);
+  });
+  it('returns null when layout does not have columns', () => {
+    expect((0, _singleValue.getSingleValueTitleText)({})).toEqual('');
+  });
+  it('returns the filter text based on column items', () => {
+    expect((0, _singleValue.getSingleValueTitleText)({
+      columns: [{
+        items: [{}]
+      }]
+    })).toEqual('The filter text');
+  });
+  describe('not dashboard', () => {
+    it('returns filter text as title', () => {
+      expect((0, _singleValue.getSingleValueTitleText)({
+        columns: [{
+          items: [{}]
+        }],
+        filters: []
+      }, {}, false)).toEqual('The filter text');
+    });
+  });
+  describe('dashboard', () => {
+    it('returns empty string', () => {
+      expect((0, _singleValue.getSingleValueTitleText)({
+        filters: {}
+      }, {}, true)).toEqual('');
+    });
+  });
+});

package/build/cjs/visualizations/config/adapters/dhis_highcharts/title/index.js

@@ -10,6 +10,7 @@ var _visTypes = require("../../../../../modules/visTypes.js");
 var _getFilterText = _interopRequireDefault(require("../../../../util/getFilterText.js"));
 var _getTextAlignOption = require("../getTextAlignOption.js");
 var _scatter = _interopRequireDefault(require("./scatter.js"));
+var _singleValue = require("./singleValue.js");
 var _yearOverYear = _interopRequireDefault(require("./yearOverYear.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const DASHBOARD_TITLE_STYLE = {
@@ -30,19 +31,41 @@ function getDefault(layout, metaData, dashboard) {
   }
   return null;
 }
-function _default(layout, metaData, dashboard) {
-  const fontStyle = (0, _fontStyle.mergeFontStyleWithDefault)(layout.fontStyle && layout.fontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_TITLE], _fontStyle.FONT_STYLE_VISUALIZATION_TITLE);
-  const title = {
-    text: undefined
-  };
+function _default(layout, metaData, extraOptions, series) {
   if (layout.hideTitle) {
-    return title;
+    return {
+      text: undefined
+    };
   }
-  const customTitle = layout.title && layout.displayTitle || layout.title;
-  if ((0, _isString.default)(customTitle) && customTitle.length) {
-    title.text = customTitle;
+  const {
+    dashboard,
+    legendSets
+  } = extraOptions;
+  const legendOptions = layout.legend;
+  const fontStyle = (0, _fontStyle.mergeFontStyleWithDefault)(layout.fontStyle && layout.fontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_TITLE], _fontStyle.FONT_STYLE_VISUALIZATION_TITLE);
+  const title = Object.assign({
+    text: undefined
+  }, dashboard ? DASHBOARD_TITLE_STYLE : {
+    margin: 30,
+    align: (0, _getTextAlignOption.getTextAlignOption)(fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_ALIGN], _fontStyle.FONT_STYLE_VISUALIZATION_TITLE, (0, _visTypes.isVerticalType)(layout.type)),
+    style: {
+      color: undefined,
+      fontSize: `${fontStyle[_fontStyle.FONT_STYLE_OPTION_FONT_SIZE]}px`,
+      fontWeight: fontStyle[_fontStyle.FONT_STYLE_OPTION_BOLD] ? _fontStyle.FONT_STYLE_OPTION_BOLD : 'normal',
+      fontStyle: fontStyle[_fontStyle.FONT_STYLE_OPTION_ITALIC] ? _fontStyle.FONT_STYLE_OPTION_ITALIC : 'normal',
+      whiteSpace: 'nowrap',
+      overflow: 'hidden',
+      textOverflow: 'ellipsis'
+    }
+  });
+  const customTitleText = layout.title && layout.displayTitle || layout.title;
+  if ((0, _isString.default)(customTitleText) && customTitleText.length) {
+    title.text = customTitleText;
   } else {
     switch (layout.type) {
+      case _visTypes.VIS_TYPE_SINGLE_VALUE:
+        title.text = (0, _singleValue.getSingleValueTitleText)(layout, metaData, dashboard);
+        break;
       case _visTypes.VIS_TYPE_GAUGE:
       case _visTypes.VIS_TYPE_YEAR_OVER_YEAR_LINE:
       case _visTypes.VIS_TYPE_YEAR_OVER_YEAR_COLUMN:
@@ -56,17 +79,22 @@ function _default(layout, metaData, dashboard) {
         break;
     }
   }
-  return Object.assign({}, dashboard ? DASHBOARD_TITLE_STYLE : {
-    margin: 30,
-    align: (0, _getTextAlignOption.getTextAlignOption)(fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_ALIGN], _fontStyle.FONT_STYLE_VISUALIZATION_TITLE, (0, _visTypes.isVerticalType)(layout.type)),
-    style: {
-      color: fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR],
-      fontSize: `${fontStyle[_fontStyle.FONT_STYLE_OPTION_FONT_SIZE]}px`,
-      fontWeight: fontStyle[_fontStyle.FONT_STYLE_OPTION_BOLD] ? _fontStyle.FONT_STYLE_OPTION_BOLD : 'normal',
-      fontStyle: fontStyle[_fontStyle.FONT_STYLE_OPTION_ITALIC] ? _fontStyle.FONT_STYLE_OPTION_ITALIC : 'normal',
-      whiteSpace: 'nowrap',
-      overflow: 'hidden',
-      textOverflow: 'ellipsis'
-    }
-  }, title);
+  switch (layout.type) {
+    case _visTypes.VIS_TYPE_SINGLE_VALUE:
+      {
+        var _defaultFontStyle$FON, _layout$fontStyle, _layout$fontStyle$FON;
+        const defaultColor = _fontStyle.defaultFontStyle === null || _fontStyle.defaultFontStyle === void 0 ? void 0 : (_defaultFontStyle$FON = _fontStyle.defaultFontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_TITLE]) === null || _defaultFontStyle$FON === void 0 ? void 0 : _defaultFontStyle$FON[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR];
+        const customColor = layout === null || layout === void 0 ? void 0 : (_layout$fontStyle = layout.fontStyle) === null || _layout$fontStyle === void 0 ? void 0 : (_layout$fontStyle$FON = _layout$fontStyle[_fontStyle.FONT_STYLE_VISUALIZATION_TITLE]) === null || _layout$fontStyle$FON === void 0 ? void 0 : _layout$fontStyle$FON[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR];
+        title.style.color = (0, _singleValue.getSingleValueTitleColor)(customColor, defaultColor, series[0], legendOptions, legendSets);
+        if (dashboard) {
+          // TODO: is this always what we want?
+          title.style.fontWeight = 'normal';
+        }
+      }
+      break;
+    default:
+      title.style.color = fontStyle[_fontStyle.FONT_STYLE_OPTION_TEXT_COLOR];
+      break;
+  }
+  return title;
 }

package/build/cjs/visualizations/config/adapters/dhis_highcharts/title/singleValue.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "getSingleValueTitleColor", {
+  enumerable: true,
+  get: function () {
+    return _getSingleValueTitleColor.getSingleValueTitleColor;
+  }
+});
+exports.getSingleValueTitleText = getSingleValueTitleText;
+var _getFilterText = _interopRequireDefault(require("../../../../util/getFilterText.js"));
+var _getSingleValueTitleColor = require("../customSVGOptions/singleValue/getSingleValueTitleColor.js");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function getSingleValueTitleText(layout, metaData) {
+  if (layout.hideTitle) {
+    return '';
+  }
+  if (typeof layout.title === 'string' && layout.title.length) {
+    return layout.title;
+  }
+  if (layout.columns) {
+    const firstItem = layout.columns[0].items[0];
+    const column = Object.assign({}, layout.columns[0], {
+      items: [firstItem]
+    });
+    return (0, _getFilterText.default)([column], metaData);
+  }
+  return '';
+}

package/build/cjs/visualizations/config/adapters/dhis_highcharts/type.js

@@ -40,6 +40,8 @@ function _default(type) {
         type: 'scatter',
         zoomType: 'xy'
       };
+    case _visTypes.VIS_TYPE_SINGLE_VALUE:
+      return {};
     case _visTypes.VIS_TYPE_COLUMN:
     case _visTypes.VIS_TYPE_STACKED_COLUMN:
     case _visTypes.VIS_TYPE_YEAR_OVER_YEAR_COLUMN:

package/build/cjs/visualizations/config/adapters/dhis_highcharts/xAxis/index.js

@@ -54,6 +54,7 @@ function _default(store, layout, extraOptions, series) {
     switch (layout.type) {
       case _visTypes.VIS_TYPE_PIE:
       case _visTypes.VIS_TYPE_GAUGE:
+      case _visTypes.VIS_TYPE_SINGLE_VALUE:
         xAxis = noAxis();
         break;
       case _visTypes.VIS_TYPE_YEAR_OVER_YEAR_LINE:

package/build/cjs/visualizations/config/adapters/dhis_highcharts/yAxis/index.js

@@ -107,13 +107,12 @@ function getDefault(layout, series, extraOptions) {
   return axes;
 }
 function _default(layout, series, extraOptions) {
-  let yAxis;
   switch (layout.type) {
+    case _visTypes.VIS_TYPE_SINGLE_VALUE:
+      return null;
     case _visTypes.VIS_TYPE_GAUGE:
-      yAxis = (0, _gauge.default)(layout, series, extraOptions.legendSets[0]);
-      break;
+      return (0, _gauge.default)(layout, series, extraOptions.legendSets[0]);
     default:
-      yAxis = getDefault(layout, series, extraOptions);
+      return getDefault(layout, series, extraOptions);
   }
-  return yAxis;
 }

package/build/cjs/visualizations/config/adapters/index.js

@@ -4,11 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _index = _interopRequireDefault(require("./dhis_dhis/index.js"));
-var _index2 = _interopRequireDefault(require("./dhis_highcharts/index.js"));
+var _index = _interopRequireDefault(require("./dhis_highcharts/index.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 var _default = {
-  dhis_highcharts: _index2.default,
-  dhis_dhis: _index.default
+  dhis_highcharts: _index.default
 };
 exports.default = _default;

package/build/cjs/visualizations/config/generators/highcharts/index.js

@@ -9,16 +9,24 @@ var _highchartsMore = _interopRequireDefault(require("highcharts/highcharts-more
 var _boost = _interopRequireDefault(require("highcharts/modules/boost"));
 var _exporting = _interopRequireDefault(require("highcharts/modules/exporting"));
 var _noDataToDisplay = _interopRequireDefault(require("highcharts/modules/no-data-to-display"));
+var _offlineExporting = _interopRequireDefault(require("highcharts/modules/offline-exporting"));
 var _patternFill = _interopRequireDefault(require("highcharts/modules/pattern-fill"));
 var _solidGauge = _interopRequireDefault(require("highcharts/modules/solid-gauge"));
+var _index = _interopRequireDefault(require("./pdfExportBugFixPlugin/index.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // apply
 (0, _highchartsMore.default)(_highcharts.default);
 (0, _solidGauge.default)(_highcharts.default);
 (0, _noDataToDisplay.default)(_highcharts.default);
 (0, _exporting.default)(_highcharts.default);
+(0, _offlineExporting.default)(_highcharts.default);
 (0, _patternFill.default)(_highcharts.default);
 (0, _boost.default)(_highcharts.default);
+(0, _index.default)(_highcharts.default);
+
+/* Whitelist some additional SVG attributes here. Without this,
+ * the PDF export for the SingleValue visualization breaks. */
+_highcharts.default.AST.allowedAttributes.push('fill-rule', 'clip-rule');
 function drawLegendSymbolWrap() {
   const pick = _highcharts.default.pick;
   _highcharts.default.wrap(_highcharts.default.seriesTypes.column.prototype, 'drawLegendSymbol', function (proceed, legend, item) {

package/build/cjs/visualizations/config/generators/highcharts/pdfExportBugFixPlugin/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+var _nonASCIIFont = _interopRequireDefault(require("./nonASCIIFont.js"));
+var _textShadow = _interopRequireDefault(require("./textShadow.js"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _default(H) {
+  (0, _textShadow.default)(H);
+  (0, _nonASCIIFont.default)(H);
+}

package/build/cjs/visualizations/config/generators/highcharts/pdfExportBugFixPlugin/nonASCIIFont.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+/* This is a workaround for https://github.com/highcharts/highcharts/issues/22008
+ * We add some transparent text in a non-ASCII script to the chart to prevent
+ * the chart from being exported in a serif font */
+
+function _default(H) {
+  H.addEvent(H.Chart, 'load', function () {
+    this.renderer.text('모', 20, 20).attr({
+      opacity: 0
+    }).add();
+  });
+}