Skip to content

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

Improve Card type usage (#81409)

Kevin Kelleher4348d9373eb3
diff --git a/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts b/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts
index d190714e95f..63e34ab6855 100644
--- a/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/content_translation/utils.ts
@@ -4,14 +4,15 @@ import { P, match } from "ts-pattern";
import _ from "underscore";
import { useLocale } from "metabase/common/hooks";
-import type { ContentTranslationFunction } from "metabase/content-translation/types";
+import type {
+ ContentTranslationFunction,
+ TranslatableSingleSeries,
+} from "metabase/content-translation/types";
import { type HoveredObject, isCartesianChart } from "metabase/viz-core";
import * as Lib from "metabase-lib";
import type {
DictionaryArray,
- MaybeTranslatedSeries,
RowValue,
- Series,
SeriesSettings,
} from "metabase-types/api";
@@ -211,7 +212,7 @@ export const useTranslateFieldValuesInHoveredObject = (
export const translateFieldValuesInSeries = (
tc: ContentTranslationFunction,
-): ((series: Series) => MaybeTranslatedSeries) => {
+): (<T extends TranslatableSingleSeries>(series: T[]) => T[]) => {
if (!hasTranslations(tc)) {
return (series) => series;
}
@@ -220,12 +221,11 @@ export const translateFieldValuesInSeries = (
if (!singleSeries.data) {
return singleSeries;
}
+ const data = singleSeries.data;
const untranslatedRows = singleSeries.data.rows.concat();
const defaultFn = () => {
- return singleSeries.data.rows.map((row) =>
- row.map((value) => tc(value)),
- );
+ return data.rows.map((row) => row.map((value) => tc(value)));
};
const translatedRows: RowValue[][] = match(singleSeries.card?.display)
@@ -245,7 +245,7 @@ export const translateFieldValuesInSeries = (
// ...
// ]
//
- return singleSeries.data.rows.map((row) =>
+ return data.rows.map((row) =>
row.map((value) => {
if (
typeof value === "string" &&
@@ -257,24 +257,27 @@ export const translateFieldValuesInSeries = (
}),
);
})
- .with(P.when(isCartesianChart), () => {
- // cartesian charts have series settings that can provide display names
- // for fields, which we should translate if available
- const seriesSettings =
- singleSeries.card.visualization_settings?.series_settings ?? {};
-
- return singleSeries.data.rows.map((row) =>
- row.map((value) => {
- if (
- typeof value === "string" &&
- seriesSettings[value]?.title !== undefined
- ) {
- return tc(seriesSettings[value].title);
- }
- return tc(value);
- }),
- );
- })
+ .with(
+ P.when((display) => display && isCartesianChart(display)),
+ () => {
+ // cartesian charts have series settings that can provide display names
+ // for fields, which we should translate if available
+ const seriesSettings =
+ singleSeries.card.visualization_settings?.series_settings ?? {};
+
+ return data.rows.map((row) =>
+ row.map((value) => {
+ if (
+ typeof value === "string" &&
+ seriesSettings[value]?.title !== undefined
+ ) {
+ return tc(seriesSettings[value].title);
+ }
+ return tc(value);
+ }),
+ );
+ },
+ )
.otherwise(defaultFn);
return {
@@ -288,11 +291,13 @@ export const translateFieldValuesInSeries = (
});
};
-export const translateCardNames = (tc: ContentTranslationFunction) => {
+export const translateCardNames = (
+ tc: ContentTranslationFunction,
+): (<T extends TranslatableSingleSeries>(series: T[]) => T[]) => {
if (!hasTranslations(tc)) {
- return (series: Series) => series;
+ return (series) => series;
}
- return (series: Series) =>
+ return (series) =>
series.map((s) =>
s.card?.name ? I.setIn(s, ["card", "name"], tc(s.card.name)) : s,
);
@@ -309,7 +314,7 @@ export const translateCardNames = (tc: ContentTranslationFunction) => {
* // ➜ series_settings: { revenue: { title: tc("Revenue") } }
*/
export const translateSeriesNames = (tc: ContentTranslationFunction) => {
- return (series: Series) => {
+ return <T extends TranslatableSingleSeries>(series: T[]): T[] => {
if (!hasTranslations(tc)) {
return series;
}
@@ -318,7 +323,7 @@ export const translateSeriesNames = (tc: ContentTranslationFunction) => {
const seriesSettings =
singleSeries.card?.visualization_settings?.series_settings;
const metrics =
- singleSeries.card?.visualization_settings["graph.metrics"];
+ singleSeries.card?.visualization_settings?.["graph.metrics"];
if (!seriesSettings || !metrics) {
return singleSeries;
@@ -352,14 +357,17 @@ const curriedTranslatedDisplayNames = (
tc: ContentTranslationFunction,
locale: string,
) => {
- return (series: Series) => {
+ return <T extends TranslatableSingleSeries>(series: T[]): T[] => {
return translateDisplayNames({ obj: series, tc, locale });
};
};
-const identity = (series: Series) => series;
+const identity = <T extends TranslatableSingleSeries>(series: T[]): T[] =>
+ series;
-export const useTranslateSeries = (series: Series) => {
+export const useTranslateSeries = <T extends TranslatableSingleSeries>(
+ series: T[],
+): T[] => {
const tc = useTranslateContent();
const { locale } = useLocale();
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.ts b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.ts
index 67a69b8df47..6daab95d20b 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.ts
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/context/types.ts
@@ -21,7 +21,11 @@ import type {
QueryClickActionsMode,
} from "metabase/visualizations/types";
import type Question from "metabase-lib/v1/Question";
-import type { Card, CardDisplayType, DashboardId } from "metabase-types/api";
+import type {
+ CardDisplayType,
+ DashboardId,
+ SeriesCard,
+} from "metabase-types/api";
import type { EntityToken } from "metabase-types/api/entity";
type SdkQuestionConfig = {
@@ -197,7 +201,7 @@ export type SdkQuestionProviderProps = PropsWithChildren<
onDrillThrough?: (
params: {
drillName: string | undefined;
- nextCard: Card;
+ nextCard: SeriesCard;
},
defaultNavigate: () => Promise<void>,
) => Promise<void>;
diff --git a/frontend/src/embedding-sdk-bundle/lib/sdk-question/load-question.ts b/frontend/src/embedding-sdk-bundle/lib/sdk-question/load-question.ts
index 34144026fa0..dc9896ea60a 100644
--- a/frontend/src/embedding-sdk-bundle/lib/sdk-question/load-question.ts
+++ b/frontend/src/embedding-sdk-bundle/lib/sdk-question/load-question.ts
@@ -16,7 +16,7 @@ import { loadMetadataForCard } from "metabase/questions/actions";
import { updateMetadata } from "metabase/redux/metadata";
import { FieldSchema } from "metabase/schema";
import Question from "metabase-lib/v1/Question";
-import type { Card } from "metabase-types/api/card";
+import type { SeriesCard } from "metabase-types/api";
import type { EntityToken } from "metabase-types/api/entity";
type LoadQuestionSdkParams = LoadSdkQuestionParams & {
@@ -56,7 +56,7 @@ export const loadQuestionSdk =
questionType: isNativeQuestion ? "native" : "gui",
});
- const card: Card = isNewQuestion
+ const card: SeriesCard = isNewQuestion
? { ...resolvedCard, creationType: "custom_question" }
: resolvedCard;
diff --git a/frontend/src/embedding-sdk-bundle/types/question.ts b/frontend/src/embedding-sdk-bundle/types/question.ts
index 4dbc72032ff..1fc40a53414 100644
--- a/frontend/src/embedding-sdk-bundle/types/question.ts
+++ b/frontend/src/embedding-sdk-bundle/types/question.ts
@@ -8,7 +8,11 @@ import type {
import type { QueryParams } from "metabase/query_builder";
import type { ObjectId } from "metabase/visualizations/components/ObjectDetail/types";
import type InternalQuestion from "metabase-lib/v1/Question";
-import type { Card, ParameterValuesMap, UnsavedCard } from "metabase-types/api";
+import type {
+ ParameterValuesMap,
+ SeriesCard,
+ UnsavedCard,
+} from "metabase-types/api";
import type { SdkDashboardId } from "./dashboard";
import type { SdkEntityId, SdkEntityToken } from "./entity";
@@ -144,8 +148,8 @@ export type LoadSdkQuestionParams = {
};
export interface NavigateToNewCardParams {
- nextCard: Card;
- previousCard: Card;
+ nextCard: SeriesCard;
+ previousCard: SeriesCard;
objectId?: ObjectId;
signal?: AbortSignal;
drillName?: string;
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/cards.ts b/frontend/src/metabase-lib/v1/parameters/utils/cards.ts
index 4631e504e24..d7a39f1225d 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/cards.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/cards.ts
@@ -11,15 +11,15 @@ import { getValuePopulatedParameters } from "metabase-lib/v1/parameters/utils/pa
import { getParameterTargetField } from "metabase-lib/v1/parameters/utils/targets";
import { getParametersFromCard } from "metabase-lib/v1/parameters/utils/template-tags";
import type {
- Card,
Parameter,
ParameterTarget,
ParameterValuesMap,
+ SeriesCard,
} from "metabase-types/api";
import { isDimensionTarget } from "metabase-types/guards";
export function getCardUiParameters(
- card: Card,
+ card: SeriesCard,
metadata: Metadata,
parameterValues: ParameterValuesMap = {},
parameters = getParametersFromCard(card, metadata),
@@ -43,7 +43,7 @@ export function getCardUiParameters(
* A question opened from a dashboard shows the dashboard's parameters, which
* the card's own `param_fields` do not cover.
*/
-function hasParamFields(card: Card) {
+function hasParamFields(card: SeriesCard) {
return card.id != null && card.dashboardId == null;
}
@@ -54,7 +54,7 @@ function hasParamFields(card: Card) {
* frontend does not have.
*/
function getSavedCardUiParameters(
- card: Card,
+ card: SeriesCard,
metadata: Metadata,
parameters: Parameter[] | ParameterWithTarget[],
): UiParameter[] {
@@ -84,7 +84,7 @@ function getSavedCardUiParameters(
* against the query.
*/
function getUnsavedCardUiParameters(
- card: Card,
+ card: SeriesCard,
metadata: Metadata,
parameters: Parameter[] | ParameterWithTarget[],
): UiParameter[] {
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts b/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts
index ab597917b02..86dc3f9ac02 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts
@@ -6,9 +6,9 @@ import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type { ParameterWithTarget } from "metabase-lib/v1/parameters/types";
import { InternalQuery } from "metabase-lib/v1/queries/InternalQuery";
import type {
- Card,
Parameter,
ParameterTarget,
+ SeriesCard,
TemplateTag,
} from "metabase-types/api";
@@ -87,7 +87,10 @@ export function getTemplateTagParameters(
.map((tag) => getTemplateTagParameter(tag, parametersById[tag.id]));
}
-export function getTemplateTags(card: Card, metadata: Metadata): TemplateTag[] {
+export function getTemplateTags(
+ card: SeriesCard,
+ metadata: Metadata,
+): TemplateTag[] {
const question = new Question(card, metadata);
// this code path is used by the last audit v1 query, `bad_table`
if (InternalQuery.isDatasetQueryType(question.datasetQuery())) {
@@ -99,7 +102,7 @@ export function getTemplateTags(card: Card, metadata: Metadata): TemplateTag[] {
}
export function getParametersFromCard(
- card: Card,
+ card: SeriesCard,
metadata: Metadata,
): Parameter[] | ParameterWithTarget[] {
if (!card) {
@@ -114,7 +117,7 @@ export function getParametersFromCard(
}
export function getTemplateTagParametersFromCard(
- card: Card,
+ card: SeriesCard,
metadata: Metadata,
) {
const tags = getTemplateTags(card, metadata);
diff --git a/frontend/src/metabase-types/api/dashboard.ts b/frontend/src/metabase-types/api/dashboard.ts
index 6fdde167959..46da28800e3 100644
--- a/frontend/src/metabase-types/api/dashboard.ts
+++ b/frontend/src/metabase-types/api/dashboard.ts
@@ -14,6 +14,7 @@ import type {
ParameterId,
ParameterTarget,
ParameterValueOrArray,
+ SingleSeries,
Table,
UserId,
UserInfo,
@@ -396,3 +397,32 @@ export type GetValidDashboardFilterFieldsRequest = {
filtered: FieldId[];
filtering: FieldId[];
};
+
+export type DashCardSeriesItem = {
+ card: Card | VirtualCard;
+ isSlow: boolean;
+ isUsuallyFast: boolean;
+} & Partial<Dataset>;
+
+export type DashCardSeries = DashCardSeriesItem[];
+
+export type DashCardDataSeriesItem = SingleSeries<Card> &
+ Dataset & {
+ isSlow: boolean;
+ isUsuallyFast: boolean;
+ };
+
+export type DashCardDataSeries = DashCardDataSeriesItem[];
+
+export type VisualizerSeriesItem = Pick<SingleSeries, "card"> &
+ Partial<Omit<SingleSeries, "card">> & {
+ _isVisualizer: true;
+ };
+
+export type VisualizerSeries = VisualizerSeriesItem[];
+
+export type VisualizerDataSeriesItem = SingleSeries & {
+ _isVisualizer: true;
+};
+
+export type VisualizerDataSeries = VisualizerDataSeriesItem[];
diff --git a/frontend/src/metabase-types/api/dataset.ts b/frontend/src/metabase-types/api/dataset.ts
index da20e93aae6..081b7796ee2 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, ColumnSettings } from "./card";
+import type { Card, ColumnSettings, UnsavedCard } from "./card";
import type { DatabaseId } from "./database";
import type {
Field,
@@ -194,8 +194,10 @@ export interface NativeDatasetResponse {
params: unknown;
}
-export type SingleSeries = {
- card: Card;
+export type SeriesCard = UnsavedCard & Partial<Card>;
+
+export type SingleSeries<C extends SeriesCard = SeriesCard> = {
+ card: C;
/**
* A record that maps visualizer series keys (in the form of COLUMN_1,
* COLUMN_2, etc.) to their original values (count, avg, etc.).
@@ -203,24 +205,13 @@ export type SingleSeries = {
columnValuesMapping?: Record<string, VisualizerColumnValueSource[]>;
} & Pick<Dataset, "error" | "started_at" | "data" | "json_query">;
-export type SingleSeriesWithTranslation = SingleSeries & {
- data: Dataset["data"] & {
- /**
- * The original, untranslated rows for this series (if any).
- * Undefined if no translation occurred.
- */
- untranslatedRows?: RowValues[];
- };
-};
-
-export type TransformedCard = Card & {
+export type TransformedCard = SeriesCard & {
_seriesKey: string;
_transformed: true;
};
-export type RawSeries = SingleSeries[];
+export type RawSeries<C extends SeriesCard = SeriesCard> = SingleSeries<C>[];
export type TransformedSeries = RawSeries & { _raw?: Series };
-export type MaybeTranslatedSeries = SingleSeriesWithTranslation[];
export type Series = RawSeries | TransformedSeries;
export type TemplateTagId = string;
diff --git a/frontend/src/metabase-types/api/mocks/dashboard.ts b/frontend/src/metabase-types/api/mocks/dashboard.ts
index 4723034a509..1fafef68620 100644
--- a/frontend/src/metabase-types/api/mocks/dashboard.ts
+++ b/frontend/src/metabase-types/api/mocks/dashboard.ts
@@ -1,5 +1,7 @@
import type {
ActionDashboardCard,
+ Card,
+ DashCardDataSeriesItem,
Dashboard,
DashboardParameterMapping,
DashboardQueryMetadata,
@@ -12,7 +14,9 @@ import type {
} from "metabase-types/api";
import { createMockCard } from "./card";
+import type { MockDatasetOpts } from "./dataset";
import { createMockEntityId } from "./entity-id";
+import { createMockSingleSeries } from "./series";
const MOCK_DASHBOARD_ENTITY_ID = createMockEntityId();
export const createMockDashboard = (opts?: Partial<Dashboard>): Dashboard => ({
@@ -261,3 +265,14 @@ export const createMockDashboardQueryMetadata = (
dashboards: [],
...opts,
});
+
+export const createMockDashCardDataSeries = (
+ cardOpts: Partial<Card>,
+ dataOpts: MockDatasetOpts = {},
+ isSlow: boolean = false,
+ isUsuallyFast: boolean = false,
+): DashCardDataSeriesItem => ({
+ ...createMockSingleSeries(cardOpts, dataOpts),
+ isSlow,
+ isUsuallyFast,
+});
diff --git a/frontend/src/metabase-types/api/mocks/series.ts b/frontend/src/metabase-types/api/mocks/series.ts
index 49805e3fd61..d5c12de425b 100644
--- a/frontend/src/metabase-types/api/mocks/series.ts
+++ b/frontend/src/metabase-types/api/mocks/series.ts
@@ -1,5 +1,5 @@
import type { Card } from "../card";
-import type { Series, SingleSeries } from "../dataset";
+import type { Dataset, Series, SingleSeries } from "../dataset";
import { createMockCard } from "./card";
import type { MockDatasetOpts } from "./dataset";
@@ -8,7 +8,7 @@ import { createMockDataset } from "./dataset";
export const createMockSingleSeries = (
cardOpts: Partial<Card>,
dataOpts: MockDatasetOpts = {},
-): SingleSeries => {
+): SingleSeries<Card> & Dataset => {
return {
card: createMockCard(cardOpts),
...createMockDataset(dataOpts),
diff --git a/frontend/src/metabase-types/guards/dashboard.ts b/frontend/src/metabase-types/guards/dashboard.ts
index 564fe585d20..24be6fc5183 100644
--- a/frontend/src/metabase-types/guards/dashboard.ts
+++ b/frontend/src/metabase-types/guards/dashboard.ts
@@ -1,9 +1,19 @@
import type {
BaseDashboardCard,
+ Card,
+ DashCardDataSeries,
+ DashCardDataSeriesItem,
+ DashCardSeries,
+ DashCardSeriesItem,
LinkEntity,
RestrictedLinkEntity,
+ VirtualCard,
VisualizerDashboardCard,
-} from "metabase-types/api/dashboard";
+ VisualizerDataSeries,
+ VisualizerSeries,
+ VisualizerSeriesItem,
+} from "metabase-types/api";
+import { isVirtualCardDisplayType } from "metabase-types/api";
export const isRestrictedLinkEntity = (
value: LinkEntity,
@@ -20,3 +30,37 @@ export const isVisualizerDashboardCard = (
return dashcard.visualization_settings["visualization"] !== undefined;
};
+
+export function isVirtualCard(card: Card | VirtualCard): card is VirtualCard {
+ return isVirtualCardDisplayType(card.display);
+}
+
+export function isDashCardDataSeriesItem(
+ item: DashCardSeriesItem,
+): item is DashCardDataSeriesItem {
+ return (
+ !isVirtualCard(item.card) &&
+ item.data != null &&
+ item.database_id != null &&
+ item.row_count != null &&
+ item.running_time != null
+ );
+}
+
+export function isDashCardDataSeries(
+ series: DashCardSeries,
+): series is DashCardDataSeries {
+ return series.every(isDashCardDataSeriesItem);
+}
+
+export function isVisualizerSeriesItem(
+ item: DashCardSeriesItem | VisualizerSeriesItem,
+): item is VisualizerSeriesItem {
+ return "_isVisualizer" in item && item._isVisualizer;
+}
+
+export function isVisualizerDataSeries(
+ series: VisualizerSeries,
+): series is VisualizerDataSeries {
+ return series.every((item) => item.data != null);
+}
diff --git a/frontend/src/metabase/common/utils/card.ts b/frontend/src/metabase/common/utils/card.ts
index f878c9ede93..da96a8d4bfc 100644
--- a/frontend/src/metabase/common/utils/card.ts
+++ b/frontend/src/metabase/common/utils/card.ts
@@ -20,15 +20,16 @@ import type {
ActionParametersMapping,
Card,
CardId,
+ DashCardSeries,
DashboardParameterMapping,
DatasetQuery,
LegacyDatasetQuery,
Parameter,
ParameterValuesMap,
- Series,
UnsavedCard,
VirtualDashCardParameterMapping,
} from "metabase-types/api";
+import { isDashCardDataSeries } from "metabase-types/guards/dashboard";
export type SerializeCardOptions = {
includeDatasetQuery?: boolean;
@@ -99,10 +100,10 @@ export function isEqualCard(card1?: Card | null, card2?: Card | null) {
}
export function getMetricSeriesWithDefaultDisplay(
- series: Series,
+ series: DashCardSeries,
metadata: Metadata,
-): Series {
- if (series.length !== 1) {
+): DashCardSeries {
+ if (series.length !== 1 || !isDashCardDataSeries(series)) {
return series;
}
@@ -187,7 +188,7 @@ export function parseHash(hash?: string) {
return { options, serializedCard };
}
-export function isNative(card?: Card | null | undefined) {
+export function isNative(card?: UnsavedCard | null | undefined) {
if (!card) {
return false;
}
@@ -195,7 +196,7 @@ export function isNative(card?: Card | null | undefined) {
return question.isNative();
}
-function cardVisualizationIsEquivalent(cardA: Card, cardB: Card) {
+function cardVisualizationIsEquivalent(cardA: UnsavedCard, cardB: UnsavedCard) {
return _.isEqual(
_.pick(cardA, "display", "visualization_settings"),
_.pick(cardB, "display", "visualization_settings"),
@@ -221,7 +222,7 @@ function datasetQueryForComparison(datasetQuery: DatasetQuery): DatasetQuery {
return res;
}
-export function cardQueryIsEquivalent(cardA: Card, cardB: Card) {
+export function cardQueryIsEquivalent(cardA: UnsavedCard, cardB: UnsavedCard) {
const datasetQueryA = datasetQueryForComparison(cardA.dataset_query);
const datasetQueryB = datasetQueryForComparison(cardB.dataset_query);
return Lib.areLegacyQueriesEqual(datasetQueryA, datasetQueryB);
@@ -231,7 +232,7 @@ export function cardParametersAreEquivalent(cardA: Card, cardB: Card) {
return _.isEqual(cardA.parameters || [], cardB.parameters || []);
}
-export function cardIsEquivalent(cardA: Card, cardB: Card) {
+export function cardIsEquivalent(cardA: UnsavedCard, cardB: UnsavedCard) {
return (
cardQueryIsEquivalent(cardA, cardB) &&
cardVisualizationIsEquivalent(cardA, cardB)
diff --git a/frontend/src/metabase/common/utils/card.unit.spec.ts b/frontend/src/metabase/common/utils/card.unit.spec.ts
index f624656ad18..ef8320788f6 100644
--- a/frontend/src/metabase/common/utils/card.unit.spec.ts
+++ b/frontend/src/metabase/common/utils/card.unit.spec.ts
@@ -7,8 +7,8 @@ import * as Lib from "metabase-lib";
import { SAMPLE_METADATA, SAMPLE_PROVIDER } from "metabase-lib/test-helpers";
import {
createMockCard,
+ createMockDashCardDataSeries,
createMockDataset,
- createMockSingleSeries,
} from "metabase-types/api/mocks";
import { ORDERS_ID } from "metabase-types/api/mocks/presets";
@@ -34,7 +34,7 @@ describe("deserializeCardFromQuery", () => {
describe("getMetricSeriesWithDefaultDisplay", () => {
function createMetricSeries(query: Lib.Query) {
- return createMockSingleSeries(
+ return createMockDashCardDataSeries(
createMockCard({ type: "metric", display: "line" }),
createMockDataset({ json_query: Lib.toJsQuery(query) }),
);
@@ -89,7 +89,7 @@ describe("getMetricSeriesWithDefaultDisplay", () => {
it("preserves the display of regular questions", () => {
const series = [
- createMockSingleSeries(
+ createMockDashCardDataSeries(
createMockCard({ type: "question", display: "line" }),
createMockDataset(),
),
diff --git a/frontend/src/metabase/common/utils/series.ts b/frontend/src/metabase/common/utils/series.ts
deleted file mode 100644
index a67df1a0cb2..00000000000
--- a/frontend/src/metabase/common/utils/series.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-import type {
- Card,
- DatasetQuery,
- VisualizationSettings,
-} from "metabase-types/api";
-
-export function createSeriesCard(
- id: number,
- name: string | null,
- display: string,
- vizSettings: VisualizationSettings,
- datasetQuery?: DatasetQuery,
-): Card {
- // Unjustified type cast. FIXME
- return {
- id,
- name,
- display,
- visualization_settings: vizSettings,
- dataset_query: datasetQuery,
- } as Card;
-}
diff --git a/frontend/src/metabase/content-translation/types.ts b/frontend/src/metabase/content-translation/types.ts
index 05d2e789c6b..9f5f80fa47b 100644
--- a/frontend/src/metabase/content-translation/types.ts
+++ b/frontend/src/metabase/content-translation/types.ts
@@ -1,3 +1,5 @@
+import type { Card, DatasetData } from "metabase-types/api";
+
export type NonEmpty<ArrayType> = ArrayType extends (infer ItemType)[]
? [ItemType, ...ItemType[]]
: never;
@@ -5,3 +7,14 @@ export type NonEmpty<ArrayType> = ArrayType extends (infer ItemType)[]
export type ContentTranslationFunction = <T = string | null | undefined>(
msgid: T,
) => string | T;
+
+type PartialNullable<T> = {
+ [K in keyof T]?: T[K] | null;
+};
+
+export type TranslatableSingleSeries = {
+ card: PartialNullable<
+ Pick<Card, "name" | "display" | "visualization_settings">
+ >;
+ data?: DatasetData;
+};
diff --git a/frontend/src/metabase/dashboard/actions/getNewCardUrl.ts b/frontend/src/metabase/dashboard/actions/getNewCardUrl.ts
index c671ce80f39..e134d7ccd0b 100644
--- a/frontend/src/metabase/dashboard/actions/getNewCardUrl.ts
+++ b/frontend/src/metabase/dashboard/actions/getNewCardUrl.ts
@@ -16,6 +16,7 @@ import type {
ParameterId,
ParameterValueOrArray,
QuestionDashboardCard,
+ SeriesCard,
TemplateTag,
VirtualCard,
} from "metabase-types/api";
@@ -40,7 +41,7 @@ export const getNewCardUrl = ({
ParameterId,
ParameterValueOrArray | undefined | null
>;
- nextCard: Card | VirtualCard;
+ nextCard: SeriesCard | VirtualCard;
previousCard: Card | VirtualCard;
dashcard: QuestionDashboardCard;
objectId?: number | string;
diff --git a/frontend/src/metabase/dashboard/actions/navigation.ts b/frontend/src/metabase/dashboard/actions/navigation.ts
index 52215169587..5e5f32f0bfe 100644
--- a/frontend/src/metabase/dashboard/actions/navigation.ts
+++ b/frontend/src/metabase/dashboard/actions/navigation.ts
@@ -7,7 +7,12 @@ import * as Urls from "metabase/urls";
import { isQuestionDashCard } from "metabase/utils/dashboard";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
-import type { Card, DashboardCard, VirtualCard } from "metabase-types/api";
+import type {
+ Card,
+ DashboardCard,
+ SeriesCard,
+ VirtualCard,
+} from "metabase-types/api";
import { getNewCardUrl } from "./getNewCardUrl";
@@ -42,7 +47,7 @@ export const editQuestion = createThunkAction(
* - those all can be applied without or with a dashboard filter
*/
type NavigateToNewCardFromDashboardArgs = {
- nextCard: Card | VirtualCard;
+ nextCard: SeriesCard | VirtualCard;
previousCard: Card | VirtualCard;
dashcard: DashboardCard;
objectId?: number | string;
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
index ef2c36e677a..d47ab2b527f 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCard.tsx
@@ -1,5 +1,4 @@
import cx from "classnames";
-import { getIn } from "icepick";
import { memo, useCallback, useMemo, useRef, useState } from "react";
import { useMount, useUpdateEffect } from "react-use";
@@ -39,11 +38,15 @@ import Question from "metabase-lib/v1/Question";
import type {
Card,
DashCardId,
+ DashCardSeries,
DashboardCard,
VirtualCard,
VisualizationSettings,
} from "metabase-types/api";
-import { isVisualizerDashboardCard } from "metabase-types/guards/dashboard";
+import {
+ isDashCardDataSeries,
+ isVisualizerDashboardCard,
+} from "metabase-types/guards/dashboard";
import S from "./DashCard.module.css";
import { DashCardActionsPanel } from "./DashCardActionsPanel/DashCardActionsPanel";
@@ -168,11 +171,11 @@ function DashCardInner({
return [mainCard];
}, [mainCard, dashcard]);
- const series = useMemo(() => {
+ const series: DashCardSeries = useMemo(() => {
return cards.map((card) => {
const isSlow = card.id ? slowCards[card.id] : false;
const isUsuallyFast =
- card.query_average_duration &&
+ card.query_average_duration != null &&
card.query_average_duration < DASHBOARD_SLOW_TIMEOUT;
if (!card.id) {
@@ -180,7 +183,7 @@ function DashCardInner({
}
return {
- ...getIn(dashcardData, [card.id]),
+ ...dashcardData?.[card.id],
card,
isSlow,
isUsuallyFast,
@@ -311,6 +314,9 @@ function DashCardInner({
}, [dashcard.id, dispatch]);
const getVisualizerInitialState = useCallback(() => {
+ if (!isDashCardDataSeries(series)) {
+ return null;
+ }
if (isVisualizerDashboardCard(dashcard)) {
return getInitialStateForVisualizerCard(dashcard, datasets);
} else if (series.length > 1) {
@@ -323,9 +329,15 @@ function DashCardInner({
const onEditVisualizationClick = useCallback(() => {
const initialState = getVisualizerInitialState();
- onEditVisualization(dashcard, initialState);
+ if (initialState != null) {
+ onEditVisualization(dashcard, initialState);
+ }
}, [dashcard, onEditVisualization, getVisualizerInitialState]);
+ const handleEditVisualization = isDashCardDataSeries(series)
+ ? onEditVisualizationClick
+ : undefined;
+
const metadata = useSelector(getMetadata);
const question = useMemo(() => {
return isQuestionCard(dashcard.card)
@@ -387,7 +399,7 @@ function DashCardInner({
onPreviewToggle={handlePreviewToggle}
isTrashedOnRemove={isTrashedOnRemove}
onAddParameter={handleAddParameter}
- onEditVisualization={onEditVisualizationClick}
+ onEditVisualization={handleEditVisualization}
/>
)}
<DashCardVisualization
@@ -417,7 +429,7 @@ function DashCardInner({
onTogglePreviewing={handlePreviewToggle}
onEditVisualization={
isVisualizerDashboardCard(dashcard)
- ? onEditVisualizationClick
+ ? handleEditVisualization
: undefined
}
/>
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.tsx
index 4d65445e1e4..c2ab9907628 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.tsx
@@ -4,6 +4,7 @@ import { t } from "ttag";
import { DashboardChartSettings } from "metabase/dashboard/components/DashboardChartSettings";
import { Modal } from "metabase/ui";
import type {
+ DashCardSeries,
DashboardCard,
Series,
VisualizationSettings,
@@ -12,7 +13,7 @@ import type {
import { DashCardActionButton } from "../DashCardActionButton";
interface Props {
- series: Series;
+ series: DashCardSeries;
dashcard?: DashboardCard;
onReplaceAllVisualizationSettings: (settings: VisualizationSettings) => void;
}
@@ -51,7 +52,9 @@ export function ChartSettingsButton({
}}
>
<DashboardChartSettings
- series={series}
+ // TODO: all of the settings code assumes we have a Series with a non-optional `data` property
+ // but that's not true - virtual dashcards don't have data, so this needs to be fixed
+ series={series as Series}
onChange={onReplaceAllVisualizationSettings}
dashcard={dashcard}
onClose={close}
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.unit.spec.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.unit.spec.tsx
index bc2b6c767b4..7c2cf3417ea 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.unit.spec.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/ChartSettingsButton/ChartSettingsButton.unit.spec.tsx
@@ -7,16 +7,16 @@ import { MockDashboardContext } from "metabase/dashboard/context/mock-context";
import { registerVisualizations } from "metabase/visualizations/register";
import {
createMockColumn,
+ createMockDashCardDataSeries,
createMockDashboard,
createMockDatabase,
- createMockSingleSeries,
} from "metabase-types/api/mocks";
registerVisualizations();
const rows = [["John", "John Smith Jr"]];
const MOCK_SERIES = [
- createMockSingleSeries(
+ createMockDashCardDataSeries(
{ display: "line" },
{
data: {
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx
index 793e243b953..9ab6f688a33 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx
@@ -24,8 +24,8 @@ import { getVisualizationRaw } from "metabase/viz-core";
import type Question from "metabase-lib/v1/Question";
import type {
DashCardId,
+ DashCardSeries,
DashboardCard,
- Series,
VisualizationSettings,
} from "metabase-types/api";
import { isVisualizerDashboardCard } from "metabase-types/guards/dashboard";
@@ -41,7 +41,7 @@ import { LinkCardEditButton } from "./LinkCardEditButton/LinkCardEditButton";
import { trackVisualizeAnotherWayClicked } from "./analytics";
interface Props {
- series: Series;
+ series: DashCardSeries;
dashcard?: DashboardCard;
question: Question | null;
isLoading: boolean;
@@ -183,8 +183,9 @@ function DashCardActionsPanelInner({
if (!isLoading && !hasError) {
if (
- isVisualizerDashboardCard(dashcard) ||
- isVisualizerSupportedVisualization(dashcard?.card.display)
+ (isVisualizerDashboardCard(dashcard) ||
+ isVisualizerSupportedVisualization(dashcard?.card.display)) &&
+ onEditVisualization
) {
const label = isVisualizerDashboardCard(dashcard)
? t`Edit visualization`
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
index 5b2ccf1de16..154167b42e8 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardVisualization.tsx
@@ -39,6 +39,7 @@ import type {
CardSlownessStatus,
ClickObject,
} from "metabase/visualizations/types";
+import { DEFAULT_VISUALIZER_DISPLAY } from "metabase/visualizer/constants";
import {
createDataSource,
formatVisualizerClickObject,
@@ -55,21 +56,30 @@ import {
} from "metabase/viz-core";
import type Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import { STRUCTURED_QUERY_TEMPLATE } from "metabase-lib/v1/queries/StructuredQuery";
import type {
Card,
CardId,
DashCardId,
+ DashCardSeries,
+ DashCardSeriesItem,
DashboardCard,
Dataset,
DatasetData,
IconName,
- RawSeries,
Series,
+ SeriesCard,
VirtualCardDisplay,
VisualizationSettings,
VisualizerDataSourceId,
+ VisualizerSeries,
+ VisualizerSeriesItem,
} from "metabase-types/api";
-import { isVisualizerDashboardCard } from "metabase-types/guards/dashboard";
+import {
+ isDashCardDataSeries,
+ isVisualizerDashboardCard,
+ isVisualizerDataSeries,
+} from "metabase-types/guards/dashboard";
import { CollapsibleDashboardParameterList } from "../CollapsibleDashboardParameterList";
@@ -80,6 +90,7 @@ import S from "./DashCardVisualization.module.css";
import { getDashcardTokenId, getDashcardUuid } from "./dashcard-ids";
import type { DashCardOnChangeCardAndRunHandler } from "./types";
import {
+ getCardsFromSeries,
getMissingColumnsFromVisualizationSettings,
shouldShowParameterMapper,
} from "./utils";
@@ -91,23 +102,26 @@ import {
*
* @param series the series to sanitize
*/
-function sanitizeSeriesData(series: Series): Series {
+function sanitizeSeriesData(
+ series: (DashCardSeriesItem | VisualizerSeriesItem)[],
+): Series {
+ // TODO: all the settings code assumes we have a Series
+ // but VirtualCards don't have a dataset_query
return series.map((s) => {
- if ("data" in s) {
+ if ("data" in s && s.data != null) {
// If the series already has data, we're good
return s;
}
return {
- // @ts-expect-error according to TS this branch is impossible
...s,
data: { cols: [], rows: [] },
};
- });
+ }) as Series;
}
interface DashCardVisualizationProps {
dashcard: DashboardCard;
- series: Series;
+ series: DashCardSeries;
question: Question | null;
metadata: Metadata;
getHref?: () => string | undefined;
@@ -209,7 +223,8 @@ export function DashCardVisualization({
!dashcard ||
!rawSeries ||
rawSeries.length === 0 ||
- !isVisualizerDashboardCard(dashcard)
+ !isVisualizerDashboardCard(dashcard) ||
+ !isDashCardDataSeries(rawSeries)
) {
return;
}
@@ -229,7 +244,7 @@ export function DashCardVisualization({
}
}, [dashcard, rawSeries]);
- const untranslatedSeries = useMemo(() => {
+ const untranslatedSeries: DashCardSeries | VisualizerSeries = useMemo(() => {
if (!dashcard || !rawSeries || rawSeries.length === 0) {
return rawSeries;
}
@@ -270,24 +285,25 @@ export function DashCardVisualization({
dataSourceDatasets,
dataSources,
);
- const card = extendCardWithDashcardSettings(
- // Unjustified type cast. FIXME
+
+ const card: SeriesCard = extendCardWithDashcardSettings(
{
// Visualizer click handling code expect visualizer cards not to have card.id
name: dashcard.card.name,
description: dashcard.card.description,
- display,
+ display: display ?? DEFAULT_VISUALIZER_DISPLAY,
visualization_settings: settings,
- } as Card,
+ dataset_query: STRUCTURED_QUERY_TEMPLATE,
+ },
_.omit(dashcard.visualization_settings, "visualization"),
);
if (!everyDatasetLoaded) {
// No `data` so the parent <Visualization> picks its error or loading view.
- return [{ card }] as RawSeries;
+ return [{ card, _isVisualizer: true }];
}
- const series: RawSeries = [
+ const series: VisualizerSeries = [
{
card,
// Unjustified type cast. FIXME
@@ -297,21 +313,20 @@ export function DashCardVisualization({
datasets: dataSourceDatasets,
dataSources,
}) as DatasetData,
-
// Certain visualizations memoize settings computation based on series keys
// This guarantees a visualization always rerenders on changes
started_at: new Date().toISOString(),
-
columnValuesMapping,
-
json_query: rawSeries[0].json_query,
+ _isVisualizer: true,
},
];
if (
display &&
isCartesianChart(display) &&
- shouldSplitVisualizerSeries(columnValuesMapping)
+ shouldSplitVisualizerSeries(columnValuesMapping) &&
+ isVisualizerDataSeries(series)
) {
const dataSourceNameMap = Object.fromEntries(
dataSources.map((dataSource) => [dataSource.id, dataSource.name]),
@@ -320,14 +335,15 @@ export function DashCardVisualization({
series,
columnValuesMapping,
dataSourceNameMap,
- );
+ ).map((s) => ({ ...s, _isVisualizer: true })) satisfies VisualizerSeries;
}
return series;
}, [rawSeries, dashcard, datasets, metadata]);
- const series =
- PLUGIN_CONTENT_TRANSLATION.useTranslateSeries(untranslatedSeries);
+ const series = PLUGIN_CONTENT_TRANSLATION.useTranslateSeries<
+ DashCardSeriesItem | VisualizerSeriesItem
+ >(untranslatedSeries);
const handleOnUpdateVisualizationSettings = useCallback(
(settings: VisualizationSettings) => {
@@ -396,32 +412,46 @@ export function DashCardVisualization({
const uuid = useMemo(() => getDashcardUuid(dashcard), [dashcard]);
const findCardById = useCallback(
- (cardId?: CardId | null) => {
- const lookupSeries = isVisualizerDashboardCard(dashcard)
- ? rawSeries
- : series;
- return (
- lookupSeries.find((series) => series.card.id === cardId)?.card ??
- lookupSeries[0].card
+ (cardId?: CardId | null): Card | undefined => {
+ const cards = getCardsFromSeries(
+ isVisualizerDashboardCard(dashcard) ? rawSeries : series,
);
+ return cards.find((card) => card.id === cardId) ?? cards[0];
},
[rawSeries, dashcard, series],
);
+ const handleChangeCardAndRun = useCallback(
+ ({ nextCard, objectId }: { nextCard: SeriesCard; objectId?: number }) => {
+ const previousCard = findCardById(nextCard?.id);
+ if (previousCard) {
+ onChangeCardAndRun?.({
+ previousCard,
+ nextCard: nextCard,
+ objectId,
+ });
+ }
+ },
+ [onChangeCardAndRun, findCardById],
+ );
+
const onOpenQuestion = useCallback(
(cardId: CardId | null) => {
const card = findCardById(cardId);
- onChangeCardAndRun?.({
- previousCard: findCardById(card?.id),
- nextCard: card,
- });
+ if (card) {
+ handleChangeCardAndRun({
+ nextCard: card,
+ });
+ }
},
- [findCardById, onChangeCardAndRun],
+ [findCardById, handleChangeCardAndRun],
);
const titleMenuItems = useMemo(
() =>
- !isEditing && isVisualizerDashboardCard(dashcard) && rawSeries
+ !isEditing &&
+ isVisualizerDashboardCard(dashcard) &&
+ isDashCardDataSeries(rawSeries)
? rawSeries.map((series, index) => (
<Menu.Item
key={index}
@@ -540,7 +570,10 @@ export function DashCardVisualization({
// Visualizer cards render remapped columns,
// so click objects must be mapped back to the columns of the underlying questions before computing actions.
const transformClickObject = useMemo(() => {
- if (!isVisualizerDashboardCard(dashcard) || !rawSeries) {
+ if (
+ !isVisualizerDashboardCard(dashcard) ||
+ !isDashCardDataSeries(rawSeries)
+ ) {
return undefined;
}
const { columnValuesMapping } =
@@ -570,7 +603,10 @@ export function DashCardVisualization({
dashcard={dashcard}
rawSeries={series}
visualizerRawSeries={
- isVisualizerDashboardCard(dashcard) ? rawSeries : undefined
+ isVisualizerDashboardCard(dashcard) &&
+ isDashCardDataSeries(rawSeries)
+ ? rawSeries
+ : undefined
}
metadata={metadata}
mode={getClickActionMode ?? getDashboardClickActionMode}
@@ -597,7 +633,9 @@ export function DashCardVisualization({
transformClickObject={transformClickObject}
onUpdateVisualizationSettings={handleOnUpdateVisualizationSettings}
onTogglePreviewing={onTogglePreviewing}
- onChangeCardAndRun={onChangeCardAndRun}
+ onChangeCardAndRun={
+ onChangeCardAndRun ? handleChangeCardAndRun : null
+ }
onChangeLocation={onChangeLocation}
renderLoadingView={renderLoadingView}
titleMenuItems={titleMenuItems}
diff --git a/frontend/src/metabase/dashboard/components/DashCard/types.ts b/frontend/src/metabase/dashboard/components/DashCard/types.ts
index c289427a41a..5f5a333f279 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/types.ts
+++ b/frontend/src/metabase/dashboard/components/DashCard/types.ts
@@ -1,7 +1,7 @@
-import type { Card, DashboardCard } from "metabase-types/api";
+import type { Card, DashboardCard, SeriesCard } from "metabase-types/api";
export type NavigateToNewCardFromDashboardOpts = {
- nextCard: Card;
+ nextCard: SeriesCard;
previousCard: Card;
dashcard: DashboardCard;
objectId?: number | string;
diff --git a/frontend/src/metabase/dashboard/components/DashCard/utils.ts b/frontend/src/metabase/dashboard/components/DashCard/utils.ts
index 9522d47d9eb..e98fa80f4e4 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/utils.ts
+++ b/frontend/src/metabase/dashboard/components/DashCard/utils.ts
@@ -1,11 +1,18 @@
import { getVirtualCardType } from "metabase/dashboard/utils";
import type {
BaseDashboardCard,
- Series,
+ Card,
+ DashCardDataSeries,
+ DashCardSeriesItem,
VisualizerColumnValueSource,
VisualizerDataSourceId,
+ VisualizerSeriesItem,
VisualizerVizDefinition,
} from "metabase-types/api";
+import {
+ isVirtualCard,
+ isVisualizerSeriesItem,
+} from "metabase-types/guards/dashboard";
const VIZ_WITH_CUSTOM_MAPPING_UI = ["heading", "placeholder"];
@@ -25,7 +32,7 @@ export function shouldShowParameterMapper({
export function getMissingColumnsFromVisualizationSettings(options: {
visualizerEntity: VisualizerVizDefinition | undefined;
- rawSeries: Series;
+ rawSeries: DashCardDataSeries;
}) {
const { visualizerEntity, rawSeries } = options;
@@ -66,3 +73,20 @@ export function getMissingColumnsFromVisualizationSettings(options: {
return missingCols;
}
+
+export function getCardsFromSeries(
+ series: (DashCardSeriesItem | VisualizerSeriesItem)[],
+): Card[] {
+ const cards: Card[] = [];
+ for (const item of series) {
+ if (isVisualizerSeriesItem(item)) {
+ continue;
+ }
+ const card = item.card;
+ if (isVirtualCard(card)) {
+ continue;
+ }
+ cards.push(card);
+ }
+ return cards;
+}
diff --git a/frontend/src/metabase/dashboard/components/DashCard/utils.unit.spec.ts b/frontend/src/metabase/dashboard/components/DashCard/utils.unit.spec.ts
index fde3695b8a1..b38a1d91d1f 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/utils.unit.spec.ts
+++ b/frontend/src/metabase/dashboard/components/DashCard/utils.unit.spec.ts
@@ -2,16 +2,16 @@ import type { VisualizerVizDefinition } from "metabase-types/api";
import {
createMockCard,
createMockColumn,
+ createMockDashCardDataSeries,
createMockDataset,
createMockDatasetData,
- createMockSingleSeries,
} from "metabase-types/api/mocks";
import { getMissingColumnsFromVisualizationSettings } from "./utils";
describe("getMissingColumnsFromVisualizationSettings", () => {
const createMockSeriesWithCols = (cardId: number, cols: string[]) => [
- createMockSingleSeries(
+ createMockDashCardDataSeries(
createMockCard({ id: cardId }),
createMockDataset({
data: createMockDatasetData({
diff --git a/frontend/src/metabase/dashboard/utils.ts b/frontend/src/metabase/dashboard/utils.ts
index da72555d23c..62b65e9de5b 100644
--- a/frontend/src/metabase/dashboard/utils.ts
+++ b/frontend/src/metabase/dashboard/utils.ts
@@ -277,7 +277,7 @@ export function isDashcardAccessRestricted(
}
export function getDashcardResultsError(
- datasets: Dataset[],
+ datasets: Partial<Dataset>[],
isGuestEmbed: boolean,
) {
const permissionError = datasets
diff --git a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
index 60112f04f85..6aad72eada1 100644
--- a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/use-update-card-operations.ts
@@ -9,7 +9,11 @@ import {
} from "metabase/rich_text_editing/tiptap/EditorHost";
import * as Urls from "metabase/urls";
import Question from "metabase-lib/v1/Question";
-import type { Card, Document, VisualizationSettings } from "metabase-types/api";
+import type {
+ Document,
+ SeriesCard,
+ VisualizationSettings,
+} from "metabase-types/api";
export const useUpdateCardOperations = ({
document,
@@ -43,13 +47,7 @@ export const useUpdateCardOperations = ({
// Handle drill-through navigation
const handleChangeCardAndRun = useCallback(
- ({
- nextCard,
- }: {
- nextCard: Card;
- previousCard?: Card;
- objectId?: number;
- }) => {
+ ({ nextCard }: { nextCard: SeriesCard }) => {
if (!metadata) {
console.warn("Metadata not available for drill-through navigation");
return;
diff --git a/frontend/src/metabase/embedding/mcp/McpUiAppRoute.utils.ts b/frontend/src/metabase/embedding/mcp/McpUiAppRoute.utils.ts
index 59fbfe496fe..dca3bb50914 100644
--- a/frontend/src/metabase/embedding/mcp/McpUiAppRoute.utils.ts
+++ b/frontend/src/metabase/embedding/mcp/McpUiAppRoute.utils.ts
@@ -1,19 +1,18 @@
import { b64_to_utf8 } from "metabase/utils/encoding";
-import type { Card, VisualizationSettings } from "metabase-types/api";
+import type { SeriesCard, VisualizationSettings } from "metabase-types/api";
export const MCP_APP_VISUALIZATION_SETTINGS: VisualizationSettings = {
"graph.x_axis.labels_enabled": false,
"graph.y_axis.labels_enabled": false,
};
-export function getMcpDeserializedCard(query: string): Card | null {
+export function getMcpDeserializedCard(query: string): SeriesCard | null {
try {
- // Unjustified type cast. FIXME
return {
display: "table",
dataset_query: JSON.parse(b64_to_utf8(query)),
visualization_settings: MCP_APP_VISUALIZATION_SETTINGS,
- } as Card;
+ };
} catch {
return null;
}
diff --git a/frontend/src/metabase/embedding/mcp/hooks/useHandleMcpDrillThrough.ts b/frontend/src/metabase/embedding/mcp/hooks/useHandleMcpDrillThrough.ts
index 8a8543f2bc9..e8f9304e102 100644
--- a/frontend/src/metabase/embedding/mcp/hooks/useHandleMcpDrillThrough.ts
+++ b/frontend/src/metabase/embedding/mcp/hooks/useHandleMcpDrillThrough.ts
@@ -4,7 +4,7 @@ import { useCallback } from "react";
import * as Urls from "metabase/urls";
import { utf8_to_b64 } from "metabase/utils/encoding";
import type * as Lib from "metabase-lib";
-import type { Card } from "metabase-types/api";
+import type { SeriesCard } from "metabase-types/api";
import { storeDrillQuery } from "../api";
@@ -39,7 +39,7 @@ const isClaudeHost = (app: Pick<App, "getHostVersion">) => {
};
type DrillThroughHandler = (
- params: { drillName?: string; nextCard: Card },
+ params: { drillName?: string; nextCard: SeriesCard },
defaultNavigate: () => Promise<void>,
) => Promise<void>;
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts b/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts
index 37966453f9d..86c42ecd1ca 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/utils.ts
@@ -1,6 +1,5 @@
import { t } from "ttag";
-import { createSeriesCard } from "metabase/common/utils/series";
import { dayjs } from "metabase/dayjs";
import {
CARTESIAN_SERIES_COL_NAME,
@@ -31,6 +30,7 @@ import {
getSeriesVizSettingsKey,
isCartesianChart,
} from "metabase/viz-core";
+import { STRUCTURED_QUERY_TEMPLATE } from "metabase-lib/v1/queries/StructuredQuery";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
import {
isCountry,
@@ -51,6 +51,7 @@ import type {
ExplorationQueryType,
RowValue,
RowValues,
+ SeriesCard,
SeriesSettings,
SingleSeries,
VisualizationDisplay,
@@ -143,13 +144,13 @@ export function buildSeriesGroup({
cardVizSettings["map.colors"] = getColorplethColorScale(color);
}
}
- const card = createSeriesCard(
- query.id,
- query.name ?? null,
+ const card: SeriesCard = {
+ id: query.id,
+ name: query.name ?? undefined,
display,
- cardVizSettings,
- query.dataset_query ?? undefined,
- );
+ visualization_settings: cardVizSettings,
+ dataset_query: query.dataset_query ?? STRUCTURED_QUERY_TEMPLATE,
+ };
return { card, data: dataset.data };
});
diff --git a/frontend/src/metabase/metrics-viewer/types/viewer-state.ts b/frontend/src/metabase/metrics-viewer/types/viewer-state.ts
index 80ecff74230..6f55d1586d5 100644
--- a/frontend/src/metabase/metrics-viewer/types/viewer-state.ts
+++ b/frontend/src/metabase/metrics-viewer/types/viewer-state.ts
@@ -14,6 +14,7 @@ import type {
DimensionId,
IconName,
MathOperator,
+ SeriesCard,
SingleSeries,
TemporalUnit,
VisualizationSettings,
@@ -199,6 +200,12 @@ export interface SourceDisplayInfo {
name: string;
}
+// ── Series types ──
+
+export type MetricsViewerSeries = SingleSeries<
+ SeriesCard & Required<Pick<SeriesCard, "id" | "name">>
+>;
+
export interface UseViewerStateResult {
definitions: Record<MetricSourceId, MetricsViewerDefinitionEntry>;
formulaEntities: MetricsViewerFormulaEntity[];
@@ -208,7 +215,7 @@ export interface UseViewerStateResult {
queriesError: string | null;
modifiedDefinitionsBySlotIndex: Map<number, MetricDefinition>;
metricSlots: MetricSlot[];
- series: SingleSeries[];
+ series: MetricsViewerSeries[];
cardIdToEntityIndex: Record<CardId, number>;
activeBreakoutColors: SourceBreakoutColorMap;
sourceColors: SourceColorMap;
diff --git a/frontend/src/metabase/metrics-viewer/utils/series.ts b/frontend/src/metabase/metrics-viewer/utils/series.ts
index 7f20cde7da8..b590bd8b746 100644
--- a/frontend/src/metabase/metrics-viewer/utils/series.ts
+++ b/frontend/src/metabase/metrics-viewer/utils/series.ts
@@ -3,7 +3,6 @@ import { t } from "ttag";
import type { DimensionOption } from "metabase/common/components/DimensionPill";
import { getDimensionDescriptors } from "metabase/common/metrics/utils/dimension-descriptors";
import { getDimensionIcon } from "metabase/common/utils/columns";
-import { createSeriesCard } from "metabase/common/utils/series";
import type {
DimensionPillBarItem,
ExpressionDimensionItem,
@@ -19,6 +18,7 @@ import {
} from "metabase/viz-core";
import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";
import * as LibMetric from "metabase-lib/metric";
+import { STRUCTURED_QUERY_TEMPLATE } from "metabase-lib/v1/queries/StructuredQuery";
import type {
CardId,
Dataset,
@@ -42,6 +42,7 @@ import {
type MetricsViewerDefinitionEntry,
type MetricsViewerDisplayType,
type MetricsViewerFormulaEntity,
+ type MetricsViewerSeries,
type SelectedMetric,
type SourceBreakoutColorMap,
type SourceColorMap,
@@ -94,7 +95,7 @@ export function buildSeries({
sourceBreakoutColors,
extraVizSettings,
}: BuildSeriesParams): {
- series: SingleSeries[];
+ series: MetricsViewerSeries[];
cardIdToEntityIndex: Record<CardId, number>;
activeBreakoutColors: SourceBreakoutColorMap;
} {
@@ -142,15 +143,21 @@ export function buildSeries({
definitions,
});
const cardId = nextSyntheticCardId();
- const singleSeries: SingleSeries = {
- card: createSeriesCard(cardId, name, display, {
- ...vizSettings,
- ...extraVizSettings,
- }),
+ const singleSeries: MetricsViewerSeries = {
+ card: {
+ id: cardId,
+ name,
+ display,
+ visualization_settings: {
+ ...vizSettings,
+ ...extraVizSettings,
+ },
+ dataset_query: result.json_query ?? STRUCTURED_QUERY_TEMPLATE,
+ },
data: result.data,
};
- let entrySeries: SingleSeries[];
+ let entrySeries: MetricsViewerSeries[];
if (needsManualBreakoutSplit) {
const { series, activeBreakoutColorMap } = splitByBreakout({
entity,
@@ -394,7 +401,7 @@ function filterBreakoutColorsByData(
export interface SplitByBreakoutParams {
entity: MetricsViewerFormulaEntity;
- series: SingleSeries;
+ series: MetricsViewerSeries;
breakoutColorMap: BreakoutColorMap;
isFirstSeries: boolean;
hasMultipleSeries: boolean;
@@ -411,7 +418,7 @@ export function splitByBreakout({
display,
definitions,
}: SplitByBreakoutParams): {
- series: SingleSeries[];
+ series: MetricsViewerSeries[];
activeBreakoutColorMap: BreakoutColorMap | string | undefined;
} {
const { card, data } = series;
diff --git a/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx b/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx
index 462b073bc3f..43b9b0084b2 100644
--- a/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx
+++ b/frontend/src/metabase/metrics/components/MetricDimensionGrid/MetricDimensionGrid.tsx
@@ -23,8 +23,8 @@ import * as Urls from "metabase/urls";
import Visualization from "metabase/visualizations/components/Visualization";
import ChartSkeleton from "metabase/visualizations/components/skeletons/ChartSkeleton";
import type { MetricDefinition } from "metabase-lib/metric";
+import { STRUCTURED_QUERY_TEMPLATE } from "metabase-lib/v1/queries/StructuredQuery";
import type {
- Card,
CardDisplayType,
Dataset,
MetricDimension,
@@ -203,14 +203,14 @@ function buildSingleSeries(
return [
{
- // Unjustified type cast. FIXME
card: {
display: displayType,
visualization_settings: {
...(dimensionName ? { "graph.dimensions": [dimensionName] } : {}),
...(metricName ? { "graph.metrics": [metricName] } : {}),
},
- } as Card,
+ dataset_query: dataset.json_query ?? STRUCTURED_QUERY_TEMPLATE,
+ },
data: dataset.data,
},
];
diff --git a/frontend/src/metabase/plugins/oss/content-translation.ts b/frontend/src/metabase/plugins/oss/content-translation.ts
index 9d889a02399..be8acadc659 100644
--- a/frontend/src/metabase/plugins/oss/content-translation.ts
+++ b/frontend/src/metabase/plugins/oss/content-translation.ts
@@ -1,9 +1,11 @@
import { useCallback } from "react";
-import type { ContentTranslationFunction } from "metabase/content-translation/types";
+import type {
+ ContentTranslationFunction,
+ TranslatableSingleSeries,
+} from "metabase/content-translation/types";
import { PluginPlaceholder } from "metabase/plugins/components/PluginPlaceholder";
import type { HoveredObject } from "metabase/viz-core";
-import type { Series } from "metabase-types/api";
import type { EntityToken } from "metabase-types/api/entity";
const getDefaultPluginContentTranslation = () => ({
@@ -33,7 +35,7 @@ const getDefaultPluginContentTranslation = () => ({
locale: string;
}): string => displayName,
useTranslateFieldValuesInHoveredObject: (obj?: HoveredObject | null) => obj,
- useTranslateSeries: (obj: Series) => obj,
+ useTranslateSeries: <T extends TranslatableSingleSeries>(obj: T[]) => obj,
useSortByContentTranslation: () => (a: string, b: string) =>
a.localeCompare(b),
});
diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.ts
index 7dc78cd09da..07552663165 100644
--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.ts
+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.ts
@@ -29,7 +29,12 @@ import Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type NativeQuery from "metabase-lib/v1/queries/NativeQuery";
import { updateCardTemplateTagNames } from "metabase-lib/v1/queries/NativeQuery";
-import type { Card, SegmentId, UnsavedCard } from "metabase-types/api";
+import type {
+ Card,
+ SegmentId,
+ SeriesCard,
+ UnsavedCard,
+} from "metabase-types/api";
import type { EntityToken } from "metabase-types/api/entity";
import { isSavedCard } from "metabase-types/guards";
@@ -150,7 +155,7 @@ async function fetchAndPrepareSavedQuestionCards(
}
async function fetchAndPrepareAdHocQuestionCards(
- deserializedCard: Card,
+ deserializedCard: SeriesCard,
dispatch: Dispatch,
getState: GetState,
) {
@@ -183,7 +188,7 @@ async function fetchAndPrepareAdHocQuestionCards(
}
type ResolveCardsResult = {
- card: Card;
+ card: SeriesCard;
originalCard?: Card | null;
};
@@ -216,12 +221,7 @@ export async function resolveCards({
}
return cardId
? fetchAndPrepareSavedQuestionCards({ cardId, token }, dispatch, getState)
- : fetchAndPrepareAdHocQuestionCards(
- // Unjustified type cast. FIXME
- deserializedCard as Card,
- dispatch,
- getState,
- );
+ : fetchAndPrepareAdHocQuestionCards(deserializedCard!, dispatch, getState);
}
/**
diff --git a/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts b/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts
index 3d8f8df22c4..e38dea97432 100644
--- a/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts
+++ b/frontend/src/metabase/query_builder/actions/core/parameterUtils.ts
@@ -10,7 +10,12 @@ import { setErrorPage } from "metabase/redux/app";
import type { Dispatch } from "metabase/redux/store";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import { getCardUiParameters } from "metabase-lib/v1/parameters/utils/cards";
-import type { Card, Parameter, ParameterValuesMap } from "metabase-types/api";
+import type {
+ Card,
+ Parameter,
+ ParameterValuesMap,
+ SeriesCard,
+} from "metabase-types/api";
function shouldPropagateDashboardParameters({
cardId,
@@ -74,7 +79,7 @@ export function getParameterValuesForQuestion({
queryParams,
metadata,
}: {
- card: Card;
+ card: SeriesCard;
queryParams?: ParameterValuesMap;
metadata: Metadata;
}) {
@@ -96,13 +101,14 @@ export async function propagateDashboardParameters({
originalCard,
dispatch,
}: {
- card: Card;
+ card: SeriesCard;
deserializedCard: Card; // DashCard (has dashboardId and dashcardId)
originalCard?: Card | null;
dispatch: Dispatch;
}) {
const cardId = card.id;
if (
+ cardId &&
shouldPropagateDashboardParameters({
cardId,
deserializedCard,
diff --git a/frontend/src/metabase/query_builder/components/view/ViewFooter/use-rendered-question.ts b/frontend/src/metabase/query_builder/components/view/ViewFooter/use-rendered-question.ts
index e5627085f07..704111b4f61 100644
--- a/frontend/src/metabase/query_builder/components/view/ViewFooter/use-rendered-question.ts
+++ b/frontend/src/metabase/query_builder/components/view/ViewFooter/use-rendered-question.ts
@@ -3,6 +3,7 @@ import { t } from "ttag";
import { useSelector } from "metabase/redux";
import type Question from "metabase-lib/v1/Question";
+import type { Card } from "metabase-types/api";
import {
getIsRunning,
@@ -38,7 +39,9 @@ export const useRenderedQuestion = () => {
const renderedCard = rawSeries?.[0]?.card;
const renderedQuestion =
question != null && renderedCard != null
- ? question.setCard(renderedCard)
+ ? // Question's card is typed as Card, but it's not always actually a Card
+ // clean this up when Question gets cleaned up
+ question.setCard(renderedCard as Card)
: question;
const isPivotResult = lastRunQuestion?.display() === "pivot";
return {
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/types.ts b/frontend/src/metabase/querying/components/QueryVisualization/types.ts
index 61b87537fa4..3d2f47ff774 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/types.ts
+++ b/frontend/src/metabase/querying/components/QueryVisualization/types.ts
@@ -4,10 +4,10 @@ import type {
} from "metabase/visualizations/types";
import type Question from "metabase-lib/v1/Question";
import type {
- Card,
Dataset,
RawSeries,
Series,
+ SeriesCard,
TimelineEvent,
VisualizationSettings,
} from "metabase-types/api";
@@ -50,8 +50,8 @@ export type QueryVisualizationProps = VisualizationPassThroughProps & {
runQuestionQuery?: () => void;
cancelQuery?: () => void;
navigateToNewCardInsideQB?: (opts: {
- nextCard: Card;
- previousCard: Card;
+ nextCard: SeriesCard;
+ previousCard: SeriesCard;
objectId?: number;
}) => void;
onNavigateBack?: () => void;
diff --git a/frontend/src/metabase/static-viz/index.tsx b/frontend/src/metabase/static-viz/index.tsx
index 5ff59a336f9..1c2186048b3 100644
--- a/frontend/src/metabase/static-viz/index.tsx
+++ b/frontend/src/metabase/static-viz/index.tsx
@@ -15,6 +15,7 @@ import { createStaticRenderingContext } from "metabase/static-viz/lib/rendering-
import { measureTextEChartsAdapter } from "metabase/static-viz/lib/text";
import { updateStartOfWeek } from "metabase/utils/i18n";
import MetabaseSettings from "metabase/utils/settings";
+import { DEFAULT_VISUALIZER_DISPLAY } from "metabase/visualizer/constants";
import { createDataSource } from "metabase/visualizer/utils/data-source";
import { getVisualizationColumns } from "metabase/visualizer/utils/get-visualization-columns";
import { mergeVisualizerData } from "metabase/visualizer/utils/merge-data";
@@ -28,6 +29,7 @@ import {
isCartesianChart,
makeCellBackgroundGetter,
} from "metabase/viz-core";
+import { STRUCTURED_QUERY_TEMPLATE } from "metabase-lib/v1/queries/StructuredQuery";
import type {
Card,
DashCardVisualizationSettings,
@@ -35,6 +37,7 @@ import type {
DatasetData,
GeoJSONData,
RawSeries,
+ SeriesCard,
SettingKey,
VisualizerDataSourceId,
VisualizerVizDefinition,
@@ -102,11 +105,11 @@ function getVisualizerRawSeries(
return [
{
- // Unjustified type cast. FIXME
card: {
- display,
+ display: display ?? DEFAULT_VISUALIZER_DISPLAY,
visualization_settings: settings,
- } as Card,
+ dataset_query: STRUCTURED_QUERY_TEMPLATE,
+ },
// Unjustified type cast. FIXME
data: mergeVisualizerData({
columns,
@@ -120,7 +123,7 @@ function getVisualizerRawSeries(
}
function RenderChart(
- rawSeries: RawSeries,
+ rawSeries: RawSeries<Card>,
dashcardSettings: RenderChartDashcardSettings,
options: RenderChartOptions,
) {
@@ -141,7 +144,7 @@ function RenderChart(
options.applicationColors,
);
- let seriesForRender = rawSeries;
+ let seriesForRender: RawSeries<SeriesCard> = rawSeries;
if (dashcardSettings.visualization) {
const { visualization } = dashcardSettings;
const dataSources = rawSeries.map((series) =>
diff --git a/frontend/src/metabase/static-viz/types.ts b/frontend/src/metabase/static-viz/types.ts
index b6b0e9c0641..6c38b1456a1 100644
--- a/frontend/src/metabase/static-viz/types.ts
+++ b/frontend/src/metabase/static-viz/types.ts
@@ -1,5 +1,6 @@
import type { ColorPalette } from "metabase/ui/colors/types";
import type {
+ Card,
ColumnFormattingSetting,
DashCardVisualizationSettings,
DatasetColumn,
@@ -32,7 +33,7 @@ export type RenderChartDashcardSettings = DashCardVisualizationSettings & {
// The default (isomorphic) path — anything StaticVisualization can render.
export type IsomorphicChartInput = {
kind?: undefined;
- rawSeries: RawSeries;
+ rawSeries: RawSeries<Card>;
dashcardSettings: RenderChartDashcardSettings;
options: RenderChartOptions;
};
diff --git a/frontend/src/metabase/utils/dashboard.ts b/frontend/src/metabase/utils/dashboard.ts
index 5ed03f99121..de1b367493d 100644
--- a/frontend/src/metabase/utils/dashboard.ts
+++ b/frontend/src/metabase/utils/dashboard.ts
@@ -5,13 +5,15 @@ import { isUuid } from "metabase/utils/uuid";
import type {
ActionDashboardCard,
BaseDashboardCard,
- Card,
QuestionDashboardCard,
+ SeriesCard,
VirtualCard,
VirtualDashboardCard,
} from "metabase-types/api";
-export function isQuestionCard(card: Card | VirtualCard) {
+export function isQuestionCard(
+ card: SeriesCard | VirtualCard,
+): card is SeriesCard {
// Some old virtual cards have dataset_query equal to {} so we need to check for null and empty object
return (
card.dataset_query != null && Object.keys(card.dataset_query).length > 0
diff --git a/frontend/src/metabase/visualizations/components/ChoroplethMap.utils.ts b/frontend/src/metabase/visualizations/components/ChoroplethMap.utils.ts
index cc619aee787..fb880625aef 100644
--- a/frontend/src/metabase/visualizations/components/ChoroplethMap.utils.ts
+++ b/frontend/src/metabase/visualizations/components/ChoroplethMap.utils.ts
@@ -15,7 +15,7 @@ export type FeatureClickContext = {
settings: VisualizationSettings;
getFeatureName: (feature: Feature) => string;
getFeatureKey: (feature: Feature, opts?: { lowerCase?: boolean }) => string;
- cardId: CardId;
+ cardId: CardId | undefined;
};
export function buildFeatureClickObject(
diff --git a/frontend/src/metabase/visualizations/components/TransformedVisualization/TransformedVisualization.tsx b/frontend/src/metabase/visualizations/components/TransformedVisualization/TransformedVisualization.tsx
index 7fb86352a74..ae1d68b2f27 100644
--- a/frontend/src/metabase/visualizations/components/TransformedVisualization/TransformedVisualization.tsx
+++ b/frontend/src/metabase/visualizations/components/TransformedVisualization/TransformedVisualization.tsx
@@ -46,10 +46,6 @@ export const TransformedVisualization = ({
const handleChangeCardCandRun: OnChangeCardAndRun = useCallback(
(options: OnChangeCardAndRunOpts) => {
const cards = rawSeries.map((series) => series.card);
- const previousCard =
- options.previousCard != null
- ? cards.find((c) => c.id === options.previousCard?.id)
- : undefined;
const nextCard = cards.find((c) => c.id === options.nextCard.id);
if (!nextCard) {
@@ -63,7 +59,6 @@ export const TransformedVisualization = ({
const transformedOptions: OnChangeCardAndRunOpts = {
...options,
nextCard,
- previousCard,
};
onChangeCardAndRun?.(transformedOptions);
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
index 530b0c76ad3..9b48237e2c4 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
@@ -27,6 +27,7 @@ import type { Path } from "metabase/router";
import { getTokenFeature } from "metabase/settings";
import { getFont } from "metabase/styled-components/selectors";
import type { IconProps } from "metabase/ui";
+import { isQuestionCard } from "metabase/utils/dashboard";
import { formatNumber } from "metabase/utils/formatting";
import { memoizeClass } from "metabase/utils/memoize";
import { getVisualizationComponent } from "metabase/visualizations";
@@ -65,15 +66,16 @@ import {
import Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
- Card,
CardId,
Dashboard,
DashboardCard,
IconName,
RawSeries,
Series,
+ SeriesCard,
SingleSeries,
TimelineEvent,
+ VirtualCard,
VisualizationSettings,
} from "metabase-types/api";
import { isVisualizerDashboardCard } from "metabase-types/guards/dashboard";
@@ -110,12 +112,19 @@ type ForwardedRefProps = {
};
type OnChangeCardAndRunOpts = {
- nextCard: Card;
- previousCard: Card;
+ nextCard: SeriesCard;
+ previousCard: SeriesCard;
objectId?: number;
drillName?: string;
};
+type VisualizationRawSeries = (
+ | SingleSeries
+ | {
+ card: SeriesCard | VirtualCard;
+ }
+)[];
+
type VisualizationOwnProps = {
actionButtons?: ReactNode | null;
className?: string;
@@ -154,12 +163,7 @@ type VisualizationOwnProps = {
metadata?: Metadata;
mode?: ClickActionModeGetter | ClickActionsMode | QueryClickActionsMode;
editSummary?: () => void;
- rawSeries?: (
- | SingleSeries
- | {
- card: Card;
- }
- )[];
+ rawSeries?: VisualizationRawSeries;
visualizerRawSeries?: RawSeries;
replacementContent?: JSX.Element | null;
selectedTimelineEventIds?: number[];
@@ -433,7 +437,7 @@ class Visualization extends PureComponent<
private static getQuestionForCard(
metadata: Metadata | undefined,
- card: Card | undefined,
+ card: SeriesCard | undefined,
) {
return !!card && !!metadata ? new Question(card, metadata) : undefined;
}
@@ -448,12 +452,7 @@ class Visualization extends PureComponent<
computedSettings: Record<string, string>,
dashcard?: DashboardCard,
metadata?: Metadata,
- rawSeries: (
- | SingleSeries
- | {
- card: Card;
- }
- )[] = [],
+ rawSeries: VisualizationRawSeries = [],
visualizerRawSeries: RawSeries = [],
isRawTable = false,
getExtraDataForClick: (
@@ -475,6 +474,9 @@ class Visualization extends PureComponent<
rawSeries,
visualizerRawSeries,
);
+ if (!isQuestionCard(card)) {
+ return [];
+ }
const question = Visualization.getQuestionForCard(metadata, card);
const modeInstance = Visualization.getMode(mode, question);
@@ -551,12 +553,7 @@ class Visualization extends PureComponent<
private static findCardById(
cardId?: CardId | null,
dashcard?: DashboardCard,
- rawSeries: (
- | SingleSeries
- | {
- card: Card;
- }
- )[] = [],
+ rawSeries: VisualizationRawSeries = [],
visualizerRawSeries: RawSeries = [],
) {
const isVisualizerDashCard = isVisualizerDashboardCard(dashcard);
@@ -625,17 +622,21 @@ class Visualization extends PureComponent<
const { dashcard, rawSeries, visualizerRawSeries, onChangeCardAndRun } =
this.props;
- onChangeCardAndRun?.({
- previousCard: Visualization.findCardById(
- nextCard?.id,
- dashcard,
- rawSeries,
- visualizerRawSeries,
- ),
- nextCard,
- objectId,
- drillName,
- });
+ const previousCard = Visualization.findCardById(
+ nextCard?.id,
+ dashcard,
+ rawSeries,
+ visualizerRawSeries,
+ );
+
+ if (isQuestionCard(previousCard)) {
+ onChangeCardAndRun?.({
+ previousCard,
+ nextCard,
+ objectId,
+ drillName,
+ });
+ }
};
onRender = ({ warnings = [] }: { warnings?: string[] } = {}) => {
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Watermark/Watermark.tsx b/frontend/src/metabase/visualizations/components/Visualization/Watermark/Watermark.tsx
index 4eb7ce28ef4..15d9d7bbb25 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Watermark/Watermark.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Watermark/Watermark.tsx
@@ -1,9 +1,13 @@
import { isVirtualDashCard } from "metabase/utils/dashboard";
-import type { BaseDashboardCard, Card } from "metabase-types/api";
+import type { BaseDashboardCard, SeriesCard } from "metabase-types/api";
import S from "./Watermark.module.css";
-export const Watermark = ({ card }: { card: Card | BaseDashboardCard }) => {
+export const Watermark = ({
+ card,
+}: {
+ card: SeriesCard | BaseDashboardCard;
+}) => {
if (isVirtualDashCard(card)) {
return null;
}
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index 67cffad3cb3..b5bd4ad3a57 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -13,7 +13,6 @@ import type { BrushClickObject } from "metabase-lib/query/types";
import type Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
- Card,
Dashboard,
DashboardCard,
DatasetColumn,
@@ -23,6 +22,7 @@ import type {
RowValue,
RowValues,
Series,
+ SeriesCard,
TimelineEvent,
TimelineEventId,
VisualizationSettings,
@@ -40,8 +40,7 @@ export type TableCellFormatter = (value: RowValue) => ReactNode;
export type CardSlownessStatus = "usually-fast" | "usually-slow" | boolean;
export type OnChangeCardAndRunOpts = {
- previousCard?: Card;
- nextCard: Card;
+ nextCard: SeriesCard;
seriesIndex?: number;
objectId?: number;
drillName?: string;
@@ -58,7 +57,7 @@ export interface VisualizationProps {
series: Series;
dashboard?: Dashboard;
dashcard?: DashboardCard;
- card: Card;
+ card: SeriesCard;
getHref?: () => string | undefined;
data: DatasetData;
metadata?: Metadata;
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
index 2bf3b69f590..ef50904a312 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/events.unit.spec.ts
@@ -62,6 +62,7 @@ const dimensionModel: DimensionModel = {
column: createdAtColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: createdAtColumn },
+ columns: [createdAtColumn],
};
describe("getEventDimensions", () => {
@@ -156,6 +157,7 @@ describe("getEventDimensions", () => {
column: monthColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: monthColumn },
+ columns: [monthColumn],
};
const seriesModel = createMockSeriesModel({
@@ -253,6 +255,7 @@ describe("getEventDimensions", () => {
column: categoryColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: categoryColumn },
+ columns: [categoryColumn],
};
const seriesModel = createMockSeriesModel({
dataKey: countKey,
@@ -326,6 +329,7 @@ describe("getSeriesClickData", () => {
column: createdAtColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: createdAtColumn },
+ columns: [createdAtColumn],
},
cardsColumns: [
{
@@ -399,6 +403,7 @@ describe("getSeriesClickData", () => {
column: categoryColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: categoryColumn },
+ columns: [categoryColumn],
},
cardsColumns: [
{
@@ -561,6 +566,7 @@ describe("getBrushClickObject", () => {
column: createdAtColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: createdAtColumn },
+ columns: [createdAtColumn],
},
xAxisModel: {
axisType: "time",
@@ -607,6 +613,7 @@ describe("getBrushClickObject", () => {
column: priceColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: priceColumn },
+ columns: [priceColumn],
},
xAxisModel: {
axisType: "value",
@@ -657,6 +664,7 @@ describe("getAdjustedBrushEndEvent", () => {
column: createdAtColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: createdAtColumn },
+ columns: [createdAtColumn],
},
xAxisModel: {
axisType: "time",
diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.unit.spec.ts
index 45407338c1f..2370f52fc7c 100644
--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.unit.spec.ts
@@ -67,6 +67,7 @@ describe("getHoveredFromHighlighted", () => {
[CARD_ID]: categoryColumn,
[OTHER_CARD_ID]: categoryColumn,
},
+ columns: [categoryColumn, categoryColumn],
},
cardsColumns,
});
@@ -348,6 +349,7 @@ describe("getHoveredFromHighlighted", () => {
column: createdAtColumn,
columnIndex: 0,
columnByCardId: { [CARD_ID]: createdAtColumn },
+ columns: [createdAtColumn],
},
cardsColumns: [
{
diff --git a/frontend/src/metabase/visualizations/visualizations/RowChart/definition.ts b/frontend/src/metabase/visualizations/visualizations/RowChart/definition.ts
index 3e8e69b4203..da93325a4af 100644
--- a/frontend/src/metabase/visualizations/visualizations/RowChart/definition.ts
+++ b/frontend/src/metabase/visualizations/visualizations/RowChart/definition.ts
@@ -19,8 +19,8 @@ import {
} from "metabase/viz-core";
import { isDimension, isMetric } from "metabase-lib/v1/types/utils/isa";
import type {
- Card,
DatasetData,
+ SeriesCard,
TransformedCard,
VisualizationSettings,
} from "metabase-types/api";
@@ -121,6 +121,6 @@ export const ROW_CHART_DEFINITION: VisualizationDefinition = {
},
};
-function isTransformedCard(card: Card): card is TransformedCard {
+function isTransformedCard(card: SeriesCard): card is TransformedCard {
return "_transformed" in card && card._transformed === true;
}
diff --git a/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts b/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts
index a4e647b69a8..2891c6bace3 100644
--- a/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts
+++ b/frontend/src/metabase/visualizations/visualizations/SankeyChart/events.ts
@@ -17,7 +17,7 @@ import {
} from "metabase/viz-core";
import Question from "metabase-lib/v1/Question";
import { getColumnKey } from "metabase-lib/v1/queries/utils/column-key";
-import type { Card, RawSeries, RowValue } from "metabase-types/api";
+import type { RawSeries, RowValue, SeriesCard } from "metabase-types/api";
const getSankeyClickData = (
[
@@ -44,7 +44,7 @@ const isSankeyNodeEvent = (
event: EChartsSeriesMouseEvent<SankeyLink | SankeyNode>,
): event is EChartsSeriesMouseEvent<SankeyNode> => event.dataType === "node";
-const isNativeQuery = (card: Card) => {
+const isNativeQuery = (card: SeriesCard) => {
const question = new Question(card);
return question.isNative();
};
diff --git a/frontend/src/metabase/visualizer/constants.ts b/frontend/src/metabase/visualizer/constants.ts
index ee1a11967f9..22b70b9b8a9 100644
--- a/frontend/src/metabase/visualizer/constants.ts
+++ b/frontend/src/metabase/visualizer/constants.ts
@@ -14,3 +14,5 @@ export const DROPPABLE_ID = {
SCATTER_BUBBLE_SIZE_WELL: "SCATTER_BUBBLE_SIZE_WELL",
};
+
+export const DEFAULT_VISUALIZER_DISPLAY = "bar";
diff --git a/frontend/src/metabase/visualizer/selectors.ts b/frontend/src/metabase/visualizer/selectors.ts
index 312eff58f9c..52237674705 100644
--- a/frontend/src/metabase/visualizer/selectors.ts
+++ b/frontend/src/metabase/visualizer/selectors.ts
@@ -10,7 +10,8 @@ import {
getVisualizationTransformed,
isCartesianChart,
} from "metabase/viz-core";
-import type { Card, DatasetData, RawSeries } from "metabase-types/api";
+import { STRUCTURED_QUERY_TEMPLATE } from "metabase-lib/v1/queries/StructuredQuery";
+import type { DatasetData, RawSeries } from "metabase-types/api";
import {
createDataSource,
@@ -156,14 +157,13 @@ const getVisualizerFlatRawSeries = createSelector(
const series: RawSeries = [
{
- // Unjustified type cast. FIXME
card: {
display,
- dataset_query: {},
+ dataset_query: STRUCTURED_QUERY_TEMPLATE,
name: cards[0].name,
description: cards[0].description,
visualization_settings: settings,
- } as Card,
+ },
data,
@@ -249,14 +249,13 @@ export const getTabularPreviewSeries = createSelector(
return [
{
...rest,
- // Unjustified type cast. FIXME
card: {
display: "table",
- dataset_query: {},
+ dataset_query: STRUCTURED_QUERY_TEMPLATE,
visualization_settings: {},
- } as Card,
+ },
},
- ];
+ ] satisfies RawSeries;
},
);
diff --git a/frontend/src/metabase/visualizer/utils/dashboard-card-supports-visualizer.ts b/frontend/src/metabase/visualizer/utils/dashboard-card-supports-visualizer.ts
index efab4b1a803..3597c56a52a 100644
--- a/frontend/src/metabase/visualizer/utils/dashboard-card-supports-visualizer.ts
+++ b/frontend/src/metabase/visualizer/utils/dashboard-card-supports-visualizer.ts
@@ -1,8 +1,6 @@
import { visualizations } from "metabase/viz-core";
import type { VisualizationDisplay } from "metabase-types/api";
-export const DEFAULT_VISUALIZER_DISPLAY = "bar";
-
export function isVisualizerSupportedVisualization(
display: VisualizationDisplay | null | undefined,
) {
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 fa6dc3e7e9b..5582476870a 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
@@ -18,6 +18,7 @@ import type {
VisualizationDisplay,
} from "metabase-types/api";
+import { DEFAULT_VISUALIZER_DISPLAY } from "../constants";
import {
createDimensionColumn,
createMetricColumn,
@@ -30,10 +31,7 @@ import {
extractReferencedColumns,
rewriteRemappedReferences,
} from "./column";
-import {
- DEFAULT_VISUALIZER_DISPLAY,
- isVisualizerSupportedVisualization,
-} from "./dashboard-card-supports-visualizer";
+import { isVisualizerSupportedVisualization } from "./dashboard-card-supports-visualizer";
import { createDataSource, createDataSourceNameRef } from "./data-source";
import { updateVizSettingsWithRefs } from "./update-viz-settings-with-refs";
import { getColumnVizSettings } from "./viz-settings";
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts
index 1ba6ba51ec2..e9cb91f04b9 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.ts
@@ -2,9 +2,9 @@ import type { VisualizerVizDefinitionWithColumnsAndPreloadedDatasets } from "met
import { isNotNull } from "metabase/utils/types";
import type {
Card,
+ DashCardDataSeries,
Dataset,
DatasetColumn,
- RawSeries,
VisualizerColumnReference,
VisualizerDataSource,
} from "metabase-types/api";
@@ -108,7 +108,9 @@ function processColumnsForDataSource(
return columnInfos;
}
-export function getInitialStateForMultipleSeries(rawSeries: RawSeries) {
+export function getInitialStateForMultipleSeries(
+ rawSeries: DashCardDataSeries,
+) {
const mainCard = rawSeries[0].card;
const state: VisualizerVizDefinitionWithColumnsAndPreloadedDatasets = {
diff --git a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
index 57a8e49d360..4c315767c2d 100644
--- a/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
+++ b/frontend/src/metabase/visualizer/utils/get-initial-state-for-multiple-series.unit.spec.ts
@@ -3,8 +3,8 @@ import { registerVisualization } from "metabase/viz-core";
import {
createMockCard,
createMockColumn,
+ createMockDashCardDataSeries,
createMockDatasetData,
- createMockSingleSeries,
} from "metabase-types/api/mocks";
import { getInitialStateForMultipleSeries } from "./get-initial-state-for-multiple-series";
@@ -36,7 +36,7 @@ describe("getInitialVisualizerStateForMultipleSeries", () => {
});
const rawSeries = [
- createMockSingleSeries(firstCard, {
+ createMockDashCardDataSeries(firstCard, {
data: createMockDatasetData({
cols: [
createMockColumn({ name: "Date" }),
@@ -44,7 +44,7 @@ describe("getInitialVisualizerStateForMultipleSeries", () => {
],
}),
}),
- createMockSingleSeries(secondCard, {
+ createMockDashCardDataSeries(secondCard, {
data: createMockDatasetData({
cols: [
createMockColumn({ name: "Date" }),
diff --git a/frontend/src/metabase/visualizer/utils/viz-settings.ts b/frontend/src/metabase/visualizer/utils/viz-settings.ts
index 5f38d55d195..a36146de014 100644
--- a/frontend/src/metabase/visualizer/utils/viz-settings.ts
+++ b/frontend/src/metabase/visualizer/utils/viz-settings.ts
@@ -4,10 +4,9 @@ import {
} from "metabase/viz-core";
import type { VisualizationDisplay } from "metabase-types/api";
-import {
- DEFAULT_VISUALIZER_DISPLAY,
- isVisualizerSupportedVisualization,
-} from "./dashboard-card-supports-visualizer";
+import { DEFAULT_VISUALIZER_DISPLAY } from "../constants";
+
+import { isVisualizerSupportedVisualization } from "./dashboard-card-supports-visualizer";
const isDataSetting = ({ widget }: VisualizationSettingDefinition) => {
// TODO Come up with a better condition
diff --git a/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.ts b/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.ts
index 678cfbd0725..647bb597cb7 100644
--- a/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.ts
+++ b/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.ts
@@ -957,7 +957,7 @@ function getTimeSeriesXAxisInfo(
// 2. count - how many intervals per tick?
// 3. timezone - what timezone are values in? days vary in length by timezone
const unit = minTimeseriesUnit(
- Object.values(dimensionModel.columnByCardId)
+ dimensionModel.columns
.map((column) =>
isAbsoluteDateTimeUnit(column.unit) ? column.unit : null,
)
diff --git a/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.unit.spec.ts b/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.unit.spec.ts
index a17e340ea55..76772a8c91e 100644
--- a/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.unit.spec.ts
+++ b/frontend/src/metabase/viz-core/echarts/cartesian/model/axis.unit.spec.ts
@@ -74,6 +74,7 @@ describe("getXAxisModel", () => {
column: dateColumn,
columnIndex: 0,
columnByCardId: { 1: dateColumn },
+ columns: [dateColumn],
};
const dataset = [
@@ -101,6 +102,7 @@ describe("getXAxisModel", () => {
column: dateColumn,
columnIndex: 0,
columnByCardId: { 1: dateColumn },
+ columns: [dateColumn],
};
const settings = createMockVisualizationSettings({
diff --git a/frontend/src/metabase/viz-core/echarts/cartesian/model/dataset.ts b/frontend/src/metabase/viz-core/echarts/cartesian/model/dataset.ts
index f0a0c3cf789..f93c0c86196 100644
--- a/frontend/src/metabase/viz-core/echarts/cartesian/model/dataset.ts
+++ b/frontend/src/metabase/viz-core/echarts/cartesian/model/dataset.ts
@@ -100,7 +100,7 @@ const aggregateColumnValuesForDatum = (
datum: Record<DataKey, RowValue>,
columns: DatasetColumnInfo[],
row: RowValue[],
- cardId: number,
+ cardId: number | undefined,
dimensionIndex: number,
breakoutIndex: number | undefined,
untranslatedBreakoutValue: RowValue | undefined,
diff --git a/frontend/src/metabase/viz-core/echarts/cartesian/model/series.ts b/frontend/src/metabase/viz-core/echarts/cartesian/model/series.ts
index 915dfc8d083..2461bb50481 100644
--- a/frontend/src/metabase/viz-core/echarts/cartesian/model/series.ts
+++ b/frontend/src/metabase/viz-core/echarts/cartesian/model/series.ts
@@ -200,7 +200,7 @@ export const getCardSeriesModels = (
isFirstCard: boolean,
settings: ComputedVisualizationSettings,
): SeriesModel[] => {
- const cardId = card.id ?? null;
+ const cardId = card.id;
const hasBreakout = "breakout" in columns;
// TODO: separate scatter plot and combo charts into separate models
const hasBubbleSize = "bubbleSize" in columns;
@@ -339,15 +339,17 @@ export const getDimensionModel = (
return {
column: cardsColumns[0].dimension.column,
columnIndex: cardsColumns[0].dimension.index,
- columnByCardId: rawSeries.reduce(
+ columnByCardId: rawSeries.reduce<Record<CardId, DatasetColumn>>(
(columnByCardId, series, index) => {
const cardColumns = cardsColumns[index];
- columnByCardId[series.card.id] = cardColumns.dimension.column;
+ if (series.card.id) {
+ columnByCardId[series.card.id] = cardColumns.dimension.column;
+ }
return columnByCardId;
},
- // Unjustified type cast. FIXME
- {} as Record<CardId, DatasetColumn>,
+ {},
),
+ columns: cardsColumns.map((cardColumns) => cardColumns.dimension.column),
};
};
diff --git a/frontend/src/metabase/viz-core/echarts/cartesian/model/types.ts b/frontend/src/metabase/viz-core/echarts/cartesian/model/types.ts
index 9bb5c0f9a66..f283b8f9492 100644
--- a/frontend/src/metabase/viz-core/echarts/cartesian/model/types.ts
+++ b/frontend/src/metabase/viz-core/echarts/cartesian/model/types.ts
@@ -88,6 +88,8 @@ export type DimensionModel = {
columnIndex: number;
// All dimension columns by their card id
columnByCardId: Record<CardId, DatasetColumn>;
+ // all cards' dimension columns
+ columns: DatasetColumn[];
};
export type Datum = Record<DataKey, RowValue> & {
diff --git a/frontend/src/metabase/viz-core/echarts/cartesian/option/ticks.unit.spec.ts b/frontend/src/metabase/viz-core/echarts/cartesian/option/ticks.unit.spec.ts
index ebc386a384b..c993c20c787 100644
--- a/frontend/src/metabase/viz-core/echarts/cartesian/option/ticks.unit.spec.ts
+++ b/frontend/src/metabase/viz-core/echarts/cartesian/option/ticks.unit.spec.ts
@@ -21,6 +21,7 @@ describe("getTicksOptions", () => {
column: dateColumn,
columnIndex: 0,
columnByCardId: { 1: dateColumn },
+ columns: [dateColumn],
};
const first = "2025-03-30";
const last = "2025-04-01";
diff --git a/frontend/src/metabase/viz-core/lib/series.ts b/frontend/src/metabase/viz-core/lib/series.ts
index dac747103ef..9138ff8df48 100644
--- a/frontend/src/metabase/viz-core/lib/series.ts
+++ b/frontend/src/metabase/viz-core/lib/series.ts
@@ -6,6 +6,7 @@ import type {
DatasetQuery,
RawSeries,
Series,
+ SeriesCard,
VisualizationDisplay,
VisualizationSettings,
} from "metabase-types/api";
@@ -20,7 +21,7 @@ export const updateSeriesColor = (
return assocIn(settings, [SERIES_SETTING_KEY, seriesKey, "color"], color);
};
-export const getNameForCard = (card: Card) => {
+export const getNameForCard = (card: SeriesCard) => {
return card?.name || "";
};
diff --git a/frontend/src/metabase/viz-core/lib/settings/series.ts b/frontend/src/metabase/viz-core/lib/settings/series.ts
index f882a0582ad..f1541e701ca 100644
--- a/frontend/src/metabase/viz-core/lib/settings/series.ts
+++ b/frontend/src/metabase/viz-core/lib/settings/series.ts
@@ -2,8 +2,8 @@ import { getIn } from "icepick";
import { t } from "ttag";
import type {
- Card,
Series,
+ SeriesCard,
SingleSeries,
VisualizationSettings,
} from "metabase-types/api";
@@ -46,8 +46,8 @@ function hasSingleSeriesKey(single: SingleSeries): boolean {
}
function isLegacySeriesCard(
- card: Card,
-): card is Card & LegacySeriesSettingsObjectKey["card"] {
+ card: SeriesCard,
+): card is SeriesCard & LegacySeriesSettingsObjectKey["card"] {
return "_seriesKey" in card;
}
diff --git a/frontend/src/metabase/viz-core/lib/settings/typed-utils.ts b/frontend/src/metabase/viz-core/lib/settings/typed-utils.ts
index d2ad0dcd31a..9474268b87d 100644
--- a/frontend/src/metabase/viz-core/lib/settings/typed-utils.ts
+++ b/frontend/src/metabase/viz-core/lib/settings/typed-utils.ts
@@ -2,7 +2,7 @@ import { getIn } from "icepick";
import _ from "underscore";
import type {
- Card,
+ SeriesCard,
TableColumnOrderSetting,
VirtualCard,
VisualizationSettings,
@@ -81,10 +81,9 @@ export function sanitizeDashcardSettings(
});
}
-export function extendCardWithDashcardSettings<T extends Card | VirtualCard>(
- card: T,
- dashcardSettings?: VisualizationSettings,
-): T {
+export function extendCardWithDashcardSettings<
+ T extends SeriesCard | VirtualCard,
+>(card: T, dashcardSettings?: VisualizationSettings): T {
// Legacy broken behavior: When editing dashcard viz settings, we save both the edited setting and any settings with
// persistDefault: true. This leads to saving data settings like graph.dimensions/graph.metrics even when they can't be edited in dashboards.
const visualization = getVisualization(card.display);
diff --git a/frontend/src/metabase/viz-core/lib/utils.ts b/frontend/src/metabase/viz-core/lib/utils.ts
index ab3190aaa20..64f3708b902 100644
--- a/frontend/src/metabase/viz-core/lib/utils.ts
+++ b/frontend/src/metabase/viz-core/lib/utils.ts
@@ -10,13 +10,13 @@ import {
isMetric,
} from "metabase-lib/v1/types/utils/isa";
import type {
- Card,
CardId,
DatasetColumn,
DatasetData,
JsonQuery,
RowValues,
Series,
+ SeriesCard,
SingleSeries,
VirtualCard,
} from "metabase-types/api";
@@ -156,9 +156,14 @@ export function computeSplit(
}
}
+interface SameSeriesInput {
+ card?: SeriesCard | VirtualCard;
+ data?: DatasetData;
+}
+
export function isSameSeries(
- seriesA: Partial<Pick<SingleSeries, "card" | "data">>[] | undefined,
- seriesB: Partial<Pick<SingleSeries, "card" | "data">>[] | undefined,
+ seriesA: SameSeriesInput[] | undefined,
+ seriesB: SameSeriesInput[] | undefined,
): boolean {
if (!seriesA || !seriesB) {
return seriesA === seriesB;
@@ -251,16 +256,15 @@ export function getColumnExtent(
// TODO Atte Keinänen 5/30/17 Extract to metabase-lib card/question logic
export const cardHasBecomeDirty = (
- nextCard: Card | VirtualCard,
- previousCard: Card | VirtualCard,
+ nextCard: SeriesCard | VirtualCard,
+ previousCard: SeriesCard | VirtualCard,
): boolean =>
!_.isEqual(previousCard.dataset_query, nextCard.dataset_query) ||
previousCard.display !== nextCard.display;
-export function getCardAfterVisualizationClick<T extends Card | VirtualCard>(
- nextCard: T,
- previousCard: T,
-): T {
+export function getCardAfterVisualizationClick<
+ T extends SeriesCard | VirtualCard,
+>(nextCard: T, previousCard: T): T {
if (cardHasBecomeDirty(nextCard, previousCard)) {
const isMultiseriesQuestion = !nextCard.id;
const alreadyHadLineage = !!previousCard.original_card_id;
diff --git a/frontend/src/metabase/viz-core/shared/settings/cartesian-chart.ts b/frontend/src/metabase/viz-core/shared/settings/cartesian-chart.ts
index 4b7304b2333..ace69696361 100644
--- a/frontend/src/metabase/viz-core/shared/settings/cartesian-chart.ts
+++ b/frontend/src/metabase/viz-core/shared/settings/cartesian-chart.ts
@@ -11,9 +11,9 @@ import {
isNumeric,
} from "metabase-lib/v1/types/utils/isa";
import type {
- Card,
DatasetColumn,
RawSeries,
+ SeriesCard,
SeriesOrderSetting,
VisualizationDisplay,
} from "metabase-types/api";
@@ -157,7 +157,7 @@ export const getDefaultShowStackValues = (
export const getDefaultStackingValue = (
settings: ComputedVisualizationSettings,
- card: Card,
+ card: SeriesCard,
) => {
// legacy setting and default for D-M-M+ charts
if (settings["stackable.stacked"]) {
diff --git a/frontend/src/metabase/viz-core/shared/settings/pie.ts b/frontend/src/metabase/viz-core/shared/settings/pie.ts
index f92911298b1..29e8702f11d 100644
--- a/frontend/src/metabase/viz-core/shared/settings/pie.ts
+++ b/frontend/src/metabase/viz-core/shared/settings/pie.ts
@@ -5,7 +5,6 @@ import { NULL_DISPLAY_VALUE } from "metabase/utils/constants";
import { checkNotNull, checkNumber, isNumber } from "metabase/utils/types";
import {
type DatasetColumn,
- type MaybeTranslatedSeries,
type PieRow,
type RawSeries,
type RowValue,
@@ -213,7 +212,7 @@ export function getColors(
}
export function getPieRows(
- rawSeries: MaybeTranslatedSeries,
+ rawSeries: RawSeries,
settings: ComputedVisualizationSettings,
formatter: Formatter,
) {
diff --git a/frontend/test/__support__/echarts.ts b/frontend/test/__support__/echarts.ts
index 5266f0468b8..898582ea507 100644
--- a/frontend/test/__support__/echarts.ts
+++ b/frontend/test/__support__/echarts.ts
@@ -81,6 +81,7 @@ export const createMockCartesianChartModel = (
column,
columnIndex: 0,
columnByCardId: {},
+ columns: [column],
},
seriesModels: [],
dataset: [],