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-4935 Hover effect for timeline event chips (#78865)
Denis Berezinb5c15c500297
diff --git a/e2e/support/helpers/e2e-visual-tests-helpers.js b/e2e/support/helpers/e2e-visual-tests-helpers.jsindex 4168d978689..7e81ae718c3 100644--- a/e2e/support/helpers/e2e-visual-tests-helpers.js+++ b/e2e/support/helpers/e2e-visual-tests-helpers.js@@ -1,5 +1,6 @@import { popover } from "e2e/support/helpers/e2e-ui-elements-helpers";import { color as getColor } from "metabase/ui/colors";+import { CHART_STYLE } from "metabase/visualizations/echarts/cartesian/constants/style.ts";import { GOAL_LINE_DASH } from "metabase/visualizations/echarts/cartesian/option/goal-line.ts";import { TREND_LINE_DASH } from "metabase/visualizations/echarts/cartesian/option/trend-line.ts";@@ -56,6 +57,20 @@ export function timelineEventChip(label) {return cy.get(`[data-testid="timeline-event-chip"][aria-label="${label}"]`);}+export function timelineEventMarkerLine() {+ const lineWidth = CHART_STYLE.timelineEvents.selectionLineWidth;+ return echartsContainer()+ .find(`path[stroke-width='${lineWidth}'][fill='none']`)+ .filter((_, element) => {+ // a vertical line is drawn as "M x y1 L x y2" — two points with the same x+ const coordinates = (element.getAttribute("d") ?? "")+ .split(/[ML\s,]+/)+ .filter(Boolean);+ const [x1, , x2] = coordinates;+ return coordinates.length === 4 && x1 === x2;+ });+}+export function chartGridLines() {return echartsContainer().find("path[stroke='var(--mb-color-cartesian-grid-line)'][fill='none']",@@ -100,6 +115,12 @@ export function cartesianChartCircleWithColors(colors) {return colors.map((color) => cartesianChartCircleWithColor(color));}+export function cartesianChartCircleWithFillColor(color) {+ return echartsContainer()+ .find(`path[d="${CIRCLE_PATH}"]`)+ .filter((_, element) => getComputedStyle(element).fill === color);+}+export function otherSeriesChartPaths() {return chartPathWithFillColor("#949AAB");}diff --git a/e2e/test/scenarios/dashboard/x-rays.cy.spec.js b/e2e/test/scenarios/dashboard/x-rays.cy.spec.jsindex db4af961497..63db488c4f3 100644--- a/e2e/test/scenarios/dashboard/x-rays.cy.spec.js+++ b/e2e/test/scenarios/dashboard/x-rays.cy.spec.js@@ -291,6 +291,7 @@ describe("scenarios > x-rays", { tags: "@slow" }, () => {// BarsH.chartPathWithFillColor("#509EE3").should("have.length", 5);+ H.ensureChartIsActive();H.chartPathWithFillColor("#509EE3").eq(0).realHover();H.assertEChartsTooltip({diff --git a/e2e/test/scenarios/organization/timelines-question.cy.spec.js b/e2e/test/scenarios/organization/timelines-question.cy.spec.jsindex c52b31d123e..c2a27a9111e 100644--- a/e2e/test/scenarios/organization/timelines-question.cy.spec.js+++ b/e2e/test/scenarios/organization/timelines-question.cy.spec.js@@ -5,6 +5,9 @@ import { ORDERS_BY_YEAR_QUESTION_ID } from "e2e/support/cypress_sample_instance_const { ORDERS, ORDERS_ID } = SAMPLE_DATABASE;+// brand (#509EE3) in getComputedStyle's normalized color format+const HIGHLIGHTED_DOT_FILL = "rgb(80, 158, 227)";+describe("scenarios > organization > timelines > question", () => {beforeEach(() => {H.restore();@@ -456,6 +459,23 @@ describe("scenarios > organization > timelines > question", () => {cy.findByText("RC1").should("be.visible");cy.findByText("See all").should("not.exist");});++ cy.log(+ "hovering also shows a marker line and highlights the closest data point",+ );+ H.timelineEventMarkerLine().should("exist");+ // the highlighted datum is drawn as a solid brand-filled dot (resting dots are hollow)+ H.cartesianChartCircleWithFillColor(HIGHLIGHTED_DOT_FILL).should(+ "have.length",+ 1,+ );++ cy.log("unhovering removes the marker line and the highlight");+ cy.findByTestId("qb-header").realHover();+ H.timelineEventMarkerLine().should("not.exist");+ H.cartesianChartCircleWithFillColor(HIGHLIGHTED_DOT_FILL).should(+ "not.exist",+ );});it("should show the event popover when hovering on a stacked chart #74005", () => {diff --git a/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.ts b/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.tsindex 2f4019ae236..321eca547b1 100644--- a/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.ts+++ b/frontend/src/metabase/visualizations/echarts/cartesian/timeline-events/option.ts@@ -48,6 +48,11 @@ export const getTimelineEventsSelectionSeries = (type: "line",data: [],markLine: {+ blur: {+ lineStyle: {+ opacity: 1,+ },+ },symbol: "none",lineStyle: {type: "solid",diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsxindex 157dec491db..8bb583192ee 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/CartesianChart.tsx@@ -1,5 +1,12 @@import type { EChartsType } from "echarts/core";-import { type MouseEvent, useCallback, useMemo, useRef, useState } from "react";+import {+ type MouseEvent,+ useCallback,+ useEffect,+ useMemo,+ useRef,+ useState,+} from "react";import React from "react";import { useSet } from "react-use";@@ -9,6 +16,7 @@ import { DataPointsVisiblePopover } from "metabase/visualizations/components/Datimport { ResponsiveEChartsRenderer } from "metabase/visualizations/components/EChartsRenderer";import { LegendCaption } from "metabase/visualizations/components/legend/LegendCaption";import { getLegendItems } from "metabase/visualizations/echarts/cartesian/model/legend";+import type { TimelineEventGroup } from "metabase/visualizations/echarts/cartesian/timeline-events/types";import {useCartesianChartSeriesColorsClasses,useCloseTooltipOnScroll,@@ -23,7 +31,11 @@ import { useChartEvents } from "metabase/visualizations/visualizations/Cartesianimport { TimelineEventsBand } from "./TimelineEventsBand";import { useChartDebug } from "./use-chart-debug";import { useModelsAndOption } from "./use-models-and-option";-import { getDashboardAdjustedSettings } from "./utils";+import {+ getClosestDatumIndex,+ getDashboardAdjustedSettings,+ getDataSeriesEChartsIndices,+} from "./utils";function CartesianChartInner(props: VisualizationProps) {const containerRef = useRef<HTMLDivElement>(null);@@ -75,6 +87,14 @@ function CartesianChartInner(props: VisualizationProps) {[originalSettings, outerHeight, outerWidth, autoAdjustSettings],);+ const [hoveredTimelineEventGroup, setHoveredTimelineEventGroup] =+ useState<TimelineEventGroup | null>(null);++ const hoveredTimelineEventIds = useMemo(+ () => hoveredTimelineEventGroup?.events.map((event) => event.id),+ [hoveredTimelineEventGroup],+ );+const {chartModel,chartLayout,@@ -90,6 +110,7 @@ function CartesianChartInner(props: VisualizationProps) {settings,},containerRef,+ hoveredTimelineEventIds,);useChartDebug({ isQueryBuilder, rawSeries, option, chartModel });@@ -156,6 +177,43 @@ function CartesianChartInner(props: VisualizationProps) {? chartModel.seriesModels.filter((series) => series.visible).length - 1: 0;+ useEffect(() => {+ const chart = chartRef.current;+ if (chart == null || hoveredTimelineEventGroup == null) {+ return;+ }++ const dataIndex = getClosestDatumIndex(+ chartModel.transformedDataset,+ hoveredTimelineEventGroup.date,+ );+ const seriesIndices = getDataSeriesEChartsIndices(+ chartModel.seriesModels,+ option,+ );+ if (dataIndex < 0 || seriesIndices.length === 0) {+ return;+ }++ seriesIndices.forEach((seriesIndex) => {+ chart.dispatchAction({+ type: "highlight",+ seriesIndex,+ dataIndex: [dataIndex],+ });+ });++ return () => {+ seriesIndices.forEach((seriesIndex) => {+ chart.dispatchAction({+ type: "downplay",+ seriesIndex,+ dataIndex: [dataIndex],+ });+ });+ };+ }, [hoveredTimelineEventGroup, chartModel, option]);+// We can't navigate a user to a particular card from a visualizer viz,// so title selection is disabled in this caseconst canSelectTitle =@@ -226,6 +284,7 @@ function CartesianChartInner(props: VisualizationProps) {chartLayout={chartLayout}xAxisIndex={timelineEventsXAxisIndex}selectedTimelineEventIds={selectedTimelineEventIds}+ onGroupHover={setHoveredTimelineEventGroup}onOpenTimelines={onOpenTimelines}onSelectTimelineEvents={onSelectTimelineEvents}onDeselectTimelineEvents={onDeselectTimelineEvents}diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.tsx b/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.tsxindex 9421301b46d..351c7b3e729 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.tsx+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.tsx@@ -3,6 +3,7 @@ import { t } from "ttag";import { Box, HoverCard, Icon, Text, UnstyledButton } from "metabase/ui";import { TIMELINE_EVENTS_BAND } from "metabase/visualizations/echarts/cartesian/constants/style";+import type { TimelineEventGroup } from "metabase/visualizations/echarts/cartesian/timeline-events/types";import type { TimelineEvent, TimelineEventId } from "metabase-types/api";import S from "./TimelineEventsBand.module.css";@@ -24,6 +25,7 @@ interface TimelineEventChipProps {eventsGroup: PositionedTimelineEventGroup;centerY: number;selectedEventIds: TimelineEventId[];+ onGroupHover?: (group: TimelineEventGroup | null) => void;onOpenTimelines?: (eventIds?: number[]) => void;onSelectTimelineEvents?: (events: TimelineEvent[]) => void;onDeselectTimelineEvents?: () => void;@@ -33,6 +35,7 @@ export const TimelineEventChip = ({eventsGroup,centerY,selectedEventIds,+ onGroupHover,onOpenTimelines,onSelectTimelineEvents,onDeselectTimelineEvents,@@ -89,6 +92,8 @@ export const TimelineEventChip = ({isSingleEvent ? events[0].name : t`${events.length} events`}onClick={canSelect ? handleChipClick : undefined}+ onMouseEnter={() => onGroupHover?.(group)}+ onMouseLeave={() => onGroupHover?.(null)}>{isSingleEvent ? (<Icon name={getTimelineEventGroupIconName(group)} size={12} />diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.unit.spec.tsxindex 5e5fb9f5f8e..94ed3605c4a 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.unit.spec.tsx+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventChip.unit.spec.tsx@@ -52,6 +52,7 @@ const setup = ({selectedEventIds = [],withCallbacks = true,}: SetupOpts = {}) => {+ const onGroupHover = jest.fn();const onOpenTimelines = jest.fn();const onSelectTimelineEvents = jest.fn();const onDeselectTimelineEvents = jest.fn();@@ -61,6 +62,7 @@ const setup = ({eventsGroup={eventsGroup}centerY={120}selectedEventIds={selectedEventIds}+ onGroupHover={onGroupHover}onOpenTimelines={withCallbacks ? onOpenTimelines : undefined}onSelectTimelineEvents={withCallbacks ? onSelectTimelineEvents : undefined@@ -71,7 +73,12 @@ const setup = ({/>,);- return { onOpenTimelines, onSelectTimelineEvents, onDeselectTimelineEvents };+ return {+ onGroupHover,+ onOpenTimelines,+ onSelectTimelineEvents,+ onDeselectTimelineEvents,+ };};describe("TimelineEventChip", () => {@@ -88,6 +95,17 @@ describe("TimelineEventChip", () => {);});+ it("reports the hovered group on mouse enter and null on leave", async () => {+ const { onGroupHover } = setup({ eventsGroup: singleGroup });+ const chip = screen.getByTestId("timeline-event-chip");++ await userEvent.hover(chip);+ expect(onGroupHover).toHaveBeenLastCalledWith(singleGroup.group);++ await userEvent.unhover(chip);+ expect(onGroupHover).toHaveBeenLastCalledWith(null);+ });+it("opens a single-event popover on hover without a 'See all' link", async () => {setup({ eventsGroup: singleGroup });diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventsBand.tsx b/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventsBand.tsxindex f20c36101d2..5e42446bbcf 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventsBand.tsx+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/TimelineEventsBand/TimelineEventsBand.tsx@@ -6,7 +6,10 @@ import {TIMELINE_EVENTS_BAND,} from "metabase/visualizations/echarts/cartesian/constants/style";import type { ChartLayout } from "metabase/visualizations/echarts/cartesian/layout/types";-import type { TimelineEventsModel } from "metabase/visualizations/echarts/cartesian/timeline-events/types";+import type {+ TimelineEventGroup,+ TimelineEventsModel,+} from "metabase/visualizations/echarts/cartesian/timeline-events/types";import type { TimelineEvent, TimelineEventId } from "metabase-types/api";import { TimelineEventChip } from "./TimelineEventChip";@@ -24,6 +27,7 @@ interface TimelineEventsBandProps {chartLayout: ChartLayout;xAxisIndex: number;selectedTimelineEventIds?: TimelineEventId[];+ onGroupHover?: (group: TimelineEventGroup | null) => void;onOpenTimelines?: (eventIds?: number[]) => void;onSelectTimelineEvents?: (events: TimelineEvent[]) => void;onDeselectTimelineEvents?: () => void;@@ -36,6 +40,7 @@ export const TimelineEventsBand = ({chartLayout,xAxisIndex,selectedTimelineEventIds,+ onGroupHover,onOpenTimelines,onSelectTimelineEvents,onDeselectTimelineEvents,@@ -114,6 +119,7 @@ export const TimelineEventsBand = ({eventsGroup={eventsGroup}centerY={centerY}selectedEventIds={selectedTimelineEventIds ?? []}+ onGroupHover={onGroupHover}onOpenTimelines={onOpenTimelines}onSelectTimelineEvents={onSelectTimelineEvents}onDeselectTimelineEvents={onDeselectTimelineEvents}diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-models-and-option.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-models-and-option.tsindex eab173255ab..4cad3a0504d 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-models-and-option.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/use-models-and-option.ts@@ -39,6 +39,7 @@ export function useModelsAndOption(gridSize,}: VisualizationProps,containerRef: React.RefObject<HTMLDivElement>,+ hoveredTimelineEventIds?: TimelineEventId[],) {const tc = useTranslateContent();@@ -132,6 +133,19 @@ export function useModelsAndOption();}, [chartModel, settings, card.display, containerRef]);+ const markedTimelineEventIds = useMemo(() => {+ if (+ card.display === "bar" ||+ hoveredTimelineEventIds == null ||+ hoveredTimelineEventIds.length === 0+ ) {+ return selectedTimelineEventIds;+ }+ return [+ ...new Set([...selectedTimelineEventIds, ...hoveredTimelineEventIds]),+ ];+ }, [selectedTimelineEventIds, hoveredTimelineEventIds, card.display]);+const option = useMemo(() => {if (width === 0 || height === 0) {return {};@@ -150,7 +164,7 @@ export function useModelsAndOption(chartLayout,hasTimelineEvents,timelineEventsModel,- selectedTimelineEventIds,+ markedTimelineEventIds,settings,shouldAnimate,renderingContext,@@ -163,7 +177,7 @@ export function useModelsAndOption(chartLayout,hasTimelineEvents,timelineEventsModel,- selectedTimelineEventIds,+ markedTimelineEventIds,settings,width,shouldAnimate,@@ -177,7 +191,7 @@ export function useModelsAndOption(chartLayout,hasTimelineEvents,timelineEventsModel,- selectedTimelineEventIds,+ markedTimelineEventIds,settings,width,shouldAnimate,@@ -198,7 +212,7 @@ export function useModelsAndOption(chartLayout,hasTimelineEvents,timelineEventsModel,- selectedTimelineEventIds,+ markedTimelineEventIds,settings,renderingContext,]);diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.tsindex e85fa707df5..b10a39fce91 100644--- a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.ts@@ -1,7 +1,10 @@+import dayjs from "dayjs";import type { EChartsCoreOption } from "echarts/core";import { isNotNull } from "metabase/utils/types";+import { X_AXIS_DATA_KEY } from "metabase/visualizations/echarts/cartesian/constants/dataset";import type {+ ChartDataset,DataKey,SeriesModel,} from "metabase/visualizations/echarts/cartesian/model/types";@@ -41,3 +44,48 @@ export const getHoveredEChartsSeriesDataKeyAndIndex = (return { hoveredSeriesDataKey, hoveredEChartsSeriesIndex };};++export const getDataSeriesEChartsIndices = (+ seriesModels: SeriesModel[],+ option: EChartsCoreOption,+): number[] => {+ const seriesOptions = Array.isArray(option?.series)+ ? option.series+ : [option?.series].filter(isNotNull);++ const visibleDataKeys = new Set(+ seriesModels.filter((series) => series.visible).map((s) => s.dataKey),+ );++ return seriesOptions.flatMap((series, index) =>+ visibleDataKeys.has(series.id) ? [index] : [],+ );+};++export const getClosestDatumIndex = (+ dataset: ChartDataset,+ date: string,+): number => {+ const target = dayjs.utc(date).valueOf();+ if (Number.isNaN(target)) {+ return -1;+ }++ return dataset.reduce(+ (best, datum, index) => {+ const value = datum[X_AXIS_DATA_KEY];+ const canParse =+ typeof value === "string" ||+ typeof value === "number" ||+ value instanceof Date;+ const timestamp = canParse ? dayjs.utc(value).valueOf() : NaN;++ if (Number.isNaN(timestamp)) {+ return best;+ }+ const diff = Math.abs(timestamp - target);+ return diff < best.diff ? { index, diff } : best;+ },+ { index: -1, diff: Infinity },+ ).index;+};diff --git a/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.unit.spec.ts b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.unit.spec.tsnew file mode 100644index 00000000000..9e1b51c3e17--- /dev/null+++ b/frontend/src/metabase/visualizations/visualizations/CartesianChart/utils.unit.spec.ts@@ -0,0 +1,79 @@+import { createMockSeriesModel } from "__support__/echarts";+import { X_AXIS_DATA_KEY } from "metabase/visualizations/echarts/cartesian/constants/dataset";++import { getClosestDatumIndex, getDataSeriesEChartsIndices } from "./utils";++describe("getDataSeriesEChartsIndices", () => {+ const seriesModels = [+ createMockSeriesModel({ dataKey: "1:count" }),+ createMockSeriesModel({ dataKey: "1:sum", visible: false }),+ ];++ it("returns ECharts indices of visible data series only", () => {+ const option = {+ series: [+ { id: "goal-line" },+ { id: "1:count" },+ { id: "1:sum" },+ { id: "timeline-event-selection" },+ ],+ };++ expect(getDataSeriesEChartsIndices(seriesModels, option)).toEqual([1]);+ });++ it("returns an empty array when no data series are present", () => {+ expect(+ getDataSeriesEChartsIndices(seriesModels, { series: [{ id: "other" }] }),+ ).toEqual([]);+ });+});++describe("getClosestDatumIndex", () => {+ const dataset = [+ { [X_AXIS_DATA_KEY]: "2027-05-01T00:00:00Z" },+ { [X_AXIS_DATA_KEY]: "2027-06-01T00:00:00Z" },+ { [X_AXIS_DATA_KEY]: "2027-07-01T00:00:00Z" },+ ];++ it("finds the datum matching the group date exactly", () => {+ expect(getClosestDatumIndex(dataset, "2027-06-01T00:00:00.000Z")).toBe(1);+ });++ it("finds the closest datum when x values carry a timezone offset", () => {+ const offsetDataset = [+ { [X_AXIS_DATA_KEY]: "2027-05-01T00:00:00+02:00" },+ { [X_AXIS_DATA_KEY]: "2027-06-01T00:00:00+02:00" },+ ];+ expect(getClosestDatumIndex(offsetDataset, "2027-06-01T00:00:00Z")).toBe(1);+ });++ it("matches day buckets exactly under the wall-clock-as-UTC encoding of extreme report timezones", () => {+ const dayDataset = [+ { [X_AXIS_DATA_KEY]: "2027-06-14T00:00:00Z" },+ { [X_AXIS_DATA_KEY]: "2027-06-15T00:00:00Z" },+ { [X_AXIS_DATA_KEY]: "2027-06-16T00:00:00Z" },+ ];+ expect(getClosestDatumIndex(dayDataset, "2027-06-15T00:00:00.000Z")).toBe(+ 1,+ );+ });++ it("parses offset-less x values as UTC, independent of the browser timezone", () => {+ const offsetlessDataset = [+ { [X_AXIS_DATA_KEY]: "2027-06-14T00:00:00" },+ { [X_AXIS_DATA_KEY]: "2027-06-15T00:00:00" },+ ];+ expect(+ getClosestDatumIndex(offsetlessDataset, "2027-06-15T00:00:00Z"),+ ).toBe(1);+ });++ it("returns -1 for an unparsable date", () => {+ expect(getClosestDatumIndex(dataset, "not-a-date")).toBe(-1);+ });++ it("returns -1 for an empty dataset", () => {+ expect(getClosestDatumIndex([], "2027-06-01T00:00:00Z")).toBe(-1);+ });+});