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
Convert Scalar visualization from a class to a function component (#77774)
Andrei Chernykhadf574b57ba9
diff --git a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsx b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsxindex 59ae376b605..aa638cb74ce 100644--- a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsx+++ b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsx@@ -1,4 +1,4 @@-import { Component } from "react";+import { useRef } from "react";import _ from "underscore";import DashboardS from "metabase/css/dashboard.module.css";@@ -20,7 +20,6 @@ import type {VisualizationProps,} from "metabase/visualizations/types";import { BarChart } from "metabase/visualizations/visualizations/BarChart";-import type { DatasetColumn } from "metabase-types/api/dataset";import { ScalarValueContainer } from "./ScalarValueContainer";import { SCALAR_CHART_DEFINITION } from "./definition";@@ -40,157 +39,133 @@ function legacyScalarSettingsToFormatOptions(.value();}-// Scalar visualization shows a single number-// Multiseries Scalar is transformed to a Funnel-export class Scalar extends Component<- VisualizationProps & VisualizationPassThroughProps-> {- _scalar: HTMLElement | null = null;-- _getColumnIndex(- cols: DatasetColumn[],- settings: ComputedVisualizationSettings,- ) {- const columnIndex = _.findIndex(- cols,- (col) => col.name === settings["scalar.field"],+// Scalar visualization shows a single number; multiseries is transformed to a bar chart+function ScalarComponent(+ props: VisualizationProps & VisualizationPassThroughProps,+) {+ const scalarRef = useRef<HTMLDivElement>(null);++ const {+ series: [+ {+ data: { cols, rows },+ },+ ],+ settings,+ visualizationIsClickable,+ onVisualizationClick,+ height,+ width,+ gridSize,+ totalNumGridCols,+ fontFamily,+ rawSeries,+ } = props;++ if (rawSeries.length > 1) {+ return (+ <TransformedVisualization+ transformSeries={scalarToBarTransform}+ originalProps={props}+ VisualizationComponent={BarChart}+ />);- return columnIndex < 0 ? 0 : columnIndex;}- render() {- const {- series: [- {- data: { cols, rows },- },- ],- settings,- visualizationIsClickable,- onVisualizationClick,- height,- width,- gridSize,- totalNumGridCols,- fontFamily,- rawSeries,- } = this.props;-- if (rawSeries.length > 1) {- return (- <TransformedVisualization- transformSeries={scalarToBarTransform}- originalProps={this.props}- VisualizationComponent={BarChart}- />- );+ // clamp the -1 of a missing "scalar.field" to the first column+ const columnIndex = Math.max(+ 0,+ cols.findIndex((col) => col.name === settings["scalar.field"]),+ );+ const value = rows[0] && rows[0][columnIndex];+ const column = cols[columnIndex];++ const formatOptions = {+ ...legacyScalarSettingsToFormatOptions(settings),+ ...settings.column?.(column),+ jsx: true,+ };++ const segments = settings["scalar.segments"]?.filter((segment) =>+ segmentIsValid(segment, { allowOpenEnded: true }),+ );++ const color = getColor(value, segments);+ const tooltipContent = getTooltipContent(segments);++ const { displayValue, fullScalarValue } = compactifyValue(+ value,+ width,+ formatOptions,+ );++ const label = settings["scalar.label"];+ const sublabel = settings["scalar.sublabel"];+ const isMetricsViewer = label !== undefined;++ const isClickable = onVisualizationClick != null && !isMetricsViewer;++ const handleClick = () => {+ const element = scalarRef.current;+ if (element == null) {+ return;}- const columnIndex = this._getColumnIndex(cols, settings);- const value = rows[0] && rows[0][columnIndex];- const column = cols[columnIndex];-- const formatOptions = {- ...legacyScalarSettingsToFormatOptions(settings),- ...settings.column?.(column),- jsx: true,- };-- const segments = settings["scalar.segments"]?.filter((segment) =>- segmentIsValid(segment, { allowOpenEnded: true }),- );-- const color = getColor(value, segments);- const tooltipContent = getTooltipContent(segments);-- const { displayValue, fullScalarValue } = compactifyValue(+ const clickData = {value,- width,- formatOptions,- );-- const label = settings["scalar.label"];- const sublabel = settings["scalar.sublabel"];- const isMetricsViewer = label !== undefined;-- const isClickable = onVisualizationClick != null && !isMetricsViewer;-- const handleClick = () => {- if (this._scalar == null) {- return;- }-- const clickData = {- value,- column,- data: rows[0]?.map((value, index) => ({ value, col: cols[index] })),- settings,- element: this._scalar,- };-- if (- this._scalar &&- onVisualizationClick &&- visualizationIsClickable(clickData)- ) {- onVisualizationClick(clickData);- }+ column,+ data: rows[0]?.map((value, index) => ({ value, col: cols[index] })),+ settings,+ element,};- return (- <ScalarWrapper>- <ScalarValueContainer- className={DashboardS.fullscreenNormalText}- tooltip={fullScalarValue}- alwaysShowTooltip={fullScalarValue !== displayValue}- isClickable={isClickable}+ if (onVisualizationClick && visualizationIsClickable(clickData)) {+ onVisualizationClick(clickData);+ }+ };++ return (+ <ScalarWrapper>+ <ScalarValueContainer+ className={DashboardS.fullscreenNormalText}+ tooltip={fullScalarValue}+ alwaysShowTooltip={fullScalarValue !== displayValue}+ isClickable={isClickable}+ >+ <Tooltip+ label={tooltipContent}+ position="bottom"+ px="0.375rem"+ py="xs"+ disabled={!tooltipContent}>- <Tooltip- label={tooltipContent}- position="bottom"- px="0.375rem"- py="xs"- disabled={!tooltipContent}- >- <Stack- onClick={handleClick}- ref={(scalar) => (this._scalar = scalar)}- align="center"- gap={0}- >- <ScalarValue- color={color}- disableHover={isMetricsViewer}- fontFamily={fontFamily}- gridSize={gridSize}- height={Math.max(height - PADDING * 2, 0)}- totalNumGridCols={totalNumGridCols}- // Unjustified type cast. FIXME- value={displayValue as string}- width={Math.max(width - PADDING, 0)}- />- {label && (- <Text fz="14px" lh="16px" c="text-primary" mt="md" ta="center">- {label}- </Text>- )}- {sublabel && (- <Text- fz="12px"- lh="16px"- c="text-secondary"- mt="xs"- ta="center"- >- {sublabel}- </Text>- )}- </Stack>- </Tooltip>- </ScalarValueContainer>- </ScalarWrapper>- );- }+ <Stack onClick={handleClick} ref={scalarRef} align="center" gap={0}>+ <ScalarValue+ color={color}+ disableHover={isMetricsViewer}+ fontFamily={fontFamily}+ gridSize={gridSize}+ height={Math.max(height - PADDING * 2, 0)}+ totalNumGridCols={totalNumGridCols}+ // Unjustified type cast. FIXME+ value={displayValue as string}+ width={Math.max(width - PADDING, 0)}+ />+ {label && (+ <Text fz="14px" lh="16px" c="text-primary" mt="md" ta="center">+ {label}+ </Text>+ )}+ {sublabel && (+ <Text fz="12px" lh="16px" c="text-secondary" mt="xs" ta="center">+ {sublabel}+ </Text>+ )}+ </Stack>+ </Tooltip>+ </ScalarValueContainer>+ </ScalarWrapper>+ );}-Object.assign(Scalar, SCALAR_CHART_DEFINITION);+export const Scalar = Object.assign(ScalarComponent, SCALAR_CHART_DEFINITION);diff --git a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.unit.spec.tsxindex e67b1a1f4db..4817c496679 100644--- a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.unit.spec.tsx+++ b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.unit.spec.tsx@@ -110,6 +110,46 @@ describe("Scalar", () => {overflowY: "visible",});});++ it("should call onVisualizationClick with the clicked element when clickable", async () => {+ const onVisualizationClick = jest.fn();+ render(+ <Scalar+ {...mockedProps}+ series={series(12345)}+ rawSeries={series(12345)}+ settings={settings}+ visualizationIsClickable={() => true}+ onVisualizationClick={onVisualizationClick}+ width={230}+ />,+ );++ await userEvent.click(screen.getByText("12,345"));++ expect(onVisualizationClick).toHaveBeenCalledWith(+ expect.objectContaining({+ value: 12345,+ column: expect.objectContaining({ name: "count" }),+ element: expect.any(HTMLElement),+ }),+ );+ });++ it("should fall back to the first column when scalar.field matches no column", () => {+ render(+ <Scalar+ {...mockedProps}+ series={series(12345)}+ rawSeries={series(12345)}+ settings={{ ...settings, "scalar.field": "not-a-column" }}+ visualizationIsClickable={() => false}+ width={230}+ />,+ );++ expect(screen.getByText("12,345")).toBeInTheDocument();+ });});describe("scalar viz settings", () => {