Skip to content

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

Convert QueryVisualization components to TypeScript (#75684)

Andrei Chernykh3d290b8530c2
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx
index 5c3223b1b31..6daabef18e6 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms-python/components/PythonTransformEditor/PythonEditorBody/PythonEditorBody.tsx
@@ -130,8 +130,8 @@ export function PythonEditorBody({
{!hideRunButton && (
<RunButtonWithTooltip
disabled={!isRunnable}
- isRunning={isRunning}
- isDirty={isDirty}
+ isRunning={Boolean(isRunning)}
+ isDirty={Boolean(isDirty)}
onRun={onRun}
onCancel={onCancel}
getTooltip={() => t`Run Python script`}
diff --git a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Visualization.tsx b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Visualization.tsx
index c122b56379b..411a915df07 100644
--- a/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Visualization.tsx
+++ b/frontend/src/embedding-sdk-bundle/components/private/SdkQuestion/components/Visualization.tsx
@@ -53,7 +53,6 @@ export const QuestionVisualization = ({
updateQuestion,
originalId,
onVisualizationChange,
- token,
} = useSdkQuestionContext();
const isGuestEmbed = useSdkSelector(getIsGuestEmbed);
@@ -110,9 +109,8 @@ export const QuestionVisualization = ({
isNativeEditorOpen={false}
result={result}
noHeader
- mode={mode}
- token={token}
- navigateToNewCardInsideQB={navigateToNewCard}
+ mode={mode ?? undefined}
+ navigateToNewCardInsideQB={navigateToNewCard ?? undefined}
onNavigateBack={onNavigateBack}
onUpdateQuestion={(question: Question) =>
updateQuestion(question, { run: false })
diff --git a/frontend/src/embedding-sdk-bundle/types/question.ts b/frontend/src/embedding-sdk-bundle/types/question.ts
index eb4f2a1e5de..d9a3dea8743 100644
--- a/frontend/src/embedding-sdk-bundle/types/question.ts
+++ b/frontend/src/embedding-sdk-bundle/types/question.ts
@@ -115,7 +115,7 @@ export type LoadSdkQuestionParams = {
export interface NavigateToNewCardParams {
nextCard: Card;
previousCard: Card;
- objectId: ObjectId;
+ objectId?: ObjectId;
signal?: AbortSignal;
drillName?: string;
}
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
index bacd0b34363..cee9690e540 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
@@ -62,6 +62,7 @@ import {
import type NativeQuery from "metabase-lib/v1/queries/NativeQuery";
import type {
CollectionId,
+ Dataset,
DatasetColumn,
Field,
NativeQuerySnippet,
@@ -95,7 +96,7 @@ export type DatasetEditorInnerProps = {
metadataDiff: MetadataDiff;
resultsMetadata?: ResultsMetadata | null;
isMetadataDirty: boolean;
- result?: { error?: unknown } | null;
+ result?: Dataset | null;
height?: number;
isDirty: boolean;
isResultDirty: boolean;
@@ -538,18 +539,18 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {
);
const handleTableElementClick = useCallback(
- ({
- element,
- ...clickedObject
- }: {
- element?: unknown;
- column?: DatasetColumn;
- }) => {
- const isColumnClick =
- clickedObject?.column && Object.keys(clickedObject)?.length === 1;
+ (clicked: Lib.ClickObject | null) => {
+ if (!clicked) {
+ return;
+ }
+ const { element, ...clickedObject } = clicked;
+ if (!clickedObject.column) {
+ return;
+ }
+ const isColumnClick = Object.keys(clickedObject).length === 1;
if (isColumnClick) {
- setFocusedFieldName((clickedObject.column as DatasetColumn).name);
+ setFocusedFieldName(clickedObject.column.name);
}
},
[setFocusedFieldName],
@@ -758,7 +759,9 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {
isShowingDetailsOnlyColumns={datasetEditorTab !== "metadata"}
hasMetadataPopovers={false}
handleVisualizationClick={handleTableElementClick}
- tableHeaderHeight={isEditingColumns && TABLE_HEADER_HEIGHT}
+ tableHeaderHeight={
+ isEditingColumns ? TABLE_HEADER_HEIGHT : undefined
+ }
renderTableHeader={renderTableHeader}
scrollToColumn={focusedFieldIndex + scrollToColumnModifier}
renderEmptyMessage={isEditingColumns}
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.module.css b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.module.css
new file mode 100644
index 00000000000..e13bc785d71
--- /dev/null
+++ b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.module.css
@@ -0,0 +1,34 @@
+.root {
+ /* Establish a stacking context so the overlay z-indexes layer correctly. */
+ transform: scale(1);
+}
+
+.spread {
+ position: absolute;
+ inset: 0;
+}
+
+.overlay {
+ position: absolute;
+ inset: 0;
+ z-index: 2;
+}
+
+.visualization {
+ position: absolute;
+ inset: 0;
+ z-index: 1;
+}
+
+.warnings {
+ position: absolute;
+ top: 0;
+ right: 0;
+ z-index: 2;
+ margin-top: var(--mantine-spacing-md);
+ margin-right: var(--mantine-spacing-md);
+}
+
+.shadowed {
+ box-shadow: 0 2px 2px var(--mb-color-shadow);
+}
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.jsx b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
similarity index 73%
rename from frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.jsx
rename to frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
index a882470592a..dd536cb785c 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.jsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
@@ -1,5 +1,5 @@
-/* eslint-disable react/prop-types */
import cx from "classnames";
+import type { ReactNode } from "react";
import { useState } from "react";
import { useTimeout } from "react-use";
import { c, t } from "ttag";
@@ -7,7 +7,6 @@ import { c, t } from "ttag";
import EmptyCodeResult from "assets/img/empty-states/code.svg";
import { LoadingSpinner } from "metabase/common/components/LoadingSpinner";
import { Warnings } from "metabase/common/components/Warnings";
-import CS from "metabase/css/core/index.css";
import QueryBuilderS from "metabase/css/query_builder.module.css";
import { useSelector } from "metabase/redux";
import { getWhiteLabeledLoadingMessageFactory } from "metabase/selectors/whitelabel";
@@ -17,13 +16,15 @@ import { SERVER_ERROR_TYPES } from "metabase/utils/errors";
import * as Lib from "metabase-lib";
import { HARD_ROW_LIMIT } from "metabase-lib/v1/queries/utils";
+import S from "./QueryVisualization.module.css";
import { RunButtonWithTooltip } from "./RunButtonWithTooltip";
import { VisualizationError } from "./VisualizationError";
import { VisualizationResult } from "./VisualizationResult";
+import type { QueryVisualizationProps } from "./types";
const SLOW_MESSAGE_TIMEOUT = 4000;
-export function QueryVisualization(props) {
+export function QueryVisualization(props: QueryVisualizationProps) {
const {
className,
question,
@@ -38,7 +39,7 @@ export function QueryVisualization(props) {
} = props;
const canRun = Lib.canRun(question.query(), question.type());
- const [warnings, setWarnings] = useState([]);
+ const [warnings, setWarnings] = useState<string[]>([]);
const isDirtyStateShown =
canRun &&
isResultDirty &&
@@ -47,65 +48,52 @@ export function QueryVisualization(props) {
!isNativeEditorOpen &&
(result?.error == null ||
isDirtyStateShownForError ||
- result.error_type === SERVER_ERROR_TYPES.missingRequiredParameter);
+ result?.error_type === SERVER_ERROR_TYPES.missingRequiredParameter);
return (
- <div
- className={cx(className, CS.relative, CS.stackingContext, CS.fullHeight)}
- >
- {isRunning ? (
- <VisualizationRunningState className={cx(CS.spread, CS.z2)} />
- ) : null}
+ <Box pos="relative" h="100%" className={cx(className, S.root)}>
+ {isRunning ? <VisualizationRunningState className={S.overlay} /> : null}
<VisualizationDirtyState
{...props}
hidden={!isDirtyStateShown}
- className={cx(CS.spread, CS.z2)}
+ className={S.overlay}
/>
{!isObjectDetail && (
- <Warnings
- warnings={warnings}
- className={cx(CS.absolute, CS.top, CS.right, CS.mt2, CS.mr2, CS.z2)}
- size={18}
- />
+ <Warnings warnings={warnings} className={S.warnings} size={18} />
)}
- <div
- className={cx(
- CS.spread,
- QueryBuilderS.Visualization,
- {
- [QueryBuilderS.VisualizationLoading]: isRunning,
- },
- CS.z1,
- )}
+ <Box
+ className={cx(S.visualization, QueryBuilderS.Visualization, {
+ [QueryBuilderS.VisualizationLoading]: isRunning,
+ })}
data-testid="query-visualization-root"
>
{result?.error ? (
<VisualizationError
- className={CS.spread}
+ className={S.spread}
error={result.error}
errorType={result.error_type}
- via={result.via}
+ via={result.via ?? []}
question={question}
- duration={result.duration}
+ duration={result.duration ?? 0}
/>
) : result?.data ? (
<VisualizationResult
{...props}
maxTableRows={maxTableRows}
- className={CS.spread}
+ className={S.spread}
onUpdateWarnings={setWarnings}
/>
) : !isRunning && !isDirtyStateShown ? (
- <VisualizationEmptyState className={CS.spread}>
+ <VisualizationEmptyState>
{t`Here's where your results will appear`}
</VisualizationEmptyState>
) : null}
- </div>
- </div>
+ </Box>
+ </Box>
);
}
-const VisualizationEmptyState = ({ children }) => {
+const VisualizationEmptyState = ({ children }: { children: ReactNode }) => {
const keyboardShortcut = getRunQueryShortcut();
return (
@@ -126,14 +114,18 @@ const VisualizationEmptyState = ({ children }) => {
);
};
-export function VisualizationRunningState({ className = "" }) {
+export function VisualizationRunningState({
+ className = "",
+}: {
+ className?: string;
+}) {
const [isSlow] = useTimeout(SLOW_MESSAGE_TIMEOUT);
const getLoadingMessage = useSelector(getWhiteLabeledLoadingMessageFactory);
// show the slower loading message only when the loadingMessage is
// not customized
- const message = getLoadingMessage(isSlow());
+ const message = getLoadingMessage(isSlow() ?? false);
return (
<Flex
@@ -151,23 +143,31 @@ export function VisualizationRunningState({ className = "" }) {
);
}
+type VisualizationDirtyStateProps = {
+ className?: string;
+ isRunning?: boolean;
+ isResultDirty?: boolean;
+ runQuestionQuery?: () => void;
+ cancelQuery?: () => void;
+ hidden?: boolean;
+};
+
export const VisualizationDirtyState = ({
className,
- result,
isRunning,
isResultDirty,
runQuestionQuery,
cancelQuery,
hidden,
-}) => {
+}: VisualizationDirtyStateProps) => {
const keyboardShortcut = getRunQueryShortcut();
const handleClick = () => {
if (!hidden) {
if (isRunning) {
- cancelQuery();
+ cancelQuery?.();
} else {
- runQuestionQuery();
+ runQuestionQuery?.();
}
}
};
@@ -186,12 +186,12 @@ export const VisualizationDirtyState = ({
onClick={handleClick}
>
<RunButtonWithTooltip
- className={CS.shadowed}
+ className={S.shadowed}
iconSize={32}
circular
hidden={hidden}
- isRunning={isRunning}
- isDirty={isResultDirty}
+ isRunning={Boolean(isRunning)}
+ isDirty={Boolean(isResultDirty)}
/>
{!hidden && <Text c="text-secondary">{keyboardShortcut}</Text>}
</Flex>
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/RunButton.tsx b/frontend/src/metabase/querying/components/QueryVisualization/RunButton.tsx
index e2175a3df05..249253366af 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/RunButton.tsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/RunButton.tsx
@@ -7,13 +7,14 @@ import { Button } from "metabase/common/components/Button";
import CS from "metabase/css/core/index.css";
import QueryBuilderS from "metabase/css/query_builder.module.css";
-interface RunButtonProps {
+export interface RunButtonProps {
className?: string;
isRunning: boolean;
isDirty: boolean;
circular?: boolean;
medium?: boolean;
hidden?: boolean;
+ disabled?: boolean;
onlyIcon?: boolean;
iconSize?: number;
onRun?: () => void;
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/RunButtonWithTooltip.jsx b/frontend/src/metabase/querying/components/QueryVisualization/RunButtonWithTooltip.tsx
similarity index 60%
rename from frontend/src/metabase/querying/components/QueryVisualization/RunButtonWithTooltip.jsx
rename to frontend/src/metabase/querying/components/QueryVisualization/RunButtonWithTooltip.tsx
index b5401c3be5a..056b8d23cf7 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/RunButtonWithTooltip.jsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/RunButtonWithTooltip.tsx
@@ -1,17 +1,28 @@
-/* eslint-disable react/prop-types */
import { t } from "ttag";
import { Tooltip } from "metabase/ui";
import { duration } from "metabase/utils/formatting";
+import type { Dataset } from "metabase-types/api";
-import { RunButton } from "./RunButton";
+import { RunButton, type RunButtonProps } from "./RunButton";
const REFRESH_TOOLTIP_THRESHOLD = 30 * 1000; // 30 seconds
-const defaultGetTooltip = ({ isDirty, result }) => {
+type TooltipInput = {
+ isDirty?: boolean;
+ result?: Dataset | null;
+};
+
+type RunButtonWithTooltipProps = RunButtonProps &
+ TooltipInput & {
+ getTooltip?: (props: TooltipInput) => string | null;
+ };
+
+const defaultGetTooltip = ({ isDirty, result }: TooltipInput) => {
const { cached, average_execution_time } = result || {};
return !isDirty &&
cached &&
+ average_execution_time != null &&
average_execution_time > REFRESH_TOOLTIP_THRESHOLD
? t`This question will take approximately ${duration(
average_execution_time,
@@ -22,7 +33,7 @@ const defaultGetTooltip = ({ isDirty, result }) => {
export function RunButtonWithTooltip({
getTooltip = defaultGetTooltip,
...props
-}) {
+}: RunButtonWithTooltipProps) {
const tooltip = getTooltip(props);
return (
<Tooltip label={tooltip} disabled={!tooltip} position="top">
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
deleted file mode 100644
index 78127d97440..00000000000
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
+++ /dev/null
@@ -1,172 +0,0 @@
-/* eslint-disable react/prop-types */
-import cx from "classnames";
-import { Component } from "react";
-import { jt, t } from "ttag";
-import _ from "underscore";
-
-import { ErrorMessage } from "metabase/common/components/ErrorMessage";
-import ButtonsS from "metabase/css/components/buttons.module.css";
-import CS from "metabase/css/core/index.css";
-import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import { CreateOrEditQuestionAlertModal } from "metabase/notifications/modals/CreateOrEditQuestionAlertModal";
-import { ALERT_TYPE_ROWS, getAlertType } from "metabase/notifications/utils";
-import Visualization from "metabase/visualizations/components/Visualization";
-import * as Lib from "metabase-lib";
-import { datasetContainsNoResults } from "metabase-lib/v1/queries/utils/dataset";
-
-const ALLOWED_VISUALIZATION_PROPS = [
- // Table
- "isShowingDetailsOnlyColumns",
- // Table Interactive
- "hasMetadataPopovers",
- "tableHeaderHeight",
- "scrollToColumn",
- "renderTableHeader",
- "mode",
- "renderEmptyMessage",
- "zoomedRowIndex",
- // Legend
- "hideLegend",
-];
-
-export class VisualizationResult extends Component {
- state = {
- showCreateAlertModal: false,
- };
-
- showCreateAlertModal = () => {
- this.setState({ showCreateAlertModal: true });
- };
-
- onCloseCreateAlertModal = () => {
- this.setState({ showCreateAlertModal: false });
- };
-
- render() {
- const {
- question,
- token,
- isDirty,
- queryBuilderMode,
- navigateToNewCardInsideQB,
- result,
- rawSeries,
- timelineEvents,
- selectedTimelineEventIds,
- onNavigateBack,
- className,
- isRunning,
- isShowingSummarySidebar,
- editSummary,
- renderEmptyMessage,
- isRawTable,
- scrollToLastColumn,
- onZoomRow,
- getExtraDataForClick,
- } = this.props;
- const { showCreateAlertModal } = this.state;
-
- const noResults = datasetContainsNoResults(result.data);
- if (noResults && !isRunning && !renderEmptyMessage) {
- const supportsRowsPresentAlert =
- !isEmbeddingSdk() && getAlertType(question) === ALERT_TYPE_ROWS;
-
- const supportsBackToPreviousResult =
- !isEmbeddingSdk() || !!onNavigateBack;
-
- // successful query but there were 0 rows returned with the result
- return (
- <div className={cx(className, CS.flex)}>
- <ErrorMessage
- type="noRows"
- title={t`No results!`}
- message={t`This may be the answer you’re looking for. If not, try removing or changing your filters to make them less specific.`}
- action={
- <div>
- {supportsRowsPresentAlert && !isDirty && (
- <p>
- {jt`You can also ${(
- <a
- className={CS.link}
- key="link"
- onClick={this.showCreateAlertModal}
- >
- {t`get an alert`}
- </a>
- )} when there are some results.`}
- </p>
- )}
-
- {supportsBackToPreviousResult && (
- <button
- className={ButtonsS.Button}
- onClick={() =>
- onNavigateBack ? onNavigateBack() : window.history.back()
- }
- >
- {t`Back to previous results`}
- </button>
- )}
- </div>
- }
- />
- {showCreateAlertModal && (
- <CreateOrEditQuestionAlertModal
- question={question}
- onClose={this.onCloseCreateAlertModal}
- onAlertCreated={this.onCloseCreateAlertModal}
- />
- )}
- </div>
- );
- } else {
- const vizSpecificProps = _.pick(
- this.props,
- ...ALLOWED_VISUALIZATION_PROPS,
- );
- const { isEditable } = Lib.queryDisplayInfo(question.query());
- const hasDrills = isEditable;
- return (
- <>
- <Visualization
- className={className}
- rawSeries={rawSeries}
- onChangeCardAndRun={
- hasDrills ? navigateToNewCardInsideQB : undefined
- }
- isEditing={true}
- isObjectDetail={false}
- isQueryBuilder={true}
- isRawTable={isRawTable}
- scrollToLastColumn={scrollToLastColumn}
- isShowingSummarySidebar={isShowingSummarySidebar}
- isRunning={isRunning}
- editSummary={editSummary}
- queryBuilderMode={queryBuilderMode}
- showTitle={false}
- canToggleSeriesVisibility
- metadata={question.metadata()}
- timelineEvents={timelineEvents}
- token={token}
- selectedTimelineEventIds={selectedTimelineEventIds}
- getExtraDataForClick={getExtraDataForClick}
- onZoomRow={onZoomRow}
- handleVisualizationClick={this.props.handleVisualizationClick}
- onOpenTimelines={this.props.onOpenTimelines}
- onSelectTimelineEvents={this.props.selectTimelineEvents}
- onDeselectTimelineEvents={this.props.deselectTimelineEvents}
- onOpenChartSettings={this.props.onOpenChartSettings}
- onUpdateQuestion={this.props.onUpdateQuestion}
- onUpdateWarnings={this.props.onUpdateWarnings}
- onHeaderColumnReorder={this.props.onHeaderColumnReorder}
- onUpdateVisualizationSettings={
- this.props.onUpdateVisualizationSettings
- }
- onVisualizationRendered={this.props.onVisualizationRendered}
- {...vizSpecificProps}
- />
- </>
- );
- }
- }
-}
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.tsx b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.tsx
new file mode 100644
index 00000000000..4096add4233
--- /dev/null
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.tsx
@@ -0,0 +1,149 @@
+import { useState } from "react";
+import { jt, t } from "ttag";
+import _ from "underscore";
+
+import { ErrorMessage } from "metabase/common/components/ErrorMessage";
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
+import { CreateOrEditQuestionAlertModal } from "metabase/notifications/modals/CreateOrEditQuestionAlertModal";
+import { ALERT_TYPE_ROWS, getAlertType } from "metabase/notifications/utils";
+import { Anchor, Button, Flex } from "metabase/ui";
+import Visualization from "metabase/visualizations/components/Visualization";
+import * as Lib from "metabase-lib";
+import { datasetContainsNoResults } from "metabase-lib/v1/queries/utils/dataset";
+
+import type { QueryVisualizationProps } from "./types";
+
+const ALLOWED_VISUALIZATION_PROPS = [
+ // Table
+ "isShowingDetailsOnlyColumns",
+ // Table Interactive
+ "hasMetadataPopovers",
+ "tableHeaderHeight",
+ "scrollToColumn",
+ "renderTableHeader",
+ "mode",
+ "renderEmptyMessage",
+ "zoomedRowIndex",
+ // Legend
+ "hideLegend",
+] as const;
+
+export function VisualizationResult(props: QueryVisualizationProps) {
+ const {
+ question,
+ isDirty,
+ queryBuilderMode,
+ navigateToNewCardInsideQB,
+ result,
+ rawSeries,
+ timelineEvents,
+ selectedTimelineEventIds,
+ onNavigateBack,
+ className,
+ isRunning,
+ isShowingSummarySidebar,
+ editSummary,
+ renderEmptyMessage,
+ isRawTable,
+ scrollToLastColumn,
+ onZoomRow,
+ getExtraDataForClick,
+ } = props;
+ const [isCreateAlertModalShown, setIsCreateAlertModalShown] = useState(false);
+
+ if (!result) {
+ return null;
+ }
+
+ const noResults = datasetContainsNoResults(result.data);
+ if (noResults && !isRunning && !renderEmptyMessage) {
+ const supportsRowsPresentAlert =
+ !isEmbeddingSdk() && getAlertType(question) === ALERT_TYPE_ROWS;
+
+ const supportsBackToPreviousResult =
+ !isEmbeddingSdk() || Boolean(onNavigateBack);
+
+ // successful query but there were 0 rows returned with the result
+ return (
+ <Flex className={className}>
+ <ErrorMessage
+ type="noRows"
+ title={t`No results!`}
+ message={t`This may be the answer you’re looking for. If not, try removing or changing your filters to make them less specific.`}
+ action={
+ <div>
+ {supportsRowsPresentAlert && !isDirty && (
+ <p>
+ {jt`You can also ${(
+ <Anchor
+ key="link"
+ onClick={() => setIsCreateAlertModalShown(true)}
+ >
+ {t`get an alert`}
+ </Anchor>
+ )} when there are some results.`}
+ </p>
+ )}
+
+ {supportsBackToPreviousResult && (
+ <Button
+ variant="default"
+ onClick={() =>
+ onNavigateBack ? onNavigateBack() : window.history.back()
+ }
+ >
+ {t`Back to previous results`}
+ </Button>
+ )}
+ </div>
+ }
+ />
+ {isCreateAlertModalShown && (
+ <CreateOrEditQuestionAlertModal
+ question={question}
+ onClose={() => setIsCreateAlertModalShown(false)}
+ onAlertCreated={() => setIsCreateAlertModalShown(false)}
+ />
+ )}
+ </Flex>
+ );
+ }
+
+ const vizSpecificProps = _.pick(props, ...ALLOWED_VISUALIZATION_PROPS);
+ const { isEditable } = Lib.queryDisplayInfo(question.query());
+ const hasDrills = isEditable;
+ return (
+ <Visualization
+ className={className}
+ rawSeries={rawSeries ?? undefined}
+ onChangeCardAndRun={hasDrills ? navigateToNewCardInsideQB : undefined}
+ isEditing={true}
+ isObjectDetail={false}
+ isQueryBuilder={true}
+ isRawTable={isRawTable}
+ scrollToLastColumn={scrollToLastColumn}
+ isShowingSummarySidebar={isShowingSummarySidebar}
+ isRunning={isRunning}
+ editSummary={editSummary}
+ queryBuilderMode={queryBuilderMode}
+ showTitle={false}
+ canToggleSeriesVisibility
+ metadata={question.metadata()}
+ timelineEvents={timelineEvents}
+ selectedTimelineEventIds={selectedTimelineEventIds}
+ getExtraDataForClick={getExtraDataForClick}
+ onZoomRow={onZoomRow}
+ handleVisualizationClick={props.handleVisualizationClick}
+ onOpenTimelines={props.onOpenTimelines}
+ onSelectTimelineEvents={props.selectTimelineEvents}
+ onDeselectTimelineEvents={props.deselectTimelineEvents}
+ onOpenChartSettings={props.onOpenChartSettings}
+ onUpdateQuestion={props.onUpdateQuestion}
+ onUpdateWarnings={props.onUpdateWarnings}
+ onHeaderColumnReorder={props.onHeaderColumnReorder}
+ onUpdateVisualizationSettings={props.onUpdateVisualizationSettings}
+ onVisualizationRendered={props.onVisualizationRendered}
+ {...vizSpecificProps}
+ />
+ );
+}
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/index.ts b/frontend/src/metabase/querying/components/QueryVisualization/index.ts
index 8ed0c58b990..d9dc0365be2 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/index.ts
+++ b/frontend/src/metabase/querying/components/QueryVisualization/index.ts
@@ -3,3 +3,4 @@ export {
VisualizationRunningState,
VisualizationDirtyState,
} from "./QueryVisualization";
+export type { QueryVisualizationProps } from "./types";
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/types.ts b/frontend/src/metabase/querying/components/QueryVisualization/types.ts
new file mode 100644
index 00000000000..61b87537fa4
--- /dev/null
+++ b/frontend/src/metabase/querying/components/QueryVisualization/types.ts
@@ -0,0 +1,74 @@
+import type {
+ ClickObject,
+ VisualizationPassThroughProps,
+} from "metabase/visualizations/types";
+import type Question from "metabase-lib/v1/Question";
+import type {
+ Card,
+ Dataset,
+ RawSeries,
+ Series,
+ TimelineEvent,
+ VisualizationSettings,
+} from "metabase-types/api";
+
+/**
+ * A query result as it lives in the query builder. It's a {@link Dataset} for
+ * successful runs, augmented with the `via` error chain and `duration` that the
+ * QB attaches to failed runs (see `query_builder/actions/querying`).
+ */
+export type QueryVisualizationResult = Dataset & {
+ via?: Record<string, unknown>[];
+ duration?: number;
+};
+
+export type QueryVisualizationProps = VisualizationPassThroughProps & {
+ className?: string;
+ noHeader?: boolean;
+ question: Question;
+ result?: QueryVisualizationResult | null;
+ rawSeries?: RawSeries | null;
+ maxTableRows?: number;
+
+ isRunnable?: boolean;
+ isRunning?: boolean;
+ isResultDirty?: boolean;
+ isNativeEditorOpen?: boolean;
+ isDirtyStateShownForError?: boolean;
+ isDirty?: boolean;
+ isShowingSummarySidebar?: boolean;
+ hideLegend?: boolean;
+
+ // query-builder-specific props injected by callers via `useVisualizationResultQBProps`
+ isRawTable?: boolean;
+ scrollToLastColumn?: boolean;
+ getExtraDataForClick?: () => Record<string, unknown>;
+
+ timelineEvents?: TimelineEvent[];
+ selectedTimelineEventIds?: number[];
+
+ runQuestionQuery?: () => void;
+ cancelQuery?: () => void;
+ navigateToNewCardInsideQB?: (opts: {
+ nextCard: Card;
+ previousCard: Card;
+ objectId?: number;
+ }) => void;
+ onNavigateBack?: () => void;
+ editSummary?: () => void;
+
+ handleVisualizationClick?: (clicked: ClickObject | null) => void;
+ selectTimelineEvents?: (timelineEvents: TimelineEvent[]) => void;
+ deselectTimelineEvents?: () => void;
+ onOpenChartSettings?: (data: {
+ initialChartSettings?: { section: string };
+ showSidebarTitle?: boolean;
+ }) => void;
+ onUpdateQuestion?: (question: Question, opts?: { run?: boolean }) => void;
+ onUpdateWarnings?: (warnings: string[]) => void;
+ onUpdateVisualizationSettings?: (
+ settings: VisualizationSettings,
+ question?: Question,
+ ) => void;
+ onVisualizationRendered?: (series: Series) => void;
+};
diff --git a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
index 90aea16b08d..14b84416fb5 100644
--- a/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
+++ b/frontend/src/metabase/visualizations/components/Visualization/Visualization.tsx
@@ -179,9 +179,9 @@ type VisualizationOwnProps = {
}) => void;
onChangeCardAndRun?: ((opts: OnChangeCardAndRunOpts) => void) | null;
onBrush?: ((range: { start: number; end: number }) => void) | null;
- onHeaderColumnReorder?: (columnName: string) => void;
+ onHeaderColumnReorder?: (columnIndex: number) => void;
onChangeLocation?: (location: Location) => void;
- onUpdateQuestion?: () => void;
+ onUpdateQuestion?: (question: Question) => void;
onUpdateVisualizationSettings?: (
settings: VisualizationSettings,
question?: Question,
diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.ts
index 621a8097d66..d32139f9bfb 100644
--- a/frontend/src/metabase/visualizations/types/visualization.ts
+++ b/frontend/src/metabase/visualizations/types/visualization.ts
@@ -242,7 +242,7 @@ export type VisualizationPassThroughProps = {
tableHeaderHeight?: number;
scrollToColumn?: number;
renderTableHeader?: (
- column: number,
+ column: DatasetColumn,
index: number,
theme: unknown,
) => ReactNode;
@@ -259,7 +259,7 @@ export type VisualizationPassThroughProps = {
showAllLegendItems?: boolean;
- onHeaderColumnReorder?: (columnName: string) => void;
+ onHeaderColumnReorder?: (columnIndex: number) => void;
/**
* Items that will be shown in a menu when the title is clicked.