Skip to content

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

Make stacked row chart tooltips use custom display names (#67706)

Anderson336180ee0c3f
diff --git a/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsx b/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsx
index 60a777af672..3a910576eee 100644
--- a/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsx
+++ b/frontend/src/metabase/static-viz/components/RowChart/RowChart.tsx
@@ -93,7 +93,7 @@ export const StaticRowChart = ({
const xValueRange = getXValueRange(settings);
const labelledSeries = getLabelledSeries(settings, series);
- const legendItems = getLegendItems(series, seriesColors, settings);
+ const legendItems = getLegendItems(series, seriesColors);
const legend = calculateLegendRows({
items: legendItems,
width,
diff --git a/frontend/src/metabase/visualizations/shared/utils/data.ts b/frontend/src/metabase/visualizations/shared/utils/data.ts
index 14a41c14193..f18b6582739 100644
--- a/frontend/src/metabase/visualizations/shared/utils/data.ts
+++ b/frontend/src/metabase/visualizations/shared/utils/data.ts
@@ -195,12 +195,14 @@ const getBreakoutSeries = (
breakoutValues: RowValue[],
metric: ColumnDescriptor,
dimension: ColumnDescriptor,
+ settings: ComputedVisualizationSettings,
): Series<GroupedDatum, SeriesInfo>[] => {
return breakoutValues.map((breakoutValue) => {
const breakoutName = String(breakoutValue);
+ const customName = settings?.series_settings?.[breakoutName]?.title;
return {
seriesKey: breakoutName,
- seriesName: breakoutName,
+ seriesName: customName ?? breakoutName,
yAccessor: (datum: GroupedDatum) =>
formatNullable(
typeof datum.dimensionValue === "object"
@@ -221,11 +223,15 @@ const getBreakoutSeries = (
const getMultipleMetricSeries = (
dimension: ColumnDescriptor,
metrics: ColumnDescriptor[],
+ settings: ComputedVisualizationSettings,
): Series<GroupedDatum, SeriesInfo>[] => {
return metrics.map((metric) => {
+ const seriesKey = metric.column.name;
+ const customName = settings?.series_settings?.[seriesKey]?.title;
+ const defaultName = metric.column.display_name ?? metric.column.name;
return {
- seriesKey: metric.column.name,
- seriesName: metric.column.display_name ?? metric.column.name,
+ seriesKey,
+ seriesName: customName ?? defaultName,
yAccessor: (datum: GroupedDatum) =>
typeof datum.dimensionValue === "object"
? JSON.stringify(datum.dimensionValue)
@@ -243,6 +249,7 @@ export const getSeries = (
data: DatasetData,
chartColumns: CartesianChartColumns,
columnFormatter: ColumnFormatter,
+ settings: ComputedVisualizationSettings,
): Series<GroupedDatum, SeriesInfo>[] => {
if ("breakout" in chartColumns) {
const breakoutValues = getBreakoutDistinctValues(
@@ -255,10 +262,15 @@ export const getSeries = (
breakoutValues,
chartColumns.metric,
chartColumns.dimension,
+ settings,
);
}
- return getMultipleMetricSeries(chartColumns.dimension, chartColumns.metrics);
+ return getMultipleMetricSeries(
+ chartColumns.dimension,
+ chartColumns.metrics,
+ settings,
+ );
};
export const getOrderedSeries = (
diff --git a/frontend/src/metabase/visualizations/shared/utils/data.unit.spec.ts b/frontend/src/metabase/visualizations/shared/utils/data.unit.spec.ts
index b6c84e6b722..300ef473474 100644
--- a/frontend/src/metabase/visualizations/shared/utils/data.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/shared/utils/data.unit.spec.ts
@@ -5,10 +5,11 @@ import type {
import type { ColumnFormatter } from "metabase/visualizations/shared/types/format";
import {
createMockColumn,
+ createMockDatasetData,
createMockVisualizationSettings,
} from "metabase-types/api/mocks";
-import { getGroupedDataset } from "./data";
+import { getGroupedDataset, getSeries } from "./data";
const columnFormatter: ColumnFormatter = (value: any) => String(value);
@@ -154,4 +155,136 @@ describe("data utils", () => {
]);
});
});
+
+ describe("getSeries", () => {
+ describe("chart with breakout", () => {
+ it("should return series for each breakout value", () => {
+ const data = createMockDatasetData({
+ cols: [dimensionColumn, breakoutColumn, countMetricColumn],
+ rows,
+ });
+
+ const series = getSeries(
+ data,
+ breakoutChartColumns,
+ columnFormatter,
+ createMockVisualizationSettings(),
+ );
+
+ expect(series).toHaveLength(2);
+ expect(series[0]).toMatchObject({
+ seriesKey: "Doohickey",
+ seriesName: "Doohickey",
+ seriesInfo: {
+ metricColumn: countMetricColumn,
+ dimensionColumn: dimensionColumn,
+ breakoutValue: "Doohickey",
+ },
+ });
+ expect(series[1]).toMatchObject({
+ seriesKey: "Gadget",
+ seriesName: "Gadget",
+ seriesInfo: {
+ metricColumn: countMetricColumn,
+ dimensionColumn: dimensionColumn,
+ breakoutValue: "Gadget",
+ },
+ });
+ });
+ });
+
+ describe("chart with multiple metrics", () => {
+ it("should return series for each metric", () => {
+ const data = createMockDatasetData({
+ cols: [
+ dimensionColumn,
+ breakoutColumn,
+ countMetricColumn,
+ avgMetricColumn,
+ ],
+ rows,
+ });
+
+ const series = getSeries(
+ data,
+ multipleMetricsChartColumns,
+ columnFormatter,
+ createMockVisualizationSettings(),
+ );
+
+ expect(series).toHaveLength(2);
+ expect(series[0]).toMatchObject({
+ seriesKey: "count",
+ seriesName: "Column",
+ seriesInfo: {
+ dimensionColumn: dimensionColumn,
+ metricColumn: countMetricColumn,
+ },
+ });
+ expect(series[1]).toMatchObject({
+ seriesKey: "avg",
+ seriesName: "Column",
+ seriesInfo: {
+ dimensionColumn: dimensionColumn,
+ metricColumn: avgMetricColumn,
+ },
+ });
+ });
+ });
+
+ describe("custom series titles", () => {
+ it("should apply custom title from settings for breakout series", () => {
+ const data = createMockDatasetData({
+ cols: [dimensionColumn, breakoutColumn, countMetricColumn],
+ rows,
+ });
+
+ const settings = createMockVisualizationSettings({
+ series_settings: {
+ Doohickey: { title: "Custom Doohickey Title" },
+ Gadget: { title: "Custom Gadget Title" },
+ },
+ });
+
+ const series = getSeries(
+ data,
+ breakoutChartColumns,
+ columnFormatter,
+ settings,
+ );
+
+ expect(series[0].seriesName).toBe("Custom Doohickey Title");
+ expect(series[1].seriesName).toBe("Custom Gadget Title");
+ });
+
+ it("should apply custom title from settings for multiple metrics series", () => {
+ const data = createMockDatasetData({
+ cols: [
+ dimensionColumn,
+ breakoutColumn,
+ countMetricColumn,
+ avgMetricColumn,
+ ],
+ rows,
+ });
+
+ const settings = createMockVisualizationSettings({
+ series_settings: {
+ count: { title: "Custom Total Count" },
+ avg: { title: "Custom Average Value" },
+ },
+ });
+
+ const series = getSeries(
+ data,
+ multipleMetricsChartColumns,
+ columnFormatter,
+ settings,
+ );
+
+ expect(series[0].seriesName).toBe("Custom Total Count");
+ expect(series[1].seriesName).toBe("Custom Average Value");
+ });
+ });
+ });
});
diff --git a/frontend/src/metabase/visualizations/shared/utils/series.ts b/frontend/src/metabase/visualizations/shared/utils/series.ts
index 144b523aa5f..41db4a97058 100644
--- a/frontend/src/metabase/visualizations/shared/utils/series.ts
+++ b/frontend/src/metabase/visualizations/shared/utils/series.ts
@@ -12,7 +12,12 @@ export const getTwoDimensionalChartSeries = (
columnFormatter: ColumnFormatter,
) => {
const chartColumns = getCartesianChartColumns(data.cols, settings);
- const unorderedSeries = getSeries(data, chartColumns, columnFormatter);
+ const unorderedSeries = getSeries(
+ data,
+ chartColumns,
+ columnFormatter,
+ settings,
+ );
const seriesOrder = settings["graph.series_order"];
const series = getOrderedSeries(unorderedSeries, seriesOrder);
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
index 87c581f1e4f..3883cb72caa 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
@@ -245,8 +245,8 @@ const RowChartVisualization = ({
const canSelectTitle = !!onChangeCardAndRun;
const legendItems = useMemo(
- () => getLegendItems(series, seriesColors, settings),
- [series, seriesColors, settings],
+ () => getLegendItems(series, seriesColors),
+ [series, seriesColors],
);
const { xLabel, yLabel } = useMemo(() => getLabels(settings), [settings]);
@@ -395,6 +395,7 @@ RowChartVisualization.transformSeries = (originalMultipleSeries: any) => {
data,
chartColumns,
getColumnValueFormatter(),
+ settings,
);
const transformedSeries = seriesDefinitions.map((seriesDef) => ({
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/utils/legend.ts b/frontend/src/metabase/visualizations/visualizations/RowChart/utils/legend.ts
index d893f8694c1..c720770c8d9 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/utils/legend.ts
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/utils/legend.ts
@@ -1,16 +1,13 @@
import type { LegendItem } from "metabase/visualizations/echarts/cartesian/model/types";
import type { Series } from "metabase/visualizations/shared/components/RowChart/types";
-import type { VisualizationSettings } from "metabase-types/api";
export const getLegendItems = <TDatum>(
- multipleSeries: Series<TDatum, unknown>[],
+ multipleSeries: Series<TDatum>[],
seriesColors: Record<string, string>,
- settings: VisualizationSettings,
): LegendItem[] => {
return multipleSeries.map((series) => ({
key: series.seriesKey,
- name:
- settings?.series_settings?.[series.seriesKey]?.title ?? series.seriesName,
+ name: series.seriesName,
color: seriesColors[series.seriesKey],
}));
};