Skip to content

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

[UXW-3769] Fix Tooltip for total bar in waterfall charts shows transformed value (#73892)

Andrei Chernykh78d6c369e5de
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/dataset.ts b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/dataset.ts
index b6c73b7dc65..40e9f81dfce 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/dataset.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/dataset.ts
@@ -114,7 +114,7 @@ export const getWaterfallDataset = (
export const extendOriginalDatasetWithTotalDatum = (
dataset: ChartDataset,
- waterfallDatasetTotalDatum: Datum,
+ totalValue: RowValue,
seriesDataKey: DataKey,
settings: ComputedVisualizationSettings,
) => {
@@ -123,7 +123,7 @@ export const extendOriginalDatasetWithTotalDatum = (
}
const totalDatum: Datum = {
- [seriesDataKey]: waterfallDatasetTotalDatum[WATERFALL_TOTAL_KEY],
+ [seriesDataKey]: totalValue,
[X_AXIS_DATA_KEY]: t`Total`,
[IS_WATERFALL_TOTAL_DATA_KEY]: true,
};
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/dataset.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/dataset.unit.spec.ts
new file mode 100644
index 00000000000..5838f3ce41a
--- /dev/null
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/dataset.unit.spec.ts
@@ -0,0 +1,57 @@
+import {
+ IS_WATERFALL_TOTAL_DATA_KEY,
+ X_AXIS_DATA_KEY,
+} from "metabase/visualizations/echarts/cartesian/constants/dataset";
+import type { ChartDataset } from "metabase/visualizations/echarts/cartesian/model/types";
+import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
+import { createMockVisualizationSettings } from "metabase-types/api/mocks";
+
+import { extendOriginalDatasetWithTotalDatum } from "./dataset";
+
+const settings = (
+ overrides: Partial<ComputedVisualizationSettings> = {},
+): ComputedVisualizationSettings =>
+ createMockVisualizationSettings({
+ "waterfall.show_total": true,
+ ...overrides,
+ });
+
+describe("extendOriginalDatasetWithTotalDatum", () => {
+ const seriesKey = "count";
+ const dataset: ChartDataset = [
+ { [X_AXIS_DATA_KEY]: "a", [seriesKey]: 100 },
+ { [X_AXIS_DATA_KEY]: "b", [seriesKey]: 200 },
+ ];
+
+ it("appends a total datum with the raw value it was given", () => {
+ const result = extendOriginalDatasetWithTotalDatum(
+ dataset,
+ 300,
+ seriesKey,
+ settings(),
+ );
+
+ expect(result).toHaveLength(3);
+ expect(result[2][seriesKey]).toBe(300);
+ expect(result[2][IS_WATERFALL_TOTAL_DATA_KEY]).toBe(true);
+ });
+
+ it("returns the dataset unchanged when waterfall.show_total is off", () => {
+ const result = extendOriginalDatasetWithTotalDatum(
+ dataset,
+ 300,
+ seriesKey,
+ settings({ "waterfall.show_total": false }),
+ );
+
+ expect(result).toBe(dataset);
+ });
+
+ it("returns the dataset unchanged when it is empty", () => {
+ const empty: ChartDataset = [];
+
+ expect(
+ extendOriginalDatasetWithTotalDatum(empty, 0, seriesKey, settings()),
+ ).toBe(empty);
+ });
+});
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/index.ts b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/index.ts
index 7e667d0d3b5..5ac99875972 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/index.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/index.ts
@@ -15,6 +15,7 @@ import {
import type { WaterfallChartModel } from "metabase/visualizations/echarts/cartesian/model/types";
import type { ShowWarning } from "metabase/visualizations/echarts/types";
import { getCartesianChartColumns } from "metabase/visualizations/lib/graph/columns";
+import { getNumberOr } from "metabase/visualizations/lib/settings/row-values";
import type {
ComputedVisualizationSettings,
RenderingContext,
@@ -117,10 +118,16 @@ export const getWaterfallChartModel = (
},
);
- // Extending the original dataset with total datum for tooltips
+ // Extending the original dataset with total datum for tooltips. Sum from the
+ // untransformed scaledDataset so the tooltip shows the raw total, not the
+ // y-axis-transformed value (e.g. with log/power scale).
+ const untransformedTotal = scaledDataset.reduce(
+ (sum, datum) => sum + getNumberOr(datum[seriesModel.dataKey], 0),
+ 0,
+ );
const originalDatasetWithTotal = extendOriginalDatasetWithTotalDatum(
scaledDataset,
- transformedDataset[transformedDataset.length - 1],
+ untransformedTotal,
seriesModel.dataKey,
settings,
);
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/index.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/index.unit.spec.ts
new file mode 100644
index 00000000000..19773583951
--- /dev/null
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/model/index.unit.spec.ts
@@ -0,0 +1,96 @@
+import { IS_WATERFALL_TOTAL_DATA_KEY } from "metabase/visualizations/echarts/cartesian/constants/dataset";
+import type {
+ ComputedVisualizationSettings,
+ RenderingContext,
+} from "metabase/visualizations/types";
+import type { RawSeries } from "metabase-types/api";
+import {
+ createMockCard,
+ createMockColumn,
+ createMockDatasetData,
+ createMockVisualizationSettings,
+} from "metabase-types/api/mocks";
+
+import { getWaterfallChartModel } from "./index";
+
+describe("getWaterfallChartModel", () => {
+ const dimensionColumn = createMockColumn({
+ name: "bucket",
+ display_name: "Bucket",
+ base_type: "type/Text",
+ semantic_type: "type/Category",
+ });
+ const metricColumn = createMockColumn({
+ name: "count",
+ display_name: "Count",
+ base_type: "type/Integer",
+ semantic_type: "type/Quantity",
+ });
+
+ // Includes a negative value so the running total is not monotonic; this
+ // prevents accidentally testing the "last end happens to equal the sum" case.
+ const rows: [string, number][] = [
+ ["a", 100],
+ ["b", 200],
+ ["c", -50],
+ ["d", 300],
+ ];
+ const expectedRawTotal = 550;
+
+ const rawSeries: RawSeries = [
+ {
+ card: createMockCard({ id: 1, name: "Waterfall", display: "waterfall" }),
+ data: createMockDatasetData({
+ rows,
+ cols: [dimensionColumn, metricColumn],
+ }),
+ },
+ ];
+
+ const renderingContext: RenderingContext = {
+ getColor: () => "#000000",
+ measureText: () => 10,
+ measureTextHeight: () => 10,
+ fontFamily: "Arial",
+ theme: { cartesian: { label: { fontSize: 12 } } } as any,
+ };
+
+ const buildModel = (
+ yAxisScale: "linear" | "log" | "pow",
+ extraSettings: Partial<ComputedVisualizationSettings> = {},
+ ) =>
+ getWaterfallChartModel(
+ rawSeries,
+ createMockVisualizationSettings({
+ "graph.dimensions": [dimensionColumn.name],
+ "graph.metrics": [metricColumn.name],
+ "graph.x_axis.scale": "ordinal",
+ "graph.y_axis.scale": yAxisScale,
+ "waterfall.show_total": true,
+ ...extraSettings,
+ }),
+ [],
+ renderingContext,
+ );
+
+ it.each(["linear", "log", "pow"] as const)(
+ "puts the raw total (not the y-axis-transformed value) into the dataset's Total row on %s scale",
+ (scale) => {
+ const { dataset, seriesModels } = buildModel(scale);
+ const seriesDataKey = seriesModels[0].dataKey;
+
+ const totalDatum = dataset[dataset.length - 1];
+ expect(totalDatum[IS_WATERFALL_TOTAL_DATA_KEY]).toBe(true);
+ expect(totalDatum[seriesDataKey]).toBe(expectedRawTotal);
+ },
+ );
+
+ it("omits the Total row when waterfall.show_total is disabled", () => {
+ const { dataset } = buildModel("log", { "waterfall.show_total": false });
+
+ expect(dataset).toHaveLength(rows.length);
+ expect(
+ dataset.some((datum) => datum[IS_WATERFALL_TOTAL_DATA_KEY] === true),
+ ).toBe(false);
+ });
+});