@hitachivantara/uikit-react-viz 5.10.1 → 5.11.0

package/dist/esm/utils/index.js

@@ -32,8 +32,35 @@ const getMeasure = (name, msr) => {
     return m.field === measureName;
   }) ?? measuresArray[0];
 };
+const getFilterFunction = (operation, field, value) => {
+  switch (operation) {
+    case "is": {
+      const valueArray = Array.isArray(value) ? value : [value];
+      return (row) => valueArray.includes(row[field]);
+    }
+    case "isNot": {
+      const valueArray = Array.isArray(value) ? value : [value];
+      return (row) => !valueArray.includes(row[field]);
+    }
+    case "contains":
+      return (row) => row[field].includes(value);
+    case "greaterThan":
+      return (row) => row[field] > (Array.isArray(value) ? value[0] : value);
+    case "greaterThanOrEqual":
+      return (row) => row[field] >= (Array.isArray(value) ? value[0] : value);
+    case "lessThan":
+      return (row) => row[field] < (Array.isArray(value) ? value[0] : value);
+    case "lessThanOrEqual":
+      return (row) => row[field] <= (Array.isArray(value) ? value[0] : value);
+    case "between":
+      return (row) => row[field] >= value[0] && row[field] <= value[1];
+    default:
+      throw new Error("Unsupported operation");
+  }
+};
 export {
   getAxisType,
+  getFilterFunction,
   getGroupKey,
   getLegendIcon,
   getMeasure

package/dist/esm/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../src/utils/index.ts"],"sourcesContent":["import { Arrayable } from \"@hitachivantara/uikit-react-core\";\n\nimport type {\n  HvBarChartMeasures,\n  HvChartAxisType,\n  HvDonutChartMeasure,\n  HvLineChartMeasures,\n} from \"..\";\nimport { HvChartCommonProps } from \"../types/common\";\nimport { HvChartLegendIcon } from \"../types/legend\";\nimport { HvScatterPlotMeasure } from \"../types/measures\";\n\nexport const getAxisType = (type?: HvChartAxisType) => {\n  switch (type) {\n    case \"categorical\":\n      return \"category\";\n    case \"time\":\n      return \"time\";\n    case \"continuous\":\n      return \"value\";\n    default:\n      return undefined;\n  }\n};\n\nexport const getGroupKey = (groupBy: HvChartCommonProps[\"groupBy\"]) =>\n  Array.isArray(groupBy) ? groupBy.join(\"_\") : groupBy;\n\nexport const getLegendIcon = (icon: HvChartLegendIcon) => {\n  switch (icon) {\n    case \"circle\":\n      return \"circle\";\n    case \"square\":\n      return \"path://M0,0L16,0L16,16L0,16L0,0Z\";\n    case \"line\":\n    default:\n      return \"path://M0,0L16,0L16,2L0,2Z\";\n  }\n};\n\nexport const getMeasure = (\n  name: string,\n  msr:\n    | Arrayable<HvLineChartMeasures | HvBarChartMeasures | HvScatterPlotMeasure>\n    | HvDonutChartMeasure,\n):\n  | HvLineChartMeasures\n  | HvBarChartMeasures\n  | HvDonutChartMeasure\n  | HvScatterPlotMeasure => {\n  const measureName = name.split(\"_\")[0];\n  const measuresArray = Array.isArray(msr) ? msr : [msr];\n  // find the measure in measures array or return the first one\n  return (\n    measuresArray.find((m) => {\n      if (typeof m === \"string\") {\n        return m === measureName;\n      }\n      return m.field === measureName;\n    }) ?? measuresArray[0]\n  );\n};\n"],"names":[],"mappings":"AAYa,MAAA,cAAc,CAAC,SAA2B;AACrD,UAAQ,MAAM;AAAA,IACZ,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AACI,aAAA;AAAA,IACT;AACS,aAAA;AAAA,EACX;AACF;AAEa,MAAA,cAAc,CAAC,YAC1B,MAAM,QAAQ,OAAO,IAAI,QAAQ,KAAK,GAAG,IAAI;AAElC,MAAA,gBAAgB,CAAC,SAA4B;AACxD,UAAQ,MAAM;AAAA,IACZ,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AAAA,IACL;AACS,aAAA;AAAA,EACX;AACF;AAEa,MAAA,aAAa,CACxB,MACA,QAO0B;AAC1B,QAAM,cAAc,KAAK,MAAM,GAAG,EAAE,CAAC;AACrC,QAAM,gBAAgB,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,GAAG;AAGnD,SAAA,cAAc,KAAK,CAAC,MAAM;AACpB,QAAA,OAAO,MAAM,UAAU;AACzB,aAAO,MAAM;AAAA,IACf;AACA,WAAO,EAAE,UAAU;AAAA,EAAA,CACpB,KAAK,cAAc,CAAC;AAEzB;"}
+{"version":3,"file":"index.js","sources":["../../../src/utils/index.ts"],"sourcesContent":["import { Arrayable } from \"@hitachivantara/uikit-react-core\";\n\nimport type {\n  HvBarChartMeasures,\n  HvChartAxisType,\n  HvChartFilter,\n  HvChartFilterOperation,\n  HvDonutChartMeasure,\n  HvLineChartMeasures,\n} from \"..\";\nimport { HvChartCommonProps } from \"../types/common\";\nimport { HvChartLegendIcon } from \"../types/legend\";\nimport { HvScatterPlotMeasure } from \"../types/measures\";\n\nexport const getAxisType = (type?: HvChartAxisType) => {\n  switch (type) {\n    case \"categorical\":\n      return \"category\";\n    case \"time\":\n      return \"time\";\n    case \"continuous\":\n      return \"value\";\n    default:\n      return undefined;\n  }\n};\n\nexport const getGroupKey = (groupBy: HvChartCommonProps[\"groupBy\"]) =>\n  Array.isArray(groupBy) ? groupBy.join(\"_\") : groupBy;\n\nexport const getLegendIcon = (icon: HvChartLegendIcon) => {\n  switch (icon) {\n    case \"circle\":\n      return \"circle\";\n    case \"square\":\n      return \"path://M0,0L16,0L16,16L0,16L0,0Z\";\n    case \"line\":\n    default:\n      return \"path://M0,0L16,0L16,2L0,2Z\";\n  }\n};\n\nexport const getMeasure = (\n  name: string,\n  msr:\n    | Arrayable<HvLineChartMeasures | HvBarChartMeasures | HvScatterPlotMeasure>\n    | HvDonutChartMeasure,\n):\n  | HvLineChartMeasures\n  | HvBarChartMeasures\n  | HvDonutChartMeasure\n  | HvScatterPlotMeasure => {\n  const measureName = name.split(\"_\")[0];\n  const measuresArray = Array.isArray(msr) ? msr : [msr];\n  // find the measure in measures array or return the first one\n  return (\n    measuresArray.find((m) => {\n      if (typeof m === \"string\") {\n        return m === measureName;\n      }\n      return m.field === measureName;\n    }) ?? measuresArray[0]\n  );\n};\n\nexport const getFilterFunction = (\n  operation: HvChartFilterOperation,\n  field: HvChartFilter[\"field\"],\n  value: HvChartFilter[\"value\"],\n): Function => {\n  switch (operation) {\n    case \"is\": {\n      const valueArray = Array.isArray(value) ? value : [value];\n      return (row: any) => valueArray.includes(row[field]);\n    }\n    case \"isNot\": {\n      const valueArray = Array.isArray(value) ? value : [value];\n      return (row: any) => !valueArray.includes(row[field]);\n    }\n    case \"contains\":\n      return (row: any) => row[field].includes(value);\n    case \"greaterThan\":\n      return (row: any) =>\n        row[field] > (Array.isArray(value) ? value[0] : value);\n    case \"greaterThanOrEqual\":\n      return (row: any) =>\n        row[field] >= (Array.isArray(value) ? value[0] : value);\n    case \"lessThan\":\n      return (row: any) =>\n        row[field] < (Array.isArray(value) ? value[0] : value);\n    case \"lessThanOrEqual\":\n      return (row: any) =>\n        row[field] <= (Array.isArray(value) ? value[0] : value);\n    case \"between\":\n      return (row: any) => row[field] >= value[0] && row[field] <= value[1];\n\n    default:\n      throw new Error(\"Unsupported operation\");\n  }\n};\n"],"names":[],"mappings":"AAca,MAAA,cAAc,CAAC,SAA2B;AACrD,UAAQ,MAAM;AAAA,IACZ,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AACI,aAAA;AAAA,IACT;AACS,aAAA;AAAA,EACX;AACF;AAEa,MAAA,cAAc,CAAC,YAC1B,MAAM,QAAQ,OAAO,IAAI,QAAQ,KAAK,GAAG,IAAI;AAElC,MAAA,gBAAgB,CAAC,SAA4B;AACxD,UAAQ,MAAM;AAAA,IACZ,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AACI,aAAA;AAAA,IACT,KAAK;AAAA,IACL;AACS,aAAA;AAAA,EACX;AACF;AAEa,MAAA,aAAa,CACxB,MACA,QAO0B;AAC1B,QAAM,cAAc,KAAK,MAAM,GAAG,EAAE,CAAC;AACrC,QAAM,gBAAgB,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,GAAG;AAGnD,SAAA,cAAc,KAAK,CAAC,MAAM;AACpB,QAAA,OAAO,MAAM,UAAU;AACzB,aAAO,MAAM;AAAA,IACf;AACA,WAAO,EAAE,UAAU;AAAA,EAAA,CACpB,KAAK,cAAc,CAAC;AAEzB;AAEO,MAAM,oBAAoB,CAC/B,WACA,OACA,UACa;AACb,UAAQ,WAAW;AAAA,IACjB,KAAK,MAAM;AACT,YAAM,aAAa,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK;AACxD,aAAO,CAAC,QAAa,WAAW,SAAS,IAAI,KAAK,CAAC;AAAA,IACrD;AAAA,IACA,KAAK,SAAS;AACZ,YAAM,aAAa,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK;AACxD,aAAO,CAAC,QAAa,CAAC,WAAW,SAAS,IAAI,KAAK,CAAC;AAAA,IACtD;AAAA,IACA,KAAK;AACH,aAAO,CAAC,QAAa,IAAI,KAAK,EAAE,SAAS,KAAK;AAAA,IAChD,KAAK;AACI,aAAA,CAAC,QACN,IAAI,KAAK,KAAK,MAAM,QAAQ,KAAK,IAAI,MAAM,CAAC,IAAI;AAAA,IACpD,KAAK;AACI,aAAA,CAAC,QACN,IAAI,KAAK,MAAM,MAAM,QAAQ,KAAK,IAAI,MAAM,CAAC,IAAI;AAAA,IACrD,KAAK;AACI,aAAA,CAAC,QACN,IAAI,KAAK,KAAK,MAAM,QAAQ,KAAK,IAAI,MAAM,CAAC,IAAI;AAAA,IACpD,KAAK;AACI,aAAA,CAAC,QACN,IAAI,KAAK,MAAM,MAAM,QAAQ,KAAK,IAAI,MAAM,CAAC,IAAI;AAAA,IACrD,KAAK;AACH,aAAO,CAAC,QAAa,IAAI,KAAK,KAAK,MAAM,CAAC,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC;AAAA,IAEtE;AACQ,YAAA,IAAI,MAAM,uBAAuB;AAAA,EAC3C;AACF;"}

