@dhis2/analytics 26.4.0 → 26.5.0

package/build/cjs/components/PeriodDimension/PeriodTransfer.js

@@ -23,15 +23,35 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 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 }; }
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); } //TODO: Reimplement the icon.js
-const PeriodTransfer = _ref => {
+const RightHeader = _ref => {
+  let {
+    infoBoxMessage
+  } = _ref;
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("p", {
+    className: `jsx-${_DimensionSelectorStyle.default.__hash}` + " " + "rightHeader"
+  }, _index.default.t('Selected Periods')), infoBoxMessage && /*#__PURE__*/_react.default.createElement("div", {
+    className: `jsx-${_DimensionSelectorStyle.default.__hash}` + " " + "info-container"
+  }, /*#__PURE__*/_react.default.createElement("div", {
+    className: `jsx-${_DimensionSelectorStyle.default.__hash}`
+  }, /*#__PURE__*/_react.default.createElement(_ui.IconInfo16, null)), /*#__PURE__*/_react.default.createElement("span", {
+    className: `jsx-${_DimensionSelectorStyle.default.__hash}` + " " + "info-text"
+  }, infoBoxMessage)), /*#__PURE__*/_react.default.createElement(_style.default, {
+    id: _DimensionSelectorStyle.default.__hash
+  }, _DimensionSelectorStyle.default));
+};
+RightHeader.propTypes = {
+  infoBoxMessage: _propTypes.default.string
+};
+const PeriodTransfer = _ref2 => {
   let {
     onSelect,
     dataTest,
-    initialSelectedPeriods,
+    selectedItems,
     rightFooter,
     excludedPeriodTypes,
-    periodsSettings
-  } = _ref;
+    periodsSettings,
+    infoBoxMessage
+  } = _ref2;
   const defaultRelativePeriodType = excludedPeriodTypes.includes(_index2.MONTHLY) ? (0, _relativePeriods.getRelativePeriodsOptionsById)(_index2.QUARTERLY) : (0, _relativePeriods.getRelativePeriodsOptionsById)(_index2.MONTHLY);
   const defaultFixedPeriodType = excludedPeriodTypes.includes(_index2.MONTHLY) ? (0, _fixedPeriods.getFixedPeriodsOptionsById)(_index2.QUARTERLY, periodsSettings) : (0, _fixedPeriods.getFixedPeriodsOptionsById)(_index2.MONTHLY, periodsSettings);
   const now = (0, _multiCalendarDates.getNowInCalendar)(periodsSettings.calendar);
@@ -44,7 +64,6 @@ const PeriodTransfer = _ref => {
     reversePeriods: false
   });
   const [allPeriods, setAllPeriods] = (0, _react.useState)(defaultRelativePeriodType.getPeriods());
-  const [selectedPeriods, setSelectedPeriods] = (0, _react.useState)(initialSelectedPeriods);
   const [isRelative, setIsRelative] = (0, _react.useState)(true);
   const [relativeFilter, setRelativeFilter] = (0, _react.useState)({
     periodType: defaultRelativePeriodType.id
@@ -53,6 +72,10 @@ const PeriodTransfer = _ref => {
     periodType: defaultFixedPeriodType.id,
     year: defaultFixedPeriodYear.toString()
   });
+  const isActive = value => {
+    const item = selectedItems.find(item => item.id === value);
+    return !item || item.isActive;
+  };
   const onIsRelativeClick = state => {
     if (state !== isRelative) {
       setIsRelative(state);
@@ -99,11 +122,6 @@ const PeriodTransfer = _ref => {
   })), /*#__PURE__*/_react.default.createElement(_style.default, {
     id: _DimensionSelectorStyle.default.__hash
   }, _DimensionSelectorStyle.default));
