Skip to content

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

Prepare the visualization types for a viz-core module (#80404)

Fraserecdaad1ddca3
diff --git a/frontend/src/metabase/dashboard/actions/cards-typed.ts b/frontend/src/metabase/dashboard/actions/cards-typed.ts
index ec9730da8c1..921f4b4d159 100644
--- a/frontend/src/metabase/dashboard/actions/cards-typed.ts
+++ b/frontend/src/metabase/dashboard/actions/cards-typed.ts
@@ -17,7 +17,7 @@ import {
getPositionForNewDashCard,
} from "metabase/utils/dashboard_grid";
import { checkNotNull } from "metabase/utils/types";
-import { getDefaultSize } from "metabase/visualizations";
+import { getRegisteredDefaultSize } from "metabase/visualizations";
import { getCardIdsFromColumnValueMappings } from "metabase/visualizer/utils";
import type {
Card,
@@ -93,7 +93,7 @@ export const addDashCardToDashboard =
(dispatch: Dispatch, getState: GetState) => {
const display = dashcardOverrides?.card?.display;
const dashCardSize = display
- ? getDefaultSize(display) || DEFAULT_CARD_SIZE
+ ? getRegisteredDefaultSize(display) || DEFAULT_CARD_SIZE
: DEFAULT_CARD_SIZE;
const dashboardState = getState().dashboard;
diff --git a/frontend/src/metabase/query_builder/actions/core/core.ts b/frontend/src/metabase/query_builder/actions/core/core.ts
index ea3c2edfde1..ac7b3acce15 100644
--- a/frontend/src/metabase/query_builder/actions/core/core.ts
+++ b/frontend/src/metabase/query_builder/actions/core/core.ts
@@ -33,7 +33,7 @@ import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import { clone } from "metabase/utils/clone";
import { isNotNull } from "metabase/utils/types";
-import { getDefaultSize } from "metabase/visualizations";
+import { getRegisteredDefaultSize } from "metabase/visualizations";
import { shouldOpenInBlankWindow } from "metabase/visualizations/lib/open-url";
import { getCardAfterVisualizationClick } from "metabase/visualizations/lib/utils";
import * as Lib from "metabase-lib";
@@ -378,7 +378,7 @@ async function reduxCreateQuestion(
options?: OnCreateOptions,
) {
const display = question.display();
- const size = getDefaultSize(display);
+ const size = getRegisteredDefaultSize(display);
// Unjustified type cast. FIXME
const card = (await dispatch(
createQuestionCard({
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/hooks.ts b/frontend/src/metabase/visualizations/components/ChartSettings/hooks.ts
index 8690f48d669..809374889a1 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/hooks.ts
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/hooks.ts
@@ -12,7 +12,7 @@ import type { ComputedVisualizationSettings } from "metabase/visualizations/type
import type {
SettingsExtra,
Widget,
-} from "metabase/visualizations/types/visualization";
+} from "metabase/visualizations/types/definition";
import type Question from "metabase-lib/v1/Question";
import type {
RawSeries,
diff --git a/frontend/src/metabase/visualizations/components/ChoroplethMap.tsx b/frontend/src/metabase/visualizations/components/ChoroplethMap.tsx
index 15c110b49b8..4997fd24aff 100644
--- a/frontend/src/metabase/visualizations/components/ChoroplethMap.tsx
+++ b/frontend/src/metabase/visualizations/components/ChoroplethMap.tsx
@@ -20,7 +20,7 @@ import {
getLegendTitles,
} from "metabase/visualizations/lib/choropleth";
import { MinColumnsError } from "metabase/visualizations/lib/errors";
-import { getCanonicalRowKey } from "metabase/visualizations/lib/mapping";
+import { getCanonicalRowKey } from "metabase/visualizations/lib/region-codes";
import { unaggregatedDataWarningMap } from "metabase/visualizations/lib/warnings";
import {
getDefaultSize,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingColumns.tsx b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingColumns.tsx
index c2813348345..8ea30351309 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingColumns.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingColumns.tsx
@@ -1,8 +1,8 @@
import type { ReactNode } from "react";
+import type { EditWidgetData } from "metabase/visualizations/types";
import type { DatasetColumn } from "metabase-types/api";
-import type { EditWidgetData } from "./ChartSettingTableColumns/types";
import { ColumnItem } from "./ColumnItem";
const displayNameForColumn = (column?: DatasetColumn) =>
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx
index bd95fc3cb8b..f074b12eda6 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx
@@ -2,8 +2,8 @@ import { useMemo, useRef, useState } from "react";
import { t } from "ttag";
import { Box, Group, Icon, Menu, NumberInput, TextInput } from "metabase/ui";
+import type { ChartSettingGoalInputProps } from "metabase/visualizations/types";
import { isNumeric } from "metabase-lib/v1/types/utils/isa";
-import type { DatasetColumn } from "metabase-types/api";
import S from "./ChartSettingFieldPicker/ChartSettingFieldPicker.module.css";
@@ -22,14 +22,6 @@ const inputStyles = {
},
};
-export type ChartSettingGoalInputProps = {
- id: string;
- value: number | string;
- onChange: (value: number | string) => void;
- columns?: DatasetColumn[];
- valueField?: string;
-};
-
export const ChartSettingGoalInput = ({
id,
value,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingInputNumeric.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingInputNumeric.tsx
index eb7b542e0fd..7b209d41b57 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingInputNumeric.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingInputNumeric.tsx
@@ -10,8 +10,7 @@ import {
import { useLatest } from "react-use";
import { TextInput } from "metabase/ui";
-
-import type { ChartSettingWidgetProps } from "./types";
+import type { ChartSettingWidgetProps } from "metabase/visualizations/types";
const ALLOWED_CHARS = new Set([
"0",
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx
index 66763ea960a..eb32589adba 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx
@@ -2,20 +2,12 @@ import { useCallback } from "react";
import { t } from "ttag";
import { Checkbox, Select, Stack, Text } from "metabase/ui";
-import type { VisualizationSettings } from "metabase-types/api";
+import type {
+ AggregationFunction,
+ ChartSettingMaxCategoriesProps,
+} from "metabase/visualizations/types";
import { ChartSettingInputNumeric } from "./ChartSettingInputNumeric";
-import type { ChartSettingWidgetProps } from "./types";
-
-type AggregationFunction = Exclude<
- VisualizationSettings["graph.other_category_aggregation_fn"],
- undefined
->;
-
-export type ChartSettingMaxCategoriesProps = ChartSettingWidgetProps<number> & {
- isEnabled?: boolean;
- aggregationFunction: AggregationFunction;
-};
export const ChartSettingMaxCategories = ({
isEnabled,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingNumberInput.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingNumberInput.tsx
index e1b0fabfac9..6ce1bc841a0 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingNumberInput.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingNumberInput.tsx
@@ -1,6 +1,5 @@
import { NumberInput } from "metabase/ui";
-
-import type { ChartSettingWidgetProps } from "./types";
+import type { ChartSettingWidgetProps } from "metabase/visualizations/types";
interface ChartSettingNumberInputProps extends Omit<
ChartSettingWidgetProps<number>,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingOrderedItems/ChartSettingOrderedItems.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingOrderedItems/ChartSettingOrderedItems.tsx
index 82f07845f25..0bf6dc5b86e 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingOrderedItems/ChartSettingOrderedItems.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingOrderedItems/ChartSettingOrderedItems.tsx
@@ -8,17 +8,10 @@ import { Sortable, SortableList } from "metabase/common/components/Sortable";
import { useDndSensors } from "metabase/common/hooks";
import type { IconProps } from "metabase/ui";
import type { AccentColorOptions } from "metabase/ui/colors/types";
+import type { ChartSettingOrderedItem } from "metabase/visualizations/types";
import { ColumnItem } from "../ColumnItem";
-export interface SortableItem {
- enabled: boolean;
- color?: string;
- icon?: IconProps["name"];
- isOther?: boolean;
- hideSettings?: boolean;
-}
-
interface SortableColumnFunctions<T> {
onRemove?: (item: T) => void;
onEdit?: (item: T, targetElement: HTMLElement) => void;
@@ -29,7 +22,7 @@ interface SortableColumnFunctions<T> {
onColorChange?: (item: T, color: string) => void;
}
interface ChartSettingOrderedItemsProps<
- T extends SortableItem,
+ T extends ChartSettingOrderedItem,
> extends SortableColumnFunctions<T> {
onSortEnd: ({ id, newIndex }: DragEndEvent) => void;
items: T[];
@@ -37,11 +30,11 @@ interface ChartSettingOrderedItemsProps<
isSortable?: boolean;
removeIcon?: IconProps["name"];
accentColorOptions?: AccentColorOptions;
- getItemColor?: (item: SortableItem) => string | undefined;
+ getItemColor?: (item: ChartSettingOrderedItem) => string | undefined;
dividers?: SortableDivider[];
}
-export function ChartSettingOrderedItems<T extends SortableItem>({
+export function ChartSettingOrderedItems<T extends ChartSettingOrderedItem>({
onRemove,
onSortEnd,
onEdit,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx
index 8066b7e2509..2c755cc5fa1 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx
@@ -7,18 +7,13 @@ import CS from "metabase/css/core/index.css";
import { Box, Button, Icon, NumberInput, Text } from "metabase/ui";
import { color } from "metabase/ui/colors";
import { getAccentColors } from "metabase/ui/colors/groups";
+import type { ChartSettingSegmentsEditorProps } from "metabase/visualizations/types";
import type { ScalarSegment } from "metabase-types/api";
import { ChartSettingInput } from "../ChartSettingInput";
import S from "./ChartSettingSegmentsEditor.module.css";
-export type ChartSettingSegmentsEditorProps = {
- value: ScalarSegment[];
- onChange: (value: ScalarSegment[]) => void;
- canRemoveAll?: boolean;
-};
-
export const ChartSettingSegmentsEditor = ({
value: segments,
onChange,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.unit.spec.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.unit.spec.tsx
index 5abd8be7b68..0fffb6d98a2 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.unit.spec.tsx
@@ -1,12 +1,10 @@
import userEvent from "@testing-library/user-event";
import { fireEvent, render, screen, within } from "__support__/ui";
+import type { ChartSettingSegmentsEditorProps } from "metabase/visualizations/types";
import type { ScalarSegment } from "metabase-types/api";
-import {
- ChartSettingSegmentsEditor,
- type ChartSettingSegmentsEditorProps,
-} from "./ChartSettingSegmentsEditor";
+import { ChartSettingSegmentsEditor } from "./ChartSettingSegmentsEditor";
const createMockSegment = (opts?: Partial<ScalarSegment>): ScalarSegment => {
return { label: "", min: 0, max: 100, color: "red", ...opts };
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx
index d2d1618d4e5..ad3bdfd8ba2 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx
@@ -9,51 +9,16 @@ import type { DragEndEvent } from "metabase/common/components/Sortable";
import { Box, Button, Flex, Group, Icon, Select, Text } from "metabase/ui";
import { color } from "metabase/ui/colors";
import { getAccentColors } from "metabase/ui/colors/groups";
-import type { AccentColorOptions } from "metabase/ui/colors/types";
import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";
import { getEventTarget } from "metabase/utils/dom";
import { isEmpty } from "metabase/utils/validate";
-import type { Series } from "metabase-types/api";
+import type {
+ ChartSettingSeriesOrderItem,
+ ChartSettingSeriesOrderProps,
+} from "metabase/visualizations/types";
import { ChartSettingMessage } from "./ChartSettingMessage";
-import {
- ChartSettingOrderedItems,
- type SortableItem as SortableChartSettingOrderedItem,
-} from "./ChartSettingOrderedItems";
-
-export { SortableChartSettingOrderedItem };
-
-export interface SortableItem {
- key: string;
- enabled: boolean;
- name: string;
- color?: string;
- hidden?: boolean;
- hideSettings?: boolean;
-}
-
-export type ChartSettingSeriesOrderProps = {
- onChange: (rows: SortableItem[]) => void;
- value: SortableItem[];
- onShowWidget: (
- widget: { id?: string; props?: { seriesKey: string } },
- ref: HTMLElement | undefined,
- ) => void;
- series: Series;
- hasEditSettings: boolean;
- onChangeSeriesColor: (seriesKey: string, color: string) => void;
- onSortEnd: (newItems: SortableItem[]) => void;
- isSortable?: boolean;
- accentColorOptions?: AccentColorOptions;
- getItemColor?: (item: SortableChartSettingOrderedItem) => string | undefined;
- addButtonLabel?: string;
- searchPickerPlaceholder?: string;
- groupedAfterIndex?: number;
- otherColor?: string;
- otherSettingWidgetId?: string;
- onOtherColorChange?: (newColor: string) => void;
- truncateAfter?: number;
-};
+import { ChartSettingOrderedItems } from "./ChartSettingOrderedItems";
export const ChartSettingSeriesOrder = ({
onChange,
@@ -109,7 +74,7 @@ export const ChartSettingSeriesOrder = ({
const canAddSeries = hiddenItems.length > 0;
const toggleDisplay = useCallback(
- (selectedItem: SortableItem) => {
+ (selectedItem: ChartSettingSeriesOrderItem) => {
const index = orderedItems.findIndex(
(item) => item.key === selectedItem.key,
);
@@ -133,12 +98,12 @@ export const ChartSettingSeriesOrder = ({
[orderedItems, onChange, onSortEnd],
);
- const getItemTitle = useCallback((item: SortableItem) => {
+ const getItemTitle = useCallback((item: ChartSettingSeriesOrderItem) => {
return isEmpty(item.name) ? NULL_DISPLAY_VALUE : item.name;
}, []);
const handleOnEdit = useCallback(
- (item: SortableItem, ref: HTMLElement | undefined) => {
+ (item: ChartSettingSeriesOrderItem, ref: HTMLElement | undefined) => {
onShowWidget(
{
props: {
@@ -152,7 +117,7 @@ export const ChartSettingSeriesOrder = ({
);
const handleColorChange = useCallback(
- (item: SortableItem, color: string) => {
+ (item: ChartSettingSeriesOrderItem, color: string) => {
onChangeSeriesColor(item.key, color);
},
[onChangeSeriesColor],
@@ -169,7 +134,10 @@ export const ChartSettingSeriesOrder = ({
[hiddenItems, toggleDisplay],
);
- const getId = useCallback((item: SortableItem) => item.key, []);
+ const getId = useCallback(
+ (item: ChartSettingSeriesOrderItem) => item.key,
+ [],
+ );
const handleOtherSeriesSettingsClick = useCallback(
(e: React.MouseEvent) => {
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
index efad12f32ea..36be5cbecdb 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
@@ -3,27 +3,12 @@ import { t } from "ttag";
import { FieldPanel } from "metabase/querying/fields/components/FieldPanel";
import { Button } from "metabase/ui";
+import type { ChartSettingTableColumnsProps } from "metabase/visualizations/types";
import type * as Lib from "metabase-lib";
-import type Question from "metabase-lib/v1/Question";
-import type {
- DatasetColumn,
- TableColumnOrderSetting,
-} from "metabase-types/api";
import { TableColumnPanel } from "./TableColumnPanel";
-import type { EditWidgetData } from "./types";
import { canEditQuery } from "./utils";
-export type ChartSettingTableColumnsProps = {
- value: TableColumnOrderSetting[];
- columns: DatasetColumn[];
- question?: Question;
- isShowingDetailsOnlyColumns: boolean;
- getColumnName: (column: DatasetColumn) => string;
- onChange: (value: TableColumnOrderSetting[], question?: Question) => void;
- onShowWidget: (config: EditWidgetData, targetElement: HTMLElement) => void;
-};
-
export const ChartSettingTableColumns = ({
value,
columns,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx
index 4527f522932..41386a3cfb7 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/TableColumnPanel.tsx
@@ -3,13 +3,13 @@ import { useCallback, useMemo } from "react";
import type { DragEndEvent } from "metabase/common/components/Sortable";
import { useTranslateContent } from "metabase/content-translation/hooks";
import { Box } from "metabase/ui";
+import type { EditWidgetData } from "metabase/visualizations/types";
import type {
DatasetColumn,
TableColumnOrderSetting,
} from "metabase-types/api";
import { ChartSettingOrderedItems } from "../../ChartSettingOrderedItems";
-import type { EditWidgetData } from "../types";
import type { ColumnItem } from "./types";
import {
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts
index aa8706e443f..ac7db486aa3 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/TableColumnPanel/utils.ts
@@ -1,5 +1,6 @@
import { getColumnIcon } from "metabase/common/utils/columns";
import type { ContentTranslationFunction } from "metabase/content-translation/types";
+import type { EditWidgetData } from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
import { findColumnIndexesForColumnSettings } from "metabase-lib/v1/queries/utils/dataset";
@@ -8,8 +9,6 @@ import type {
TableColumnOrderSetting,
} from "metabase-types/api";
-import type { EditWidgetData } from "../types";
-
import type { ColumnItem } from "./types";
export function getColumnItems(
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/types.ts b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/types.ts
deleted file mode 100644
index bf06ceb83c5..00000000000
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/types.ts
+++ /dev/null
@@ -1,8 +0,0 @@
-export type EditWidgetData = {
- id: string;
- props: EditWidgetProps;
-};
-
-export type EditWidgetProps = {
- initialKey: string;
-};
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleBackground.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleBackground.tsx
index fb11c6c45b4..c3e9bab4217 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleBackground.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleBackground.tsx
@@ -1,9 +1,10 @@
import type { CSSProperties } from "react";
-import { ColorRange } from "metabase/common/components/ColorRange";
import { Box } from "metabase/ui";
import type { ColumnFormattingSetting } from "metabase-types/api";
+import { ColorRange } from "../ColorRange";
+
export const RuleBackground = ({
rule,
className,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleEditor.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleEditor.tsx
index 8b350ad1ae0..cdca7241193 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleEditor.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingsTableFormatting/RuleEditor.tsx
@@ -3,7 +3,6 @@ import { useMemo } from "react";
import { msgid, ngettext, t } from "ttag";
import _ from "underscore";
-import { ColorRangeSelector } from "metabase/common/components/ColorRangeSelector";
import { ColorSelector } from "metabase/common/components/ColorSelector";
import CS from "metabase/css/core/index.css";
import {
@@ -30,6 +29,7 @@ import type {
import { ChartSettingInputNumeric } from "../ChartSettingInputNumeric";
import { ChartSettingRadio } from "../ChartSettingRadio";
import { ChartSettingToggle } from "../ChartSettingToggle";
+import { ColorRangeSelector } from "../ColorRangeSelector";
import { COLORS, COLOR_RANGES, DEFAULTS_BY_TYPE } from "./constants";
import { getOperatorsForColumns } from "./get-operators-for-columns";
diff --git a/frontend/src/metabase/common/components/ColorRange/ColorRange.stories.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRange/ColorRange.stories.tsx
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRange/ColorRange.stories.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRange/ColorRange.stories.tsx
diff --git a/frontend/src/metabase/common/components/ColorRange/ColorRange.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRange/ColorRange.tsx
similarity index 95%
rename from frontend/src/metabase/common/components/ColorRange/ColorRange.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRange/ColorRange.tsx
index 49e5dfda0e0..c52f96ad467 100644
--- a/frontend/src/metabase/common/components/ColorRange/ColorRange.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ColorRange/ColorRange.tsx
@@ -5,7 +5,8 @@ import _ from "underscore";
import CS from "metabase/css/core/index.css";
import { Box, Flex, type FlexProps } from "metabase/ui";
-import { getColorScale } from "metabase/visualizations/lib/color-scales";
+
+import { getColorScale } from "../../../lib/color-scales";
export interface ColorRangeProps extends Omit<FlexProps, "onSelect"> {
colors: string[];
diff --git a/frontend/src/metabase/common/components/ColorRange/index.ts b/frontend/src/metabase/visualizations/components/settings/ColorRange/index.ts
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRange/index.ts
rename to frontend/src/metabase/visualizations/components/settings/ColorRange/index.ts
diff --git a/frontend/src/metabase/common/components/ColorRangeSelector/ColorRangePopover.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangePopover.tsx
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRangeSelector/ColorRangePopover.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangePopover.tsx
diff --git a/frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeSelector.stories.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeSelector.stories.tsx
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeSelector.stories.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeSelector.stories.tsx
diff --git a/frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeSelector.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeSelector.tsx
similarity index 96%
rename from frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeSelector.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeSelector.tsx
index 00ba3f21732..631771e3fec 100644
--- a/frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeSelector.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeSelector.tsx
@@ -2,9 +2,10 @@ import { useDisclosure } from "@mantine/hooks";
import type { HTMLAttributes, Ref } from "react";
import { forwardRef } from "react";
-import { ColorRange } from "metabase/common/components/ColorRange";
import { Popover, type PopoverProps, rem } from "metabase/ui";
+import { ColorRange } from "../ColorRange";
+
import { ColorRangePopover } from "./ColorRangePopover";
export type ColorRangeSelectorAttributes = Omit<
diff --git a/frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeSelector.unit.spec.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeSelector.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeSelector.unit.spec.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeSelector.unit.spec.tsx
diff --git a/frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeToggle.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeToggle.tsx
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeToggle.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeToggle.tsx
diff --git a/frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeToggle.unit.spec.tsx b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeToggle.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRangeSelector/ColorRangeToggle.unit.spec.tsx
rename to frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/ColorRangeToggle.unit.spec.tsx
diff --git a/frontend/src/metabase/common/components/ColorRangeSelector/index.ts b/frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/index.ts
similarity index 100%
rename from frontend/src/metabase/common/components/ColorRangeSelector/index.ts
rename to frontend/src/metabase/visualizations/components/settings/ColorRangeSelector/index.ts
diff --git a/frontend/src/metabase/visualizations/components/settings/types.ts b/frontend/src/metabase/visualizations/components/settings/types.ts
deleted file mode 100644
index c74cda669fb..00000000000
--- a/frontend/src/metabase/visualizations/components/settings/types.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-import type { VisualizationSettings } from "metabase-types/api";
-
-export type ChartSettingWidgetProps<TValue> = {
- value: TValue | undefined;
- onChange: (value?: TValue | null) => void;
- onChangeSettings: (settings: Partial<VisualizationSettings>) => void;
-};
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.ts b/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.ts
index 8a98f9baf30..d58ac638349 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/layout/index.ts
@@ -650,7 +650,7 @@ const getTicksOverflow = (
return { firstTickOverflow, lastTickOverflow };
};
-export const getChartPadding = (
+export const getCartesianChartPadding = (
input: ChartLayoutInput,
settings: ComputedVisualizationSettings,
ticksDimensions: TicksDimensions,
@@ -913,7 +913,7 @@ export const getChartLayout = (
hasTimelineEvents,
renderingContext,
);
- const padding = getChartPadding(
+ const padding = getCartesianChartPadding(
input,
settings,
ticksDimensions,
@@ -998,7 +998,7 @@ const computeSplitPanelLayout = (
getXTickWidth: computedTicks.getXTickWidth,
};
- const padding = getChartPadding(
+ const padding = getCartesianChartPadding(
singleAxisInput,
settings,
ticksDimensions,
diff --git a/frontend/src/metabase/visualizations/echarts/graph/treemap/style.ts b/frontend/src/metabase/visualizations/echarts/graph/treemap/style.ts
index 02f14f04b90..65c07deb968 100644
--- a/frontend/src/metabase/visualizations/echarts/graph/treemap/style.ts
+++ b/frontend/src/metabase/visualizations/echarts/graph/treemap/style.ts
@@ -44,7 +44,7 @@ export function getGroupHeaderBgTint(
.string();
}
-export function getChartPadding(isDashboard: boolean) {
+export function getTreemapContainerPadding(isDashboard: boolean) {
const side = isDashboard ? "1rem" : "2rem";
return `0 ${side} ${side} ${side}`;
}
diff --git a/frontend/src/metabase/visualizations/index.ts b/frontend/src/metabase/visualizations/index.ts
index 8af60fe87f6..8d58a445456 100644
--- a/frontend/src/metabase/visualizations/index.ts
+++ b/frontend/src/metabase/visualizations/index.ts
@@ -2,13 +2,12 @@ export {
type RegisteredVisualization,
type VisualizationComponentLoader,
canSavePng,
- getDefaultSize,
+ getRegisteredDefaultSize,
getIconForVisualizationType,
getMaxDimensionsSupported,
getMaxMetricsSupported,
getSettingWidgetComponent,
getVisualization,
- getVisualizationComponent,
getVisualizationRaw,
getVisualizationTransformed,
isCartesianChart,
@@ -19,4 +18,5 @@ export {
setDefaultVisualization,
visualizations,
} from "./lib/registry";
+export { getVisualizationComponent } from "./visualization-component";
export { extractRemappedColumns, extractRemappings } from "./lib/remapping";
diff --git a/frontend/src/metabase/visualizations/lib/mapping.ts b/frontend/src/metabase/visualizations/lib/mapping.ts
index 8746b3cbc65..379e8aa1dbc 100644
--- a/frontend/src/metabase/visualizations/lib/mapping.ts
+++ b/frontend/src/metabase/visualizations/lib/mapping.ts
@@ -1,10 +1,6 @@
import * as d3 from "d3";
import type { Feature, Position } from "geojson";
-// getCanonicalRowKey lives in a Leaflet-free module so the static-viz bundle can use it; re-exported
-// here to keep existing import sites working.
-export { getCanonicalRowKey } from "./region-codes";
-
export type BoundsCoordinates = {
northEast: { lat: number; lng: number };
southWest: { lat: number; lng: number };
diff --git a/frontend/src/metabase/visualizations/lib/registry.ts b/frontend/src/metabase/visualizations/lib/registry.ts
index 0d9613d0109..eca004d6f8e 100644
--- a/frontend/src/metabase/visualizations/lib/registry.ts
+++ b/frontend/src/metabase/visualizations/lib/registry.ts
@@ -12,20 +12,24 @@ import type {
VisualizationDisplay,
} from "metabase-types/api";
-import type {
- Visualization,
- VisualizationComponent,
- VisualizationDefinition,
-} from "../types/visualization";
+import type { VisualizationDefinition } from "../types/definition";
+
+// A chart component carrying its definition as statics.
+// The props stay open because static-viz loads the registry without the React and redux types.
+export type RegisteredVisualizationComponent = ComponentType<any> &
+ VisualizationDefinition;
// The static-viz bundle registers bare definitions with no component; the app
// bundles register full components carrying their definition statics.
-export type RegisteredVisualization = Visualization | VisualizationDefinition;
+export type RegisteredVisualization =
+ | RegisteredVisualizationComponent
+ | VisualizationDefinition;
// A definition can be registered together with a loader for its component, so
// the chart itself stays out of the initial bundle. The loaded module carries
// its definition statics, the same as an eagerly registered visualization.
-export type VisualizationComponentLoader = () => Promise<Visualization>;
+export type VisualizationComponentLoader =
+ () => Promise<RegisteredVisualizationComponent>;
export const visualizations = new Map<
VisualizationDisplay,
@@ -37,7 +41,7 @@ const componentLoaders = new Map<
VisualizationDisplay,
VisualizationComponentLoader
>();
-const lazyComponents = new Map<VisualizationDisplay, VisualizationComponent>();
+const lazyComponents = new Map<VisualizationDisplay, ComponentType<any>>();
visualizations.get = function (key) {
return (
Map.prototype.get.call(this, key) ||
@@ -57,7 +61,7 @@ export function setDefaultVisualization(
// forwardRef and lazy return. A bare definition is a plain object.
function isVisualizationComponent(
visualization: RegisteredVisualization | undefined,
-): visualization is Visualization {
+): visualization is RegisteredVisualizationComponent {
return isValidElementType(visualization);
}
@@ -122,9 +126,9 @@ export function registerVisualization(
* definition was registered with a loader. Callers must render it inside a
* Suspense boundary.
*/
-export function getVisualizationComponent(
+export function getRegisteredComponent(
display: VisualizationDisplay | null,
-): VisualizationComponent | undefined {
+): ComponentType<any> | undefined {
const visualization = getVisualization(display);
if (visualization == null) {
@@ -272,7 +276,7 @@ export function canSavePng(display: VisualizationDisplay) {
return visualization?.canSavePng ?? true;
}
-export function getDefaultSize(display: VisualizationDisplay) {
+export function getRegisteredDefaultSize(display: VisualizationDisplay) {
const visualization = visualizations.get(display);
return visualization?.defaultSize;
}
diff --git a/frontend/src/metabase/visualizations/lib/registry.unit.spec.tsx b/frontend/src/metabase/visualizations/lib/registry.unit.spec.tsx
index 26948660145..648d50c1788 100644
--- a/frontend/src/metabase/visualizations/lib/registry.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/lib/registry.unit.spec.tsx
@@ -4,7 +4,7 @@ import React, { Component, Suspense } from "react";
import type { VisualizationDisplay } from "metabase-types/api";
import {
- getVisualizationComponent,
+ getRegisteredComponent,
loadVisualizationComponents,
registerVisualization,
} from "./registry";
@@ -48,7 +48,7 @@ describe("registerVisualization", () => {
registerVisualization(definition, () => Promise.resolve(Chart)),
).toThrow(/already registered/);
- expect(getVisualizationComponent(display)).toBeDefined();
+ expect(getRegisteredComponent(display)).toBeDefined();
});
});
@@ -64,7 +64,7 @@ describe("a chunk that fails to download", () => {
return Promise.reject(new Error("chunk load failed"));
});
- const failing = getVisualizationComponent(display);
+ const failing = getRegisteredComponent(display);
render(
<ChunkErrorBoundary>
<Suspense fallback={<div>loading</div>}>
@@ -84,7 +84,7 @@ describe("a chunk that fails to download", () => {
// A new object, so the next render downloads again rather than reusing a
// lazy React has permanently marked as rejected.
- const retried = getVisualizationComponent(display);
+ const retried = getRegisteredComponent(display);
expect(retried).toBeDefined();
expect(retried).not.toBe(failing);
});
@@ -100,6 +100,6 @@ describe("loadVisualizationComponents", () => {
registerVisualization(definition, () => Promise.resolve(Chart));
await loadVisualizationComponents();
- expect(getVisualizationComponent(display)).toBe(Chart);
+ expect(getRegisteredComponent(display)).toBe(Chart);
});
});
diff --git a/frontend/src/metabase/visualizations/lib/tooltip.ts b/frontend/src/metabase/visualizations/lib/tooltip.ts
index 8e23bf744d9..247ef576e56 100644
--- a/frontend/src/metabase/visualizations/lib/tooltip.ts
+++ b/frontend/src/metabase/visualizations/lib/tooltip.ts
@@ -4,7 +4,7 @@ import type { DatasetColumn, VisualizationSettings } from "metabase-types/api";
import { getFormattingOptionsWithoutScaling } from "../echarts/cartesian/model/util";
-export const formatValueForTooltip = ({
+export const formatValueForTooltipWithoutScaling = ({
value,
column,
settings,
diff --git a/frontend/src/metabase/visualizations/register.ts b/frontend/src/metabase/visualizations/register.ts
index 05d5473a1f6..92e3c090138 100644
--- a/frontend/src/metabase/visualizations/register.ts
+++ b/frontend/src/metabase/visualizations/register.ts
@@ -1,6 +1,6 @@
+import type { ComponentType } from "react";
import _ from "underscore";
-import { ColorRangeSelector } from "metabase/common/components/ColorRangeSelector";
import {
EMBEDDING_SDK_PORTAL_ROOT_ELEMENT_ID,
isEmbeddingSdk,
@@ -41,10 +41,15 @@ import { ChartSettingSeriesOrder } from "./components/settings/ChartSettingSerie
import { ChartSettingTableColumns } from "./components/settings/ChartSettingTableColumns";
import { ChartSettingToggle } from "./components/settings/ChartSettingToggle";
import { ChartSettingsTableFormatting } from "./components/settings/ChartSettingsTableFormatting";
+import { ColorRangeSelector } from "./components/settings/ColorRangeSelector";
import { setTooltipRootProvider } from "./echarts/tooltip";
import { registerJsxFormatting } from "./lib/register-jsx-formatting";
import { setComputedSettingsTransform } from "./lib/settings";
-import type { ComputedVisualizationSettings, SettingsExtra } from "./types";
+import type {
+ ChartSettingColorRangeProps,
+ ComputedVisualizationSettings,
+ SettingsExtra,
+} from "./types";
import { AREA_CHART_DEFINITION } from "./visualizations/AreaChart/definition";
import { BAR_CHART_DEFINITION } from "./visualizations/BarChart/definition";
import { BOXPLOT_CHART_DEFINITION } from "./visualizations/BoxPlot/definition";
@@ -200,7 +205,8 @@ function registerVisualizationSettingWidgets() {
fieldsPartition: ChartSettingFieldsPartition,
color: ChartSettingColorPicker,
colors: ChartSettingColorsPicker,
- colorRangeSelector: ColorRangeSelector,
+ colorRangeSelector:
+ ColorRangeSelector satisfies ComponentType<ChartSettingColorRangeProps>,
linkUrlInput: ChartSettingLinkUrlInput,
tableFormatting: ChartSettingsTableFormatting,
multiselect: ChartSettingMultiSelect,
diff --git a/frontend/src/metabase/visualizations/types/columns.ts b/frontend/src/metabase/visualizations/types/columns.ts
index d3bb6819fc9..4a900ba2bcc 100644
--- a/frontend/src/metabase/visualizations/types/columns.ts
+++ b/frontend/src/metabase/visualizations/types/columns.ts
@@ -1,4 +1,5 @@
-import type { DatasetColumn, DatasetData } from "metabase-types/api";
+import type * as Lib from "metabase-lib";
+import type { DatasetColumn, DatasetData, RowValues } from "metabase-types/api";
export type RemappingHydratedDatasetColumn = DatasetColumn & {
remapped_from_index?: number;
@@ -9,3 +10,11 @@ export type RemappingHydratedDatasetColumn = DatasetColumn & {
export type RemappingHydratedChartData = DatasetData & {
cols: RemappingHydratedDatasetColumn[];
};
+
+export type PivotedRowValues = RowValues & {
+ _dimension?: Lib.ClickObjectDimension; // present in pivoted data
+};
+
+export type PivotedDatasetColumn = DatasetColumn & {
+ _dimension?: Lib.ClickObjectDimension; // present in pivoted data
+};
diff --git a/frontend/src/metabase/visualizations/types/computed-settings.ts b/frontend/src/metabase/visualizations/types/computed-settings.ts
new file mode 100644
index 00000000000..ab811556fde
--- /dev/null
+++ b/frontend/src/metabase/visualizations/types/computed-settings.ts
@@ -0,0 +1,15 @@
+import type {
+ ColumnSettings,
+ SeriesSettings,
+ VisualizationSettings,
+} from "metabase-types/api";
+
+import type { LegacySeriesSettingsObjectKey } from "../echarts/cartesian/model/types";
+
+import type { RemappingHydratedDatasetColumn } from "./columns";
+
+export type ComputedVisualizationSettings = VisualizationSettings & {
+ column?: (col: RemappingHydratedDatasetColumn) => ColumnSettings;
+ series?: (key: LegacySeriesSettingsObjectKey) => SeriesSettings;
+ nested?: (value: unknown) => unknown;
+};
diff --git a/frontend/src/metabase/visualizations/types/definition.ts b/frontend/src/metabase/visualizations/types/definition.ts
new file mode 100644
index 00000000000..7d849be1245
--- /dev/null
+++ b/frontend/src/metabase/visualizations/types/definition.ts
@@ -0,0 +1,420 @@
+import type { CSSProperties, ComponentType } from "react";
+
+import type {
+ ColumnSettings,
+ DashboardId,
+ DatasetColumn,
+ DatasetData,
+ Field,
+ IconName,
+ RawSeries,
+ Series,
+ SingleSeries,
+ TransformedSeries,
+ VisualizationSettings,
+} from "metabase-types/api";
+import type { VisualizationDisplay } from "metabase-types/api/visualization";
+
+import type { ComputedVisualizationSettings } from "./computed-settings";
+import type {
+ ChartSettingColorRangeProps,
+ ChartSettingGoalInputProps,
+ ChartSettingMaxCategoriesProps,
+ ChartSettingSegmentedControlProps,
+ ChartSettingSegmentsEditorProps,
+ ChartSettingSeriesOrderProps,
+ ChartSettingTableColumnsProps,
+ DimensionsWidgetProps,
+ SmartScalarComparisonWidgetProps,
+ TreemapGroupsPickerProps,
+} from "./widget-props";
+
+export type ColumnSettingDefinition<TValue, TProps = unknown> = {
+ title?: string;
+ hint?: string;
+ widget?: string | ComponentType<any>;
+ props?: TProps;
+ inline?: boolean;
+ readDependencies?: string[];
+ getDefault?: (col: DatasetColumn, settings: ColumnSettings) => TValue;
+ getHidden?: (col: DatasetColumn, settings: ColumnSettings) => boolean;
+ isValid?: (col: DatasetColumn, settings: ColumnSettings) => boolean;
+ getProps?: (
+ col: DatasetColumn,
+ settings: ColumnSettings,
+ onChange: (value: TValue) => void,
+ extra: { series: Series },
+ ) => TProps;
+};
+
+export type SettingsExtra = {
+ dashboardId?: DashboardId;
+ enableEntityNavigation?: boolean;
+ forAdminSettings?: boolean;
+ isDashboard?: boolean;
+ series?: Series;
+ settings?: VisualizationSettings;
+ transformedSeries?: RawSeries | TransformedSeries;
+};
+
+export type VisualizationSettingDefinition<
+ T = unknown,
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = {
+ id?: string;
+ title?: string;
+ placeholder?: string;
+ group?: string;
+ index?: number;
+ showColumnSetting?: boolean;
+ widget?: string | ComponentType<TProps & { id: string }>;
+ isValid?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => boolean;
+ getHidden?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => boolean;
+ getDefault?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => TValue;
+ getValue?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => TValue;
+ getSection?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => string;
+ getWrapperStyle?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => CSSProperties | undefined;
+ autoOpenWhenUnset?: boolean;
+ set?: boolean;
+ persistDefault?: boolean;
+ inline?: boolean;
+ getProps?: (
+ object: T,
+ vizSettings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ onChange: (value: TValue) => void,
+ extra: SettingsExtra | undefined,
+ onChangeSettings: (value: Partial<VisualizationSettings>) => void,
+ ) => Partial<TProps>;
+ onChange?: (value: TValue) => void;
+ onChangeSettings?: (value: Partial<VisualizationSettings>) => void;
+ onUpdate?: (value: TValue, extra: SettingsExtra) => void;
+ readDependencies?: string[];
+ writeDependencies?: string[];
+ eraseDependencies?: string[];
+ // is the setting visible in the dashboard card viz settings
+ dashboard?: boolean;
+ useRawSeries?: boolean;
+};
+
+export type CompleteVisualizationSettingDefinition<
+ T = unknown,
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = Omit<
+ VisualizationSettingDefinition<T, TValue, TProps>,
+ "getProps" | "getWrapperStyle" | "getHidden" | "getSection"
+> & {
+ id: string;
+ style?: CSSProperties;
+ props: Partial<TProps>;
+ hidden: boolean;
+ section?: string;
+ value?: TValue;
+};
+
+export type DatasetColumnSettingDefinition<
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = VisualizationSettingDefinition<DatasetColumn, TValue, TProps>;
+
+/**
+ * current we work with DatasetColumn and Field, but their shapes are different
+ */
+export type FormattableColumn = Omit<DatasetColumn, "id" | "source"> & {
+ id?: DatasetColumn["id"] | Field["id"];
+ source?: DatasetColumn["source"];
+};
+
+export type SeriesSettingDefinition<
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = VisualizationSettingDefinition<Series, TValue, TProps>;
+
+export type SingleSeriesSettingDefinition<
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = VisualizationSettingDefinition<SingleSeries, TValue, TProps>;
+
+type Value = unknown;
+
+type Props = Record<string, unknown>;
+
+/** Object keys are kept in alphabetical order */
+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>;
+ click_behavior?: SeriesSettingDefinition<Value, Props>;
+ color?: SingleSeriesSettingDefinition<Value, Props>;
+ column?: DatasetColumnSettingDefinition<Value, Props>;
+ column_settings?: DatasetColumnSettingDefinition<Value, Props>;
+ column_title?: DatasetColumnSettingDefinition<Value, Props>;
+ currency?: DatasetColumnSettingDefinition<Value, Props>;
+ currency_in_header?: DatasetColumnSettingDefinition<Value, Props>;
+ currency_style?: DatasetColumnSettingDefinition<Value, Props>;
+ date_abbreviate?: DatasetColumnSettingDefinition<Value, Props>;
+ date_separator?: DatasetColumnSettingDefinition<Value, Props>;
+ date_style?: DatasetColumnSettingDefinition<Value, Props>;
+ decimals?: DatasetColumnSettingDefinition<Value, Props>;
+ display?: SingleSeriesSettingDefinition<Value, Props>;
+ "gauge.range"?: SeriesSettingDefinition<Value, Props>;
+ "gauge.segments"?: SeriesSettingDefinition<
+ Value,
+ ChartSettingSegmentsEditorProps
+ >;
+ "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" 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,
+ ChartSettingSegmentedControlProps
+ >;
+ "graph.label_value_formatting"?: SeriesSettingDefinition<Value, Props>;
+ "graph.max_categories"?: SeriesSettingDefinition<
+ Value,
+ ChartSettingMaxCategoriesProps
+ >;
+ "graph.max_categories_enabled"?: SeriesSettingDefinition<Value, Props>;
+ "graph.other_category_color"?: SeriesSettingDefinition<Value, Props>;
+ "graph.other_category_aggregation_fn"?: SeriesSettingDefinition<Value, Props>;
+ "graph.series_labels"?: SeriesSettingDefinition<Value, Props>;
+ "graph.series_order"?: SeriesSettingDefinition<
+ Value,
+ 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>;
+ "graph.show_values"?: SeriesSettingDefinition<Value, Props>;
+ "graph.split_panels"?: SeriesSettingDefinition<Value, Props>;
+ "graph.stack_value_format"?: SeriesSettingDefinition<
+ Value,
+ ChartSettingSegmentedControlProps
+ >;
+ "graph.tooltip_columns"?: SeriesSettingDefinition<Value, Props>;
+ "graph.tooltip_type"?: SeriesSettingDefinition<Value, Props>;
+ "graph.x_axis._is_histogram"?: SeriesSettingDefinition<Value, Props>;
+ "graph.x_axis._is_numeric"?: SeriesSettingDefinition<Value, Props>;
+ "graph.x_axis._is_timeseries"?: SeriesSettingDefinition<Value, Props>;
+ "graph.x_axis.axis_enabled"?: SeriesSettingDefinition<Value, Props>;
+ "graph.x_axis.labels_enabled"?: SeriesSettingDefinition<Value, Props>;
+ "graph.x_axis.title_text"?: SeriesSettingDefinition<Value, Props>;
+ "graph.x_axis.scale"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.auto_range"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.auto_split"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.labels_enabled"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.max"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.min"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.axis_enabled"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.scale"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.split_number"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.title_text"?: SeriesSettingDefinition<Value, Props>;
+ "graph.y_axis.unpin_from_zero"?: SeriesSettingDefinition<Value, Props>;
+ "legend.is_reversed"?: SeriesSettingDefinition<Value, Props>;
+ "line.interpolate"?: SingleSeriesSettingDefinition<Value, Props>;
+ "line.marker_enabled"?: SingleSeriesSettingDefinition<Value, Props>;
+ "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>;
+ "map.pin_type"?: SeriesSettingDefinition<Value, Props>;
+ "map.type"?: SeriesSettingDefinition<Value, Props>;
+ "map.region"?: SeriesSettingDefinition<Value, Props>;
+ "map.colors"?: SeriesSettingDefinition<Value, ChartSettingColorRangeProps>;
+ "map.heat.radius"?: SeriesSettingDefinition<Value, Props>;
+ "map.heat.blur"?: SeriesSettingDefinition<Value, Props>;
+ "map.heat.min-opacity"?: SeriesSettingDefinition<Value, Props>;
+ "map.heat.max-zoom"?: SeriesSettingDefinition<Value, Props>;
+ markdown_template?: DatasetColumnSettingDefinition<Value, Props>;
+ number_separators?: DatasetColumnSettingDefinition<Value, Props>;
+ number_style?: DatasetColumnSettingDefinition<Value, Props>;
+ "pie._dimensions_widget"?: SeriesSettingDefinition<
+ Value,
+ DimensionsWidgetProps
+ >;
+ "pie.decimal_places"?: SeriesSettingDefinition<Value, Props>;
+ "pie.dimension"?: SeriesSettingDefinition<Value, Props>;
+ "pie.metric"?: SeriesSettingDefinition<Value, Props>;
+ "pie.percent_visibility"?: SeriesSettingDefinition<Value, Props>;
+ "pie.rows"?: SeriesSettingDefinition<Value, Props>;
+ "pie.slice_threshold"?: SeriesSettingDefinition<Value, Props>;
+ "pie.show_labels"?: SeriesSettingDefinition<Value, Props>;
+ "pie.show_legend"?: SeriesSettingDefinition<Value, Props>;
+ "pie.show_total"?: SeriesSettingDefinition<Value, Props>;
+ "pie.sort_rows"?: SeriesSettingDefinition<Value, Props>;
+ "pie.sort_rows_dimension"?: SeriesSettingDefinition<Value, Props>;
+ prefix?: DatasetColumnSettingDefinition<Value, Props>;
+ "progress.color"?: SeriesSettingDefinition<Value, Props>;
+ "progress.goal"?: SeriesSettingDefinition<Value, ChartSettingGoalInputProps>;
+ "progress.value"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.edge_color"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.label_value_formatting"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.node_align"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.show_edge_color"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.show_edge_labels"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.source"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.target"?: SeriesSettingDefinition<Value, Props>;
+ "sankey.value"?: SeriesSettingDefinition<Value, Props>;
+ "scalar.compact_primary_number"?: SeriesSettingDefinition<Value, Props>;
+ "scalar.comparisons"?: SeriesSettingDefinition<
+ Value,
+ SmartScalarComparisonWidgetProps
+ >;
+ "scalar.field"?: SeriesSettingDefinition<Value, Props>;
+ "scalar.switch_positive_negative"?: SeriesSettingDefinition<Value, Props>;
+ scale?: DatasetColumnSettingDefinition<Value, Props>;
+ "scatter.bubble"?: SeriesSettingDefinition<Value, Props>;
+ show_series_trendline?: SingleSeriesSettingDefinition<Value, Props>;
+ show_series_values?: SingleSeriesSettingDefinition<Value, Props>;
+ "stackable.stack_type"?: SeriesSettingDefinition<Value, Props>;
+ suffix?: DatasetColumnSettingDefinition<Value, Props>;
+ "table.columns"?: SeriesSettingDefinition<
+ Value,
+ ChartSettingTableColumnsProps
+ >;
+ time_enabled?: DatasetColumnSettingDefinition<Value, Props>;
+ time_style?: DatasetColumnSettingDefinition<Value, Props>;
+ title?: SingleSeriesSettingDefinition<Value, Props>;
+ "treemap._groups_widget"?: SeriesSettingDefinition<
+ Value,
+ TreemapGroupsPickerProps
+ >;
+ "treemap.grouping"?: SeriesSettingDefinition<Value, Props>;
+ "treemap.rows"?: SeriesSettingDefinition<Value, Props>;
+ "treemap.show_leaf_labels"?: SeriesSettingDefinition<Value, Props>;
+ "treemap.show_leaf_values"?: SeriesSettingDefinition<Value, Props>;
+ "treemap.show_parent_labels"?: SeriesSettingDefinition<Value, Props>;
+ "treemap.show_parent_values"?: SeriesSettingDefinition<Value, Props>;
+ "treemap.sub_grouping"?: SeriesSettingDefinition<Value, Props>;
+ "treemap.value"?: SeriesSettingDefinition<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
+ * both VisualizationSettings and VisualizationSettingsDefinitions.
+ */
+ [key: string]: any;
+};
+
+export type Widget = {
+ id: string;
+ section?: string;
+ hidden?: boolean;
+ props?: Record<string, unknown>;
+ title?: string;
+ widget?: string | ComponentType<any>;
+};
+
+export type VisualizationGridSize = {
+ // grid columns
+ width: number;
+ // grid rows
+ height: number;
+};
+
+export type VisualizationDefinition = {
+ name?: string;
+ noun?: string;
+ getUiName: () => string;
+ identifier: VisualizationDisplay;
+ aliases?: string[];
+ iconName?: IconName;
+ iconUrl?: string;
+ hasEmptyState?: boolean;
+ isDev?: boolean; // is custom viz in dev mode
+
+ maxMetricsSupported?: number;
+ maxDimensionsSupported?: number;
+
+ disableClickBehavior?: boolean;
+ canSavePng?: boolean;
+ noHeader?: boolean;
+ hidden?: boolean;
+ disableSettingsConfig?: boolean;
+ supportPreviewing?: boolean;
+ supportsVisualizer?: boolean;
+ disableVisualizer?: boolean;
+
+ minSize?: VisualizationGridSize;
+ defaultSize?: VisualizationGridSize;
+
+ settings?: VisualizationSettingsDefinitions;
+
+ transformSeries?: (series: Series) => TransformedSeries;
+ isSensible?: (data: DatasetData) => boolean;
+ columnSettings?:
+ | VisualizationSettingsDefinitions
+ | ((column: FormattableColumn) => VisualizationSettingsDefinitions);
+ // checkRenderable throws an error if a visualization is not renderable
+ checkRenderable: (
+ series: Series,
+ settings: VisualizationSettings,
+ ) => void | never;
+ isLiveResizable?: (series: Series) => boolean;
+ onDisplayUpdate?: (settings: VisualizationSettings) => VisualizationSettings;
+};
diff --git a/frontend/src/metabase/visualizations/types/hover.ts b/frontend/src/metabase/visualizations/types/hover.ts
index 0dd5e4922cf..b8a2307064b 100644
--- a/frontend/src/metabase/visualizations/types/hover.ts
+++ b/frontend/src/metabase/visualizations/types/hover.ts
@@ -2,7 +2,7 @@ import type { ClickObjectDataRow } from "metabase-lib";
import type { CardId, RowValue } from "metabase-types/api";
import type { RemappingHydratedDatasetColumn } from "./columns";
-import type { ComputedVisualizationSettings } from "./visualization";
+import type { ComputedVisualizationSettings } from "./computed-settings";
export interface DataPoint extends ClickObjectDataRow {
key: string;
diff --git a/frontend/src/metabase/visualizations/types/index.ts b/frontend/src/metabase/visualizations/types/index.ts
index afb600c0ea2..25b61da5d5d 100644
--- a/frontend/src/metabase/visualizations/types/index.ts
+++ b/frontend/src/metabase/visualizations/types/index.ts
@@ -1,4 +1,8 @@
export * from "./click-actions";
export * from "./columns";
+export * from "./computed-settings";
+export * from "./definition";
export * from "./hover";
+export * from "./rendering";
export * from "./visualization";
+export * from "./widget-props";
diff --git a/frontend/src/metabase/visualizations/types/rendering.ts b/frontend/src/metabase/visualizations/types/rendering.ts
new file mode 100644
index 00000000000..65a631f0886
--- /dev/null
+++ b/frontend/src/metabase/visualizations/types/rendering.ts
@@ -0,0 +1,66 @@
+import type { ColorGetter } from "metabase/ui/colors/types";
+import type {
+ TextHeightMeasurer,
+ TextWidthMeasurer,
+} from "metabase/utils/measure-text";
+import type { ColumnSettings, RawSeries, RowValue } from "metabase-types/api";
+
+export interface Padding {
+ top: number;
+ left: number;
+ bottom: number;
+ right: number;
+}
+
+export type Formatter = (
+ value: RowValue,
+ options?: ColumnSettings,
+) => string | null;
+
+export type Extent = [number, number];
+
+export interface RenderingContext {
+ getColor: ColorGetter;
+ measureText: TextWidthMeasurer;
+ measureTextHeight: TextHeightMeasurer;
+ fontFamily: string;
+ /** Defaults to "light" when not provided. */
+ colorScheme?: "light" | "dark";
+
+ theme: VisualizationTheme;
+}
+
+/**
+ * Visualization theming overrides.
+ * Refer to DEFAULT_METABASE_COMPONENT_THEME for the default values.
+ **/
+export interface VisualizationTheme {
+ cartesian: {
+ label: {
+ fontSize: number;
+ };
+ goalLine: {
+ label: {
+ fontSize: number;
+ };
+ };
+ splitLine: {
+ lineStyle: {
+ color: string;
+ };
+ };
+ };
+ pie: {
+ borderColor: string;
+ };
+}
+
+export interface StaticVisualizationProps {
+ rawSeries: RawSeries;
+ renderingContext: RenderingContext;
+ isStorybook?: boolean;
+ hasDevWatermark?: boolean;
+ width?: number;
+ height?: number;
+ fitWithinBounds?: boolean;
+}
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index d781b8472dc..ac978b57d72 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -1,116 +1,43 @@
-import type { CSSProperties, ComponentType, ReactNode } from "react";
+import type { ComponentType, ReactNode } from "react";
-import type {
- ColorRangeSelectorAttributes,
- ColorRangeSelectorProps,
-} from "metabase/common/components/ColorRangeSelector/ColorRangeSelector";
import type { Dispatch, QueryBuilderMode } from "metabase/redux/store";
import type { IconProps } from "metabase/ui";
-import type { ColorGetter } from "metabase/ui/colors/types";
-import type {
- TextHeightMeasurer,
- TextWidthMeasurer,
-} from "metabase/utils/measure-text";
-import type {
- ClickActionModeGetter,
- ClickActionsMode,
- ClickObject,
- QueryClickActionsMode,
-} from "metabase/visualizations/types";
-import type * as Lib from "metabase-lib";
import type { BrushClickObject } from "metabase-lib/query/types";
import type Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
Card,
- ColumnSettings,
Dashboard,
DashboardCard,
- DashboardId,
DatasetColumn,
DatasetData,
- Field,
IconName,
RawSeries,
RowValue,
RowValues,
Series,
- SeriesSettings,
- SingleSeries,
TimelineEvent,
TimelineEventId,
- TransformedSeries,
VisualizationSettings,
} from "metabase-types/api";
-import type { VisualizationDisplay } from "metabase-types/api/visualization";
-import type { ChartSettingGoalInputProps } from "../components/settings/ChartSettingGoalInput";
-import type { ChartSettingMaxCategoriesProps } from "../components/settings/ChartSettingMaxCategories";
-import type { ChartSettingSegmentsEditorProps } from "../components/settings/ChartSettingSegmentsEditor";
-import type { ChartSettingSeriesOrderProps } from "../components/settings/ChartSettingSeriesOrder";
-import type { ChartSettingTableColumnsProps } from "../components/settings/ChartSettingTableColumns";
-import type { LegacySeriesSettingsObjectKey } from "../echarts/cartesian/model/types";
-import type { DimensionsWidgetProps } from "../visualizations/PieChart/DimensionsWidget";
-import type { SmartScalarComparisonWidgetProps } from "../visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets";
-import type { TreemapGroupsPickerProps } from "../visualizations/TreemapChart/TreemapGroupsPicker";
-
-import type { RemappingHydratedDatasetColumn } from "./columns";
+import type {
+ ClickActionModeGetter,
+ ClickActionsMode,
+ ClickObject,
+ QueryClickActionsMode,
+} from "./click-actions";
+import type { ComputedVisualizationSettings } from "./computed-settings";
+import type {
+ VisualizationDefinition,
+ VisualizationGridSize,
+} from "./definition";
import type { HighlightedObject, HoveredObject } from "./hover";
-import type { ChartSettingSegmentedControlProps } from "./widget-props";
-
-export interface Padding {
- top: number;
- left: number;
- bottom: number;
- right: number;
-}
-export type Formatter = (
- value: RowValue,
- options?: ColumnSettings,
-) => string | null;
export type TableCellFormatter = (value: RowValue) => ReactNode;
-export type Extent = [number, number];
-
export type CardSlownessStatus = "usually-fast" | "usually-slow" | boolean;
-export interface RenderingContext {
- getColor: ColorGetter;
- measureText: TextWidthMeasurer;
- measureTextHeight: TextHeightMeasurer;
- fontFamily: string;
- /** Defaults to "light" when not provided. */
- colorScheme?: "light" | "dark";
-
- theme: VisualizationTheme;
-}
-
-/**
- * Visualization theming overrides.
- * Refer to DEFAULT_METABASE_COMPONENT_THEME for the default values.
- **/
-export interface VisualizationTheme {
- cartesian: {
- label: {
- fontSize: number;
- };
- goalLine: {
- label: {
- fontSize: number;
- };
- };
- splitLine: {
- lineStyle: {
- color: string;
- };
- };
- };
- pie: {
- borderColor: string;
- };
-}
-
export type OnChangeCardAndRunOpts = {
previousCard?: Card;
nextCard: Card;
@@ -126,22 +53,6 @@ export type OnBrush = (options: {
openClickActions: (clicked: ClickObject | null) => void;
}) => void;
-export type ComputedVisualizationSettings = VisualizationSettings & {
- column?: (col: RemappingHydratedDatasetColumn) => ColumnSettings;
- series?: (key: LegacySeriesSettingsObjectKey) => SeriesSettings;
- nested?: (value: unknown) => unknown;
-};
-
-export interface StaticVisualizationProps {
- rawSeries: RawSeries;
- renderingContext: RenderingContext;
- isStorybook?: boolean;
- hasDevWatermark?: boolean;
- width?: number;
- height?: number;
- fitWithinBounds?: boolean;
-}
-
export interface VisualizationProps {
series: Series;
dashboard?: Dashboard;
@@ -305,410 +216,9 @@ export type AuditTableSorting = {
isAscending: boolean;
};
-export type ColumnSettingDefinition<TValue, TProps = unknown> = {
- title?: string;
- hint?: string;
- widget?: string | ComponentType<any>;
- props?: TProps;
- inline?: boolean;
- readDependencies?: string[];
- getDefault?: (col: DatasetColumn, settings: ColumnSettings) => TValue;
- getHidden?: (col: DatasetColumn, settings: ColumnSettings) => boolean;
- isValid?: (col: DatasetColumn, settings: ColumnSettings) => boolean;
- getProps?: (
- col: DatasetColumn,
- settings: ColumnSettings,
- onChange: (value: TValue) => void,
- extra: { series: Series },
- ) => TProps;
-};
-
-export type SettingsExtra = {
- dashboardId?: DashboardId;
- enableEntityNavigation?: boolean;
- forAdminSettings?: boolean;
- isDashboard?: boolean;
- series?: Series;
- settings?: VisualizationSettings;
- transformedSeries?: RawSeries | TransformedSeries;
-};
-
-export type VisualizationSettingDefinition<
- T = unknown,
- TValue = unknown,
- TProps extends Record<string, unknown> = Record<string, unknown>,
-> = {
- id?: string;
- title?: string;
- placeholder?: string;
- group?: string;
- index?: number;
- showColumnSetting?: boolean;
- widget?: string | ComponentType<TProps & { id: string }>;
- isValid?: (
- object: T,
- settings: T extends DatasetColumn
- ? ColumnSettings
- : ComputedVisualizationSettings,
- extra?: SettingsExtra,
- ) => boolean;
- getHidden?: (
- object: T,
- settings: T extends DatasetColumn
- ? ColumnSettings
- : ComputedVisualizationSettings,
- extra?: SettingsExtra,
- ) => boolean;
- getDefault?: (
- object: T,
- settings: T extends DatasetColumn
- ? ColumnSettings
- : ComputedVisualizationSettings,
- extra?: SettingsExtra,
- ) => TValue;
- getValue?: (
- object: T,
- settings: T extends DatasetColumn
- ? ColumnSettings
- : ComputedVisualizationSettings,
- extra?: SettingsExtra,
- ) => TValue;
- getSection?: (
- object: T,
- settings: T extends DatasetColumn
- ? ColumnSettings
- : ComputedVisualizationSettings,
- extra?: SettingsExtra,
- ) => string;
- getWrapperStyle?: (
- object: T,
- settings: T extends DatasetColumn
- ? ColumnSettings
- : ComputedVisualizationSettings,
- extra?: SettingsExtra,
- ) => CSSProperties | undefined;
- autoOpenWhenUnset?: boolean;
- set?: boolean;
- persistDefault?: boolean;
- inline?: boolean;
- getProps?: (
- object: T,
- vizSettings: T extends DatasetColumn
- ? ColumnSettings
- : ComputedVisualizationSettings,
- onChange: (value: TValue) => void,
- extra: SettingsExtra | undefined,
- onChangeSettings: (value: Partial<VisualizationSettings>) => void,
- ) => Partial<TProps>;
- onChange?: (value: TValue) => void;
- onChangeSettings?: (value: Partial<VisualizationSettings>) => void;
- onUpdate?: (value: TValue, extra: SettingsExtra) => void;
- readDependencies?: string[];
- writeDependencies?: string[];
- eraseDependencies?: string[];
- // is the setting visible in the dashboard card viz settings
- dashboard?: boolean;
- useRawSeries?: boolean;
-};
-
-export type CompleteVisualizationSettingDefinition<
- T = unknown,
- TValue = unknown,
- TProps extends Record<string, unknown> = Record<string, unknown>,
-> = Omit<
- VisualizationSettingDefinition<T, TValue, TProps>,
- "getProps" | "getWrapperStyle" | "getHidden" | "getSection"
-> & {
- id: string;
- style?: CSSProperties;
- props: Partial<TProps>;
- hidden: boolean;
- section?: string;
- value?: TValue;
-};
-
-export type DatasetColumnSettingDefinition<
- TValue = unknown,
- TProps extends Record<string, unknown> = Record<string, unknown>,
-> = VisualizationSettingDefinition<DatasetColumn, TValue, TProps>;
-
-/**
- * current we work with DatasetColumn and Field, but their shapes are different
- */
-export type FormattableColumn = Omit<DatasetColumn, "id" | "source"> & {
- id?: DatasetColumn["id"] | Field["id"];
- source?: DatasetColumn["source"];
-};
-
-export type SeriesSettingDefinition<
- TValue = unknown,
- TProps extends Record<string, unknown> = Record<string, unknown>,
-> = VisualizationSettingDefinition<Series, TValue, TProps>;
-
-export type SingleSeriesSettingDefinition<
- TValue = unknown,
- TProps extends Record<string, unknown> = Record<string, unknown>,
-> = VisualizationSettingDefinition<SingleSeries, TValue, TProps>;
-
-type Value = unknown;
-
-type Props = Record<string, unknown>;
-
-/** Object keys are kept in alphabetical order */
-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>;
- click_behavior?: SeriesSettingDefinition<Value, Props>;
- color?: SingleSeriesSettingDefinition<Value, Props>;
- column?: DatasetColumnSettingDefinition<Value, Props>;
- column_settings?: DatasetColumnSettingDefinition<Value, Props>;
- column_title?: DatasetColumnSettingDefinition<Value, Props>;
- currency?: DatasetColumnSettingDefinition<Value, Props>;
- currency_in_header?: DatasetColumnSettingDefinition<Value, Props>;
- currency_style?: DatasetColumnSettingDefinition<Value, Props>;
- date_abbreviate?: DatasetColumnSettingDefinition<Value, Props>;
- date_separator?: DatasetColumnSettingDefinition<Value, Props>;
- date_style?: DatasetColumnSettingDefinition<Value, Props>;
- decimals?: DatasetColumnSettingDefinition<Value, Props>;
- display?: SingleSeriesSettingDefinition<Value, Props>;
- "gauge.range"?: SeriesSettingDefinition<Value, Props>;
- "gauge.segments"?: SeriesSettingDefinition<
- Value,
- ChartSettingSegmentsEditorProps
- >;
- "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" 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,
- ChartSettingSegmentedControlProps
- >;
- "graph.label_value_formatting"?: SeriesSettingDefinition<Value, Props>;
- "graph.max_categories"?: SeriesSettingDefinition<
- Value,
- ChartSettingMaxCategoriesProps
- >;
- "graph.max_categories_enabled"?: SeriesSettingDefinition<Value, Props>;
- "graph.other_category_color"?: SeriesSettingDefinition<Value, Props>;
- "graph.other_category_aggregation_fn"?: SeriesSettingDefinition<Value, Props>;
- "graph.series_labels"?: SeriesSettingDefinition<Value, Props>;
- "graph.series_order"?: SeriesSettingDefinition<
- Value,
- 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>;
- "graph.show_values"?: SeriesSettingDefinition<Value, Props>;
- "graph.split_panels"?: SeriesSettingDefinition<Value, Props>;
- "graph.stack_value_format"?: SeriesSettingDefinition<
- Value,
- ChartSettingSegmentedControlProps
- >;
- "graph.tooltip_columns"?: SeriesSettingDefinition<Value, Props>;
- "graph.tooltip_type"?: SeriesSettingDefinition<Value, Props>;
- "graph.x_axis._is_histogram"?: SeriesSettingDefinition<Value, Props>;
- "graph.x_axis._is_numeric"?: SeriesSettingDefinition<Value, Props>;
- "graph.x_axis._is_timeseries"?: SeriesSettingDefinition<Value, Props>;
- "graph.x_axis.axis_enabled"?: SeriesSettingDefinition<Value, Props>;
- "graph.x_axis.labels_enabled"?: SeriesSettingDefinition<Value, Props>;
- "graph.x_axis.title_text"?: SeriesSettingDefinition<Value, Props>;
- "graph.x_axis.scale"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.auto_range"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.auto_split"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.labels_enabled"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.max"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.min"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.axis_enabled"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.scale"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.split_number"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.title_text"?: SeriesSettingDefinition<Value, Props>;
- "graph.y_axis.unpin_from_zero"?: SeriesSettingDefinition<Value, Props>;
- "legend.is_reversed"?: SeriesSettingDefinition<Value, Props>;
- "line.interpolate"?: SingleSeriesSettingDefinition<Value, Props>;
- "line.marker_enabled"?: SingleSeriesSettingDefinition<Value, Props>;
- "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>;
- "map.pin_type"?: SeriesSettingDefinition<Value, Props>;
- "map.type"?: SeriesSettingDefinition<Value, Props>;
- "map.region"?: SeriesSettingDefinition<Value, Props>;
- "map.colors"?: SeriesSettingDefinition<
- Value,
- Omit<ColorRangeSelectorProps, keyof ColorRangeSelectorAttributes>
- >;
- "map.heat.radius"?: SeriesSettingDefinition<Value, Props>;
- "map.heat.blur"?: SeriesSettingDefinition<Value, Props>;
- "map.heat.min-opacity"?: SeriesSettingDefinition<Value, Props>;
- "map.heat.max-zoom"?: SeriesSettingDefinition<Value, Props>;
- markdown_template?: DatasetColumnSettingDefinition<Value, Props>;
- number_separators?: DatasetColumnSettingDefinition<Value, Props>;
- number_style?: DatasetColumnSettingDefinition<Value, Props>;
- "pie._dimensions_widget"?: SeriesSettingDefinition<
- Value,
- DimensionsWidgetProps
- >;
- "pie.decimal_places"?: SeriesSettingDefinition<Value, Props>;
- "pie.dimension"?: SeriesSettingDefinition<Value, Props>;
- "pie.metric"?: SeriesSettingDefinition<Value, Props>;
- "pie.percent_visibility"?: SeriesSettingDefinition<Value, Props>;
- "pie.rows"?: SeriesSettingDefinition<Value, Props>;
- "pie.slice_threshold"?: SeriesSettingDefinition<Value, Props>;
- "pie.show_labels"?: SeriesSettingDefinition<Value, Props>;
- "pie.show_legend"?: SeriesSettingDefinition<Value, Props>;
- "pie.show_total"?: SeriesSettingDefinition<Value, Props>;
- "pie.sort_rows"?: SeriesSettingDefinition<Value, Props>;
- "pie.sort_rows_dimension"?: SeriesSettingDefinition<Value, Props>;
- prefix?: DatasetColumnSettingDefinition<Value, Props>;
- "progress.color"?: SeriesSettingDefinition<Value, Props>;
- "progress.goal"?: SeriesSettingDefinition<Value, ChartSettingGoalInputProps>;
- "progress.value"?: SeriesSettingDefinition<Value, Props>;
- "sankey.edge_color"?: SeriesSettingDefinition<Value, Props>;
- "sankey.label_value_formatting"?: SeriesSettingDefinition<Value, Props>;
- "sankey.node_align"?: SeriesSettingDefinition<Value, Props>;
- "sankey.show_edge_color"?: SeriesSettingDefinition<Value, Props>;
- "sankey.show_edge_labels"?: SeriesSettingDefinition<Value, Props>;
- "sankey.source"?: SeriesSettingDefinition<Value, Props>;
- "sankey.target"?: SeriesSettingDefinition<Value, Props>;
- "sankey.value"?: SeriesSettingDefinition<Value, Props>;
- "scalar.compact_primary_number"?: SeriesSettingDefinition<Value, Props>;
- "scalar.comparisons"?: SeriesSettingDefinition<
- Value,
- SmartScalarComparisonWidgetProps
- >;
- "scalar.field"?: SeriesSettingDefinition<Value, Props>;
- "scalar.switch_positive_negative"?: SeriesSettingDefinition<Value, Props>;
- scale?: DatasetColumnSettingDefinition<Value, Props>;
- "scatter.bubble"?: SeriesSettingDefinition<Value, Props>;
- show_series_trendline?: SingleSeriesSettingDefinition<Value, Props>;
- show_series_values?: SingleSeriesSettingDefinition<Value, Props>;
- "stackable.stack_type"?: SeriesSettingDefinition<Value, Props>;
- suffix?: DatasetColumnSettingDefinition<Value, Props>;
- "table.columns"?: SeriesSettingDefinition<
- Value,
- ChartSettingTableColumnsProps
- >;
- time_enabled?: DatasetColumnSettingDefinition<Value, Props>;
- time_style?: DatasetColumnSettingDefinition<Value, Props>;
- title?: SingleSeriesSettingDefinition<Value, Props>;
- "treemap._groups_widget"?: SeriesSettingDefinition<
- Value,
- TreemapGroupsPickerProps
- >;
- "treemap.grouping"?: SeriesSettingDefinition<Value, Props>;
- "treemap.rows"?: SeriesSettingDefinition<Value, Props>;
- "treemap.show_leaf_labels"?: SeriesSettingDefinition<Value, Props>;
- "treemap.show_leaf_values"?: SeriesSettingDefinition<Value, Props>;
- "treemap.show_parent_labels"?: SeriesSettingDefinition<Value, Props>;
- "treemap.show_parent_values"?: SeriesSettingDefinition<Value, Props>;
- "treemap.sub_grouping"?: SeriesSettingDefinition<Value, Props>;
- "treemap.value"?: SeriesSettingDefinition<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
- * both VisualizationSettings and VisualizationSettingsDefinitions.
- */
- [key: string]: any;
-};
-
-export type Widget = {
- id: string;
- section?: string;
- hidden?: boolean;
- props?: Record<string, unknown>;
- title?: string;
- widget?: string | ComponentType<any>;
-};
-
-export type VisualizationGridSize = {
- // grid columns
- width: number;
- // grid rows
- height: number;
-};
-
export type VisualizationComponent = ComponentType<
VisualizationProps & VisualizationPassThroughProps
>;
// TODO: add component property for the react component instead of the intersection
export type Visualization = VisualizationComponent & VisualizationDefinition;
-
-export type VisualizationDefinition = {
- name?: string;
- noun?: string;
- getUiName: () => string;
- identifier: VisualizationDisplay;
- aliases?: string[];
- iconName?: IconName;
- iconUrl?: string;
- hasEmptyState?: boolean;
- isDev?: boolean; // is custom viz in dev mode
-
- maxMetricsSupported?: number;
- maxDimensionsSupported?: number;
-
- disableClickBehavior?: boolean;
- canSavePng?: boolean;
- noHeader?: boolean;
- hidden?: boolean;
- disableSettingsConfig?: boolean;
- supportPreviewing?: boolean;
- supportsVisualizer?: boolean;
- disableVisualizer?: boolean;
-
- minSize?: VisualizationGridSize;
- defaultSize?: VisualizationGridSize;
-
- settings?: VisualizationSettingsDefinitions;
-
- transformSeries?: (series: Series) => TransformedSeries;
- isSensible?: (data: DatasetData) => boolean;
- columnSettings?:
- | VisualizationSettingsDefinitions
- | ((column: FormattableColumn) => VisualizationSettingsDefinitions);
- // checkRenderable throws an error if a visualization is not renderable
- checkRenderable: (
- series: Series,
- settings: VisualizationSettings,
- ) => void | never;
- isLiveResizable?: (series: Series) => boolean;
- onDisplayUpdate?: (settings: VisualizationSettings) => VisualizationSettings;
-};
-
-export type PivotedRowValues = RowValues & {
- _dimension?: Lib.ClickObjectDimension; // present in pivoted data
-};
-
-export type PivotedDatasetColumn = DatasetColumn & {
- _dimension?: Lib.ClickObjectDimension; // present in pivoted data
-};
diff --git a/frontend/src/metabase/visualizations/types/widget-props.ts b/frontend/src/metabase/visualizations/types/widget-props.ts
index 738902fb6a3..ecc5aa9524d 100644
--- a/frontend/src/metabase/visualizations/types/widget-props.ts
+++ b/frontend/src/metabase/visualizations/types/widget-props.ts
@@ -1,9 +1,29 @@
-import type { IconName } from "metabase-types/api";
+import type { AccentColorOptions } from "metabase/ui/colors/types";
+import type Question from "metabase-lib/v1/Question";
+import type {
+ DatasetColumn,
+ IconName,
+ RawSeries,
+ ScalarSegment,
+ Series,
+ SmartScalarComparison,
+ SmartScalarComparisonType,
+ TableColumnOrderSetting,
+ VisualizationSettings,
+} from "metabase-types/api";
+
+import type { ComputedVisualizationSettings } from "./computed-settings";
// Prop contracts for setting widgets that settings definitions reference by
// string name. They live here rather than with the widget components so the
// type dependency runs UI -> core.
+export type ChartSettingWidgetProps<TValue> = {
+ value: TValue | undefined;
+ onChange: (value?: TValue | null) => void;
+ onChangeSettings: (settings: Partial<VisualizationSettings>) => void;
+};
+
export type ChartSettingEnumToggleProps<T extends string> = {
value: T | undefined;
onChange: (value: T) => void;
@@ -17,3 +37,137 @@ export type ChartSettingSegmentedControlProps = {
onChange: (value: string) => void;
value: string;
};
+
+export type ChartSettingGoalInputProps = {
+ id: string;
+ value: number | string;
+ onChange: (value: number | string) => void;
+ columns?: DatasetColumn[];
+ valueField?: string;
+};
+
+export type AggregationFunction = Exclude<
+ VisualizationSettings["graph.other_category_aggregation_fn"],
+ undefined
+>;
+
+export type ChartSettingMaxCategoriesProps = ChartSettingWidgetProps<number> & {
+ isEnabled?: boolean;
+ aggregationFunction: AggregationFunction;
+};
+
+export type ChartSettingSegmentsEditorProps = {
+ value: ScalarSegment[];
+ onChange: (value: ScalarSegment[]) => void;
+ canRemoveAll?: boolean;
+};
+
+// The fields ChartSettingOrderedItems reads off every row it renders.
+export interface ChartSettingOrderedItem {
+ enabled: boolean;
+ color?: string;
+ icon?: IconName;
+ isOther?: boolean;
+ hideSettings?: boolean;
+}
+
+export interface ChartSettingSeriesOrderItem {
+ key: string;
+ enabled: boolean;
+ name: string;
+ color?: string;
+ hidden?: boolean;
+ hideSettings?: boolean;
+}
+
+export type ChartSettingSeriesOrderProps = {
+ onChange: (rows: ChartSettingSeriesOrderItem[]) => void;
+ value: ChartSettingSeriesOrderItem[];
+ onShowWidget: (
+ widget: { id?: string; props?: { seriesKey: string } },
+ ref: HTMLElement | undefined,
+ ) => void;
+ series: Series;
+ hasEditSettings: boolean;
+ onChangeSeriesColor: (seriesKey: string, color: string) => void;
+ onSortEnd: (newItems: ChartSettingSeriesOrderItem[]) => void;
+ isSortable?: boolean;
+ accentColorOptions?: AccentColorOptions;
+ getItemColor?: (item: ChartSettingOrderedItem) => string | undefined;
+ addButtonLabel?: string;
+ searchPickerPlaceholder?: string;
+ groupedAfterIndex?: number;
+ otherColor?: string;
+ otherSettingWidgetId?: string;
+ onOtherColorChange?: (newColor: string) => void;
+ truncateAfter?: number;
+};
+
+export type EditWidgetProps = {
+ initialKey: string;
+};
+
+export type EditWidgetData = {
+ id: string;
+ props: EditWidgetProps;
+};
+
+export type ChartSettingTableColumnsProps = {
+ value: TableColumnOrderSetting[];
+ columns: DatasetColumn[];
+ question?: Question;
+ isShowingDetailsOnlyColumns: boolean;
+ getColumnName: (column: DatasetColumn) => string;
+ onChange: (value: TableColumnOrderSetting[], question?: Question) => void;
+ onShowWidget: (config: EditWidgetData, targetElement: HTMLElement) => void;
+};
+
+// The props the map colour setting supplies to ColorRangeSelector.
+// The component takes div attributes on top of these, which a setting never passes.
+export type ChartSettingColorRangeProps = {
+ value: string[];
+ colors: string[];
+ colorRanges?: string[][];
+ colorMapping?: Record<string, string[]>;
+ isQuantile?: boolean;
+ onChange?: (newValue: string[]) => void;
+};
+
+export type DimensionsWidgetProps = {
+ rawSeries: RawSeries;
+ settings: ComputedVisualizationSettings;
+ onChangeSettings: (newSettings: ComputedVisualizationSettings) => void;
+ onShowWidget: (widget: any, ref: any) => void;
+};
+
+type ComparisonMenuOptionOf<TType extends SmartScalarComparisonType> = {
+ type: TType;
+ name: string;
+};
+
+export type ComparisonMenuOption =
+ | ComparisonMenuOptionOf<"anotherColumn">
+ | ComparisonMenuOptionOf<"previousValue">
+ | ComparisonMenuOptionOf<"previousPeriod">
+ | (ComparisonMenuOptionOf<"periodsAgo"> & { maxValue: number })
+ | ComparisonMenuOptionOf<"staticNumber">;
+
+export type SmartScalarComparisonWidgetProps = {
+ onChange: (setting: SmartScalarComparison[]) => void;
+ options: ComparisonMenuOption[];
+ comparableColumns: DatasetColumn[];
+ value: SmartScalarComparison[];
+ maxComparisons: number;
+ series: RawSeries;
+ settings: ComputedVisualizationSettings;
+};
+
+export type TreemapGroupsPickerProps = {
+ rawSeries: RawSeries;
+ settings: ComputedVisualizationSettings;
+ onChangeSettings: (newSettings: ComputedVisualizationSettings) => void;
+ onShowWidget: (
+ widget: { id?: string; props?: { seriesKey: string } },
+ ref: HTMLElement | undefined,
+ ) => void;
+};
diff --git a/frontend/src/metabase/visualizations/visualization-component.ts b/frontend/src/metabase/visualizations/visualization-component.ts
new file mode 100644
index 00000000000..e3e0a465e24
--- /dev/null
+++ b/frontend/src/metabase/visualizations/visualization-component.ts
@@ -0,0 +1,11 @@
+import { getRegisteredComponent } from "./lib/registry";
+import type { VisualizationComponent } from "./types/visualization";
+
+/** Callers must render the returned component inside a Suspense boundary. */
+export function getVisualizationComponent(
+ ...args: Parameters<typeof getRegisteredComponent>
+): VisualizationComponent | undefined {
+ // Every chart in the registry was registered as a Visualization,
+ // so its props are the ones this signature names.
+ return getRegisteredComponent(...args) as VisualizationComponent | undefined;
+}
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx
index 1a46f9ae495..8e244aacc0e 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx
@@ -22,9 +22,8 @@ import { Button, Text } from "metabase/ui";
import { ChartSettingFieldPicker } from "metabase/visualizations/components/settings/ChartSettingFieldPicker";
import { getOptionFromColumn } from "metabase/visualizations/lib/settings/utils";
import { getPieDimensions } from "metabase/visualizations/shared/settings/pie";
-import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
+import type { DimensionsWidgetProps } from "metabase/visualizations/types";
import { isDimension } from "metabase-lib/v1/types/utils/isa";
-import type { RawSeries } from "metabase-types/api";
import Styles from "./DimensionsWidget.module.css";
import { PieRowsPicker } from "./PieRowsPicker";
@@ -85,13 +84,6 @@ const THREE_RING_SETTING_TITLES = [
OUTER_RING_TITLE,
];
-export type DimensionsWidgetProps = {
- rawSeries: RawSeries;
- settings: ComputedVisualizationSettings;
- onChangeSettings: (newSettings: ComputedVisualizationSettings) => void;
- onShowWidget: (widget: any, ref: any) => void;
-};
-
export function DimensionsWidget({
rawSeries,
settings,
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/PieRowsPicker.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/PieRowsPicker.tsx
index 38b725c9733..5ed8860bf12 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/PieRowsPicker.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/PieRowsPicker.tsx
@@ -1,15 +1,15 @@
import { useMemo } from "react";
import { color } from "metabase/ui/colors";
-import {
- ChartSettingSeriesOrder,
- type SortableChartSettingOrderedItem,
-} from "metabase/visualizations/components/settings/ChartSettingSeriesOrder";
+import { ChartSettingSeriesOrder } from "metabase/visualizations/components/settings/ChartSettingSeriesOrder";
import {
createHexToAccentNumberMap,
getPickerColorAlias,
} from "metabase/visualizations/echarts/pie/util/colors";
-import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
+import type {
+ ChartSettingOrderedItem,
+ ComputedVisualizationSettings,
+} from "metabase/visualizations/types";
import type { PieRow, RawSeries } from "metabase-types/api";
export function PieRowsPicker({
@@ -36,7 +36,7 @@ export function PieRowsPicker({
const handleGetColorForPicker = ({
color: hexColor,
- }: SortableChartSettingOrderedItem) => {
+ }: ChartSettingOrderedItem) => {
if (!hasMultipleRings || hexColor == null) {
return hexColor;
}
@@ -57,7 +57,7 @@ export function PieRowsPicker({
}),
});
- const onSortEnd = (newPieRows: SortableChartSettingOrderedItem[]) =>
+ const onSortEnd = (newPieRows: ChartSettingOrderedItem[]) =>
onChangeSettings({
"pie.sort_rows": false,
// Unjustified type cast. FIXME
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/utils/events.ts b/frontend/src/metabase/visualizations/visualizations/RowChart/utils/events.ts
index 274167a1784..1f4a0f44066 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/utils/events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/utils/events.ts
@@ -10,7 +10,7 @@ import type {
} from "metabase/visualizations/lib/graph/columns";
import { getColumnDescriptors } from "metabase/visualizations/lib/graph/columns";
import { getStackOffset } from "metabase/visualizations/lib/settings/stacking";
-import { formatValueForTooltip } from "metabase/visualizations/lib/tooltip";
+import { formatValueForTooltipWithoutScaling } from "metabase/visualizations/lib/tooltip";
import type {
BarData,
Series,
@@ -244,7 +244,7 @@ export const getStackedTooltipRows = <TDatum>(
value,
formatter: (value: unknown) =>
String(
- formatValueForTooltip({
+ formatValueForTooltipWithoutScaling({
value,
settings,
column: series.seriesInfo?.metricColumn,
@@ -265,7 +265,7 @@ export const getTooltipModel = <TDatum>(
const dimensionValue = series.yAccessor(datum);
const headerTitle = String(
- formatValueForTooltip({
+ formatValueForTooltipWithoutScaling({
value: dimensionValue,
column: chartColumns.dimension.column,
settings,
@@ -287,7 +287,7 @@ export const getTooltipModel = <TDatum>(
const totalFormatter = (value: unknown) =>
String(
- formatValueForTooltip({
+ formatValueForTooltipWithoutScaling({
value,
settings,
column: hasBreakout
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/ComparisonPicker.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/ComparisonPicker.tsx
index 9fa052f7b6c..7abb3d4e13c 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/ComparisonPicker.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/ComparisonPicker.tsx
@@ -8,6 +8,7 @@ import { IconButtonWrapper } from "metabase/common/components/IconButtonWrapper"
import CS from "metabase/css/core/index.css";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { Menu, Stack, Text, rem } from "metabase/ui";
+import type { ComparisonMenuOption } from "metabase/visualizations/types";
import type {
DatasetColumn,
SmartScalarComparison,
@@ -15,7 +16,6 @@ import type {
} from "metabase-types/api";
import { COMPARISON_TYPES } from "../constants";
-import type { ComparisonMenuOption } from "../types";
import { AnotherColumnForm } from "./AnotherColumnForm";
import { MenuItemStyled } from "./MenuItem.styled";
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx
index 1bdeeb38440..c89831c9361 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx
@@ -15,14 +15,9 @@ import { t } from "ttag";
import { Sortable } from "metabase/common/components/Sortable";
import { Stack } from "metabase/ui";
-import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
-import type {
- DatasetColumn,
- RawSeries,
- SmartScalarComparison,
-} from "metabase-types/api";
+import type { SmartScalarComparisonWidgetProps } from "metabase/visualizations/types";
+import type { SmartScalarComparison } from "metabase-types/api";
-import type { ComparisonMenuOption } from "../types";
import { getDefaultComparison } from "../utils";
import { ComparisonPicker } from "./ComparisonPicker";
@@ -31,16 +26,6 @@ import {
ComparisonList,
} from "./SmartScalarSettingsWidgets.styled";
-export type SmartScalarComparisonWidgetProps = {
- onChange: (setting: SmartScalarComparison[]) => void;
- options: ComparisonMenuOption[];
- comparableColumns: DatasetColumn[];
- value: SmartScalarComparison[];
- maxComparisons: number;
- series: RawSeries;
- settings: ComputedVisualizationSettings;
-};
-
export function SmartScalarComparisonWidget({
value,
maxComparisons,
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/types.ts b/frontend/src/metabase/visualizations/visualizations/SmartScalar/types.ts
deleted file mode 100644
index bca73f51ccf..00000000000
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/types.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-import type { COMPARISON_TYPES } from "./constants";
-
-type AnotherColumnMenuOption = {
- type: typeof COMPARISON_TYPES.ANOTHER_COLUMN;
- name: string;
-};
-type PreviousValueMenuOption = {
- type: typeof COMPARISON_TYPES.PREVIOUS_VALUE;
- name: string;
-};
-type PreviousPeriodMenuOption = {
- type: typeof COMPARISON_TYPES.PREVIOUS_PERIOD;
- name: string;
-};
-type PeriodsAgoMenuOption = {
- type: typeof COMPARISON_TYPES.PERIODS_AGO;
- name: string;
- maxValue: number;
-};
-type StaticNumberMenuOption = {
- type: typeof COMPARISON_TYPES.STATIC_NUMBER;
- name: string;
-};
-export type ComparisonMenuOption =
- | AnotherColumnMenuOption
- | PreviousValueMenuOption
- | PreviousPeriodMenuOption
- | PeriodsAgoMenuOption
- | StaticNumberMenuOption;
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/utils.ts b/frontend/src/metabase/visualizations/visualizations/SmartScalar/utils.ts
index 147f2d80649..778996a535c 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/utils.ts
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/utils.ts
@@ -6,6 +6,7 @@ import { formatNumber } from "metabase/utils/formatting";
import { measureText } from "metabase/utils/measure-text";
import { uuid } from "metabase/utils/uuid";
import { isEmpty } from "metabase/utils/validate";
+import type { ComparisonMenuOption } from "metabase/visualizations/types";
import { isDate, isNumeric } from "metabase-lib/v1/types/utils/isa";
import type {
DateTimeAbsoluteUnit,
@@ -28,7 +29,6 @@ import {
SPACING,
VALUE_MIN_HEIGHT,
} from "./constants";
-import type { ComparisonMenuOption } from "./types";
export const isPeriodVisible = (height: number) =>
height > PERIOD_HIDE_HEIGHT_THRESHOLD;
diff --git a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
index 941a2e07466..0f26157b4db 100644
--- a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapChart.tsx
@@ -17,7 +17,7 @@ import { getTreemapInlineValueIds } from "metabase/visualizations/echarts/graph/
import { isOverview } from "metabase/visualizations/echarts/graph/treemap/model/tree";
import { getTreemapChartOption } from "metabase/visualizations/echarts/graph/treemap/option/option";
import {
- getChartPadding,
+ getTreemapContainerPadding,
groupHeader,
} from "metabase/visualizations/echarts/graph/treemap/style";
import {
@@ -274,7 +274,7 @@ const TreemapChartComponent = ({
)}
<Box
className={S.root}
- p={getChartPadding(isDashboard)}
+ p={getTreemapContainerPadding(isDashboard)}
w="100%"
style={{ flex: 1, minHeight: 0 }}
>
diff --git a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapGroupsPicker.tsx b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapGroupsPicker.tsx
index 6bb870646b0..b0eb90e4aee 100644
--- a/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapGroupsPicker.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/TreemapChart/TreemapGroupsPicker.tsx
@@ -2,18 +2,8 @@ import { t } from "ttag";
import { ChartSettingSeriesOrder } from "metabase/visualizations/components/settings/ChartSettingSeriesOrder";
import { getTreemapChartColumns } from "metabase/visualizations/echarts/graph/treemap/model/data";
-import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
-import type { RawSeries, TreemapRow } from "metabase-types/api";
-
-export type TreemapGroupsPickerProps = {
- rawSeries: RawSeries;
- settings: ComputedVisualizationSettings;
- onChangeSettings: (newSettings: ComputedVisualizationSettings) => void;
- onShowWidget: (
- widget: { id?: string; props?: { seriesKey: string } },
- ref: HTMLElement | undefined,
- ) => void;
-};
+import type { TreemapGroupsPickerProps } from "metabase/visualizations/types";
+import type { TreemapRow } from "metabase-types/api";
export function TreemapGroupsPicker({
rawSeries,