package/dist/types/index.d.ts

@@ -39,6 +39,9 @@ declare interface BaseMeasure {
     valueFormatter?: (value?: string | number) => string;
 }
 
+declare interface BoxplotMeasure extends Omit<BaseMeasure, "agg" | "valueFormatter">, Omit<AxisMeasure, "stack" | "sampling"> {
+}
+
 declare interface ConfusionMatrixMeasure extends BaseMeasure {
 }
 
@@ -100,6 +103,28 @@ export declare interface HvBarChartProps extends HvAxisChartCommonProps, HvChart
     classes?: HvBarChartClasses;
 }
 
+/**
+ * A Boxplot chart visually summarizes the distribution of a dataset by depicting key statistical measures such as the median, quartiles, and outliers.
+ */
+export declare const HvBoxplot: ForwardRefExoticComponent<HvBoxplotProps & RefAttributes<default_3>>;
+
+export declare type HvBoxplotClasses = ExtractNames<typeof useClasses_4>;
+
+export declare type HvBoxplotMeasure = string | BoxplotMeasure;
+
+export declare interface HvBoxplotProps extends HvAxisChartCommonProps, Omit<HvChartCommonProps, "groupBy"> {
+    /** The name of the heatmap */
+    name?: string;
+    /**  Columns to measure on the chart. */
+    measures: Arrayable<HvBoxplotMeasure>;
+    /** Columns to use to group the data. */
+    groupBy?: string;
+    /** The tooltip options. */
+    tooltip?: Omit<HvChartTooltip, "type" | "valueFormatter" | "titleFormatter">;
+    /** A Jss Object used to override or extend the styles applied to the component. */
+    classes?: HvBoxplotClasses;
+}
+
 /** Aggregation functions */
 export declare type HvChartAggregation = "sum" | "average" | "min" | "max" | "count";
 
