Skip to content

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

GDGT-1869 Remove "as VisualizationSettingsDefinitions" casts (#71217)

Kamil Mielnikaee64c60470c
diff --git a/frontend/src/metabase-types/api/dataset.ts b/frontend/src/metabase-types/api/dataset.ts
index f098b104a60..e63c195db90 100644
--- a/frontend/src/metabase-types/api/dataset.ts
+++ b/frontend/src/metabase-types/api/dataset.ts
@@ -207,8 +207,13 @@ export type SingleSeriesWithTranslation = SingleSeries & {
};
};
+export type TransformedCard = Card & {
+ _seriesKey: string;
+ _transformed: true;
+};
+
export type RawSeries = SingleSeries[];
-export type TransformedSeries = RawSeries & { _raw: Series };
+export type TransformedSeries = RawSeries & { _raw?: Series };
export type MaybeTranslatedSeries = SingleSeriesWithTranslation[];
export type Series = RawSeries | TransformedSeries;
diff --git a/frontend/src/metabase/actions/components/ActionViz/ActionViz.tsx b/frontend/src/metabase/actions/components/ActionViz/ActionViz.tsx
index 8e1600e2a0d..423f2658876 100644
--- a/frontend/src/metabase/actions/components/ActionViz/ActionViz.tsx
+++ b/frontend/src/metabase/actions/components/ActionViz/ActionViz.tsx
@@ -4,6 +4,7 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
import type { VisualizationSettings } from "metabase-types/api";
import Action from "./Action";
@@ -11,8 +12,7 @@ import Action from "./Action";
const isForm = (object: any, computedSettings: VisualizationSettings) =>
computedSettings.actionDisplayType === "form";
-// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default Object.assign(Action, {
+const ActionViz: VisualizationDefinition = {
getUiName: () => t`Action`,
identifier: "action",
iconName: "play",
@@ -77,4 +77,7 @@ export default Object.assign(Action, {
}),
},
},
-});
+};
+
+// eslint-disable-next-line import/no-default-export -- deprecated usage
+export default Object.assign(Action, ActionViz);
diff --git a/frontend/src/metabase/dashboard/components/ActionSidebar/ActionSidebar.tsx b/frontend/src/metabase/dashboard/components/ActionSidebar/ActionSidebar.tsx
index a74c6e148ff..796560afad6 100644
--- a/frontend/src/metabase/dashboard/components/ActionSidebar/ActionSidebar.tsx
+++ b/frontend/src/metabase/dashboard/components/ActionSidebar/ActionSidebar.tsx
@@ -11,11 +11,12 @@ import { Sidebar } from "metabase/common/components/Sidebar";
import CS from "metabase/css/core/index.css";
import { useDashboardContext } from "metabase/dashboard/context";
import { Form, FormProvider, FormSelect, FormTextInput } from "metabase/forms";
+import { checkNotNull } from "metabase/lib/types";
import { Box, Button, Divider, Flex, Modal, Stack, Title } from "metabase/ui";
import type { ActionDashboardCard } from "metabase-types/api";
-const buttonVariantOptions =
- ActionViz.settings["button.variant"].getProps().options;
+const settings = checkNotNull(ActionViz.settings);
+const buttonVariantOptions = settings["button.variant"].getProps().options;
export function ActionSidebar() {
const {
diff --git a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx b/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
index 0e12487d16f..1be81b9a284 100644
--- a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
+++ b/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
@@ -20,6 +20,7 @@ import {
} from "metabase/visualizations/shared/utils/sizes";
import type {
ColumnSettingDefinition,
+ VisualizationDefinition,
VisualizationProps,
} from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
@@ -39,7 +40,7 @@ import { ListViewConfiguration } from "../ListView/ListViewConfiguration";
import S from "./ListViz.module.css";
-const vizDefinition = {
+const vizDefinition: VisualizationDefinition = {
identifier: "list",
iconName: "list",
getUiName: () => t`List`,
diff --git a/frontend/src/metabase/visualizations/components/ChartCaption.tsx b/frontend/src/metabase/visualizations/components/ChartCaption.tsx
index cd39139cf69..255a7289750 100644
--- a/frontend/src/metabase/visualizations/components/ChartCaption.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartCaption.tsx
@@ -45,12 +45,14 @@ const ChartCaption = ({
const description = settings["card.description"];
const data =
visualizerRawSeries ?? (series as TransformedSeries)._raw ?? series;
- const card = data[0].card;
- const cardIds = new Set(data.map((s) => s.card.id));
+ const card = data?.[0].card;
+ const cardIds = new Set(data?.map((s) => s.card.id) ?? []);
const canSelectTitle = cardIds.size === 1 && onChangeCardAndRun;
const handleSelectTitle = useCallback(() => {
- onChangeCardAndRun?.({ nextCard: card });
+ if (card) {
+ onChangeCardAndRun?.({ nextCard: card });
+ }
}, [card, onChangeCardAndRun]);
return (
diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.ts b/frontend/src/metabase/visualizations/lib/settings/graph.ts
index 3ec65edf568..9e7c2d99011 100644
--- a/frontend/src/metabase/visualizations/lib/settings/graph.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/graph.ts
@@ -11,6 +11,7 @@ import {
type ChartSettingEnumToggleProps,
} from "metabase/visualizations/components/settings/ChartSettingEnumToggle";
import { ChartSettingMaxCategories } from "metabase/visualizations/components/settings/ChartSettingMaxCategories";
+import type { ChartSettingSegmentedControlProps } from "metabase/visualizations/components/settings/ChartSettingSegmentedControl";
import { ChartSettingSeriesOrder } from "metabase/visualizations/components/settings/ChartSettingSeriesOrder";
import { dimensionIsNumeric } from "metabase/visualizations/lib/numeric";
import { columnSettings } from "metabase/visualizations/lib/settings/column";
@@ -55,6 +56,7 @@ import {
} from "metabase/visualizations/shared/settings/cartesian-chart";
import type {
ComputedVisualizationSettings,
+ SeriesSettingDefinition,
VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
@@ -437,18 +439,14 @@ export const TOOLTIP_SETTINGS: VisualizationSettingsDefinitions = {
getHidden: (rawSeries, vizSettings) => {
return getAvailableAdditionalColumns(rawSeries, vizSettings).length === 0;
},
- getProps: (rawSeries, vizSettings) => {
- const options = getAvailableAdditionalColumns(rawSeries, vizSettings).map(
+ getProps: (rawSeries, vizSettings) => ({
+ options: getAvailableAdditionalColumns(rawSeries, vizSettings).map(
(col) => ({
label: col.display_name,
value: getColumnKey(col),
}),
- );
-
- return {
- options,
- };
- },
+ ),
+ }),
readDependencies: ["graph.metrics", "graph.dimensions"],
},
};
@@ -523,18 +521,8 @@ export const GRAPH_DISPLAY_VALUES_SETTINGS: VisualizationSettingsDefinitions = {
},
getProps: () => ({
options: [
- {
- get name() {
- return t`Some`;
- },
- value: "fit",
- },
- {
- get name() {
- return t`All`;
- },
- value: "all",
- },
+ { name: t`Some`, value: "fit" },
+ { name: t`All`, value: "all" },
],
}),
getDefault: getDefaultDataLabelsFrequency,
@@ -1032,9 +1020,28 @@ export const GRAPH_AXIS_SETTINGS: VisualizationSettingsDefinitions = {
"graph.series_labels": {},
};
-export const BOXPLOT_SETTINGS: VisualizationSettingsDefinitions<
+const BOXPLOT_LABEL_VALUE_FREQUENCY_SETTING: SeriesSettingDefinition<
+ "fit" | "all",
ChartSettingEnumToggleProps<"fit" | "all">
> = {
+ get section() {
+ return t`Display`;
+ },
+ get title() {
+ return t`Hide overlapping labels`;
+ },
+ widget: ChartSettingEnumToggle,
+ getDefault: () => "fit",
+ inline: true,
+ getHidden: (_series, vizSettings) => !vizSettings["graph.show_values"],
+ getProps: () => ({
+ checkedValue: "fit",
+ uncheckedValue: "all",
+ }),
+ readDependencies: ["graph.show_values"],
+};
+
+export const BOXPLOT_SETTINGS: VisualizationSettingsDefinitions = {
"boxplot.whisker_type": {
get section() {
return t`Display`;
@@ -1045,12 +1052,10 @@ export const BOXPLOT_SETTINGS: VisualizationSettingsDefinitions<
widget: "radio",
getDefault: () => "tukey",
getProps: () => ({
- get options() {
- return [
- { name: t`1.5 × interquartile range`, value: "tukey" },
- { name: t`Min/Max`, value: "min-max" },
- ];
- },
+ options: [
+ { name: t`1.5 × interquartile range`, value: "tukey" },
+ { name: t`Min/Max`, value: "min-max" },
+ ],
}),
},
"boxplot.points_mode": {
@@ -1137,23 +1142,20 @@ export const BOXPLOT_SETTINGS: VisualizationSettingsDefinitions<
}),
readDependencies: ["graph.show_values"],
},
- "graph.label_value_frequency": {
- get section() {
- return t`Display`;
- },
- get title() {
- return t`Hide overlapping labels`;
- },
- widget: ChartSettingEnumToggle,
- getDefault: () => "fit",
- inline: true,
- getHidden: (_series, vizSettings) => !vizSettings["graph.show_values"],
- getProps: () => ({
- checkedValue: "fit",
- uncheckedValue: "all",
- }),
- readDependencies: ["graph.show_values"],
- },
+ "graph.label_value_frequency":
+ /**
+ * "graph.label_value_frequency" key is used for 2 different settings:
+ * - in waterfall viz and every cartesian viz - as a segmented toggle
+ * - in boxplot viz - as a switch (on/off)
+ *
+ * It's the only case in VisualizationSettingsDefinitions where 1 key has 2 meanings.
+ * For simplicity, we're defaulting to segmented toggle widget in types,
+ * and making an exception here for the boxplot viz with this cast.
+ */
+ BOXPLOT_LABEL_VALUE_FREQUENCY_SETTING as SeriesSettingDefinition<
+ unknown,
+ ChartSettingSegmentedControlProps
+ >,
"graph.label_value_formatting": {
get section() {
return t`Display`;
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index ce9ddffb558..285bf6c8ffd 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -37,7 +37,6 @@ import type {
import type { VisualizationDisplay } from "metabase-types/api/visualization";
import type { Dispatch, QueryBuilderMode } from "metabase-types/store";
-import type { ChartSettingEnumToggleProps } from "../components/settings/ChartSettingEnumToggle";
import type { ChartSettingGoalInputProps } from "../components/settings/ChartSettingGoalInput";
import type { ChartSettingMaxCategoriesProps } from "../components/settings/ChartSettingMaxCategories";
import type { ChartSettingSegmentedControlProps } from "../components/settings/ChartSettingSegmentedControl";
@@ -415,17 +414,15 @@ type Value = unknown;
type Props = Record<string, unknown>;
/** Object keys are kept in alphabetical order */
-export type VisualizationSettingsDefinitions<
- LabelValueFrequencyWidgetProps extends Props =
- | ChartSettingEnumToggleProps<"fit" | "all">
- | ChartSettingSegmentedControlProps,
-> = {
+export type VisualizationSettingsDefinitions = {
_column_title_full?: DatasetColumnSettingDefinition<Value, Props>;
_header_unit?: DatasetColumnSettingDefinition<Value, Props>;
_numberFormatter?: DatasetColumnSettingDefinition<Value, Props>;
axis?: SingleSeriesSettingDefinition<Value, Props>;
"boxplot.points_mode"?: SeriesSettingDefinition<Value, Props>;
+ "boxplot.show_mean"?: SeriesSettingDefinition<Value, Props>;
"boxplot.show_values_mode"?: SeriesSettingDefinition<Value, Props>;
+ "boxplot.whisker_type"?: SeriesSettingDefinition<Value, Props>;
"card.description"?: SeriesSettingDefinition<Value, Props>;
"card.hide_empty"?: SeriesSettingDefinition<Value, Props>;
"card.title"?: SeriesSettingDefinition<Value, Props>;
@@ -452,9 +449,18 @@ export type VisualizationSettingsDefinitions<
"graph.goal_label"?: SeriesSettingDefinition<Value, Props>;
"graph.goal_value"?: SeriesSettingDefinition<Value, Props>;
"graph.metrics"?: SeriesSettingDefinition<Value, Props>;
+ /**
+ * "graph.label_value_frequency" key is used for 2 different settings:
+ * - in waterfall viz and every cartesian viz - as a segmented toggle
+ * - in boxplot viz - as a switch (on/off)
+ *
+ * It's the only case in VisualizationSettingsDefinitions where 1 setting key has 2 meanings.
+ * For simplicity, we're defaulting to segmented toggle widget in types,
+ * and we make an exception for the boxplot with a cast.
+ */
"graph.label_value_frequency"?: SeriesSettingDefinition<
Value,
- LabelValueFrequencyWidgetProps
+ ChartSettingSegmentedControlProps
>;
"graph.label_value_formatting"?: SeriesSettingDefinition<Value, Props>;
"graph.max_categories"?: SeriesSettingDefinition<
@@ -501,6 +507,8 @@ export type VisualizationSettingsDefinitions<
"line.missing"?: SingleSeriesSettingDefinition<Value, Props>;
"line.size"?: SingleSeriesSettingDefinition<Value, Props>;
"line.style"?: SingleSeriesSettingDefinition<Value, Props>;
+ "link.text"?: SeriesSettingDefinition<Value, Props>;
+ "link.url"?: SeriesSettingDefinition<Value, Props>;
markdown_template?: DatasetColumnSettingDefinition<Value, Props>;
number_separators?: DatasetColumnSettingDefinition<Value, Props>;
number_style?: DatasetColumnSettingDefinition<Value, Props>;
@@ -551,6 +559,11 @@ export type VisualizationSettingsDefinitions<
time_enabled?: DatasetColumnSettingDefinition<Value, Props>;
time_style?: DatasetColumnSettingDefinition<Value, Props>;
title?: SingleSeriesSettingDefinition<Value, Props>;
+ view_as?: SeriesSettingDefinition<Value, Props>;
+ "waterfall.decrease_color"?: SeriesSettingDefinition<Value, Props>;
+ "waterfall.increase_color"?: SeriesSettingDefinition<Value, Props>;
+ "waterfall.show_total"?: SeriesSettingDefinition<Value, Props>;
+ "waterfall.total_color"?: SeriesSettingDefinition<Value, Props>;
/**
* TODO: next line should be removed when VisualizationSettingsDefinitions and VisualizationSettings are complete.
* Once that happens, it should be possible to safely use VisualizationSettingKey for
@@ -605,13 +618,13 @@ export type VisualizationDefinition = {
supportsVisualizer?: boolean;
disableVisualizer?: boolean;
- minSize: VisualizationGridSize;
- defaultSize: VisualizationGridSize;
+ minSize?: VisualizationGridSize;
+ defaultSize?: VisualizationGridSize;
- settings: VisualizationSettingsDefinitions;
+ settings?: VisualizationSettingsDefinitions;
transformSeries?: (series: Series) => TransformedSeries;
- isSensible: (data: DatasetData) => boolean;
+ isSensible?: (data: DatasetData) => boolean;
columnSettings?:
| VisualizationSettingsDefinitions
| ((column: DatasetColumn) => VisualizationSettingsDefinitions);
diff --git a/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx b/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx
index 5e30d005552..a4399be043f 100644
--- a/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/AreaChart/AreaChart.tsx
@@ -10,14 +10,10 @@ import {
getCartesianChartDefinition,
} from "metabase/visualizations/visualizations/CartesianChart/chart-definition";
-import type {
- VisualizationProps,
- VisualizationSettingsDefinitions,
-} from "../../types";
+import type { VisualizationDefinition, VisualizationProps } from "../../types";
-Object.assign(
- AreaChart,
- getCartesianChartDefinition({
+const AreaViz: Omit<VisualizationDefinition, "isSensible" | "checkRenderable"> =
+ {
getUiName: () => t`Area`,
identifier: "area",
iconName: "area",
@@ -27,9 +23,10 @@ Object.assign(
defaultSize: getDefaultSize("area"),
settings: {
...COMBO_CHARTS_SETTINGS_DEFINITIONS,
- } as any as VisualizationSettingsDefinitions,
- }),
-);
+ },
+ };
+
+Object.assign(AreaChart, getCartesianChartDefinition(AreaViz));
export function AreaChart(props: VisualizationProps) {
return <CartesianChart {...props} />;
diff --git a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx
index 9325673cb90..a3c849f55d5 100644
--- a/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/BarChart/BarChart.tsx
@@ -10,14 +10,10 @@ import {
getCartesianChartDefinition,
} from "metabase/visualizations/visualizations/CartesianChart/chart-definition";
-import type {
- VisualizationProps,
- VisualizationSettingsDefinitions,
-} from "../../types";
+import type { VisualizationDefinition, VisualizationProps } from "../../types";
-Object.assign(
- BarChart,
- getCartesianChartDefinition({
+const BarViz: Omit<VisualizationDefinition, "isSensible" | "checkRenderable"> =
+ {
getUiName: () => t`Bar`,
identifier: "bar",
iconName: "bar",
@@ -27,9 +23,10 @@ Object.assign(
defaultSize: getDefaultSize("bar"),
settings: {
...COMBO_CHARTS_SETTINGS_DEFINITIONS,
- } as any as VisualizationSettingsDefinitions,
- }),
-);
+ },
+ };
+
+Object.assign(BarChart, getCartesianChartDefinition(BarViz));
export function BarChart(props: VisualizationProps) {
return <CartesianChart {...props} />;
diff --git a/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.unit.spec.ts
index 8061ccdffc5..72f940b8872 100644
--- a/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/BoxPlot/BoxPlot.unit.spec.ts
@@ -43,7 +43,7 @@ describe("BoxPlot", () => {
cols: columns,
});
- expect(BOXPLOT_CHART_DEFINITION.isSensible(data)).toBe(true);
+ expect(BOXPLOT_CHART_DEFINITION.isSensible?.(data)).toBe(true);
});
it("should return false when there is only one dimension column", () => {
@@ -58,7 +58,7 @@ describe("BoxPlot", () => {
cols: [categoryColumn, metricColumn],
});
- expect(BOXPLOT_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(BOXPLOT_CHART_DEFINITION.isSensible?.(data)).toBe(false);
});
it("should return false when there are no rows", () => {
@@ -67,7 +67,7 @@ describe("BoxPlot", () => {
cols: columns,
});
- expect(BOXPLOT_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(BOXPLOT_CHART_DEFINITION.isSensible?.(data)).toBe(false);
});
it("should return false when there is no metric column", () => {
@@ -97,7 +97,7 @@ describe("BoxPlot", () => {
cols: columnsWithoutMetric,
});
- expect(BOXPLOT_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(BOXPLOT_CHART_DEFINITION.isSensible?.(data)).toBe(false);
});
it("should return true for multiple categories with sufficient total rows", () => {
@@ -112,7 +112,7 @@ describe("BoxPlot", () => {
cols: columns,
});
- expect(BOXPLOT_CHART_DEFINITION.isSensible(data)).toBe(true);
+ expect(BOXPLOT_CHART_DEFINITION.isSensible?.(data)).toBe(true);
});
});
});
diff --git a/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.ts
index 1ec43b94940..d13a0ae19d7 100644
--- a/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/BoxPlot/chart-definition.ts
@@ -13,13 +13,13 @@ import {
} from "metabase/visualizations/shared/utils/sizes";
import type {
ComputedVisualizationSettings,
- VisualizationSettingsDefinitions,
+ VisualizationDefinition,
} from "metabase/visualizations/types";
import { transformSeries } from "metabase/visualizations/visualizations/CartesianChart/chart-definition-legacy";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
import type { DatasetData, RawSeries } from "metabase-types/api";
-export const BOXPLOT_CHART_DEFINITION = {
+export const BOXPLOT_CHART_DEFINITION: VisualizationDefinition = {
getUiName: () => t`Box Plot`,
identifier: "boxplot",
iconName: "boxplot",
@@ -53,5 +53,5 @@ export const BOXPLOT_CHART_DEFINITION = {
...GRAPH_GOAL_SETTINGS,
...GRAPH_AXIS_SETTINGS,
...BOXPLOT_DATA_SETTINGS,
- } as any as VisualizationSettingsDefinitions,
+ },
};
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts
index a3d79f05986..2b88a95ad98 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.ts
@@ -22,6 +22,7 @@ import {
import { SERIES_SETTING_KEY } from "metabase/visualizations/shared/settings/series";
import type {
Visualization,
+ VisualizationDefinition,
VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
@@ -43,7 +44,7 @@ const transformCartesianSeries = (series: Series): TransformedSeries => {
};
export const getCartesianChartDefinition = (
- props: Partial<Visualization>,
+ props: Partial<VisualizationDefinition>,
): Partial<Visualization> => {
return {
noHeader: true,
@@ -105,16 +106,17 @@ export const getCartesianChartDefinition = (
};
};
-export const COMBO_CHARTS_SETTINGS_DEFINITIONS = {
- ...STACKABLE_SETTINGS,
- ...SPLIT_PANELS_SETTINGS,
- ...LINE_SETTINGS,
- ...GRAPH_GOAL_SETTINGS,
- ...GRAPH_TREND_SETTINGS,
- ...GRAPH_COLORS_SETTINGS,
- ...GRAPH_AXIS_SETTINGS,
- ...GRAPH_DISPLAY_VALUES_SETTINGS,
- ...GRAPH_DATA_SETTINGS,
- ...TOOLTIP_SETTINGS,
- ...LEGEND_SETTINGS,
-} as any as VisualizationSettingsDefinitions;
+export const COMBO_CHARTS_SETTINGS_DEFINITIONS: VisualizationSettingsDefinitions =
+ {
+ ...STACKABLE_SETTINGS,
+ ...SPLIT_PANELS_SETTINGS,
+ ...LINE_SETTINGS,
+ ...GRAPH_GOAL_SETTINGS,
+ ...GRAPH_TREND_SETTINGS,
+ ...GRAPH_COLORS_SETTINGS,
+ ...GRAPH_AXIS_SETTINGS,
+ ...GRAPH_DISPLAY_VALUES_SETTINGS,
+ ...GRAPH_DATA_SETTINGS,
+ ...TOOLTIP_SETTINGS,
+ ...LEGEND_SETTINGS,
+ };
diff --git a/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx b/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx
index 7f9117b0bfe..091feb27535 100644
--- a/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/ComboChart/ComboChart.tsx
@@ -10,26 +10,25 @@ import {
getCartesianChartDefinition,
} from "metabase/visualizations/visualizations/CartesianChart/chart-definition";
-import type {
- VisualizationProps,
- VisualizationSettingsDefinitions,
-} from "../../types";
+import type { VisualizationDefinition, VisualizationProps } from "../../types";
-Object.assign(
- ComboChart,
- getCartesianChartDefinition({
- getUiName: () => t`Combo`,
- identifier: "combo",
- iconName: "lineandbar",
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- noun: t`line and bar chart`,
- minSize: getMinSize("combo"),
- defaultSize: getDefaultSize("combo"),
- settings: {
- ...COMBO_CHARTS_SETTINGS_DEFINITIONS,
- } as any as VisualizationSettingsDefinitions,
- }),
-);
+const ComboViz: Omit<
+ VisualizationDefinition,
+ "isSensible" | "checkRenderable"
+> = {
+ getUiName: () => t`Combo`,
+ identifier: "combo",
+ iconName: "lineandbar",
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ noun: t`line and bar chart`,
+ minSize: getMinSize("combo"),
+ defaultSize: getDefaultSize("combo"),
+ settings: {
+ ...COMBO_CHARTS_SETTINGS_DEFINITIONS,
+ },
+};
+
+Object.assign(ComboChart, getCartesianChartDefinition(ComboViz));
export function ComboChart(props: VisualizationProps) {
return <CartesianChart {...props} />;
diff --git a/frontend/src/metabase/visualizations/visualizations/DashCardPlaceholder.tsx b/frontend/src/metabase/visualizations/visualizations/DashCardPlaceholder.tsx
index c60b8c42570..b21c5de9d2a 100644
--- a/frontend/src/metabase/visualizations/visualizations/DashCardPlaceholder.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/DashCardPlaceholder.tsx
@@ -11,7 +11,7 @@ import { useDispatch } from "metabase/lib/redux";
import { Button, Flex } from "metabase/ui";
import type { Dashboard, VirtualDashboardCard } from "metabase-types/api";
-import type { VisualizationProps } from "../types";
+import type { VisualizationDefinition, VisualizationProps } from "../types";
type Props = VisualizationProps & {
dashcard: VirtualDashboardCard;
@@ -111,7 +111,7 @@ function preventDragging(e: React.MouseEvent<HTMLButtonElement>) {
e.stopPropagation();
}
-export const DashCardPlaceholder = Object.assign(DashCardPlaceholderInner, {
+const PlaceholderViz: VisualizationDefinition = {
getUiName: () => t`Empty card`,
identifier: "placeholder",
iconName: "table",
@@ -125,4 +125,9 @@ export const DashCardPlaceholder = Object.assign(DashCardPlaceholderInner, {
checkRenderable: () => {
// always renderable
},
-});
+};
+
+export const DashCardPlaceholder = Object.assign(
+ DashCardPlaceholderInner,
+ PlaceholderViz,
+);
diff --git a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
index 03579d5a835..bae277af28b 100644
--- a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
@@ -25,6 +25,7 @@ import {
} from "metabase/visualizations/shared/utils/sizes";
import type {
ComputedVisualizationSettings,
+ VisualizationDefinition,
VisualizationProps,
} from "metabase/visualizations/types";
import { BarChart } from "metabase/visualizations/visualizations/BarChart";
@@ -44,7 +45,7 @@ const getUniqueFunnelRows = (rows: FunnelRow[]) => {
return [...new Map(rows.map((row) => [row.key, row])).values()];
};
-Object.assign(Funnel, {
+const FunnelViz: VisualizationDefinition = {
getUiName: () => t`Funnel`,
identifier: "funnel",
iconName: "funnel",
@@ -188,7 +189,9 @@ Object.assign(Funnel, {
useRawSeries: true,
},
},
-});
+};
+
+Object.assign(Funnel, FunnelViz);
export function Funnel(props: VisualizationProps) {
const {
diff --git a/frontend/src/metabase/visualizations/visualizations/Heading/index.ts b/frontend/src/metabase/visualizations/visualizations/Heading/index.ts
index caf543007a5..4323d0925c1 100644
--- a/frontend/src/metabase/visualizations/visualizations/Heading/index.ts
+++ b/frontend/src/metabase/visualizations/visualizations/Heading/index.ts
@@ -4,13 +4,14 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
import { Heading } from "./Heading";
-const HeadingWrapper = Object.assign(Heading, {
+const HeadingViz: VisualizationDefinition = {
getUiName: () => t`Heading`,
identifier: "heading",
- iconName: "heading",
+ iconName: "empty",
canSavePng: false,
noHeader: true,
@@ -41,6 +42,8 @@ const HeadingWrapper = Object.assign(Heading, {
getDefault: () => false,
},
},
-});
+};
+
+const HeadingWrapper = Object.assign(Heading, HeadingViz);
export { HeadingWrapper as Heading };
diff --git a/frontend/src/metabase/visualizations/visualizations/IFrameViz/IFrameVizSettings.ts b/frontend/src/metabase/visualizations/visualizations/IFrameViz/IFrameVizSettings.ts
index c5a4a9e026c..e857ed7f01d 100644
--- a/frontend/src/metabase/visualizations/visualizations/IFrameViz/IFrameVizSettings.ts
+++ b/frontend/src/metabase/visualizations/visualizations/IFrameViz/IFrameVizSettings.ts
@@ -4,8 +4,9 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
-export const settings = {
+export const settings: VisualizationDefinition = {
getUiName: () => "iframe",
canSavePng: false,
identifier: "iframe",
@@ -20,7 +21,7 @@ export const settings = {
settings: {
"card.title": {
dashboard: false,
- get default() {
+ getDefault() {
return t`Iframe card`;
},
},
diff --git a/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx b/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx
index 26ab8adf16b..7727459c0bd 100644
--- a/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/LineChart/LineChart.tsx
@@ -10,14 +10,10 @@ import {
getCartesianChartDefinition,
} from "metabase/visualizations/visualizations/CartesianChart/chart-definition";
-import type {
- VisualizationProps,
- VisualizationSettingsDefinitions,
-} from "../../types";
+import type { VisualizationDefinition, VisualizationProps } from "../../types";
-Object.assign(
- LineChart,
- getCartesianChartDefinition({
+const LineViz: Omit<VisualizationDefinition, "isSensible" | "checkRenderable"> =
+ {
getUiName: () => t`Line`,
identifier: "line",
iconName: "line",
@@ -27,9 +23,10 @@ Object.assign(
defaultSize: getDefaultSize("line"),
settings: {
...COMBO_CHARTS_SETTINGS_DEFINITIONS,
- } as any as VisualizationSettingsDefinitions,
- }),
-);
+ },
+ };
+
+Object.assign(LineChart, getCartesianChartDefinition(LineViz));
export function LineChart(props: VisualizationProps) {
return <CartesianChart {...props} />;
diff --git a/frontend/src/metabase/visualizations/visualizations/LinkViz/LinkVizSettings.ts b/frontend/src/metabase/visualizations/visualizations/LinkViz/LinkVizSettings.ts
index 5d2961e7e52..ad8d7e8a331 100644
--- a/frontend/src/metabase/visualizations/visualizations/LinkViz/LinkVizSettings.ts
+++ b/frontend/src/metabase/visualizations/visualizations/LinkViz/LinkVizSettings.ts
@@ -4,8 +4,9 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
-export const settings = {
+export const settings: VisualizationDefinition = {
getUiName: () => "Link",
canSavePng: false,
identifier: "link",
@@ -20,7 +21,7 @@ export const settings = {
settings: {
"card.title": {
dashboard: false,
- get default() {
+ getDefault() {
return t`Link card`;
},
},
@@ -36,5 +37,4 @@ export const settings = {
}),
},
},
- preventDragging: (e: React.SyntheticEvent) => e.stopPropagation(),
};
diff --git a/frontend/src/metabase/visualizations/visualizations/ObjectDetail.tsx b/frontend/src/metabase/visualizations/visualizations/ObjectDetail.tsx
index 9b8b31ee8cf..b5724c630c6 100644
--- a/frontend/src/metabase/visualizations/visualizations/ObjectDetail.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/ObjectDetail.tsx
@@ -11,10 +11,7 @@ import {
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
-import type {
- VisualizationDefinition,
- VisualizationSettingsDefinitions,
-} from "../types";
+import type { VisualizationDefinition } from "../types";
const ObjectDetailProperties: VisualizationDefinition = {
getUiName() {
@@ -35,7 +32,7 @@ const ObjectDetailProperties: VisualizationDefinition = {
...tableColumnSettings({ isShowingDetailsOnlyColumns: true }),
},
columnSettings: () => {
- const settings: VisualizationSettingsDefinitions = {
+ return {
column_title: {
title: t`Column title`,
widget: "input",
@@ -49,8 +46,6 @@ const ObjectDetailProperties: VisualizationDefinition = {
link_text: { hidden: true },
link_url: { hidden: true },
};
-
- return settings;
},
isSensible: () => true,
checkRenderable: () => true,
diff --git a/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx b/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx
index 4f572451aff..cd9ea9e4e89 100644
--- a/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PivotTable/PivotTable.tsx
@@ -33,7 +33,10 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
-import type { VisualizationProps } from "metabase/visualizations/types";
+import type {
+ VisualizationDefinition,
+ VisualizationProps,
+} from "metabase/visualizations/types";
import type { State } from "metabase-types/store";
import {
@@ -612,19 +615,21 @@ export const PivotTableView = ExplicitSize<
refreshMode: "debounceLeading",
})(PivotTableInner);
+const PivotViz: VisualizationDefinition = {
+ getUiName: () => t`Pivot Table`,
+ identifier: "pivot",
+ iconName: "pivot_table",
+ minSize: getMinSize("pivot"),
+ defaultSize: getDefaultSize("pivot"),
+ canSavePng: false,
+ isSensible,
+ checkRenderable,
+ settings,
+ columnSettings,
+ isLiveResizable: () => false,
+};
+
export const PivotTable = Object.assign(
connect(mapStateToProps)(PivotTableView),
- {
- getUiName: () => t`Pivot Table`,
- identifier: "pivot",
- iconName: "pivot_table",
- minSize: getMinSize("pivot"),
- defaultSize: getDefaultSize("pivot"),
- canSavePng: false,
- isSensible,
- checkRenderable,
- settings,
- columnSettings,
- isLiveResizable: () => false,
- },
+ PivotViz,
);
diff --git a/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts b/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts
index c21ee797d7d..ab2801a0b87 100644
--- a/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts
+++ b/frontend/src/metabase/visualizations/visualizations/PivotTable/utils.ts
@@ -10,8 +10,8 @@ import { migratePivotColumnSplitSetting } from "metabase-lib/v1/queries/utils/pi
import type {
ColumnNameColumnSplitSetting,
DatasetColumn,
- DatasetData,
PivotTableColumnSplitSetting,
+ Series,
VisualizationSettings,
} from "metabase-types/api";
@@ -224,7 +224,7 @@ export function isSensible({ cols }: { cols: DatasetColumn[] }) {
}
export function checkRenderable(
- [{ data }]: [{ data: DatasetData }],
+ [{ data }]: Series,
settings: VisualizationSettings,
query?: NativeQuery | null,
) {
diff --git a/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx b/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx
index 1ffb48d7dd6..a306c52f8f6 100644
--- a/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Progress/Progress.tsx
@@ -4,6 +4,7 @@ import { t } from "ttag";
import CS from "metabase/css/core/index.css";
import { formatValue } from "metabase/lib/formatting";
+import { checkNotNull } from "metabase/lib/types";
import { Flex, Icon } from "metabase/ui";
import type { VisualizationProps } from "metabase/visualizations/types";
@@ -217,6 +218,8 @@ export function Progress(props: VisualizationProps) {
);
}
+const minSize = checkNotNull(PROGRESS_CHART_DEFINITION.minSize);
+
function computeBarHeight({
cardHeight,
componentHeight,
@@ -230,7 +233,7 @@ function computeBarHeight({
return `${MAX_BAR_HEIGHT}px`;
}
- const isSmallCard = cardHeight === PROGRESS_CHART_DEFINITION.minSize.height;
+ const isSmallCard = cardHeight === minSize.height;
if (isSmallCard && !isMobile) {
const computedHeight =
MIN_BAR_HEIGHT + (componentHeight - COMPONENT_HEIGHT_TO_MIN_BAR_HEIGHT);
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
index 4741e6314d4..87540a8b0a0 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
@@ -43,8 +43,8 @@ import {
import type {
ComputedVisualizationSettings,
RemappingHydratedChartData,
+ VisualizationDefinition,
VisualizationProps,
- VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import {
getClickData,
@@ -53,7 +53,12 @@ import {
} from "metabase/visualizations/visualizations/RowChart/utils/events";
import { useRowChartTheme } from "metabase/visualizations/visualizations/RowChart/utils/theme";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
-import type { DatasetData, VisualizationSettings } from "metabase-types/api";
+import type {
+ Card,
+ DatasetData,
+ TransformedCard,
+ VisualizationSettings,
+} from "metabase-types/api";
import {
RowChartContainer,
@@ -328,110 +333,103 @@ const RowChartVisualization = ({
);
};
-RowChartVisualization.getUiName = () => t`Row`;
-RowChartVisualization.identifier = "row";
-RowChartVisualization.iconName = "horizontal_bar";
-// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
-RowChartVisualization.noun = t`row chart`;
-
-RowChartVisualization.noHeader = true;
-RowChartVisualization.minSize = getMinSize("row");
-RowChartVisualization.defaultSize = getDefaultSize("row");
-
-const settings: VisualizationSettingsDefinitions = {
- ...ROW_CHART_SETTINGS,
- ...GRAPH_DATA_SETTINGS,
-};
-RowChartVisualization.settings = settings;
-
-RowChartVisualization.isSensible = ({ cols, rows }: DatasetData) => {
- return (
- rows.length > 1 &&
- cols.length >= 2 &&
- cols.filter(isDimension).length > 0 &&
- cols.filter(isMetric).length > 0
- );
-};
-
-RowChartVisualization.isLiveResizable = (series: any[]) => {
- const totalRows = series.reduce((sum, s) => sum + s.data.rows.length, 0);
- return totalRows < 10;
-};
-
-RowChartVisualization.settings["graph.metrics"] = {
- ...RowChartVisualization.settings["graph.metrics"],
- get title() {
- return t`X-axis`;
+const RowViz: VisualizationDefinition = {
+ getUiName: () => t`Row`,
+ identifier: "row",
+ iconName: "horizontal_bar",
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ noun: t`row chart`,
+ noHeader: true,
+ hasEmptyState: true,
+ minSize: getMinSize("row"),
+ defaultSize: getDefaultSize("row"),
+ settings: {
+ ...ROW_CHART_SETTINGS,
+ ...GRAPH_DATA_SETTINGS,
+ ["graph.metrics"]: {
+ ...GRAPH_DATA_SETTINGS["graph.metrics"],
+ get title() {
+ return t`X-axis`;
+ },
+ },
+ ["graph.dimensions"]: {
+ ...GRAPH_DATA_SETTINGS["graph.dimensions"],
+ get title() {
+ return t`Y-axis`;
+ },
+ },
},
-};
-RowChartVisualization.settings["graph.dimensions"] = {
- ...RowChartVisualization.settings["graph.dimensions"],
- get title() {
- return t`Y-axis`;
+ isSensible: ({ cols, rows }: DatasetData) => {
+ return (
+ rows.length > 1 &&
+ cols.length >= 2 &&
+ cols.filter(isDimension).length > 0 &&
+ cols.filter(isMetric).length > 0
+ );
},
-};
-
-/**
- * Required to make it compatible with series settings without rewriting them fully
- * It expands a single card + dataset into multiple "series" and sets _seriesKey which is needed for settings to work
- */
-RowChartVisualization.transformSeries = (originalMultipleSeries: any) => {
- const [series] = originalMultipleSeries;
- const settings: ComputedVisualizationSettings = getComputedSettingsForSeries(
- originalMultipleSeries,
- );
- const { card, data } = series;
-
- if (card._transformed || !hasValidColumnsSelected(settings, data)) {
- return originalMultipleSeries;
- }
-
- const cardinality = getBreakoutCardinality(data.cols, data.rows, settings);
- if (cardinality != null && cardinality > MAX_SERIES) {
- return originalMultipleSeries;
- }
-
- const chartColumns = getCartesianChartColumns(data.cols, settings);
- const seriesDefinitions = getSeries(
- data,
- chartColumns,
- getColumnValueFormatter(),
- settings,
- );
+ isLiveResizable: (series: any[]) => {
+ const totalRows = series.reduce((sum, s) => sum + s.data.rows.length, 0);
+ return totalRows < 10;
+ },
+ /**
+ * Required to make it compatible with series settings without rewriting them fully
+ * It expands a single card + dataset into multiple "series" and sets _seriesKey which is needed for settings to work
+ */
+ transformSeries: (originalMultipleSeries) => {
+ const [series] = originalMultipleSeries;
+ const settings: ComputedVisualizationSettings =
+ getComputedSettingsForSeries(originalMultipleSeries);
+ const { card, data } = series;
+
+ if (isTransformedCard(card) || !hasValidColumnsSelected(settings, data)) {
+ return originalMultipleSeries;
+ }
- const transformedSeries = seriesDefinitions.map((seriesDef) => ({
- card: {
- ...card,
- name: seriesDef.seriesName,
- _seriesKey: seriesDef.seriesKey,
- _transformed: true,
- },
- data: {
- ...data,
- cols: [
- seriesDef.seriesInfo?.dimensionColumn,
- seriesDef.seriesInfo?.metricColumn,
- ],
- },
- }));
+ const cardinality = getBreakoutCardinality(data.cols, data.rows, settings);
+ if (cardinality != null && cardinality > MAX_SERIES) {
+ return originalMultipleSeries;
+ }
- return transformedSeries.length > 0
- ? transformedSeries
- : originalMultipleSeries;
-};
+ const chartColumns = getCartesianChartColumns(data.cols, settings);
+ const seriesDefinitions = getSeries(
+ data,
+ chartColumns,
+ getColumnValueFormatter(),
+ settings,
+ );
-RowChartVisualization.checkRenderable = (
- series: any[],
- settings: VisualizationSettings,
-) => {
- validateDatasetRows(series);
- validateBreakoutSeriesCount(series, settings);
- validateChartDataSettings(settings);
- validateStacking(settings);
+ const transformedSeries = seriesDefinitions.map((seriesDef) => ({
+ card: {
+ ...card,
+ name: seriesDef.seriesName,
+ _seriesKey: seriesDef.seriesKey,
+ _transformed: true,
+ },
+ data: {
+ ...data,
+ cols: [
+ seriesDef.seriesInfo?.dimensionColumn,
+ seriesDef.seriesInfo?.metricColumn,
+ ].filter((column) => column != null),
+ },
+ }));
+
+ return transformedSeries.length > 0
+ ? transformedSeries
+ : originalMultipleSeries;
+ },
+ checkRenderable: (series: any[], settings: VisualizationSettings) => {
+ validateDatasetRows(series);
+ validateBreakoutSeriesCount(series, settings);
+ validateChartDataSettings(settings);
+ validateStacking(settings);
+ },
};
-RowChartVisualization.hasEmptyState = true;
+function isTransformedCard(card: Card): card is TransformedCard {
+ return "_transformed" in card && card._transformed === true;
+}
-RowChartVisualization.getUiName = () => t`Row`;
+Object.assign(RowChartVisualization, RowViz);
export { RowChartVisualization as RowChart };
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.unit.spec.ts
index eddae89227a..cecf2562ccd 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.unit.spec.ts
@@ -1,3 +1,4 @@
+import { checkNotNull } from "metabase/lib/types";
import { ChartSettingsError } from "metabase/visualizations/lib/errors";
import { createMockCard } from "metabase-types/api/mocks/card";
import {
@@ -7,6 +8,8 @@ import {
import { SANKEY_CHART_DEFINITION } from "./chart-definition";
+const isSensible = checkNotNull(SANKEY_CHART_DEFINITION.isSensible);
+
const columns = [
createMockColumn({
name: "Source",
@@ -37,7 +40,7 @@ describe("SANKEY_CHART_DEFINITION", () => {
cols: columns,
});
- expect(SANKEY_CHART_DEFINITION.isSensible(data)).toBe(true);
+ expect(isSensible(data)).toBe(true);
});
it("should return false when there are no rows", () => {
@@ -46,7 +49,7 @@ describe("SANKEY_CHART_DEFINITION", () => {
cols: columns,
});
- expect(SANKEY_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(isSensible(data)).toBe(false);
});
it("should return false when there are not enough columns", () => {
@@ -55,7 +58,7 @@ describe("SANKEY_CHART_DEFINITION", () => {
cols: columns.slice(0, 2),
});
- expect(SANKEY_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(isSensible(data)).toBe(false);
});
it("should return false when there are not enough dimension columns", () => {
@@ -86,7 +89,7 @@ describe("SANKEY_CHART_DEFINITION", () => {
cols: columnsWithoutDimensions,
});
- expect(SANKEY_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(isSensible(data)).toBe(false);
});
it("should return false when there are not enough metric columns", () => {
@@ -116,7 +119,7 @@ describe("SANKEY_CHART_DEFINITION", () => {
cols: columnsWithoutMetrics,
});
- expect(SANKEY_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(isSensible(data)).toBe(false);
});
it("should return false when data contains cycles", () => {
@@ -129,7 +132,7 @@ describe("SANKEY_CHART_DEFINITION", () => {
cols: columns,
});
- expect(SANKEY_CHART_DEFINITION.isSensible(data)).toBe(false);
+ expect(isSensible(data)).toBe(false);
});
});
diff --git a/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx b/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx
index 17e06e035f0..c157980cdc2 100644
--- a/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/ScatterPlot/ScatterPlot.tsx
@@ -17,33 +17,32 @@ import {
SPLIT_PANELS_SETTINGS,
TOOLTIP_SETTINGS,
} from "../../lib/settings/graph";
-import type {
- VisualizationProps,
- VisualizationSettingsDefinitions,
-} from "../../types";
+import type { VisualizationDefinition, VisualizationProps } from "../../types";
-Object.assign(
- ScatterPlot,
- getCartesianChartDefinition({
- getUiName: () => t`Scatter`,
- identifier: "scatter",
- iconName: "bubble",
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- noun: t`scatter plot`,
- minSize: getMinSize("scatter"),
- defaultSize: getDefaultSize("scatter"),
- settings: {
- ...GRAPH_BUBBLE_SETTINGS,
- ...GRAPH_GOAL_SETTINGS,
- ...GRAPH_TREND_SETTINGS,
- ...GRAPH_COLORS_SETTINGS,
- ...GRAPH_AXIS_SETTINGS,
- ...GRAPH_DATA_SETTINGS,
- ...SPLIT_PANELS_SETTINGS,
- ...TOOLTIP_SETTINGS,
- } as any as VisualizationSettingsDefinitions,
- }),
-);
+const ScatterViz: Omit<
+ VisualizationDefinition,
+ "isSensible" | "checkRenderable"
+> = {
+ getUiName: () => t`Scatter`,
+ identifier: "scatter",
+ iconName: "bubble",
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ noun: t`scatter plot`,
+ minSize: getMinSize("scatter"),
+ defaultSize: getDefaultSize("scatter"),
+ settings: {
+ ...GRAPH_BUBBLE_SETTINGS,
+ ...GRAPH_GOAL_SETTINGS,
+ ...GRAPH_TREND_SETTINGS,
+ ...GRAPH_COLORS_SETTINGS,
+ ...GRAPH_AXIS_SETTINGS,
+ ...GRAPH_DATA_SETTINGS,
+ ...SPLIT_PANELS_SETTINGS,
+ ...TOOLTIP_SETTINGS,
+ },
+};
+
+Object.assign(ScatterPlot, getCartesianChartDefinition(ScatterViz));
export function ScatterPlot(props: VisualizationProps) {
return <CartesianChart {...props} />;
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
index 947f90e46b4..b47d7ac82bb 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
@@ -17,6 +17,7 @@ import {
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
import type {
+ VisualizationDefinition,
VisualizationPassThroughProps,
VisualizationProps,
VisualizationSettingsDefinitions,
@@ -233,7 +234,7 @@ export const SETTINGS_DEFINITIONS: VisualizationSettingsDefinitions = {
click_behavior: {},
};
-Object.assign(SmartScalar, {
+const SmartScalarViz: VisualizationDefinition = {
getUiName: () => t`Trend`,
identifier: "smartscalar",
iconName: "smartscalar",
@@ -265,4 +266,6 @@ Object.assign(SmartScalar, {
},
hasEmptyState: true,
-});
+};
+
+Object.assign(SmartScalar, SmartScalarViz);
diff --git a/frontend/src/metabase/visualizations/visualizations/Text/index.ts b/frontend/src/metabase/visualizations/visualizations/Text/index.ts
index f82f4141228..9186a8c1aa1 100644
--- a/frontend/src/metabase/visualizations/visualizations/Text/index.ts
+++ b/frontend/src/metabase/visualizations/visualizations/Text/index.ts
@@ -4,13 +4,14 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
import { Text } from "./Text";
-const TextWrapper = Object.assign(Text, {
+const TextViz: VisualizationDefinition = {
getUiName: () => t`Text`,
identifier: "text",
- iconName: "text",
+ iconName: "empty",
canSavePng: false,
disableSettingsConfig: false,
@@ -78,6 +79,8 @@ const TextWrapper = Object.assign(Text, {
getDefault: () => true,
},
},
-});
+};
+
+const TextWrapper = Object.assign(Text, TextViz);
export { TextWrapper as Text };
diff --git a/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx b/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx
index d98045f15b7..889e4d7627d 100644
--- a/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx
@@ -14,82 +14,80 @@ import {
} from "metabase/visualizations/shared/utils/sizes";
import type {
ComputedVisualizationSettings,
+ VisualizationDefinition,
VisualizationProps,
- VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
import { CartesianChart } from "../CartesianChart";
import { getCartesianChartDefinition } from "../CartesianChart/chart-definition";
-Object.assign(
- WaterfallChart,
- getCartesianChartDefinition({
- getUiName: () => t`Waterfall`,
- identifier: "waterfall",
- iconName: "waterfall",
- isSensible: ({ cols, rows }) => {
- const dimensionCount = cols.filter(
- (col) => isDimension(col) && !isMetric(col),
- ).length;
- const metricCount = cols.filter(isMetric).length;
- return (
- rows.length > 1 &&
- cols.length >= 2 &&
- dimensionCount === 1 &&
- metricCount > 0
- );
+const WaterfallViz: Omit<VisualizationDefinition, "checkRenderable"> = {
+ getUiName: () => t`Waterfall`,
+ identifier: "waterfall",
+ iconName: "waterfall",
+ isSensible: ({ cols, rows }) => {
+ const dimensionCount = cols.filter(
+ (col) => isDimension(col) && !isMetric(col),
+ ).length;
+ const metricCount = cols.filter(isMetric).length;
+ return (
+ rows.length > 1 &&
+ cols.length >= 2 &&
+ dimensionCount === 1 &&
+ metricCount > 0
+ );
+ },
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ noun: t`waterfall chart`,
+ minSize: getMinSize("waterfall"),
+ defaultSize: getDefaultSize("waterfall"),
+ maxMetricsSupported: 1,
+ maxDimensionsSupported: 1,
+ supportsVisualizer: false,
+ settings: {
+ ...GRAPH_AXIS_SETTINGS,
+ "waterfall.increase_color": {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Display`,
+ getProps: () => ({ title: t`Increase color` }),
+ widget: "color",
+ getDefault: () => color("accent1"),
},
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- noun: t`waterfall chart`,
- minSize: getMinSize("waterfall"),
- defaultSize: getDefaultSize("waterfall"),
- maxMetricsSupported: 1,
- maxDimensionsSupported: 1,
- supportsVisualizer: false,
- settings: {
- ...GRAPH_AXIS_SETTINGS,
- "waterfall.increase_color": {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Display`,
- getProps: () => ({ title: t`Increase color` }),
- widget: "color",
- getDefault: () => color("accent1"),
- },
- "waterfall.decrease_color": {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Display`,
- getProps: () => ({ title: t`Decrease color` }),
- widget: "color",
- getDefault: () => color("accent3"),
- },
- "waterfall.show_total": {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Display`,
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- title: t`Show total`,
- widget: "toggle",
- getDefault: () => true,
- inline: true,
- },
- "waterfall.total_color": {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Display`,
- getProps: () => ({ title: t`Total color` }),
- widget: "color",
- // Unfortunately, to get static viz to look right, we need to avoid using alpha colors here
- getDefault: () =>
- Color(color("text-primary", staticVizOverrides)).hex(),
- getHidden: (_series: any, vizSettings: ComputedVisualizationSettings) =>
- vizSettings["waterfall.show_total"] !== true,
- readDependencies: ["waterfall.show_total"],
- },
- ...GRAPH_DISPLAY_VALUES_SETTINGS,
- ...GRAPH_DATA_SETTINGS,
- ...TOOLTIP_SETTINGS,
- } as any as VisualizationSettingsDefinitions,
- }),
-);
+ "waterfall.decrease_color": {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Display`,
+ getProps: () => ({ title: t`Decrease color` }),
+ widget: "color",
+ getDefault: () => color("accent3"),
+ },
+ "waterfall.show_total": {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Display`,
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ title: t`Show total`,
+ widget: "toggle",
+ getDefault: () => true,
+ inline: true,
+ },
+ "waterfall.total_color": {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Display`,
+ getProps: () => ({ title: t`Total color` }),
+ widget: "color",
+ // Unfortunately, to get static viz to look right, we need to avoid using alpha colors here
+ getDefault: () => Color(color("text-primary", staticVizOverrides)).hex(),
+ getHidden: (_series: any, vizSettings: ComputedVisualizationSettings) =>
+ vizSettings["waterfall.show_total"] !== true,
+ readDependencies: ["waterfall.show_total"],
+ },
+ ...GRAPH_DISPLAY_VALUES_SETTINGS,
+ ...GRAPH_DATA_SETTINGS,
+ ...TOOLTIP_SETTINGS,
+ },
+};
+
+Object.assign(WaterfallChart, getCartesianChartDefinition(WaterfallViz));
export function WaterfallChart(props: VisualizationProps) {
return <CartesianChart {...props} />;