Skip to content

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

Keep dominant treemap share honest instead of rounding to 100% (#77602)

Oleh Kebea514c841a
diff --git a/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsx b/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsx
index ef8edfa9c7e..8f067adc12a 100644
--- a/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsx
+++ b/frontend/src/metabase/static-viz/components/TreemapChart/TreemapChart.tsx
@@ -60,7 +60,7 @@ export function TreemapChart({
settings,
);
const colors = getTreemapColors(tree, treemapRows);
- const formatters = getTreemapFormatters(treemapColumns, settings);
+ const formatters = getTreemapFormatters(treemapColumns, settings, tree);
const config: TreemapChartOptionConfig = {
tree,
diff --git a/frontend/src/metabase/visualizations/echarts/graph/treemap/model/formatters.ts b/frontend/src/metabase/visualizations/echarts/graph/treemap/model/formatters.ts
index df3a167ff11..a179d89a88e 100644
--- a/frontend/src/metabase/visualizations/echarts/graph/treemap/model/formatters.ts
+++ b/frontend/src/metabase/visualizations/echarts/graph/treemap/model/formatters.ts
@@ -1,5 +1,6 @@
import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";
import { formatValue } from "metabase/visualizations/lib/formatting";
+import { computeMaxDecimalsForValues } from "metabase/visualizations/lib/utils";
import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
import type { DatasetColumn, RowValue } from "metabase-types/api";
@@ -11,11 +12,38 @@ export interface TreemapFormatters {
percent: (ratio: number) => string;
}
+const DEFAULT_PERCENT_DECIMALS = 2;
+const PERCENT_SIGNIFICANT_DIGITS = 2;
+
+function getPercentDecimals(tree: TreemapTree): number {
+ const total = getTreemapTotal(tree);
+ if (total === 0) {
+ return DEFAULT_PERCENT_DECIMALS;
+ }
+
+ const shares = tree.flatMap((root) => [
+ root.value / total,
+ ...(root.children ?? []).map((leaf) => leaf.value / total),
+ ]);
+
+ const decimals = computeMaxDecimalsForValues(shares, {
+ style: "percent",
+ maximumSignificantDigits: PERCENT_SIGNIFICANT_DIGITS,
+ });
+
+ return Math.max(
+ DEFAULT_PERCENT_DECIMALS,
+ decimals ?? DEFAULT_PERCENT_DECIMALS,
+ );
+}
+
export function getTreemapFormatters(
columns: TreemapChartColumns,
settings: ComputedVisualizationSettings,
+ tree: TreemapTree,
): TreemapFormatters {
const valueColumn = columns.value.column;
+ const percentDecimals = getPercentDecimals(tree);
return {
value: getTreemapColumnFormatter(valueColumn, settings),
percent: (ratio: number) =>
@@ -23,7 +51,7 @@ export function getTreemapFormatters(
formatValue(ratio, {
column: valueColumn,
number_style: "percent",
- decimals: Math.abs(ratio) === 1 ? 0 : 2,
+ decimals: Math.abs(ratio) === 1 ? 0 : percentDecimals,
}),
),
};
diff --git a/frontend/src/metabase/visualizations/echarts/graph/treemap/model/formatters.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/graph/treemap/model/formatters.unit.spec.ts
new file mode 100644
index 00000000000..1db43cc3a4e
--- /dev/null
+++ b/frontend/src/metabase/visualizations/echarts/graph/treemap/model/formatters.unit.spec.ts
@@ -0,0 +1,74 @@
+import { createMockColumn } from "metabase-types/api/mocks/dataset";
+
+import { getTreemapFormatters } from "./formatters";
+import type { TreemapChartColumns, TreemapTree } from "./types";
+
+const valueColumn = createMockColumn({
+ name: "Amount",
+ display_name: "Amount",
+ base_type: "type/Number",
+ semantic_type: "type/Number",
+});
+
+const columns: TreemapChartColumns = {
+ grouping: {
+ index: 0,
+ column: createMockColumn({ name: "Category", base_type: "type/Text" }),
+ },
+ value: { index: 1, column: valueColumn },
+};
+
+function makeTree(...values: number[]): TreemapTree {
+ return values.map((value, index) => ({
+ rawName: `n${index}`,
+ displayName: `n${index}`,
+ value,
+ rowIndices: [index],
+ }));
+}
+
+type SetupOpts = {
+ tree: TreemapTree;
+};
+
+function setup({ tree }: SetupOpts) {
+ return getTreemapFormatters(columns, { column: () => ({}) }, tree);
+}
+
+describe("getTreemapFormatters percent", () => {
+ it("keeps a dominant share honest instead of rounding it to 100%", () => {
+ const total = 100001;
+ const { percent } = setup({ tree: makeTree(100000, 1) });
+
+ expect(percent(100000 / total)).toBe("99.999%");
+ expect(percent(1 / total)).toBe("0.001%");
+ });
+
+ it("uses two decimals by default for evenly split values", () => {
+ const { percent } = setup({ tree: makeTree(1, 1, 1) });
+
+ expect(percent(1 / 3)).toBe("33.33%");
+ });
+
+ it("renders an exact whole share without decimals", () => {
+ const { percent } = setup({ tree: makeTree(10) });
+
+ expect(percent(1)).toBe("100%");
+ });
+
+ it("considers leaf shares when picking the decimal count", () => {
+ const total = 100001;
+ const tree: TreemapTree = [
+ {
+ rawName: "root",
+ displayName: "root",
+ value: total,
+ rowIndices: [0, 1],
+ children: makeTree(100000, 1),
+ },
+ ];
+ const { percent } = setup({ tree });
+
+ expect(percent(100000 / total)).toBe("99.999%");
+ });
+});
diff --git a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
index 28ca02afc1c..c5a32bad4af 100644
--- a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
@@ -86,7 +86,11 @@ export const TreemapChart = ({
const formatters = useMemo(
() =>
chartData
- ? getTreemapFormatters(chartData.treemapColumns, settings)
+ ? getTreemapFormatters(
+ chartData.treemapColumns,
+ settings,
+ chartData.tree,
+ )
: null,
[chartData, settings],
);