Skip to content

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

chore: migrate registerVisualization to typescript (#70306)

Uladzimir Havenchykee7bd843cece
diff --git a/enterprise/frontend/src/custom-viz/src/types/format.ts b/enterprise/frontend/src/custom-viz/src/types/format.ts
index 674638e8116..94f9507f95c 100644
--- a/enterprise/frontend/src/custom-viz/src/types/format.ts
+++ b/enterprise/frontend/src/custom-viz/src/types/format.ts
@@ -6,7 +6,7 @@ export type FormatValueOptions = {
currency?: string;
currency_style?: string;
date_format?: string;
- date_style?: string;
+ date_style?: string | null;
date_separator?: string;
date_abbreviate?: boolean;
decimals?: number;
diff --git a/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-common.ts b/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-common.ts
index 186d0215971..2e767f6f76e 100644
--- a/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-common.ts
+++ b/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-common.ts
@@ -1,7 +1,15 @@
import type { CustomVisualization } from "custom-viz";
+import type { ComponentType } from "react";
-import type { Visualization } from "metabase/visualizations/types/visualization";
-import type { CustomVizPluginId } from "metabase-types/api";
+import type {
+ Visualization,
+ VisualizationPassThroughProps,
+ VisualizationProps,
+} from "metabase/visualizations/types/visualization";
+import type {
+ CustomVizPluginId,
+ VisualizationDisplay,
+} from "metabase-types/api";
import { sanitizePluginSettings } from "./custom-viz-settings";
@@ -18,17 +26,17 @@ import { sanitizePluginSettings } from "./custom-viz-settings";
* components.
*/
export function applyDefaultVisualizationProps(
- Component: Visualization,
+ Component: ComponentType<VisualizationProps & VisualizationPassThroughProps>,
vizDef: CustomVisualization<Record<string, unknown>>,
settings: {
- identifier: string;
+ identifier: VisualizationDisplay;
pluginId: CustomVizPluginId;
getUiName: () => string;
iconUrl?: string | undefined;
isDev?: boolean;
},
-) {
- Object.assign(Component, {
+): Visualization {
+ return Object.assign(Component, {
settings:
sanitizePluginSettings(
vizDef.settings,
@@ -43,5 +51,5 @@ export function applyDefaultVisualizationProps(
defaultSize: vizDef.defaultSize,
isDev: settings.isDev,
...settings,
- } satisfies Partial<Record<keyof Visualization, unknown>>);
+ });
}
diff --git a/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-plugins.tsx b/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-plugins.tsx
index edb8d1cc64e..8d759733768 100644
--- a/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-plugins.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/custom_viz/custom-viz-plugins.tsx
@@ -23,10 +23,7 @@ import {
getCustomPluginIdentifier,
getPluginAssetUrl,
} from "metabase/visualizations/custom-visualizations/custom-viz-utils";
-import type {
- Visualization,
- VisualizationProps,
-} from "metabase/visualizations/types/visualization";
+import type { VisualizationProps } from "metabase/visualizations/types/visualization";
import { useListCustomVizPluginsQuery } from "metabase-enterprise/api";
import type {
CustomVizPluginId,
@@ -413,16 +410,17 @@ export async function loadCustomVizPlugin(
);
// Attach the required static properties onto the component function
- const Component = ExplicitSize<VisualizationProps>({ wrapped: true })(
- Wrapper,
- ) as Visualization;
- applyDefaultVisualizationProps(Component, vizDef, {
- identifier,
- pluginId: plugin.id,
- getUiName: () => plugin.display_name,
- iconUrl: resolvedIconUrl,
- isDev: Boolean(plugin.dev_bundle_url),
- });
+ const Component = applyDefaultVisualizationProps(
+ ExplicitSize<VisualizationProps>({ wrapped: true })(Wrapper),
+ vizDef,
+ {
+ identifier,
+ pluginId: plugin.id,
+ getUiName: () => plugin.display_name,
+ iconUrl: resolvedIconUrl,
+ isDev: Boolean(plugin.dev_bundle_url),
+ },
+ );
if (!isLatest()) {
return identifier;
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx
index 8869fc3515b..f274d6aea05 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/ChartTypeDropdown/ChartTypeDropdown.tsx
@@ -4,7 +4,9 @@ import { t } from "ttag";
import type { IconName } from "metabase/embedding-sdk/types/icon";
import { Combobox, Flex, Icon, Text, useCombobox } from "metabase/ui";
import { isNotNull } from "metabase/utils/types";
-import visualizations from "metabase/visualizations";
+import visualizations, {
+ getIconForVisualizationType,
+} from "metabase/visualizations";
import type { Visualization } from "metabase/visualizations/types";
import type { CardDisplayType } from "metabase-types/api";
@@ -97,11 +99,13 @@ export const ChartTypeDropdownInner = (props: ChartTypeDropdownInnerProps) => {
return null;
}
+ const icon = getIconForVisualizationType(visualizationType);
+
return {
value: visualizationType,
label: visualization.getUiName(),
- iconName: visualization.iconName,
- iconUrl: visualization.iconUrl,
+ iconName: icon.name,
+ iconUrl: icon.iconUrl,
};
};
diff --git a/frontend/src/metabase/documents/components/Editor/Editor.stories.tsx b/frontend/src/metabase/documents/components/Editor/Editor.stories.tsx
index b42998e2b8a..da3298e429d 100644
--- a/frontend/src/metabase/documents/components/Editor/Editor.stories.tsx
+++ b/frontend/src/metabase/documents/components/Editor/Editor.stories.tsx
@@ -26,9 +26,7 @@ import {
import { Editor, type EditorProps } from "./Editor";
import Data from "./data/data.json";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(LineChart);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(PieChart);
const settings = mockSettings();
diff --git a/frontend/src/metabase/documents/utils/visualizationUtils.ts b/frontend/src/metabase/documents/utils/visualizationUtils.ts
index 32ec2a8f263..99fe912ebb5 100644
--- a/frontend/src/metabase/documents/utils/visualizationUtils.ts
+++ b/frontend/src/metabase/documents/utils/visualizationUtils.ts
@@ -1,7 +1,9 @@
import { useMemo } from "react";
import { isNotNull } from "metabase/utils/types";
-import visualizations from "metabase/visualizations";
+import visualizations, {
+ getIconForVisualizationType,
+} from "metabase/visualizations";
import { getSensibleVisualizations } from "metabase/visualizations/lib/sensibility";
import type {
Dataset,
@@ -27,11 +29,13 @@ export function getVisualizationItem(
return null;
}
+ const icon = getIconForVisualizationType(visualizationType);
+
return {
value: visualizationType,
label: visualization.getUiName(),
- iconName: visualization.iconName,
- iconUrl: visualization.iconUrl,
+ iconName: icon.name,
+ iconUrl: icon.iconUrl,
};
}
diff --git a/frontend/src/metabase/palette/components/Palette.stories.tsx b/frontend/src/metabase/palette/components/Palette.stories.tsx
index 9a0c9133c6b..f6c3b056e38 100644
--- a/frontend/src/metabase/palette/components/Palette.stories.tsx
+++ b/frontend/src/metabase/palette/components/Palette.stories.tsx
@@ -28,13 +28,9 @@ const storeInitialState = createMockState({
settings,
entities: createMockEntitiesState({}),
});
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(SmartScalar);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(ComboChart);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(LineChart);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Table);
// Unjustified type cast. FIXME
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-card-filters.stories.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-card-filters.stories.tsx
index df6abeaacae..b4261208fb4 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-card-filters.stories.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-card-filters.stories.tsx
@@ -35,9 +35,8 @@ import { PRODUCTS } from "metabase-types/api/mocks/presets";
import { PublicOrEmbeddedDashboardView } from "./PublicOrEmbeddedDashboardView";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
-// @ts-expect-error: incompatible prop types with registerVisualization
+// @ts-expect-error: Heading has its own HeadingProps shape; migrate props to VisualizationProps
registerVisualization(Heading);
export default {
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-filters.stories.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-filters.stories.tsx
index 7a8bacce0dd..c39a9577650 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-filters.stories.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-filters.stories.tsx
@@ -44,9 +44,7 @@ import {
import { PublicOrEmbeddedDashboardView } from "./PublicOrEmbeddedDashboardView";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Table);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
/**
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-pdf-export.stories.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-pdf-export.stories.tsx
index 25f99229e2b..06a087bcb78 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-pdf-export.stories.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView-pdf-export.stories.tsx
@@ -33,7 +33,6 @@ import {
createMockDatasetData,
} from "metabase-types/api/mocks";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Map);
// Initialize MetabaseSettings with required values for map rendering
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView.stories.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView.stories.tsx
index 0643bc3c914..e92cdf3b7e8 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView.stories.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedDashboard/PublicOrEmbeddedDashboardView.stories.tsx
@@ -44,9 +44,7 @@ import {
import { PublicOrEmbeddedDashboardView } from "./PublicOrEmbeddedDashboardView";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Table);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
export default {
@@ -401,7 +399,6 @@ export function ComponentCompatibility() {
// Card visualizations
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(ObjectDetail);
export const CardVisualizationsLightTheme = {
diff --git a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx
index 62ec2dd7c62..773850e2ef1 100644
--- a/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx
+++ b/frontend/src/metabase/public/containers/PublicOrEmbeddedQuestion/PublicOrEmbeddedQuestionView.stories.tsx
@@ -39,13 +39,9 @@ import {
type PublicOrEmbeddedQuestionViewProps,
} from "./PublicOrEmbeddedQuestionView";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(PivotTable);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(SmartScalar);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Table);
export default {
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts b/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts
index bfc90ada638..0d47221a4a8 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/types.ts
@@ -4,8 +4,8 @@ import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type Table from "metabase-lib/v1/metadata/Table";
import type {
Card,
+ DashboardCard,
DatasetData,
- QuestionDashboardCard,
RowValue,
} from "metabase-types/api";
@@ -28,7 +28,7 @@ export interface ObjectDetailProps {
question?: Question;
metadata?: Metadata;
card?: Card;
- dashcard?: QuestionDashboardCard;
+ dashcard?: DashboardCard;
isObjectDetail?: boolean; // whether this should be shown in a modal
table?: Table | null;
zoomedRow?: RowValue[] | undefined;
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
index bc7cb6ed864..3718e076ce1 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
@@ -685,7 +685,6 @@ class Visualization extends PureComponent<
getHref,
hasDevWatermark,
headerIcon,
- height: rawHeight,
isAction,
isDashboard,
isDocument,
@@ -732,7 +731,6 @@ class Visualization extends PureComponent<
tableHeaderHeight,
timelineEvents,
totalNumGridCols,
- width: rawWidth,
onDeselectTimelineEvents,
onOpenChartSettings,
onOpenTimelines,
@@ -951,7 +949,7 @@ class Visualization extends PureComponent<
getHref={getHref}
gridSize={gridSize}
headerIcon={hasHeader ? null : headerIcon}
- height={rawHeight}
+ height={height}
hovered={hovered}
isDashboard={!!isDashboard}
isDocument={!!isDocument}
@@ -989,7 +987,7 @@ class Visualization extends PureComponent<
timelineEvents={timelineEvents}
totalNumGridCols={totalNumGridCols}
visualizationIsClickable={this.visualizationIsClickable}
- width={rawWidth}
+ width={width}
zoomedRowIndex={zoomedRowIndex}
onZoomRow={onZoomRow}
onActionDismissal={this.hideActions}
diff --git a/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts b/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts
index 272ce1b3059..26ed269aa13 100644
--- a/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/typed-utils.unit.spec.ts
@@ -11,7 +11,6 @@ import {
sanitizeDashcardSettings,
} from "./typed-utils";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
describe("mergeSettings (metabase#14597)", () => {
diff --git a/frontend/src/metabase/visualizations/register.js b/frontend/src/metabase/visualizations/register.ts
similarity index 100%
rename from frontend/src/metabase/visualizations/register.js
rename to frontend/src/metabase/visualizations/register.ts
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index ee17b365333..6bd44e75e04 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -262,7 +262,7 @@ export type VisualizationPassThroughProps = {
* Items that will be shown in a menu when the title is clicked.
* Used for visualizer cards to jump to underlying questions
*/
- titleMenuItems?: ReactNode[];
+ titleMenuItems?: ReactNode;
// frontend/src/metabase/visualizations/components/ChartSettings/ChartSettingsVisualization/ChartSettingsVisualization.tsx
isSettings?: boolean;
@@ -630,10 +630,7 @@ export type VisualizationGridSize = {
// TODO: add component property for the react component instead of the intersection
export type Visualization = ComponentType<
- Omit<VisualizationProps, "width" | "height"> & {
- width?: number | null;
- height?: number | null;
- } & VisualizationPassThroughProps
+ VisualizationProps & VisualizationPassThroughProps
> &
VisualizationDefinition;
@@ -643,7 +640,7 @@ export type VisualizationDefinition = {
getUiName: () => string;
identifier: VisualizationDisplay;
aliases?: string[];
- iconName: IconName;
+ iconName?: IconName;
iconUrl?: string;
hasEmptyState?: boolean;
isDev?: boolean; // is custom viz in dev mode
diff --git a/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx b/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx
index b67683f0755..2bc75748202 100644
--- a/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx
@@ -4,8 +4,11 @@ import type { VisualizationProps } from "../../types";
import { AREA_CHART_DEFINITION } from "./definition";
-Object.assign(AreaChart, AREA_CHART_DEFINITION);
-
-export function AreaChart(props: VisualizationProps) {
+function AreaChartComponent(props: VisualizationProps) {
return <CartesianChart {...props} />;
}
+
+export const AreaChart = Object.assign(
+ AreaChartComponent,
+ AREA_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.stories.tsx b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.stories.tsx
index 31ca14ae5e1..ce87ada9272 100644
--- a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.stories.tsx
@@ -22,7 +22,6 @@ export default {
component: BarChart,
};
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
// Unjustified type cast. FIXME
diff --git a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx
index 106362bd776..d5b58df647e 100644
--- a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx
@@ -4,8 +4,8 @@ import type { VisualizationProps } from "../../types";
import { BAR_CHART_DEFINITION } from "./definition";
-Object.assign(BarChart, BAR_CHART_DEFINITION);
-
-export function BarChart(props: VisualizationProps) {
+function BarChartComponent(props: VisualizationProps) {
return <CartesianChart {...props} />;
}
+
+export const BarChart = Object.assign(BarChartComponent, BAR_CHART_DEFINITION);
diff --git a/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx
index 35a15a7c461..8ecdd4e702e 100644
--- a/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.tsx
@@ -236,7 +236,7 @@ function BoxPlotInner({
);
}
-export function BoxPlot(props: VisualizationProps) {
+function BoxPlotComponent(props: VisualizationProps) {
return (
<ChartRenderingErrorBoundary onRenderError={props.onRenderError}>
<BoxPlotInner {...props} />
@@ -244,4 +244,7 @@ export function BoxPlot(props: VisualizationProps) {
);
}
-Object.assign(BoxPlot, BOXPLOT_CHART_DEFINITION);
+export const BoxPlot = Object.assign(
+ BoxPlotComponent,
+ BOXPLOT_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts
index 193cf8efd4d..1d8d7506d35 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/definition.ts
@@ -21,7 +21,6 @@ import {
} from "metabase/visualizations/lib/settings/validation";
import { SERIES_SETTING_KEY } from "metabase/visualizations/shared/settings/series";
import type {
- Visualization,
VisualizationDefinition,
VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
@@ -43,70 +42,79 @@ const transformCartesianSeries = (series: Series): TransformedSeries => {
return Object.assign([...transformed], { _raw: series });
};
-export const getCartesianChartDefinition = (
- props: Partial<VisualizationDefinition>,
-): Partial<Visualization> => {
- return {
- noHeader: true,
- usesEChartsRenderer: true,
- supportsVisualizer: true,
-
- isSensible: ({ cols, rows }) => {
- return (
- rows.length > 1 &&
- cols.length >= 2 &&
- cols.filter(isDimension).length > 0 &&
- cols.filter(isMetric).length > 0
- );
- },
-
- isLiveResizable: (series) => {
- const totalRows = series.reduce((sum, s) => sum + s.data.rows.length, 0);
- return totalRows < 10;
- },
-
- checkRenderable(series, settings) {
- validateDatasetRows(series);
- validateBreakoutSeriesCount(series, settings);
- validateChartDataSettings(settings);
- validateStacking(settings);
- },
-
- hasEmptyState: true,
-
- transformSeries: transformCartesianSeries,
-
- onDisplayUpdate: (settings) => {
- if (settings[SERIES_SETTING_KEY] == null) {
- return settings;
- }
-
- const newSettings = _.omit(settings, SERIES_SETTING_KEY);
- const newSeriesSettings: VisualizationSettings["series_settings"] = {};
-
- Object.entries(settings[SERIES_SETTING_KEY]).forEach(
- ([key, seriesSettings]) => {
- const newSingleSeriesSettings = seriesSettings
- ? _.omit(seriesSettings, "display")
- : seriesSettings;
-
- if (!_.isEmpty(newSingleSeriesSettings)) {
- newSeriesSettings[key] = newSingleSeriesSettings;
- }
- },
- );
-
- if (!_.isEmpty(newSeriesSettings)) {
- newSettings[SERIES_SETTING_KEY] = newSeriesSettings;
- }
-
- return newSettings;
- },
-
- ...props,
- };
+type CartesianChartAdditions = Pick<
+ VisualizationDefinition,
+ "isSensible" | "checkRenderable"
+> &
+ Partial<VisualizationDefinition>;
+
+const cartesianChartAdditions: CartesianChartAdditions = {
+ noHeader: true,
+ usesEChartsRenderer: true,
+ supportsVisualizer: true,
+
+ isSensible: ({ cols, rows }) => {
+ return (
+ rows.length > 1 &&
+ cols.length >= 2 &&
+ cols.filter(isDimension).length > 0 &&
+ cols.filter(isMetric).length > 0
+ );
+ },
+
+ isLiveResizable: (series) => {
+ const totalRows = series.reduce((sum, s) => sum + s.data.rows.length, 0);
+ return totalRows < 10;
+ },
+
+ checkRenderable(series, settings) {
+ validateDatasetRows(series);
+ validateBreakoutSeriesCount(series, settings);
+ validateChartDataSettings(settings);
+ validateStacking(settings);
+ },
+
+ hasEmptyState: true,
+
+ transformSeries: transformCartesianSeries,
+
+ onDisplayUpdate: (settings) => {
+ if (settings[SERIES_SETTING_KEY] == null) {
+ return settings;
+ }
+
+ const newSettings = _.omit(settings, SERIES_SETTING_KEY);
+ const newSeriesSettings: VisualizationSettings["series_settings"] = {};
+
+ Object.entries(settings[SERIES_SETTING_KEY]).forEach(
+ ([key, seriesSettings]) => {
+ const newSingleSeriesSettings = seriesSettings
+ ? _.omit(seriesSettings, "display")
+ : seriesSettings;
+
+ if (!_.isEmpty(newSingleSeriesSettings)) {
+ newSeriesSettings[key] = newSingleSeriesSettings;
+ }
+ },
+ );
+
+ if (!_.isEmpty(newSeriesSettings)) {
+ newSettings[SERIES_SETTING_KEY] = newSeriesSettings;
+ }
+
+ return newSettings;
+ },
};
+export const getCartesianChartDefinition = <
+ T extends Partial<VisualizationDefinition>,
+>(
+ props: T,
+): T & CartesianChartAdditions => ({
+ ...cartesianChartAdditions,
+ ...props,
+});
+
export const COMBO_CHARTS_SETTINGS_DEFINITIONS: VisualizationSettingsDefinitions =
{
...STACKABLE_SETTINGS,
diff --git a/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx b/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx
index e18ca8fdc82..117116a6c51 100644
--- a/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx
@@ -4,8 +4,11 @@ import type { VisualizationProps } from "../../types";
import { COMBO_CHART_DEFINITION } from "./definition";
-Object.assign(ComboChart, COMBO_CHART_DEFINITION);
-
-export function ComboChart(props: VisualizationProps) {
+function ComboChartComponent(props: VisualizationProps) {
return <CartesianChart {...props} />;
}
+
+export const ComboChart = Object.assign(
+ ComboChartComponent,
+ COMBO_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.stories.tsx b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.stories.tsx
index 724659e7d9d..64b83804bad 100644
--- a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.stories.tsx
@@ -23,7 +23,6 @@ export default {
component: Funnel,
};
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Funnel);
const dataset_query = createMockStructuredDatasetQuery({
diff --git a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
index ed7801f28cd..09db4f20b70 100644
--- a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
@@ -14,9 +14,7 @@ import { FunnelNormal } from "../../components/FunnelNormal";
import { FUNNEL_CHART_DEFINITION } from "./definition";
-Object.assign(Funnel, FUNNEL_CHART_DEFINITION);
-
-export function Funnel(props: VisualizationProps) {
+function FunnelComponent(props: VisualizationProps) {
const {
headerIcon,
settings,
@@ -82,3 +80,5 @@ export function Funnel(props: VisualizationProps) {
</div>
);
}
+
+export const Funnel = Object.assign(FunnelComponent, FUNNEL_CHART_DEFINITION);
diff --git a/frontend/src/metabase/visualizations/visualizations/Gauge/Gauge.tsx b/frontend/src/metabase/visualizations/visualizations/Gauge/Gauge.tsx
index f181de63691..9f8ed0e2a0e 100644
--- a/frontend/src/metabase/visualizations/visualizations/Gauge/Gauge.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Gauge/Gauge.tsx
@@ -30,9 +30,7 @@ import { GAUGE_CHART_DEFINITION } from "./definition";
import { isGaugeRange, isGaugeSegmentsArray } from "./types";
import { getValue, radians } from "./utils";
-Object.assign(Gauge, GAUGE_CHART_DEFINITION);
-
-export function Gauge({
+function GaugeComponent({
className,
isSettings,
height: heightProp,
@@ -245,3 +243,5 @@ export function Gauge({
</div>
);
}
+
+export const Gauge = Object.assign(GaugeComponent, GAUGE_CHART_DEFINITION);
diff --git a/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.stories.tsx b/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.stories.tsx
index fc7d90e3585..656c9bec688 100644
--- a/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.stories.tsx
@@ -22,7 +22,6 @@ export default {
component: LineChart,
};
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(LineChart);
const dataset_query = createMockStructuredDatasetQuery({
diff --git a/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx b/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx
index 20a81e5c51f..824b17aee26 100644
--- a/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx
@@ -4,8 +4,11 @@ import type { VisualizationProps } from "../../types";
import { LINE_CHART_DEFINITION } from "./definition";
-Object.assign(LineChart, LINE_CHART_DEFINITION);
-
-export function LineChart(props: VisualizationProps) {
+function LineChartComponent(props: VisualizationProps) {
return <CartesianChart {...props} />;
}
+
+export const LineChart = Object.assign(
+ LineChartComponent,
+ LINE_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
index 6dbf9ab0977..d8799173097 100644
--- a/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
@@ -251,7 +251,7 @@ const vizDefinition: VisualizationDefinition = {
},
};
-export const ListViz = ({
+const ListVizComponent = ({
card,
metadata,
data,
@@ -331,4 +331,4 @@ export const ListViz = ({
);
};
-Object.assign(ListViz, vizDefinition);
+export const ListViz = Object.assign(ListVizComponent, vizDefinition);
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.stories.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.stories.tsx
index afded917822..5c719500a56 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.stories.tsx
@@ -23,7 +23,6 @@ export default {
component: PieChart,
};
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(PieChart);
const Template: StoryFn = (args) => {
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx
index 7fc4ca6784a..31f35739fe4 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/PieChart.tsx
@@ -23,9 +23,7 @@ import S from "./PieChart.module.css";
import { PIE_CHART_DEFINITION } from "./definition";
import { useChartEvents } from "./use-chart-events";
-Object.assign(PieChart, PIE_CHART_DEFINITION);
-
-export function PieChart(props: VisualizationProps) {
+function PieChartComponent(props: VisualizationProps) {
const {
fontFamily,
rawSeries,
@@ -207,3 +205,5 @@ export function PieChart(props: VisualizationProps) {
</ChartWithLegend>
);
}
+
+export const PieChart = Object.assign(PieChartComponent, PIE_CHART_DEFINITION);
diff --git a/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx b/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx
index 0a923227b93..ea3f0c78c19 100644
--- a/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx
@@ -23,9 +23,7 @@ const MAX_BAR_HEIGHT = 65;
const MIN_BAR_HEIGHT = 30;
const COMPONENT_HEIGHT_TO_MIN_BAR_HEIGHT = 99;
-Object.assign(Progress, PROGRESS_CHART_DEFINITION);
-
-export function Progress(props: VisualizationProps) {
+function ProgressComponent(props: VisualizationProps) {
const {
className,
isMobile,
@@ -255,3 +253,8 @@ export function IconWithBorder() {
</Flex>
);
}
+
+export const Progress = Object.assign(
+ ProgressComponent,
+ PROGRESS_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.stories.tsx b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.stories.tsx
index b5c8fa252e0..575dc03b841 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.stories.tsx
@@ -19,7 +19,6 @@ export default {
component: RowChart,
};
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(RowChart);
// Unjustified type cast. FIXME
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
index cb8e5be1456..1cb9015cca9 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
@@ -9,7 +9,7 @@ import { extractRemappedColumns } from "metabase/visualizations";
import { getChartGoal } from "metabase/visualizations/lib/settings/goal";
import { getStackOffset } from "metabase/visualizations/lib/settings/stacking";
import type { RowChartProps } from "metabase/visualizations/shared/components/RowChart";
-import { RowChart } from "metabase/visualizations/shared/components/RowChart";
+import { RowChart as SharedRowChart } from "metabase/visualizations/shared/components/RowChart";
import type { BarData } from "metabase/visualizations/shared/components/RowChart/types";
import type {
GroupedDatum,
@@ -60,7 +60,7 @@ interface RowChartRendererProps extends RowChartProps<GroupedDatum> {
function RowChartRendererInner(props: RowChartRendererProps) {
return (
<RowChartContainer data-testid="row-chart-container">
- <RowChart {...props} />
+ <SharedRowChart {...props} />
</RowChartContainer>
);
}
@@ -309,6 +309,7 @@ const RowChartVisualization = ({
);
};
-Object.assign(RowChartVisualization, ROW_CHART_DEFINITION);
-
-export { RowChartVisualization as RowChart };
+export const RowChart = Object.assign(
+ RowChartVisualization,
+ ROW_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx b/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx
index 296f780f52d..1b465774a94 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/SankeyChart.tsx
@@ -18,7 +18,7 @@ import { useTooltipMouseLeave } from "metabase/visualizations/visualizations/Car
import { SANKEY_CHART_DEFINITION } from "./definition";
import { useChartEvents } from "./events";
-export const SankeyChart = ({
+const SankeyChartComponent = ({
rawSeries,
settings,
fontFamily,
@@ -85,4 +85,7 @@ export const SankeyChart = ({
);
};
-Object.assign(SankeyChart, SANKEY_CHART_DEFINITION);
+export const SankeyChart = Object.assign(
+ SankeyChartComponent,
+ SANKEY_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.stories.tsx b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.stories.tsx
index 9aef9378e93..bbec95da1ab 100644
--- a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.stories.tsx
@@ -20,7 +20,6 @@ export default {
component: Scalar,
};
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Scalar);
// Unjustified type cast. FIXME
diff --git a/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx b/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx
index fbfd86b9cab..08627f7ed53 100644
--- a/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx
@@ -4,8 +4,11 @@ import type { VisualizationProps } from "../../types";
import { SCATTER_PLOT_DEFINITION } from "./definition";
-Object.assign(ScatterPlot, SCATTER_PLOT_DEFINITION);
-
-export function ScatterPlot(props: VisualizationProps) {
+function ScatterPlotComponent(props: VisualizationProps) {
return <CartesianChart {...props} />;
}
+
+export const ScatterPlot = Object.assign(
+ ScatterPlotComponent,
+ SCATTER_PLOT_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.stories.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.stories.tsx
index 0b9fe63a977..0200769ef7c 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.stories.tsx
@@ -16,7 +16,6 @@ export default {
component: SmartScalar,
};
-// @ts-expect-error: SmartScalar is not written in TypeScript yet.
registerVisualization(SmartScalar);
const MOCK_ROWS = [
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
index d93d5cee6ba..41734972bdc 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
@@ -22,7 +22,7 @@ import { DASHCARD_HEADER_HEIGHT } from "./constants";
import { SMART_SCALAR_CHART_DEFINITION } from "./definition";
import { getValueHeight, getValueWidth, isPeriodVisible } from "./utils";
-export function SmartScalar({
+function SmartScalarComponent({
onVisualizationClick,
isDashboard,
settings,
@@ -138,4 +138,7 @@ export function SmartScalar({
);
}
-Object.assign(SmartScalar, SMART_SCALAR_CHART_DEFINITION);
+export const SmartScalar = Object.assign(
+ SmartScalarComponent,
+ SMART_SCALAR_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.stories.tsx b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.stories.tsx
index 6bfbd7e86d5..b2bb795ffb7 100644
--- a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.stories.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.stories.tsx
@@ -14,7 +14,6 @@ export default {
component: TreemapChart,
};
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(TreemapChart);
type TemplateArgs = { rawSeries: Series; displayTheme?: "light" | "dark" };
diff --git a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
index 1da5afe289f..941a2e07466 100644
--- a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
@@ -37,7 +37,7 @@ import { useLabelMeasurement } from "./use-label-measurement";
import { usePointerTracking } from "./use-pointer-tracking";
import { useTreemapNavigation } from "./use-treemap-navigation";
-export const TreemapChart = ({
+const TreemapChartComponent = ({
rawSeries,
settings,
fontFamily,
@@ -292,4 +292,7 @@ export const TreemapChart = ({
);
};
-Object.assign(TreemapChart, TREEMAP_CHART_DEFINITION);
+export const TreemapChart = Object.assign(
+ TreemapChartComponent,
+ TREEMAP_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx b/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx
index 250fd8f999b..0a225c76671 100644
--- a/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx
@@ -4,8 +4,11 @@ import type { VisualizationProps } from "../../types";
import { WATERFALL_CHART_DEFINITION } from "./definition";
-Object.assign(WaterfallChart, WATERFALL_CHART_DEFINITION);
-
-export function WaterfallChart(props: VisualizationProps) {
+function WaterfallChartComponent(props: VisualizationProps) {
return <CartesianChart {...props} />;
}
+
+export const WaterfallChart = Object.assign(
+ WaterfallChartComponent,
+ WATERFALL_CHART_DEFINITION,
+);
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
index ea4ac46bb79..1fe92edbc58 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
@@ -9,7 +9,6 @@ import {
import { getInitialStateForMultipleSeries } from "./get-initial-state-for-multiple-series";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(LineChart);
describe("getInitialVisualizerStateForMultipleSeries", () => {
diff --git a/frontend/src/metabase/visualizer/utils/viz-settings.unit.spec.ts b/frontend/src/metabase/visualizer/utils/viz-settings.unit.spec.ts
index 5687208a4a3..bb633b3585c 100644
--- a/frontend/src/metabase/visualizer/utils/viz-settings.unit.spec.ts
+++ b/frontend/src/metabase/visualizer/utils/viz-settings.unit.spec.ts
@@ -4,9 +4,7 @@ import { Map } from "metabase/visualizations/visualizations/Map/Map";
import { getColumnVizSettings } from "./viz-settings";
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(Map);
-// @ts-expect-error: incompatible prop types with registerVisualization
registerVisualization(BarChart);
describe("getColumnVizSettings", () => {