Skip to content

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

GDGT-1998 Get rid of VisualizationSettingDefinition["marginBottom"] (#71004)

Kamil Mielnik3c229eb38d18
diff --git a/frontend/src/metabase/visualizations/lib/settings.ts b/frontend/src/metabase/visualizations/lib/settings.ts
index 428974ce758..d7fb5947290 100644
--- a/frontend/src/metabase/visualizations/lib/settings.ts
+++ b/frontend/src/metabase/visualizations/lib/settings.ts
@@ -200,7 +200,7 @@ function getSettingWidget<T, TValue, TProps extends Record<string, unknown>>(
}
const getHiddenFn = settingDef.getHidden;
- const { getProps, ...settingDefProps } = settingDef;
+ const { getMarginBottom, getProps, ...settingDefProps } = settingDef;
const section = settingDef.getSection
? settingDef.getSection(resolvedObject, computedSettings, extra)
@@ -214,9 +214,7 @@ function getSettingWidget<T, TValue, TProps extends Record<string, unknown>>(
hidden: getHiddenFn
? getHiddenFn(resolvedObject, computedSettings, extra)
: (settingDef.hidden ?? false),
- marginBottom: settingDef.getMarginBottom
- ? settingDef.getMarginBottom(resolvedObject, computedSettings, extra)
- : settingDef.marginBottom,
+ marginBottom: getMarginBottom?.(resolvedObject, computedSettings, extra),
props:
getProps?.(
resolvedObject,
diff --git a/frontend/src/metabase/visualizations/lib/settings/goal.ts b/frontend/src/metabase/visualizations/lib/settings/goal.ts
index ddc0f77930f..678feca964b 100644
--- a/frontend/src/metabase/visualizations/lib/settings/goal.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/goal.ts
@@ -2,6 +2,7 @@ import { t } from "ttag";
import { getDefaultGoalLabel } from "metabase/visualizations/shared/settings/cartesian-chart";
import type { ChartGoal } from "metabase/visualizations/shared/types/settings";
+import type { VisualizationSettingsDefinitions } from "metabase/visualizations/types";
import type { VisualizationSettings } from "metabase-types/api";
import { getStackOffset } from "./stacking";
@@ -23,7 +24,7 @@ export const getChartGoal = (
};
};
-export const GRAPH_GOAL_SETTINGS = {
+export const GRAPH_GOAL_SETTINGS: VisualizationSettingsDefinitions = {
"graph.show_goal": {
get section() {
return t`Display`;
@@ -34,7 +35,7 @@ export const GRAPH_GOAL_SETTINGS = {
widget: "toggle",
default: false,
inline: true,
- marginBottom: "1rem",
+ getMarginBottom: () => "1rem",
},
"graph.goal_value": {
get section() {
@@ -45,7 +46,7 @@ export const GRAPH_GOAL_SETTINGS = {
},
widget: "number",
default: 0,
- getHidden: (_series: unknown, vizSettings: VisualizationSettings) =>
+ getHidden: (_series, vizSettings) =>
vizSettings["graph.show_goal"] !== true,
readDependencies: ["graph.show_goal"],
},
@@ -58,7 +59,7 @@ export const GRAPH_GOAL_SETTINGS = {
},
widget: "input",
getDefault: getDefaultGoalLabel,
- getHidden: (_series: unknown, vizSettings: VisualizationSettings) =>
+ getHidden: (_series, vizSettings) =>
vizSettings["graph.show_goal"] !== true,
readDependencies: ["graph.show_goal"],
},
diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.ts b/frontend/src/metabase/visualizations/lib/settings/graph.ts
index e04d3518ce5..74dbd068287 100644
--- a/frontend/src/metabase/visualizations/lib/settings/graph.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/graph.ts
@@ -158,7 +158,7 @@ export const GRAPH_DATA_SETTINGS: VisualizationSettingsDefinitions = {
return t`Data`;
},
widget: ChartSettingSeriesOrder,
- marginBottom: "1rem",
+ getMarginBottom: () => "1rem",
useRawSeries: true,
getValue: (rawSeries, settings) => {
const seriesModels = getSeriesModelsForSettings(rawSeries, settings);
@@ -427,7 +427,7 @@ export const GRAPH_TREND_SETTINGS: VisualizationSettingsDefinitions = {
},
useRawSeries: true,
inline: true,
- marginBottom: "1rem",
+ getMarginBottom: () => "1rem",
},
};
@@ -443,7 +443,7 @@ export const GRAPH_DISPLAY_VALUES_SETTINGS: VisualizationSettingsDefinitions = {
getHidden: (series, vizSettings) => !canHaveDataLabels(series, vizSettings),
getDefault: getDefaultShowDataLabels,
inline: true,
- marginBottom: "1rem",
+ getMarginBottom: () => "1rem",
},
"graph.label_value_frequency": {
get section() {
@@ -1056,7 +1056,7 @@ export const BOXPLOT_SETTINGS: VisualizationSettingsDefinitions<
widget: "toggle",
default: false,
inline: true,
- marginBottom: "1rem",
+ getMarginBottom: () => "1rem",
},
"boxplot.show_values_mode": {
get section() {
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index 3762302c82a..aa4c73bb992 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -354,7 +354,6 @@ export type VisualizationSettingDefinition<
) => string;
autoOpenWhenUnset?: boolean;
default?: TValue;
- marginBottom?: string;
noPadding?: boolean;
value?: TValue;
set?: boolean;
@@ -391,8 +390,12 @@ export type CompleteVisualizationSettingDefinition<
T = unknown,
TValue = unknown,
TProps extends Record<string, unknown> = Record<string, unknown>,
-> = Omit<VisualizationSettingDefinition<T, TValue, TProps>, "getProps"> & {
+> = Omit<
+ VisualizationSettingDefinition<T, TValue, TProps>,
+ "getMarginBottom" | "getProps"
+> & {
id: string;
+ marginBottom?: string;
props: Partial<TProps>;
};
@@ -450,6 +453,8 @@ export type VisualizationSettingsDefinitions<
>;
"graph.colors"?: SeriesSettingDefinition<Value, Props>;
"graph.dimensions"?: SeriesSettingDefinition<Value, Props>;
+ "graph.goal_label"?: SeriesSettingDefinition<Value, Props>;
+ "graph.goal_value"?: SeriesSettingDefinition<Value, Props>;
"graph.metrics"?: SeriesSettingDefinition<Value, Props>;
"graph.label_value_frequency"?: SeriesSettingDefinition<
Value,
@@ -469,6 +474,7 @@ export type VisualizationSettingsDefinitions<
ChartSettingSeriesOrderProps
>;
"graph.series_order_dimension"?: SeriesSettingDefinition<Value, Props>;
+ "graph.show_goal"?: SeriesSettingDefinition<Value, Props>;
"graph.show_mean"?: SeriesSettingDefinition<Value, Props>;
"graph.show_stack_values"?: SeriesSettingDefinition<Value, Props>;
"graph.show_trendline"?: SeriesSettingDefinition<Value, Props>;
diff --git a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
index 74fb694dc7c..8415c1f3b89 100644
--- a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx
@@ -92,7 +92,7 @@ Object.assign(Funnel, {
dashboard: false,
useRawSeries: true,
showColumnSetting: true,
- marginBottom: "0.625rem",
+ getMarginBottom: () => "0.625rem",
}),
"funnel.order_dimension": {
getValue: (_series: RawSeries, settings: ComputedVisualizationSettings) =>
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts
index 29878278a51..dc32517d586 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts
@@ -151,7 +151,7 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
!extra?.isDashboard || card?.display === "waterfall",
getSection: (_series, _settings, extra) =>
extra?.isDashboard ? t`Display` : t`Style`,
- marginBottom: "0",
+ getMarginBottom: () => "0",
getProps: (_series, vizSettings, _onChange, _extra, onChangeSettings) => {
const pieRows = vizSettings["pie.rows"];
if (pieRows == null) {
@@ -197,7 +197,7 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
widget: "toggle",
getDefault: getDefaultShowLegend,
inline: true,
- marginBottom: "1rem",
+ getMarginBottom: () => "1rem",
},
"pie.show_total": {
get section() {
@@ -209,7 +209,7 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
widget: "toggle",
getDefault: getDefaultShowTotal,
inline: true,
- marginBottom: "1rem",
+ getMarginBottom: () => "1rem",
},
"pie.show_labels": {
get section() {