Skip to content

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

Inject pdf export params (#72847)

Fraserf2cb46a30751
diff --git a/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsx b/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsx
index 5def83d2aaa..c9b6b475158 100644
--- a/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardParameterList/DashboardParameterList.tsx
@@ -1,4 +1,3 @@
-import cx from "classnames";
import { type ComponentProps, forwardRef, useMemo } from "react";
import {
@@ -7,7 +6,6 @@ import {
setParameterValue,
setParameterValueToDefault,
} from "metabase/dashboard/actions";
-import { DASHBOARD_PARAMETERS_PDF_EXPORT_NODE_CLASSNAME } from "metabase/dashboard/constants";
import { useDashboardContext } from "metabase/dashboard/context";
import { ParametersList } from "metabase/parameters/components/ParametersList";
import { useDispatch } from "metabase/redux";
@@ -65,7 +63,7 @@ export const DashboardParameterList = forwardRef<
return (
<ParametersList
ref={ref}
- className={cx(DASHBOARD_PARAMETERS_PDF_EXPORT_NODE_CLASSNAME, className)}
+ className={className}
parameters={parameters}
linkedFilterParameters={linkedFilterParameters}
editingParameter={editingParameter}
diff --git a/frontend/src/metabase/dashboard/constants.ts b/frontend/src/metabase/dashboard/constants.ts
index bc29c1293ff..a012cd3600e 100644
--- a/frontend/src/metabase/dashboard/constants.ts
+++ b/frontend/src/metabase/dashboard/constants.ts
@@ -53,8 +53,6 @@ export const DASHBOARD_PDF_EXPORT_ROOT_ID =
"Dashboard-Parameters-And-Cards-Container";
export const DASHBOARD_HEADER_PARAMETERS_PDF_EXPORT_NODE_ID =
"Dashboard-Parameters-Content";
-export const DASHBOARD_PARAMETERS_PDF_EXPORT_NODE_CLASSNAME =
- "Dashboard-Parameters-List";
export const DEFAULT_DASHBOARD_DISPLAY_OPTIONS: EmbedDisplayParams = {
background: true,
diff --git a/frontend/src/metabase/redux/downloads.ts b/frontend/src/metabase/redux/downloads.ts
index 6b4cfe613cd..6fdc946c192 100644
--- a/frontend/src/metabase/redux/downloads.ts
+++ b/frontend/src/metabase/redux/downloads.ts
@@ -11,7 +11,10 @@ import _ from "underscore";
import { exportFormatPng } from "metabase/common/types/export";
import { waitUntilNextFramePainted } from "metabase/common/utils/wait-until-next-frame-paints";
import { trackExportDashboardToPDF } from "metabase/dashboard/analytics";
-import { DASHBOARD_PDF_EXPORT_ROOT_ID } from "metabase/dashboard/constants";
+import {
+ DASHBOARD_HEADER_PARAMETERS_PDF_EXPORT_NODE_ID,
+ DASHBOARD_PDF_EXPORT_ROOT_ID,
+} from "metabase/dashboard/constants";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import type { DownloadsState, State } from "metabase/redux/store";
import { createAsyncThunk } from "metabase/redux/utils";
@@ -201,6 +204,7 @@ export const downloadDashboardToPdf = createAsyncThunk(
await saveDashboardPdf({
fileName,
selector: cardNodeSelector,
+ parametersNodeSelector: `#${DASHBOARD_HEADER_PARAMETERS_PDF_EXPORT_NODE_ID}`,
dashboardName: dashboard.name,
includeBranding,
});
diff --git a/frontend/src/metabase/visualizations/lib/image-exports.ts b/frontend/src/metabase/visualizations/lib/image-exports.ts
index 1a8d86a5869..d890e93ad04 100644
--- a/frontend/src/metabase/visualizations/lib/image-exports.ts
+++ b/frontend/src/metabase/visualizations/lib/image-exports.ts
@@ -2,11 +2,6 @@
import { css } from "@emotion/react";
import GlobalDashboardS from "metabase/css/dashboard.module.css";
-import DashboardGridS from "metabase/dashboard/components/DashboardGrid.module.css";
-import {
- DASHBOARD_HEADER_PARAMETERS_PDF_EXPORT_NODE_ID,
- DASHBOARD_PARAMETERS_PDF_EXPORT_NODE_CLASSNAME,
-} from "metabase/dashboard/constants";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { isStorybookActive } from "metabase/env";
import EmbedFrameS from "metabase/public/components/EmbedFrame/EmbedFrame.module.css";
@@ -35,13 +30,7 @@ export const saveDomImageStyles = css`
overflow: visible;
}
- .${DASHBOARD_PARAMETERS_PDF_EXPORT_NODE_CLASSNAME} {
- legend {
- top: -9px;
- }
- }
-
- .${DashboardGridS.DashboardCardContainer} .${GlobalDashboardS.Card} {
+ [data-dashcard-key].${GlobalDashboardS.Card} {
/* the renderer we use for saving to image/pdf doesn't support box-shadow
so we replace it with a border */
box-shadow: none;
@@ -53,7 +42,7 @@ export const saveDomImageStyles = css`
this is a workaround to make sure the text is not clipped vertically */
${isEmbeddingSdk() &&
css`
- .${DashboardGridS.DashboardCardContainer} .${GlobalDashboardS.Card} * {
+ [data-dashcard-key].${GlobalDashboardS.Card} * {
overflow: visible !important;
}
`};
@@ -90,6 +79,16 @@ export const canvasToBlob = (
});
};
+// html2canvas renders fieldset legends shifted down; nudge them back up in the
+// cloned parameter bar before capture.
+export const fixParameterLegendOffsetForExport = (
+ parametersNode: HTMLElement,
+) => {
+ parametersNode.querySelectorAll<HTMLElement>("legend").forEach((el) => {
+ el.style.top = "-9px";
+ });
+};
+
export interface DashboardRenderSetup {
gridNode: HTMLElement;
contentWidth: number;
@@ -100,19 +99,18 @@ export interface DashboardRenderSetup {
}
export const setupDashboardForRendering = (
- selector: string,
+ dashboardRoot: HTMLElement,
+ getParametersNode: (dashboardRoot: HTMLElement) => HTMLElement | null,
): DashboardRenderSetup | undefined => {
- const dashboardRoot = document.querySelector(selector);
- const gridNode = dashboardRoot?.querySelector(".react-grid-layout");
+ const gridNode = dashboardRoot.querySelector(".react-grid-layout");
if (!gridNode || !(gridNode instanceof HTMLElement)) {
- console.warn("No dashboard content found", selector);
+ console.warn("No dashboard content found");
return undefined;
}
- const pageHeaderParametersNode = dashboardRoot
- ?.querySelector(`#${DASHBOARD_HEADER_PARAMETERS_PDF_EXPORT_NODE_ID}`)
- ?.cloneNode(true);
+ const pageHeaderParametersNode =
+ getParametersNode(dashboardRoot)?.cloneNode(true);
let parametersHeight = 0;
if (pageHeaderParametersNode instanceof HTMLElement) {
@@ -146,8 +144,17 @@ export const setupDashboardForRendering = (
export const getDashboardImage = async (
selector: string,
+ parametersNodeSelector: string,
): Promise<string | undefined> => {
- const setup = setupDashboardForRendering(selector);
+ const dashboardRoot = document.querySelector(selector);
+ if (!(dashboardRoot instanceof HTMLElement)) {
+ console.warn("No dashboard root found", selector);
+ return undefined;
+ }
+
+ const setup = setupDashboardForRendering(dashboardRoot, (root) =>
+ root.querySelector<HTMLElement>(parametersNodeSelector),
+ );
if (!setup) {
return undefined;
}
@@ -168,6 +175,7 @@ export const getDashboardImage = async (
node.style.height = `${contentHeight}px`;
node.style.backgroundColor = backgroundColor;
if (parametersNode) {
+ fixParameterLegendOffsetForExport(parametersNode);
node.insertBefore(parametersNode, node.firstChild);
}
},
diff --git a/frontend/src/metabase/visualizations/lib/save-dashboard-pdf.ts b/frontend/src/metabase/visualizations/lib/save-dashboard-pdf.ts
index e9c81c5a169..586fdab035b 100644
--- a/frontend/src/metabase/visualizations/lib/save-dashboard-pdf.ts
+++ b/frontend/src/metabase/visualizations/lib/save-dashboard-pdf.ts
@@ -1,7 +1,6 @@
import Color from "color";
import { t } from "ttag";
-import { DASHBOARD_HEADER_PARAMETERS_PDF_EXPORT_NODE_ID } from "metabase/dashboard/constants";
import { isStorybookActive } from "metabase/env";
import { getCspNonce } from "metabase/utils/csp";
import { openImageBlobOnStorybook } from "metabase/utils/loki-utils";
@@ -12,6 +11,7 @@ import {
getBrandingConfig,
getBrandingSize,
} from "./exports-branding-utils";
+import { fixParameterLegendOffsetForExport } from "./image-exports";
import { SAVING_DOM_IMAGE_CLASS } from "./save-chart-image";
const TARGET_ASPECT_RATIO = 21 / 17;
@@ -157,6 +157,7 @@ const PAGE_PADDING = 16;
interface SavePdfProps {
fileName: string;
selector: string;
+ parametersNodeSelector: string;
dashboardName: string;
includeBranding: boolean;
}
@@ -176,6 +177,7 @@ async function isValidColor(str: string) {
export const saveDashboardPdf = async ({
fileName,
selector,
+ parametersNodeSelector,
dashboardName,
includeBranding,
}: SavePdfProps) => {
@@ -190,7 +192,7 @@ export const saveDashboardPdf = async ({
const pdfHeader = createHeaderElement(dashboardName, HEADER_MARGIN_BOTTOM);
const parametersNode = dashboardRoot
- ?.querySelector(`#${DASHBOARD_HEADER_PARAMETERS_PDF_EXPORT_NODE_ID}`)
+ ?.querySelector(parametersNodeSelector)
?.cloneNode(true);
let parametersHeight = 0;
@@ -259,6 +261,7 @@ export const saveDashboardPdf = async ({
});
if (parametersNode instanceof HTMLElement) {
+ fixParameterLegendOffsetForExport(parametersNode);
node.insertBefore(parametersNode, node.firstChild);
}
node.insertBefore(pdfHeader, node.firstChild);