-  const renderRightHeader = () => /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("p", {
-    className: `jsx-${_DimensionSelectorStyle.default.__hash}` + " " + "rightHeader"
-  }, _index.default.t('Selected Periods')), /*#__PURE__*/_react.default.createElement(_style.default, {
-    id: _DimensionSelectorStyle.default.__hash
-  }, _DimensionSelectorStyle.default));
   const onSelectFixedPeriods = filter => {
     setFixedFilter(filter);
     setAllPeriods((0, _fixedPeriods.getFixedPeriodsOptionsById)(filter.periodType, periodsSettings).getPeriods(fixedPeriodConfig(Number(filter.year)), periodsSettings));
@@ -114,45 +132,58 @@ const PeriodTransfer = _ref => {
     id: _DimensionSelectorStyle.default.__hash
   }, _DimensionSelectorStyle.default));
   return /*#__PURE__*/_react.default.createElement(_ui.Transfer, {
-    onChange: _ref2 => {
+    onChange: _ref3 => {
       let {
         selected
-      } = _ref2;
-      const formattedItems = selected.map(id => ({
-        id,
-        name: [...allPeriods, ...selectedPeriods].find(item => item.id === id).name
-      }));
-      setSelectedPeriods(formattedItems);
+      } = _ref3;
+      const formattedItems = selected.map(id => {
+        const matchingItem = [...allPeriods, ...selectedItems].find(item => item.id === id);
+        return {
+          id,
+          name: matchingItem.name,
+          isActive: matchingItem.isActive
+        };
+      });
       onSelect(formattedItems);
     },
-    selected: selectedPeriods.map(period => period.id),
+    selected: selectedItems.map(period => period.id),
     leftHeader: renderLeftHeader(),
     enableOrderChange: true,
     height: _dimensionSelectorHelper.TRANSFER_HEIGHT,
     optionsWidth: _dimensionSelectorHelper.TRANSFER_OPTIONS_WIDTH,
     selectedWidth: _dimensionSelectorHelper.TRANSFER_SELECTED_WIDTH,
     selectedEmptyComponent: renderEmptySelection(),
-    rightHeader: renderRightHeader(),
+    rightHeader: /*#__PURE__*/_react.default.createElement(RightHeader, {
+      infoBoxMessage: infoBoxMessage
+    }),
     rightFooter: rightFooter,
-    options: [...allPeriods, ...selectedPeriods].map(_ref3 => {
+    options: [...allPeriods, ...selectedItems].map(_ref4 => {
       let {
         id,
         name
-      } = _ref3;
+      } = _ref4;
       return {
         label: name,
         value: id
       };
     }),
-    renderOption: props => /*#__PURE__*/_react.default.createElement(_TransferOption.TransferOption, _extends({}, props, {
-      icon: _PeriodIcon.default,
-      dataTest: `${dataTest}-transfer-option`
-    })),
+    renderOption: _ref5 => {
+      let {
+        value,
+        ...props
+      } = _ref5;
+      return /*#__PURE__*/_react.default.createElement(_TransferOption.TransferOption, _extends({}, props, {
+        value: value,
+        active: isActive(value),
+        icon: _PeriodIcon.default,
+        dataTest: `${dataTest}-transfer-option`
+      }));
+    },
     dataTest: `${dataTest}-transfer`
   });
 };
 PeriodTransfer.defaultProps = {
-  initialSelectedPeriods: [],
+  selectedItems: [],
   excludedPeriodTypes: [],
   periodsSettings: {
     calendar: 'gregory',
@@ -163,15 +194,17 @@ PeriodTransfer.propTypes = {
   onSelect: _propTypes.default.func.isRequired,
   dataTest: _propTypes.default.string,
   excludedPeriodTypes: _propTypes.default.arrayOf(_propTypes.default.string),
-  initialSelectedPeriods: _propTypes.default.arrayOf(_propTypes.default.shape({
-    id: _propTypes.default.string,
-    name: _propTypes.default.string
-  })),
+  infoBoxMessage: _propTypes.default.string,
   periodsSettings: _propTypes.default.shape({
     calendar: _propTypes.default.string,
     locale: _propTypes.default.string
   }),
-  rightFooter: _propTypes.default.node
+  rightFooter: _propTypes.default.node,
+  selectedItems: _propTypes.default.arrayOf(_propTypes.default.shape({
+    id: _propTypes.default.string,
+    isActive: _propTypes.default.bool,
+    name: _propTypes.default.string
+  }))
 };
 var _default = PeriodTransfer;
 exports.default = _default;

package/build/cjs/components/PeriodDimension/__tests__/__snapshots__/PeriodDimension.spec.js.snap

@@ -4,7 +4,6 @@ exports[`The Period Dimension component matches the snapshot 1`] = `
 <PeriodTransfer
   dataTest="period-dimension"
   excludedPeriodTypes={Array []}
-  initialSelectedPeriods={Array []}
   onSelect={[Function]}
   periodsSettings={
     Object {
@@ -13,5 +12,6 @@ exports[`The Period Dimension component matches the snapshot 1`] = `
     }
   }
   rightFooter={<React.Fragment />}
+  selectedItems={Array []}
 />
 `;

package/build/cjs/components/PeriodDimension/__tests__/__snapshots__/PeriodSelector.spec.js.snap

@@ -77,18 +77,7 @@ exports[`The Period Selector component matches the snapshot 1`] = `
   optionsWidth="420px"
   renderOption={[Function]}
   rightFooter={<React.Fragment />}
