Skip to content

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

Convert visualization settings components and specs to TypeScript (#76759)

Anderson8eea1fc50b5a
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx
index b9c5105fe92..3bc86727535 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeries.tsx
@@ -1,9 +1,9 @@
+import type { ChartNestedSettingsSeriesMultipleProps } from "./ChartNestedSettingSeriesMultiple";
import { ChartNestedSettingSeriesMultiple } from "./ChartNestedSettingSeriesMultiple";
-import type { ChartNestedSettingsSeriesSingleProps } from "./ChartNestedSettingSeriesSingle";
import ChartNestedSettingSeriesSingle from "./ChartNestedSettingSeriesSingle";
export type ChartNestedSettingSeriesProps =
- ChartNestedSettingsSeriesSingleProps & {
+ ChartNestedSettingsSeriesMultipleProps & {
isDashboard: boolean;
};
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.jsx b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.jsx
deleted file mode 100644
index d578cfbb28b..00000000000
--- a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.jsx
+++ /dev/null
@@ -1,116 +0,0 @@
-/* eslint-disable react/prop-types */
-import cx from "classnames";
-import { Component } from "react";
-import { t } from "ttag";
-
-import { ColorSelector } from "metabase/common/components/ColorSelector";
-import CS from "metabase/css/core/index.css";
-import { Flex } from "metabase/ui";
-import { getAccentColors } from "metabase/ui/colors/groups";
-
-import {
- OptionsIcon,
- SeriesNameInput,
-} from "./ChartNestedSettingSeries.styled";
-
-// various props injected by chartSettingNestedSettings HOC
-export class ChartNestedSettingSeriesMultiple extends Component {
- render() {
- const {
- objects,
- getObjectKey,
- onChangeEditingObject,
- onChangeObjectSettings,
- objectSettingsWidgets,
- object,
- allComputedSettings,
- seriesCardNames,
- settings: visualizationSettings,
- } = this.props;
- const objectKey = object && getObjectKey(object);
- const isSelected = (single) => objectKey === getObjectKey(single);
-
- return (
- <div data-testid="series-settings">
- {objects.length < 100 &&
- objects.map((single) => {
- const key = getObjectKey(single);
- const settings = allComputedSettings[key] || {};
- const seriesCardName = seriesCardNames?.[key];
- const seriesOrderSetting = visualizationSettings[
- "graph.series_order"
- ]?.find((seriesOrder) => seriesOrder.key === key);
- const isHidden =
- seriesOrderSetting != null && !seriesOrderSetting.enabled;
-
- if (isHidden) {
- return null;
- }
- return (
- <div
- key={key}
- className={cx(
- CS.px4,
- CS.pt2,
- CS.mt2,
- CS.borderTop,
- CS.alignSelfStretch,
- )}
- >
- <div className={cx(CS.flex, CS.alignCenter)}>
- <ColorSelector
- withinPortal={false}
- value={settings.color}
- colors={getAccentColors()}
- onChange={(value) =>
- onChangeObjectSettings(single, { color: value })
- }
- />
- <SeriesNameInput
- className={cx(CS.flexFull, CS.ml1, CS.alignSelfStretch)}
- // set vertical padding to 0 and use align-self-stretch to match siblings
- style={{ paddingTop: 0, paddingBottom: 0 }}
- value={settings.title}
- description={
- seriesCardName === settings.title ? "" : seriesCardName
- }
- onBlurChange={(e) =>
- onChangeObjectSettings(single, {
- title: e.target.value,
- })
- }
- data-testid="series-name-input"
- />
- {objects.length > 1 ? (
- <Flex
- align="center"
- justify="center"
- bdrs={6}
- className={cx(CS.ml1, CS.p1)}
- >
- <OptionsIcon
- name={isSelected(single) ? "chevronup" : "chevrondown"}
- tooltip={
- isSelected(single) ? t`Hide options` : t`More options`
- }
- onClick={() =>
- onChangeEditingObject(
- isSelected(single) ? null : single,
- )
- }
- />
- </Flex>
- ) : null}
- </div>
- {objectSettingsWidgets &&
- objectSettingsWidgets.length > 0 &&
- isSelected(single) ? (
- <div className={CS.mt3}>{objectSettingsWidgets}</div>
- ) : null}
- </div>
- );
- })}
- </div>
- );
- }
-}
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.tsx b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.tsx
new file mode 100644
index 00000000000..dfbfdf8b82b
--- /dev/null
+++ b/frontend/src/metabase/visualizations/components/settings/ChartNestedSettingSeriesMultiple.tsx
@@ -0,0 +1,120 @@
+import cx from "classnames";
+import { t } from "ttag";
+
+import { ColorSelector } from "metabase/common/components/ColorSelector";
+import CS from "metabase/css/core/index.css";
+import { Flex } from "metabase/ui";
+import { getAccentColors } from "metabase/ui/colors/groups";
+import type { SingleSeries, VisualizationSettings } from "metabase-types/api";
+
+import {
+ OptionsIcon,
+ SeriesNameInput,
+} from "./ChartNestedSettingSeries.styled";
+import type { ChartNestedSettingsSeriesSingleProps } from "./ChartNestedSettingSeriesSingle";
+
+export interface ChartNestedSettingsSeriesMultipleProps extends ChartNestedSettingsSeriesSingleProps {
+ objects: SingleSeries[];
+ onChangeEditingObject: (object: SingleSeries | null) => void;
+ settings: VisualizationSettings;
+}
+
+// various props injected by chartSettingNestedSettings HOC
+export const ChartNestedSettingSeriesMultiple = ({
+ objects,
+ getObjectKey,
+ onChangeEditingObject,
+ onChangeObjectSettings,
+ objectSettingsWidgets,
+ object,
+ allComputedSettings,
+ seriesCardNames,
+ settings: visualizationSettings,
+}: ChartNestedSettingsSeriesMultipleProps) => {
+ const objectKey = object && getObjectKey(object);
+ const isSelected = (single: SingleSeries) =>
+ objectKey === getObjectKey(single);
+
+ return (
+ <div data-testid="series-settings">
+ {objects.length < 100 &&
+ objects.map((single) => {
+ const key = getObjectKey(single);
+ const settings = allComputedSettings[key] || {};
+ const seriesCardName = seriesCardNames?.[key];
+ const seriesOrderSetting = visualizationSettings[
+ "graph.series_order"
+ ]?.find((seriesOrder) => seriesOrder.key === key);
+ const isHidden =
+ seriesOrderSetting != null && !seriesOrderSetting.enabled;
+
+ if (isHidden) {
+ return null;
+ }
+ return (
+ <div
+ key={key}
+ className={cx(
+ CS.px4,
+ CS.pt2,
+ CS.mt2,
+ CS.borderTop,
+ CS.alignSelfStretch,
+ )}
+ >
+ <div className={cx(CS.flex, CS.alignCenter)}>
+ <ColorSelector
+ withinPortal={false}
+ value={settings.color}
+ colors={getAccentColors()}
+ onChange={(value) =>
+ onChangeObjectSettings(single, { color: value })
+ }
+ />
+ <SeriesNameInput
+ className={cx(CS.flexFull, CS.ml1, CS.alignSelfStretch)}
+ // set vertical padding to 0 and use align-self-stretch to match siblings
+ style={{ paddingTop: 0, paddingBottom: 0 }}
+ value={settings.title}
+ description={
+ seriesCardName === settings.title ? "" : seriesCardName
+ }
+ onBlurChange={(e) =>
+ onChangeObjectSettings(single, {
+ title: e.target.value,
+ })
+ }
+ data-testid="series-name-input"
+ />
+ {objects.length > 1 ? (
+ <Flex
+ align="center"
+ justify="center"
+ bdrs={6}
+ className={cx(CS.ml1, CS.p1)}
+ >
+ <OptionsIcon
+ name={isSelected(single) ? "chevronup" : "chevrondown"}
+ tooltip={
+ isSelected(single) ? t`Hide options` : t`More options`
+ }
+ onClick={() =>
+ onChangeEditingObject(
+ isSelected(single) ? null : single,
+ )
+ }
+ />
+ </Flex>
+ ) : null}
+ </div>
+ {objectSettingsWidgets &&
+ objectSettingsWidgets.length > 0 &&
+ isSelected(single) ? (
+ <div className={CS.mt3}>{objectSettingsWidgets}</div>
+ ) : null}
+ </div>
+ );
+ })}
+ </div>
+ );
+};
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker.unit.spec.js b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker.unit.spec.tsx
similarity index 60%
rename from frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker.unit.spec.js
rename to frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker.unit.spec.tsx
index 72ebe47d9dd..922762b51ad 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker.unit.spec.js
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker.unit.spec.tsx
@@ -1,49 +1,55 @@
-// these tests use QuestionChartSettings directly, but logic we're testing logic in ChartSettingFieldPicker
+// these tests use QuestionChartSettings directly, but logic we're testing lives in ChartSettingFieldPicker
import { renderWithProviders, screen, within } from "__support__/ui";
import { QuestionChartSettings } from "metabase/visualizations/components/ChartSettings";
import registerVisualizations from "metabase/visualizations/register";
-import { createMockCard } from "metabase-types/api/mocks";
+import type { DatasetColumn, Series } from "metabase-types/api";
+import {
+ createMockColumn,
+ createMockSingleSeries,
+} from "metabase-types/api/mocks";
registerVisualizations();
-function getSeries(metricColumnProps) {
+function getSeries(metricColumnProps?: Partial<DatasetColumn>): Series {
return [
- {
- card: createMockCard({
+ createMockSingleSeries(
+ {
+ id: 1,
+ name: "Card",
display: "line",
visualization_settings: {
"graph.dimensions": ["FOO"],
"graph.metrics": ["BAR"],
},
- }),
- data: {
- rows: [
- ["a", 1],
- ["b", 2],
- ],
- cols: [
- {
- name: "FOO",
- display_name: "FOO",
- source: "native",
- base_type: "type/Text",
- field_ref: ["field", "FOO", {}],
- },
- {
- name: "BAR",
- display_name: "BAR",
- source: "native",
- base_type: "type/Integer",
- field_ref: ["field", "BAR", {}],
- ...metricColumnProps,
- },
- ],
},
- },
+ {
+ data: {
+ rows: [
+ ["a", 1],
+ ["b", 2],
+ ],
+ cols: [
+ createMockColumn({
+ name: "FOO",
+ display_name: "FOO",
+ source: "native",
+ base_type: "type/Text",
+ }),
+ createMockColumn({
+ name: "BAR",
+ display_name: "BAR",
+ source: "native",
+ base_type: "type/Integer",
+ ...metricColumnProps,
+ }),
+ ],
+ },
+ },
+ ),
];
}
-const setup = (seriesDisplay) => {
+const setup = (seriesDisplay?: Partial<DatasetColumn>) => {
const series = getSeries(seriesDisplay);
return renderWithProviders(
<QuestionChartSettings series={series} initial={{ section: "Data" }} />,
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx
index 07dd41ef0b3..f3c91638872 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldPicker/ChartSettingFieldPicker.tsx
@@ -37,14 +37,14 @@ type ChartSettingFieldPickerProps = {
fieldSettingWidget?: string | null;
onChange?: (value: string) => void;
onChangeSeriesColor?: (seriesKey: string, value: string) => void;
- onRemove?: () => void;
+ onRemove?: (() => void) | null;
onShowWidget?: (widget: MenuWidgetInfo, target: HTMLElement) => void;
options?: Array<{ name: string; value: string }>;
series?: Series;
showColorPicker?: boolean;
showColumnSetting?: boolean;
showDragHandle?: boolean;
- value?: string;
+ value?: string | null;
};
export const ChartSettingFieldPicker = ({
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPartition.unit.spec.js b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPartition.unit.spec.tsx
similarity index 65%
rename from frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPartition.unit.spec.js
rename to frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPartition.unit.spec.tsx
index d565399b8a8..a2da3806e1f 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPartition.unit.spec.js
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPartition.unit.spec.tsx
@@ -1,16 +1,22 @@
import { render, screen } from "__support__/ui";
+import type { Partition } from "metabase/visualizations/visualizations/PivotTable/partitions";
import { createMockColumn } from "metabase-types/api/mocks";
import { ChartSettingFieldsPartition } from "./ChartSettingFieldsPartition";
+const partitions: Partition[] = [
+ { name: "rows", title: "Rows", columnFilter: (x) => Boolean(x) },
+];
+
describe("ChartSettingFieldsPartition", () => {
it("should render empty state when value is undefined", () => {
render(
<ChartSettingFieldsPartition
- partitions={[
- { name: "rows", title: "Rows", columnFilter: (x) => Boolean(x) },
- ]}
+ partitions={partitions}
columns={[createMockColumn()]}
+ getColumnTitle={(column) => column.display_name}
+ onChange={jest.fn()}
+ onShowWidget={jest.fn()}
/>,
);
expect(screen.getByText("Drag fields here")).toBeInTheDocument();
@@ -20,9 +26,7 @@ describe("ChartSettingFieldsPartition", () => {
const fieldName = "my column";
render(
<ChartSettingFieldsPartition
- partitions={[
- { name: "rows", title: "Rows", columnFilter: (x) => Boolean(x) },
- ]}
+ partitions={partitions}
columns={[
createMockColumn({
name: fieldName,
@@ -30,7 +34,9 @@ describe("ChartSettingFieldsPartition", () => {
}),
]}
getColumnTitle={(column) => column.display_name}
- value={{ rows: [fieldName] }}
+ value={{ rows: [fieldName], columns: [], values: [] }}
+ onChange={jest.fn()}
+ onShowWidget={jest.fn()}
/>,
);
expect(screen.queryByText("Drag fields here")).not.toBeInTheDocument();
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.jsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.tsx
similarity index 77%
rename from frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.jsx
rename to frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.tsx
index 76acb2f9a56..ec70d3abd1e 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.jsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.tsx
@@ -1,4 +1,3 @@
-/* eslint-disable react/prop-types */
import cx from "classnames";
import { useCallback, useMemo } from "react";
import { match } from "ts-pattern";
@@ -15,7 +14,24 @@ import { AddAnotherContainer } from "./ChartSettingFieldsPicker.styled";
export const UNDEFINED_ITEM_KEY = "$$UNDEFINED_ITEM_KEY$$";
export const NULL_ITEM_KEY = "$$NULL_ITEM_KEY$$";
-const convertField = (field) => {
+type Field = string | null | undefined;
+type SortableField = string;
+
+type Option = { name: string; value: string };
+
+type ChartSettingFieldsPickerProps = {
+ value?: Field[];
+ options: Option[];
+ onChange: (fields: Field[]) => void;
+ addAnother?: string;
+ showColumnSetting?: boolean;
+ showColumnSettingForIndicies?: number[];
+ fieldSettingWidgets?: Array<string | null | undefined>;
+ // additional props are forwarded to ChartSettingFieldPicker
+ [key: string]: unknown;
+};
+
+const convertField = (field: Field | SortableField): Field | SortableField => {
return match(field)
.with(undefined, () => UNDEFINED_ITEM_KEY)
.with(null, () => NULL_ITEM_KEY)
@@ -24,7 +40,18 @@ const convertField = (field) => {
.otherwise((x) => x);
};
-const convertFieldsToSortableFields = (fields) => fields.map(convertField);
+const convertFieldsToSortableFields = (fields: Field[]): SortableField[] =>
+ fields.map((field) => {
+ if (field === undefined) {
+ return UNDEFINED_ITEM_KEY;
+ }
+
+ if (field === null) {
+ return NULL_ITEM_KEY;
+ }
+
+ return field;
+ });
export const ChartSettingFieldsPicker = ({
value: fields = [],
@@ -35,24 +62,30 @@ export const ChartSettingFieldsPicker = ({
showColumnSettingForIndicies,
fieldSettingWidgets = [],
...props
-}) => {
+}: ChartSettingFieldsPickerProps) => {
const sortableFields = useMemo(
() => convertFieldsToSortableFields(fields),
[fields],
);
- const getId = useCallback((field) => field, []);
+ const getId = useCallback((field: SortableField) => field, []);
const sensors = useDndSensors({ distance: 15 });
- const handleDragEnd = ({ id: sortableField, newIndex }) => {
- const field = convertField(sortableField);
+ const handleDragEnd = ({
+ id: sortableField,
+ newIndex,
+ }: {
+ id: SortableField | number;
+ newIndex: number;
+ }) => {
+ const field = convertField(String(sortableField));
const oldIndex = fields.indexOf(field);
onChange(moveElement(fields, oldIndex, newIndex));
};
const calculateOptions = useCallback(
- (field) =>
+ (field: Field) =>
options.filter(
(option) =>
fields.findIndex((v) => v === option.value) < 0 ||
@@ -64,7 +97,15 @@ export const ChartSettingFieldsPicker = ({
const isDragDisabled = fields?.length <= 1;
const renderItem = useCallback(
- ({ item: sortableField, id, index: fieldIndex }) => {
+ ({
+ item: sortableField,
+ id,
+ index: fieldIndex,
+ }: {
+ item: SortableField;
+ id: SortableField | number;
+ index: number;
+ }) => {
const field = convertField(sortableField);
return (
@@ -85,7 +126,7 @@ export const ChartSettingFieldsPicker = ({
key={id}
value={field}
options={calculateOptions(field)}
- onChange={(updatedField) => {
+ onChange={(updatedField: Field) => {
const fieldsCopy = [...fields];
// this swaps the position of the existing value
const existingIndex = fields.indexOf(updatedField);
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.unit.spec.js b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.unit.spec.tsx
similarity index 90%
rename from frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.unit.spec.js
rename to frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.unit.spec.tsx
index 82b61426d81..073baf89809 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.unit.spec.js
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingFieldsPicker.unit.spec.tsx
@@ -3,7 +3,11 @@ import userEvent from "@testing-library/user-event";
import { renderWithProviders, screen } from "__support__/ui";
import { ChartSettingFieldsPicker } from "metabase/visualizations/components/settings/ChartSettingFieldsPicker";
-const DEFAULT_PROPS = {
+type ChartSettingFieldsPickerProps = React.ComponentProps<
+ typeof ChartSettingFieldsPicker
+>;
+
+const DEFAULT_PROPS: ChartSettingFieldsPickerProps = {
options: [
{ name: "Count", value: "count" },
{ name: "Average of Total", value: "avg" },
@@ -12,9 +16,10 @@ const DEFAULT_PROPS = {
columnHasSettings: () => true,
value: ["avg", "count"],
addAnother: "Add another series",
+ onChange: jest.fn(),
};
-const setup = (props) => {
+const setup = (props?: Partial<ChartSettingFieldsPickerProps>) => {
renderWithProviders(
<ChartSettingFieldsPicker {...DEFAULT_PROPS} {...props} />,
);
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingNestedSettings.jsx b/frontend/src/metabase/visualizations/components/settings/ChartSettingNestedSettings.tsx
similarity index 63%
rename from frontend/src/metabase/visualizations/components/settings/ChartSettingNestedSettings.jsx
rename to frontend/src/metabase/visualizations/components/settings/ChartSettingNestedSettings.tsx
index 169e806c309..9c517bc341f 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingNestedSettings.jsx
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingNestedSettings.tsx
@@ -1,25 +1,58 @@
-/* eslint-disable react/prop-types */
/* eslint-disable react/display-name */
-import { Component } from "react";
+import { Component, type ComponentType } from "react";
import _ from "underscore";
import { updateSettings } from "metabase/visualizations/lib/settings";
+import type { CompleteVisualizationSettingDefinition } from "metabase/visualizations/types";
+import type { Series, VisualizationSettings } from "metabase-types/api";
import ChartSettingsWidget from "../ChartSettingsWidget";
+type ChartSettingNestedSettingsConfig<T> = {
+ getObjectKey: (object: T) => string;
+ getObjectSettings: (
+ allStoredSettings: Record<string, VisualizationSettings>,
+ object: T,
+ ) => any;
+ getSettingsWidgetsForObject: (
+ series: Series,
+ object: T,
+ storedSettings: VisualizationSettings,
+ onChangeSettings: (newSettings: Partial<VisualizationSettings>) => void,
+ extra: any,
+ ) => CompleteVisualizationSettingDefinition<T>[];
+};
+
+type ChartSettingNestedSettingsProps<T> = {
+ series: Series;
+ objects: T[];
+ value?: Record<string, VisualizationSettings>;
+ onChange: (value: Record<string, VisualizationSettings>) => void;
+ initialKey?: string | null;
+ onEndShowWidget?: () => void;
+ extra?: any;
+};
+
+type ChartSettingNestedSettingsState = {
+ objectKeyOverride?: string | null;
+};
+
/**
* @deprecated HOCs are deprecated
*/
-export const chartSettingNestedSettings =
- ({ getObjectKey, getObjectSettings, getSettingsWidgetsForObject }) =>
- (ComposedComponent) =>
- class extends Component {
- constructor(props) {
- super(props);
- this.state = {};
- }
+export const chartSettingNestedSettings = <T,>({
+ getObjectKey,
+ getObjectSettings,
+ getSettingsWidgetsForObject,
+}: ChartSettingNestedSettingsConfig<T>) => {
+ return (ComposedComponent: ComponentType<any>): ComponentType<any> => {
+ const Wrapped = class extends Component<
+ ChartSettingNestedSettingsProps<T> & Record<string, unknown>,
+ ChartSettingNestedSettingsState
+ > {
+ state: ChartSettingNestedSettingsState = {};
- getEditingObjectKey = () => {
+ getEditingObjectKey = (): string | null | undefined => {
return (
this.state.objectKeyOverride ||
(this.props.initialKey ??
@@ -29,7 +62,7 @@ export const chartSettingNestedSettings =
);
};
- handleChangeEditingObject = (editingObject) => {
+ handleChangeEditingObject = (editingObject: T | null) => {
// objectKeyOverride allows child components to set the editing object key to a different value than is derived
// from the props. For example, this is used by the "More options" button in ChartNestedSettingSeries.
this.setState({
@@ -41,24 +74,33 @@ export const chartSettingNestedSettings =
}
};
- handleChangeSettingsForEditingObject = (newSettings) => {
+ handleChangeSettingsForEditingObject = (
+ newSettings: Partial<VisualizationSettings>,
+ ) => {
const editingObjectKey = this.getEditingObjectKey();
if (editingObjectKey != null) {
this.handleChangeSettingsForObjectKey(editingObjectKey, newSettings);
}
};
- handleChangeSettingsForObject = (object, newSettings) => {
+ handleChangeSettingsForObject = (
+ object: T,
+ newSettings: Partial<VisualizationSettings>,
+ ) => {
const objectKey = getObjectKey(object);
if (objectKey != null) {
this.handleChangeSettingsForObjectKey(objectKey, newSettings);
}
};
- handleChangeSettingsForObjectKey = (changedKey, changedSettings) => {
+ handleChangeSettingsForObjectKey = (
+ changedKey: string,
+ changedSettings: Partial<VisualizationSettings>,
+ ) => {
const { objects, onChange } = this.props;
const oldSettings = this.props.value || {};
- const newSettings = objects.reduce((newSettings, object) => {
+ const newSettings: Record<string, VisualizationSettings> = {};
+ for (const object of objects) {
const currentKey = getObjectKey(object);
const objectSettings = getObjectSettings(oldSettings, object);
if (currentKey === changedKey) {
@@ -71,8 +113,7 @@ export const chartSettingNestedSettings =
// entries, which would corrupt the settings map (EMB-1940).
newSettings[currentKey] = objectSettings;
}
- return newSettings;
- }, {});
+ }
onChange(newSettings);
};
@@ -119,3 +160,6 @@ export const chartSettingNestedSettings =
);
}
};
+ return Wrapped;
+ };
+};
diff --git a/frontend/src/metabase/visualizations/components/settings/ChartSettingStacked.unit.spec.js b/frontend/src/metabase/visualizations/components/settings/ChartSettingStacked.unit.spec.tsx
similarity index 50%
rename from frontend/src/metabase/visualizations/components/settings/ChartSettingStacked.unit.spec.js
rename to frontend/src/metabase/visualizations/components/settings/ChartSettingStacked.unit.spec.tsx
index ce44c836dab..29647be8cb5 100644
--- a/frontend/src/metabase/visualizations/components/settings/ChartSettingStacked.unit.spec.js
+++ b/frontend/src/metabase/visualizations/components/settings/ChartSettingStacked.unit.spec.tsx
@@ -2,13 +2,15 @@
import { renderWithProviders, screen } from "__support__/ui";
import { QuestionChartSettings } from "metabase/visualizations/components/ChartSettings";
import registerVisualizations from "metabase/visualizations/register";
+import type { Series } from "metabase-types/api";
+import { createMockSingleSeries } from "metabase-types/api/mocks";
registerVisualizations();
-function getSeries(metrics) {
+function getSeries(metrics: string[]): Series {
return [
- {
- card: {
+ createMockSingleSeries(
+ {
dataset_query: {
type: "native",
native: {
@@ -26,61 +28,63 @@ function getSeries(metrics) {
"graph.metrics": metrics,
},
},
- data: {
- rows: [
- ["dogs", 50, 45],
- ["cats", 45, 20],
- ],
- cols: [
- {
- display_name: "PETS",
- source: "native",
- field_ref: [
- "field",
- "PETS",
- {
- "base-type": "type/Text",
- },
- ],
- name: "PETS",
- base_type: "type/Text",
- effective_type: "type/Text",
- },
- {
- display_name: "MALE",
- source: "native",
- field_ref: [
- "field",
- "MALE",
- {
- "base-type": "type/Integer",
- },
- ],
- name: "MALE",
- base_type: "type/Integer",
- effective_type: "type/Integer",
- },
- {
- display_name: "FEMALE",
- source: "native",
- field_ref: [
- "field",
- "FEMALE",
- {
- "base-type": "type/Integer",
- },
- ],
- name: "FEMALE",
- base_type: "type/Integer",
- effective_type: "type/Integer",
- },
- ],
+ {
+ data: {
+ rows: [
+ ["dogs", 50, 45],
+ ["cats", 45, 20],
+ ],
+ cols: [
+ {
+ display_name: "PETS",
+ source: "native",
+ field_ref: [
+ "field",
+ "PETS",
+ {
+ "base-type": "type/Text",
+ },
+ ],
+ name: "PETS",
+ base_type: "type/Text",
+ effective_type: "type/Text",
+ },
+ {
+ display_name: "MALE",
+ source: "native",
+ field_ref: [
+ "field",
+ "MALE",
+ {
+ "base-type": "type/Integer",
+ },
+ ],
+ name: "MALE",
+ base_type: "type/Integer",
+ effective_type: "type/Integer",
+ },
+ {
+ display_name: "FEMALE",
+ source: "native",
+ field_ref: [
+ "field",
+ "FEMALE",
+ {
+ "base-type": "type/Integer",
+ },
+ ],
+ name: "FEMALE",
+ base_type: "type/Integer",
+ effective_type: "type/Integer",
+ },
+ ],
+ },
},
- },
+ ),
];
}
-const setup = (seriesMetrics) => {
+const setup = (seriesMetrics: string[]) => {
return renderWithProviders(
<QuestionChartSettings
series={getSeries(seriesMetrics)}