Skip to content

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

Add extension points in viz for sdk behaviour (#79436)

Fraser5516e40607c4
diff --git a/frontend/lint/side-effect-files.json b/frontend/lint/side-effect-files.json
index 5327537ed7f..b0737bfdb79 100644
--- a/frontend/lint/side-effect-files.json
+++ b/frontend/lint/side-effect-files.json
@@ -210,7 +210,6 @@
"frontend/src/metabase/visualizations/components/EChartsRenderer/EChartsRenderer.tsx": "global",
"frontend/src/metabase/visualizations/components/LeafletChoropleth.tsx": "self",
"frontend/src/metabase/visualizations/components/LeafletMap.tsx": "self",
- "frontend/src/metabase/visualizations/lib/image-exports.ts": "self",
"frontend/src/metabase/visualizations/lib/open-url.ts": "self",
"frontend/src/metabase/visualizations/visualizations/Map/Map.tsx": "self",
"frontend/src/metabase/visualizations/visualizations/ObjectDetail/ObjectDetail.ts": "self",
diff --git a/frontend/src/embedding-sdk-bundle/components/private/PublicComponentStylesWrapper.tsx b/frontend/src/embedding-sdk-bundle/components/private/PublicComponentStylesWrapper.tsx
index ed3d2004f37..e0d0212980a 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/PublicComponentStylesWrapper.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/PublicComponentStylesWrapper.tsx
@@ -6,8 +6,9 @@ import cx from "classnames";
import type React from "react";
import { forwardRef } from "react";
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { useComputedColorScheme } from "metabase/ui";
-import { saveDomImageStyles } from "metabase/visualizations/lib/image-exports";
+import { getSaveDomImageStyles } from "metabase/visualizations/lib/image-exports";
import S from "./PublicComponentStylesWrapper.style.css";
@@ -18,7 +19,7 @@ import S from "./PublicComponentStylesWrapper.style.css";
*/
const PublicComponentStylesWrapperInner = styled.div`
font-size: ${({ theme }) => theme.other.fontSize};
- ${saveDomImageStyles}
+ ${() => getSaveDomImageStyles(isEmbeddingSdk())}
`;
export const PublicComponentStylesWrapper = forwardRef<
diff --git a/frontend/src/metabase/styled-components/containers/GlobalStyles/GlobalStyles.tsx b/frontend/src/metabase/styled-components/containers/GlobalStyles/GlobalStyles.tsx
index d0da05ce78c..54a2f1c47a8 100644
--- a/frontend/src/metabase/styled-components/containers/GlobalStyles/GlobalStyles.tsx
+++ b/frontend/src/metabase/styled-components/containers/GlobalStyles/GlobalStyles.tsx
@@ -8,13 +8,14 @@ import {
isPublicEmbedding,
isStaticEmbedding,
} from "metabase/embedding/config";
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { useSelector } from "metabase/redux";
import { useSetting } from "metabase/settings";
import { getMetabaseCssVariables } from "metabase/styled-components/theme/css-variables";
import { useMantineTheme } from "metabase/ui";
import { getSitePath } from "metabase/utils/dom";
import { getFontFamilyValue } from "metabase/utils/fonts";
-import { saveDomImageStyles } from "metabase/visualizations/lib/image-exports";
+import { getSaveDomImageStyles } from "metabase/visualizations/lib/image-exports";
import { getFont, getFontFiles } from "../../selectors";
@@ -51,7 +52,7 @@ export const GlobalStyles = (): JSX.Element => {
}
`,
)}
- ${saveDomImageStyles}
+ ${getSaveDomImageStyles(isEmbeddingSdk())}
body {
font-size: 0.875em;
${isStaticEmbedding() || isPublicEmbedding()
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.unit.spec.ts
index 66136fa0777..8f74fd0d4f7 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.unit.spec.ts
@@ -1,10 +1,10 @@
-import { DEFAULT_VISUALIZATION_THEME } from "metabase/visualizations/shared/utils/theme";
import type { RenderingContext } from "metabase/visualizations/types";
import {
createMockColumn,
createMockVisualizationSettings,
} from "metabase-types/api/mocks";
+import { DEFAULT_VISUALIZATION_THEME } from "../../../shared/utils/theme";
import { CHART_STYLE } from "../constants/style";
import type { XAxisModel, YAxisModel } from "../model/types";
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/option/index.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/cartesian/option/index.unit.spec.ts
index 521c71b7789..5abd612c62c 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/option/index.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/option/index.unit.spec.ts
@@ -1,6 +1,5 @@
import type { XAXisOption, YAXisOption } from "echarts/types/dist/shared";
-import { DEFAULT_VISUALIZATION_THEME } from "metabase/visualizations/shared/utils/theme";
import type { RenderingContext } from "metabase/visualizations/types";
import type { RawSeries, SingleSeries } from "metabase-types/api";
import {
@@ -10,6 +9,7 @@ import {
createMockVisualizationSettings,
} from "metabase-types/api/mocks";
+import { DEFAULT_VISUALIZATION_THEME } from "../../../shared/utils/theme";
import { getChartLayout } from "../layout";
import { getCartesianChartModel } from "../model";
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.unit.spec.ts
index 7eb110d1153..a978641a929 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.unit.spec.ts
@@ -1,7 +1,8 @@
-import { DEFAULT_VISUALIZATION_THEME } from "metabase/visualizations/shared/utils/theme";
import type { RenderingContext } from "metabase/visualizations/types";
import { createMockTimelineEvent } from "metabase-types/api/mocks";
+import { DEFAULT_VISUALIZATION_THEME } from "../../../shared/utils/theme";
+
import { getTimelineEventsSelectionSeries } from "./option";
import type { TimelineEventsModel } from "./types";
diff --git a/frontend/src/metabase/visualizations/echarts/graph/treemap/option/option.unit.spec.ts b/frontend/src/metabase/visualizations/echarts/graph/treemap/option/option.unit.spec.ts
index 925e0bf576a..da9d43ef530 100644
--- a/frontend/src/metabase/visualizations/echarts/graph/treemap/option/option.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/echarts/graph/treemap/option/option.unit.spec.ts
@@ -1,7 +1,7 @@
import { formatPercent } from "metabase/utils/formatting";
-import { DEFAULT_VISUALIZATION_THEME } from "metabase/visualizations/shared/utils/theme";
import type { RenderingContext } from "metabase/visualizations/types";
+import { DEFAULT_VISUALIZATION_THEME } from "../../../../shared/utils/theme";
import type { TreemapTree } from "../model/types";
import { getTreemapChartOption } from "./option";
diff --git a/frontend/src/metabase/visualizations/echarts/tooltip/index.tsx b/frontend/src/metabase/visualizations/echarts/tooltip/index.tsx
index d846cc2587c..f9e3b84abad 100644
--- a/frontend/src/metabase/visualizations/echarts/tooltip/index.tsx
+++ b/frontend/src/metabase/visualizations/echarts/tooltip/index.tsx
@@ -3,10 +3,6 @@ import type React from "react";
import { useEffect, useMemo } from "react";
import _ from "underscore";
-import {
- EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID,
- isEmbeddingSdk,
-} from "metabase/embedding-sdk/config";
import { getCspNonce } from "metabase/utils/csp";
import { isNotNull } from "metabase/utils/types";
import TooltipStyles from "metabase/visualizations/components/ChartTooltip/EChartsTooltip/EChartsTooltip.module.css";
@@ -21,6 +17,13 @@ import { getArrayFromMapValues } from "../pie/util";
export const TOOLTIP_POINTER_MARGIN = 10;
export const ECHARTS_TOOLTIP_CONTAINER_CLASS = "echarts-tooltip-container";
+// The embedding SDK sets this to its portal root, so tooltips render inside the embed instead of on document.body.
+let tooltipRootProvider: () => HTMLElement | null = () => document.body;
+
+export function setTooltipRootProvider(provider: () => HTMLElement | null) {
+ tooltipRootProvider = provider;
+}
+
export const getTooltipPositionFn =
(containerRef: React.RefObject<HTMLDivElement>) =>
(
@@ -73,15 +76,12 @@ export const getTooltipBaseOption = (
enterable: true,
className: TooltipStyles.ChartTooltipRoot,
appendTo: () => {
- const echartsTooltipContainerSelector = `.${ECHARTS_TOOLTIP_CONTAINER_CLASS}`;
- const containerSelector = !isEmbeddingSdk()
- ? echartsTooltipContainerSelector
- : `#${EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID} ${echartsTooltipContainerSelector}`;
+ const root = tooltipRootProvider();
- // Unjustified type cast. FIXME
- let container = document.querySelector(
- containerSelector,
- ) as HTMLDivElement;
+ let container =
+ root?.querySelector<HTMLDivElement>(
+ `.${ECHARTS_TOOLTIP_CONTAINER_CLASS}`,
+ ) ?? null;
if (!container) {
container = document.createElement("div");
@@ -96,13 +96,7 @@ export const getTooltipBaseOption = (
"calc(var(--mb-overlay-z-index) + 1)",
);
- if (!isEmbeddingSdk()) {
- document.body.append(container);
- } else {
- document
- .getElementById(EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID)
- ?.append(container);
- }
+ root?.append(container);
}
return container;
diff --git a/frontend/src/metabase/visualizations/lib/image-exports.ts b/frontend/src/metabase/visualizations/lib/image-exports.ts
index 5199a688785..5e658cc6654 100644
--- a/frontend/src/metabase/visualizations/lib/image-exports.ts
+++ b/frontend/src/metabase/visualizations/lib/image-exports.ts
@@ -3,7 +3,6 @@ import { css } from "@emotion/react";
import GlobalDashboardS from "metabase/css/dashboard.module.css";
import EmbedFrameS from "metabase/embedding/theme.module.css";
-import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { isStorybookActive } from "metabase/env";
import { utf8_to_b64 } from "metabase/utils/encoding";
import { openImageBlobOnStorybook } from "metabase/utils/loki-utils";
@@ -18,7 +17,7 @@ export const SAVING_DOM_IMAGE_OVERFLOW_VISIBLE_CLASS =
"saving-dom-image-overflow-visible";
export const PARAMETERS_MARGIN_BOTTOM = 12;
-export const saveDomImageStyles = css`
+export const getSaveDomImageStyles = (allowTextOverflow: boolean) => css`
.${SAVING_DOM_IMAGE_CLASS} {
.${SAVING_DOM_IMAGE_HIDDEN_CLASS} {
visibility: hidden;
@@ -37,10 +36,9 @@ export const saveDomImageStyles = css`
border: 1px solid var(--mb-color-border-neutral);
}
- /* the renderer for saving to image/pdf does not support text overflow
- with line height in custom themes in the embedding sdk.
- this is a workaround to make sure the text is not clipped vertically */
- ${isEmbeddingSdk() &&
+ /* The export renderer clips text vertically when a custom theme changes the line height.
+ The flag works around that by capturing with overflow visible. */
+ ${allowTextOverflow &&
css`
[data-dashcard-key].${GlobalDashboardS.Card} * {
overflow: visible !important;
diff --git a/frontend/src/metabase/visualizations/lib/settings.ts b/frontend/src/metabase/visualizations/lib/settings.ts
index 8bbe5b8ec7c..7815409a0ea 100644
--- a/frontend/src/metabase/visualizations/lib/settings.ts
+++ b/frontend/src/metabase/visualizations/lib/settings.ts
@@ -1,10 +1,5 @@
import _ from "underscore";
-import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import {
- convertLinkColumnToClickBehavior,
- removeInternalClickBehaviors,
-} from "metabase/embedding-sdk/lib/links";
import type {
ComputedVisualizationSettings,
SettingsExtra,
@@ -19,6 +14,20 @@ import type {
} from "metabase-types/api";
import { isObjectWithRaw } from "metabase-types/guards";
+type ComputedSettingsTransform = (
+ computedSettings: ComputedVisualizationSettings,
+ extra: SettingsExtra,
+) => ComputedVisualizationSettings;
+
+// The embedding SDK sets this to rewrite click behaviours in the computed settings.
+let computedSettingsTransform: ComputedSettingsTransform | null = null;
+
+export function setComputedSettingsTransform(
+ transform: ComputedSettingsTransform | null,
+) {
+ computedSettingsTransform = transform;
+}
+
export function getComputedSettings<T>(
settingsDefs: VisualizationSettingsDefinitions,
object: T,
@@ -38,18 +47,8 @@ export function getComputedSettings<T>(
);
}
- if (isEmbeddingSdk()) {
- const shouldKeepInternalClickBehavior = extra.enableEntityNavigation;
-
- const result: ComputedVisualizationSettings = _.compose(
- // remove internal click behaviors unless internal navigation is enabled
- shouldKeepInternalClickBehavior
- ? _.identity
- : removeInternalClickBehaviors,
- convertLinkColumnToClickBehavior,
- )(computedSettings);
-
- return result;
+ if (computedSettingsTransform) {
+ return computedSettingsTransform(computedSettings, extra);
}
return computedSettings;
diff --git a/frontend/src/metabase/visualizations/register.ts b/frontend/src/metabase/visualizations/register.ts
index ec8684769f0..05d5473a1f6 100644
--- a/frontend/src/metabase/visualizations/register.ts
+++ b/frontend/src/metabase/visualizations/register.ts
@@ -1,4 +1,14 @@
+import _ from "underscore";
+
import { ColorRangeSelector } from "metabase/common/components/ColorRangeSelector";
+import {
+ EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID,
+ isEmbeddingSdk,
+} from "metabase/embedding-sdk/config";
+import {
+ convertLinkColumnToClickBehavior,
+ removeInternalClickBehaviors,
+} from "metabase/embedding-sdk/lib/links";
import {
registerSettingWidgets,
registerVisualization,
@@ -31,7 +41,10 @@ import { ChartSettingSeriesOrder } from "./components/settings/ChartSettingSerie
import { ChartSettingTableColumns } from "./components/settings/ChartSettingTableColumns";
import { ChartSettingToggle } from "./components/settings/ChartSettingToggle";
import { ChartSettingsTableFormatting } from "./components/settings/ChartSettingsTableFormatting";
+import { setTooltipRootProvider } from "./echarts/tooltip";
import { registerJsxFormatting } from "./lib/register-jsx-formatting";
+import { setComputedSettingsTransform } from "./lib/settings";
+import type { ComputedVisualizationSettings, SettingsExtra } from "./types";
import { AREA_CHART_DEFINITION } from "./visualizations/AreaChart/definition";
import { BAR_CHART_DEFINITION } from "./visualizations/BarChart/definition";
import { BOXPLOT_CHART_DEFINITION } from "./visualizations/BoxPlot/definition";
@@ -207,8 +220,35 @@ function registerVisualizationSettingWidgets() {
});
}
+function transformComputedSettingsForSdk(
+ computedSettings: ComputedVisualizationSettings,
+ extra: SettingsExtra,
+): ComputedVisualizationSettings {
+ if (!isEmbeddingSdk()) {
+ return computedSettings;
+ }
+
+ const shouldKeepInternalClickBehavior = extra.enableEntityNavigation;
+
+ return _.compose(
+ // remove internal click behaviors unless internal navigation is enabled
+ shouldKeepInternalClickBehavior ? _.identity : removeInternalClickBehaviors,
+ convertLinkColumnToClickBehavior,
+ )(computedSettings);
+}
+
+function registerSdkAwareBehaviors() {
+ setComputedSettingsTransform(transformComputedSettingsForSdk);
+ setTooltipRootProvider(() =>
+ isEmbeddingSdk()
+ ? document.getElementById(EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID)
+ : document.body,
+ );
+}
+
export function registerVisualizations() {
registerVisualizationComponents();
registerVisualizationSettingWidgets();
registerJsxFormatting();
+ registerSdkAwareBehaviors();
}
diff --git a/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts b/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts
index 980ef2a80ed..62820bcb363 100644
--- a/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts
+++ b/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts
@@ -1,7 +1,7 @@
import { t } from "ttag";
import _ from "underscore";
-import { DEFAULT_METABASE_COMPONENT_THEME } from "metabase/embedding-sdk/theme";
+import { DEFAULT_METABASE_COMPONENT_THEME } from "metabase/ui";
import { sumArray } from "metabase/utils/arrays";
import { measureText } from "metabase/utils/measure-text";
import { isPivotGroupColumn } from "metabase/visualizations/lib/data_grid";
diff --git a/frontend/src/metabase/visualizations/visualizations/TreemapChart/use-label-measurement.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/TreemapChart/use-label-measurement.unit.spec.ts
index ea968977334..5a380289369 100644
--- a/frontend/src/metabase/visualizations/visualizations/TreemapChart/use-label-measurement.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/TreemapChart/use-label-measurement.unit.spec.ts
@@ -4,9 +4,10 @@ import type { MutableRefObject } from "react";
import type { TreemapFormatters } from "metabase/visualizations/echarts/graph/treemap/model/formatters";
import type { TreemapTree } from "metabase/visualizations/echarts/graph/treemap/model/types";
-import { DEFAULT_VISUALIZATION_THEME } from "metabase/visualizations/shared/utils/theme";
import type { RenderingContext } from "metabase/visualizations/types";
+import { DEFAULT_VISUALIZATION_THEME } from "../../shared/utils/theme";
+
import { useLabelMeasurement } from "./use-label-measurement";
const renderingContext: RenderingContext = {