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
Uxw 3765 goal line on waterfall chart (#72650)
Nick Fitzpatrickc2a0e3615d4a
diff --git a/.loki/reference/chrome_laptop_Viz_Static_Viz_WaterfallChart_With_Goal_Line.png b/.loki/reference/chrome_laptop_Viz_Static_Viz_WaterfallChart_With_Goal_Line.pngnew file mode 100644index 00000000000..d93b8e5ea94Binary files /dev/null and b/.loki/reference/chrome_laptop_Viz_Static_Viz_WaterfallChart_With_Goal_Line.png differdiff --git a/e2e/test/scenarios/visualizations-charts/waterfall.cy.spec.js b/e2e/test/scenarios/visualizations-charts/waterfall.cy.spec.jsindex 0d53d94b017..01793398f45 100644--- a/e2e/test/scenarios/visualizations-charts/waterfall.cy.spec.js+++ b/e2e/test/scenarios/visualizations-charts/waterfall.cy.spec.js@@ -426,6 +426,34 @@ describe("scenarios > visualizations > waterfall", () => {});});+ it("should display goal line when configured", () => {+ H.visitQuestionAdhoc({+ display: "waterfall",+ dataset_query: {+ type: "query",+ database: SAMPLE_DB_ID,+ query: {+ "source-table": ORDERS_ID,+ aggregation: [["count"], ["sum", ["field-id", ORDERS.TOTAL]]],+ breakout: [["field", ORDERS.CREATED_AT, { "temporal-unit": "year" }]],+ },+ },+ });++ H.openVizSettingsSidebar();++ H.leftSidebar().contains("Display").click();++ H.leftSidebar().within(() => {+ cy.findByText("Goal line").click();+ cy.findByLabelText("Goal value").clear().type("11000");+ cy.findByLabelText("Goal label").clear().type("Target");+ });++ H.echartsContainer().findByText("Target").should("exist");+ H.goalLine().should("exist");+ });+describe("scenarios > visualizations > waterfall settings", () => {beforeEach(() => {H.restore();diff --git a/frontend/src/metabase/static-viz/components/WaterfallChart/WaterfallChart.stories.tsx b/frontend/src/metabase/static-viz/components/WaterfallChart/WaterfallChart.stories.tsxindex bf72c53c305..ef380d6b826 100644--- a/frontend/src/metabase/static-viz/components/WaterfallChart/WaterfallChart.stories.tsx+++ b/frontend/src/metabase/static-viz/components/WaterfallChart/WaterfallChart.stories.tsx@@ -1,4 +1,5 @@import type { StoryFn } from "@storybook/react";+import { updateIn } from "icepick";import { data } from "metabase/static-viz/components/WaterfallChart/stories-data";import {@@ -403,3 +404,23 @@ export const Watermark = {hasDevWatermark: true,},};++export const WithGoalLine = {+ render: Template,++ args: {+ rawSeries: updateIn(+ data.yAxisFullWithDataLabels,+ [0, "card", "visualization_settings"],+ (settings) => {+ return {+ ...settings,+ "graph.show_goal": true,+ "graph.goal_value": 250000,+ "graph.goal_label": "Target",+ };+ },+ ) as any,+ renderingContext,+ },+};diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/option/index.ts b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/option/index.tsindex 299a8a84e78..9eafb687c74 100644--- a/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/option/index.ts+++ b/frontend/src/metabase/visualizations/echarts/cartesian/waterfall/option/index.ts@@ -35,6 +35,10 @@ import type { ChartLayout } from "../../layout/types";import { isCategoryAxis } from "../../model/guards";import { getSharedEChartsOptions } from "../../option";import { buildAxes } from "../../option/axis";+import {+ getGoalLineParams,+ getGoalLineSeriesOption,+} from "../../option/goal-line";import { getTimelineEventsSeries } from "../../timeline-events/option";import type { TimelineEventsModel } from "../../timeline-events/types";@@ -234,9 +238,15 @@ export const getWaterfallChartOption = (chartModel.waterfallLabelFormatter,renderingContext,);+ const goalSeriesOption = getGoalLineSeriesOption(+ getGoalLineParams(chartModel),+ settings,+ renderingContext,+ );const seriesOption: WaterfallSeriesOption[] = [dataSeriesOptions,+ goalSeriesOption,timelineEventsSeries,].flatMap((option) => option ?? []);diff --git a/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx b/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsxindex 889e4d7627d..67648a56918 100644--- a/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx+++ b/frontend/src/metabase/visualizations/visualizations/WaterfallChart/WaterfallChart.tsx@@ -2,6 +2,7 @@ import Color from "color";import { t } from "ttag";import { color, staticVizOverrides } from "metabase/ui/colors";+import { GRAPH_GOAL_SETTINGS } from "metabase/visualizations/lib/settings/goal";import {GRAPH_AXIS_SETTINGS,GRAPH_DATA_SETTINGS,@@ -47,6 +48,7 @@ const WaterfallViz: Omit<VisualizationDefinition, "checkRenderable"> = {supportsVisualizer: false,settings: {...GRAPH_AXIS_SETTINGS,+ ...GRAPH_GOAL_SETTINGS,"waterfall.increase_color": {// eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045section: t`Display`,