@@ -159,6 +184,8 @@ declare interface HvChartCommonProps {
     groupBy: Arrayable<string>;
     /** Columns to use to sort the data points. */
     sortBy?: Arrayable<HvChartSortBy>;
+    /** Filters to apply to the data. */
+    filters?: Arrayable<HvChartFilter>;
     /** Tooltip options. */
     tooltip?: HvChartTooltip;
     /** Legend options. */
@@ -184,6 +211,14 @@ export declare type HvChartData = Map<string | number, (string | number)[]> | Re
 
 export declare type HvChartEmptyCellMode = (typeof emptyCellMode)[number];
 
+export declare type HvChartFilter = {
+    field: string;
+    operation: HvChartFilterOperation;
+    value: string | string[] | number | number[];
+};
+
+export declare type HvChartFilterOperation = "is" | "isNot" | "contains" | "greaterThan" | "greaterThanOrEqual" | "lessThan" | "lessThanOrEqual" | "between";
+
 export declare interface HvChartGrid {
     /** Distance between the grid and the top of the container. */
     top?: string | number;
@@ -359,7 +394,7 @@ export declare type HvHeatmapData = Array<HvHeatmapItem>;
 
 export declare type HvHeatmapItem = Array<number | string>;
 
-export declare interface HvHeatmapProps extends Omit<HvChartCommonProps, "data" | "groupBy" | "sortBy" | "grid" | "legend" | "tooltip"> {
+export declare interface HvHeatmapProps extends Omit<HvChartCommonProps, "data" | "groupBy" | "sortBy" | "grid" | "legend" | "tooltip" | "filters"> {
     /** The name of the heatmap */
     name?: string;
     /** The data to use on the heatmap */
@@ -430,7 +465,7 @@ export declare const HvTreemapChart: ForwardRefExoticComponent<HvTreemapChartPro
 export declare interface HvTreemapChartClasses extends HvChartTooltipClasses {
 }
 
-export declare interface HvTreemapChartProps extends Omit<HvChartCommonProps, "data" | "groupBy" | "sortBy" | "grid" | "legend" | "tooltip"> {
+export declare interface HvTreemapChartProps extends Omit<HvChartCommonProps, "data" | "groupBy" | "sortBy" | "grid" | "legend" | "tooltip" | "filters"> {
     /** The name of the treemap */
     name?: string;
     /** The data to use on the treemap */
@@ -553,6 +588,19 @@ declare const useClasses_3: (classesProp?: Partial<Record<"tooltipRoot" | "toolt
     cx: (...args: any) => string;
 };
 
+declare const useClasses_4: (classesProp?: Partial<Record<"tooltipRoot" | "tooltipContainer" | "tooltipText", string>>, addStatic?: boolean) => {
+    classes: {
+        tooltipRoot: string;
+        tooltipContainer: string;
+        tooltipText: string;
+    };
+    css: {
+        (template: TemplateStringsArray, ...args: CSSInterpolation[]): string;
+        (...args: CSSInterpolation[]): string;
+    };
+    cx: (...args: any) => string;
+};
+
 declare interface XAxis extends HvChartXAxis {
     data?: string[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hitachivantara/uikit-react-viz",
-  "version": "5.10.1",
+  "version": "5.11.0",
   "private": false,
   "author": "Hitachi Vantara UI Kit Team",
   "description": "Contributed React visualization components for the NEXT UI Kit.",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@emotion/css": "^11.11.0",
-    "@hitachivantara/uikit-react-core": "^5.64.3"
+    "@hitachivantara/uikit-react-core": "^5.64.4"
   },
   "files": [
     "dist"
@@ -42,7 +42,7 @@
     "access": "public",
     "directory": "package"
   },
-  "gitHead": "e4d9b95ff33f0a36aa8205bd3529475974aa0fe2",
+  "gitHead": "619dcd24f060c174736375f95f603b41784cb0c8",
   "exports": {
     ".": {
       "require": "./dist/cjs/index.cjs",