Skip to content

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

GDGT-3390: Make dashcard legend items real links (#84736)

Will Fryd4bd776d8124
diff --git a/frontend/src/metabase/dashboard/actions/navigation.ts b/frontend/src/metabase/dashboard/actions/navigation.ts
index 0d75f81b430..85ad43eb14f 100644
--- a/frontend/src/metabase/dashboard/actions/navigation.ts
+++ b/frontend/src/metabase/dashboard/actions/navigation.ts
@@ -2,7 +2,7 @@ import { selectQuestionFromCardBuilder } from "metabase/metadata-store";
import { createThunkAction } from "metabase/redux";
import { openUrl } from "metabase/redux/app";
import { EDIT_QUESTION, NAVIGATE_TO_NEW_CARD } from "metabase/redux/dashboard";
-import type { Dispatch, GetState } from "metabase/redux/store";
+import type { Dispatch, GetState, State } from "metabase/redux/store";
import * as Urls from "metabase/urls";
import { isQuestionDashCard } from "metabase/utils/dashboard";
import * as Lib from "metabase-lib";
@@ -48,34 +48,52 @@ type NavigateToNewCardFromDashboardArgs = {
objectId?: number | string;
};
-export const navigateToNewCardFromDashboard = createThunkAction(
- NAVIGATE_TO_NEW_CARD,
- ({
+/**
+ * Returns the URL `navigateToNewCardFromDashboard` opens for the same arguments,
+ * or `undefined` when there is no dashboard or the dashcard has no question.
+ */
+export const getNewCardUrlFromDashboard = (
+ state: State,
+ {
+ nextCard,
+ previousCard,
+ dashcard,
+ objectId,
+ }: NavigateToNewCardFromDashboardArgs,
+): string | undefined => {
+ const { dashboardId, dashboards, parameterValues } = state.dashboard;
+ const dashboard = dashboardId != null ? dashboards[dashboardId] : null;
+
+ if (
+ !dashboard ||
+ !isQuestionDashCard(dashcard) ||
+ !dashcard.card.dataset_query
+ ) {
+ return undefined;
+ }
+
+ return getNewCardUrl({
+ buildQuestion: selectQuestionFromCardBuilder(state),
+ dashboard,
+ parameterValues,
nextCard,
previousCard,
dashcard,
objectId,
- }: NavigateToNewCardFromDashboardArgs) =>
+ });
+};
+
+export const navigateToNewCardFromDashboard = createThunkAction(
+ NAVIGATE_TO_NEW_CARD,
+ (args: NavigateToNewCardFromDashboardArgs) =>
(dispatch: Dispatch, getState: GetState) => {
const state = getState();
- const buildQuestion = selectQuestionFromCardBuilder(state);
- const { dashboardId, dashboards, parameterValues } = state.dashboard;
+ const { dashboardId, dashboards } = state.dashboard;
const dashboard = dashboardId != null ? dashboards[dashboardId] : null;
- if (dashboard && isQuestionDashCard(dashcard)) {
- const url = getNewCardUrl({
- buildQuestion,
- dashboard,
- parameterValues,
- nextCard,
- previousCard,
- dashcard,
- objectId,
- });
-
- if (url) {
- dispatch(openUrl(url));
- }
+ const url = getNewCardUrlFromDashboard(state, args);
+ if (url) {
+ dispatch(openUrl(url));
}
return { model: "dashboard", id: dashboardId, name: dashboard?.name };
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
index 1e028e89820..8625001ab03 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
@@ -6,7 +6,11 @@ import { isActionCard } from "metabase/actions/utils";
import ErrorBoundary from "metabase/common/components/ErrorBoundary";
import CS from "metabase/css/core/index.css";
import DashboardS from "metabase/css/dashboard.module.css";
-import { addParameter, duplicateCard } from "metabase/dashboard/actions";
+import {
+ addParameter,
+ duplicateCard,
+ getNewCardUrlFromDashboard,
+} from "metabase/dashboard/actions";
import { DASHBOARD_SLOW_TIMEOUT } from "metabase/dashboard/constants";
import { useDashboardContext } from "metabase/dashboard/context";
import { getDashcardData, getDashcardHref } from "metabase/dashboard/selectors";
@@ -50,7 +54,10 @@ import {
import S from "./DashCard.module.css";
import { DashCardActionsPanel } from "./DashCardActionsPanel/DashCardActionsPanel";
import { DashCardVisualization } from "./DashCardVisualization";
-import type { DashCardOnChangeCardAndRunHandler } from "./types";
+import type {
+ DashCardGetCardHref,
+ DashCardOnChangeCardAndRunHandler,
+} from "./types";
import { useAutoScrollIntoView } from "./use-auto-scroll-into-view";
function preventDragging(event: React.SyntheticEvent) {
@@ -128,6 +135,11 @@ function DashCardInner({
() => getDashcardHref(store.getState(), dashcard.id),
[store, dashcard.id],
);
+ const getCardHref = useCallback<DashCardGetCardHref>(
+ (opts) =>
+ getNewCardUrlFromDashboard(store.getState(), { ...opts, dashcard }),
+ [store, dashcard],
+ );
const [isPreviewingCard, setIsPreviewingCard] = useState(!dashcard.justAdded);
const cardRootRef = useRef<HTMLDivElement>(null);
@@ -409,6 +421,7 @@ function DashCardInner({
expectedDuration={expectedDuration}
error={error}
getHref={navigateToNewCardFromDashboard ? getHref : undefined}
+ getCardHref={navigateToNewCardFromDashboard ? getCardHref : undefined}
isAction={isAction}
isEditingDashCardClickBehavior={isEditingDashCardClickBehavior}
isEditingDashboardLayout={isEditingDashboardLayout}
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
index fb7817cb13f..c533f5ab0ce 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
@@ -93,7 +93,10 @@ import { DashCardMenu } from "./DashCardMenu/DashCardMenu";
import { DashCardParameterMapper } from "./DashCardParameterMapper/DashCardParameterMapper";
import S from "./DashCardVisualization.module.css";
import { getDashcardTokenId, getDashcardUuid } from "./dashcard-ids";
-import type { DashCardOnChangeCardAndRunHandler } from "./types";
+import type {
+ DashCardGetCardHref,
+ DashCardOnChangeCardAndRunHandler,
+} from "./types";
import {
getCardsFromSeries,
getMissingColumnsFromVisualizationSettings,
@@ -129,6 +132,7 @@ interface DashCardVisualizationProps {
series: DashCardSeries;
question: Question | null;
getHref?: () => string | undefined;
+ getCardHref?: DashCardGetCardHref;
gridSize: {
width: number;
@@ -169,6 +173,7 @@ export function DashCardVisualization({
series: rawSeries,
question,
getHref,
+ getCardHref,
gridSize,
gridItemWidth,
totalNumGridCols,
@@ -443,6 +448,17 @@ export function DashCardVisualization({
[onChangeCardAndRun, findCardById],
);
+ const getNextCardHref = useMemo(() => {
+ if (!getCardHref) {
+ return;
+ }
+
+ return (nextCard: SeriesCard) => {
+ const previousCard = findCardById(nextCard.id);
+ return previousCard ? getCardHref({ nextCard, previousCard }) : undefined;
+ };
+ }, [getCardHref, findCardById]);
+
const onOpenQuestion = useCallback(
(cardId: CardId | null) => {
const card = findCardById(cardId);
@@ -639,6 +655,7 @@ export function DashCardVisualization({
}
mode={clickActionMode ?? dashboardClickActionMode}
getHref={getHref}
+ getCardHref={getNextCardHref}
gridSize={gridSize}
totalNumGridCols={totalNumGridCols}
headerIcon={headerIcon}
diff --git a/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx
index 8850ddba552..41e659ef567 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/Dashcard.unit.spec.tsx
@@ -1,7 +1,10 @@
+import { parse } from "url";
+
import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
+import { createMockMetadata } from "__support__/metadata";
import {
setupLastDownloadFormatEndpoints,
setupTimelinesEndpoints,
@@ -20,6 +23,7 @@ import {
waitForLoaderToBeRemoved,
within,
} from "__support__/ui";
+import { deserializeCardFromUrl } from "metabase/common/utils/card";
import {
MockDashboardContext,
type MockDashboardContextProps,
@@ -29,14 +33,20 @@ import { registerDashboardVisualizations } from "metabase/dashboard/visualizatio
import { reinitialize } from "metabase/plugins";
import { SERVER_ERROR_TYPES } from "metabase/utils/errors";
import { registerVisualizations } from "metabase/visualizations/register";
+import * as Lib from "metabase-lib";
+import Question from "metabase-lib/v1/Question";
import {
type DashCardDataMap,
DataPermissionValue,
+ type Database,
type DownloadPermission,
+ type ParameterId,
+ type ParameterValueOrArray,
} from "metabase-types/api";
import {
createMockActionDashboardCard,
createMockCard,
+ createMockCategoryColumn,
createMockColumn,
createMockDashboard,
createMockDashboardCard,
@@ -58,6 +68,12 @@ import {
createMockTimelineEvent,
createMockTokenFeatures,
} from "metabase-types/api/mocks";
+import {
+ PRODUCTS,
+ PRODUCTS_ID,
+ SAMPLE_DB_ID,
+ createSampleDatabase,
+} from "metabase-types/api/mocks/presets";
import type { DashCardProps } from "./DashCard";
import { DashCard } from "./DashCard";
@@ -118,6 +134,8 @@ function setup({
dashcardData = tableDashcardData,
isEditing,
withMetadata = false,
+ databases,
+ parameterValues = {},
dashcardMenu,
withTimelineEvents = false,
...props
@@ -129,6 +147,8 @@ function setup({
dashboard?: NonNullable<MockDashboardContextProps["dashboard"]>;
dashcardData?: DashCardDataMap;
withMetadata?: boolean;
+ databases?: Database[];
+ parameterValues?: Record<ParameterId, ParameterValueOrArray>;
} = {}) {
const onReplaceCard = jest.fn();
@@ -147,10 +167,14 @@ function setup({
dashcards: {
[dashcard.id]: dashcard,
},
+ parameterValues,
});
const storeInitialState = createMockState({
dashboard: baseDashboardState,
+ ...(databases && {
+ entities: createMockEntitiesState({ databases }),
+ }),
...(withMetadata && {
entities: createMockEntitiesState({
databases: [
@@ -754,6 +778,84 @@ describe("DashCard", () => {
]);
});
+ it("should link legend items to their own question with dashboard filters applied (metabase#83401)", async () => {
+ const user = userEvent.setup({ advanceTimers: jest.advanceTimersByTime });
+ const database = createSampleDatabase();
+ const metadataProvider = Lib.metadataProvider(
+ SAMPLE_DB_ID,
+ createMockMetadata({ databases: [database] }),
+ );
+ const productsQuery = Lib.toJsQuery(
+ Lib.fromJsQuery(metadataProvider, {
+ type: "query",
+ database: SAMPLE_DB_ID,
+ query: { "source-table": PRODUCTS_ID },
+ }),
+ );
+ const firstCard = createMockCard({
+ id: 1,
+ name: "Card 1",
+ display: "bar",
+ dataset_query: productsQuery,
+ });
+ const secondCard = createMockCard({
+ id: 2,
+ name: "Card 2",
+ display: "bar",
+ dataset_query: productsQuery,
+ });
+ const parameter = createMockParameter({ id: "category", type: "category" });
+ // Only the second card is filtered, so the link only gets the filter when
+ // it's built from that card.
+ const dashcard = createMockDashboardCard({
+ card_id: firstCard.id,
+ card: firstCard,
+ series: [secondCard],
+ parameter_mappings: [
+ {
+ parameter_id: parameter.id,
+ card_id: secondCard.id,
+ target: ["dimension", ["field", PRODUCTS.CATEGORY, null]],
+ },
+ ],
+ });
+ const dataset = createMockDataset({
+ data: createMockDatasetData({
+ cols: [
+ createMockCategoryColumn({ name: "CATEGORY" }),
+ createMockNumericColumn({ name: "count" }),
+ ],
+ rows: [["Gizmo", 1]],
+ }),
+ });
+
+ setup({
+ dashboard: createMockDashboard({
+ dashcards: [dashcard],
+ parameters: [parameter],
+ }),
+ dashcard,
+ dashcardData: {
+ [dashcard.id]: { [firstCard.id]: dataset, [secondCard.id]: dataset },
+ },
+ databases: [database],
+ parameterValues: { [parameter.id]: "Gizmo" },
+ });
+
+ const legend = await screen.findByLabelText("Legend");
+ await user.hover(within(legend).getByText("Card 2"));
+
+ const href = within(legend)
+ .getByRole("link", { name: "Card 2" })
+ .getAttribute("href");
+ const { hash } = parse(href ?? "");
+ const linkedQuestion = new Question(
+ hash ? deserializeCardFromUrl(hash) : undefined,
+ );
+ expect(linkedQuestion.card().original_card_id).toBe(secondCard.id);
+ expect(Lib.filters(linkedQuestion.query(), -1)).toHaveLength(1);
+ });
+
describe("visualizer dashcard download permissions", () => {
const sourceCard = createMockCard({
id: 42,
diff --git a/frontend/src/metabase/dashboard/components/DashCard/types.ts b/frontend/src/metabase/dashboard/components/DashCard/types.ts
index 5f5a333f279..45ec0194d03 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/types.ts
+++ b/frontend/src/metabase/dashboard/components/DashCard/types.ts
@@ -10,3 +10,11 @@ export type NavigateToNewCardFromDashboardOpts = {
export type DashCardOnChangeCardAndRunHandler = (
opts: Omit<NavigateToNewCardFromDashboardOpts, "dashcard">,
) => void;
+
+/**
+ * Returns the URL for opening `nextCard` from the dashcard's `previousCard`,
+ * with the dashboard's filters applied, or `undefined` when it can't be opened.
+ */
+export type DashCardGetCardHref = (
+ opts: Pick<NavigateToNewCardFromDashboardOpts, "nextCard" | "previousCard">,
+) => string | undefined;
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.legend-links.unit.spec.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.legend-links.unit.spec.tsx
new file mode 100644
index 00000000000..448eaece9b4
--- /dev/null
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.legend-links.unit.spec.tsx
@@ -0,0 +1,156 @@
+import userEvent from "@testing-library/user-event";
+
+import { act, renderWithProviders, screen, within } from "__support__/ui";
+import { delay } from "__support__/utils";
+import VisualizationComponent from "metabase/visualizations/components/Visualization";
+import { registerVisualizations } from "metabase/visualizations/register";
+import type { OnChangeCardAndRunOpts } from "metabase/visualizations/types";
+import { loadVisualizationComponents } from "metabase/viz-core";
+import type { RawSeries, SeriesCard } from "metabase-types/api";
+import {
+ createMockCard,
+ createMockCategoryColumn,
+ createMockDatasetData,
+ createMockNumericColumn,
+} from "metabase-types/api/mocks";
+
+registerVisualizations();
+
+beforeAll(() => loadVisualizationComponents(["bar", "row"]));
+
+const createBarSeries = (id: number, name: string) => ({
+ card: createMockCard({ id, name, display: "bar" }),
+ data: createMockDatasetData({
+ cols: [
+ createMockCategoryColumn({ id: 1, name: "Dimension" }),
+ createMockNumericColumn({ id: 2, name: "Count" }),
+ ],
+ rows: [
+ ["foo", 1],
+ ["bar", 2],
+ ],
+ }),
+});
+
+interface SetupOpts {
+ rawSeries: RawSeries;
+}
+
+const setup = async ({ rawSeries }: SetupOpts) => {
+ const getCardHref = jest.fn(
+ (nextCard: SeriesCard) => `/question/${nextCard.id}`,
+ );
+ const onChangeCardAndRun = jest.fn<void, [OnChangeCardAndRunOpts]>();
+
+ renderWithProviders(
+ <VisualizationComponent
+ rawSeries={rawSeries}
+ isDashboard
+ showTitle
+ getCardHref={getCardHref}
+ onChangeCardAndRun={onChangeCardAndRun}
+ />,
+ { withRouter: true },
+ );
+ // ExplicitSize sets the chart dimensions on the tick after mounting.
+ await delay(0);
+
+ return { getCardHref, onChangeCardAndRun };
+};
+
+const getLegend = () => screen.getByLabelText("Legend");
+const getLegendTitle = (name: string) => within(getLegend()).getByText(name);
+const getLegendLink = (name: string) =>
+ within(getLegend()).getByRole("link", { name });
+
+describe("Visualization dashcard legend links (metabase#83401)", () => {
+ it("should link each series to its own question, building the URL on hover", async () => {
+ const { getCardHref } = await setup({
+ rawSeries: [createBarSeries(1, "Card1"), createBarSeries(2, "Card2")],
+ });
+
+ expect(getLegendLink("Card2")).toHaveAttribute("href", "#");
+ expect(getCardHref).not.toHaveBeenCalled();
+
+ await userEvent.hover(getLegendTitle("Card2"));
+
+ expect(getLegendLink("Card2")).toHaveAttribute("href", "/question/2");
+ });
+
+ it("should build the URL when a series link is focused", async () => {
+ await setup({
+ rawSeries: [createBarSeries(1, "Card1"), createBarSeries(2, "Card2")],
+ });
+
+ act(() => getLegendLink("Card2").focus());
+
+ expect(getLegendLink("Card2")).toHaveFocus();
+ expect(getLegendLink("Card2")).toHaveAttribute("href", "/question/2");
+ });
+
+ it("should open the question through onChangeCardAndRun when a series is clicked", async () => {
+ const { onChangeCardAndRun } = await setup({
+ rawSeries: [createBarSeries(1, "Card1"), createBarSeries(2, "Card2")],
+ });
+
+ await userEvent.click(getLegendTitle("Card2"));
+
+ expect(onChangeCardAndRun).toHaveBeenCalledTimes(1);
+ expect(onChangeCardAndRun).toHaveBeenCalledWith(
+ expect.objectContaining({
+ nextCard: expect.objectContaining({ id: 2 }),
+ }),
+ );
+ });
+
+ it("should link the series of a single row chart question to that question", async () => {
+ await setup({
+ rawSeries: [
+ {
+ card: createMockCard({ id: 3, name: "Card", display: "row" }),
+ data: createMockDatasetData({
+ cols: [
+ createMockCategoryColumn({ name: "Dimension" }),
+ createMockNumericColumn({ name: "count", display_name: "Count" }),
+ createMockNumericColumn({ name: "sum", display_name: "Sum" }),
+ ],
+ rows: [
+ ["foo", 1, 3],
+ ["bar", 2, 4],
+ ],
+ }),
+ },
+ ],
+ });
+
+ await userEvent.hover(getLegendTitle("Sum"));
+
+ expect(getLegendLink("Sum")).toHaveAttribute("href", "/question/3");
+ });
+
+ it("should not link breakout series, which open drills instead", async () => {
+ await setup({
+ rawSeries: [
+ {
+ card: createMockCard({ id: 1, name: "Card", display: "bar" }),
+ data: createMockDatasetData({
+ cols: [
+ createMockCategoryColumn({ name: "Dimension1" }),
+ createMockCategoryColumn({ name: "Dimension2" }),
+ createMockNumericColumn({ name: "Count" }),
+ ],
+ rows: [
+ ["foo", "a", 1],
+ ["bar", "a", 2],
+ ["baz", "b", 3],
+ ],
+ }),
+ },
+ ],
+ });
+
+ await userEvent.hover(getLegendTitle("a"));
+
+ expect(within(getLegend()).queryByRole("link")).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
index a57f64efdd6..ac3f8aadbbd 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
@@ -131,6 +131,7 @@ type VisualizationOwnProps = {
clicked: ClickObject | null,
) => Record<string, unknown>;
getHref?: () => string | undefined;
+ getCardHref?: (nextCard: SeriesCard) => string | undefined;
gridSize?: VisualizationGridSize;
gridUnit?: number;
handleVisualizationClick?: (clicked: ClickObject | null) => void;
@@ -642,6 +643,7 @@ class Visualization extends PureComponent<
fontFamily,
getExtraDataForClick,
getHref,
+ getCardHref,
hasColumnReordering,
hasDevWatermark,
headerIcon,
@@ -929,6 +931,7 @@ class Visualization extends PureComponent<
fontFamily={fontFamily}
getExtraDataForClick={getExtraDataForClick}
getHref={getHref}
+ getCardHref={getCardHref}
gridSize={gridSize}
hasColumnReordering={hasColumnReordering}
headerIcon={hasHeader ? null : headerIcon}
diff --git a/frontend/src/metabase/visualizations/components/legend/Legend.tsx b/frontend/src/metabase/visualizations/components/legend/Legend.tsx
index 8677de1d2b0..c7222a872c0 100644
--- a/frontend/src/metabase/visualizations/components/legend/Legend.tsx
+++ b/frontend/src/metabase/visualizations/components/legend/Legend.tsx
@@ -33,6 +33,7 @@ interface LegendProps {
index: number,
isReversed?: boolean,
) => void;
+ getSeriesHref?: (index: number) => string | undefined;
onToggleSeriesVisibility?: (event: React.MouseEvent, index: number) => void;
isReversed?: boolean;
}
@@ -47,6 +48,7 @@ export const Legend = ({
size = "sm",
onHoverChange,
onSelectSeries,
+ getSeriesHref,
onToggleSeriesVisibility,
isReversed,
}: LegendProps) => {
@@ -84,6 +86,7 @@ export const Legend = ({
isReversed={isReversed}
onHoverChange={onHoverChange}
onSelectSeries={onSelectSeries}
+ getSeriesHref={getSeriesHref}
onToggleSeriesVisibility={onToggleSeriesVisibility}
/>
);
@@ -120,6 +123,7 @@ export const Legend = ({
size={size}
onHoverChange={onHoverChange}
onSelectSeries={onSelectSeries}
+ getSeriesHref={getSeriesHref}
onToggleSeriesVisibility={onToggleSeriesVisibility}
isReversed={isReversed}
/>
diff --git a/frontend/src/metabase/visualizations/components/legend/LegendItem.tsx b/frontend/src/metabase/visualizations/components/legend/LegendItem.tsx
index 66541ccb1ee..f7f68ebb283 100644
--- a/frontend/src/metabase/visualizations/components/legend/LegendItem.tsx
+++ b/frontend/src/metabase/visualizations/components/legend/LegendItem.tsx
@@ -1,14 +1,19 @@
import cx from "classnames";
-import { memo } from "react";
+import { memo, useState } from "react";
import CS from "metabase/css/core/index.css";
import DashboardS from "metabase/css/dashboard.module.css";
import { Box, Ellipsified, Flex, rem } from "metabase/ui";
+import * as Urls from "metabase/urls";
import S from "./LegendItem.module.css";
import { LegendItemDot } from "./LegendItemDot";
import { LEGEND_SIZES, type LegendSize } from "./layout";
+// Before the real URL is computed, a non-empty href keeps the title a
+// focusable link, so focusing it can trigger that computation.
+const HREF_PLACEHOLDER = "#";
+
export interface LegendItemData {
key: string;
color: string;
@@ -28,6 +33,7 @@ interface LegendItemProps {
index: number,
isReversed?: boolean,
) => void;
+ getSeriesHref?: (index: number) => string | undefined;
onToggleSeriesVisibility?: (event: React.MouseEvent, index: number) => void;
}
@@ -39,10 +45,15 @@ const LegendItemInner = ({
isReversed,
onHoverChange,
onSelectSeries,
+ getSeriesHref,
onToggleSeriesVisibility,
}: LegendItemProps) => {
const { dotSize, dotGap, typography } = LEGEND_SIZES[size];
const isClickable = onSelectSeries != null;
+ const isLink = isClickable && getSeriesHref !== undefined;
+ // Building the URL is expensive, so it waits until the title is hovered or
+ // focused.
+ const [href, setHref] = useState<string | undefined>(HREF_PLACEHOLDER);
const handleDotClick = (event: React.MouseEvent) => {
onToggleSeriesVisibility?.(event, index);
@@ -52,6 +63,19 @@ const LegendItemInner = ({
onSelectSeries?.(event, index, isReversed);
};
+ // Navigate in-app through onSelectSeries, so the app doesn't reload and the
+ // query builder can link back to the dashboard. The href serves middle-click
+ // and "Open in new tab".
+ const handleLinkClick = (event: React.MouseEvent) => {
+ event.preventDefault();
+ handleItemClick(event);
+ };
+
+ const handleUpdateHref = () => {
+ const url = getSeriesHref?.(index);
+ setHref(url && Urls.getSubpathSafeUrl(url));
+ };
+
const handleItemMouseEnter = (event: React.MouseEvent) => {
onHoverChange?.({ index: index, element: event.currentTarget });
};
@@ -77,17 +101,22 @@ const LegendItemInner = ({
onClick={onToggleSeriesVisibility && handleDotClick}
/>
<Box
+ component={isLink ? "a" : "div"} // not Metabase's <Link>: it swaps elements when the href resolves, losing focus
+ href={isLink ? href : undefined}
className={cx(
DashboardS.fullscreenNormalText,
CS.textPrimary,
CS.overflowHidden,
{ [CS.cursorPointer]: isClickable, [CS.textBrandHover]: isClickable },
)}
+ display="block"
fz={typography}
lh={typography}
ml={dotGap}
miw={0}
- onClick={onSelectSeries && handleItemClick}
+ onClick={isLink ? handleLinkClick : onSelectSeries && handleItemClick}
+ onFocus={isLink ? handleUpdateHref : undefined}
+ onMouseEnter={isLink ? handleUpdateHref : undefined}
>
<Ellipsified>{item.name}</Ellipsified>
</Box>
diff --git a/frontend/src/metabase/visualizations/components/legend/LegendLayout.tsx b/frontend/src/metabase/visualizations/components/legend/LegendLayout.tsx
index cd043e41b87..88753390c7c 100644
--- a/frontend/src/metabase/visualizations/components/legend/LegendLayout.tsx
+++ b/frontend/src/metabase/visualizations/components/legend/LegendLayout.tsx
@@ -34,6 +34,13 @@ interface LegendLayoutProps {
index: number,
isReversed?: boolean,
) => void;
+ /**
+ * With `onSelectSeries` also set, series titles render as links to the
+ * returned URL. It's called when a title is hovered or focused, not on render.
+ * Clicks still go to `onSelectSeries`; the URL serves middle-click and the
+ * browser's link menu, such as "Open in new tab".
+ */
+ getSeriesHref?: (index: number) => string | undefined;
onToggleSeriesVisibility?: (event: React.MouseEvent, index: number) => void;
isReversed?: boolean;
}
@@ -56,6 +63,7 @@ export const LegendLayout = ({
children,
onHoverChange,
onSelectSeries,
+ getSeriesHref,
onToggleSeriesVisibility,
isReversed,
}: LegendLayoutProps) => {
@@ -97,6 +105,7 @@ export const LegendLayout = ({
size,
onHoverChange,
onSelectSeries,
+ getSeriesHref,
onToggleSeriesVisibility,
isReversed,
};
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index df5a73007c1..6f1623976f0 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -54,6 +54,7 @@ export interface VisualizationProps {
dashcard?: DashboardCard;
card: SeriesCard;
getHref?: () => string | undefined;
+ getCardHref?: (nextCard: SeriesCard) => string | undefined;
data: DatasetData;
rawSeries: RawSeries;
visualizerRawSeries?: RawSeries;
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx
index f2c7a7df58d..9ca9d9149aa 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx
@@ -178,16 +178,17 @@ function CartesianChartInner(props: VisualizationProps) {
return null;
}, [props.hovered, props.highlighted, rawSeries, chartModel]);
- const { onSelectSeries, onOpenQuestion, eventHandlers } = useChartEvents(
- chartRef,
- containerRef,
- chartModel,
- option,
- renderingContext,
- hovered,
- props,
- chartInstance,
- );
+ const { onSelectSeries, getSeriesHref, onOpenQuestion, eventHandlers } =
+ useChartEvents(
+ chartRef,
+ containerRef,
+ chartModel,
+ option,
+ renderingContext,
+ hovered,
+ props,
+ chartInstance,
+ );
const handleResize = useCallback((width: number, height: number) => {
setChartSize({ width, height });
@@ -255,6 +256,7 @@ function CartesianChartInner(props: VisualizationProps) {
fontFamily={renderingContext.fontFamily}
measureText={renderingContext.measureText}
onSelectSeries={onSelectSeries}
+ getSeriesHref={getSeriesHref}
onToggleSeriesVisibility={
canToggleSeriesVisibility ? handleToggleSeriesVisibility : undefined
}
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
index 68f77fe072a..e4abb7b8d23 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
@@ -3,6 +3,7 @@ import type { EChartsType } from "echarts/core";
import { useCallback, useEffect, useMemo, useRef } from "react";
import { useLatest } from "react-use";
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { useStore } from "metabase/redux";
import { useChartYAxisVisibility } from "metabase/visualizations/hooks/use-chart-y-axis-visibility";
import type { VisualizationProps } from "metabase/visualizations/types";
@@ -28,16 +29,20 @@ import {
buildBrushMirrorGraphics,
buildClearBrushMirrorGraphics,
getVisualizerSeriesCardIndex,
+ isBreakoutSeries,
isGoalLineSeriesId,
isLineXBrushRange,
useClickedStateTooltipSync,
} from "metabase/viz-core";
-import type { CardId } from "metabase-types/api";
+import type { CardId, SeriesCard } from "metabase-types/api";
import type { CartesianHoveredObject } from "./types";
import { useBrush } from "./use-brush";
import { useTooltipMouseLeave } from "./use-tooltip-mouse-leave";
-import { getHoveredEChartsSeriesDataKeyAndIndex } from "./utils";
+import {
+ doesSeriesAlwaysOpenQuestion,
+ getHoveredEChartsSeriesDataKeyAndIndex,
+} from "./utils";
function getSplitPanelGrids(option: EChartsOption) {
const { grid } = option;
@@ -87,6 +92,7 @@ export const useChartEvents = (
onHoverChange,
clicked,
isDashboard,
+ getCardHref,
}: VisualizationProps,
// The ECharts instance, mirrored into state by the caller. Used as a signal
// to re-run chart-instance-dependent effects (e.g. brush) once it is ready,
@@ -99,25 +105,24 @@ export const useChartEvents = (
const isBrushing = useRef<boolean>();
useTooltipMouseLeave(chartRef, onHoverChange, containerRef);
- const onOpenQuestion = useCallback(
- (cardId?: CardId) => {
+ const getQuestionCard = useCallback(
+ (cardId?: CardId): SeriesCard => {
if (isVisualizerCard) {
const index = getVisualizerSeriesCardIndex(cardId);
- const nextCard = visualizerRawSeries[index].card;
- onChangeCardAndRun?.({ nextCard });
- } else {
- const nextCard =
- rawSeries.find((series) => series.card.id === cardId)?.card ?? card;
- onChangeCardAndRun?.({ nextCard });
+ return visualizerRawSeries[index].card;
}
+ return (
+ rawSeries.find((series) => series.card.id === cardId)?.card ?? card
+ );
},
- [
- card,
- rawSeries,
- visualizerRawSeries,
- isVisualizerCard,
- onChangeCardAndRun,
- ],
+ [card, rawSeries, visualizerRawSeries, isVisualizerCard],
+ );
+
+ const onOpenQuestion = useCallback(
+ (cardId?: CardId) => {
+ onChangeCardAndRun?.({ nextCard: getQuestionCard(cardId) });
+ },
+ [getQuestionCard, onChangeCardAndRun],
);
const isSplitPanels =
@@ -413,17 +418,23 @@ export const useChartEvents = (
chartInstance,
);
+ const hasMultipleCards = rawSeries.length > 1;
+
const onSelectSeries = useCallback(
(event: React.MouseEvent, seriesIndex: number) => {
- const areMultipleCards = rawSeries.length > 1;
const seriesModel = chartModel.seriesModels[seriesIndex];
- if (areMultipleCards) {
+ if (
+ doesSeriesAlwaysOpenQuestion(seriesModel, {
+ hasMultipleCards,
+ isDashboard,
+ })
+ ) {
onOpenQuestion(seriesModel.cardId);
return;
}
- const hasBreakout = "breakoutColumn" in seriesModel;
+ const hasBreakout = isBreakoutSeries(seriesModel);
const dimensions = hasBreakout
? [
{
@@ -448,7 +459,7 @@ export const useChartEvents = (
},
[
chartModel.seriesModels,
- rawSeries,
+ hasMultipleCards,
settings,
visualizationIsClickable,
onVisualizationClick,
@@ -457,8 +468,35 @@ export const useChartEvents = (
],
);
+ const getSeriesHref = useCallback(
+ (seriesIndex: number) => {
+ const seriesModel = chartModel.seriesModels[seriesIndex];
+ return seriesModel
+ ? getCardHref?.(getQuestionCard(seriesModel.cardId))
+ : undefined;
+ },
+ [chartModel.seriesModels, getCardHref, getQuestionCard],
+ );
+
+ // Legend titles are links only when clicking one always opens a question:
+ // breakout series can open drills instead. The Embedding SDK has no
+ // in-app routes to link to.
+ const canNavigate =
+ getCardHref !== undefined &&
+ onChangeCardAndRun != null &&
+ !isEmbeddingSdk();
+ const canLinkSeries =
+ canNavigate &&
+ chartModel.seriesModels.every((seriesModel) =>
+ doesSeriesAlwaysOpenQuestion(seriesModel, {
+ hasMultipleCards,
+ isDashboard,
+ }),
+ );
+
return {
onSelectSeries,
+ getSeriesHref: canLinkSeries ? getSeriesHref : undefined,
onOpenQuestion,
eventHandlers,
};
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts
index 8c45612a620..3f1bb33d3f6 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts
@@ -12,6 +12,7 @@ import {
X_AXIS_DATA_KEY,
getDatasetKey,
getSizeAdjustedSettings,
+ isBreakoutSeries,
} from "metabase/viz-core";
import type { RawSeries } from "metabase-types/api";
@@ -20,6 +21,22 @@ import type { CartesianHoveredObject } from "./types";
export { getSizeAdjustedSettings };
+type SeriesSelectContext = {
+ hasMultipleCards: boolean;
+ isDashboard: boolean;
+};
+
+/**
+ * Whether selecting this series in the legend always opens its question.
+ * When false, a breakout series opens drills for its value if it has any, and
+ * falls back to opening the question on a dashboard.
+ */
+export const doesSeriesAlwaysOpenQuestion = (
+ seriesModel: SeriesModel,
+ { hasMultipleCards, isDashboard }: SeriesSelectContext,
+): boolean =>
+ hasMultipleCards || (isDashboard && !isBreakoutSeries(seriesModel));
+
export const getHoveredSeriesDataKey = (
seriesModels: SeriesModel[],
hovered: HoveredObject | null | undefined,