The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
add stack series button to metrics viewer (#71694)
Aleksandr Lesnenko1b31cc65218b
diff --git a/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.ts b/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.tsindex e261a522869..93f8bcee6c2 100644--- a/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.ts+++ b/e2e/test/scenarios/metrics/metrics-explorer.cy.spec.ts@@ -627,6 +627,28 @@ describe("scenarios > metrics > explorer", () => {H.MetricsViewer.getAllMetricVisualizations().should("have.length", 1);});+ it("should stack series into panels when the stack series button is toggled", () => {+ addMetric("Count of products");+ cy.wait("@dataset");++ cy.log("line chart with multiple series should show chart layout picker");+ H.MetricsViewer.assertVizType("Line");+ cy.findByTestId("chart-layout-picker").should("be.visible");+ cy.findByLabelText("Stack layout").click();++ cy.log("should split the chart into separate panels");+ H.splitPanelAxisLines().should("have.length", 2);++ cy.log("toggling off should return to unified view");+ cy.findByLabelText("Default layout").click();+ H.splitPanelAxisLines().should("have.length", 0);++ cy.log("button should not be visible for non-line/area/bar charts");+ switchToTab("State");+ H.MetricsViewer.assertVizType("Map");+ cy.findByTestId("chart-layout-picker").should("not.exist");+ });+it("should automatically split for display types that do not support multiple series", () => {cy.log("with a single series, map shows one visualization");switchToTab("State");diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.module.css b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.module.cssnew file mode 100644index 00000000000..a1ac75000c6--- /dev/null+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.module.css@@ -0,0 +1,3 @@+.selected {+ box-shadow: 0 1px 2px var(--mb-color-shadow);+}diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.tsxnew file mode 100644index 00000000000..dc7a4e987e4--- /dev/null+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/ChartLayoutPicker.tsx@@ -0,0 +1,56 @@+import { t } from "ttag";++import { ActionIcon, Flex, Icon, Tooltip } from "metabase/ui";++import S from "./ChartLayoutPicker.module.css";++type ChartLayoutPickerProps = {+ isStacked: boolean;+ onToggle: (stacked: boolean) => void;+};++export function ChartLayoutPicker({+ isStacked,+ onToggle,+}: ChartLayoutPickerProps) {+ return (+ <Flex+ gap="xs"+ bg="background-secondary"+ p="xs"+ bdrs="md"+ data-testid="chart-layout-picker"+ >+ <Tooltip label={t`Default layout`}>+ <ActionIcon+ w="2rem"+ variant={!isStacked ? "filled" : "subtle"}+ bg={!isStacked ? "background-primary" : undefined}+ onClick={() => onToggle(false)}+ aria-label={t`Default layout`}+ className={!isStacked ? S.selected : undefined}+ >+ <Icon+ name="chart_layout_default"+ c={!isStacked ? "brand" : "text-primary"}+ />+ </ActionIcon>+ </Tooltip>+ <Tooltip label={t`Stack layout`}>+ <ActionIcon+ w="2rem"+ variant={isStacked ? "filled" : "subtle"}+ bg={isStacked ? "background-primary" : undefined}+ onClick={() => onToggle(true)}+ aria-label={t`Stack layout`}+ className={isStacked ? S.selected : undefined}+ >+ <Icon+ name="chart_layout_stack"+ c={isStacked ? "brand" : "text-primary"}+ />+ </ActionIcon>+ </Tooltip>+ </Flex>+ );+}diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/index.ts b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/index.tsnew file mode 100644index 00000000000..9073f756233--- /dev/null+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/ChartLayoutPicker/index.ts@@ -0,0 +1 @@+export { ChartLayoutPicker } from "./ChartLayoutPicker";diff --git a/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsx b/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsxindex 386efbf3138..f4dba5f90cf 100644--- a/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsx+++ b/frontend/src/metabase/metrics-viewer/components/MetricControls/MetricControls.tsx@@ -2,7 +2,7 @@ import { useMemo } from "react";import { Divider, Flex } from "metabase/ui";import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";-import type { TemporalUnit } from "metabase-types/api";+import type { TemporalUnit, VisualizationSettings } from "metabase-types/api";import type {MetricsViewerDisplayType,@@ -14,6 +14,7 @@ import { getTabConfig } from "../../utils/tab-config";import { BinningButton } from "./BinningButton";import { BucketButton } from "./BucketButton";+import { ChartLayoutPicker } from "./ChartLayoutPicker";import { ChartTypePicker } from "./ChartTypePicker";import { DimensionFilterButton } from "./DimensionFilterButton";import S from "./MetricControls.module.css";@@ -36,6 +37,11 @@ type MetricControlsProps = {onDimensionFilterChange: (value: DimensionFilterValue | undefined) => void;onTemporalUnitChange: (unit: TemporalUnit | undefined) => void;onBinningChange: (binningStrategy: string | undefined) => void;+ showStackSeries?: boolean;+ visualizationSettings?: Partial<VisualizationSettings>;+ onVisualizationSettingsChange?: (+ updates: Partial<VisualizationSettings>,+ ) => void;};export function MetricControls({@@ -48,6 +54,9 @@ export function MetricControls({onDimensionFilterChange,onTemporalUnitChange,onBinningChange,+ showStackSeries,+ visualizationSettings,+ onVisualizationSettingsChange,}: MetricControlsProps) {const projectionInfo = useMemo(() => getProjectionInfo(definition),@@ -90,6 +99,19 @@ export function MetricControls({value={effectiveDisplayType}onChange={onDisplayTypeChange}/>+ {showStackSeries && onVisualizationSettingsChange && (+ <>+ <Divider orientation="vertical" className={S.divider} mx="xs" />+ <ChartLayoutPicker+ isStacked={!!visualizationSettings?.["graph.split_panels"]}+ onToggle={(stacked) =>+ onVisualizationSettingsChange({+ "graph.split_panels": stacked,+ })+ }+ />+ </>+ )}{hasFilterControls && projectionInfo.filterDimension && (<><Divider orientation="vertical" className={S.divider} mx="xs" />diff --git a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/MetricsViewerTabContent.tsx b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/MetricsViewerTabContent.tsxindex d83c40c2b7d..8d7f383ae7e 100644--- a/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/MetricsViewerTabContent.tsx+++ b/frontend/src/metabase/metrics-viewer/components/MetricsViewerTabs/MetricsViewerTabContent/MetricsViewerTabContent.tsx@@ -8,7 +8,12 @@ import { Center, Flex, Stack } from "metabase/ui";import type { DimensionMetadata, MetricDefinition } from "metabase-lib/metric";import * as LibMetric from "metabase-lib/metric";import { isMetric } from "metabase-lib/v1/types/utils/isa";-import type { CardId, SingleSeries, TemporalUnit } from "metabase-types/api";+import type {+ CardId,+ SingleSeries,+ TemporalUnit,+ VisualizationSettings,+} from "metabase-types/api";import type {MetricSourceId,@@ -21,7 +26,7 @@ import type {import { getProjectionInfo } from "../../../utils/definition-builder";import type { DimensionFilterValue } from "../../../utils/dimension-filters";import { buildDimensionItemsFromDefinitions } from "../../../utils/series";-import { getTabConfig } from "../../../utils/tab-config";+import { DISPLAY_TYPE_REGISTRY, getTabConfig } from "../../../utils/tab-config";import { MetricControls } from "../../MetricControls";import { MetricsViewerVisualization } from "../../MetricsViewerVisualization";@@ -168,6 +173,18 @@ export function MetricsViewerTabContent({[onTabUpdate],);+ const handleVisualizationSettingsChange = useCallback(+ (updates: Partial<VisualizationSettings>) => {+ onTabUpdate({+ visualizationSettings: {+ ...tab.visualizationSettings,+ ...updates,+ },+ });+ },+ [onTabUpdate, tab.visualizationSettings],+ );+const handleBrush = useCallback(({ start, end }: { start: number; end: number }) => {updateProjectionConfig({@@ -182,6 +199,9 @@ export function MetricsViewerTabContent({[updateProjectionConfig],);+ const showStackSeries =+ DISPLAY_TYPE_REGISTRY[tab.display].supportsStacking && rawSeries.length > 1;+const isTimeTab = tab.type === "time";const mappedDimensionCount = getObjectValues(tab.dimensionMapping).filter(isNotNull,@@ -226,6 +246,9 @@ export function MetricsViewerTabContent({onDimensionFilterChange={handleDimensionFilterChange}onTemporalUnitChange={handleTemporalUnitChange}onBinningChange={handleBinningChange}+ showStackSeries={showStackSeries}+ visualizationSettings={tab.visualizationSettings}+ onVisualizationSettingsChange={handleVisualizationSettingsChange}/></Flex>)}diff --git a/frontend/src/metabase/metrics-viewer/hooks/use-metrics-viewer.ts b/frontend/src/metabase/metrics-viewer/hooks/use-metrics-viewer.tsindex 0cbed0e2d93..78c77b70523 100644--- a/frontend/src/metabase/metrics-viewer/hooks/use-metrics-viewer.ts+++ b/frontend/src/metabase/metrics-viewer/hooks/use-metrics-viewer.ts@@ -245,6 +245,7 @@ export function useMetricsViewer({resultsByDefinitionId,modifiedDefinitions,sourceBreakoutColors,+ activeTab.visualizationSettings,);}, [state.definitions,diff --git a/frontend/src/metabase/metrics-viewer/types/viewer-state.ts b/frontend/src/metabase/metrics-viewer/types/viewer-state.tsindex 3ec0a4d3eec..879c3d23bb4 100644--- a/frontend/src/metabase/metrics-viewer/types/viewer-state.ts+++ b/frontend/src/metabase/metrics-viewer/types/viewer-state.ts@@ -5,6 +5,7 @@ import type {ConcreteTableId,DimensionId,TemporalUnit,+ VisualizationSettings,} from "metabase-types/api";import type { DimensionFilterValue } from "../utils/dimension-filters";@@ -57,6 +58,7 @@ export interface MetricsViewerTabState {type: MetricsViewerTabType;label: string | null;display: MetricsViewerDisplayType;+ visualizationSettings?: Partial<VisualizationSettings>;dimensionMapping: Record<MetricSourceId, DimensionId | null>;projectionConfig: MetricsViewerTabProjectionConfig;}diff --git a/frontend/src/metabase/metrics-viewer/utils/series.ts b/frontend/src/metabase/metrics-viewer/utils/series.tsindex 77be8ffb181..8d2b4df317e 100644--- a/frontend/src/metabase/metrics-viewer/utils/series.ts+++ b/frontend/src/metabase/metrics-viewer/utils/series.ts@@ -241,6 +241,7 @@ export function buildRawSeriesFromDefinitions(resultsByDefinitionId: Map<MetricSourceId, Dataset>,modifiedDefinitions: Map<MetricSourceId, MetricDefinition>,sourceBreakoutColors: SourceBreakoutColorMap,+ extraVizSettings?: Partial<VisualizationSettings>,): {series: SingleSeries[];cardIdToDefinitionId: Record<CardId, MetricSourceId>;@@ -321,6 +322,7 @@ export function buildRawSeriesFromDefinitions(seriesKey,color,}),+ ...extraVizSettings,}),data: result.data,};diff --git a/frontend/src/metabase/metrics-viewer/utils/tab-config.ts b/frontend/src/metabase/metrics-viewer/utils/tab-config.tsindex 99479cc1e07..82482d8d2b3 100644--- a/frontend/src/metabase/metrics-viewer/utils/tab-config.ts+++ b/frontend/src/metabase/metrics-viewer/utils/tab-config.ts@@ -23,6 +23,7 @@ export interface ChartTypeOption {interface DisplayTypeDefinition {supportsMultipleSeries: boolean;+ supportsStacking: boolean;getSettings: (def: MetricDefinition,dimension: DimensionMetadata,@@ -221,21 +222,40 @@ export const DISPLAY_TYPE_REGISTRY: Record<> = {line: {supportsMultipleSeries: true,+ supportsStacking: true,getSettings: getChartSettings,combineSettings: combineColors,},area: {supportsMultipleSeries: true,+ supportsStacking: true,getSettings: getChartSettings,combineSettings: combineColors,},bar: {supportsMultipleSeries: true,+ supportsStacking: true,getSettings: getChartSettings,combineSettings: combineColors,},- row: { supportsMultipleSeries: true, getSettings: getChartSettings },- scatter: { supportsMultipleSeries: true, getSettings: getScatterSettings },- map: { supportsMultipleSeries: false, getSettings: getMapSettings },- pie: { supportsMultipleSeries: false, getSettings: getPieSettings },+ row: {+ supportsMultipleSeries: true,+ supportsStacking: false,+ getSettings: getChartSettings,+ },+ scatter: {+ supportsMultipleSeries: true,+ supportsStacking: false,+ getSettings: getScatterSettings,+ },+ map: {+ supportsMultipleSeries: false,+ supportsStacking: false,+ getSettings: getMapSettings,+ },+ pie: {+ supportsMultipleSeries: false,+ supportsStacking: false,+ getSettings: getPieSettings,+ },};diff --git a/frontend/src/metabase/metrics-viewer/utils/url-serialization.ts b/frontend/src/metabase/metrics-viewer/utils/url-serialization.tsindex f377ceb4aaf..7fe30bc1c68 100644--- a/frontend/src/metabase/metrics-viewer/utils/url-serialization.ts+++ b/frontend/src/metabase/metrics-viewer/utils/url-serialization.ts@@ -2,7 +2,7 @@ import { b64url_to_utf8, utf8_to_b64url } from "metabase/lib/encoding";import { getObjectEntries } from "metabase/lib/objects";import type { MetricDefinition } from "metabase-lib/metric";import * as LibMetric from "metabase-lib/metric";-import type { TemporalUnit } from "metabase-types/api";+import type { TemporalUnit, VisualizationSettings } from "metabase-types/api";import type {MetricSourceId,@@ -68,6 +68,7 @@ interface SerializedTab {type: MetricsViewerTabType;label: string | null;display: MetricsViewerDisplayType;+ visualizationSettings?: Partial<VisualizationSettings>;definitions: SerializedTabDef[];projectionConfig?: SerializedProjectionConfig;}@@ -105,6 +106,10 @@ function tabToSerializedTab(tab: MetricsViewerTabState): SerializedTab {type: tab.type,label: tab.label,display: tab.display,+ ...(tab.visualizationSettings &&+ Object.keys(tab.visualizationSettings).length > 0+ ? { visualizationSettings: tab.visualizationSettings }+ : {}),definitions: getObjectEntries(tab.dimensionMapping).map(([sourceId, dimensionId]) => ({definitionId: sourceId,@@ -134,6 +139,9 @@ export function deserializeTab(type: serializedTab.type,label: serializedTab.label,display: serializedTab.display,+ ...(serializedTab.visualizationSettings+ ? { visualizationSettings: serializedTab.visualizationSettings }+ : {}),dimensionMapping,projectionConfig: {dimensionFilter: serializedTab.projectionConfig?.dimensionFilter,@@ -245,6 +253,7 @@ const tabSchema = defineCompactSchema<SerializedTab>({type: "t",label: { key: "l", default: null },display: { key: "d", default: "line" },+ visualizationSettings: { key: "V", optional: true },definitions: { key: "D", schema: tabDefSchema, default: [] },projectionConfig: {key: "p",diff --git a/frontend/src/metabase/ui/components/icons/Icon/icons/chart_layout_default.svg b/frontend/src/metabase/ui/components/icons/Icon/icons/chart_layout_default.svgnew file mode 100644index 00000000000..a4860c2eaa7--- /dev/null+++ b/frontend/src/metabase/ui/components/icons/Icon/icons/chart_layout_default.svg@@ -0,0 +1,4 @@+<svg viewBox="0 0 16 16" fill="currentcolor" xmlns="http://www.w3.org/2000/svg">+ <path d="M12 11.75H4V10.25H12V11.75Z" />+ <path fill-rule="evenodd" clip-rule="evenodd" d="M12 1.25C13.5188 1.25 14.75 2.48122 14.75 4V12C14.75 13.5188 13.5188 14.75 12 14.75H4C2.48122 14.75 1.25 13.5188 1.25 12V4C1.25 2.48122 2.48122 1.25 4 1.25H12ZM4 2.75C3.30964 2.75 2.75 3.30964 2.75 4V12C2.75 12.6904 3.30964 13.25 4 13.25H12C12.6904 13.25 13.25 12.6904 13.25 12V4C13.25 3.30964 12.6904 2.75 12 2.75H4Z" />+</svg>diff --git a/frontend/src/metabase/ui/components/icons/Icon/icons/chart_layout_stack.svg b/frontend/src/metabase/ui/components/icons/Icon/icons/chart_layout_stack.svgnew file mode 100644index 00000000000..3cf23c046dc--- /dev/null+++ b/frontend/src/metabase/ui/components/icons/Icon/icons/chart_layout_stack.svg@@ -0,0 +1,3 @@+<svg viewBox="0 0 16 16" fill="currentcolor" xmlns="http://www.w3.org/2000/svg">+ <path fill-rule="evenodd" clip-rule="evenodd" d="M12 1.25C13.5188 1.25 14.75 2.48122 14.75 4V12C14.75 13.5188 13.5188 14.75 12 14.75H4C2.48122 14.75 1.25 13.5188 1.25 12V4C1.25 2.48122 2.48122 1.25 4 1.25H12ZM2.75 8.75V12C2.75 12.6904 3.30964 13.25 4 13.25H12C12.6904 13.25 13.25 12.6904 13.25 12V8.75H2.75ZM4 2.75C3.30964 2.75 2.75 3.30964 2.75 4V7.25H13.25V4C13.25 3.30964 12.6904 2.75 12 2.75H4Z" />+</svg>diff --git a/frontend/src/metabase/ui/components/icons/Icon/icons/index.ts b/frontend/src/metabase/ui/components/icons/Icon/icons/index.tsindex 577eb381ebc..67f959332ef 100644--- a/frontend/src/metabase/ui/components/icons/Icon/icons/index.ts+++ b/frontend/src/metabase/ui/components/icons/Icon/icons/index.ts@@ -84,6 +84,10 @@ import calendar_component from "./calendar.svg?component";import calendar_source from "./calendar.svg?source";import camera_component from "./camera.svg?component";import camera_source from "./camera.svg?source";+import chart_layout_default_component from "./chart_layout_default.svg?component";+import chart_layout_default_source from "./chart_layout_default.svg?source";+import chart_layout_stack_component from "./chart_layout_stack.svg?component";+import chart_layout_stack_source from "./chart_layout_stack.svg?source";import check_component from "./check.svg?component";import check_source from "./check.svg?source";import check_filled_component from "./check_filled.svg?component";@@ -729,6 +733,14 @@ export const Icons: Record<IconName, { component: React.VFC; source: string }> =component: camera_component,source: camera_source,},+ chart_layout_default: {+ component: chart_layout_default_component,+ source: chart_layout_default_source,+ },+ chart_layout_stack: {+ component: chart_layout_stack_component,+ source: chart_layout_stack_source,+ },check: {component: check_component,source: check_source,@@ -1759,6 +1771,8 @@ export type IconName =| "burger"| "calendar"| "camera"+ | "chart_layout_default"+ | "chart_layout_stack"| "check"| "check_filled"| "code_block"