Skip to content

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

GDGT-1834 Visualization Typescript Conversions - lib/settings/ (#69893)

Kamil Mielnik7dc0929cc1e2
diff --git a/frontend/src/metabase-lib/v1/queries/utils/column-key.ts b/frontend/src/metabase-lib/v1/queries/utils/column-key.ts
index 1bdc1bc355a..5bc49d3d291 100644
--- a/frontend/src/metabase-lib/v1/queries/utils/column-key.ts
+++ b/frontend/src/metabase-lib/v1/queries/utils/column-key.ts
@@ -17,7 +17,7 @@ import type {
export type DatasetColumnReference = Pick<DatasetColumn, "name" | "field_ref">;
-export const getColumnKey = (column: DatasetColumnReference) => {
+export const getColumnKey = (column: DatasetColumnReference): string => {
return JSON.stringify(["name", column.name]);
};
@@ -70,7 +70,7 @@ export const getColumnNameFromKey = (key: string) => {
export const getColumnSettings = (
settings: VisualizationSettings | null | undefined,
column: DatasetColumnReference,
-) => {
+): ColumnSettings | undefined => {
return getObjectColumnSettings(settings?.column_settings, column);
};
@@ -87,7 +87,7 @@ export const getColumnSettings = (
export const getObjectColumnSettings = (
settings: Record<string, ColumnSettings> | null | undefined,
column: DatasetColumnReference,
-) => {
+): ColumnSettings | undefined => {
return (
settings?.[getLegacyColumnKey(column)] ??
settings?.[getLegacyColumnKey(column, { excludeBaseType: true })] ??
diff --git a/frontend/src/metabase-types/api/card.ts b/frontend/src/metabase-types/api/card.ts
index 62ed71163be..b52ecabe9e2 100644
--- a/frontend/src/metabase-types/api/card.ts
+++ b/frontend/src/metabase-types/api/card.ts
@@ -1,3 +1,4 @@
+import type { CurrencyStyle } from "metabase/lib/formatting";
import type {
EmbeddingParameters,
EmbeddingType,
@@ -6,6 +7,7 @@ import type { IconName } from "metabase/ui";
import type { PieRow } from "metabase/visualizations/echarts/pie/model/types";
import type { EntityToken, EntityUuid } from "metabase-types/api/entity";
+import type { ClickBehavior } from "./click-behavior";
import type { Collection, CollectionId, LastEditInfo } from "./collection";
import type {
DashCardId,
@@ -123,13 +125,14 @@ export type SeriesSettings = {
title?: string;
color?: string;
show_series_values?: boolean;
- display?: string;
+ display?: VisualizationDisplay;
axis?: string;
"line.size"?: LineSize;
"line.style"?: "solid" | "dashed" | "dotted";
"line.interpolate"?: string;
"line.marker_enabled"?: boolean;
"line.missing"?: string;
+ show_series_trendline?: boolean;
};
export type SeriesOrderSetting = {
@@ -240,6 +243,8 @@ export interface ColumnSettings {
column_title?: string;
number_separators?: string;
currency?: string;
+ currency_style?: CurrencyStyle;
+ click_behavior?: ClickBehavior;
// some options are untyped
[key: string]: any;
@@ -367,7 +372,10 @@ export type EmbedVisualizationSettings = {
iframe?: string;
};
-export type VisualizationSettingKey = keyof VisualizationSettings;
+export type VisualizationSettingKey = Exclude<
+ keyof VisualizationSettings,
+ number // TS infers number because of `[key: string]: any` in VisualizationSettings
+>;
export type CardId = number;
diff --git a/frontend/src/metabase-types/api/dataset.ts b/frontend/src/metabase-types/api/dataset.ts
index 9d670ab1c84..2ce50e2cb0b 100644
--- a/frontend/src/metabase-types/api/dataset.ts
+++ b/frontend/src/metabase-types/api/dataset.ts
@@ -6,7 +6,7 @@ import type {
VisualizerColumnValueSource,
} from "metabase-types/api";
-import type { Card } from "./card";
+import type { Card, ColumnSettings } from "./card";
import type { DatabaseId } from "./database";
import type {
Field,
@@ -80,7 +80,7 @@ export interface DatasetColumn {
remapped_to?: string;
effective_type?: string;
binning_info?: BinningMetadata | null;
- settings?: Record<string, any>;
+ settings?: ColumnSettings;
fingerprint?: FieldFingerprint | null;
// model with customized metadata
diff --git a/frontend/src/metabase-types/api/index.ts b/frontend/src/metabase-types/api/index.ts
index 1499fabc0fe..8b06966bcae 100644
--- a/frontend/src/metabase-types/api/index.ts
+++ b/frontend/src/metabase-types/api/index.ts
@@ -1,8 +1,8 @@
export * from "./actions";
export * from "./activity";
export * from "./admin";
-export * from "./ai-sql-fixer";
export * from "./ai-entity-analysis";
+export * from "./ai-sql-fixer";
export * from "./alert";
export * from "./autocomplete";
export * from "./automagic-dashboards";
@@ -18,11 +18,13 @@ export * from "./dashboard";
export * from "./database";
export * from "./dataset";
export * from "./dependencies";
+export * from "./document";
export * from "./email";
export * from "./entity-id";
export * from "./field";
export * from "./geojson";
export * from "./group";
+export * from "./insight";
export * from "./llm";
export * from "./logger";
export * from "./measure";
@@ -38,7 +40,6 @@ export * from "./performance";
export * from "./permissions";
export * from "./persist";
export * from "./query";
-export * from "./document";
export * from "./remote-sync";
export * from "./revision";
export * from "./schema";
diff --git a/frontend/src/metabase-types/api/mocks/index.ts b/frontend/src/metabase-types/api/mocks/index.ts
index e7053e4b29e..e9691cbfbc7 100644
--- a/frontend/src/metabase-types/api/mocks/index.ts
+++ b/frontend/src/metabase-types/api/mocks/index.ts
@@ -14,6 +14,7 @@ export * from "./document";
export * from "./field";
export * from "./geojson";
export * from "./group";
+export * from "./insight";
export * from "./logger";
export * from "./measure";
export * from "./metabot";
diff --git a/frontend/src/metabase-types/store/qb.ts b/frontend/src/metabase-types/store/qb.ts
index 8ef6e33bf90..4aa4c3c5797 100644
--- a/frontend/src/metabase-types/store/qb.ts
+++ b/frontend/src/metabase-types/store/qb.ts
@@ -1,6 +1,6 @@
import type { Deferred } from "metabase/lib/promise";
import type { QueryModalType } from "metabase/query_builder/constants";
-import type { Widget } from "metabase/visualizations/components/ChartSettings/types";
+import type { Widget } from "metabase/visualizations/types";
import type {
Card,
CollectionItemModel,
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
index fde3501a010..29eee451001 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
@@ -169,7 +169,7 @@ const DashCardLoadingView = ({
*
* @param series the series to sanitize
*/
-function sanitizeSeriesData(series: RawSeries | { card: Card }[]) {
+function sanitizeSeriesData(series: Series): Series {
return series.map((s) => {
if ("data" in s) {
// If the series already has data, we're good
@@ -177,6 +177,7 @@ function sanitizeSeriesData(series: RawSeries | { card: Card }[]) {
}
return {
+ // @ts-expect-error according to TS this branch is impossible
...s,
data: { cols: [], rows: [] },
};
diff --git a/frontend/src/metabase/detail-view/utils.ts b/frontend/src/metabase/detail-view/utils.ts
index 7ae91cd3c52..7d1aa1dea89 100644
--- a/frontend/src/metabase/detail-view/utils.ts
+++ b/frontend/src/metabase/detail-view/utils.ts
@@ -16,8 +16,17 @@ import {
isPK,
isTitle,
} from "metabase-lib/v1/types/utils/isa";
-import type { DatasetColumn, Field, RowValue, Table } from "metabase-types/api";
-import { createMockCard } from "metabase-types/api/mocks";
+import type {
+ DatasetColumn,
+ Field,
+ RowValue,
+ Series,
+ Table,
+} from "metabase-types/api";
+import {
+ createMockCard,
+ createMockDatasetData,
+} from "metabase-types/api/mocks";
export function renderValue(
tc: ContentTranslationFunction,
@@ -25,7 +34,12 @@ export function renderValue(
column: DatasetColumn,
optionsOverride?: OptionsType,
) {
- const mockSeries = [{ data: { cols: [column] }, card: createMockCard() }];
+ const mockSeries: Series = [
+ {
+ data: createMockDatasetData({ cols: [column] }),
+ card: createMockCard(),
+ },
+ ];
const settingDefs = getSettingDefinitionsForColumn(mockSeries, column);
const inheritedSettings = {
...getGlobalSettingsForColumn(),
@@ -148,7 +162,12 @@ export const getColumnTitle = (
column: DatasetColumn,
settings: OptionsType,
) => {
- const series = [{ data: { cols: [column] }, card: createMockCard() }];
+ const series: Series = [
+ {
+ data: createMockDatasetData({ cols: [column] }),
+ card: createMockCard(),
+ },
+ ];
return getTitleForColumn(column, series, {
...getComputedSettingsForSeries(series),
diff --git a/frontend/src/metabase/lib/colors/charts.ts b/frontend/src/metabase/lib/colors/charts.ts
index f83e9fbf538..71f5c4043a9 100644
--- a/frontend/src/metabase/lib/colors/charts.ts
+++ b/frontend/src/metabase/lib/colors/charts.ts
@@ -6,7 +6,7 @@ export const getColorsForValues = (
keys: string[],
existingMapping?: Record<string, string> | null,
palette?: ColorPalette,
- seriesVizSettingsDefaultKeys?: string[],
+ seriesVizSettingsDefaultKeys?: (string | undefined)[],
) => {
if (keys.length <= ACCENT_COUNT) {
return getHashBasedMapping(
@@ -92,7 +92,7 @@ const getHashBasedMapping = (
values: string[],
existingMapping: Record<string, string> | null | undefined,
getPreferredValue: (key: string) => string | undefined,
- seriesVizSettingsDefaultKeys?: string[],
+ seriesVizSettingsDefaultKeys?: (string | undefined)[],
) => {
const newMapping: Record<string, string> = {};
const sortedKeys = [...keys].sort();
diff --git a/frontend/src/metabase/lib/formatting/currency.ts b/frontend/src/metabase/lib/formatting/currency.ts
index 852ab35f8cc..41070db3368 100644
--- a/frontend/src/metabase/lib/formatting/currency.ts
+++ b/frontend/src/metabase/lib/formatting/currency.ts
@@ -1,8 +1,10 @@
import { t } from "ttag";
-import { currency } from "cljs/metabase.util.currency";
+import { currency as currencyCljs } from "cljs/metabase.util.currency";
-export interface CurrencyInfo {
+export const currency: [Currency["symbol"], Currency][] = currencyCljs;
+
+export type Currency = {
symbol: string;
name: string;
symbol_native: string;
@@ -10,7 +12,7 @@ export interface CurrencyInfo {
rounding: number;
code: string;
name_plural: string;
-}
+};
export interface CurrencyOption {
name: string;
@@ -30,7 +32,7 @@ export interface CompactCurrencyOptions {
}
const getCurrencyMapCache = (() => {
- let currencyMapCache: Record<string, CurrencyInfo>;
+ let currencyMapCache: Record<string, Currency>;
return () => {
if (!currencyMapCache) {
@@ -41,11 +43,21 @@ const getCurrencyMapCache = (() => {
};
})();
-export function getCurrencySymbol(currencyCode: string): string {
+export function getCurrencySymbol(currencyCode: string | undefined): string {
+ if (!currencyCode) {
+ return "$";
+ }
+
return getCurrencyMapCache()[currencyCode]?.symbol || currencyCode || "$";
}
-export function getCurrencyNarrowSymbol(currencyCode: string): string {
+export function getCurrencyNarrowSymbol(
+ currencyCode: string | undefined,
+): string {
+ if (!currencyCode) {
+ return "$";
+ }
+
return (
getCurrencyMapCache()[currencyCode]?.symbol_native || currencyCode || "$"
);
@@ -97,9 +109,13 @@ export function getCurrencyStyleOptions(
}
export function getCurrency(
- currency: string,
- currencyStyle: CurrencyStyle,
-): string {
+ currency: string | undefined,
+ currencyStyle: CurrencyStyle | undefined,
+): string | null {
+ if (!currency || !currencyStyle) {
+ return null;
+ }
+
try {
return (0)
.toLocaleString("en", {
@@ -115,7 +131,7 @@ export function getCurrency(
}
export function getCurrencyOptions(): CurrencyOption[] {
- return currency.map(([, currency]: [string, CurrencyInfo]) => ({
+ return currency.map(([, currency]) => ({
name: currency.name,
value: currency.code,
}));
diff --git a/frontend/src/metabase/lib/formatting/date.tsx b/frontend/src/metabase/lib/formatting/date.tsx
index 148c9b993bf..5d7bf752c17 100644
--- a/frontend/src/metabase/lib/formatting/date.tsx
+++ b/frontend/src/metabase/lib/formatting/date.tsx
@@ -720,12 +720,12 @@ const getMonthFormat = (options: OptionsType) =>
options.compact || options.date_abbreviate ? "MMM" : "MMMM";
export function getDateFormatFromStyle(
- style: string,
- unit: DatetimeUnit,
+ style: string | undefined,
+ unit: DatetimeUnit | undefined,
separator?: string,
includeWeekday?: boolean,
) {
- const replaceSeparators = (format: string) =>
+ const replaceSeparators = (format: string | undefined) =>
separator && format ? format.replace(/\//g, separator) : format;
if (!unit) {
@@ -734,7 +734,7 @@ export function getDateFormatFromStyle(
let format = null;
- if (DATE_STYLE_TO_FORMAT[style]) {
+ if (style && DATE_STYLE_TO_FORMAT[style]) {
if (DATE_STYLE_TO_FORMAT[style][unit]) {
format = replaceSeparators(DATE_STYLE_TO_FORMAT[style][unit]);
}
@@ -1246,7 +1246,7 @@ function replaceDateFormatNames(format: string, options: OptionsType) {
export function formatDateTimeWithFormats(
value: number | string | Date | Dayjs,
- dateFormat: string,
+ dateFormat: string | undefined,
timeFormat: string | null,
options: OptionsType,
) {
@@ -1370,7 +1370,7 @@ export function formatDateTimeWithUnit(
const EXAMPLE_DATE = dayjs("2018-01-31 17:24");
export function getDateStyleOptionsForUnit(
- unit: DatetimeUnit,
+ unit: DatetimeUnit | undefined,
abbreviate = false,
separator?: string,
) {
@@ -1403,12 +1403,12 @@ export function getDateStyleOptionsForUnit(
function dateStyleOption(
style: string,
- unit: DatetimeUnit,
+ unit: DatetimeUnit | undefined,
abbreviate = false,
separator?: string,
) {
let format = getDateFormatFromStyle(style, unit, separator);
- if (abbreviate) {
+ if (abbreviate && format) {
format = format.replace(/MMMM/, "MMM").replace(/dddd/, "ddd");
}
return {
diff --git a/frontend/src/metabase/lib/formatting/datetime-utils.ts b/frontend/src/metabase/lib/formatting/datetime-utils.ts
index c82d7dd64df..ab088a7f21e 100644
--- a/frontend/src/metabase/lib/formatting/datetime-utils.ts
+++ b/frontend/src/metabase/lib/formatting/datetime-utils.ts
@@ -12,10 +12,10 @@ type UNITS_WITH_DAY_TYPE = (typeof UNITS_WITH_DAY)[number];
const UNITS_WITH_HOUR_SET = new Set(UNITS_WITH_HOUR);
const UNITS_WITH_DAY_SET = new Set(UNITS_WITH_DAY);
-export const hasDay = (unit: DatetimeUnit) =>
+export const hasDay = (unit: DatetimeUnit | undefined) =>
unit == null || UNITS_WITH_DAY_SET.has(unit as UNITS_WITH_DAY_TYPE);
-export const hasHour = (unit: DatetimeUnit) =>
+export const hasHour = (unit: DatetimeUnit | undefined) =>
unit == null || UNITS_WITH_HOUR_SET.has(unit as UNITS_WITH_HOUR_TYPE);
export function getTimeFormatFromStyle(
diff --git a/frontend/src/metabase/lib/formatting/types.ts b/frontend/src/metabase/lib/formatting/types.ts
index a2ea4b698bc..f0585d175ce 100644
--- a/frontend/src/metabase/lib/formatting/types.ts
+++ b/frontend/src/metabase/lib/formatting/types.ts
@@ -1,6 +1,10 @@
+import type { CurrencyStyle } from "./currency";
+
+export type TimeEnabled = "minutes" | "milliseconds" | "seconds";
+
export interface TimeOnlyOptions {
local?: boolean;
- time_enabled?: "minutes" | "milliseconds" | "seconds" | null;
+ time_enabled?: TimeEnabled | null;
time_format?: string;
time_style?: string;
}
@@ -8,9 +12,12 @@ export interface TimeOnlyOptions {
export interface OptionsType extends TimeOnlyOptions {
click_behavior?: any;
clicked?: any;
+ collapseNewlines?: boolean;
column?: any;
column_title?: string;
compact?: boolean;
+ currency?: string;
+ currency_style?: CurrencyStyle;
date_abbreviate?: boolean;
date_format?: string;
date_separator?: string;
@@ -33,11 +40,10 @@ export interface OptionsType extends TimeOnlyOptions {
removeYear?: boolean;
rich?: boolean;
scale?: number;
- stringifyNull?: boolean;
show_mini_bar?: boolean;
+ stringifyNull?: boolean;
suffix?: string;
type?: string;
view_as?: string | null;
weekday_enabled?: boolean;
- collapseNewlines?: boolean;
}
diff --git a/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx b/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx
index 3419d20396a..18fc2437516 100644
--- a/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx
+++ b/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx
@@ -1,7 +1,7 @@
import type { FocusEvent } from "react";
import { t } from "ttag";
-import { currency } from "cljs/metabase.util.currency";
+import { currency } from "metabase/lib/formatting";
import {
Combobox,
Flex,
@@ -89,16 +89,8 @@ export const CurrencyPicker = ({
);
};
-type Currency = {
- name: string;
- code: string;
- symbol: string;
-};
-
function getData() {
- const currencyData = currency as [Currency["symbol"], Currency][];
-
- return currencyData.map(([, currency]) => ({
+ return currency.map(([, currency]) => ({
label: currency.name,
value: currency.code,
symbol: currency.symbol,
diff --git a/frontend/src/metabase/static-viz/lib/numbers.ts b/frontend/src/metabase/static-viz/lib/numbers.ts
index fd5a12f18ff..5ca80ba6c39 100644
--- a/frontend/src/metabase/static-viz/lib/numbers.ts
+++ b/frontend/src/metabase/static-viz/lib/numbers.ts
@@ -1,9 +1,12 @@
+import type { CurrencyStyle } from "metabase/lib/formatting";
import { formatNumber as appFormatNumber } from "metabase/lib/formatting/numbers";
+export type NumberStyle = "currency" | "decimal" | "scientific" | "percentage";
+
export type NumberFormatOptions = {
- number_style?: "currency" | "decimal" | "scientific" | "percentage";
+ number_style?: NumberStyle;
currency?: string;
- currency_style?: "symbol" | "code" | "name";
+ currency_style?: CurrencyStyle;
number_separators?: ".,";
decimals?: number;
scale?: number;
@@ -13,7 +16,7 @@ export type NumberFormatOptions = {
};
const DEFAULT_OPTIONS = {
- number_style: "decimal" as NumberFormatOptions["number_style"],
+ number_style: "decimal" as const,
currency: undefined,
currency_style: "symbol",
number_separators: ".,",
diff --git a/frontend/src/metabase/visualizations/click-actions/actions/ColumnFormattingAction/ColumnFormattingAction.tsx b/frontend/src/metabase/visualizations/click-actions/actions/ColumnFormattingAction/ColumnFormattingAction.tsx
index 19405586981..ead0150dc5c 100644
--- a/frontend/src/metabase/visualizations/click-actions/actions/ColumnFormattingAction/ColumnFormattingAction.tsx
+++ b/frontend/src/metabase/visualizations/click-actions/actions/ColumnFormattingAction/ColumnFormattingAction.tsx
@@ -1,3 +1,4 @@
+import { Fragment } from "react";
import { t } from "ttag";
import ChartSettingsWidget from "metabase/visualizations/components/ChartSettingsWidget";
@@ -54,19 +55,24 @@ export const ColumnFormattingAction: LegacyDrill = ({ question, clicked }) => {
(widget) => widget.id === "column_settings",
);
- const extraProps = {
+ const { id, ...extraProps } = {
...columnSettingsWidget,
props: {
- ...columnSettingsWidget.props,
+ ...columnSettingsWidget?.props,
initialKey: getColumnKey(column),
},
};
+ if (!columnSettingsWidget || id == null) {
+ return <Fragment />;
+ }
+
return (
<PopoverRoot>
<ChartSettingsWidget
{...extraProps}
- key={columnSettingsWidget.id}
+ id={id}
+ key={columnSettingsWidget?.id}
hidden={false}
dataTestId={POPOVER_TEST_ID}
/>
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.tsx b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.tsx
index 1450cb83c39..d952356e614 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.tsx
@@ -12,12 +12,13 @@ import {
} from "metabase/visualizations/lib/settings";
import { getSettingDefinitionsForColumn } from "metabase/visualizations/lib/settings/column";
import { keyForSingleSeries } from "metabase/visualizations/lib/settings/series";
+import { SERIES_SETTING_KEY } from "metabase/visualizations/shared/settings/series";
+import type { Widget } from "metabase/visualizations/types";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
import type { DatasetColumn } from "metabase-types/api";
import ChartSettingsWidgetList from "../../ChartSettingsWidgetList";
import { ChartSettingsWidgetPopover } from "../../ChartSettingsWidgetPopover";
-import type { Widget } from "../types";
import {
ChartSettingsListContainer,
@@ -78,10 +79,10 @@ export const BaseChartSettings = ({
[chartSettings, series],
);
- const styleWidget = useMemo(() => {
+ const styleWidget = useMemo<Widget | null>(() => {
const seriesSettingsWidget =
currentWidget &&
- widgets.find((widget) => widget.id === "series_settings");
+ widgets.find((widget) => widget.id === SERIES_SETTING_KEY);
const display = transformedSeries?.[0]?.card?.display;
// In the pie the chart, clicking on the "measure" settings menu will only
@@ -136,7 +137,7 @@ export const BaseChartSettings = ({
return null;
}, [computedSettings, currentWidget, transformedSeries, widgets]);
- const formattingWidget = useMemo(() => {
+ const formattingWidget = useMemo<Widget | null>(() => {
const widget =
currentWidget && widgets.find((widget) => widget.id === currentWidget.id);
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.unit.spec.tsx
index e2324736b54..ce5bcdaf86d 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/BaseChartSettings.unit.spec.tsx
@@ -1,9 +1,8 @@
import { fireEvent, renderWithProviders, screen } from "__support__/ui";
import registerVisualizations from "metabase/visualizations/register";
+import type { Widget } from "metabase/visualizations/types";
import { createMockCard, createMockDataset } from "metabase-types/api/mocks";
-import type { Widget } from "../types";
-
import { BaseChartSettings } from "./BaseChartSettings";
import type { BaseChartSettingsProps } from "./types";
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/hooks.ts b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/hooks.ts
index 307deca70a5..cdafebfbce6 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/hooks.ts
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/hooks.ts
@@ -2,7 +2,7 @@ import { useMemo, useState } from "react";
import { t } from "ttag";
import _ from "underscore";
-import type { Widget } from "../types";
+import type { Widget } from "metabase/visualizations/types";
import type { BaseChartSettingsProps } from "./types";
@@ -22,8 +22,9 @@ export const useChartSettingsSections = ({
const sectionObj: Record<string, Widget[]> = {};
for (const widget of widgets) {
if (widget.widget && !widget.hidden) {
- sectionObj[widget.section] = sectionObj[widget.section] || [];
- sectionObj[widget.section].push(widget);
+ const section = String(widget.section);
+ sectionObj[section] = sectionObj[section] || [];
+ sectionObj[section].push(widget);
}
}
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/types.ts b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/types.ts
index f00bac43ec2..549205906af 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/types.ts
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/BaseChartSettings/types.ts
@@ -1,10 +1,13 @@
import type { StackProps } from "metabase/ui";
-import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
+import type {
+ ComputedVisualizationSettings,
+ Widget,
+} from "metabase/visualizations/types";
import type Question from "metabase-lib/v1/Question";
import type { QueryBuilderUIControls } from "metabase-types/store";
import type { UseChartSettingsStateReturned } from "../hooks";
-import type { CommonChartSettingsProps, Widget } from "../types";
+import type { CommonChartSettingsProps } from "../types";
export type BaseChartSettingsProps = {
initial?: QueryBuilderUIControls["initialChartSetting"];
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/types.ts b/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/types.ts
index 5eaa90fca1b..1165dfaf537 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/types.ts
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/DashboardChartSettings/types.ts
@@ -1,6 +1,7 @@
+import type { Widget } from "metabase/visualizations/types";
import type { Dashboard, DashboardCard } from "metabase-types/api";
-import type { CommonChartSettingsProps, Widget } from "../types";
+import type { CommonChartSettingsProps } from "../types";
export type DashboardChartSettingsProps = {
className?: string;
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/QuestionChartSettings/types.ts b/frontend/src/metabase/visualizations/components/ChartSettings/QuestionChartSettings/types.ts
index 5c7129349ee..02b40677311 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/QuestionChartSettings/types.ts
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/QuestionChartSettings/types.ts
@@ -1,5 +1,7 @@
+import type { Widget } from "metabase/visualizations/types";
+
import type { BaseChartSettingsProps } from "../BaseChartSettings/types";
-import type { CommonChartSettingsProps, Widget } from "../types";
+import type { CommonChartSettingsProps } from "../types";
export type QuestionChartSettingsProps = {
widgets?: Widget[];
diff --git a/frontend/src/metabase/visualizations/components/ChartSettings/types.ts b/frontend/src/metabase/visualizations/components/ChartSettings/types.ts
index d4f4c0379e9..a682fde4df7 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettings/types.ts
+++ b/frontend/src/metabase/visualizations/components/ChartSettings/types.ts
@@ -1,16 +1,6 @@
import type Question from "metabase-lib/v1/Question";
import type { Series, VisualizationSettings } from "metabase-types/api";
-// this type is not full, we need to extend it later
-export type Widget = {
- id: string;
- section: string;
- hidden?: boolean;
- props: Record<string, unknown>;
- title?: string;
- widget?: string | React.ComponentType<any>;
-};
-
export type CommonChartSettingsProps = {
series: Series;
settings?: VisualizationSettings;
diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx
index a16fb2744fc..64aa693c08c 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx
@@ -1,5 +1,5 @@
import cx from "classnames";
-import type * as React from "react";
+import type { ComponentType } from "react";
import PopoverS from "metabase/common/components/Popover/Popover.module.css";
import FormS from "metabase/css/components/form.module.css";
@@ -13,7 +13,7 @@ type Props = {
hint?: string;
hidden?: boolean;
disabled?: boolean;
- widget?: React.ComponentType<{ id: string }>;
+ widget?: string | ComponentType<{ id: string }>;
inline?: boolean;
marginBottom?: string;
props?: Record<string, unknown>;
diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx
index d9f226f44df..4957c15a552 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.tsx
@@ -5,13 +5,9 @@ import { TippyPopover } from "metabase/common/components/Popover/TippyPopover";
import CS from "metabase/css/core/index.css";
import { Box, Space, Tabs } from "metabase/ui";
-import ChartSettingsWidget from "./ChartSettingsWidget";
+import type { Widget } from "../types";
-interface Widget {
- id: string;
- section: string;
- props: Record<string, unknown>;
-}
+import ChartSettingsWidget from "./ChartSettingsWidget";
interface ChartSettingsWidgetPopoverProps {
anchor: HTMLElement;
@@ -24,14 +20,14 @@ export const ChartSettingsWidgetPopover = ({
handleEndShowWidget,
widgets,
}: ChartSettingsWidgetPopoverProps) => {
- const sections = useRef<string[]>([]);
+ const sections = useRef<(string | undefined)[]>([]);
const contentRef = useRef<HTMLDivElement>(null);
useEffect(() => {
sections.current = _.chain(widgets).pluck("section").unique().value();
}, [widgets]);
- const [currentSection, setCurrentSection] = useState("");
+ const [currentSection, setCurrentSection] = useState<string | undefined>("");
useEffect(() => {
setCurrentSection(sections.current[0]);
@@ -68,7 +64,11 @@ export const ChartSettingsWidgetPopover = ({
>
<Tabs.List grow>
{sections.current.map((sectionName) => (
- <Tabs.Tab key={sectionName} value={sectionName} p="md">
+ <Tabs.Tab
+ key={sectionName}
+ value={String(sectionName)}
+ p="md"
+ >
{sectionName}
</Tabs.Tab>
))}
diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx
index 63bd722b516..e7dd7ccadc5 100644
--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidgetPopover.unit.spec.tsx
@@ -2,9 +2,10 @@ import userEvent from "@testing-library/user-event";
import { type ComponentProps, useState } from "react";
import { renderWithProviders, screen } from "__support__/ui";
-import type { Widget } from "metabase/visualizations/components/ChartSettings/types";
import { ChartSettingsWidgetPopover } from "metabase/visualizations/components/ChartSettingsWidgetPopover";
+import type { Widget } from "../types";
+
type PopoverProps = ComponentProps<typeof ChartSettingsWidgetPopover>;
const DEFAULT_PROPS: Pick<PopoverProps, "handleEndShowWidget"> = {
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx
index 1e15d7d001a..b9c5105fe92 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx
@@ -2,10 +2,10 @@ import { ChartNestedSettingSeriesMultiple } from "./ChartNestedSettingSeriesMult
import type { ChartNestedSettingsSeriesSingleProps } from "./ChartNestedSettingSeriesSingle";
import ChartNestedSettingSeriesSingle from "./ChartNestedSettingSeriesSingle";
-interface ChartNestedSettingSeriesProps
- extends ChartNestedSettingsSeriesSingleProps {
- isDashboard: boolean;
-}
+export type ChartNestedSettingSeriesProps =
+ ChartNestedSettingsSeriesSingleProps & {
+ isDashboard: boolean;
+ };
const ChartNestedSettingSeries = ({
isDashboard,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx
index 4d4a6c99012..f531469382e 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingEnumToggle.tsx
@@ -1,18 +1,20 @@
import { Switch } from "metabase/ui";
+export type ChartSettingEnumToggleProps<T extends string> = {
+ value: T | undefined;
+ onChange: (value: T) => void;
+ id?: string;
+ checkedValue: T;
+ uncheckedValue: T;
+};
+
export const ChartSettingEnumToggle = <T extends string>({
value,
onChange,
id,
checkedValue,
uncheckedValue,
-}: {
- value: T | undefined;
- onChange: (value: T) => void;
- id?: string;
- checkedValue: T;
- uncheckedValue: T;
-}) => (
+}: ChartSettingEnumToggleProps<T>) => (
<Switch
labelPosition="left"
checked={value === checkedValue}
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx
index 4f75f94ba43..6441ec01130 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingGoalInput.tsx
@@ -5,13 +5,13 @@ import { ActionIcon, Icon, Menu, NumberInput, TextInput } from "metabase/ui";
import { isNumeric } from "metabase-lib/v1/types/utils/isa";
import type { DatasetColumn } from "metabase-types/api";
-interface ChartSettingGoalInputProps {
+export type ChartSettingGoalInputProps = {
id: string;
value: number | string;
onChange: (value: number | string) => void;
columns?: DatasetColumn[];
valueField?: string;
-}
+};
export const ChartSettingGoalInput = ({
id,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx
index d0a652ad6ef..062087e9f57 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingMaxCategories.tsx
@@ -12,11 +12,10 @@ type AggregationFunction = Exclude<
undefined
>;
-export interface ChartSettingMaxCategoriesProps
- extends ChartSettingWidgetProps<number> {
+export type ChartSettingMaxCategoriesProps = ChartSettingWidgetProps<number> & {
isEnabled?: boolean;
aggregationFunction: AggregationFunction;
-}
+};
export const ChartSettingMaxCategories = ({
isEnabled,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx
index 489b59e2e89..a02bb13d5b2 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentedControl/ChartSettingSegmentedControl.tsx
@@ -3,11 +3,11 @@ import cx from "classnames";
import CS from "metabase/css/core/index.css";
import { Box, Button, Center, Icon, type IconName, Text } from "metabase/ui";
-interface ChartSettingSegmentedControlProps {
+export type ChartSettingSegmentedControlProps = {
options: { name: string; value: string; icon?: IconName }[];
onChange: (value: string) => void;
value: string;
-}
+};
export const ChartSettingSegmentedControl = ({
options,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx
index bb70dde99cd..37cdb751da6 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingSegmentsEditor/ChartSettingSegmentsEditor.tsx
@@ -13,11 +13,11 @@ import { ChartSettingInput } from "../ChartSettingInput";
import S from "./ChartSettingSegmentsEditor.module.css";
-export interface ChartSettingSegmentsEditorProps {
+export type ChartSettingSegmentsEditorProps = {
value: ScalarSegment[];
onChange: (value: ScalarSegment[]) => void;
canRemoveAll?: boolean;
-}
+};
export const ChartSettingSegmentsEditor = ({
value: segments,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx
index 3031755c620..4ca9d411b4f 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingSeriesOrder.tsx
@@ -32,7 +32,7 @@ export interface SortableItem {
hideSettings?: boolean;
}
-interface ChartSettingSeriesOrderProps {
+export type ChartSettingSeriesOrderProps = {
onChange: (rows: SortableItem[]) => void;
value: SortableItem[];
onShowWidget: (
@@ -52,7 +52,7 @@ interface ChartSettingSeriesOrderProps {
otherSettingWidgetId?: string;
onOtherColorChange?: (newColor: string) => void;
truncateAfter?: number;
-}
+};
export const ChartSettingSeriesOrder = ({
onChange,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
index 7850a478d8a..efad12f32ea 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingTableColumns/ChartSettingTableColumns.tsx
@@ -14,7 +14,7 @@ import { TableColumnPanel } from "./TableColumnPanel";
import type { EditWidgetData } from "./types";
import { canEditQuery } from "./utils";
-interface ChartSettingTableColumnsProps {
+export type ChartSettingTableColumnsProps = {
value: TableColumnOrderSetting[];
columns: DatasetColumn[];
question?: Question;
@@ -22,7 +22,7 @@ interface ChartSettingTableColumnsProps {
getColumnName: (column: DatasetColumn) => string;
onChange: (value: TableColumnOrderSetting[], question?: Question) => void;
onShowWidget: (config: EditWidgetData, targetElement: HTMLElement) => void;
-}
+};
export const ChartSettingTableColumns = ({
value,
diff --git a/frontend/src/metabase/visualizations/components/settings/types.ts b/frontend/src/metabase/visualizations/components/settings/types.ts
index 4ea4317c698..c74cda669fb 100644
--- a/frontend/src/metabase/visualizations/components/settings/types.ts
+++ b/frontend/src/metabase/visualizations/components/settings/types.ts
@@ -1,7 +1,7 @@
import type { VisualizationSettings } from "metabase-types/api";
-export interface ChartSettingWidgetProps<TValue> {
+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/boxplot/model/index.ts b/frontend/src/metabase/visualizations/echarts/boxplot/model/index.ts
index 9b5a415443a..717ec58b20d 100644
--- a/frontend/src/metabase/visualizations/echarts/boxplot/model/index.ts
+++ b/frontend/src/metabase/visualizations/echarts/boxplot/model/index.ts
@@ -271,7 +271,7 @@ const getYAxisSplit = (
const auto: DataKey[] = [];
seriesModels.forEach((seriesModel) => {
- const seriesSettings = settings.series(
+ const seriesSettings = settings.series?.(
seriesModel.legacySeriesSettingsObjectKey,
);
const axis = seriesSettings?.axis;
diff --git a/frontend/src/metabase/visualizations/echarts/boxplot/option/series.ts b/frontend/src/metabase/visualizations/echarts/boxplot/option/series.ts
index ce97d9d638a..08f36a6f28c 100644
--- a/frontend/src/metabase/visualizations/echarts/boxplot/option/series.ts
+++ b/frontend/src/metabase/visualizations/echarts/boxplot/option/series.ts
@@ -200,7 +200,7 @@ export const buildEChartsPointsSeries = (
return seriesModels
.filter((seriesModel) => seriesModel.visible)
.flatMap((seriesModel) => {
- const seriesSettings = settings?.series(
+ const seriesSettings = settings.series?.(
seriesModel.legacySeriesSettingsObjectKey,
);
const showSeriesValues = seriesSettings?.show_series_values ?? true;
@@ -357,7 +357,7 @@ export const buildEChartsBoxPlotLabelsSeries = (
if (!labelFormatter) {
return false;
}
- const seriesSettings = settings?.series(
+ const seriesSettings = settings.series?.(
seriesModel.legacySeriesSettingsObjectKey,
);
return seriesSettings?.show_series_values ?? true;
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/chart-measurements/index.ts b/frontend/src/metabase/visualizations/echarts/cartesian/chart-measurements/index.ts
index 5a7cfdff787..b4ad4f4dbbe 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/chart-measurements/index.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/chart-measurements/index.ts
@@ -554,10 +554,10 @@ export const getChartPadding = (
// the tick labels on the very edge of the x-axis for scatter plots only.
const isScatterPlot =
seriesModels?.some((seriesModel) => {
- const seriesSettings = settings.series(
+ const seriesSettings = settings.series?.(
seriesModel.legacySeriesSettingsObjectKey,
);
- return seriesSettings.display === "scatter";
+ return seriesSettings?.display === "scatter";
}) ?? false;
if (isScatterPlot && xAxisModel.axisType !== "category") {
firstTickOverflow = Math.min(
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/axis.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/axis.ts
index 626a7725546..4bb1fb19081 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/axis.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/axis.ts
@@ -45,6 +45,7 @@ import {
tryGetDate,
} from "metabase/visualizations/echarts/cartesian/utils/timeseries";
import { computeNumericDataInterval } from "metabase/visualizations/lib/numeric";
+import { getLineAreaBarComparisonSettings } from "metabase/visualizations/lib/settings";
import type {
ColumnSettings,
ComputedVisualizationSettings,
@@ -56,7 +57,6 @@ import type {
NumericScale,
RawSeries,
RowValue,
- SeriesSettings,
StackType,
} from "metabase-types/api";
import { numericScale } from "metabase-types/api";
@@ -67,31 +67,6 @@ import type { ShowWarning } from "../../types";
import { getAxisTransforms } from "./transforms";
import { getFormattingOptionsWithoutScaling } from "./util";
-const KEYS_TO_COMPARE = new Set([
- "number_style",
- "currency",
- "currency_style",
- "number_separators",
- "decimals",
- "scale",
- "prefix",
- "suffix",
-]);
-
-function getLineAreaBarComparisonSettings(
- columnSettings: Record<string, unknown>,
-) {
- return _.pick(columnSettings, (value, key) => {
- if (!KEYS_TO_COMPARE.has(key)) {
- return false;
- }
- if ((key === "prefix" || key === "suffix") && value === "") {
- return false;
- }
- return true;
- });
-}
-
const uniqueCards = (seriesModels: SeriesModel[]) =>
_.uniq(seriesModels.map(({ cardId }) => cardId)).length;
@@ -292,7 +267,7 @@ const getYAxisSplit = (
const axisBySeriesKey = seriesModels.reduce(
(acc, seriesModel) => {
- const seriesSettings: SeriesSettings = settings.series(
+ const seriesSettings = settings.series?.(
seriesModel.legacySeriesSettingsObjectKey,
);
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts
index 3e15507e946..343c2ff9e68 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/dataset.ts
@@ -306,12 +306,12 @@ export const getNullReplacerTransform = (
seriesModels: SeriesModel[],
): TransformFn => {
const replaceNullsWithZeroDataKeys = seriesModels
- .filter(
- (seriesModel) =>
- settings.series(seriesModel.legacySeriesSettingsObjectKey)[
- "line.missing"
- ] === "zero",
- )
+ .filter((seriesModel) => {
+ const seriesSettings = settings.series?.(
+ seriesModel.legacySeriesSettingsObjectKey,
+ );
+ return seriesSettings?.["line.missing"] === "zero";
+ })
.map((seriesModel) => seriesModel.dataKey);
return (datum) => {
@@ -328,12 +328,13 @@ const hasInterpolatedAreaSeries = (
settings: ComputedVisualizationSettings,
) => {
return seriesModels.some((seriesModel) => {
- const seriesSettings = settings.series(
+ const seriesSettings = settings.series?.(
seriesModel.legacySeriesSettingsObjectKey,
);
- return (
- seriesSettings["line.missing"] !== "none" &&
- seriesSettings.display === "area"
+ return Boolean(
+ seriesSettings &&
+ seriesSettings["line.missing"] !== "none" &&
+ seriesSettings.display === "area",
);
});
};
@@ -739,10 +740,10 @@ export const applyVisualizationSettingsDataTransformations = (
) => {
dataset = appendDataIndex(dataset);
const barSeriesModels = seriesModels.filter((seriesModel) => {
- const seriesSettings = settings.series(
+ const seriesSettings = settings.series?.(
seriesModel.legacySeriesSettingsObjectKey,
);
- return seriesSettings.display === "bar";
+ return seriesSettings?.display === "bar";
});
const seriesDataKeys = seriesModels.map((seriesModel) => seriesModel.dataKey);
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts
index 73b38ba9305..33883cbb914 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/series.ts
@@ -18,7 +18,6 @@ import type {
StackModel,
StackTotalDataKey,
StackedSeriesFormatters,
- VizSettingsKey,
WaterFallChartDataDensity,
} from "metabase/visualizations/echarts/cartesian/model/types";
import { getHexColor } from "metabase/visualizations/lib/color";
@@ -39,6 +38,7 @@ import {
type RowValue,
type SeriesSettings,
type SingleSeries,
+ type VisualizationSettingKey,
getRowsForStableKeys,
} from "metabase-types/api";
@@ -58,7 +58,7 @@ export const getSeriesVizSettingsKey = (
metricsCount: number,
breakoutName: string | null,
cardName?: string,
-): VizSettingsKey => {
+): VisualizationSettingKey => {
const isBreakoutSeries = breakoutName != null;
const isSingleMetricCard = metricsCount === 1 && !isBreakoutSeries;
@@ -454,18 +454,21 @@ export function getComboChartDataDensity(
);
const seriesWithSymbols = seriesModels.filter((seriesModel) => {
const seriesSettings = seriesSettingsByDataKey[seriesModel.dataKey];
- return ["area", "line"].includes(seriesSettings.display ?? "");
+ const display = seriesSettings.display;
+ return display && ["area", "line"].includes(display);
});
const seriesWithLabels = seriesModels.filter((seriesModel) => {
const seriesSettings = seriesSettingsByDataKey[seriesModel.dataKey];
+ const display = seriesSettings.display;
if (
- ["area", "bar"].includes(seriesSettings.display ?? "") &&
+ display &&
+ ["area", "bar"].includes(display) &&
settings["stackable.stack_type"] != null
) {
return false;
}
- return seriesSettings["show_series_values"];
+ return seriesSettings?.show_series_values;
});
let totalNumberOfDots = 0;
@@ -581,20 +584,28 @@ export function getDisplaySeriesSettingsByDataKey(
stackModels: StackModel[] | null,
settings: ComputedVisualizationSettings,
) {
- const seriesSettingsByKey = seriesModels.reduce(
- (acc, seriesModel) => {
- acc[seriesModel.dataKey] = settings.series(
- seriesModel.legacySeriesSettingsObjectKey,
- );
- return acc;
- },
- {} as Record<DataKey, SeriesSettings>,
- );
+ const seriesSettingsByKey = seriesModels.reduce<
+ Record<DataKey, SeriesSettings>
+ >((acc, seriesModel) => {
+ const seriesSettings = settings.series?.(
+ seriesModel.legacySeriesSettingsObjectKey,
+ );
+
+ if (seriesSettings) {
+ acc[seriesModel.dataKey] = seriesSettings;
+ }
+
+ return acc;
+ }, {});
if (stackModels != null) {
stackModels.forEach(({ display, seriesKeys }) => {
seriesKeys.forEach((seriesKey) => {
- seriesSettingsByKey[seriesKey].display = display;
+ const settings = seriesSettingsByKey[seriesKey];
+
+ if (settings) {
+ settings.display = display;
+ }
});
});
}
@@ -743,7 +754,7 @@ const getSeriesLabelsFormatters = (
const seriesModelsWithLabels = seriesModels.filter((seriesModel) => {
const seriesSettings =
- settings.series(seriesModel.legacySeriesSettingsObjectKey) ?? {};
+ settings.series?.(seriesModel.legacySeriesSettingsObjectKey) ?? {};
return !!seriesSettings["show_series_values"];
});
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/stack.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/stack.ts
index 78a8f873997..f4894e1dd22 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/stack.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/stack.ts
@@ -19,8 +19,13 @@ export const getStackModels = (
const seriesModelsByDisplay = _.groupBy(
visibleSeriesModels,
- (seriesModel) =>
- settings.series(seriesModel.legacySeriesSettingsObjectKey).display,
+ (seriesModel) => {
+ const series = settings.series?.(
+ seriesModel.legacySeriesSettingsObjectKey,
+ );
+
+ return series?.display ?? "no-display";
+ },
);
return getObjectKeys(seriesModelsByDisplay)
@@ -34,8 +39,8 @@ export const getStackModels = (
} else {
axis = stackSeriesModels.every(
(seriesModel) =>
- settings.series(seriesModel.legacySeriesSettingsObjectKey)?.axis ===
- "right",
+ settings.series?.(seriesModel.legacySeriesSettingsObjectKey)
+ ?.axis === "right",
)
? "right"
: "left";
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/trend-line.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/trend-line.ts
index 71d3cbeac31..4af2e53a052 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/trend-line.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/trend-line.ts
@@ -41,10 +41,10 @@ const getSeriesModelsWithTrends = (
): [SeriesModel, TrendFn][] => {
return seriesModels
.map((seriesModel) => {
- if (
- settings.series(seriesModel.legacySeriesSettingsObjectKey)
- .show_series_trendline === false
- ) {
+ const seriesSetting = settings.series?.(
+ seriesModel.legacySeriesSettingsObjectKey,
+ );
+ if (seriesSetting?.show_series_trendline === false) {
return null;
}
// Breakout series do not support trend lines because the data grouping happens on the client
diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/model/types.ts b/frontend/src/metabase/visualizations/echarts/cartesian/model/types.ts
index 3497d4dbe7e..80a084da52f 100644
--- a/frontend/src/metabase/visualizations/echarts/cartesian/model/types.ts
+++ b/frontend/src/metabase/visualizations/echarts/cartesian/model/types.ts
@@ -8,10 +8,12 @@ import type {
X_AXIS_DATA_KEY,
} from "metabase/visualizations/echarts/cartesian/constants/dataset";
import type {
+ Card,
CardId,
DatasetColumn,
DateTimeAbsoluteUnit,
RowValue,
+ VisualizationSettingKey,
} from "metabase-types/api";
export type BreakoutValue = Exclude<RowValue, object>;
@@ -30,11 +32,9 @@ export type DataKey =
| typeof X_AXIS_DATA_KEY
| typeof INDEX_KEY;
-export type VizSettingsKey = string;
-
export type LegacySeriesSettingsObjectKey = {
- card: {
- _seriesKey: VizSettingsKey;
+ card: Partial<Card> & {
+ _seriesKey?: VisualizationSettingKey;
};
};
@@ -48,7 +48,7 @@ export type BaseSeriesModel = {
};
export type RegularSeriesModel = BaseSeriesModel & {
- vizSettingsKey: VizSettingsKey;
+ vizSettingsKey: VisualizationSettingKey;
// TODO: remove when the settings definitions are updated for the dynamic combo chart.
// This object is used as a key for the `series` function of the computed
diff --git a/frontend/src/metabase/visualizations/index.ts b/frontend/src/metabase/visualizations/index.ts
index 92ce4522715..2a38f23e2ae 100644
--- a/frontend/src/metabase/visualizations/index.ts
+++ b/frontend/src/metabase/visualizations/index.ts
@@ -77,7 +77,9 @@ export function getVisualization(display: VisualizationDisplay | null) {
return display ? visualizations.get(display) : defaultVisualization;
}
-export function getVisualizationRaw(series: SeriesLike) {
+export function getVisualizationRaw(
+ series: SeriesLike,
+): Visualization | undefined {
return visualizations.get(series[0].card.display);
}
diff --git a/frontend/src/metabase/visualizations/lib/settings.js b/frontend/src/metabase/visualizations/lib/settings.js
deleted file mode 100644
index b4d7d7beb17..00000000000
--- a/frontend/src/metabase/visualizations/lib/settings.js
+++ /dev/null
@@ -1,300 +0,0 @@
-import _ from "underscore";
-
-import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import {
- convertLinkColumnToClickBehavior,
- removeInternalClickBehaviors,
-} from "metabase/embedding-sdk/lib/links";
-import { ChartSettingColorPicker } from "metabase/visualizations/components/settings/ChartSettingColorPicker";
-import { ChartSettingColorsPicker } from "metabase/visualizations/components/settings/ChartSettingColorsPicker";
-import { ChartSettingFieldPicker } from "metabase/visualizations/components/settings/ChartSettingFieldPicker";
-import { ChartSettingFieldsPartition } from "metabase/visualizations/components/settings/ChartSettingFieldsPartition";
-import { ChartSettingFieldsPicker } from "metabase/visualizations/components/settings/ChartSettingFieldsPicker";
-import { ChartSettingInput } from "metabase/visualizations/components/settings/ChartSettingInput";
-import { ChartSettingInputNumeric } from "metabase/visualizations/components/settings/ChartSettingInputNumeric";
-import { ChartSettingMultiSelect } from "metabase/visualizations/components/settings/ChartSettingMultiSelect";
-import { ChartSettingRadio } from "metabase/visualizations/components/settings/ChartSettingRadio";
-import { ChartSettingSegmentedControl } from "metabase/visualizations/components/settings/ChartSettingSegmentedControl";
-import { ChartSettingSelect } from "metabase/visualizations/components/settings/ChartSettingSelect";
-import { ChartSettingToggle } from "metabase/visualizations/components/settings/ChartSettingToggle";
-
-const WIDGETS = {
- input: ChartSettingInput,
- number: ChartSettingInputNumeric,
- radio: ChartSettingRadio,
- select: ChartSettingSelect,
- toggle: ChartSettingToggle,
- segmentedControl: ChartSettingSegmentedControl,
- field: ChartSettingFieldPicker,
- fields: ChartSettingFieldsPicker,
- fieldsPartition: ChartSettingFieldsPartition,
- color: ChartSettingColorPicker,
- colors: ChartSettingColorsPicker,
- multiselect: ChartSettingMultiSelect,
-};
-
-export function getComputedSettings(
- settingsDefs,
- object,
- storedSettings,
- extra = {},
-) {
- const computedSettings = {};
- for (const settingId in settingsDefs) {
- getComputedSetting(
- computedSettings,
- settingsDefs,
- settingId,
- object,
- storedSettings,
- extra,
- );
- }
-
- if (isEmbeddingSdk()) {
- const shouldKeepInternalClickBehavior = extra.enableEntityNavigation;
-
- const result = _.compose(
- // remove internal click behaviors unless internal navigation is enabled
- shouldKeepInternalClickBehavior
- ? _.identity
- : removeInternalClickBehaviors,
- convertLinkColumnToClickBehavior,
- )(computedSettings);
-
- return result;
- }
-
- return computedSettings;
-}
-
-function getComputedSetting(
- computedSettings, // MUTATED!
- settingDefs,
- settingId,
- object,
- storedSettings,
- extra = {},
-) {
- if (settingId in computedSettings) {
- return;
- }
-
- const settingDef = settingDefs[settingId] || {};
-
- for (const dependentId of settingDef.readDependencies || []) {
- getComputedSetting(
- computedSettings,
- settingDefs,
- dependentId,
- object,
- storedSettings,
- extra,
- );
- }
-
- if (settingDef.useRawSeries && object._raw) {
- object = object._raw;
- }
-
- const settings = { ...storedSettings, ...computedSettings };
-
- try {
- if (settingDef.getValue) {
- return (computedSettings[settingId] = settingDef.getValue(
- object,
- settings,
- extra,
- ));
- }
-
- if (storedSettings[settingId] !== undefined) {
- if (!settingDef.isValid || settingDef.isValid(object, settings, extra)) {
- return (computedSettings[settingId] = storedSettings[settingId]);
- }
- }
-
- if (settingDef.getDefault) {
- const defaultValue = settingDef.getDefault(object, settings, extra);
-
- return (computedSettings[settingId] = defaultValue);
- }
-
- if ("default" in settingDef) {
- return (computedSettings[settingId] = settingDef.default);
- }
- } catch (e) {
- console.warn("Error getting setting", settingId, e);
- }
- return (computedSettings[settingId] = undefined);
-}
-
-function getSettingWidget(
- settingDefs,
- settingId,
- storedSettings,
- computedSettings,
- object,
- onChangeSettings,
- extra = {},
-) {
- const settingDef = settingDefs[settingId];
- const value = computedSettings[settingId];
- const onChange = (value, question) => {
- const newSettings = { [settingId]: value };
- for (const settingId of settingDef.writeDependencies || []) {
- newSettings[settingId] = computedSettings[settingId];
- }
- for (const settingId of settingDef.eraseDependencies || []) {
- newSettings[settingId] = null;
- }
- onChangeSettings(newSettings, question);
- settingDef.onUpdate?.(value, extra);
- };
- if (settingDef.useRawSeries && object._raw) {
- extra.transformedSeries = object;
- object = object._raw;
- }
- return {
- ...settingDef,
- id: settingId,
- value: value,
- section: settingDef.getSection
- ? settingDef.getSection(object, computedSettings, extra)
- : settingDef.section,
- title: settingDef.getTitle
- ? settingDef.getTitle(object, computedSettings, extra)
- : settingDef.title,
- hidden: settingDef.getHidden
- ? settingDef.getHidden(object, computedSettings, extra)
- : settingDef.hidden || false,
- marginBottom: settingDef.getMarginBottom
- ? settingDef.getMarginBottom(object, computedSettings, extra)
- : settingDef.marginBottom,
- disabled: settingDef.getDisabled
- ? settingDef.getDisabled(object, computedSettings, extra)
- : settingDef.disabled || false,
- props: {
- ...(settingDef.props ? settingDef.props : {}),
- ...(settingDef.getProps
- ? settingDef.getProps(
- object,
- computedSettings,
- onChange,
- extra,
- onChangeSettings,
- )
- : {}),
- },
- set: settingId in storedSettings,
- widget:
- typeof settingDef.widget === "string"
- ? WIDGETS[settingDef.widget]
- : settingDef.widget,
- onChange,
- onChangeSettings, // this gives a widget access to update other settings
- };
-}
-
-export function getSettingsWidgets(
- settingDefs,
- storedSettings,
- computedSettings,
- object,
- onChangeSettings,
- extra = {},
-) {
- return Object.keys(settingDefs)
- .map((settingId) =>
- getSettingWidget(
- settingDefs,
- settingId,
- storedSettings,
- computedSettings,
- object,
- onChangeSettings,
- extra,
- ),
- )
- .filter((widget) => widget.widget);
-}
-
-export function getPersistableDefaultSettings(settingsDefs, completeSettings) {
- const persistableDefaultSettings = {};
- for (const settingId in settingsDefs) {
- const settingDef = settingsDefs[settingId];
- if (settingDef.persistDefault) {
- persistableDefaultSettings[settingId] = completeSettings[settingId];
- }
- }
- return persistableDefaultSettings;
-}
-
-export function updateSettings(storedSettings, changedSettings) {
- const newSettings = {
- ...storedSettings,
- ...changedSettings,
- };
- // remove undefined settings
- for (const [key, value] of Object.entries(changedSettings)) {
- if (value === undefined) {
- delete newSettings[key];
- }
- }
- return newSettings;
-}
-
-export function getClickBehaviorSettings(settings) {
- const newSettings = {};
-
- if (settings.click_behavior) {
- newSettings.click_behavior = settings.click_behavior;
- }
-
- const columnSettings = getColumnClickBehavior(settings.column_settings);
- if (columnSettings) {
- newSettings.column_settings = columnSettings;
- }
-
- return newSettings;
-}
-
-function getColumnClickBehavior(columnSettings) {
- if (columnSettings == null) {
- return null;
- }
-
- return Object.entries(columnSettings)
- .filter(([_, fieldSettings]) => fieldSettings.click_behavior != null)
- .reduce((acc, [key, fieldSettings]) => {
- return {
- ...acc,
- [key]: {
- click_behavior: fieldSettings.click_behavior,
- },
- };
- }, null);
-}
-
-const KEYS_TO_COMPARE = new Set([
- "number_style",
- "currency",
- "currency_style",
- "number_separators",
- "decimals",
- "scale",
- "prefix",
- "suffix",
-]);
-
-export function getLineAreaBarComparisonSettings(columnSettings) {
- return _.pick(columnSettings, (value, key) => {
- if (!KEYS_TO_COMPARE.has(key)) {
- return false;
- }
- if ((key === "prefix" || key === "suffix") && value === "") {
- return false;
- }
- return true;
- });
-}
diff --git a/frontend/src/metabase/visualizations/lib/settings.ts b/frontend/src/metabase/visualizations/lib/settings.ts
new file mode 100644
index 00000000000..229e9d9a735
--- /dev/null
+++ b/frontend/src/metabase/visualizations/lib/settings.ts
@@ -0,0 +1,389 @@
+import type React from "react";
+import _ from "underscore";
+
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
+import {
+ convertLinkColumnToClickBehavior,
+ removeInternalClickBehaviors,
+} from "metabase/embedding-sdk/lib/links";
+import { ChartSettingColorPicker } from "metabase/visualizations/components/settings/ChartSettingColorPicker";
+import { ChartSettingColorsPicker } from "metabase/visualizations/components/settings/ChartSettingColorsPicker";
+import { ChartSettingFieldPicker } from "metabase/visualizations/components/settings/ChartSettingFieldPicker";
+import { ChartSettingFieldsPartition } from "metabase/visualizations/components/settings/ChartSettingFieldsPartition";
+import { ChartSettingFieldsPicker } from "metabase/visualizations/components/settings/ChartSettingFieldsPicker";
+import { ChartSettingInput } from "metabase/visualizations/components/settings/ChartSettingInput";
+import { ChartSettingInputNumeric } from "metabase/visualizations/components/settings/ChartSettingInputNumeric";
+import { ChartSettingMultiSelect } from "metabase/visualizations/components/settings/ChartSettingMultiSelect";
+import { ChartSettingRadio } from "metabase/visualizations/components/settings/ChartSettingRadio";
+import { ChartSettingSegmentedControl } from "metabase/visualizations/components/settings/ChartSettingSegmentedControl";
+import { ChartSettingSelect } from "metabase/visualizations/components/settings/ChartSettingSelect";
+import { ChartSettingToggle } from "metabase/visualizations/components/settings/ChartSettingToggle";
+import type {
+ CompleteVisualizationSettingDefinition,
+ ComputedVisualizationSettings,
+ SettingsExtra,
+ VisualizationSettingDefinition,
+ VisualizationSettingsDefinitions,
+} from "metabase/visualizations/types";
+import type Question from "metabase-lib/v1/Question";
+import type {
+ ColumnSettings,
+ Series,
+ VisualizationSettingKey,
+ VisualizationSettings,
+} from "metabase-types/api";
+import { isObject } from "metabase-types/guards";
+
+const WIDGETS: Record<string, React.ComponentType<any>> = {
+ input: ChartSettingInput,
+ number: ChartSettingInputNumeric,
+ radio: ChartSettingRadio,
+ select: ChartSettingSelect,
+ toggle: ChartSettingToggle,
+ segmentedControl: ChartSettingSegmentedControl,
+ field: ChartSettingFieldPicker,
+ fields: ChartSettingFieldsPicker,
+ fieldsPartition: ChartSettingFieldsPartition,
+ color: ChartSettingColorPicker,
+ colors: ChartSettingColorsPicker,
+ multiselect: ChartSettingMultiSelect,
+};
+
+export function getComputedSettings<T>(
+ settingsDefs: VisualizationSettingsDefinitions,
+ object: T,
+ storedSettings: VisualizationSettings,
+ extra: SettingsExtra = {},
+): ComputedVisualizationSettings {
+ const computedSettings: ComputedVisualizationSettings = {};
+
+ for (const settingId in settingsDefs) {
+ getComputedSetting(
+ computedSettings,
+ settingsDefs,
+ settingId,
+ object,
+ storedSettings,
+ extra,
+ );
+ }
+
+ if (isEmbeddingSdk()) {
+ const shouldKeepInternalClickBehavior = extra.enableEntityNavigation;
+
+ const result: ComputedVisualizationSettings = _.compose(
+ // remove internal click behaviors unless internal navigation is enabled
+ shouldKeepInternalClickBehavior
+ ? _.identity
+ : removeInternalClickBehaviors,
+ convertLinkColumnToClickBehavior,
+ )(computedSettings);
+
+ return result;
+ }
+
+ return computedSettings;
+}
+
+function getComputedSetting<T, TValue, TProps extends Record<string, unknown>>(
+ computedSettings: ComputedVisualizationSettings, // MUTATED!
+ settingDefs: VisualizationSettingsDefinitions,
+ settingId: VisualizationSettingKey,
+ object: T,
+ storedSettings: VisualizationSettings,
+ extra: SettingsExtra = {},
+): void {
+ if (settingId in computedSettings) {
+ return;
+ }
+
+ const settingDef: VisualizationSettingDefinition<T, TValue, TProps> =
+ settingDefs[settingId] ?? {};
+
+ for (const dependentId of settingDef.readDependencies || []) {
+ getComputedSetting(
+ computedSettings,
+ settingDefs,
+ dependentId,
+ object,
+ storedSettings,
+ extra,
+ );
+ }
+
+ const resolvedObject =
+ settingDef.useRawSeries && isObjectWithRaw(object) && object._raw
+ ? object._raw
+ : object;
+
+ const settings: ComputedVisualizationSettings = {
+ ...storedSettings,
+ ...computedSettings,
+ };
+
+ try {
+ if (settingDef.getValue) {
+ computedSettings[settingId] = settingDef.getValue(
+ resolvedObject,
+ settings,
+ extra,
+ );
+ return;
+ }
+
+ if (storedSettings[settingId] !== undefined) {
+ const isValid = settingDef.isValid;
+ if (!isValid || isValid(resolvedObject, settings, extra)) {
+ computedSettings[settingId] = storedSettings[settingId];
+ return;
+ }
+ }
+
+ if (settingDef.getDefault) {
+ const defaultValue = settingDef.getDefault(
+ resolvedObject,
+ settings,
+ extra,
+ );
+ computedSettings[settingId] = defaultValue;
+ return;
+ }
+
+ if ("default" in settingDef) {
+ computedSettings[settingId] = settingDef.default;
+ return;
+ }
+ } catch (e) {
+ console.warn("Error getting setting", settingId, e);
+ }
+ computedSettings[settingId] = undefined;
+}
+
+function isObjectWithRaw<T>(object: T): object is T & { _raw?: T } {
+ return isObject(object) && "_raw" in object;
+}
+
+function getSettingWidget<T, TValue, TProps extends Record<string, unknown>>(
+ settingDefs: VisualizationSettingsDefinitions,
+ settingId: VisualizationSettingKey,
+ storedSettings: VisualizationSettings,
+ computedSettings: ComputedVisualizationSettings,
+ object: T,
+ onChangeSettings: (
+ newSettings: Partial<VisualizationSettings>,
+ question?: Question,
+ ) => void,
+ extra: SettingsExtra = {},
+): CompleteVisualizationSettingDefinition<T, TValue, TProps> {
+ const settingDef: VisualizationSettingDefinition<T, TValue, TProps> =
+ settingDefs[settingId] ?? {};
+ const value = computedSettings[settingId];
+
+ const onChange = (newValue: TValue, question?: Question) => {
+ const newSettings: Partial<VisualizationSettings> = {
+ [settingId]: newValue,
+ };
+ for (const depId of settingDef.writeDependencies || []) {
+ newSettings[depId] = computedSettings[depId];
+ }
+ for (const eraseId of settingDef.eraseDependencies || []) {
+ newSettings[eraseId] = null;
+ }
+ onChangeSettings(newSettings, question);
+ settingDef.onUpdate?.(newValue, extra);
+ };
+
+ let resolvedObject = object;
+ if (settingDef.useRawSeries && isObjectWithRaw(object) && object._raw) {
+ // only if object is (RawSeries | TransformedSeries)
+ if (Array.isArray(object)) {
+ extra.transformedSeries = object;
+ }
+
+ resolvedObject = object._raw;
+ }
+
+ const getHiddenFn = settingDef.getHidden;
+ const getPropsFn = settingDef.getProps;
+ const defaultProps = {} as TProps;
+
+ const section = settingDef.getSection
+ ? settingDef.getSection(resolvedObject, computedSettings, extra)
+ : settingDef.section;
+
+ return {
+ ...settingDef,
+ id: settingId,
+ value,
+ section,
+ hidden: getHiddenFn
+ ? getHiddenFn(resolvedObject, computedSettings, extra)
+ : (settingDef.hidden ?? false),
+ marginBottom: settingDef.getMarginBottom
+ ? settingDef.getMarginBottom(resolvedObject, computedSettings, extra)
+ : settingDef.marginBottom,
+ disabled: settingDef.getDisabled
+ ? settingDef.getDisabled(resolvedObject, computedSettings, extra)
+ : (settingDef.disabled ?? false),
+ props: {
+ ...(settingDef.props && typeof settingDef.props === "object"
+ ? settingDef.props
+ : defaultProps),
+ ...(getPropsFn
+ ? getPropsFn(
+ resolvedObject,
+ computedSettings,
+ onChange,
+ extra,
+ onChangeSettings,
+ )
+ : defaultProps),
+ },
+ set: settingId in storedSettings,
+ widget:
+ typeof settingDef.widget === "string"
+ ? WIDGETS[settingDef.widget]
+ : settingDef.widget,
+ onChange,
+ onChangeSettings, // this gives a widget access to update other settings
+ };
+}
+
+export function getSettingsWidgets<
+ T,
+ TValue,
+ TProps extends Record<string, unknown>,
+>(
+ settingDefs: VisualizationSettingsDefinitions,
+ storedSettings: VisualizationSettings,
+ computedSettings: ComputedVisualizationSettings,
+ object: T,
+ onChangeSettings: (
+ newSettings: Partial<VisualizationSettings>,
+ question?: Question,
+ ) => void,
+ extra: SettingsExtra = {},
+): CompleteVisualizationSettingDefinition<T, TValue, TProps>[] {
+ return Object.keys(settingDefs)
+ .map((settingId) =>
+ getSettingWidget<T, TValue, TProps>(
+ settingDefs,
+ settingId,
+ storedSettings,
+ computedSettings,
+ object,
+ onChangeSettings,
+ extra,
+ ),
+ )
+ .filter((widget) => widget.widget);
+}
+
+export function getPersistableDefaultSettings(
+ settingsDefs: VisualizationSettingsDefinitions,
+ completeSettings: ComputedVisualizationSettings,
+): ComputedVisualizationSettings {
+ const persistableDefaultSettings: ComputedVisualizationSettings = {};
+
+ for (const settingId in settingsDefs) {
+ const settingDef: VisualizationSettingDefinition<Series> =
+ settingsDefs[settingId];
+
+ if (settingDef.persistDefault) {
+ persistableDefaultSettings[settingId] = completeSettings[settingId];
+ }
+ }
+ return persistableDefaultSettings;
+}
+
+export function updateSettings(
+ storedSettings: VisualizationSettings,
+ changedSettings: Partial<VisualizationSettings>,
+): VisualizationSettings {
+ const newSettings = {
+ ...storedSettings,
+ ...changedSettings,
+ };
+
+ // remove undefined settings
+ for (const [key, value] of Object.entries(changedSettings)) {
+ if (value === undefined) {
+ delete newSettings[key];
+ }
+ }
+
+ return newSettings;
+}
+
+export function getClickBehaviorSettings(
+ settings: VisualizationSettings | null | undefined,
+): VisualizationSettings {
+ const newSettings: VisualizationSettings = {};
+
+ if (!settings) {
+ return newSettings;
+ }
+
+ if (settings.click_behavior) {
+ newSettings.click_behavior = settings.click_behavior;
+ }
+
+ const columnSettings = getColumnClickBehavior(settings.column_settings);
+
+ if (columnSettings) {
+ newSettings.column_settings = columnSettings;
+ }
+
+ return newSettings;
+}
+
+function getColumnClickBehavior(
+ columnSettings: Record<string, ColumnSettings> | undefined,
+): Record<string, ColumnSettings> | null {
+ if (columnSettings == null) {
+ return null;
+ }
+
+ const entries = Object.entries(columnSettings).filter(
+ ([, fieldSettings]) => fieldSettings.click_behavior != null,
+ );
+
+ if (entries.length === 0) {
+ return null;
+ }
+
+ return entries.reduce(
+ (acc, [key, fieldSettings]) => ({
+ ...acc,
+ [key]: {
+ click_behavior: fieldSettings.click_behavior,
+ },
+ }),
+ {},
+ );
+}
+
+const KEYS_TO_COMPARE = new Set([
+ "number_style",
+ "currency",
+ "currency_style",
+ "number_separators",
+ "decimals",
+ "scale",
+ "prefix",
+ "suffix",
+]);
+
+export function getLineAreaBarComparisonSettings(
+ columnSettings: ColumnSettings,
+): Partial<ColumnSettings> {
+ return _.pick(columnSettings, (value, key) => {
+ if (!KEYS_TO_COMPARE.has(key)) {
+ return false;
+ }
+ if ((key === "prefix" || key === "suffix") && value === "") {
+ return false;
+ }
+ return true;
+ });
+}
diff --git a/frontend/src/metabase/visualizations/lib/settings.unit.spec.js b/frontend/src/metabase/visualizations/lib/settings.unit.spec.ts
similarity index 94%
rename from frontend/src/metabase/visualizations/lib/settings.unit.spec.js
rename to frontend/src/metabase/visualizations/lib/settings.unit.spec.ts
index 093920be831..aa7884a2956 100644
--- a/frontend/src/metabase/visualizations/lib/settings.unit.spec.js
+++ b/frontend/src/metabase/visualizations/lib/settings.unit.spec.ts
@@ -1,5 +1,6 @@
// NOTE: need to load visualizations first for getSettings to work
import "metabase/visualizations";
+
import {
getClickBehaviorSettings,
getComputedSettings,
@@ -96,8 +97,7 @@ describe("settings framework", () => {
mockObject,
() => {},
);
- widgets.map(deleteFunctions);
- expect(widgets).toEqual([
+ expect(widgets).toMatchObject([
{
id: "foo",
title: "Foo",
@@ -162,7 +162,7 @@ describe("settings framework", () => {
mockObject,
onChangeSettings,
);
- widgets[0].onChange("bar");
+ widgets[0].onChange?.("bar");
expect(onChangeSettings.mock.calls).toEqual([[{ foo: "bar" }]]);
});
});
@@ -173,13 +173,13 @@ describe("settings framework", () => {
getClickBehaviorSettings({
column_settings: {
col1: {
- click_behavior: { type: "stub" },
+ click_behavior: { type: "action" },
not_click_behavior: { type: "another stub" },
},
},
}),
).toEqual({
- column_settings: { col1: { click_behavior: { type: "stub" } } },
+ column_settings: { col1: { click_behavior: { type: "action" } } },
});
});
@@ -208,11 +208,3 @@ describe("settings framework", () => {
});
});
});
-
-function deleteFunctions(object) {
- for (const property in object) {
- if (typeof object[property] === "function") {
- delete object[property];
- }
- }
-}
diff --git a/frontend/src/metabase/visualizations/lib/settings/column.js b/frontend/src/metabase/visualizations/lib/settings/column.ts
similarity index 68%
rename from frontend/src/metabase/visualizations/lib/settings/column.js
rename to frontend/src/metabase/visualizations/lib/settings/column.ts
index cc523198fbb..2d937525508 100644
--- a/frontend/src/metabase/visualizations/lib/settings/column.js
+++ b/frontend/src/metabase/visualizations/lib/settings/column.ts
@@ -1,8 +1,9 @@
import { t } from "ttag";
import _ from "underscore";
-import { currency } from "cljs/metabase.util.currency";
import {
+ type TimeEnabled,
+ currency,
displayNameForColumn,
getCurrency,
getCurrencyNarrowSymbol,
@@ -26,6 +27,10 @@ import {
getDefaultNumberSeparators,
getDefaultNumberStyle,
} from "metabase/visualizations/shared/settings/column";
+import type {
+ ComputedVisualizationSettings,
+ VisualizationSettingsDefinitions,
+} from "metabase/visualizations/types";
import {
getColumnKey,
getObjectColumnSettings,
@@ -41,32 +46,37 @@ import {
isDateWithoutTime,
isNumber,
} from "metabase-lib/v1/types/utils/isa";
+import type {
+ ColumnSettings,
+ DatasetColumn,
+ DatetimeUnit,
+ Series,
+ VisualizationSettings,
+} from "metabase-types/api";
import { nestedSettings } from "./nested";
-/**
- * @typedef {import("metabase-types/api").Series} Series
- * @typedef {import("metabase-types/api").DatasetColumn} DatasetColumn
- * @typedef {(series: Series, vizSettings) => DatasetColumn[]} GetColumnsFn
- */
-
-/** @type {GetColumnsFn} */
-const DEFAULT_GET_COLUMNS = (series, vizSettings) =>
- [].concat(...series.map((s) => (s.data && s.data.cols) || []));
-
-/**
- * @param {Object} [settings]
- * @param {GetColumnsFn} [settings.getColumns]
- * @param {boolean} [settings.hidden]
- * @param {string} [settings.section]
- * @param {string[]} [settings.readDependencies]
- */
+type GetColumnsFn = (
+ series: Series,
+ vizSettings: VisualizationSettings,
+) => DatasetColumn[];
+
+const DEFAULT_GET_COLUMNS: GetColumnsFn = (series, _vizSettings) =>
+ series.flatMap((s) => s.data?.cols ?? []);
+
+export interface ColumnSettingsOptions {
+ getColumns?: GetColumnsFn;
+ hidden?: boolean;
+ section?: string;
+ readDependencies?: string[];
+}
+
export function columnSettings({
getColumns = DEFAULT_GET_COLUMNS,
hidden,
...def
-} = {}) {
- return nestedSettings("column_settings", {
+}: ColumnSettingsOptions = {}) {
+ return nestedSettings<"column_settings", DatasetColumn>("column_settings", {
section: t`Formatting`,
objectName: "column",
getObjects: getColumns,
@@ -81,8 +91,8 @@ export function columnSettings({
});
}
-export function getGlobalSettingsForColumn() {
- const columnSettings = {};
+export function getGlobalSettingsForColumn(): ColumnSettings {
+ const columnSettings: ColumnSettings = {};
const customFormatting = MetabaseSettings.get("custom-formatting") || {};
// NOTE: the order of these doesn't matter as long as there's no overlap between settings
@@ -93,19 +103,21 @@ export function getGlobalSettingsForColumn() {
return columnSettings;
}
-function getLocalSettingsForColumn(column) {
+function getLocalSettingsForColumn(column: DatasetColumn): ColumnSettings {
return column.settings || {};
}
-function getInheritedSettingsForColumn(column) {
+function getInheritedSettingsForColumn(column: DatasetColumn): ColumnSettings {
return {
...getGlobalSettingsForColumn(),
...getLocalSettingsForColumn(column),
};
}
-function getTimeEnabledOptionsForUnit(unit) {
- const options = [
+function getTimeEnabledOptionsForUnit(
+ unit: DatetimeUnit | "second" | "millisecond" | undefined,
+): { name: string; value: TimeEnabled | null }[] {
+ const options: { name: string; value: TimeEnabled | null }[] = [
{ name: t`Off`, value: null },
{ name: t`HH:MM`, value: "minutes" },
];
@@ -130,7 +142,7 @@ function getTimeEnabledOptionsForUnit(unit) {
return options;
}
-export const DATE_COLUMN_SETTINGS = {
+export const DATE_COLUMN_SETTINGS: VisualizationSettingsDefinitions = {
date_style: {
get title() {
return t`Date style`;
@@ -143,17 +155,22 @@ export const DATE_COLUMN_SETTINGS = {
return value;
},
isValid: ({ unit }, settings) => {
- const options = getDateStyleOptionsForUnit(unit);
- return !!_.findWhere(options, { value: settings["date_style"] });
+ const options = getDateStyleOptionsForUnit(unit ?? "default");
+ return !!_.findWhere(options, { value: settings.date_style });
},
getProps: ({ unit }, settings) => ({
options: getDateStyleOptionsForUnit(
- unit,
- settings["date_abbreviate"],
- settings["date_separator"],
+ unit ?? "default",
+ settings.date_abbreviate != null
+ ? Boolean(settings.date_abbreviate)
+ : undefined,
+ settings.date_separator != null
+ ? String(settings.date_separator)
+ : undefined,
),
}),
- getHidden: ({ unit }) => getDateStyleOptionsForUnit(unit).length < 2,
+ getHidden: ({ unit }) =>
+ getDateStyleOptionsForUnit(unit ?? "default").length < 2,
},
date_separator: {
get title() {
@@ -161,9 +178,9 @@ export const DATE_COLUMN_SETTINGS = {
},
widget: "radio",
default: "/",
- getProps: (column, settings) => {
- const style = /\//.test(settings["date_style"])
- ? settings["date_style"]
+ getProps: (_column, settings) => {
+ const style = /\//.test(settings.date_style ?? "")
+ ? (settings.date_style ?? "")
: "M/D/YYYY";
return {
options: [
@@ -173,7 +190,8 @@ export const DATE_COLUMN_SETTINGS = {
],
};
},
- getHidden: ({ unit }, settings) => !/\//.test(settings["date_style"] || ""),
+ getHidden: (_column, settings) =>
+ !/\//.test(String(settings.date_style ?? "")),
},
date_abbreviate: {
get title() {
@@ -183,8 +201,11 @@ export const DATE_COLUMN_SETTINGS = {
default: false,
inline: true,
getHidden: ({ unit }, settings) => {
- const format = getDateFormatFromStyle(settings["date_style"], unit);
- return !format.match(/MMMM|dddd/);
+ const format = getDateFormatFromStyle(
+ settings.date_style,
+ unit ?? "default",
+ );
+ return !format || !format.match(/MMMM|dddd/);
},
readDependencies: ["date_style"],
},
@@ -195,14 +216,13 @@ export const DATE_COLUMN_SETTINGS = {
widget: "radio",
isValid: ({ unit }, settings) => {
const options = getTimeEnabledOptionsForUnit(unit);
- return !!_.findWhere(options, { value: settings["time_enabled"] });
+ return !!_.findWhere(options, { value: settings.time_enabled });
},
- getProps: ({ unit }, settings) => {
+ getProps: ({ unit }) => {
const options = getTimeEnabledOptionsForUnit(unit);
return { options };
},
- getHidden: (column, settings) =>
- !hasHour(column.unit) || isDateWithoutTime(column),
+ getHidden: (column) => !hasHour(column.unit) || isDateWithoutTime(column),
getDefault: ({ unit }) => (hasHour(unit) ? "minutes" : null),
},
time_style: {
@@ -212,15 +232,15 @@ export const DATE_COLUMN_SETTINGS = {
widget: "radio",
default: "h:mm A",
getProps: (column) => ({
- options: getTimeStyleOptions(column.unit),
+ options: getTimeStyleOptions(column.unit ?? "default"),
}),
getHidden: (column, settings) =>
- !settings["time_enabled"] || isDateWithoutTime(column),
+ !settings.time_enabled || isDateWithoutTime(column),
readDependencies: ["time_enabled"],
},
};
-export const NUMBER_COLUMN_SETTINGS = {
+export const NUMBER_COLUMN_SETTINGS: VisualizationSettingsDefinitions = {
number_style: {
get title() {
return t`Style`;
@@ -257,7 +277,7 @@ export const NUMBER_COLUMN_SETTINGS = {
getDefault: getDefaultNumberStyle,
// hide this for currency
getHidden: (column, settings) =>
- isCurrency(column) && settings["number_style"] === "currency",
+ isCurrency(column) && settings.number_style === "currency",
readDependencies: ["currency"],
},
currency: {
@@ -267,31 +287,29 @@ export const NUMBER_COLUMN_SETTINGS = {
widget: "select",
props: {
// FIXME: rest of these options
- options: currency.map(([_, currency]) => ({
- name: currency.name,
- value: currency.code,
+ options: currency.map(([_code, c]) => ({
+ name: c.name,
+ value: c.code,
})),
searchProp: "name",
searchCaseSensitive: false,
},
getDefault: getDefaultCurrency,
- getHidden: (column, settings) => settings["number_style"] !== "currency",
+ getHidden: (_column, settings) => settings.number_style !== "currency",
},
currency_style: {
get title() {
return t`Currency label style`;
},
widget: "radio",
- getProps: (column, settings) => {
- return {
- options: getCurrencyStyleOptions(
- settings["currency"] || "USD",
- settings["currency_style"],
- ),
- };
- },
+ getProps: (_column, settings) => ({
+ options: getCurrencyStyleOptions(
+ settings.currency || "USD",
+ settings.currency_style,
+ ),
+ }),
getDefault: getDefaultCurrencyStyle,
- getHidden: (column, settings) => settings["number_style"] !== "currency",
+ getHidden: (_column, settings) => settings.number_style !== "currency",
readDependencies: ["number_style"],
},
currency_in_header: {
@@ -299,25 +317,23 @@ export const NUMBER_COLUMN_SETTINGS = {
return t`Where to display the unit of currency`;
},
widget: "radio",
- getProps: (_series, _vizSettings, onChange) => {
- return {
- onChange: (value) => onChange(value === true),
- options: [
- { name: t`In the column heading`, value: true },
- { name: t`In every table cell`, value: false },
- ],
- };
- },
+ getProps: (_series, _vizSettings, onChange) => ({
+ onChange: (value: unknown) => onChange(value === true),
+ options: [
+ { name: t`In the column heading`, value: true },
+ { name: t`In every table cell`, value: false },
+ ],
+ }),
getDefault: getDefaultCurrencyInHeader,
- getHidden: (_column, settings, { series, forAdminSettings }) => {
+ getHidden: (_column, settings, extra) => {
+ const { forAdminSettings, series = [] } = extra ?? {};
if (forAdminSettings === true) {
return false;
- } else {
- return (
- settings["number_style"] !== "currency" ||
- series[0].card.display !== "table"
- );
}
+ return (
+ settings.number_style !== "currency" ||
+ series[0].card.display !== "table"
+ );
},
readDependencies: ["number_style"],
},
@@ -382,8 +398,7 @@ export const NUMBER_COLUMN_SETTINGS = {
},
// Optimization: build a single NumberFormat object that is used by formatting.js
_numberFormatter: {
- getValue: (column, settings) => numberFormatterForOptions(settings),
- // NOTE: make sure to include every setting that affects the number formatter here
+ getValue: (_column, settings) => numberFormatterForOptions(settings),
readDependencies: [
"number_style",
"currency_style",
@@ -392,18 +407,16 @@ export const NUMBER_COLUMN_SETTINGS = {
],
},
_header_unit: {
- getValue: (column, settings) => {
- if (
- settings["number_style"] === "currency" &&
- settings["currency_in_header"]
- ) {
- if (settings["currency_style"] === "symbol") {
- return getCurrencySymbol(settings["currency"]);
+ getValue: (_column, settings) => {
+ if (settings.number_style === "currency" && settings.currency_in_header) {
+ if (settings.currency_style === "symbol") {
+ return getCurrencySymbol(settings.currency);
}
- if (settings["currency_style"] === "narrowSymbol") {
- return getCurrencyNarrowSymbol(settings["currency"]);
+ if (settings.currency_style === "narrowSymbol") {
+ return getCurrencyNarrowSymbol(settings.currency);
}
- return getCurrency(settings["currency"], settings["currency_style"]);
+
+ return getCurrency(settings.currency, settings.currency_style);
}
return null;
},
@@ -416,7 +429,7 @@ export const NUMBER_COLUMN_SETTINGS = {
},
};
-const COMMON_COLUMN_SETTINGS = {
+const COMMON_COLUMN_SETTINGS: VisualizationSettingsDefinitions = {
// markdown_template: {
// title: t`Markdown template`,
// widget: "input",
@@ -441,12 +454,15 @@ const COMMON_COLUMN_SETTINGS = {
},
};
-export function getSettingDefinitionsForColumn(series, column) {
+export function getSettingDefinitionsForColumn(
+ series: Series,
+ column: DatasetColumn,
+) {
const visualization = getVisualizationRaw(series);
const extraColumnSettings =
- typeof visualization.columnSettings === "function"
+ typeof visualization?.columnSettings === "function"
? visualization.columnSettings(column)
- : visualization.columnSettings || {};
+ : visualization?.columnSettings || {};
if (isDate(column) || (column.unit && column.unit !== "default")) {
return {
@@ -454,21 +470,24 @@ export function getSettingDefinitionsForColumn(series, column) {
...DATE_COLUMN_SETTINGS,
...COMMON_COLUMN_SETTINGS,
};
- } else if (isNumber(column) && !isCoordinate(column)) {
+ }
+ if (isNumber(column) && !isCoordinate(column)) {
return {
...extraColumnSettings,
...NUMBER_COLUMN_SETTINGS,
...COMMON_COLUMN_SETTINGS,
};
- } else {
- return {
- ...extraColumnSettings,
- ...COMMON_COLUMN_SETTINGS,
- };
}
+ return {
+ ...extraColumnSettings,
+ ...COMMON_COLUMN_SETTINGS,
+ };
}
-export function isPivoted(series, settings) {
+export function isPivoted(
+ series: Series,
+ settings: ComputedVisualizationSettings,
+): boolean {
const [{ data }] = series;
if (!settings["table.pivot"]) {
@@ -485,27 +504,34 @@ export function isPivoted(series, settings) {
);
const normalIndex = _.findIndex(
data.cols,
- (col, index) => index !== pivotIndex && index !== cellIndex,
+ (_col, index) => index !== pivotIndex && index !== cellIndex,
);
return pivotIndex >= 0 && cellIndex >= 0 && normalIndex >= 0;
}
-export const getTitleForColumn = (column, series, settings) => {
+export const getTitleForColumn = (
+ column: DatasetColumn,
+ series: Series,
+ settings: ComputedVisualizationSettings,
+): string => {
const pivoted = isPivoted(series, settings);
+
if (pivoted) {
return displayNameForColumn(column) || t`Unset`;
- } else {
- return (
- settings.column(column)["_column_title_full"] ||
- displayNameForColumn(column)
- );
}
+
+ return (
+ settings?.column?.(column)._column_title_full ||
+ displayNameForColumn(column)
+ );
};
export function tableColumnSettings({
isShowingDetailsOnlyColumns = false,
-} = {}) {
+}: {
+ isShowingDetailsOnlyColumns?: boolean;
+} = {}): VisualizationSettingsDefinitions {
return {
"table.columns": {
get section() {
@@ -513,7 +539,7 @@ export function tableColumnSettings({
},
// title: t`Columns`,
widget: ChartSettingTableColumns,
- getHidden: (series, vizSettings) => vizSettings["table.pivot"],
+ getHidden: (_series, vizSettings) => vizSettings["table.pivot"],
getValue: ([{ data }], vizSettings) => {
const { cols } = data;
const settings = vizSettings["table.columns"] ?? [];
diff --git a/frontend/src/metabase/visualizations/lib/settings/column.unit.spec.js b/frontend/src/metabase/visualizations/lib/settings/column.unit.spec.ts
similarity index 64%
rename from frontend/src/metabase/visualizations/lib/settings/column.unit.spec.js
rename to frontend/src/metabase/visualizations/lib/settings/column.unit.spec.ts
index abfa9998935..d78990c99ef 100644
--- a/frontend/src/metabase/visualizations/lib/settings/column.unit.spec.js
+++ b/frontend/src/metabase/visualizations/lib/settings/column.unit.spec.ts
@@ -1,31 +1,39 @@
+import { checkNotNull } from "metabase/lib/types";
import { getComputedSettings } from "metabase/visualizations/lib/settings";
import registerVisualizations from "metabase/visualizations/register";
+import type { DatasetColumn, Series } from "metabase-types/api";
+import {
+ createMockColumn,
+ createMockSingleSeries,
+} from "metabase-types/api/mocks";
import { NUMBER_COLUMN_SETTINGS, columnSettings } from "./column";
registerVisualizations();
-function seriesWithColumn(col) {
+function seriesWithColumn(column?: Partial<DatasetColumn>): Series {
return [
- {
- card: {},
- data: {
- cols: [
- {
- name: "foo",
- base_type: "type/Float",
- semantic_type: "type/Currency",
- ...col,
- },
- ],
+ createMockSingleSeries(
+ {},
+ {
+ data: {
+ cols: [
+ createMockColumn({
+ name: "foo",
+ base_type: "type/Float",
+ semantic_type: "type/Currency",
+ ...column,
+ }),
+ ],
+ },
},
- },
+ ),
];
}
describe("column settings", () => {
it("should find by column name", () => {
- const series = seriesWithColumn({});
+ const series = seriesWithColumn();
const defs = { ...columnSettings() };
const stored = {
column_settings: {
@@ -35,7 +43,7 @@ describe("column settings", () => {
},
};
const computed = getComputedSettings(defs, series, stored);
- expect(computed.column(series[0].data.cols[0]).currency).toEqual("BTC");
+ expect(computed.column?.(series[0].data.cols[0]).currency).toEqual("BTC");
});
it("should find by column 'field' ID ref", () => {
@@ -52,7 +60,7 @@ describe("column settings", () => {
},
};
const computed = getComputedSettings(defs, series, stored);
- expect(computed.column(series[0].data.cols[0]).currency).toEqual("BTC");
+ expect(computed.column?.(series[0].data.cols[0]).currency).toEqual("BTC");
});
it("should find by column name if it also has a 'field-literal' ref", () => {
@@ -68,10 +76,10 @@ describe("column settings", () => {
},
};
const computed = getComputedSettings(defs, series, stored);
- expect(computed.column(series[0].data.cols[0]).currency).toEqual("BTC");
+ expect(computed.column?.(series[0].data.cols[0]).currency).toEqual("BTC");
});
- it("should find by column name if it also has a 'aggregation' ref", () => {
+ it("should find by column name if it also has an 'aggregation' ref", () => {
const series = seriesWithColumn({
field_ref: ["aggregation", 0],
});
@@ -84,7 +92,7 @@ describe("column settings", () => {
},
};
const computed = getComputedSettings(defs, series, stored);
- expect(computed.column(series[0].data.cols[0]).currency).toEqual("BTC");
+ expect(computed.column?.(series[0].data.cols[0]).currency).toEqual("BTC");
});
it("should set a time style but no date style for hour-of-day", () => {
@@ -95,8 +103,8 @@ describe("column settings", () => {
});
const defs = { ...columnSettings() };
const computed = getComputedSettings(defs, series, {});
- const { time_enabled, time_style, date_style } = computed.column(
- series[0].data.cols[0],
+ const { time_enabled, time_style, date_style } = checkNotNull(
+ computed.column?.(series[0].data.cols[0]),
);
expect(time_enabled).toEqual("minutes");
expect(time_style).toEqual("h:mm A");
@@ -109,19 +117,29 @@ describe("column settings", () => {
});
const defs = { ...columnSettings() };
const computed = getComputedSettings(defs, series, {});
- const { number_style } = computed.column(series[0].data.cols[0]);
+ const { number_style } = checkNotNull(
+ computed.column?.(series[0].data.cols[0]),
+ );
expect(number_style).toBe("percent");
});
describe("NUMBER_COLUMN_SETTINGS", () => {
it("should have coherent options and onChange (metabase#54728)", () => {
const onChangeSpy = jest.fn();
- const { options, onChange } =
- NUMBER_COLUMN_SETTINGS.currency_in_header.getProps(
- undefined,
- undefined,
- onChangeSpy,
- );
+ const getProps = checkNotNull(
+ NUMBER_COLUMN_SETTINGS.currency_in_header?.getProps,
+ );
+
+ const { options, onChange } = getProps(
+ createMockColumn(),
+ {},
+ onChangeSpy,
+ undefined,
+ jest.fn(),
+ ) as {
+ options: { value: boolean }[];
+ onChange: (value: boolean) => void;
+ };
onChange(options[0].value);
expect(onChangeSpy).toHaveBeenCalledWith(true);
diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.js b/frontend/src/metabase/visualizations/lib/settings/graph.ts
similarity index 87%
rename from frontend/src/metabase/visualizations/lib/settings/graph.js
rename to frontend/src/metabase/visualizations/lib/settings/graph.ts
index c7d6097493f..5b62b754ebf 100644
--- a/frontend/src/metabase/visualizations/lib/settings/graph.js
+++ b/frontend/src/metabase/visualizations/lib/settings/graph.ts
@@ -6,7 +6,10 @@ import {
getMaxDimensionsSupported,
getMaxMetricsSupported,
} from "metabase/visualizations";
-import { ChartSettingEnumToggle } from "metabase/visualizations/components/settings/ChartSettingEnumToggle";
+import {
+ ChartSettingEnumToggle,
+ type ChartSettingEnumToggleProps,
+} from "metabase/visualizations/components/settings/ChartSettingEnumToggle";
import { ChartSettingMaxCategories } from "metabase/visualizations/components/settings/ChartSettingMaxCategories";
import { ChartSettingSeriesOrder } from "metabase/visualizations/components/settings/ChartSettingSeriesOrder";
import { dimensionIsNumeric } from "metabase/visualizations/lib/numeric";
@@ -49,25 +52,40 @@ import {
isXAxisScaleValid,
isYAxisUnpinFromZeroValid,
} from "metabase/visualizations/shared/settings/cartesian-chart";
+import type {
+ ComputedVisualizationSettings,
+ VisualizationSettingsDefinitions,
+} from "metabase/visualizations/types";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
import { isNumeric } from "metabase-lib/v1/types/utils/isa";
+import type { Series, VisualizationDisplay } from "metabase-types/api";
-export const getSeriesDisplays = (transformedSeries, settings) => {
- return transformedSeries.map((single) => settings.series(single).display);
+export const getSeriesDisplays = (
+ transformedSeries: Series,
+ settings: ComputedVisualizationSettings,
+): VisualizationDisplay[] => {
+ return transformedSeries
+ .map((single) => settings.series?.(single).display)
+ .filter((display) => display != null);
};
-export function getDefaultDimensionLabel(multipleSeries) {
+export function getDefaultDimensionLabel(
+ multipleSeries: Series,
+): string | null | undefined {
return getDefaultXAxisTitle(multipleSeries[0]?.data.cols[0]);
}
-function canHaveDataLabels(series, vizSettings) {
+function canHaveDataLabels(
+ series: Series,
+ vizSettings: ComputedVisualizationSettings,
+) {
const areAllAreas = getSeriesDisplays(series, vizSettings).every(
(display) => display === "area",
);
return vizSettings["stackable.stack_type"] !== "normalized" || !areAllAreas;
}
-export const GRAPH_DATA_SETTINGS = {
+export const GRAPH_DATA_SETTINGS: VisualizationSettingsDefinitions = {
...columnSettings({
getColumns: ([
{
@@ -94,15 +112,15 @@ export const GRAPH_DATA_SETTINGS = {
if (dimensions.length === 0) {
const defaultDimensions = getDefaultDimensions(series, vizSettings);
return defaultDimensions.length === 0;
- } else {
- return getAreDimensionsAndMetricsValid(series, vizSettings);
}
+ return getAreDimensionsAndMetricsValid(series);
},
getDefault: (series, vizSettings) =>
getDefaultDimensions(series, vizSettings),
persistDefault: true,
getProps: ([{ card, data }], vizSettings) => {
- const addedDimensions = vizSettings["graph.dimensions"];
+ const addedDimensions = vizSettings["graph.dimensions"] ?? [];
+ const graphMetrics = vizSettings["graph.metrics"] ?? [];
const maxDimensionsSupported = getMaxDimensionsSupported(card.display);
const options = data.cols
.filter(getDefaultDimensionFilter(card.display))
@@ -112,10 +130,8 @@ export const GRAPH_DATA_SETTINGS = {
addAnother:
options.length > addedDimensions.length &&
addedDimensions.length < maxDimensionsSupported &&
- addedDimensions.every(
- (dimension) => dimension !== undefined && dimension !== null,
- ) &&
- vizSettings["graph.metrics"].length < 2
+ addedDimensions.every((dimension) => dimension != null) &&
+ graphMetrics.length < 2
? t`Add series breakout`
: null,
columns: data.cols,
@@ -154,7 +170,7 @@ export const GRAPH_DATA_SETTINGS = {
settings["graph.max_categories"] !== 0
? settings["graph.max_categories"]
: Infinity;
- const onOtherColorChange = (color) =>
+ const onOtherColorChange = (color: string) =>
onChangeSettings({ "graph.other_category_color": color });
return {
rawSeries,
@@ -198,9 +214,8 @@ export const GRAPH_DATA_SETTINGS = {
if (metrics.length === 0) {
const defaultMetrics = getDefaultMetrics(series, vizSettings);
return defaultMetrics.length === 0;
- } else {
- return getAreDimensionsAndMetricsValid(series, vizSettings);
}
+ return getAreDimensionsAndMetricsValid(series);
},
getDefault: (series, vizSettings) => getDefaultMetrics(series, vizSettings),
persistDefault: true,
@@ -209,8 +224,9 @@ export const GRAPH_DATA_SETTINGS = {
.filter(getDefaultMetricFilter(card.display))
.map(getOptionFromColumn);
- const addedMetrics = vizSettings["graph.metrics"];
- const hasBreakout = vizSettings["graph.dimensions"].length > 1;
+ const addedMetrics = vizSettings["graph.metrics"] ?? [];
+ const graphDimensions = vizSettings["graph.dimensions"] ?? [];
+ const hasBreakout = graphDimensions.length > 1;
const addedMetricsCount = addedMetrics.length;
const maxMetricsSupportedCount = getMaxMetricsSupported(card.display);
@@ -228,7 +244,7 @@ export const GRAPH_DATA_SETTINGS = {
showColumnSetting: true,
showColorPicker: !hasBreakout && card.display !== "waterfall",
colors: vizSettings["series_settings.colors"],
- series: extra.transformedSeries,
+ series: extra?.transformedSeries,
};
},
readDependencies: ["series_settings.colors"],
@@ -239,7 +255,7 @@ export const GRAPH_DATA_SETTINGS = {
...seriesSetting(),
};
-export const GRAPH_BUBBLE_SETTINGS = {
+export const GRAPH_BUBBLE_SETTINGS: VisualizationSettingsDefinitions = {
"scatter.bubble": {
get section() {
return t`Data`;
@@ -248,7 +264,7 @@ export const GRAPH_BUBBLE_SETTINGS = {
return t`Bubble size`;
},
widget: "field",
- isValid: (series, vizSettings) =>
+ isValid: (series) =>
series.some(({ card, data }) =>
columnsAreValid(
[card.visualization_settings["scatter.bubble"]],
@@ -256,8 +272,16 @@ export const GRAPH_BUBBLE_SETTINGS = {
isNumeric,
),
),
- getDefault: (series) => getDefaultColumns(series).bubble,
- getProps: ([{ card, data }], vizSettings, onChange) => {
+ getDefault: (series) => {
+ const defaultColumns = getDefaultColumns(series);
+
+ if ("bubble" in defaultColumns) {
+ return defaultColumns.bubble;
+ }
+
+ return undefined;
+ },
+ getProps: ([{ data }], vizSettings, onChange) => {
const options = data.cols.filter(isNumeric).map(getOptionFromColumn);
return {
options,
@@ -283,7 +307,7 @@ export const LINE_SETTINGS = {
},
};
-export const STACKABLE_SETTINGS = {
+export const STACKABLE_SETTINGS: VisualizationSettingsDefinitions = {
"stackable.stack_type": {
get section() {
return t`Display`;
@@ -319,14 +343,16 @@ export const STACKABLE_SETTINGS = {
return isStackingValueValid(settings, seriesDisplays);
},
- getDefault: ([{ card, data }], settings) => {
+ getDefault: ([{ card }], settings) => {
return getDefaultStackingValue(settings, card);
},
getHidden: (series, settings) => {
- const displays = series.map((single) => settings.series(single).display);
- const stackableDisplays = displays.filter((display) =>
- STACKABLE_SERIES_DISPLAY_TYPES.has(display),
+ const displays = series.map(
+ (single) => settings.series?.(single).display,
);
+ const stackableDisplays = displays.filter((display) => {
+ return display != null && STACKABLE_SERIES_DISPLAY_TYPES.has(display);
+ });
return stackableDisplays.length <= 1;
},
@@ -334,14 +360,14 @@ export const STACKABLE_SETTINGS = {
},
};
-export const LEGEND_SETTINGS = {
+export const LEGEND_SETTINGS: VisualizationSettingsDefinitions = {
"legend.is_reversed": {
getDefault: (_series, settings) => getDefaultLegendIsReversed(settings),
hidden: true,
},
};
-export const TOOLTIP_SETTINGS = {
+export const TOOLTIP_SETTINGS: VisualizationSettingsDefinitions = {
"graph.tooltip_type": {
getDefault: ([{ card }]) => {
const shouldShowComparisonTooltip = !["scatter", "waterfall"].includes(
@@ -368,15 +394,12 @@ export const TOOLTIP_SETTINGS = {
return getAvailableAdditionalColumns(rawSeries, vizSettings).length === 0;
},
getProps: (rawSeries, vizSettings) => {
- const isAggregatedChart = rawSeries[0].card.display !== "scatter";
- const options = getAvailableAdditionalColumns(
- rawSeries,
- vizSettings,
- isAggregatedChart,
- ).map((col) => ({
- label: col.display_name,
- value: getColumnKey(col),
- }));
+ const options = getAvailableAdditionalColumns(rawSeries, vizSettings).map(
+ (col) => ({
+ label: col.display_name,
+ value: getColumnKey(col),
+ }),
+ );
return {
options,
@@ -386,7 +409,7 @@ export const TOOLTIP_SETTINGS = {
},
};
-export const GRAPH_TREND_SETTINGS = {
+export const GRAPH_TREND_SETTINGS: VisualizationSettingsDefinitions = {
"graph.show_trendline": {
get section() {
return t`Display`;
@@ -398,11 +421,8 @@ export const GRAPH_TREND_SETTINGS = {
default: false,
getHidden: (series, vizSettings) => {
const { insights } = series[0].data;
- return (
- !insights ||
- insights.length === 0 ||
- vizSettings["graph.dimensions"].length > 1
- );
+ const graphDimensions = vizSettings["graph.dimensions"] ?? [];
+ return !insights || insights.length === 0 || graphDimensions.length > 1;
},
useRawSeries: true,
inline: true,
@@ -410,7 +430,7 @@ export const GRAPH_TREND_SETTINGS = {
},
};
-export const GRAPH_DISPLAY_VALUES_SETTINGS = {
+export const GRAPH_DISPLAY_VALUES_SETTINGS: VisualizationSettingsDefinitions = {
"graph.show_values": {
get section() {
return t`Display`;
@@ -554,7 +574,7 @@ export const GRAPH_DISPLAY_VALUES_SETTINGS = {
},
],
},
- getDefault: (series, vizSettings) => {
+ getDefault: (_series, vizSettings) => {
const columnSettings = vizSettings["column_settings"];
if (columnSettings) {
const hasNonDefaultCurrencyStyle = Object.values(columnSettings)
@@ -588,7 +608,7 @@ export const GRAPH_DISPLAY_VALUES_SETTINGS = {
// temporarily hiding the setting (metabase#50510)
default: Number.MAX_SAFE_INTEGER,
isValid: () => false,
- getProps: ([{ card }], settings) => {
+ getProps: (_series, settings) => {
return {
isEnabled: settings["graph.max_categories_enabled"],
aggregationFunction: settings["graph.other_category_aggregation_fn"],
@@ -606,7 +626,7 @@ export const GRAPH_DISPLAY_VALUES_SETTINGS = {
"graph.other_category_aggregation_fn": {
hidden: true,
getDefault: ([{ data }], settings) => {
- const [metricName] = settings["graph.metrics"];
+ const [metricName] = settings["graph.metrics"] ?? [];
const metric = data.cols.find((col) => col.name === metricName);
return metric?.aggregation_type ?? "sum";
},
@@ -614,44 +634,44 @@ export const GRAPH_DISPLAY_VALUES_SETTINGS = {
},
};
-export const GRAPH_COLORS_SETTINGS = {
+export const GRAPH_COLORS_SETTINGS: VisualizationSettingsDefinitions = {
// DEPRECATED: replaced with "color" series setting
"graph.colors": {},
};
-export const GRAPH_AXIS_SETTINGS = {
+export const GRAPH_AXIS_SETTINGS: VisualizationSettingsDefinitions = {
"graph.x_axis._is_timeseries": {
readDependencies: ["graph.dimensions"],
- getDefault: ([{ data }], vizSettings) =>
- dimensionIsTimeseries(
+ getDefault: ([{ data }], vizSettings) => {
+ const graphDimensions = vizSettings["graph.dimensions"] ?? [];
+ return dimensionIsTimeseries(
data,
_.findIndex(
data.cols,
- (c) => c.name === vizSettings["graph.dimensions"].filter((d) => d)[0],
+ (c) => c.name === graphDimensions.filter((d) => d)[0],
),
- ),
+ );
+ },
},
"graph.x_axis._is_numeric": {
readDependencies: ["graph.dimensions"],
getDefault: ([{ data }], vizSettings) => {
+ const graphDimensions = vizSettings["graph.dimensions"] ?? [];
return dimensionIsNumeric(
data,
_.findIndex(
data.cols,
- (c) => c.name === vizSettings["graph.dimensions"].filter((d) => d)[0],
+ (c) => c.name === graphDimensions.filter((d) => d)[0],
),
);
},
},
"graph.x_axis._is_histogram": {
- getDefault: (
- [
- {
- data: { cols },
- },
- ],
- vizSettings,
- ) => cols[0] && getDefaultIsHistogram(cols[0]),
+ getDefault: ([
+ {
+ data: { cols },
+ },
+ ]) => cols[0] && getDefaultIsHistogram(cols[0]),
},
"graph.x_axis.scale": {
get section() {
@@ -691,7 +711,7 @@ export const GRAPH_AXIS_SETTINGS = {
},
widget: "select",
default: "linear",
- getProps: (series, vizSettings) => ({
+ getProps: () => ({
options: [
{ name: t`Linear`, value: "linear" },
{ name: t`Power`, value: "pow" },
@@ -831,7 +851,7 @@ export const GRAPH_AXIS_SETTINGS = {
},
widget: "number",
default: 0,
- getHidden: (series, vizSettings) =>
+ getHidden: (_series, vizSettings) =>
vizSettings["graph.y_axis.auto_range"] !== false,
},
"graph.y_axis.max": {
@@ -893,7 +913,7 @@ export const GRAPH_AXIS_SETTINGS = {
return t`X-axis`;
},
widget: "input",
- getHidden: (series, vizSettings) =>
+ getHidden: (_series, vizSettings) =>
vizSettings["graph.x_axis.labels_enabled"] === false,
getDefault: getDefaultDimensionLabel,
getProps: (series) => ({
@@ -943,12 +963,12 @@ export const GRAPH_AXIS_SETTINGS = {
return t`Y-axis`;
},
widget: "input",
- getHidden: (series, vizSettings) =>
+ getHidden: (_series, vizSettings) =>
vizSettings["graph.y_axis.labels_enabled"] === false,
getDefault: (series, vizSettings) => {
// If there are multiple series, we check if the metric names match.
// If they do, we use that as the default y axis label.
- const [metric] = vizSettings["graph.metrics"];
+ const [metric] = vizSettings["graph.metrics"] ?? [];
const metricNames = series.map(({ data: { cols } }) => {
const metricCol = cols.find((c) => c.name === metric);
return metricCol && metricCol.display_name;
@@ -962,7 +982,9 @@ export const GRAPH_AXIS_SETTINGS = {
"graph.series_labels": {},
};
-export const BOXPLOT_SETTINGS = {
+export const BOXPLOT_SETTINGS: VisualizationSettingsDefinitions<
+ ChartSettingEnumToggleProps<"fit" | "all">
+> = {
"boxplot.whisker_type": {
get section() {
return t`Display`;
@@ -1110,7 +1132,7 @@ export const BOXPLOT_SETTINGS = {
},
};
-export const BOXPLOT_DATA_SETTINGS = {
+export const BOXPLOT_DATA_SETTINGS: VisualizationSettingsDefinitions = {
...GRAPH_DATA_SETTINGS,
"graph.dimensions": {
...GRAPH_DATA_SETTINGS["graph.dimensions"],
diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.unit.spec.js b/frontend/src/metabase/visualizations/lib/settings/graph.unit.spec.ts
similarity index 67%
rename from frontend/src/metabase/visualizations/lib/settings/graph.unit.spec.js
rename to frontend/src/metabase/visualizations/lib/settings/graph.unit.spec.ts
index 8fa3b717e1f..9741994ce4b 100644
--- a/frontend/src/metabase/visualizations/lib/settings/graph.unit.spec.js
+++ b/frontend/src/metabase/visualizations/lib/settings/graph.unit.spec.ts
@@ -1,8 +1,11 @@
+import { checkNotNull } from "metabase/lib/types";
+import type { VisualizationDisplay } from "metabase-types/api";
import {
createMockCard,
createMockColumn,
createMockDataset,
createMockDatasetData,
+ createMockInsight,
createMockSingleSeries,
} from "metabase-types/api/mocks";
@@ -18,55 +21,71 @@ import {
describe("STACKABLE_SETTINGS", () => {
describe("stackable.stack_type", () => {
describe("getDefault", () => {
- const getDefault = STACKABLE_SETTINGS["stackable.stack_type"].getDefault;
+ const getDefault = checkNotNull(
+ STACKABLE_SETTINGS["stackable.stack_type"]?.getDefault,
+ );
it("should return stacked if area chart has more than 1 metric", () => {
- const value = getDefault([{ card: { display: "area" } }], {
- "graph.metrics": ["foo", "bar"],
- "graph.dimensions": [],
- });
+ const value = getDefault(
+ [createMockSingleSeries({ display: "area" })],
+ {
+ "graph.metrics": ["foo", "bar"],
+ "graph.dimensions": [],
+ },
+ );
expect(value).toBe("stacked");
});
it("should return stacked if area chart has more than 1 dimension", () => {
- const value = getDefault([{ card: { display: "area" } }], {
- "graph.metrics": [],
- "graph.dimensions": ["foo", "bar"],
- });
+ const value = getDefault(
+ [createMockSingleSeries({ display: "area" })],
+ {
+ "graph.metrics": [],
+ "graph.dimensions": ["foo", "bar"],
+ },
+ );
expect(value).toBe("stacked");
});
it("should return null if area chart has 1 metric and 1 dimension", () => {
- const value = getDefault([{ card: { display: "area" } }], {
- "graph.metrics": ["foo"],
- "graph.dimensions": ["bar"],
- });
+ const value = getDefault(
+ [createMockSingleSeries({ display: "area" })],
+ {
+ "graph.metrics": ["foo"],
+ "graph.dimensions": ["bar"],
+ },
+ );
expect(value).toBeNull();
});
it("should return the legacy 'stackable.stacked' value if present", () => {
- const value = getDefault([{ card: { display: "area" } }], {
- "stackable.stacked": "normalized",
- "graph.metrics": ["foo", "bar"],
- "graph.dimensions": ["bar"],
- });
+ const value = getDefault(
+ [createMockSingleSeries({ display: "area" })],
+ {
+ "stackable.stacked": "normalized",
+ "graph.metrics": ["foo", "bar"],
+ "graph.dimensions": ["bar"],
+ },
+ );
expect(value).toBe("normalized");
});
});
describe("isValid", () => {
- const isValid = STACKABLE_SETTINGS["stackable.stack_type"].isValid;
+ const isValid = checkNotNull(
+ STACKABLE_SETTINGS["stackable.stack_type"]?.isValid,
+ );
it("should be valid even on cards with display=line when there are stackable series (metabase#45182)", () => {
const result = isValid(
[
- { card: { display: "line" }, id: 1 },
- { card: { display: "line" }, id: 2 },
- { card: { display: "line" }, id: 3 },
+ createMockSingleSeries({ id: 1, display: "line" }),
+ createMockSingleSeries({ id: 2, display: "line" }),
+ createMockSingleSeries({ id: 3, display: "line" }),
],
{
series: (series) => ({
@@ -83,9 +102,9 @@ describe("STACKABLE_SETTINGS", () => {
it("should not be valid when there is less than two stackable series", () => {
const result = isValid(
[
- { card: { display: "bar" }, id: 1 },
- { card: { display: "bar" }, id: 2 },
- { card: { display: "bar" }, id: 3 },
+ createMockSingleSeries({ id: 1, display: "bar" }),
+ createMockSingleSeries({ id: 2, display: "bar" }),
+ createMockSingleSeries({ id: 3, display: "bar" }),
],
{
series: (series) => ({
@@ -144,35 +163,36 @@ describe("GRAPH_AXIS_SETTINGS", () => {
describe("graph.y_axis.unpin_from_zero", () => {
it.each([
{
- display: "scatter",
+ display: "scatter" as const,
expectedHidden: false,
},
{
- display: "line",
+ display: "line" as const,
expectedHidden: false,
},
{
- display: "area",
+ display: "area" as const,
expectedHidden: true,
},
{
- display: "bar",
+ display: "bar" as const,
expectedHidden: true,
},
{
- display: "combo",
+ display: "combo" as const,
expectedHidden: false,
},
{
- display: "waterfall",
+ display: "waterfall" as const,
expectedHidden: true,
},
])(
"should be visible on all display types except waterfall",
({ display, expectedHidden }) => {
- const isHidden = GRAPH_AXIS_SETTINGS[
- "graph.y_axis.unpin_from_zero"
- ].getHidden([{ card: { display } }], {
+ const getHidden = checkNotNull(
+ GRAPH_AXIS_SETTINGS["graph.y_axis.unpin_from_zero"]?.getHidden,
+ );
+ const isHidden = getHidden([createMockSingleSeries({ display })], {
"graph.metrics": ["foo"],
"graph.dimensions": ["bar"],
"graph.y_axis.auto_range": true,
@@ -183,52 +203,61 @@ describe("GRAPH_AXIS_SETTINGS", () => {
);
it("should be hidden when auto_range is disabled", () => {
- const isHidden = GRAPH_AXIS_SETTINGS[
- "graph.y_axis.unpin_from_zero"
- ].getHidden([{ card: { display: "line" } }], {
- "graph.metrics": ["foo"],
- "graph.dimensions": ["bar"],
- "graph.y_axis.auto_range": false,
- series: () => ({ display: "line" }),
- });
+ const getHidden = checkNotNull(
+ GRAPH_AXIS_SETTINGS["graph.y_axis.unpin_from_zero"]?.getHidden,
+ );
+ const isHidden = getHidden(
+ [createMockSingleSeries({ display: "line" })],
+ {
+ "graph.metrics": ["foo"],
+ "graph.dimensions": ["bar"],
+ "graph.y_axis.auto_range": false,
+ series: () => ({ display: "line" }),
+ },
+ );
expect(isHidden).toBe(true);
});
it("should be hidden when line visualization has overriding series display settings", () => {
- const isHidden = GRAPH_AXIS_SETTINGS[
- "graph.y_axis.unpin_from_zero"
- ].getHidden([{ card: { display: "line" } }], {
- "graph.metrics": ["foo"],
- "graph.dimensions": ["bar"],
- "graph.y_axis.auto_range": false,
- series: () => ({ display: "bar" }),
- });
+ const getHidden = checkNotNull(
+ GRAPH_AXIS_SETTINGS["graph.y_axis.unpin_from_zero"]?.getHidden,
+ );
+ const isHidden = getHidden(
+ [createMockSingleSeries({ display: "line" })],
+ {
+ "graph.metrics": ["foo"],
+ "graph.dimensions": ["bar"],
+ "graph.y_axis.auto_range": false,
+ series: () => ({ display: "bar" }),
+ },
+ );
expect(isHidden).toBe(true);
});
it.each([
{
- display: "scatter",
+ display: "scatter" as const,
expectedDefault: true,
},
{
- display: "line",
+ display: "line" as const,
expectedDefault: false,
},
{
- display: "bar",
+ display: "bar" as const,
expectedDefault: false,
},
{
- display: "combo",
+ display: "combo" as const,
expectedDefault: false,
},
])(
"should be enabled by default on scatter charts",
({ display, expectedDefault }) => {
- const isEnabled = GRAPH_AXIS_SETTINGS[
- "graph.y_axis.unpin_from_zero"
- ].getDefault([{ card: { display } }], {
+ const getDefault = checkNotNull(
+ GRAPH_AXIS_SETTINGS["graph.y_axis.unpin_from_zero"]?.getDefault,
+ );
+ const isEnabled = getDefault([createMockSingleSeries({ display })], {
"graph.metrics": ["foo"],
"graph.dimensions": ["bar"],
"graph.y_axis.auto_range": true,
@@ -242,11 +271,25 @@ describe("GRAPH_AXIS_SETTINGS", () => {
describe("GRAPH_TREND_SETTINGS", () => {
describe("graph.show_trendline", () => {
- const getHidden = GRAPH_TREND_SETTINGS["graph.show_trendline"].getHidden;
+ const getHidden = checkNotNull(
+ GRAPH_TREND_SETTINGS["graph.show_trendline"]?.getHidden,
+ );
it("should be hidden on cards with multiple dimensions", () => {
const isHidden = getHidden(
- [{ card: { display: "area" }, data: { insights: ["FOO", "BAR"] } }],
+ [
+ createMockSingleSeries(
+ { display: "area" },
+ {
+ data: createMockDatasetData({
+ insights: [
+ createMockInsight({ col: "FOO" }),
+ createMockInsight({ col: "BAR" }),
+ ],
+ }),
+ },
+ ),
+ ],
{
series: (series) => ({ display: series.card.display }),
"graph.dimensions": ["FOO", "BAR"],
@@ -260,8 +303,9 @@ describe("GRAPH_TREND_SETTINGS", () => {
describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
describe("graph.label_value_formatting", () => {
- const getDefault =
- GRAPH_DISPLAY_VALUES_SETTINGS["graph.label_value_formatting"].getDefault;
+ const getDefault = checkNotNull(
+ GRAPH_DISPLAY_VALUES_SETTINGS["graph.label_value_formatting"]?.getDefault,
+ );
it("should default to an adapted value if there are currency styled columns", () => {
expect(getDefault([], {})).toBe("auto");
@@ -269,7 +313,7 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
expect(
getDefault([], {
column_settings: {
- foo: { currency_style: "USD" },
+ foo: { currency_style: "code" },
},
}),
).toBe("auto");
@@ -309,12 +353,16 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
});
describe("graph.show_values", () => {
- const getHidden =
- GRAPH_DISPLAY_VALUES_SETTINGS["graph.show_values"].getHidden;
+ const getHidden = checkNotNull(
+ GRAPH_DISPLAY_VALUES_SETTINGS["graph.show_values"]?.getHidden,
+ );
it("should be hidden on normalized area charts", () => {
const isHidden = getHidden(
- [{ card: { display: "area" } }, { card: { display: "area" } }],
+ [
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
+ ],
{
series: (series) => ({ display: series.card.display }),
"stackable.stack_type": "normalized",
@@ -327,9 +375,9 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should not be hidden on normalized charts with line series", () => {
const isHidden = getHidden(
[
- { card: { display: "area" } },
- { card: { display: "area" } },
- { card: { display: "line" } },
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "line" }),
],
{
series: (series) => ({ display: series.card.display }),
@@ -342,15 +390,16 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
});
describe("graph.label_value_frequency", () => {
- const getHidden =
- GRAPH_DISPLAY_VALUES_SETTINGS["graph.label_value_frequency"].getHidden;
+ const getHidden = checkNotNull(
+ GRAPH_DISPLAY_VALUES_SETTINGS["graph.label_value_frequency"]?.getHidden,
+ );
it("should be hidden when data values are hidden", () => {
const isHidden = getHidden(
[
- { card: { display: "line" } },
- { card: { display: "area" } },
- { card: { display: "bar" } },
+ createMockSingleSeries({ display: "line" }),
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "bar" }),
],
{
series: (series) => ({ display: series.card.display }),
@@ -364,9 +413,9 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should be hidden on normalized charts without line series", () => {
const isHidden = getHidden(
[
- { card: { display: "area" } },
- { card: { display: "area" } },
- { card: { display: "bar" } },
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "bar" }),
],
{
series: (series) => ({ display: series.card.display }),
@@ -380,9 +429,9 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should be hidden on normalized area charts", () => {
const isHidden = getHidden(
[
- { card: { display: "area" } },
- { card: { display: "area" } },
- { card: { display: "area" } },
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
],
{
series: (series) => ({ display: series.card.display }),
@@ -396,9 +445,9 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should be hidden on normalized bar charts", () => {
const isHidden = getHidden(
[
- { card: { display: "bar" } },
- { card: { display: "bar" } },
- { card: { display: "bar" } },
+ createMockSingleSeries({ display: "bar" }),
+ createMockSingleSeries({ display: "bar" }),
+ createMockSingleSeries({ display: "bar" }),
],
{
series: (series) => ({ display: series.card.display }),
@@ -412,9 +461,9 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should not be hidden on normalized charts with line series", () => {
const isHidden = getHidden(
[
- { card: { display: "area" } },
- { card: { display: "area" } },
- { card: { display: "line" } },
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "line" }),
],
{
series: (series) => ({ display: series.card.display }),
@@ -428,12 +477,16 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
});
describe("graph.show_stack_values", () => {
- const getHidden =
- GRAPH_DISPLAY_VALUES_SETTINGS["graph.show_stack_values"].getHidden;
+ const getHidden = checkNotNull(
+ GRAPH_DISPLAY_VALUES_SETTINGS["graph.show_stack_values"]?.getHidden,
+ );
it("should be hidden on non-stacked charts", () => {
const isHidden = getHidden(
- [{ card: { display: "bar" } }, { card: { display: "bar" } }],
+ [
+ createMockSingleSeries({ display: "bar" }),
+ createMockSingleSeries({ display: "bar" }),
+ ],
{
series: (series) => ({ display: series.card.display }),
"stackable.stack_type": null,
@@ -446,7 +499,10 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should be hidden on stacked area charts", () => {
const isHidden = getHidden(
- [{ card: { display: "area" } }, { card: { display: "area" } }],
+ [
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
+ ],
{
series: (series) => ({ display: series.card.display }),
"stackable.stack_type": "stacked",
@@ -460,10 +516,10 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should not be hidden on mixed stacked area and bar charts", () => {
const isHidden = getHidden(
[
- { card: { display: "area" } },
- { card: { display: "area" } },
- { card: { display: "bar" } },
- { card: { display: "bar" } },
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "area" }),
+ createMockSingleSeries({ display: "bar" }),
+ createMockSingleSeries({ display: "bar" }),
],
{
series: (series) => ({ display: series.card.display }),
@@ -477,7 +533,10 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should be hidden on normalized charts bar charts", () => {
const isHidden = getHidden(
- [{ card: { display: "bar" } }, { card: { display: "bar" } }],
+ [
+ createMockSingleSeries({ display: "bar" }),
+ createMockSingleSeries({ display: "bar" }),
+ ],
{
series: (series) => ({ display: series.card.display }),
"stackable.stack_type": "normalized",
@@ -490,7 +549,10 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
it("should be hidden on stacked bar charts when show values setting is false", () => {
const isHidden = getHidden(
- [{ card: { display: "bar" } }, { card: { display: "bar" } }],
+ [
+ createMockSingleSeries({ display: "bar" }),
+ createMockSingleSeries({ display: "bar" }),
+ ],
{
series: (series) => ({ display: series.card.display }),
"stackable.stack_type": "stacked",
@@ -504,25 +566,33 @@ describe("GRAPH_DISPLAY_VALUES_SETTINGS", () => {
});
describe("graph.tooltip_columns", () => {
- const tooltipColumnsSetting = TOOLTIP_SETTINGS["graph.tooltip_columns"];
+ const getHidden = checkNotNull(
+ TOOLTIP_SETTINGS["graph.tooltip_columns"]?.getHidden,
+ );
+ const getValue = checkNotNull(
+ TOOLTIP_SETTINGS["graph.tooltip_columns"]?.getValue,
+ );
+ const getProps = checkNotNull(
+ TOOLTIP_SETTINGS["graph.tooltip_columns"]?.getProps,
+ );
describe("getHidden", () => {
it("should be hidden when there are no available additional columns", () => {
const mockSeries = [
createMockSingleSeries(
- createMockCard(),
- createMockDataset({
+ {},
+ {
data: createMockDatasetData({
cols: [
createMockColumn({ name: "dim", base_type: "type/Text" }),
createMockColumn({ name: "metric", base_type: "type/Number" }),
],
}),
- }),
+ },
),
];
- const isHidden = tooltipColumnsSetting.getHidden(mockSeries, {
+ const isHidden = getHidden(mockSeries, {
"graph.tooltip_type": "series_comparison",
"graph.dimensions": ["dim"],
"graph.metrics": ["metric"],
@@ -547,7 +617,7 @@ describe("graph.tooltip_columns", () => {
),
];
- const isHidden = tooltipColumnsSetting.getHidden(mockSeries, {
+ const isHidden = getHidden(mockSeries, {
"graph.tooltip_type": "series_comparison",
"graph.dimensions": ["dim"],
"graph.metrics": ["metric1"],
@@ -557,7 +627,7 @@ describe("graph.tooltip_columns", () => {
});
describe("getValue", () => {
- const getMockSeries = (display) => [
+ const getMockSeries = (display: VisualizationDisplay) => [
createMockSingleSeries(
createMockCard({ display }),
createMockDataset({
@@ -587,7 +657,7 @@ describe("graph.tooltip_columns", () => {
];
it("should return all available columns on scatter charts by default", () => {
- const value = tooltipColumnsSetting.getValue(getMockSeries("scatter"), {
+ const value = getValue(getMockSeries("scatter"), {
"graph.tooltip_type": "series_comparison",
"graph.dimensions": ["dim"],
"graph.metrics": ["metric1"],
@@ -601,7 +671,7 @@ describe("graph.tooltip_columns", () => {
});
it("should return no additional columns by default", () => {
- const value = tooltipColumnsSetting.getValue(getMockSeries("line"), {
+ const value = getValue(getMockSeries("line"), {
"graph.tooltip_type": "series_comparison",
"graph.dimensions": ["dim"],
"graph.metrics": ["metric1"],
@@ -637,14 +707,20 @@ describe("graph.tooltip_columns", () => {
),
];
- const props = tooltipColumnsSetting.getProps(mockSeries, {
- "graph.dimensions": ["dim"],
- "graph.metrics": ["metric1"],
- });
+ const props = getProps(
+ mockSeries,
+ {
+ "graph.dimensions": ["dim"],
+ "graph.metrics": ["metric1"],
+ },
+ jest.fn(),
+ undefined,
+ jest.fn(),
+ );
- expect(props.options).toEqual([
- { label: "Metric 2", value: '["name","metric2"]' },
- ]);
+ expect(props).toMatchObject({
+ options: [{ label: "Metric 2", value: '["name","metric2"]' }],
+ });
});
});
});
diff --git a/frontend/src/metabase/visualizations/lib/settings/nested.js b/frontend/src/metabase/visualizations/lib/settings/nested.js
deleted file mode 100644
index 31c14f168c3..00000000000
--- a/frontend/src/metabase/visualizations/lib/settings/nested.js
+++ /dev/null
@@ -1,137 +0,0 @@
-import { t } from "ttag";
-import _ from "underscore";
-
-import { chartSettingNestedSettings } from "metabase/visualizations/components/settings/ChartSettingNestedSettings";
-
-import { getComputedSettings, getSettingsWidgets } from "../settings";
-
-export function nestedSettings(
- id,
- {
- objectName = "object",
- getObjects,
- getObjectKey,
- getObjectSettings,
- getSettingDefinitionsForObject,
- getInheritedSettingsForObject = () => ({}),
- component,
- ...def
- } = {},
-) {
- function getComputedSettingsForObject(series, object, storedSettings, extra) {
- const settingsDefs = getSettingDefinitionsForObject(series, object);
- const inheritedSettings = getInheritedSettingsForObject(object);
- const computedSettings = getComputedSettings(
- settingsDefs,
- object,
- { ...inheritedSettings, ...storedSettings },
- extra,
- );
- // remove undefined settings since they override other settings when merging object
- return _.pick(computedSettings, (value) => value !== undefined);
- }
-
- function getComputedSettingsForAllObjects(
- series,
- objects,
- allStoredSettings,
- extra,
- ) {
- const allComputedSettings = {};
- for (const object of objects) {
- const key = getObjectKey(object);
- allComputedSettings[key] = getComputedSettingsForObject(
- series,
- object,
- getObjectSettings(allStoredSettings, object) ?? {},
- extra,
- );
- }
- return allComputedSettings;
- }
-
- function getSettingsWidgetsForObject(
- series,
- object,
- storedSettings,
- onChangeSettings,
- extra,
- ) {
- const settingsDefs = getSettingDefinitionsForObject(series, object);
- const computedSettings = getComputedSettingsForObject(
- series,
- object,
- storedSettings,
- extra,
- );
- const widgets = getSettingsWidgets(
- settingsDefs,
- storedSettings,
- computedSettings,
- object,
- onChangeSettings,
- extra,
- );
- return widgets.map((widget) => ({ ...widget, noPadding: true }));
- }
-
- // decorate with nested settings HOC
- const widget = chartSettingNestedSettings({
- getObjectKey,
- getObjectSettings,
- getSettingsWidgetsForObject,
- })(component);
-
- return {
- [id]: {
- section: t`Display`,
- default: {},
- getProps: (series, settings, onChange, extra) => {
- const objects = getObjects(series, settings);
- const allComputedSettings = getComputedSettingsForAllObjects(
- series,
- objects,
- settings[id],
- { series, settings, ...extra },
- );
- return {
- series,
- settings,
- objects,
- allComputedSettings,
- extra: { series, settings },
- ...def.getExtraProps?.(series, settings, onChange, extra),
- ...extra,
- };
- },
- widget,
- ...def,
- },
- [objectName]: {
- getDefault(series, settings, extra) {
- const cache = new Map();
- return (object) => {
- const key = getObjectKey(object);
- if (!cache.has(key)) {
- const inheritedSettings = getInheritedSettingsForObject(object);
- const storedSettings =
- getObjectSettings(settings[id], object) ?? {};
- cache.set(key, {
- ...getComputedSettingsForObject(
- series,
- object,
- {
- ...inheritedSettings,
- ...storedSettings,
- },
- { series, settings, ...extra },
- ),
- });
- }
- return cache.get(key);
- };
- },
- readDependencies: [id],
- },
- };
-}
diff --git a/frontend/src/metabase/visualizations/lib/settings/nested.ts b/frontend/src/metabase/visualizations/lib/settings/nested.ts
new file mode 100644
index 00000000000..6c695e12fcd
--- /dev/null
+++ b/frontend/src/metabase/visualizations/lib/settings/nested.ts
@@ -0,0 +1,206 @@
+import type { ComponentType } from "react";
+import { t } from "ttag";
+import _ from "underscore";
+
+import { checkNotNull } from "metabase/lib/types";
+import type { ChartNestedSettingSeriesProps } from "metabase/visualizations/components/settings/ChartNestedSettingSeries";
+import { chartSettingNestedSettings } from "metabase/visualizations/components/settings/ChartSettingNestedSettings";
+import type {
+ ComputedVisualizationSettings,
+ SeriesSettingDefinition,
+ SettingsExtra,
+ VisualizationSettingDefinition,
+ VisualizationSettingsDefinitions,
+} from "metabase/visualizations/types";
+import type { Series, VisualizationSettings } from "metabase-types/api";
+
+import { getComputedSettings, getSettingsWidgets } from "../settings";
+
+export type NestedSettingsOptions<
+ T,
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = Omit<VisualizationSettingDefinition<T, TValue, TProps>, "getHidden"> & {
+ objectName?: string;
+ getHidden?: (
+ object: Series,
+ settings: VisualizationSettings,
+ extra?: SettingsExtra,
+ ) => boolean;
+ getObjects?: (series: Series, settings: VisualizationSettings) => T[];
+ getObjectKey: (object: T) => string;
+ getObjectSettings?: (
+ allStoredSettings: VisualizationSettings,
+ object: T,
+ ) => VisualizationSettings | undefined;
+ getSettingDefinitionsForObject?: (
+ series: Series,
+ object: T,
+ ) => VisualizationSettingsDefinitions;
+ getInheritedSettingsForObject?: (object: T) => VisualizationSettings;
+ component?: React.ComponentType<ChartNestedSettingSeriesProps>;
+ getExtraProps?: (
+ series: Series,
+ settings: VisualizationSettings,
+ onChange: (value: TValue) => void,
+ extra?: SettingsExtra,
+ ) => Record<string, unknown>;
+};
+
+export function nestedSettings<
+ Key extends Exclude<
+ keyof VisualizationSettingsDefinitions,
+ number // TS infers number because of `[key: string]: any` in VisualizationSettingsDefinitions
+ >,
+ T,
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+>(
+ id: Key,
+ {
+ objectName = "object",
+ getObjects = () => [],
+ getObjectKey,
+ getObjectSettings = () => ({}),
+ getSettingDefinitionsForObject = () => ({}),
+ getInheritedSettingsForObject = () => ({}),
+ component,
+ widget: widgetProp,
+ ...def
+ }: NestedSettingsOptions<T, TValue, TProps>,
+): VisualizationSettingsDefinitions {
+ function getComputedSettingsForObject(
+ series: Series,
+ object: T,
+ storedSettings: VisualizationSettings,
+ extra: SettingsExtra,
+ ): ComputedVisualizationSettings {
+ const settingsDefs = getSettingDefinitionsForObject(series, object);
+ const inheritedSettings = getInheritedSettingsForObject(object);
+ const computedSettings = getComputedSettings(
+ settingsDefs,
+ object,
+ { ...inheritedSettings, ...storedSettings },
+ extra,
+ );
+ // remove undefined settings since they override other settings when merging object
+ return _.pick(computedSettings, (value) => value !== undefined);
+ }
+
+ function getComputedSettingsForAllObjects(
+ series: Series,
+ objects: T[],
+ allStoredSettings: VisualizationSettings,
+ extra: SettingsExtra,
+ ): Record<string, ComputedVisualizationSettings> {
+ const allComputedSettings: Record<string, ComputedVisualizationSettings> =
+ {};
+
+ for (const object of objects) {
+ const key = getObjectKey(object);
+ allComputedSettings[key] = getComputedSettingsForObject(
+ series,
+ object,
+ getObjectSettings(allStoredSettings, object) ?? {},
+ extra,
+ );
+ }
+
+ return allComputedSettings;
+ }
+
+ function getSettingsWidgetsForObject(
+ series: Series,
+ object: T,
+ storedSettings: VisualizationSettings,
+ onChangeSettings: (newSettings: Partial<VisualizationSettings>) => void,
+ extra: SettingsExtra,
+ ) {
+ const settingsDefs = getSettingDefinitionsForObject(series, object);
+ const computedSettings = getComputedSettingsForObject(
+ series,
+ object,
+ storedSettings,
+ extra,
+ );
+ const widgets = getSettingsWidgets(
+ settingsDefs,
+ storedSettings,
+ computedSettings,
+ object,
+ onChangeSettings,
+ extra,
+ );
+ return widgets.map((widget) => ({ ...widget, noPadding: true }));
+ }
+
+ // decorate with nested settings HOC
+ const defaultWidget: ComponentType<TProps & { id: string }> | undefined =
+ component
+ ? chartSettingNestedSettings({
+ getObjectKey,
+ getObjectSettings,
+ getSettingsWidgetsForObject,
+ })(component)
+ : undefined;
+ // either "component" or "widget" prop needs to be passed
+ const widget = checkNotNull(widgetProp ?? defaultWidget);
+
+ type Value = VisualizationSettingsDefinitions[Key];
+
+ const idDef: SeriesSettingDefinition<Value, TProps & { id: string }> = {
+ section: t`Display`,
+ default: {},
+ getProps: (series, settings, onChange, extra) => {
+ const objects = getObjects(series, settings);
+ const allComputedSettings = getComputedSettingsForAllObjects(
+ series,
+ objects,
+ settings[id],
+ { series, settings, ...extra },
+ );
+ return {
+ series,
+ settings,
+ objects,
+ allComputedSettings,
+ extra: { series, settings },
+ ...(def.getExtraProps?.(series, settings, onChange, extra) ?? {}),
+ ...extra,
+ };
+ },
+ widget,
+ ...def,
+ } as SeriesSettingDefinition<Value, TProps & { id: string }>;
+
+ const objectDef: SeriesSettingDefinition = {
+ getDefault(series, settings, extra) {
+ const cache = new Map<string, VisualizationSettings>();
+ return (object: T) => {
+ const key = getObjectKey(object);
+ if (!cache.has(key)) {
+ const inheritedSettings = getInheritedSettingsForObject(object);
+ const storedSettings = getObjectSettings(settings[id], object) ?? {};
+ cache.set(key, {
+ ...getComputedSettingsForObject(
+ series,
+ object,
+ {
+ ...inheritedSettings,
+ ...storedSettings,
+ },
+ { series, settings, ...extra },
+ ),
+ });
+ }
+ return cache.get(key);
+ };
+ },
+ readDependencies: [id],
+ };
+
+ return {
+ [id]: idDef,
+ [objectName]: objectDef,
+ };
+}
diff --git a/frontend/src/metabase/visualizations/lib/settings/nested.unit.spec.js b/frontend/src/metabase/visualizations/lib/settings/nested.unit.spec.ts
similarity index 57%
rename from frontend/src/metabase/visualizations/lib/settings/nested.unit.spec.js
rename to frontend/src/metabase/visualizations/lib/settings/nested.unit.spec.ts
index 046f0f684c8..d42fb1e309e 100644
--- a/frontend/src/metabase/visualizations/lib/settings/nested.unit.spec.js
+++ b/frontend/src/metabase/visualizations/lib/settings/nested.unit.spec.ts
@@ -3,25 +3,28 @@ import { nestedSettings } from "metabase/visualizations/lib/settings/nested";
describe("nestedSettings", () => {
it("should add a nested setting function to settings", () => {
- const defs = {
- ...nestedSettings("nested_settings", {
+ const defs = nestedSettings<"nested_settings", number | null>(
+ "nested_settings",
+ {
objectName: "nested",
getObjects: () => [1, 2, 3],
getObjectKey: (object) => String(object),
- getObjectSettings: (objects, key) => objects[key],
+ getObjectSettings: (objects, key) => objects[String(key)],
getSettingDefinitionsForObject: () => ({
- foo: { getDefault: (object) => `foo${object}` },
+ foo: {
+ getDefault: (object: string) => `foo${object}`,
+ },
}),
- }),
- };
+ component: () => null,
+ },
+ );
const stored = { nested_settings: { 1: { foo: "bar" } } };
const settings = getComputedSettings(defs, null, stored);
- expect(settings.nested(1)).toEqual({ foo: "bar" });
- expect(settings.nested(2)).toEqual({ foo: "foo2" });
- delete settings.nested;
- expect(settings).toEqual({
- nested: undefined,
+ expect(settings.nested?.(1)).toEqual({ foo: "bar" });
+ expect(settings.nested?.(2)).toEqual({ foo: "foo2" });
+
+ expect(settings).toMatchObject({
nested_settings: { 1: { foo: "bar" } },
});
});
diff --git a/frontend/src/metabase/visualizations/lib/settings/series.js b/frontend/src/metabase/visualizations/lib/settings/series.ts
similarity index 51%
rename from frontend/src/metabase/visualizations/lib/settings/series.js
rename to frontend/src/metabase/visualizations/lib/settings/series.ts
index e223e5ffc09..16edcc6b4c6 100644
--- a/frontend/src/metabase/visualizations/lib/settings/series.js
+++ b/frontend/src/metabase/visualizations/lib/settings/series.ts
@@ -3,6 +3,7 @@ import { t } from "ttag";
import ChartNestedSettingSeries from "metabase/visualizations/components/settings/ChartNestedSettingSeries";
import { OTHER_DATA_KEY } from "metabase/visualizations/echarts/cartesian/constants/dataset";
+import type { LegacySeriesSettingsObjectKey } from "metabase/visualizations/echarts/cartesian/model/types";
import {
SERIES_COLORS_SETTING_KEY,
SERIES_SETTING_KEY,
@@ -16,28 +17,59 @@ import {
getSeriesDefaultShowSeriesTrendline,
getSeriesDefaultShowSeriesValues,
} from "metabase/visualizations/shared/settings/series";
+import type { VisualizationSettingsDefinitions } from "metabase/visualizations/types";
+import type {
+ Card,
+ Series,
+ SingleSeries,
+ VisualizationSettings,
+} from "metabase-types/api";
import { getNameForCard } from "../series";
-import { nestedSettings } from "./nested";
+import { type NestedSettingsOptions, nestedSettings } from "./nested";
-export function keyForSingleSeries(single) {
- // _seriesKey is sometimes set by transformSeries
- return single.card._seriesKey || String(single.card.name);
+export function keyForSingleSeries(single: SingleSeries): string {
+ if (isLegacySeriesCard(single.card)) {
+ // _seriesKey is sometimes set by transformSeries
+ return single.card._seriesKey || String(single.card.name);
+ }
+
+ return String(single.card.name);
+}
+
+function hasSingleSeriesKey(single: SingleSeries): boolean {
+ if (isLegacySeriesCard(single.card)) {
+ return Boolean(single.card._seriesKey || single.card.name);
+ }
+
+ return Boolean(single.card.name);
}
-function hasSingleSeriesKey(single) {
- return Boolean(single.card._seriesKey || single.card.name);
+function isLegacySeriesCard(
+ card: Card,
+): card is Card & LegacySeriesSettingsObjectKey["card"] {
+ return "_seriesKey" in card;
}
const LINE_DISPLAY_TYPES = new Set(["line", "area"]);
-export function seriesSetting({ readDependencies = [], def } = {}) {
- const COMMON_SETTINGS = {
+export interface SeriesSettingOptions {
+ readDependencies?: string[];
+ def?: Partial<NestedSettingsOptions<SingleSeries>>;
+}
+
+export function seriesSetting({
+ readDependencies = [],
+ def = {},
+}: SeriesSettingOptions = {}): VisualizationSettingsDefinitions {
+ const COMMON_SETTINGS: VisualizationSettingsDefinitions = {
// title, and color don't need widgets because they're handled directly in ChartNestedSettingSeries
title: {
- getDefault: (single, settings, { series, settings: vizSettings }) => {
- const legacyTitles = vizSettings["graph.series_labels"];
+ getDefault: (single, _settings, extra = {}) => {
+ const { series = [], settings: vizSettings = {} } = extra;
+ const legacyTitles: string[] | undefined =
+ vizSettings["graph.series_labels"];
if (legacyTitles) {
const index = series.indexOf(single); // TODO: pass in series index so we don't have to search for it
if (index >= 0 && index < legacyTitles.length) {
@@ -57,23 +89,18 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
{ value: "bar", icon: "bar" },
],
},
- getHidden: (single, settings, { series }) => {
- return (
- !["line", "area", "bar", "combo"].includes(single.card.display) ||
- settings["stackable.stack_type"] != null
- );
- },
-
- getDefault: (single, settings, { series }) => {
+ getHidden: (single, settings, _extra) =>
+ !["line", "area", "bar", "combo"].includes(single.card.display ?? "") ||
+ settings["stackable.stack_type"] != null,
+ getDefault: (single, _settings, extra) => {
+ const { series = [] } = extra ?? {};
if (keyForSingleSeries(single) === OTHER_DATA_KEY) {
return "bar"; // "other" series is always a bar chart now
}
-
// FIXME: will move to Cartesian series model further, but now this code is used by other legacy charts
const transformedSeriesIndex = series.findIndex(
(s) => keyForSingleSeries(s) === keyForSingleSeries(single),
);
-
return getSeriesDefaultDisplay(
series[transformedSeriesIndex].card.display,
transformedSeriesIndex,
@@ -81,12 +108,13 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
},
},
color: {
- getDefault: (single, settings, { settings: vizSettings }) =>
+ getDefault: (single, _settings, extra) => {
// get the color for series key, computed in the setting
- getIn(vizSettings, [
+ return getIn(extra?.settings, [
SERIES_COLORS_SETTING_KEY,
keyForSingleSeries(single),
- ]),
+ ]);
+ },
},
"line.interpolate": {
title: t`Line shape`,
@@ -98,11 +126,12 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
{ icon: "stepped", value: "step-after" },
],
},
- getHidden: (single, settings) =>
+ getHidden: (_single, settings) =>
!LINE_DISPLAY_TYPES.has(settings["display"]),
- getDefault: (single, settings, { settings: vizSettings }) =>
+ getDefault: (_single, _settings, extra) => {
// use legacy global line.interpolate setting if present
- getSeriesDefaultLinearInterpolate(vizSettings),
+ return getSeriesDefaultLinearInterpolate(extra?.settings ?? {});
+ },
readDependencies: ["display"],
},
"line.style": {
@@ -115,8 +144,8 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
{ icon: "line_style_dotted", value: "dotted" },
],
},
- getDefault: (series, settings) => getSeriesDefaultLineStyle(settings),
- getHidden: (single, settings) =>
+ getDefault: (_series, settings) => getSeriesDefaultLineStyle(settings),
+ getHidden: (_single, settings) =>
!LINE_DISPLAY_TYPES.has(settings["display"]),
readDependencies: ["display"],
},
@@ -130,8 +159,8 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
{ name: "L", value: "L" },
],
},
- getDefault: (series, settings) => getSeriesDefaultLineSize(settings),
- getHidden: (single, settings) =>
+ getDefault: (_series, settings) => getSeriesDefaultLineSize(settings),
+ getHidden: (_single, settings) =>
!LINE_DISPLAY_TYPES.has(settings["display"]),
readDependencies: ["display"],
},
@@ -145,11 +174,12 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
{ name: t`Off`, value: false },
],
},
- getHidden: (single, settings) =>
+ getHidden: (_single, settings) =>
!LINE_DISPLAY_TYPES.has(settings["display"]),
- getDefault: (single, settings, { settings: vizSettings }) =>
+ getDefault: (_single, _settings, extra) => {
// use legacy global line.marker_enabled setting if present
- getSeriesDefaultLineMarker(vizSettings),
+ return getSeriesDefaultLineMarker(extra?.settings ?? {});
+ },
readDependencies: ["display"],
},
"line.missing": {
@@ -162,18 +192,19 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
{ name: t`Linear Interpolated`, value: "interpolate" },
],
},
- getHidden: (single, settings) =>
+ getHidden: (_single, settings) =>
!LINE_DISPLAY_TYPES.has(settings["display"]),
- getDefault: (single, settings, { settings: vizSettings }) =>
+ getDefault: (_single, _settings, extra) => {
// use legacy global line.missing setting if present
- getSeriesDefaultLineMissing(vizSettings),
+ return getSeriesDefaultLineMissing(extra?.settings ?? {});
+ },
readDependencies: ["display"],
},
axis: {
title: t`Y-axis position`,
widget: "segmentedControl",
default: null,
- getHidden: (single, settings) => single.card.display === "row",
+ getHidden: (single) => single.card.display === "row",
props: {
options: [
{ name: t`Auto`, value: null },
@@ -187,57 +218,68 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
title: t`Show trend line for this series`,
widget: "toggle",
inline: true,
- getHidden: (single, seriesSettings, { settings, series }) =>
- series.length <= 1 || // no need to show series-level control if there's only one series
- !settings["graph.show_trendline"], // don't show it unless this chart has a global setting
- getDefault: (single, seriesSettings, { settings }) =>
- getSeriesDefaultShowSeriesTrendline(settings),
+ getHidden: (_single, _seriesSettings, extra) => {
+ const { series = [], settings = {} } = extra ?? {};
+ return (
+ series.length <= 1 || // no need to show series-level control if there's only one series
+ !settings["graph.show_trendline"] // don't show it unless this chart has a global setting;
+ );
+ },
+ getDefault: (_single, _seriesSettings, extra) =>
+ getSeriesDefaultShowSeriesTrendline(extra?.settings ?? {}),
readDependencies: ["graph.show_trendline"],
},
show_series_values: {
title: t`Show values for this series`,
widget: "toggle",
inline: true,
- getHidden: (single, seriesSettings, { settings, series }) =>
- series.length <= 1 || // no need to show series-level control if there's only one series
- !settings["graph.show_values"] || // don't show it unless this chart has a global setting
- (settings["stackable.stack_type"] &&
- settings["graph.show_stack_values"] === "total"),
- getDefault: (single, seriesSettings, { settings }) =>
- getSeriesDefaultShowSeriesValues(settings),
+ getHidden: (_single, _seriesSettings, extra) => {
+ const { series = [], settings = {} } = extra ?? {};
+
+ return Boolean(
+ series.length <= 1 || // no need to show series-level control if there's only one series
+ !settings["graph.show_values"] || // don't show it unless this chart has a global setting
+ (settings["stackable.stack_type"] &&
+ settings["graph.show_stack_values"] === "total"),
+ );
+ },
+ getDefault: (_single, _seriesSettings, extra) =>
+ getSeriesDefaultShowSeriesValues(extra?.settings ?? {}),
readDependencies: ["graph.show_values", "stackable.stack_type"],
},
};
- function getSettingDefinitionsForSingleSeries(series, object, settings) {
- return COMMON_SETTINGS;
- }
-
return {
- ...nestedSettings(SERIES_SETTING_KEY, {
- getHidden: ([{ card }], settings, { isDashboard }) =>
- !isDashboard || card?.display === "waterfall",
- getSection: (series, settings, { isDashboard }) =>
- isDashboard ? t`Display` : t`Style`,
- objectName: "series",
- getObjects: (series, settings) => series,
- getObjectKey: keyForSingleSeries,
- getObjectSettings: (settings, object) =>
- settings[keyForSingleSeries(object)],
- getSettingDefinitionsForObject: getSettingDefinitionsForSingleSeries,
- component: ChartNestedSettingSeries,
- readDependencies: [SERIES_COLORS_SETTING_KEY, ...readDependencies],
- noPadding: true,
- getExtraProps: (series) => ({
- seriesCardNames: series.reduce((memo, singleSeries) => {
- memo[keyForSingleSeries(singleSeries)] = getNameForCard(
- singleSeries.card,
- );
- return memo;
- }, {}),
- }),
- ...def,
- }),
+ ...nestedSettings<typeof SERIES_SETTING_KEY, SingleSeries>(
+ SERIES_SETTING_KEY,
+ {
+ getHidden: ([{ card }], _settings, extra) =>
+ !extra?.isDashboard || card?.display === "waterfall",
+ getSection: (_series, _settings, extra) =>
+ extra?.isDashboard ? t`Display` : t`Style`,
+ objectName: "series",
+ getObjects: (series) => series,
+ getObjectKey: keyForSingleSeries,
+ getObjectSettings: (storedSettings, object) =>
+ storedSettings[keyForSingleSeries(object)],
+ getSettingDefinitionsForObject: () => COMMON_SETTINGS,
+ component: ChartNestedSettingSeries,
+ readDependencies: [SERIES_COLORS_SETTING_KEY, ...readDependencies],
+ noPadding: true,
+ getExtraProps: (series) => ({
+ seriesCardNames: series.reduce<Record<string, string>>(
+ (memo, singleSeries) => {
+ memo[keyForSingleSeries(singleSeries)] = getNameForCard(
+ singleSeries.card,
+ );
+ return memo;
+ },
+ {},
+ ),
+ }),
+ ...def,
+ },
+ ),
// colors must be computed as a whole rather than individually
[SERIES_COLORS_SETTING_KEY]: {
getValue: getColors,
@@ -250,18 +292,24 @@ export function seriesSetting({ readDependencies = [], def } = {}) {
* Computes the colors for the series based on their keys and settings.
* It filters out series that do not have a single key and maps them to their keys.
* Then it retrieves the colors using the `getSeriesColors` function.
- * @param {Array} series - The series to compute colors for.
- * @param {Object} settings - The visualization settings.
- * @returns {Object} - An object mapping series keys to their colors.
+ * @returns An object mapping series keys to their colors.
*/
-export function getColors(series, settings) {
- const originalKeys = [];
+export function getColors(
+ series: Series,
+ settings: VisualizationSettings,
+): Record<string, string> {
+ const keys: string[] = [];
+ const defaultKeys: (string | undefined)[] = [];
- const keys = series.filter(hasSingleSeriesKey).map((s) => {
+ for (const s of series.filter(hasSingleSeriesKey)) {
const key = keyForSingleSeries(s);
- originalKeys.push(s.columnValuesMapping?.[key]?.[0]?.originalName);
- return key;
- });
+ const mappedValue = s.columnValuesMapping?.[key]?.[0];
+
+ keys.push(key);
+ defaultKeys.push(
+ typeof mappedValue === "string" ? mappedValue : mappedValue?.originalName,
+ );
+ }
- return getSeriesColors(keys, settings, originalKeys);
+ return getSeriesColors(keys, settings, defaultKeys);
}
diff --git a/frontend/src/metabase/visualizations/lib/settings/series.unit.spec.ts b/frontend/src/metabase/visualizations/lib/settings/series.unit.spec.ts
index 51bcfbd8663..de89e0fee11 100644
--- a/frontend/src/metabase/visualizations/lib/settings/series.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/series.unit.spec.ts
@@ -1,5 +1,7 @@
import {
createMockCard,
+ createMockDataset,
+ createMockSingleSeries,
createMockVisualizationSettings,
} from "metabase-types/api/mocks";
@@ -8,7 +10,7 @@ import { getColors } from "./series";
describe("Series unit settings", () => {
describe("getColors", () => {
it("should work for a card with a name", () => {
- const series = [{ card: createMockCard({ name: "The card" }) }];
+ const series = [createMockSingleSeries({ name: "The card" })];
const settings = createMockVisualizationSettings({
"graph.metrics": ["count"],
"graph.dimensions": ["CATEGORY"],
@@ -22,7 +24,10 @@ describe("Series unit settings", () => {
it("should work for a card with a _seriesKey", () => {
const series = [
- { card: { ...createMockCard({ name: "Count" }), _seriesKey: "count" } },
+ {
+ card: { ...createMockCard({ name: "Count" }), _seriesKey: "count" },
+ ...createMockDataset(),
+ },
];
const settings = createMockVisualizationSettings({
"graph.metrics": ["count"],
@@ -38,31 +43,30 @@ describe("Series unit settings", () => {
it("should work for visualizer series", () => {
const series = [
{
+ card: {
+ ...createMockCard({ name: "Count" }),
+ _seriesKey: "COLUMN_2",
+ },
+ ...createMockDataset(),
// columnValuesMapping is needed by the color assignment logic
// because certain series have a specific color based on their name (count, for instance)
// see frontend/src/metabase/lib/colors/groups.ts, getPreferredColor()
columnValuesMapping: {
COLUMN_1: [
{
- sourceId: "card:124",
+ sourceId: "card:124" as const,
originalName: "CATEGORY",
name: "COLUMN_1",
},
],
COLUMN_2: [
{
- sourceId: "card:124",
+ sourceId: "card:124" as const,
originalName: "count",
name: "COLUMN_2",
},
],
},
- card: {
- ...createMockCard({
- name: "Count",
- }),
- _seriesKey: "COLUMN_2",
- },
},
];
diff --git a/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts b/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts
index 28f0a4237d6..424c0ce9c66 100644
--- a/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts
+++ b/frontend/src/metabase/visualizations/lib/settings/typed-utils.ts
@@ -2,7 +2,10 @@ import { getIn } from "icepick";
import _ from "underscore";
import { getVisualization } from "metabase/visualizations";
-import type { VisualizationSettingDefinition } from "metabase/visualizations/types";
+import type {
+ VisualizationSettingDefinition,
+ VisualizationSettingsDefinitions,
+} from "metabase/visualizations/types";
import type {
Card,
TableColumnOrderSetting,
@@ -65,7 +68,7 @@ const mergeTableColumns = (
};
export const isSettingHiddenOnDashboards = (
- vizSettingDefinition: VisualizationSettingDefinition<unknown, unknown>,
+ vizSettingDefinition: VisualizationSettingDefinition,
) => {
// strict check as by default all settings are visible on dashboards
return vizSettingDefinition.dashboard === false;
@@ -78,10 +81,7 @@ export const isSettingHiddenOnDashboards = (
*/
export function sanitizeDashcardSettings(
settings: VisualizationSettings,
- vizSettingsDefs: Record<
- string,
- VisualizationSettingDefinition<unknown, unknown>
- >,
+ vizSettingsDefs: VisualizationSettingsDefinitions,
): VisualizationSettings {
return _.pick(settings, (_, key) => {
const settingDef = vizSettingsDefs[key];
diff --git a/frontend/src/metabase/visualizations/lib/settings/utils.js b/frontend/src/metabase/visualizations/lib/settings/utils.ts
similarity index 55%
rename from frontend/src/metabase/visualizations/lib/settings/utils.js
rename to frontend/src/metabase/visualizations/lib/settings/utils.ts
index fe23a81fb42..3b109f835f7 100644
--- a/frontend/src/metabase/visualizations/lib/settings/utils.js
+++ b/frontend/src/metabase/visualizations/lib/settings/utils.ts
@@ -4,16 +4,23 @@ import {
columnsAreValid,
getDefaultDimensionAndMetric,
} from "metabase/visualizations/lib/utils";
+import type { SeriesSettingDefinition } from "metabase/visualizations/types";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
+import type {
+ DatasetColumn,
+ Series,
+ TableColumnOrderSetting,
+ VisualizationSettings,
+} from "metabase-types/api";
-export function getOptionFromColumn(col) {
+export function getOptionFromColumn(col: DatasetColumn) {
return {
name: col.display_name,
value: col.name,
};
}
-export function metricSetting(id, def = {}) {
+export function metricSetting(id: string, def: SeriesSettingDefinition = {}) {
return fieldSetting(id, {
fieldFilter: isMetric,
getDefault: (series) => getDefaultDimensionAndMetric(series).metric,
@@ -21,7 +28,10 @@ export function metricSetting(id, def = {}) {
});
}
-export function dimensionSetting(id, def = {}) {
+export function dimensionSetting(
+ id: string,
+ def: SeriesSettingDefinition = {},
+) {
return fieldSetting(id, {
fieldFilter: isDimension,
getDefault: (series) => getDefaultDimensionAndMetric(series).dimension,
@@ -29,44 +39,42 @@ export function dimensionSetting(id, def = {}) {
});
}
-const DEFAULT_FIELD_FILTER = (column) => true;
+const DEFAULT_FIELD_FILTER = (_column: DatasetColumn) => true;
+
+type FieldFilterFn = (column: DatasetColumn) => boolean;
export function getDefaultColumn(
- series,
- vizSettings,
- fieldFilter = DEFAULT_FIELD_FILTER,
-) {
+ series: Series,
+ _vizSettings: VisualizationSettings,
+ fieldFilter: FieldFilterFn = DEFAULT_FIELD_FILTER,
+): string | undefined {
const [{ data }] = series;
return data.cols.find(fieldFilter)?.name;
}
-/**
- * @typedef {import("metabase/visualizations/types").VisualizationSettingsDefinitions} VisualizationSettingsDefinitions
- * @typedef {(column: DatasetColumn) => boolean} FieldFilterFn
- */
-
-/**
- * @param {string} id
- * @param {VisualizationSettingsDefinitions[string] & { fieldFilter?: FieldFilterFn }} settings
- * @returns {VisualizationSettingsDefinitions}
- */
export function fieldSetting(
- id,
+ id: string,
{
fieldFilter = DEFAULT_FIELD_FILTER,
showColumnSetting,
autoOpenWhenUnset,
...def
+ }: SeriesSettingDefinition & {
+ fieldFilter?: FieldFilterFn;
+ showColumnSetting?: boolean;
+ autoOpenWhenUnset?: boolean;
} = {},
-) {
+): {
+ [id]: SeriesSettingDefinition;
+} {
return {
[id]: {
widget: "field",
- isValid: ([{ card, data }], vizSettings) =>
+ isValid: ([{ card, data }]) =>
columnsAreValid(card.visualization_settings[id], data, fieldFilter),
getDefault: (series, vizSettings) =>
getDefaultColumn(series, vizSettings, fieldFilter),
- getProps: ([{ card, data }], vizSettings) => ({
+ getProps: ([{ data }]) => ({
options: data.cols.filter(fieldFilter).map(getOptionFromColumn),
columns: data.cols,
showColumnSetting,
@@ -77,6 +85,8 @@ export function fieldSetting(
};
}
-export function getDeduplicatedTableColumnSettings(tableColumnsSettings) {
+export function getDeduplicatedTableColumnSettings(
+ tableColumnsSettings: TableColumnOrderSetting[],
+): TableColumnOrderSetting[] {
return _.uniq(tableColumnsSettings, false, (item) => item.name);
}
diff --git a/frontend/src/metabase/visualizations/lib/settings/validation.js b/frontend/src/metabase/visualizations/lib/settings/validation.ts
similarity index 74%
rename from frontend/src/metabase/visualizations/lib/settings/validation.js
rename to frontend/src/metabase/visualizations/lib/settings/validation.ts
index 02e85569e88..3b538d590aa 100644
--- a/frontend/src/metabase/visualizations/lib/settings/validation.js
+++ b/frontend/src/metabase/visualizations/lib/settings/validation.ts
@@ -8,15 +8,25 @@ import {
} from "metabase/visualizations/lib/errors";
import { getCartesianChartColumns } from "metabase/visualizations/lib/graph/columns";
import { MAX_SERIES } from "metabase/visualizations/lib/utils";
+import type {
+ DatasetColumn,
+ RowValues,
+ Series,
+ SingleSeries,
+ VisualizationSettings,
+} from "metabase-types/api";
+
+export const validateDatasetRows = (series: Series) => {
+ const singleSeriesHasNoRows = ({ data: { rows } }: SingleSeries) => {
+ return rows.length === 0;
+ };
-export const validateDatasetRows = (series) => {
- const singleSeriesHasNoRows = ({ data: { rows } }) => rows.length === 0;
if (_.every(series, singleSeriesHasNoRows)) {
throw new MinRowsError(1, 0);
}
};
-export const validateChartDataSettings = (settings) => {
+export const validateChartDataSettings = (settings: VisualizationSettings) => {
const dimensions = (settings["graph.dimensions"] || []).filter(isNotNull);
const metrics = (settings["graph.metrics"] || []).filter(isNotNull);
if (dimensions.length < 1 || metrics.length < 1) {
@@ -27,7 +37,7 @@ export const validateChartDataSettings = (settings) => {
);
}
const seriesOrder = (settings["graph.series_order"] || []).filter(
- (series) => series.enabled,
+ (s) => s.enabled,
);
if (dimensions.length > 1 && seriesOrder.length === 0) {
throw new ChartSettingsError(t`No breakouts are enabled`, {
@@ -36,7 +46,7 @@ export const validateChartDataSettings = (settings) => {
}
};
-export const validateStacking = (settings) => {
+export const validateStacking = (settings: VisualizationSettings) => {
if (
settings["stackable.stack_type"] === "normalized" &&
settings["graph.y_axis.scale"] === "log"
@@ -47,7 +57,11 @@ export const validateStacking = (settings) => {
}
};
-export const getBreakoutCardinality = (cols, rows, settings) => {
+export const getBreakoutCardinality = (
+ cols: DatasetColumn[],
+ rows: RowValues[],
+ settings: VisualizationSettings,
+): number | null => {
const dimensions = (settings["graph.dimensions"] || []).filter(isNotNull);
if (dimensions.length < 2) {
return null;
@@ -63,7 +77,10 @@ export const getBreakoutCardinality = (cols, rows, settings) => {
return uniqueValues.size;
};
-export const validateBreakoutSeriesCount = (series, settings) => {
+export const validateBreakoutSeriesCount = (
+ series: Series,
+ settings: VisualizationSettings,
+) => {
const [
{
data: { cols, rows },
diff --git a/frontend/src/metabase/visualizations/lib/settings/visualization.js b/frontend/src/metabase/visualizations/lib/settings/visualization.ts
similarity index 70%
rename from frontend/src/metabase/visualizations/lib/settings/visualization.js
rename to frontend/src/metabase/visualizations/lib/settings/visualization.ts
index c4794d66b65..00cfd89b0a6 100644
--- a/frontend/src/metabase/visualizations/lib/settings/visualization.js
+++ b/frontend/src/metabase/visualizations/lib/settings/visualization.ts
@@ -4,7 +4,18 @@ import { t } from "ttag";
import { isVirtualDashCard } from "metabase/dashboard/utils";
import { getVisualizationRaw } from "metabase/visualizations";
import { trackCardSetToHideWhenNoResults } from "metabase/visualizations/lib/settings/analytics";
+import type {
+ ComputedVisualizationSettings,
+ SettingsExtra,
+ VisualizationSettingsDefinitions,
+} from "metabase/visualizations/types";
import { normalize } from "metabase-lib/v1/queries/utils/normalize";
+import type {
+ ColumnSettings,
+ DimensionReference,
+ Series,
+ VisualizationSettings,
+} from "metabase-types/api";
import {
getComputedSettings,
@@ -12,7 +23,7 @@ import {
getSettingsWidgets,
} from "../settings";
-const COMMON_SETTINGS = {
+const COMMON_SETTINGS: VisualizationSettingsDefinitions = {
"card.title": {
get title() {
return t`Title`;
@@ -41,24 +52,25 @@ const COMMON_SETTINGS = {
dashboard: true,
getHidden: ([{ card }]) => isVirtualDashCard(card),
onUpdate: (value, extra) => {
- if (!value) {
+ if (!value || extra.dashboardId == null) {
return;
}
-
trackCardSetToHideWhenNoResults(extra.dashboardId);
},
},
click_behavior: {},
};
-function getSettingDefinitionsForSeries(series) {
+function getSettingDefinitionsForSeries(
+ series: Series | null | undefined,
+): VisualizationSettingsDefinitions {
if (!series) {
return {};
}
const visualization = getVisualizationRaw(series);
const definitions = {
...COMMON_SETTINGS,
- ...(visualization.settings || {}),
+ ...(visualization?.settings || {}),
};
for (const id in definitions) {
definitions[id].id = id;
@@ -66,10 +78,13 @@ function getSettingDefinitionsForSeries(series) {
return definitions;
}
-function normalizeColumnSettings(columnSettings) {
- const newColumnSettings = {};
+function normalizeColumnSettings(
+ columnSettings: Record<string, ColumnSettings>,
+): Record<string, ColumnSettings> {
+ const newColumnSettings: Record<string, ColumnSettings> = {};
for (const oldColumnKey of Object.keys(columnSettings)) {
- const [refOrName, fieldRef] = JSON.parse(oldColumnKey);
+ const [refOrName, fieldRef]: [string, DimensionReference] =
+ JSON.parse(oldColumnKey);
// if the key is a reference, normalize the mbql syntax
const newColumnKey =
refOrName === "ref"
@@ -80,9 +95,10 @@ function normalizeColumnSettings(columnSettings) {
return newColumnSettings;
}
-export function getStoredSettingsForSeries(series) {
- let storedSettings =
- (series && series[0] && series[0].card.visualization_settings) || {};
+export function getStoredSettingsForSeries(
+ series: Series | null | undefined,
+): VisualizationSettings {
+ let storedSettings = series?.[0]?.card?.visualization_settings ?? {};
if (storedSettings.column_settings) {
// normalize any settings stored under old style keys: [ref, [fk->, 1, 2]]
storedSettings = assocIn(
@@ -94,14 +110,10 @@ export function getStoredSettingsForSeries(series) {
return storedSettings;
}
-/**
- * @import { ComputedVisualizationSettings } from "metabase/visualizations/types";
- *
- * @param {any} series
- * @param {{ enableEntityNavigation?: boolean }} [extra]
- * @returns {ComputedVisualizationSettings}
- */
-export function getComputedSettingsForSeries(series, extra = {}) {
+export function getComputedSettingsForSeries(
+ series: Series | null | undefined,
+ extra: SettingsExtra = {},
+): ComputedVisualizationSettings {
if (!series) {
return {};
}
@@ -111,7 +123,9 @@ export function getComputedSettingsForSeries(series, extra = {}) {
return getComputedSettings(settingsDefs, series, storedSettings, extra);
}
-export function getPersistableDefaultSettingsForSeries(series) {
+export function getPersistableDefaultSettingsForSeries(
+ series: Series | null | undefined,
+): ComputedVisualizationSettings {
// A complete set of settings (not only defaults) is loaded because
// some persistable default settings need other settings as dependency for calculating the default value
const settingsDefs = getSettingDefinitionsForSeries(series);
@@ -120,10 +134,10 @@ export function getPersistableDefaultSettingsForSeries(series) {
}
export function getSettingsWidgetsForSeries(
- series,
- onChangeSettings,
+ series: Series | null | undefined,
+ onChangeSettings: (newSettings: Partial<VisualizationSettings>) => void,
isDashboard = false,
- extra = {},
+ extra: SettingsExtra = {},
) {
const settingsDefs = getSettingDefinitionsForSeries(series);
const storedSettings = getStoredSettingsForSeries(series);
@@ -133,7 +147,7 @@ export function getSettingsWidgetsForSeries(
settingsDefs,
storedSettings,
computedSettings,
- series,
+ series ?? [],
onChangeSettings,
{ isDashboard, ...extra },
).filter(
diff --git a/frontend/src/metabase/visualizations/lib/settings/visualization.unit.spec.js b/frontend/src/metabase/visualizations/lib/settings/visualization.unit.spec.ts
similarity index 72%
rename from frontend/src/metabase/visualizations/lib/settings/visualization.unit.spec.js
rename to frontend/src/metabase/visualizations/lib/settings/visualization.unit.spec.ts
index c9044310290..b83d62bbe29 100644
--- a/frontend/src/metabase/visualizations/lib/settings/visualization.unit.spec.js
+++ b/frontend/src/metabase/visualizations/lib/settings/visualization.unit.spec.ts
@@ -10,6 +10,16 @@ import {
getStoredSettingsForSeries,
} from "metabase/visualizations/lib/settings/visualization";
import registerVisualizations from "metabase/visualizations/register";
+import type {
+ Series,
+ VisualizationDisplay,
+ VisualizationSettings,
+} from "metabase-types/api";
+import {
+ createMockCard,
+ createMockDatasetData,
+ createMockSingleSeries,
+} from "metabase-types/api/mocks";
registerVisualizations();
@@ -36,7 +46,7 @@ describe("visualization_settings", () => {
describe("graph.x_axis._is_histogram", () => {
// NOTE: currently datetimes with unit are never considered histograms
- const HISTOGRAM_UNITS = [];
+ const HISTOGRAM_UNITS: string[] = [];
const NON_HISTOGRAM_UNITS = [
// definitely not histogram
"day-of-week",
@@ -74,28 +84,31 @@ describe("visualization_settings", () => {
});
describe("graph.y_axis.title_text", () => {
- const data = {
+ const data = createMockDatasetData({
cols: [
DateTimeColumn({ unit: "month", name: "col1" }),
NumberColumn({ name: "col2" }),
],
rows: [[0, 0]],
- };
+ });
it("should use the series title if set", () => {
- const card = {
+ const card = createMockCard({
visualization_settings: {
"graph.y_axis.title_text": "some title",
},
display: "bar",
name: "foo",
- };
+ });
const settings = getComputedSettingsForSeries([{ card, data }]);
expect(settings["graph.y_axis.title_text"]).toBe("some title");
});
it("should use the metric name if all series match", () => {
- const card = { visualization_settings: {}, display: "bar" };
+ const card = createMockCard({
+ visualization_settings: {},
+ display: "bar",
+ });
const settings = getComputedSettingsForSeries([
{ card, data },
{ card, data },
@@ -104,21 +117,24 @@ describe("visualization_settings", () => {
});
it("should be null if column names don't match", () => {
- const card = { visualization_settings: {}, display: "bar" };
- const data1 = {
+ const card = createMockCard({
+ visualization_settings: {},
+ display: "bar",
+ });
+ const data1 = createMockDatasetData({
cols: [
DateTimeColumn({ unit: "month", name: "col1" }),
NumberColumn({ name: "col2a" }),
],
rows: [[0, 0]],
- };
- const data2 = {
+ });
+ const data2 = createMockDatasetData({
cols: [
DateTimeColumn({ unit: "month", name: "col1" }),
NumberColumn({ name: "col2b" }),
],
rows: [[0, 0]],
- };
+ });
const settings = getComputedSettingsForSeries([
{ card, data: data1 },
{ card, data: data2 },
@@ -129,19 +145,22 @@ describe("visualization_settings", () => {
describe("graph.show_values", () => {
it("should not show values on a bar chart by default", () => {
- const card = { visualization_settings: {}, display: "bar" };
- const data = { rows: new Array(10).fill([1]) };
+ const card = createMockCard({
+ visualization_settings: {},
+ display: "bar",
+ });
+ const data = createMockDatasetData({ rows: new Array(10).fill([1]) });
const settings = getComputedSettingsForSeries([{ card, data }]);
expect(settings["graph.show_values"]).toBe(false);
});
it("should not show values on a previously saved bar chart", () => {
- const card = {
+ const card = createMockCard({
visualization_settings: {},
display: "bar",
original_card_id: 1,
- };
- const data = { rows: new Array(10).fill([1]) };
+ });
+ const data = createMockDatasetData({ rows: new Array(10).fill([1]) });
const settings = getComputedSettingsForSeries([{ card, data }]);
expect(settings["graph.show_values"]).toBe(false);
});
@@ -150,32 +169,32 @@ describe("visualization_settings", () => {
describe("getStoredSettingsForSeries", () => {
it("should return an empty object if visualization_settings isn't defined", () => {
- const settings = getStoredSettingsForSeries([{ card: {} }]);
+ const card = createMockCard({});
+ const data = createMockDatasetData({ rows: [] });
+ const settings = getStoredSettingsForSeries([{ card, data }]);
expect(settings).toEqual({});
});
it("should pull out any saved visualization settings", () => {
- const settings = getStoredSettingsForSeries([
- { card: { visualization_settings: { foo: "bar" } } },
- ]);
+ const card = createMockCard({ visualization_settings: { foo: "bar" } });
+ const data = createMockDatasetData({ rows: [] });
+ const settings = getStoredSettingsForSeries([{ card, data }]);
expect(settings).toEqual({ foo: "bar" });
});
it("should work correctly with frozen objects", () => {
- const settings = getStoredSettingsForSeries(
- icepick.freeze([
- {
- card: {
- visualization_settings: {
- column_settings: {
- '["name","A"]': {
- number_style: "currency",
- },
- },
- },
+ const card = createMockCard({
+ visualization_settings: {
+ column_settings: {
+ '["name","A"]': {
+ number_style: "currency",
},
},
- ]),
+ },
+ });
+ const data = createMockDatasetData({ rows: [] });
+ const settings = getStoredSettingsForSeries(
+ icepick.freeze([{ card, data }]),
);
expect(settings).toEqual({
column_settings: {
@@ -266,20 +285,22 @@ describe("visualization_settings", () => {
describe("pie.metric and pie.dimension", () => {
it("should pick defaults when there are multiple metric columns", () => {
const series = [
- {
- card: { display: "pie", visualization_settings: {} },
- data: {
- cols: [
- StringColumn({ name: "category" }),
- NumberColumn({ name: "sum" }),
- NumberColumn({ name: "count" }),
- ],
- rows: [
- ["a", 10, 1],
- ["b", 20, 2],
- ],
+ createMockSingleSeries(
+ { display: "pie", visualization_settings: {} },
+ {
+ data: {
+ cols: [
+ StringColumn({ name: "category" }),
+ NumberColumn({ name: "sum" }),
+ NumberColumn({ name: "count" }),
+ ],
+ rows: [
+ ["a", 10, 1],
+ ["b", 20, 2],
+ ],
+ },
},
- },
+ ),
];
const settings = getComputedSettingsForSeries(series);
expect(settings["pie.dimension"]).toEqual(["category"]);
@@ -290,23 +311,25 @@ describe("visualization_settings", () => {
describe("map.metric and map.dimension", () => {
it("should pick defaults when there are multiple metric columns", () => {
const series = [
- {
- card: {
+ createMockSingleSeries(
+ {
display: "map",
visualization_settings: { "map.type": "region" },
},
- data: {
- cols: [
- StringColumn({
- name: "state",
- semantic_type: "type/State",
- }),
- NumberColumn({ name: "count" }),
- NumberColumn({ name: "sum" }),
- ],
- rows: [["CA", 100, 100]],
+ {
+ data: {
+ cols: [
+ StringColumn({
+ name: "state",
+ semantic_type: "type/State",
+ }),
+ NumberColumn({ name: "count" }),
+ NumberColumn({ name: "sum" }),
+ ],
+ rows: [["CA", 100, 100]],
+ },
},
- },
+ ),
];
const settings = getComputedSettingsForSeries(series);
expect(settings["map.metric"]).toBe("count");
@@ -318,39 +341,51 @@ const cardWithTimeseriesBreakout = ({
unit,
display = "bar",
visualization_settings = {},
-}) => [
- {
- card: {
+}: {
+ unit?: string;
+ display?: VisualizationDisplay;
+ visualization_settings?: VisualizationSettings;
+}): Series => [
+ createMockSingleSeries(
+ {
display: display,
visualization_settings,
},
- data: {
- cols: [
- DateTimeColumn({ unit, name: "col1" }),
- NumberColumn({ name: "col2" }),
- ],
- rows: [[0, 0]],
+ {
+ data: {
+ cols: [
+ DateTimeColumn({ unit, name: "col1" }),
+ NumberColumn({ name: "col2" }),
+ ],
+ rows: [[0, 0]],
+ },
},
- },
+ ),
];
const cardWithTimeseriesBreakoutAndTwoMetrics = ({
unit,
display = "bar",
visualization_settings = {},
-}) => [
- {
- card: {
+}: {
+ unit?: string;
+ display?: VisualizationDisplay;
+ visualization_settings?: VisualizationSettings;
+}): Series => [
+ createMockSingleSeries(
+ {
display: display,
visualization_settings,
},
- data: {
- cols: [
- DateTimeColumn({ unit, name: "col1" }),
- NumberColumn({ name: "col2" }),
- NumberColumn({ name: "col3" }),
- ],
- rows: [[0, 0, 0]],
+ {
+ data: {
+ cols: [
+ DateTimeColumn({ unit, name: "col1" }),
+ NumberColumn({ name: "col2" }),
+ NumberColumn({ name: "col3" }),
+ ],
+ rows: [[0, 0, 0]],
+ },
},
- },
+ ),
];
diff --git a/frontend/src/metabase/visualizations/lib/utils.js b/frontend/src/metabase/visualizations/lib/utils.js
index b8ec747dd08..1e75ff93b81 100644
--- a/frontend/src/metabase/visualizations/lib/utils.js
+++ b/frontend/src/metabase/visualizations/lib/utils.js
@@ -20,7 +20,7 @@ const SPLIT_AXIS_MAX_DEPTH = 8;
// NOTE Atte Keinänen 8/3/17: Moved from settings.js because this way we
// are able to avoid circular dependency errors in e2e tests
-export function columnsAreValid(colNames, data, filter = () => true) {
+export function columnsAreValid(colNames, data, filter = (_column) => true) {
if (typeof colNames === "string") {
colNames = [colNames];
}
diff --git a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
index 73c979eafd1..7d163f663e3 100644
--- a/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
+++ b/frontend/src/metabase/visualizations/shared/settings/cartesian-chart.ts
@@ -32,6 +32,7 @@ import type {
DatasetData,
RawSeries,
SeriesOrderSetting,
+ VisualizationDisplay,
} from "metabase-types/api";
export function getDefaultDimensionFilter(display: string) {
@@ -121,11 +122,14 @@ export function getDefaultMetrics(
return defaultMetrics.slice(0, getMaxMetricsSupported(card.display));
}
-export const STACKABLE_SERIES_DISPLAY_TYPES = new Set(["area", "bar"]);
+export const STACKABLE_SERIES_DISPLAY_TYPES = new Set<VisualizationDisplay>([
+ "area",
+ "bar",
+]);
export const isStackingValueValid = (
settings: ComputedVisualizationSettings,
- seriesDisplays: string[],
+ seriesDisplays: VisualizationDisplay[],
) => {
if (settings["stackable.stack_type"] == null) {
return true;
@@ -225,7 +229,7 @@ export const getSeriesOrderVisibilitySettings = (
}));
};
-export const getDefaultYAxisTitle = (metricNames: string[]) => {
+export const getDefaultYAxisTitle = (metricNames: (string | undefined)[]) => {
const metricsCount = new Set(metricNames).size;
return metricsCount === 1 ? metricNames[0] : null;
};
@@ -364,9 +368,9 @@ export const isXAxisScaleValid = (
return false;
}
- return (
+ return Boolean(
!isWaterfall ||
- (xAxisScale && !WATERFALL_UNSUPPORTED_X_AXIS_SCALES.includes(xAxisScale))
+ (xAxisScale && !WATERFALL_UNSUPPORTED_X_AXIS_SCALES.includes(xAxisScale)),
);
};
diff --git a/frontend/src/metabase/visualizations/shared/settings/series.ts b/frontend/src/metabase/visualizations/shared/settings/series.ts
index af1b5c18a21..1caf62643c3 100644
--- a/frontend/src/metabase/visualizations/shared/settings/series.ts
+++ b/frontend/src/metabase/visualizations/shared/settings/series.ts
@@ -10,7 +10,7 @@ export const SERIES_COLORS_SETTING_KEY = "series_settings.colors";
export const getSeriesColors = (
seriesVizSettingsKeys: string[],
settings: VisualizationSettings,
- seriesVizSettingsDefaultKeys: string[],
+ seriesVizSettingsDefaultKeys: (string | undefined)[],
) => {
const assignments: Record<string, string> = {};
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index e9d4b33eb08..9aed92ef213 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -1,5 +1,4 @@
-import type { ReactNode } from "react";
-import type React from "react";
+import type { ComponentType, ReactNode } from "react";
import type { OptionsType } from "metabase/lib/formatting/types";
import type { IconName, IconProps } from "metabase/ui";
@@ -19,11 +18,14 @@ import type {
Card,
Dashboard,
DashboardCard,
+ DashboardId,
DatasetColumn,
DatasetData,
RawSeries,
RowValue,
Series,
+ SeriesSettings,
+ SingleSeries,
TimelineEvent,
TimelineEventId,
TransformedSeries,
@@ -32,6 +34,17 @@ import type {
import type { VisualizationDisplay } from "metabase-types/api/visualization";
import type { Dispatch, QueryBuilderMode } from "metabase-types/store";
+import type { ChartSettingEnumToggleProps } from "../components/settings/ChartSettingEnumToggle";
+import type { ChartSettingGoalInputProps } from "../components/settings/ChartSettingGoalInput";
+import type { ChartSettingMaxCategoriesProps } from "../components/settings/ChartSettingMaxCategories";
+import type { ChartSettingSegmentedControlProps } from "../components/settings/ChartSettingSegmentedControl";
+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 { RemappingHydratedDatasetColumn } from "./columns";
import type { HoveredObject } from "./hover";
@@ -43,7 +56,7 @@ export interface Padding {
}
export type Formatter = (value: unknown, options?: OptionsType) => string;
-export type TableCellFormatter = (value: RowValue) => React.ReactNode;
+export type TableCellFormatter = (value: RowValue) => ReactNode;
export type ColorGetter = (colorName: string) => string;
@@ -91,6 +104,7 @@ export type OnChangeCardAndRunOpts = {
export type OnChangeCardAndRun = (opts: OnChangeCardAndRunOpts) => void;
export type ColumnSettings = OptionsType & {
+ _column_title_full?: string;
"pivot_table.column_show_totals"?: boolean;
text_align?: "left" | "middle" | "right";
[key: string]: unknown;
@@ -98,6 +112,8 @@ export type ColumnSettings = OptionsType & {
export type ComputedVisualizationSettings = VisualizationSettings & {
column?: (col: RemappingHydratedDatasetColumn) => ColumnSettings;
+ series?: (key: LegacySeriesSettingsObjectKey) => SeriesSettings;
+ nested?: (value: unknown) => unknown;
};
export interface StaticVisualizationProps {
@@ -184,7 +200,7 @@ export interface VisualizationProps {
* Items that will be shown in a menu when the title is clicked.
* Used for visualizer cards to jump to underlying questions
*/
- titleMenuItems?: React.ReactNode;
+ titleMenuItems?: ReactNode;
}
export type VisualizationPassThroughProps = {
@@ -229,7 +245,7 @@ export type VisualizationPassThroughProps = {
* Items that will be shown in a menu when the title is clicked.
* Used for visualizer cards to jump to underlying questions
*/
- titleMenuItems?: React.ReactNode[];
+ titleMenuItems?: ReactNode[];
// frontend/src/metabase/visualizations/components/ChartSettings/ChartSettingsVisualization/ChartSettingsVisualization.tsx
isSettings?: boolean;
@@ -237,7 +253,7 @@ export type VisualizationPassThroughProps = {
/**
* Extra buttons to be shown in the table footer (if the visualization is a table)
*/
- tableFooterExtraButtons?: React.ReactNode;
+ tableFooterExtraButtons?: ReactNode;
/**
* Props used for Audit Table visualization
@@ -251,7 +267,7 @@ export type VisualizationPassThroughProps = {
export type ColumnSettingDefinition<TValue, TProps = unknown> = {
title?: string;
hint?: string;
- widget?: string | React.ComponentType<any>;
+ widget?: string | ComponentType<any>;
default?: TValue;
props?: TProps;
inline?: boolean;
@@ -267,30 +283,101 @@ export type ColumnSettingDefinition<TValue, TProps = unknown> = {
) => TProps;
};
-export type VisualizationSettingDefinition<TValue, TProps = void> = {
+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;
section?: string;
title?: string;
+ placeholder?: string;
group?: string;
- widget?: string | React.ComponentType<TProps>;
- isValid?: (series: Series, settings: VisualizationSettings) => boolean;
- getHidden?: (series: Series, settings: VisualizationSettings) => boolean;
- getDefault?: (series: Series, settings: VisualizationSettings) => TValue;
- getValue?: (series: Series, settings: VisualizationSettings) => TValue;
- getDisabled?: (series: Series, settings: VisualizationSettings) => TValue;
+ index?: number;
+ showColumnSetting?: boolean;
+ widget?: string | ComponentType<TProps & { id: string }>;
+ isValid?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => boolean;
+ hidden?: 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;
+ getDisabled?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => boolean;
+ getSection?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => string;
+ autoOpenWhenUnset?: boolean;
disabled?: boolean;
default?: TValue;
marginBottom?: string;
- getMarginBottom?: (series: Series, settings: VisualizationSettings) => string;
+ noPadding?: boolean;
+ value?: TValue;
+ set?: boolean;
+ getMarginBottom?: (
+ object: T,
+ settings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
+ extra?: SettingsExtra,
+ ) => string;
persistDefault?: boolean;
inline?: boolean;
- props?: TProps;
+ props?: Partial<TProps>;
getProps?: (
- series: Series,
- vizSettings: VisualizationSettings,
+ object: T,
+ vizSettings: T extends DatasetColumn
+ ? ColumnSettings
+ : ComputedVisualizationSettings,
onChange: (value: TValue) => void,
- extra: unknown,
- onChangeSettings: (value: Record<string, any>) => void,
- ) => TProps;
+ 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[];
@@ -299,8 +386,180 @@ export type VisualizationSettingDefinition<TValue, TProps = void> = {
useRawSeries?: boolean;
};
-export type VisualizationSettingsDefinitions = {
- [key: string]: VisualizationSettingDefinition<unknown, unknown>;
+export type CompleteVisualizationSettingDefinition<
+ T = unknown,
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = VisualizationSettingDefinition<T, TValue, TProps> & {
+ id: string;
+};
+
+export type DatasetColumnSettingDefinition<
+ TValue = unknown,
+ TProps extends Record<string, unknown> = Record<string, unknown>,
+> = VisualizationSettingDefinition<DatasetColumn, TValue, TProps>;
+
+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<
+ LabelValueFrequencyWidgetProps extends Props =
+ | ChartSettingEnumToggleProps<"fit" | "all">
+ | ChartSettingSegmentedControlProps,
+> = {
+ _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_values_mode"?: 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>;
+ 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.metrics"?: SeriesSettingDefinition<Value, Props>;
+ "graph.label_value_frequency"?: SeriesSettingDefinition<
+ Value,
+ LabelValueFrequencyWidgetProps
+ >;
+ "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_mean"?: SeriesSettingDefinition<Value, Props>;
+ "graph.show_stack_values"?: SeriesSettingDefinition<Value, Props>;
+ "graph.show_trendline"?: SeriesSettingDefinition<Value, Props>;
+ "graph.show_values"?: SeriesSettingDefinition<Value, Props>;
+ "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>;
+ 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>;
+ /**
+ * 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 = {
@@ -311,7 +570,7 @@ export type VisualizationGridSize = {
};
// TODO: add component property for the react component instead of the intersection
-export type Visualization = React.ComponentType<
+export type Visualization = ComponentType<
Omit<VisualizationProps, "width" | "height"> & {
width?: number | null;
height?: number | null;
@@ -347,6 +606,9 @@ export type VisualizationDefinition = {
transformSeries?: (series: Series) => TransformedSeries;
isSensible: (data: DatasetData) => boolean;
+ columnSettings?:
+ | VisualizationSettingsDefinitions
+ | ((column: DatasetColumn) => VisualizationSettingsDefinitions);
// checkRenderable throws an error if a visualization is not renderable
checkRenderable: (
series: Series,
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.unit.spec.ts
index 0afd950693c..35edb697bad 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/chart-definition.unit.spec.ts
@@ -1,4 +1,5 @@
import { SERIES_SETTING_KEY } from "metabase/visualizations/shared/settings/series";
+import type { VisualizationSettings } from "metabase-types/api";
import { getCartesianChartDefinition } from "./chart-definition";
@@ -7,7 +8,7 @@ describe("chart-definition", () => {
const onDisplayUpdate = getCartesianChartDefinition({}).onDisplayUpdate!;
it("should reset individual series display", () => {
- const settings = {
+ const settings: VisualizationSettings = {
"graph.y_axis.min": 50,
[SERIES_SETTING_KEY]: {
foo: {
@@ -31,7 +32,7 @@ describe("chart-definition", () => {
});
it("should remove series settings when they contain only series displays", () => {
- const settings = {
+ const settings: VisualizationSettings = {
"graph.y_axis.min": 50,
[SERIES_SETTING_KEY]: {
foo: {
@@ -48,7 +49,7 @@ describe("chart-definition", () => {
});
it("should return unchanged settings when no series settings", () => {
- const settings = {
+ const settings: VisualizationSettings = {
"graph.y_axis.min": 50,
};
expect(onDisplayUpdate(settings)).toStrictEqual({
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
index cb4a6eb6cb3..98f4ff9683c 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-chart-events.ts
@@ -264,7 +264,7 @@ export const useChartEvents = (
// all the data labels show
const isBarSeries =
seriesModel != null
- ? settings.series(seriesModel.legacySeriesSettingsObjectKey)
+ ? settings.series?.(seriesModel.legacySeriesSettingsObjectKey)
.display === "bar"
: false;
const shouldHighlightEntireSeries =
diff --git a/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.ts
index 72bf0e0dac0..71ae49ada27 100644
--- a/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.ts
@@ -10,10 +10,7 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
-import type {
- VisualizationDefinition,
- VisualizationSettingsDefinitions,
-} from "metabase/visualizations/types";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
import { isDate, isNumeric } from "metabase-lib/v1/types/utils/isa";
import { isGaugeSegmentsArray } from "./types";
@@ -51,7 +48,7 @@ export const GAUGE_CHART_DEFINITION: VisualizationDefinition = {
}),
"gauge.range": {
// currently not exposed in settings, just computed from gauge.segments
- getDefault(series, vizSettings) {
+ getDefault(_series, vizSettings) {
const gaugeSegments = vizSettings["gauge.segments"];
const segments = isGaugeSegmentsArray(gaugeSegments)
? gaugeSegments.filter((segment) => segmentIsValid(segment))
@@ -92,5 +89,5 @@ export const GAUGE_CHART_DEFINITION: VisualizationDefinition = {
persistDefault: true,
noPadding: true,
},
- } as VisualizationSettingsDefinitions,
+ },
};
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx
index 9bb218ea198..9c0632768c6 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/DimensionsWidget.tsx
@@ -85,17 +85,19 @@ 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,
onChangeSettings,
onShowWidget,
-}: {
- rawSeries: RawSeries;
- settings: ComputedVisualizationSettings;
- onChangeSettings: (newSettings: ComputedVisualizationSettings) => void;
- onShowWidget: (widget: any, ref: any) => void;
-}) {
+}: DimensionsWidgetProps) {
// Dimension settings
const [dimensions, setDimensions] = useState<(string | undefined)[]>(() => [
...getPieDimensions(settings),
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx b/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx
index f018df58b0b..50011004fe6 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/SliceNameWidget.tsx
@@ -3,15 +3,17 @@ import type { PieRow } from "metabase/visualizations/echarts/pie/model/types";
import { SliceNameInput } from "./SliceNameWidget.styled";
+export type SliceNameWidgetProps = {
+ initialKey: string | number;
+ pieRows: PieRow[];
+ updateRowName: (newName: string, key: string | number) => void;
+};
+
export function SliceNameWidget({
initialKey,
pieRows,
updateRowName,
-}: {
- initialKey: string | number;
- pieRows: PieRow[];
- updateRowName: (newName: string, key: string | number) => void;
-}) {
+}: SliceNameWidgetProps) {
if (pieRows.length === 0) {
return null;
}
diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts
index 291e8af5e39..e81f76fac76 100644
--- a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts
@@ -8,6 +8,7 @@ import {
} from "metabase/visualizations/lib/errors";
import { columnSettings } from "metabase/visualizations/lib/settings/column";
import { nestedSettings } from "metabase/visualizations/lib/settings/nested";
+import { keyForSingleSeries } from "metabase/visualizations/lib/settings/series";
import {
dimensionSetting,
metricSetting,
@@ -28,16 +29,12 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
-import type {
- ComputedVisualizationSettings,
- VisualizationDefinition,
- VisualizationSettingsDefinitions,
-} from "metabase/visualizations/types";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
-import type { RawSeries, Series } from "metabase-types/api";
+import type { SingleSeries } from "metabase-types/api";
import { DimensionsWidget } from "./DimensionsWidget";
-import { SliceNameWidget } from "./SliceNameWidget";
+import { SliceNameWidget, type SliceNameWidgetProps } from "./SliceNameWidget";
const pieRowsReadDeps = [
"pie.dimension",
@@ -98,7 +95,7 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
return t`Measure`;
},
showColumnSetting: true,
- getDefault: (rawSeries: Series) => getDefaultPieColumns(rawSeries).metric,
+ getDefault: (rawSeries) => getDefaultPieColumns(rawSeries).metric,
}),
...columnSettings({ hidden: true }),
...dimensionSetting("pie.dimension", {
@@ -107,8 +104,7 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
return t`Dimension`;
},
showColumnSetting: true,
- getDefault: (rawSeries: Series) =>
- getDefaultPieColumns(rawSeries).dimension,
+ getDefault: (rawSeries) => getDefaultPieColumns(rawSeries).dimension,
}),
"pie.rows": {
hidden: true,
@@ -143,26 +139,20 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
hidden: true,
getDefault: getDefaultSortRows,
},
- ...nestedSettings(SERIES_SETTING_KEY, {
+ ...nestedSettings<
+ "series_settings",
+ SingleSeries,
+ unknown,
+ SliceNameWidgetProps
+ >(SERIES_SETTING_KEY, {
+ getObjectKey: keyForSingleSeries,
widget: SliceNameWidget,
- getHidden: (
- [{ card }]: RawSeries,
- _settings: ComputedVisualizationSettings,
- { isDashboard }: { isDashboard: boolean },
- ) => !isDashboard || card?.display === "waterfall",
- getSection: (
- _series: RawSeries,
- _settings: ComputedVisualizationSettings,
- { isDashboard }: { isDashboard: boolean },
- ) => (isDashboard ? t`Display` : t`Style`),
+ getHidden: ([{ card }], _settings, extra) =>
+ !extra?.isDashboard || card?.display === "waterfall",
+ getSection: (_series, _settings, extra) =>
+ extra?.isDashboard ? t`Display` : t`Style`,
marginBottom: "0",
- getProps: (
- _series: any,
- vizSettings: ComputedVisualizationSettings,
- _onChange: any,
- _extra: any,
- onChangeSettings: (newSettings: ComputedVisualizationSettings) => void,
- ) => {
+ getProps: (_series, vizSettings, _onChange, _extra, onChangeSettings) => {
const pieRows = vizSettings["pie.rows"];
if (pieRows == null) {
return { pieRows: [], updateRowName: () => null };
@@ -183,20 +173,14 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
};
},
readDependencies: ["pie.rows"],
- } as any), // any type cast needed to avoid type error from confusion with destructured object params in `nestedSettings`
+ }),
"pie._dimensions_widget": {
get section() {
return t`Data`;
},
widget: DimensionsWidget,
- getProps: (
- rawSeries: RawSeries,
- settings: ComputedVisualizationSettings,
- _onChange: any,
- _extra: any,
- onChangeSettings: (newSettings: ComputedVisualizationSettings) => void,
- ) => ({
+ getProps: (rawSeries, settings, _onChange, _extra, onChangeSettings) => ({
rawSeries,
settings,
onChangeSettings,
@@ -305,5 +289,5 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {
widget: "number",
getDefault: getDefaultSliceThreshold,
},
- } as VisualizationSettingsDefinitions,
+ },
};
diff --git a/frontend/src/metabase/visualizations/visualizations/Progress/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/Progress/chart-definition.ts
index 540732dd5f4..bf2fa97c604 100644
--- a/frontend/src/metabase/visualizations/visualizations/Progress/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/Progress/chart-definition.ts
@@ -8,10 +8,7 @@ import {
getDefaultSize,
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
-import type {
- VisualizationDefinition,
- VisualizationSettingsDefinitions,
-} from "metabase/visualizations/types";
+import type { VisualizationDefinition } from "metabase/visualizations/types";
import { isNumeric } from "metabase-lib/v1/types/utils/isa";
import { findProgressColumn } from "./utils";
@@ -110,5 +107,5 @@ export const PROGRESS_CHART_DEFINITION: VisualizationDefinition = {
widget: "color",
default: color("accent1"),
},
- } as VisualizationSettingsDefinitions,
+ },
};
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
index 1388147099e..c04f644049f 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/RowChart.tsx
@@ -45,6 +45,7 @@ import type {
ComputedVisualizationSettings,
RemappingHydratedChartData,
VisualizationProps,
+ VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import {
getClickData,
@@ -337,10 +338,11 @@ RowChartVisualization.noHeader = true;
RowChartVisualization.minSize = getMinSize("row");
RowChartVisualization.defaultSize = getDefaultSize("row");
-RowChartVisualization.settings = {
+const settings: VisualizationSettingsDefinitions = {
...ROW_CHART_SETTINGS,
...GRAPH_DATA_SETTINGS,
};
+RowChartVisualization.settings = settings;
RowChartVisualization.isSensible = ({ cols, rows }: DatasetData) => {
return (
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.ts
index 0f47611f9bd..58a198d1945 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/chart-definition.ts
@@ -18,13 +18,13 @@ import type {
VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import { isDate, isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
-import type { DatasetData, RawSeries, Series } from "metabase-types/api";
+import type { DatasetData, RawSeries } from "metabase-types/api";
import { hasCyclicFlow } from "./utils/cycle-detection";
const MAX_SANKEY_NODES = 150;
-export const SETTINGS_DEFINITIONS = {
+export const SETTINGS_DEFINITIONS: VisualizationSettingsDefinitions = {
...columnSettings({ hidden: true }),
...dimensionSetting("sankey.source", {
// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
@@ -35,8 +35,7 @@ export const SETTINGS_DEFINITIONS = {
persistDefault: true,
dashboard: false,
autoOpenWhenUnset: false,
- getDefault: ([series]: RawSeries) =>
- findSensibleSankeyColumns(series.data)?.source,
+ getDefault: ([series]) => findSensibleSankeyColumns(series.data)?.source,
}),
...dimensionSetting("sankey.target", {
// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
@@ -47,8 +46,7 @@ export const SETTINGS_DEFINITIONS = {
persistDefault: true,
dashboard: false,
autoOpenWhenUnset: false,
- getDefault: ([series]: RawSeries) =>
- findSensibleSankeyColumns(series.data)?.target,
+ getDefault: ([series]) => findSensibleSankeyColumns(series.data)?.target,
}),
...metricSetting("sankey.value", {
// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
@@ -59,8 +57,7 @@ export const SETTINGS_DEFINITIONS = {
persistDefault: true,
dashboard: false,
autoOpenWhenUnset: false,
- getDefault: ([series]: RawSeries) =>
- findSensibleSankeyColumns(series.data)?.metric,
+ getDefault: ([series]) => findSensibleSankeyColumns(series.data)?.metric,
}),
"sankey.node_align": {
// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
@@ -114,10 +111,7 @@ export const SETTINGS_DEFINITIONS = {
{ name: t`Full`, value: "full" },
],
},
- getHidden: (
- _series: Series,
- vizSettings: ComputedVisualizationSettings,
- ) => {
+ getHidden: (_series, vizSettings) => {
return !vizSettings["sankey.show_edge_labels"];
},
default: "auto",
@@ -238,5 +232,5 @@ export const SANKEY_CHART_DEFINITION: VisualizationDefinition = {
hasEmptyState: true,
settings: {
...SETTINGS_DEFINITIONS,
- } as any as VisualizationSettingsDefinitions,
+ },
};
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx
index d7e3084ea3c..1bdeeb38440 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SettingsComponents/SmartScalarSettingsWidgets.tsx
@@ -31,7 +31,7 @@ import {
ComparisonList,
} from "./SmartScalarSettingsWidgets.styled";
-type SmartScalarComparisonWidgetProps = {
+export type SmartScalarComparisonWidgetProps = {
onChange: (setting: SmartScalarComparison[]) => void;
options: ComparisonMenuOption[];
comparableColumns: DatasetColumn[];
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
index 3de99cdc8e1..732ee890976 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/SmartScalar.tsx
@@ -17,11 +17,12 @@ import {
getMinSize,
} from "metabase/visualizations/shared/utils/sizes";
import type {
- VisualizationDefinition,
VisualizationPassThroughProps,
VisualizationProps,
+ VisualizationSettingsDefinitions,
} from "metabase/visualizations/types";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
+import type { DatasetData, Series } from "metabase-types/api";
import { ScalarValueContainer } from "../Scalar/ScalarValueContainer";
@@ -161,6 +162,77 @@ export function SmartScalar({
);
}
+export const SETTINGS_DEFINITIONS: VisualizationSettingsDefinitions = {
+ ...fieldSetting("scalar.field", {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Data`,
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ title: t`Primary number`,
+ fieldFilter: isSuitableScalarColumn,
+ }),
+ "scalar.comparisons": {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Data`,
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ title: t`Comparisons`,
+ widget: SmartScalarComparisonWidget,
+ getValue: (series, vizSettings) => getComparisons(series, vizSettings),
+ isValid: (series, vizSettings) => validateComparisons(series, vizSettings),
+ getDefault: (series, vizSettings) =>
+ getDefaultComparison(series, vizSettings),
+ getProps: (series, vizSettings) => {
+ const cols = series[0].data.cols;
+ return {
+ maxComparisons: MAX_COMPARISONS,
+ comparableColumns: getColumnsForComparison(cols, vizSettings),
+ options: getComparisonOptions(series, vizSettings),
+ series,
+ settings: vizSettings,
+ };
+ },
+ readDependencies: ["scalar.field"],
+ },
+ "scalar.switch_positive_negative": {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Display`,
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ title: t`Switch positive / negative colors?`,
+ widget: "toggle",
+ inline: true,
+ default: VIZ_SETTINGS_DEFAULTS["scalar.switch_positive_negative"],
+ },
+ "scalar.compact_primary_number": {
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Display`,
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ title: t`Compact number`,
+ widget: "toggle",
+ inline: true,
+ default: VIZ_SETTINGS_DEFAULTS["scalar.compact_primary_number"],
+ },
+ ...columnSettings({
+ // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
+ section: t`Display`,
+ getColumns: (
+ [
+ {
+ data: { cols },
+ },
+ ],
+ settings,
+ ) => [
+ // try and find a selected field setting
+ cols.find((col) => col.name === settings["scalar.field"]) ||
+ // fall back to the second column
+ cols[1] ||
+ // but if there's only one column use that
+ cols[0],
+ ],
+ readDependencies: ["scalar.field"],
+ }),
+ click_behavior: {},
+};
+
Object.assign(SmartScalar, {
getUiName: () => t`Trend`,
identifier: "smartscalar",
@@ -170,79 +242,9 @@ Object.assign(SmartScalar, {
minSize: getMinSize("smartscalar"),
defaultSize: getDefaultSize("smartscalar"),
- settings: {
- ...fieldSetting("scalar.field", {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Data`,
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- title: t`Primary number`,
- fieldFilter: isSuitableScalarColumn,
- }),
- "scalar.comparisons": {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Data`,
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- title: t`Comparisons`,
- widget: SmartScalarComparisonWidget,
- getValue: (series, vizSettings) => getComparisons(series, vizSettings),
- isValid: (series, vizSettings) =>
- validateComparisons(series, vizSettings),
- getDefault: (series, vizSettings) =>
- getDefaultComparison(series, vizSettings),
- getProps: (series, vizSettings) => {
- const cols = series[0].data.cols;
- return {
- maxComparisons: MAX_COMPARISONS,
- comparableColumns: getColumnsForComparison(cols, vizSettings),
- options: getComparisonOptions(series, vizSettings),
- series,
- settings: vizSettings,
- };
- },
- readDependencies: ["scalar.field"],
- },
- "scalar.switch_positive_negative": {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Display`,
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- title: t`Switch positive / negative colors?`,
- widget: "toggle",
- inline: true,
- default: VIZ_SETTINGS_DEFAULTS["scalar.switch_positive_negative"],
- },
- "scalar.compact_primary_number": {
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Display`,
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- title: t`Compact number`,
- widget: "toggle",
- inline: true,
- default: VIZ_SETTINGS_DEFAULTS["scalar.compact_primary_number"],
- },
- ...columnSettings({
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- section: t`Display`,
- getColumns: (
- [
- {
- data: { cols },
- },
- ],
- settings,
- ) => [
- // try and find a selected field setting
- cols.find((col) => col.name === settings["scalar.field"]) ||
- // fall back to the second column
- cols[1] ||
- // but if there's only one column use that
- cols[0],
- ],
- readDependencies: ["scalar.field"],
- }),
- click_behavior: {},
- },
+ settings: SETTINGS_DEFINITIONS,
- isSensible({ cols, insights }) {
+ isSensible({ cols, insights }: DatasetData) {
const dimensionCount = cols.filter(
(col) => isDimension(col) && !isMetric(col),
).length;
@@ -254,7 +256,7 @@ Object.assign(SmartScalar, {
{
data: { insights },
},
- ]) {
+ ]: Series) {
if (!insights || insights.length === 0) {
throw new ChartSettingsError(
t`Group only by a time field to see how this has changed over time`,
@@ -263,4 +265,4 @@ Object.assign(SmartScalar, {
},
hasEmptyState: true,
-} as VisualizationDefinition);
+});
diff --git a/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx
index 4aafa9e66b4..05d023cfe87 100644
--- a/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/SmartScalar/tests/SmartScalar.unit.spec.tsx
@@ -7,6 +7,7 @@ import { getSettingsWidgetsForSeries } from "metabase/visualizations/lib/setting
import registerVisualizations from "metabase/visualizations/register";
import type { Series } from "metabase-types/api";
import type { Insight } from "metabase-types/api/insight";
+import { createMockSingleSeries } from "metabase-types/api/mocks";
import {
PREVIOUS_VALUE_COMPARISON,
@@ -142,9 +143,22 @@ describe("SmartScalar", () => {
});
it("shouldn't throw an error getting settings for single-column data", () => {
- const card = { display: "smartscalar", visualization_settings: {} };
- const data = { cols: [NumberColumn({ name: "Count" })], rows: [[100]] };
- expect(() => getSettingsWidgetsForSeries([{ card, data }])).not.toThrow();
+ expect(() =>
+ getSettingsWidgetsForSeries(
+ [
+ createMockSingleSeries(
+ { display: "smartscalar", visualization_settings: {} },
+ {
+ data: {
+ cols: [NumberColumn({ name: "Count" })],
+ rows: [[100]],
+ },
+ },
+ ),
+ ],
+ jest.fn(),
+ ),
+ ).not.toThrow();
});
it("shouldn't render compact if normal formatting is <=6 characters", () => {
diff --git a/frontend/src/metabase/visualizer/components/VizSettingsSidebar/VizSettingsSidebar.tsx b/frontend/src/metabase/visualizer/components/VizSettingsSidebar/VizSettingsSidebar.tsx
index 3c199efa7b7..0e56524d435 100644
--- a/frontend/src/metabase/visualizer/components/VizSettingsSidebar/VizSettingsSidebar.tsx
+++ b/frontend/src/metabase/visualizer/components/VizSettingsSidebar/VizSettingsSidebar.tsx
@@ -43,9 +43,12 @@ export function VizSettingsSidebar({ className }: { className?: string }) {
handleChangeSettings,
true,
);
- return widgets.filter(
- (widget) => !HIDDEN_SETTING_WIDGETS.includes(widget.id),
- );
+ return widgets.filter((widget) => {
+ return (
+ typeof widget.id !== "string" ||
+ !HIDDEN_SETTING_WIDGETS.includes(widget.id)
+ );
+ });
} catch (error) {
setError(error as Error);
return [];
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts
index a942cfe9ddf..1c558d27c4a 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-card-data-source.ts
@@ -160,7 +160,7 @@ export function getInitialStateForCardDataSource(
// Using state.display to get viz settings
// relevant to a new visualization vs. original card
// (e.g. if a card is a smartscalar, it won't have any relevant viz settings)
- card: { ...card, display: state.display },
+ card: { ...card, display: state.display ?? card.display },
},
]);
diff --git a/frontend/src/metabase/visualizer/utils/viz-settings.ts b/frontend/src/metabase/visualizer/utils/viz-settings.ts
index bcfee57204b..67539972ef6 100644
--- a/frontend/src/metabase/visualizer/utils/viz-settings.ts
+++ b/frontend/src/metabase/visualizer/utils/viz-settings.ts
@@ -7,9 +7,7 @@ import {
isVisualizerSupportedVisualization,
} from "./dashboard-card-supports-visualizer";
-const isDataSetting = ({
- widget,
-}: VisualizationSettingDefinition<unknown, unknown>) => {
+const isDataSetting = ({ widget }: VisualizationSettingDefinition) => {
// TODO Come up with a better condition
return widget === "field" || widget === "fields";
};
diff --git a/frontend/test/__support__/echarts.ts b/frontend/test/__support__/echarts.ts
index 9eba406371d..672d8c593f7 100644
--- a/frontend/test/__support__/echarts.ts
+++ b/frontend/test/__support__/echarts.ts
@@ -2,7 +2,7 @@ import type {
BreakoutSeriesModel,
SeriesModel,
} from "metabase/visualizations/echarts/cartesian/model/types";
-import { createMockColumn } from "metabase-types/api/mocks";
+import { createMockCard, createMockColumn } from "metabase-types/api/mocks";
export const createMockSeriesModel = (
opts?: Partial<SeriesModel>,
@@ -13,7 +13,9 @@ export const createMockSeriesModel = (
name: `name for ${dataKey}`,
tooltipName: `tooltip name for ${dataKey}`,
color: "red",
- legacySeriesSettingsObjectKey: { card: { _seriesKey: dataKey } },
+ legacySeriesSettingsObjectKey: {
+ card: { ...createMockCard(), _seriesKey: dataKey },
+ },
vizSettingsKey: dataKey,
column: createMockColumn({ name: dataKey }),
columnIndex: 1,
diff --git a/frontend/test/__support__/visualizations.js b/frontend/test/__support__/visualizations.js
index 9d4c2eaf2f7..14b8d84aa6d 100644
--- a/frontend/test/__support__/visualizations.js
+++ b/frontend/test/__support__/visualizations.js
@@ -1,5 +1,6 @@
import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settings/visualization";
import { formatValueForTooltip } from "metabase/visualizations/lib/tooltip";
+import { createMockColumn } from "metabase-types/api/mocks";
export function makeCard(card) {
return {
@@ -18,11 +19,12 @@ export function makeData(cols, rows) {
};
}
-export const Column = (col = {}) => ({
- ...col,
- name: col.name || "column_name",
- display_name: col.display_name || col.name || "column_display_name",
-});
+export const Column = (col = {}) =>
+ createMockColumn({
+ ...col,
+ name: col.name || "column_name",
+ display_name: col.display_name || col.name || "column_display_name",
+ });
export const BooleanColumn = (col = {}) =>
Column({ base_type: "type/Boolean", semantic_type: null, ...col });