Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Use lowest cardinality dimension as default for boxplot (#70569)

Kevin Kelleher9bfb9ed7a4d3
diff --git a/.loki/reference/chrome_laptop_Viz_Static_Viz_BoxPlotChart_Box_Plot_Customization.png b/.loki/reference/chrome_laptop_Viz_Static_Viz_BoxPlotChart_Box_Plot_Customization.png
index 88a4f9f8cbf..eab15e9faa7 100644
Binary files a/.loki/reference/chrome_laptop_Viz_Static_Viz_BoxPlotChart_Box_Plot_Customization.png and b/.loki/reference/chrome_laptop_Viz_Static_Viz_BoxPlotChart_Box_Plot_Customization.png differ
diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.ts b/frontend/src/metabase/visualizations/lib/settings/graph.ts
index 5b62b754ebf..e0661c9dd70 100644
--- a/frontend/src/metabase/visualizations/lib/settings/graph.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/graph.ts
@@ -25,6 +25,7 @@ import {
getAvailableAdditionalColumns,
getAvailableXAxisScales,
getComputedAdditionalColumnsValue,
+ getDefaultBoxplotDimensions,
getDefaultColumns,
getDefaultDataLabelsFrequency,
getDefaultDimensionFilter,
@@ -1136,8 +1137,6 @@ export const BOXPLOT_DATA_SETTINGS: VisualizationSettingsDefinitions = {
...GRAPH_DATA_SETTINGS,
"graph.dimensions": {
...GRAPH_DATA_SETTINGS["graph.dimensions"],
- getDefault: (series, vizSettings) =>
- // As BoxPlot needs unaggregated data, we only default to one dimension even if there are multiple dimensions available
- getDefaultDimensions(series, vizSettings).slice(0, 1),
+ getDefault: getDefaultBoxplotDimensions,
},
};
diff --git a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
index 7d163f663e3..9e443e8b4b8 100644
--- a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
+++ b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
@@ -534,3 +534,32 @@ export function getSeriesModelsForSettings(
const cardsColumns = getCardsColumns(rawSeries, settings);
return getCardsSeriesModels(rawSeries, cardsColumns, [], settings);
}
+
+export function getDefaultBoxplotDimensions(
+ series: RawSeries,
+ settings: ComputedVisualizationSettings,
+) {
+ // since a boxplot needs unaggregated data, we default to only one dimension - the one with the lowest cardinality
+ const dimensions = getDefaultDimensions(series, settings);
+ if (dimensions.length <= 1) {
+ return dimensions;
+ }
+ const { cols, rows } = series[0].data;
+ let lowestDimension: string | undefined;
+ let lowestCardinality = Infinity;
+ for (const dimension of dimensions) {
+ const index = cols.findIndex((col) => col.name === dimension);
+ if (index === -1) {
+ continue;
+ }
+ const cardinality = getColumnCardinality(cols, rows, index);
+ if (cardinality < lowestCardinality) {
+ lowestDimension = dimension;
+ lowestCardinality = cardinality;
+ }
+ }
+ if (lowestDimension === undefined) {
+ return [];
+ }
+ return [lowestDimension];
+}
diff --git a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts
index c690efddddf..c408bb67b9e 100644
--- a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.unit.spec.ts
@@ -1,4 +1,5 @@
import {
+ getDefaultBoxplotDimensions,
getDefaultColumns,
getDefaultDimensions,
getDefaultMetrics,
@@ -236,3 +237,42 @@ describe("getDefaultColumns", () => {
});
});
});
+
+describe("getDefaultBoxplotDimensions", () => {
+ it("should return the dimension with the lowest cardinality", () => {
+ const cols = [
+ createMockColumn({
+ name: "category",
+ display_name: "Category",
+ source: "breakout",
+ }),
+ createMockColumn({
+ name: "status",
+ display_name: "Status",
+ source: "breakout",
+ }),
+ createMockColumn({
+ name: "total",
+ display_name: "Total",
+ base_type: "type/Integer",
+ source: "aggregation",
+ }),
+ ];
+
+ const rows = [
+ ["Electronics", "active", 100],
+ ["Electronics", "inactive", 50],
+ ["Clothing", "active", 75],
+ ["Clothing", "inactive", 25],
+ ["Food", "active", 60],
+ ["Food", "inactive", 30],
+ ];
+
+ const series = createSeries({ display: "boxplot", cols, rows });
+
+ const result = getDefaultBoxplotDimensions(series, {});
+
+ // "status" has cardinality 2, "category" has cardinality 3
+ expect(result).toEqual(["status"]);
+ });
+});