Skip to content

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

2.8 KB
Raw Blame
type MetabaseCard = MetabaseCardBase &
  | {
  visualization?: never;
  visualizationSettings?: never;
}
  | {
  visualization: "table" | "pivot" | "object" | "list";
  visualizationSettings?: TableVisualizationSettings;
}
  | {
  visualization: "bar" | "line" | "area" | "combo" | "row";
  visualizationSettings?: CartesianVisualizationSettings;
}
  | {
  visualization: "scatter";
  visualizationSettings?: ScatterVisualizationSettings;
}
  | {
  visualization: "waterfall";
  visualizationSettings?: WaterfallVisualizationSettings;
}
  | {
  visualization: "pie";
  visualizationSettings?: PieVisualizationSettings;
}
  | {
  visualization: "scalar" | "smartscalar" | "gauge" | "progress";
  visualizationSettings?: ScalarVisualizationSettings;
}
  | {
  visualization: "funnel";
  visualizationSettings?: FunnelVisualizationSettings;
}
  | {
  visualization: "map";
  visualizationSettings?: MapVisualizationSettings;
}
  | {
  visualization: "sankey";
  visualizationSettings?: SankeyVisualizationSettings;
}
  | {
  visualization: "boxplot";
  visualizationSettings?: BoxplotVisualizationSettings;
}
  | {
  visualization: CustomVizDisplayType;
  visualizationSettings?: Record<string, unknown>;
};

Ad-hoc card definition for SDK-rendered questions. Pass only query when Metabase should infer a display from the query result. Add visualization when the user or design asks for a specific chart type. Add visualizationSettings only for explicit setting-level presentation changes.

Not Exported

MetabaseCardBase

Not Exported

TableVisualizationSettings

Not Exported

CartesianVisualizationSettings

Not Exported

ScatterVisualizationSettings

Not Exported

WaterfallVisualizationSettings

Not Exported

PieVisualizationSettings

Not Exported

ScalarVisualizationSettings

Not Exported

FunnelVisualizationSettings

Not Exported

MapVisualizationSettings

Not Exported

SankeyVisualizationSettings

Not Exported

BoxplotVisualizationSettings

Not Exported

CustomVizDisplayType