-  rightHeader={
-    <React.Fragment>
-      <p
-        className="rightHeader"
-      >
-        Selected Periods
-      </p>
-      <style>
-        
-      </style>
-    </React.Fragment>
-  }
+  rightHeader={<RightHeader />}
   selected={Array []}
   selectedEmptyComponent={
     <React.Fragment>

package/build/cjs/components/VisTypeIcon.js

@@ -24,7 +24,7 @@ const VisTypeIcon = _ref => {
       }
     case _visTypes.VIS_TYPE_PIVOT_TABLE:
       {
-        VisIcon = useSmall ? _ui.IconTable16 : _ui.IconTable24;
+        VisIcon = useSmall ? _ui.IconVisualizationPivotTable16 : _ui.IconVisualizationPivotTable24;
         break;
       }
     case _visTypes.VIS_TYPE_BAR:
@@ -92,6 +92,11 @@ const VisTypeIcon = _ref => {
         VisIcon = useSmall ? _ui.IconVisualizationScatter16 : _ui.IconVisualizationScatter24;
         break;
       }
+    case _visTypes.VIS_TYPE_OUTLIER_TABLE:
+      {
+        VisIcon = useSmall ? _ui.IconVisualizationOutlierTable16 : _ui.IconVisualizationOutlierTable24;
+        break;
+      }
     case _visTypes.VIS_TYPE_COLUMN:
     default:
       {

package/build/cjs/index.js

@@ -140,6 +140,7 @@ var _exportNames = {
   VIS_TYPE_PIVOT_TABLE: true,
   VIS_TYPE_SCATTER: true,
   VIS_TYPE_LINE_LIST: true,
+  VIS_TYPE_OUTLIER_TABLE: true,
   visTypeDisplayNames: true,
   visTypeIcons: true,
   getDisplayNameByVisType: true,
@@ -149,6 +150,7 @@ var _exportNames = {
   isYearOverYear: true,
   isDualAxisType: true,
   isSingleValue: true,
+  isOutlierTable: true,
   isTwoCategoryChartType: true,
   isLegendSetType: true,
   isColumnBasedType: true,
@@ -160,12 +162,15 @@ var _exportNames = {
   LAYOUT_TYPE_PIVOT_TABLE: true,
   LAYOUT_TYPE_SCATTER: true,
   LAYOUT_TYPE_LINE_LIST: true,
+  LAYOUT_TYPE_OUTLIER_TABLE: true,
   getAvailableAxes: true,
   getDisallowedDimensions: true,
+  getDimensionMaxNumberOfItems: true,
   getAxisMaxNumberOfItems: true,
   getAxisMaxNumberOfDimensions: true,
   getAxisMinNumberOfDimensions: true,
   hasAxisTooManyItems: true,
+  hasDimensionTooManyItems: true,
   getAxisPerLockedDimension: true,
   getAllLockedDimensionIds: true,
   canDimensionBeAddedToAxis: true,
@@ -247,7 +252,8 @@ var _exportNames = {
   DIMENSION_TYPE_ORGANISATION_UNIT: true,
   DIMENSION_TYPE_PERIOD: true,
   DIMENSION_TYPE_ORGANISATION_UNIT_GROUP_SET: true,
-  DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM: true
+  DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM: true,
+  dataTypeMap: true
 };
 Object.defineProperty(exports, "ALL_DYNAMIC_DIMENSION_ITEMS", {
   enumerable: true,
@@ -741,6 +747,12 @@ Object.defineProperty(exports, "LAYOUT_TYPE_LINE_LIST", {
     return _layoutTypes.LAYOUT_TYPE_LINE_LIST;
   }
 });
+Object.defineProperty(exports, "LAYOUT_TYPE_OUTLIER_TABLE", {
+  enumerable: true,
+  get: function () {
+    return _layoutTypes.LAYOUT_TYPE_OUTLIER_TABLE;
+  }
+});
 Object.defineProperty(exports, "LAYOUT_TYPE_PIE", {
   enumerable: true,
   get: function () {
@@ -1071,6 +1083,12 @@ Object.defineProperty(exports, "VIS_TYPE_LINE_LIST", {
     return _visTypes.VIS_TYPE_LINE_LIST;
   }
 });
+Object.defineProperty(exports, "VIS_TYPE_OUTLIER_TABLE", {
+  enumerable: true,
+  get: function () {
+    return _visTypes.VIS_TYPE_OUTLIER_TABLE;
+  }
+});
 Object.defineProperty(exports, "VIS_TYPE_PIE", {
   enumerable: true,
   get: function () {
@@ -1293,6 +1311,12 @@ Object.defineProperty(exports, "createVisualization", {
     return _index10.createVisualization;
   }
 });
+Object.defineProperty(exports, "dataTypeMap", {
+  enumerable: true,
+  get: function () {
+    return _dataTypes.dataTypeMap;
+  }
+});
 Object.defineProperty(exports, "defaultFontStyle", {
   enumerable: true,
   get: function () {
@@ -1431,6 +1455,12 @@ Object.defineProperty(exports, "getDimensionById", {
     return _predefinedDimensions.getDimensionById;
   }
 });
+Object.defineProperty(exports, "getDimensionMaxNumberOfItems", {
+  enumerable: true,
+  get: function () {
+    return _index9.getDimensionMaxNumberOfItems;
+  }
+});
 Object.defineProperty(exports, "getDisallowedDimensions", {
   enumerable: true,
   get: function () {
@@ -1515,6 +1545,12 @@ Object.defineProperty(exports, "hasCustomAxes", {
     return _axis.hasCustomAxes;
   }
 });
+Object.defineProperty(exports, "hasDimensionTooManyItems", {
+  enumerable: true,
+  get: function () {
+    return _index9.hasDimensionTooManyItems;
+  }
+});
 Object.defineProperty(exports, "hasRelativeItems", {
   enumerable: true,
   get: function () {
@@ -1557,6 +1593,12 @@ Object.defineProperty(exports, "isMultiType", {
     return _visTypes.isMultiType;
   }
 });
+Object.defineProperty(exports, "isOutlierTable", {
+  enumerable: true,
+  get: function () {
+    return _visTypes.isOutlierTable;
+  }
+});
 Object.defineProperty(exports, "isSingleValue", {
   enumerable: true,
   get: function () {

package/build/cjs/locales/en/translations.json

@@ -44,6 +44,7 @@
     "Drag items here, or double click in the list, to start building a calculation formula": "Drag items here, or double click in the list, to start building a calculation formula",
     "Math operators": "Math operators",
     "Data Type": "Data Type",
+    "Only {{dataType}} can be used in {{visType}}": "Only {{dataType}} can be used in {{visType}}",
     "All types": "All types",
     "Disaggregation": "Disaggregation",
     "No data": "No data",
@@ -54,10 +55,12 @@
     "No data sets found": "No data sets found",
     "No event data items found": "No event data items found",
     "No program indicators found": "No program indicators found",
+    "No calculations found": "No calculations found",
     "No indicators found for \"{{- searchTerm}}\"": "No indicators found for \"{{- searchTerm}}\"",
     "No data sets found for \"{{- searchTerm}}\"": "No data sets found for \"{{- searchTerm}}\"",
     "No event data items found for \"{{- searchTerm}}\"": "No event data items found for \"{{- searchTerm}}\"",
     "No program indicators found for \"{{- searchTerm}}\"": "No program indicators found for \"{{- searchTerm}}\"",
+    "No calculations found for \"{{- searchTerm}}\"": "No calculations found for \"{{- searchTerm}}\"",
     "Nothing found for \"{{- searchTerm}}\"": "Nothing found for \"{{- searchTerm}}\"",
     "Calculation": "Calculation",
     "Metric type": "Metric type",
@@ -201,9 +204,9 @@
     "Year": "Year",
     "Select year": "Select year",
     "Period": "Period",
+    "Selected Periods": "Selected Periods",
     "Relative periods": "Relative periods",
     "Fixed periods": "Fixed periods",
-    "Selected Periods": "Selected Periods",
     "No periods selected": "No periods selected",
     "Daily": "Daily",
     "Weekly": "Weekly",
@@ -371,6 +374,7 @@
     "Radar": "Radar",
     "Scatter": "Scatter",
     "Single value": "Single value",
+    "Outlier table": "Outlier table",
     "All charts": "All charts",
     "{{seriesName}} (trend)": "{{seriesName}} (trend)",
     "Trend": "Trend",

package/build/cjs/modules/__tests__/getAdaptedUiLayoutByType.spec.js

@@ -6,6 +6,7 @@ var _predefinedDimensions = require("../predefinedDimensions.js");
 var _visTypes = require("../visTypes.js");
 const someId = 'someId';
 const otherId = 'otherId';
+const thirdId = 'thirdId';
 describe('getAdaptedUiLayoutByType', () => {
   it('column: moves all extra dimensions in columns and rows to filters', () => {
     const initialState = {
@@ -109,6 +110,20 @@ describe('getAdaptedUiLayoutByType', () => {
     };
     expect(actualState).toEqual(expectedState);
   });
+  it('outlier table: removes all dimensions but dx,pe,ou which are moved to columns', () => {
+    const initialState = {
+      [_axis.AXIS_ID_COLUMNS]: [_predefinedDimensions.DIMENSION_ID_DATA, someId],
+      [_axis.AXIS_ID_ROWS]: [_predefinedDimensions.DIMENSION_ID_PERIOD, otherId],
+      [_axis.AXIS_ID_FILTERS]: [_predefinedDimensions.DIMENSION_ID_ORGUNIT, thirdId]
+    };
+    const actualState = (0, _getAdaptedUiLayoutByType.getAdaptedUiLayoutByType)(initialState, _visTypes.VIS_TYPE_OUTLIER_TABLE);
+    const expectedState = {
+      [_axis.AXIS_ID_COLUMNS]: [_predefinedDimensions.DIMENSION_ID_DATA, _predefinedDimensions.DIMENSION_ID_PERIOD, _predefinedDimensions.DIMENSION_ID_ORGUNIT],
+      [_axis.AXIS_ID_ROWS]: [],
+      [_axis.AXIS_ID_FILTERS]: []
+    };
+    expect(actualState).toEqual(expectedState);
+  });
   it('pivot -> sv with dimension strings', () => {
     const initialLayout = {
       [_axis.AXIS_ID_COLUMNS]: [_predefinedDimensions.DIMENSION_ID_DATA, _predefinedDimensions.DIMENSION_ID_PERIOD],

package/build/cjs/modules/axis.js

@@ -35,6 +35,10 @@ const getAxisNamesByLayoutType = layoutType => {
         [_axis.AXIS_ID_ROWS]: _index.default.t('Points'),
         [_axis.AXIS_ID_FILTERS]: _index.default.t('Filter')
       };
+    case _layoutTypes.LAYOUT_TYPE_OUTLIER_TABLE:
+      return {
+        [_axis.AXIS_ID_COLUMNS]: _index.default.t('Columns')
+      };
   }
 };
 const getAxisNameByLayoutType = (axisId, layoutType) => {

package/build/cjs/modules/getAdaptedUiLayoutByType.js

@@ -33,6 +33,8 @@ const getAdaptedUiLayoutByType = (layout, type) => {
       return layout;
     case _visTypes.VIS_TYPE_SCATTER:
       return getScatterLayout(layout);
+    case _visTypes.VIS_TYPE_OUTLIER_TABLE:
+      return getOutlierTableLayout(layout);
     default:
       return getDefaultLayout(layout);
   }
@@ -107,6 +109,13 @@ const getSingleValueLayout = layout => {
   };
 };
 
+// Transform from ui.layout to outlier table layout format
+const getOutlierTableLayout = () => ({
+  [_axis.AXIS_ID_COLUMNS]: [_predefinedDimensions.DIMENSION_ID_DATA, _predefinedDimensions.DIMENSION_ID_PERIOD, _predefinedDimensions.DIMENSION_ID_ORGUNIT],
+  [_axis.AXIS_ID_ROWS]: [],
+  [_axis.AXIS_ID_FILTERS]: []
+});
+
 /**
  *
  * @param {string|object} dimension

package/build/cjs/modules/layoutTypes.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.LAYOUT_TYPE_YEAR_OVER_YEAR = exports.LAYOUT_TYPE_SINGLE_VALUE = exports.LAYOUT_TYPE_SCATTER = exports.LAYOUT_TYPE_PIVOT_TABLE = exports.LAYOUT_TYPE_PIE = exports.LAYOUT_TYPE_LINE_LIST = exports.LAYOUT_TYPE_DEFAULT = void 0;
+exports.LAYOUT_TYPE_YEAR_OVER_YEAR = exports.LAYOUT_TYPE_SINGLE_VALUE = exports.LAYOUT_TYPE_SCATTER = exports.LAYOUT_TYPE_PIVOT_TABLE = exports.LAYOUT_TYPE_PIE = exports.LAYOUT_TYPE_OUTLIER_TABLE = exports.LAYOUT_TYPE_LINE_LIST = exports.LAYOUT_TYPE_DEFAULT = void 0;
 const LAYOUT_TYPE_DEFAULT = 'LAYOUT_TYPE_DEFAULT';
 exports.LAYOUT_TYPE_DEFAULT = LAYOUT_TYPE_DEFAULT;
 const LAYOUT_TYPE_PIE = 'LAYOUT_TYPE_PIE';
@@ -17,4 +17,6 @@ exports.LAYOUT_TYPE_PIVOT_TABLE = LAYOUT_TYPE_PIVOT_TABLE;
 const LAYOUT_TYPE_SCATTER = 'LAYOUT_TYPE_SCATTER';
 exports.LAYOUT_TYPE_SCATTER = LAYOUT_TYPE_SCATTER;
 const LAYOUT_TYPE_LINE_LIST = 'LAYOUT_TYPE_LINE_LIST';
-exports.LAYOUT_TYPE_LINE_LIST = LAYOUT_TYPE_LINE_LIST;
+exports.LAYOUT_TYPE_LINE_LIST = LAYOUT_TYPE_LINE_LIST;
+const LAYOUT_TYPE_OUTLIER_TABLE = 'LAYOUT_TYPE_OUTLIER_TABLE';
+exports.LAYOUT_TYPE_OUTLIER_TABLE = LAYOUT_TYPE_OUTLIER_TABLE;

package/build/cjs/modules/layoutUiRules/__tests__/rules.spec.js

@@ -4,12 +4,14 @@ var _axis = require("../../layout/axis.js");
 var _predefinedDimensions = require("../../predefinedDimensions.js");
 var _rules = require("../rules.js");
 // Consts
+const validDims = [_predefinedDimensions.DIMENSION_ID_DATA, _predefinedDimensions.DIMENSION_ID_PERIOD, _predefinedDimensions.DIMENSION_ID_ORGUNIT];
 const lockableDims = [_predefinedDimensions.DIMENSION_ID_DATA, _predefinedDimensions.DIMENSION_ID_PERIOD, _predefinedDimensions.DIMENSION_ID_ORGUNIT];
-const disallowableDims = [_predefinedDimensions.DIMENSION_ID_DATA, _predefinedDimensions.DIMENSION_ID_PERIOD];
+const disallowableDims = [_predefinedDimensions.DIMENSION_ID_DATA, _predefinedDimensions.DIMENSION_ID_PERIOD, _predefinedDimensions.DIMENSION_ID_ASSIGNED_CATEGORIES];
 
 // Helper fns
 const allArrayItemsAreValid = (allItems, validItems) => allItems.every(value => validItems.includes(value));
 const allArrayItemsAreValidAxisIds = array => allArrayItemsAreValid(array, _axis.ALL_AXIS_IDS);
+const allArrayItemsAreValidDimensionIds = array => allArrayItemsAreValid(array, validDims);
 const onlyRulesWithProp = ruleProp => _rules.testResourceRules.filter(rule => rule[ruleProp]);
 
 // Partial tests
@@ -19,6 +21,9 @@ const testPropHasKeysAndValues = ruleProp => it('has keys and values', () => {
 const testPropIsArray = ruleProp => it('is an array', () => {
   expect(onlyRulesWithProp(ruleProp).every(rule => Array.isArray(rule[ruleProp]))).toBe(true);
 });
+const testKeysAreValidDimensionIds = ruleProp => it('keys should be valid dimension ids', () => {
+  expect(onlyRulesWithProp(ruleProp).every(rule => allArrayItemsAreValidDimensionIds(Object.keys(rule[ruleProp])))).toBe(true);
+});
 const testKeysAreValidAxisIds = ruleProp => it('keys should be valid axis ids', () => {
   expect(onlyRulesWithProp(ruleProp).every(rule => allArrayItemsAreValidAxisIds(Object.keys(rule[ruleProp])))).toBe(true);
 });
@@ -57,6 +62,13 @@ describe("verify each rule's ", () => {
       testNoValuesNegative(ruleProp);
     });
   });
+  describe('MAX_ITEMS_PER_DIM', () => {
+    const ruleProp = _rules.testResourceAllRuleProps['MAX_ITEMS_PER_DIM'];
+    testPropHasKeysAndValues(ruleProp);
+    testKeysAreValidDimensionIds(ruleProp);
+    testNoValuesZero(ruleProp);
+    testNoValuesNegative(ruleProp);
+  });
   describe('AVAILABLE_AXES', () => {
     const ruleProp = _rules.testResourceAllRuleProps['AVAILABLE_AXES'];
     testPropIsArray(ruleProp);

package/build/cjs/modules/layoutUiRules/index.js

@@ -45,6 +45,12 @@ Object.defineProperty(exports, "getAxisPerLockedDimension", {
     return _rulesHelper.getAxisPerLockedDimByVisType;
   }
 });
+Object.defineProperty(exports, "getDimensionMaxNumberOfItems", {
+  enumerable: true,
+  get: function () {
+    return _rulesHelper.getDimMaxNumberOfItemsByVisType;
+  }
+});
 Object.defineProperty(exports, "getDisallowedDimensions", {
   enumerable: true,
   get: function () {
@@ -63,6 +69,12 @@ Object.defineProperty(exports, "hasAxisTooManyItems", {
     return _rulesUtils.hasAxisTooManyItemsByVisType;
   }
 });
+Object.defineProperty(exports, "hasDimensionTooManyItems", {
+  enumerable: true,
+  get: function () {
+    return _rulesUtils.hasDimensionTooManyItemsByVisType;
+  }
+});
 Object.defineProperty(exports, "isAxisFull", {
   enumerable: true,
   get: function () {

package/build/cjs/modules/layoutUiRules/rules.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.testResourceRules = exports.testResourceRequiredProps = exports.testResourceAllRuleProps = exports.getMinNumberOfDimsPerAxisByVisType = exports.getMaxNumberOfItemsPerAxisByVisType = exports.getMaxNumberOfDimsPerAxisByVisType = exports.getLockedDimsByVisType = exports.getDisallowedDimsByVisType = exports.getAvailableAxesByVisType = void 0;
+exports.testResourceRules = exports.testResourceRequiredProps = exports.testResourceAllRuleProps = exports.getMinNumberOfDimsPerAxisByVisType = exports.getMaxNumberOfItemsPerDimByVisType = exports.getMaxNumberOfItemsPerAxisByVisType = exports.getMaxNumberOfDimsPerAxisByVisType = exports.getLockedDimsByVisType = exports.getDisallowedDimsByVisType = exports.getAvailableAxesByVisType = void 0;
 var _axis = require("../layout/axis.js");
 var _predefinedDimensions = require("../predefinedDimensions.js");
 var _visTypes = require("../visTypes.js");
@@ -11,6 +11,7 @@ const RULE_PROP_AVAILABLE_AXES = 'availableAxes',
   RULE_PROP_MAX_DIMS_PER_AXIS = 'maxNumberOfDimsPerAxis',
   RULE_PROP_MIN_DIMS_PER_AXIS = 'minNumberOfDimsPerAxis',
   RULE_PROP_MAX_ITEMS_PER_AXIS = 'maxNumberOfItemsPerAxis',
+  RULE_PROP_MAX_ITEMS_PER_DIM = 'maxNumberOfItemsPerDim',
   RULE_PROP_DISALLOWED_DIMS = 'disallowedDims',
   RULE_PROP_LOCKED_DIMS = 'lockedDims';
 const defaultRules = {
@@ -88,6 +89,21 @@ const scatterRules = {
 const lineListRules = {
   [RULE_PROP_AVAILABLE_AXES]: [_axis.AXIS_ID_COLUMNS, _axis.AXIS_ID_FILTERS]
 };
+const outlierTableRules = {
+  [RULE_PROP_AVAILABLE_AXES]: [_axis.AXIS_ID_COLUMNS],
+  [RULE_PROP_MIN_DIMS_PER_AXIS]: {
+    [_axis.AXIS_ID_COLUMNS]: 3
+  },
+  [RULE_PROP_MAX_ITEMS_PER_DIM]: {
+    [_predefinedDimensions.DIMENSION_ID_PERIOD]: 1
+  },
+  [RULE_PROP_LOCKED_DIMS]: {
+    [_predefinedDimensions.DIMENSION_ID_DATA]: _axis.AXIS_ID_COLUMNS,
+    [_predefinedDimensions.DIMENSION_ID_PERIOD]: _axis.AXIS_ID_COLUMNS,
+    [_predefinedDimensions.DIMENSION_ID_ORGUNIT]: _axis.AXIS_ID_COLUMNS
+  },
+  [RULE_PROP_DISALLOWED_DIMS]: [_predefinedDimensions.DIMENSION_ID_ASSIGNED_CATEGORIES]
+};
 const visTypeToRules = {
   [_visTypes.VIS_TYPE_COLUMN]: defaultRules,
   [_visTypes.VIS_TYPE_STACKED_COLUMN]: defaultRules,
@@ -104,7 +120,8 @@ const visTypeToRules = {
   [_visTypes.VIS_TYPE_YEAR_OVER_YEAR_COLUMN]: yearOverYearRules,
   [_visTypes.VIS_TYPE_PIVOT_TABLE]: pivotTableRules,
   [_visTypes.VIS_TYPE_SCATTER]: scatterRules,
-  [_visTypes.VIS_TYPE_LINE_LIST]: lineListRules
+  [_visTypes.VIS_TYPE_LINE_LIST]: lineListRules,
+  [_visTypes.VIS_TYPE_OUTLIER_TABLE]: outlierTableRules
 };
 const getRulesByVisType = visType => {
   const rules = visTypeToRules[visType];
@@ -122,6 +139,8 @@ const getMaxNumberOfDimsPerAxisByVisType = visType => getRulesByVisType(visType)
 exports.getMaxNumberOfDimsPerAxisByVisType = getMaxNumberOfDimsPerAxisByVisType;
 const getMinNumberOfDimsPerAxisByVisType = visType => getRulesByVisType(visType)[RULE_PROP_MIN_DIMS_PER_AXIS] || {};
 exports.getMinNumberOfDimsPerAxisByVisType = getMinNumberOfDimsPerAxisByVisType;
+const getMaxNumberOfItemsPerDimByVisType = visType => getRulesByVisType(visType)[RULE_PROP_MAX_ITEMS_PER_DIM] || {};
+exports.getMaxNumberOfItemsPerDimByVisType = getMaxNumberOfItemsPerDimByVisType;
 const getMaxNumberOfItemsPerAxisByVisType = visType => getRulesByVisType(visType)[RULE_PROP_MAX_ITEMS_PER_AXIS] || {};
 exports.getMaxNumberOfItemsPerAxisByVisType = getMaxNumberOfItemsPerAxisByVisType;
 const getDisallowedDimsByVisType = visType => getRulesByVisType(visType)[RULE_PROP_DISALLOWED_DIMS] || [];
@@ -139,6 +158,7 @@ const testResourceAllRuleProps = {
   MAX_DIMS_PER_AXIS: RULE_PROP_MAX_DIMS_PER_AXIS,
   MIN_DIMS_PER_AXIS: RULE_PROP_MIN_DIMS_PER_AXIS,
   MAX_ITEMS_PER_AXIS: RULE_PROP_MAX_ITEMS_PER_AXIS,
+  MAX_ITEMS_PER_DIM: RULE_PROP_MAX_ITEMS_PER_DIM,
   DISALLOWED_DIMS: RULE_PROP_DISALLOWED_DIMS,
   LOCKED_DIMS: RULE_PROP_LOCKED_DIMS
 };

package/build/cjs/modules/layoutUiRules/rulesHelper.js

@@ -10,7 +10,7 @@ Object.defineProperty(exports, "getAvailableAxesByVisType", {
     return _rules.getAvailableAxesByVisType;
   }
 });
-exports.getAxisPerLockedDimByVisType = exports.getAxisMinNumberOfDimsByVisType = exports.getAxisMaxNumberOfItemsByVisType = exports.getAxisMaxNumberOfDimsByVisType = void 0;
+exports.getDimMaxNumberOfItemsByVisType = exports.getAxisPerLockedDimByVisType = exports.getAxisMinNumberOfDimsByVisType = exports.getAxisMaxNumberOfItemsByVisType = exports.getAxisMaxNumberOfDimsByVisType = void 0;
 Object.defineProperty(exports, "getDisallowedDimsByVisType", {
   enumerable: true,
   get: function () {
@@ -29,4 +29,6 @@ exports.getAxisMinNumberOfDimsByVisType = getAxisMinNumberOfDimsByVisType;
 const getAxisPerLockedDimByVisType = (visType, dimensionId) => (0, _rules.getLockedDimsByVisType)(visType)[dimensionId];
 exports.getAxisPerLockedDimByVisType = getAxisPerLockedDimByVisType;
 const getAllLockedDimIdsByVisType = visType => Object.keys((0, _rules.getLockedDimsByVisType)(visType));
-exports.getAllLockedDimIdsByVisType = getAllLockedDimIdsByVisType;
+exports.getAllLockedDimIdsByVisType = getAllLockedDimIdsByVisType;
+const getDimMaxNumberOfItemsByVisType = (visType, dimensionId) => (0, _rules.getMaxNumberOfItemsPerDimByVisType)(visType)[dimensionId];
+exports.getDimMaxNumberOfItemsByVisType = getDimMaxNumberOfItemsByVisType;

package/build/cjs/modules/layoutUiRules/rulesUtils.js

@@ -3,14 +3,19 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isDimensionLockedByVisType = exports.isAxisFullByVisType = exports.hasAxisTooManyItemsByVisType = exports.getTransferableDimensionPerAxisByVisType = exports.canDimensionBeAddedToAxisByVisType = void 0;
+exports.isDimensionLockedByVisType = exports.isAxisFullByVisType = exports.hasDimensionTooManyItemsByVisType = exports.hasAxisTooManyItemsByVisType = exports.getTransferableDimensionPerAxisByVisType = exports.canDimensionBeAddedToAxisByVisType = void 0;
 var _rules = require("./rules.js");
 var _rulesHelper = require("./rulesHelper.js");
 const hasAxisTooManyItemsByVisType = (visType, axisId, numberOfItems) => {
   const maxNumberOfItemsPerAxis = (0, _rulesHelper.getAxisMaxNumberOfItemsByVisType)(visType, axisId);
-  return maxNumberOfItemsPerAxis ? numberOfItems > maxNumberOfItemsPerAxis : false;
+  return maxNumberOfItemsPerAxis && numberOfItems > maxNumberOfItemsPerAxis;
 };
 exports.hasAxisTooManyItemsByVisType = hasAxisTooManyItemsByVisType;
+const hasDimensionTooManyItemsByVisType = (visType, dimensionId, numberOfItems) => {
+  const maxNumberOfItemsPerDimension = (0, _rulesHelper.getDimMaxNumberOfItemsByVisType)(visType, dimensionId);
+  return maxNumberOfItemsPerDimension && numberOfItems > maxNumberOfItemsPerDimension;
+};
+exports.hasDimensionTooManyItemsByVisType = hasDimensionTooManyItemsByVisType;
 const isDimensionLockedByVisType = (visType, dimensionId) => (0, _rulesHelper.getAllLockedDimIdsByVisType)(visType).includes(dimensionId);
 exports.isDimensionLockedByVisType = isDimensionLockedByVisType;
 const isAxisFullByVisType = (visType, axisId, axisDimensionsCount) => axisDimensionsCount >= (0, _rulesHelper.getAxisMaxNumberOfDimsByVisType)(visType, axisId);

package/build/cjs/modules/visTypeToLayoutType.js

@@ -22,7 +22,8 @@ const visTypeToLayoutType = {
   [_visTypes.VIS_TYPE_SINGLE_VALUE]: _layoutTypes.LAYOUT_TYPE_PIE,
   [_visTypes.VIS_TYPE_PIVOT_TABLE]: _layoutTypes.LAYOUT_TYPE_PIVOT_TABLE,
   [_visTypes.VIS_TYPE_SCATTER]: _layoutTypes.LAYOUT_TYPE_SCATTER,
-  [_visTypes.VIS_TYPE_LINE_LIST]: _layoutTypes.LAYOUT_TYPE_LINE_LIST
+  [_visTypes.VIS_TYPE_LINE_LIST]: _layoutTypes.LAYOUT_TYPE_LINE_LIST,
+  [_visTypes.VIS_TYPE_OUTLIER_TABLE]: _layoutTypes.LAYOUT_TYPE_OUTLIER_TABLE
 };
 const getLayoutTypeByVisType = visType => visTypeToLayoutType[visType];
 exports.getLayoutTypeByVisType = getLayoutTypeByVisType;