You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by di...@apache.org on 2025/09/16 14:11:26 UTC
(superset) branch master updated: feat(custom-tooltip): custom tooltip on deck.gl charts (#34276)
This is an automated email from the ASF dual-hosted git repository.
diegopucci pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new a66737cb05 feat(custom-tooltip): custom tooltip on deck.gl charts (#34276)
a66737cb05 is described below
commit a66737cb05c75683fe19595d03cfd5e09c3e9075
Author: Richard Fogaca Nienkotter <63...@users.noreply.github.com>
AuthorDate: Tue Sep 16 11:11:19 2025 -0300
feat(custom-tooltip): custom tooltip on deck.gl charts (#34276)
---
.../cypress/e2e/explore/control.test.ts | 15 +-
superset-frontend/package-lock.json | 5 +-
.../superset-ui-chart-controls/package.json | 3 +-
.../src/components/AsyncAceEditor/index.tsx | 12 +
.../src/components/CodeEditor/index.tsx | 106 +++
.../superset-ui-core/src/components/index.ts | 6 +
.../superset-ui-core/types/ace-builds.d.ts | 2 +
.../legacy-preset-chart-deckgl/package.json | 2 +
.../src/DeckGLContainer.tsx | 23 +-
.../src/components/Legend.tsx | 2 +
.../src/components/Tooltip.tsx | 36 +-
.../src/layers/Arc/Arc.tsx | 56 +-
.../src/layers/Arc/controlPanel.ts | 4 +
.../src/layers/Contour/Contour.tsx | 72 +-
.../src/layers/Contour/controlPanel.ts | 4 +
.../src/layers/Geojson/controlPanel.ts | 4 +
.../src/layers/Grid/Grid.tsx | 32 +-
.../src/layers/Grid/controlPanel.ts | 4 +
.../src/layers/Heatmap/Heatmap.tsx | 93 ++-
.../src/layers/Heatmap/controlPanel.ts | 4 +
.../src/layers/Hex/Hex.tsx | 30 +-
.../src/layers/Hex/controlPanel.ts | 4 +
.../src/layers/Path/Path.tsx | 30 +-
.../src/layers/Path/controlPanel.ts | 4 +
.../src/layers/Polygon/Polygon.tsx | 67 +-
.../src/layers/Polygon/controlPanel.ts | 4 +
.../src/layers/Scatter/Scatter.tsx | 47 +-
.../src/layers/Scatter/controlPanel.ts | 4 +
.../src/layers/Screengrid/Screengrid.tsx | 111 ++-
.../src/layers/Screengrid/controlPanel.ts | 4 +
.../src/layers/common.tsx | 18 +-
.../src/utilities/HandlebarsRenderer.tsx | 231 ++++++
.../src/utilities/Shared_DeckGL.tsx | 77 +-
.../src/utilities/TooltipTemplateControl.tsx | 82 ++
.../src/utilities/TooltipTemplateEditor.tsx | 76 ++
.../src/utilities/controlRegistry.tsx | 57 ++
.../src/utilities/multiValueUtils.ts | 142 ++++
.../src/utilities/tooltipUtils.tsx | 384 +++++++++
.../src/utilities/utils.ts | 2 -
.../legacy-preset-chart-deckgl/tsconfig.json | 5 +-
.../src/components/CodeEditor/CodeEditor.tsx | 67 +-
.../src/components/Handlebars/HandlebarsViewer.tsx | 2 +-
superset-frontend/spec/helpers/setup.ts | 6 +
.../explore/components/ControlPanelsContainer.tsx | 28 +-
.../components/ExploreViewContainer/index.jsx | 100 ++-
.../explore/components/RunQueryButton/index.tsx | 1 +
.../DndColumnSelectControl/ColumnSelectPopover.tsx | 317 +++++---
.../ColumnSelectPopoverTrigger.tsx | 66 +-
.../DndColumnMetricSelect.test.tsx | 344 ++++++++
.../DndColumnMetricSelect.tsx | 448 +++++++++++
.../controls/DndColumnSelectControl/Option.tsx | 8 +
.../DndColumnSelectControl/OptionWrapper.tsx | 2 +
.../controls/DndColumnSelectControl/index.ts | 12 +
.../controls/DndColumnSelectControl/types.ts | 1 +
.../components/controls/TextAreaControl.jsx | 48 +-
.../src/explore/components/controls/index.ts | 2 +
superset/common/query_context_factory.py | 77 ++
superset/config.py | 2 +-
superset/utils/core.py | 5 +
superset/viz.py | 303 ++++++-
tests/integration_tests/viz_tests.py | 879 +++++++++++++++++++--
.../common/test_query_context_factory.py | 438 ++++++++++
62 files changed, 4599 insertions(+), 421 deletions(-)
diff --git a/superset-frontend/cypress-base/cypress/e2e/explore/control.test.ts b/superset-frontend/cypress-base/cypress/e2e/explore/control.test.ts
index c6a308393e..cee2dab5b5 100644
--- a/superset-frontend/cypress-base/cypress/e2e/explore/control.test.ts
+++ b/superset-frontend/cypress-base/cypress/e2e/explore/control.test.ts
@@ -124,10 +124,13 @@ describe('VizType control', () => {
});
it('Can change vizType', () => {
- cy.visitChartByName('Daily Totals');
+ cy.visitChartByName('Daily Totals').then(() => {
+ cy.get('.slice_container').should('be.visible');
+ });
+
cy.verifySliceSuccess({ waitAlias: '@tableChartData' });
- cy.contains('View all charts').click();
+ cy.contains('View all charts').should('be.visible').click();
cy.get('.ant-modal-content').within(() => {
cy.get('button').contains('KPI').click(); // change categories
@@ -176,8 +179,12 @@ describe('Groupby control', () => {
.contains('Drop columns here or click')
.click();
cy.get('[id="adhoc-metric-edit-tabs-tab-simple"]').click();
- cy.get('input[aria-label="Column"]').click();
- cy.get('input[aria-label="Column"]').type('state{enter}');
+
+ cy.get('input[aria-label="Columns and metrics"]', { timeout: 10000 })
+ .should('be.visible')
+ .click();
+ cy.get('input[aria-label="Columns and metrics"]').type('state{enter}');
+
cy.get('[data-test="ColumnEdit#save"]').contains('Save').click();
cy.get('button[data-test="run-query-button"]').click();
diff --git a/superset-frontend/package-lock.json b/superset-frontend/package-lock.json
index 0bd0e3231f..7df6870bbf 100644
--- a/superset-frontend/package-lock.json
+++ b/superset-frontend/package-lock.json
@@ -63323,8 +63323,7 @@
"dependencies": {
"@react-icons/all-files": "^4.1.0",
"@types/react": "*",
- "lodash": "^4.17.21",
- "prop-types": "^15.8.1"
+ "lodash": "^4.17.21"
},
"peerDependencies": {
"@ant-design/icons": "^5.2.6",
@@ -65227,6 +65226,8 @@
"d3-array": "^1.2.4",
"d3-color": "^1.4.1",
"d3-scale": "^3.0.0",
+ "dayjs": "^1.11.13",
+ "handlebars": "^4.7.8",
"lodash": "^4.17.21",
"mousetrap": "^1.6.5",
"ngeohash": "^0.6.3",
diff --git a/superset-frontend/packages/superset-ui-chart-controls/package.json b/superset-frontend/packages/superset-ui-chart-controls/package.json
index 1ba1d2a35f..0c368ce6fd 100644
--- a/superset-frontend/packages/superset-ui-chart-controls/package.json
+++ b/superset-frontend/packages/superset-ui-chart-controls/package.json
@@ -26,8 +26,7 @@
"dependencies": {
"@react-icons/all-files": "^4.1.0",
"@types/react": "*",
- "lodash": "^4.17.21",
- "prop-types": "^15.8.1"
+ "lodash": "^4.17.21"
},
"peerDependencies": {
"@ant-design/icons": "^5.2.6",
diff --git a/superset-frontend/packages/superset-ui-core/src/components/AsyncAceEditor/index.tsx b/superset-frontend/packages/superset-ui-core/src/components/AsyncAceEditor/index.tsx
index 22146a9e53..c759a2bbd5 100644
--- a/superset-frontend/packages/superset-ui-core/src/components/AsyncAceEditor/index.tsx
+++ b/superset-frontend/packages/superset-ui-core/src/components/AsyncAceEditor/index.tsx
@@ -123,21 +123,33 @@ export function AsyncAceEditor(
const cssWorkerUrlPromise = import(
'ace-builds/src-min-noconflict/worker-css'
);
+ const javascriptWorkerUrlPromise = import(
+ 'ace-builds/src-min-noconflict/worker-javascript'
+ );
+ const htmlWorkerUrlPromise = import(
+ 'ace-builds/src-min-noconflict/worker-html'
+ );
const acequirePromise = import('ace-builds/src-min-noconflict/ace');
const [
{ default: ReactAceEditor },
{ config },
{ default: cssWorkerUrl },
+ { default: javascriptWorkerUrl },
+ { default: htmlWorkerUrl },
{ require: acequire },
] = await Promise.all([
reactAcePromise,
aceBuildsConfigPromise,
cssWorkerUrlPromise,
+ javascriptWorkerUrlPromise,
+ htmlWorkerUrlPromise,
acequirePromise,
]);
config.setModuleUrl('ace/mode/css_worker', cssWorkerUrl);
+ config.setModuleUrl('ace/mode/javascript_worker', javascriptWorkerUrl);
+ config.setModuleUrl('ace/mode/html_worker', htmlWorkerUrl);
await Promise.all(aceModules.map(x => aceModuleLoaders[x]()));
diff --git a/superset-frontend/packages/superset-ui-core/src/components/CodeEditor/index.tsx b/superset-frontend/packages/superset-ui-core/src/components/CodeEditor/index.tsx
new file mode 100644
index 0000000000..b2721953e3
--- /dev/null
+++ b/superset-frontend/packages/superset-ui-core/src/components/CodeEditor/index.tsx
@@ -0,0 +1,106 @@
+/* eslint-disable import/first */
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { FC } from 'react';
+import AceEditor, { IAceEditorProps } from 'react-ace';
+import ace from 'ace-builds/src-noconflict/ace';
+
+// Disable workers to avoid localhost loading issues
+ace.config.set('useWorker', false);
+
+// Import required modes and themes after ace is loaded
+import 'ace-builds/src-min-noconflict/mode-handlebars';
+import 'ace-builds/src-min-noconflict/mode-css';
+import 'ace-builds/src-min-noconflict/mode-json';
+import 'ace-builds/src-min-noconflict/mode-sql';
+import 'ace-builds/src-min-noconflict/mode-markdown';
+import 'ace-builds/src-min-noconflict/mode-javascript';
+import 'ace-builds/src-min-noconflict/mode-html';
+import 'ace-builds/src-noconflict/theme-github';
+import 'ace-builds/src-noconflict/theme-monokai';
+
+export type CodeEditorMode =
+ | 'handlebars'
+ | 'css'
+ | 'json'
+ | 'sql'
+ | 'markdown'
+ | 'javascript'
+ | 'html';
+
+export type CodeEditorTheme = 'light' | 'dark';
+
+export interface CodeEditorProps
+ extends Omit<IAceEditorProps, 'mode' | 'theme'> {
+ mode?: CodeEditorMode;
+ theme?: CodeEditorTheme;
+ name?: string;
+}
+
+export const CodeEditor: FC<CodeEditorProps> = ({
+ mode = 'handlebars',
+ theme = 'dark',
+ name,
+ width = '100%',
+ height = '300px',
+ value,
+ fontSize = 14,
+ showPrintMargin = true,
+ focus = true,
+ wrapEnabled = true,
+ highlightActiveLine = true,
+ editorProps = { $blockScrolling: true },
+ setOptions,
+ ...rest
+}: CodeEditorProps) => {
+ const editorName = name || Math.random().toString(36).substring(7);
+ const aceTheme = theme === 'light' ? 'github' : 'monokai';
+
+ return (
+ <AceEditor
+ mode={mode}
+ theme={aceTheme}
+ name={editorName}
+ height={height}
+ width={width}
+ value={value}
+ fontSize={fontSize}
+ showPrintMargin={showPrintMargin}
+ focus={focus}
+ editorProps={editorProps}
+ wrapEnabled={wrapEnabled}
+ highlightActiveLine={highlightActiveLine}
+ setOptions={{
+ enableBasicAutocompletion: true,
+ enableLiveAutocompletion: true,
+ enableSnippets: true,
+ showLineNumbers: true,
+ tabSize: 2,
+ showGutter: true,
+ fontFamily:
+ 'Menlo, Consolas, Courier New, Ubuntu Mono, source-code-pro, Lucida Console, monospace',
+ ...setOptions,
+ }}
+ {...rest}
+ />
+ );
+};
+
+export default CodeEditor;
diff --git a/superset-frontend/packages/superset-ui-core/src/components/index.ts b/superset-frontend/packages/superset-ui-core/src/components/index.ts
index 8cb4a3af9a..6590688076 100644
--- a/superset-frontend/packages/superset-ui-core/src/components/index.ts
+++ b/superset-frontend/packages/superset-ui-core/src/components/index.ts
@@ -181,3 +181,9 @@ export {
type ThemedAgGridReactProps,
setupAGGridModules,
} from './ThemedAgGridReact';
+export {
+ CodeEditor,
+ type CodeEditorProps,
+ type CodeEditorMode,
+ type CodeEditorTheme,
+} from './CodeEditor';
diff --git a/superset-frontend/packages/superset-ui-core/types/ace-builds.d.ts b/superset-frontend/packages/superset-ui-core/types/ace-builds.d.ts
index 347b9889a4..63890d0e61 100644
--- a/superset-frontend/packages/superset-ui-core/types/ace-builds.d.ts
+++ b/superset-frontend/packages/superset-ui-core/types/ace-builds.d.ts
@@ -17,4 +17,6 @@
* under the License.
*/
declare module 'ace-builds/src-min-noconflict/worker-css';
+declare module 'ace-builds/src-min-noconflict/worker-javascript';
+declare module 'ace-builds/src-min-noconflict/worker-html';
declare module 'ace-builds/src-min-noconflict/ace';
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/package.json b/superset-frontend/plugins/legacy-preset-chart-deckgl/package.json
index d094c87cc4..e026b10f4c 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/package.json
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/package.json
@@ -43,6 +43,8 @@
"d3-array": "^1.2.4",
"d3-color": "^1.4.1",
"d3-scale": "^3.0.0",
+ "dayjs": "^1.11.13",
+ "handlebars": "^4.7.8",
"lodash": "^4.17.21",
"mousetrap": "^1.6.5",
"ngeohash": "^0.6.3",
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/DeckGLContainer.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/DeckGLContainer.tsx
index 9837666027..ad1ed4953a 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/DeckGLContainer.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/DeckGLContainer.tsx
@@ -29,6 +29,7 @@ import {
useEffect,
useImperativeHandle,
useState,
+ isValidElement,
useRef,
} from 'react';
import { isEqual } from 'lodash';
@@ -110,7 +111,9 @@ export const DeckGLContainer = memo(
const layers = useCallback(() => {
if (
(props.mapStyle?.startsWith(TILE_LAYER_PREFIX) ||
- OSM_LAYER_KEYWORDS.some(tilek => props.mapStyle?.includes(tilek))) &&
+ OSM_LAYER_KEYWORDS.some((tilek: string) =>
+ props.mapStyle?.includes(tilek),
+ )) &&
props.layers.some(
l => typeof l !== 'function' && l?.id === 'tile-layer',
) === false
@@ -132,6 +135,20 @@ export const DeckGLContainer = memo(
return props.layers as Layer[];
}, [props.layers, props.mapStyle]);
+ const isCustomTooltip = (content: ReactNode): boolean =>
+ isValidElement(content) &&
+ content.props?.['data-tooltip-type'] === 'custom';
+
+ const renderTooltip = (tooltipState: TooltipProps['tooltip']) => {
+ if (!tooltipState) return null;
+
+ if (isCustomTooltip(tooltipState.content)) {
+ return <Tooltip tooltip={tooltipState} variant="custom" />;
+ }
+
+ return <Tooltip tooltip={tooltipState} />;
+ };
+
const { children = null, height, width } = props;
return (
@@ -150,7 +167,7 @@ export const DeckGLContainer = memo(
layers={layers()}
viewState={viewState}
onViewStateChange={onViewStateChange}
- onAfterRender={context => {
+ onAfterRender={(context: any) => {
glContextRef.current = context.gl;
}}
>
@@ -164,7 +181,7 @@ export const DeckGLContainer = memo(
</DeckGL>
{children}
</div>
- <Tooltip tooltip={tooltip} />
+ {renderTooltip(tooltip)}
</>
);
}),
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Legend.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Legend.tsx
index 137da24fd3..07c979e421 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Legend.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Legend.tsx
@@ -34,6 +34,8 @@ const StyledLegend = styled.div`
outline: none;
overflow-y: scroll;
max-height: 200px;
+ border: 1px solid ${theme.colorBorder};
+ border-radius: ${theme.borderRadius}px;
& ul {
list-style: none;
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Tooltip.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Tooltip.tsx
index 096d2edcd6..670e44e81d 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Tooltip.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/components/Tooltip.tsx
@@ -29,26 +29,42 @@ export type TooltipProps = {
}
| null
| undefined;
+ variant?: 'default' | 'custom';
};
-const StyledDiv = styled.div<{ top: number; left: number }>`
- ${({ theme, top, left }) => `
+const StyledDiv = styled.div<{
+ top: number;
+ left: number;
+ variant: 'default' | 'custom';
+}>`
+ ${({ theme, top, left, variant }) => `
position: absolute;
top: ${top}px;
left: ${left}px;
- padding: ${theme.sizeUnit * 2}px;
- margin: ${theme.sizeUnit * 2}px;
- background: ${theme.colorBgElevated};
- color: ${theme.colorText};
- maxWidth: 300px;
- fontSize: ${theme.fontSizeSM}px;
zIndex: 9;
pointerEvents: none;
+ ${
+ variant === 'default'
+ ? `
+ padding: ${theme.sizeUnit * 2}px;
+ margin: ${theme.sizeUnit * 2}px;
+ background: ${theme.colorBgElevated};
+ color: ${theme.colorText};
+ maxWidth: 300px;
+ fontSize: ${theme.fontSizeSM}px;
+ border: 1px solid ${theme.colorBorder};
+ border-radius: ${theme.borderRadius}px;
+ box-shadow: ${theme.boxShadowSecondary};
+ `
+ : `
+ margin: ${theme.sizeUnit * 3}px;
+ `
+ }
`}
`;
export default function Tooltip(props: TooltipProps) {
- const { tooltip } = props;
+ const { tooltip, variant = 'default' } = props;
if (typeof tooltip === 'undefined' || tooltip === null) {
return null;
}
@@ -58,7 +74,7 @@ export default function Tooltip(props: TooltipProps) {
typeof content === 'string' ? safeHtmlSpan(content) : content;
return (
- <StyledDiv top={y} left={x}>
+ <StyledDiv top={y} left={x} variant={variant}>
{safeContent}
</StyledDiv>
);
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/Arc.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/Arc.tsx
index dc468bc587..f8a6f84a92 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/Arc.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/Arc.tsx
@@ -17,14 +17,26 @@
* under the License.
*/
import { ArcLayer } from '@deck.gl/layers';
-import { JsonObject, QueryFormData, t } from '@superset-ui/core';
+import { JsonObject, QueryFormData } from '@superset-ui/core';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
import { commonLayerProps } from '../common';
import { GetLayerType, createCategoricalDeckGLComponent } from '../../factory';
-import TooltipRow from '../../TooltipRow';
import { Point } from '../../types';
+import {
+ createTooltipContent,
+ CommonTooltipRows,
+} from '../../utilities/tooltipUtils';
import { HIGHLIGHT_COLOR_ARRAY, TRANSPARENT_COLOR_ARRAY } from '../../utils';
+interface ArcDataItem {
+ sourceColor?: number[];
+ targetColor?: number[];
+ color?: number[];
+ sourcePosition: number[];
+ targetPosition: number[];
+ [key: string]: unknown;
+}
+
export function getPoints(data: JsonObject[]) {
const points: Point[] = [];
data.forEach(d => {
@@ -36,24 +48,14 @@ export function getPoints(data: JsonObject[]) {
}
function setTooltipContent(formData: QueryFormData) {
- return (o: JsonObject) => (
+ const defaultTooltipGenerator = (o: JsonObject) => (
<div className="deckgl-tooltip">
- <TooltipRow
- label={t('Start (Longitude, Latitude): ')}
- value={`${o.object?.sourcePosition?.[0]}, ${o.object?.sourcePosition?.[1]}`}
- />
- <TooltipRow
- label={t('End (Longitude, Latitude): ')}
- value={`${o.object?.targetPosition?.[0]}, ${o.object?.targetPosition?.[1]}`}
- />
- {formData.dimension && (
- <TooltipRow
- label={`${formData?.dimension}: `}
- value={`${o.object?.cat_color}`}
- />
- )}
+ {CommonTooltipRows.arcPositions(o)}
+ {CommonTooltipRows.category(o)}
</div>
);
+
+ return createTooltipContent(formData, defaultTooltipGenerator);
}
export const getLayer: GetLayerType<ArcLayer> = function ({
@@ -74,19 +76,27 @@ export const getLayer: GetLayerType<ArcLayer> = function ({
return new ArcLayer({
data,
- getSourceColor: (d: JsonObject) => {
+ getSourceColor: (d: ArcDataItem): [number, number, number, number] => {
if (colorSchemeType === COLOR_SCHEME_TYPES.fixed_color) {
return [sc.r, sc.g, sc.b, 255 * sc.a];
}
-
- return d.targetColor || d.color;
+ return (d.sourceColor || d.color || [sc.r, sc.g, sc.b, 255 * sc.a]) as [
+ number,
+ number,
+ number,
+ number,
+ ];
},
- getTargetColor: (d: any) => {
+ getTargetColor: (d: ArcDataItem): [number, number, number, number] => {
if (colorSchemeType === COLOR_SCHEME_TYPES.fixed_color) {
return [tc.r, tc.g, tc.b, 255 * tc.a];
}
-
- return d.targetColor || d.color;
+ return (d.targetColor || d.color || [tc.r, tc.g, tc.b, 255 * tc.a]) as [
+ number,
+ number,
+ number,
+ number,
+ ];
},
id: `path-layer-${fd.slice_id}` as const,
getWidth: fd.stroke_width ? fd.stroke_width : 3,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/controlPanel.ts
index dc6d726148..89d666dd93 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Arc/controlPanel.ts
@@ -38,6 +38,8 @@ import {
legendPosition,
viewport,
mapboxStyle,
+ tooltipContents,
+ tooltipTemplate,
deckGLCategoricalColor,
deckGLCategoricalColorSchemeSelect,
deckGLCategoricalColorSchemeTypeSelect,
@@ -77,6 +79,8 @@ const config: ControlPanelConfig = {
],
['row_limit', filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/Contour.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/Contour.tsx
index 18cad10d87..42af03b686 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/Contour.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/Contour.tsx
@@ -25,8 +25,24 @@ import sandboxedEval from '../../utils/sandbox';
import { GetLayerType, createDeckGLComponent } from '../../factory';
import { ColorType } from '../../types';
import TooltipRow from '../../TooltipRow';
+import {
+ createTooltipContent,
+ CommonTooltipRows,
+} from '../../utilities/tooltipUtils';
import { HIGHLIGHT_COLOR_ARRAY } from '../../utils';
+function defaultTooltipGenerator(o: any) {
+ return (
+ <div className="deckgl-tooltip">
+ {CommonTooltipRows.centroid(o)}
+ <TooltipRow
+ label={t('Threshold: ')}
+ value={`${o?.object?.contour?.threshold}`}
+ />
+ </div>
+ );
+}
+
function setTooltipContent(o: any) {
return (
<div className="deckgl-tooltip">
@@ -41,6 +57,7 @@ function setTooltipContent(o: any) {
</div>
);
}
+
export const getLayer: GetLayerType<ContourLayer> = function ({
formData,
payload,
@@ -59,6 +76,18 @@ export const getLayer: GetLayerType<ContourLayer> = function ({
} = fd;
let data = payload.data.features;
+ // Store original data for tooltip access
+ const originalDataMap = new Map();
+ data.forEach((d: any) => {
+ if (d.position) {
+ const key = `${Math.floor(d.position[0] * 1000)},${Math.floor(d.position[1] * 1000)}`;
+ if (!originalDataMap.has(key)) {
+ originalDataMap.set(key, []);
+ }
+ originalDataMap.get(key)?.push(d.originalData || d);
+ }
+ });
+
const contours = rawContours?.map(
(contour: {
color: ColorType;
@@ -89,6 +118,47 @@ export const getLayer: GetLayerType<ContourLayer> = function ({
data = jsFnMutatorFunction(data);
}
+ // Create wrapper for tooltip content that adds nearby points
+ const tooltipContentGenerator = (o: any) => {
+ // Find nearby points based on hover coordinate
+ const nearbyPoints: any[] = [];
+ if (o.coordinate) {
+ const searchKey = `${Math.floor(o.coordinate[0] * 1000)},${Math.floor(o.coordinate[1] * 1000)}`;
+ const points = originalDataMap.get(searchKey) || [];
+ nearbyPoints.push(...points);
+
+ // Also check neighboring cells for better coverage
+ for (let dx = -1; dx <= 1; dx += 1) {
+ for (let dy = -1; dy <= 1; dy += 1) {
+ if (dx !== 0 || dy !== 0) {
+ const neighborKey = `${Math.floor(o.coordinate[0] * 1000) + dx},${Math.floor(o.coordinate[1] * 1000) + dy}`;
+ const neighborPoints = originalDataMap.get(neighborKey) || [];
+ nearbyPoints.push(...neighborPoints);
+ }
+ }
+ }
+
+ // Enhance the object with nearby points data
+ if (nearbyPoints.length > 0) {
+ const enhancedObject = {
+ ...o.object,
+ nearbyPoints: nearbyPoints.slice(0, 5), // Limit to first 5 points
+ totalPoints: nearbyPoints.length,
+ // Add first point's data at top level for easy access
+ ...nearbyPoints[0],
+ };
+ Object.assign(o, { object: enhancedObject });
+ }
+ }
+
+ // Use createTooltipContent with the enhanced object
+ const baseTooltipContent = createTooltipContent(
+ fd,
+ defaultTooltipGenerator,
+ );
+ return baseTooltipContent(o);
+ };
+
return new ContourLayer({
id: `contourLayer-${fd.slice_id}`,
data,
@@ -101,7 +171,7 @@ export const getLayer: GetLayerType<ContourLayer> = function ({
...commonLayerProps({
formData: fd,
setTooltip,
- setTooltipContent,
+ setTooltipContent: tooltipContentGenerator,
onContextMenu,
setDataMask,
filterState,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/controlPanel.ts
index a154e18796..e920f07ed7 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Contour/controlPanel.ts
@@ -31,6 +31,8 @@ import {
mapboxStyle,
spatial,
viewport,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
const config: ControlPanelConfig = {
@@ -44,6 +46,8 @@ const config: ControlPanelConfig = {
['size'],
[filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Geojson/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Geojson/controlPanel.ts
index 079c352480..568659e874 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Geojson/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Geojson/controlPanel.ts
@@ -34,6 +34,8 @@ import {
mapboxStyle,
autozoom,
lineWidth,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
import { dndGeojsonColumn } from '../../utilities/sharedDndControls';
@@ -47,6 +49,8 @@ const config: ControlPanelConfig = {
['row_limit'],
[filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/Grid.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/Grid.tsx
index 7395fa1c10..da1367a189 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/Grid.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/Grid.tsx
@@ -17,7 +17,11 @@
* under the License.
*/
import { GridLayer } from '@deck.gl/aggregation-layers';
-import { t, CategoricalColorNamespace, JsonObject } from '@superset-ui/core';
+import {
+ CategoricalColorNamespace,
+ JsonObject,
+ QueryFormData,
+} from '@superset-ui/core';
import {
commonLayerProps,
@@ -29,20 +33,21 @@ import sandboxedEval from '../../utils/sandbox';
import { createDeckGLComponent, GetLayerType } from '../../factory';
import TooltipRow from '../../TooltipRow';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
+import {
+ createTooltipContent,
+ CommonTooltipRows,
+} from '../../utilities/tooltipUtils';
import { HIGHLIGHT_COLOR_ARRAY, TRANSPARENT_COLOR_ARRAY } from '../../utils';
-function setTooltipContent(o: JsonObject) {
+function defaultTooltipGenerator(o: JsonObject, formData: QueryFormData) {
+ const metricLabel = formData.size?.label || formData.size?.value || 'Height';
+
return (
<div className="deckgl-tooltip">
+ {CommonTooltipRows.centroid(o)}
<TooltipRow
- // eslint-disable-next-line prefer-template
- label={t('Longitude and Latitude') + ': '}
- value={`${o.coordinate[0]}, ${o.coordinate[1]}`}
- />
- <TooltipRow
- // eslint-disable-next-line prefer-template
- label={t('Height') + ': '}
- value={`${o.object.elevationValue}`}
+ label={`${metricLabel}: `}
+ value={`${o.object?.elevationValue || o.object?.value || 'N/A'}`}
/>
</div>
);
@@ -63,7 +68,6 @@ export const getLayer: GetLayerType<GridLayer> = function ({
let data = payload.data.features;
if (fd.js_data_mutator) {
- // Applying user defined data mutator if defined
const jsFnMutator = sandboxedEval(fd.js_data_mutator);
data = jsFnMutator(data);
}
@@ -81,6 +85,10 @@ export const getLayer: GetLayerType<GridLayer> = function ({
const aggFunc = getAggFunc(fd.js_agg_function, p => p.weight);
+ const tooltipContent = createTooltipContent(fd, (o: JsonObject) =>
+ defaultTooltipGenerator(o, fd),
+ );
+
const colorAggFunc =
colorSchemeType === COLOR_SCHEME_TYPES.color_breakpoints
? (p: number[]) => getColorForBreakpoints(aggFunc, p, colorBreakpoints)
@@ -105,7 +113,7 @@ export const getLayer: GetLayerType<GridLayer> = function ({
formData: fd,
setDataMask,
setTooltip,
- setTooltipContent,
+ setTooltipContent: tooltipContent,
filterState,
onContextMenu,
emitCrossFilters,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/controlPanel.ts
index 02e0bc4341..fef74f6fe6 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Grid/controlPanel.ts
@@ -33,6 +33,8 @@ import {
viewport,
spatial,
mapboxStyle,
+ tooltipContents,
+ tooltipTemplate,
legendPosition,
generateDeckGLColorSchemeControls,
} from '../../utilities/Shared_DeckGL';
@@ -49,6 +51,8 @@ const config: ControlPanelConfig = {
['row_limit'],
[filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/Heatmap.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/Heatmap.tsx
index 22d21d364d..68bdfac85d 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/Heatmap.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/Heatmap.tsx
@@ -18,31 +18,91 @@
*/
import { HeatmapLayer } from '@deck.gl/aggregation-layers';
import { Position } from '@deck.gl/core';
-import { t, getSequentialSchemeRegistry, JsonObject } from '@superset-ui/core';
+import {
+ t,
+ getSequentialSchemeRegistry,
+ JsonObject,
+ QueryFormData,
+} from '@superset-ui/core';
import { isPointInBonds } from '../../utilities/utils';
import { commonLayerProps, getColorRange } from '../common';
import sandboxedEval from '../../utils/sandbox';
import { GetLayerType, createDeckGLComponent } from '../../factory';
import TooltipRow from '../../TooltipRow';
+import { createTooltipContent } from '../../utilities/tooltipUtils';
import { HIGHLIGHT_COLOR_ARRAY } from '../../utils';
-function setTooltipContent(o: JsonObject) {
- return (
- <div className="deckgl-tooltip">
- <TooltipRow
- label={t('Centroid (Longitude and Latitude): ')}
- value={`(${o?.coordinate[0]}, ${o?.coordinate[1]})`}
- />
- </div>
- );
+function setTooltipContent(formData: QueryFormData) {
+ const defaultTooltipGenerator = (o: JsonObject) => {
+ const metricLabel =
+ formData.size?.label || formData.size?.value || 'Weight';
+ const lon = o.coordinate?.[0];
+ const lat = o.coordinate?.[1];
+
+ const hasCustomTooltip =
+ formData.tooltip_template ||
+ (formData.tooltip_contents && formData.tooltip_contents.length > 0);
+ const hasObjectData = o.object && Object.keys(o.object).length > 0;
+
+ return (
+ <div className="deckgl-tooltip">
+ <TooltipRow
+ label={`${t('Longitude and Latitude')}: `}
+ value={`${lon?.toFixed(6)}, ${lat?.toFixed(6)}`}
+ />
+ <TooltipRow label="LON: " value={lon?.toFixed(6)} />
+ <TooltipRow label="LAT: " value={lat?.toFixed(6)} />
+ <TooltipRow
+ label={`${metricLabel}: `}
+ value={`${o.object?.weight || o.object?.value || 'Aggregated Cell'}`}
+ />
+ {hasCustomTooltip && !hasObjectData && (
+ <TooltipRow
+ label={`${t('Note')}: `}
+ value={t('Custom fields not available in aggregated heatmap cells')}
+ />
+ )}
+ </div>
+ );
+ };
+
+ return (o: JsonObject) => {
+ // Try to find the closest data point to the hovered coordinate
+ let closestPoint = null;
+ if (o.coordinate && o.layer?.props?.data) {
+ const [hoveredLon, hoveredLat] = o.coordinate;
+ let minDistance = Infinity;
+
+ for (const point of o.layer.props.data) {
+ if (point.position) {
+ const [pointLon, pointLat] = point.position;
+ const distance = Math.sqrt(
+ Math.pow(hoveredLon - pointLon, 2) +
+ Math.pow(hoveredLat - pointLat, 2),
+ );
+ if (distance < minDistance) {
+ minDistance = distance;
+ closestPoint = point;
+ }
+ }
+ }
+ }
+ const modifiedO = {
+ ...o,
+ object: closestPoint || o.object,
+ };
+
+ return createTooltipContent(formData, defaultTooltipGenerator)(modifiedO);
+ };
}
+
export const getLayer: GetLayerType<HeatmapLayer> = ({
formData,
+ payload,
+ setTooltip,
+ setDataMask,
onContextMenu,
filterState,
- setDataMask,
- setTooltip,
- payload,
emitCrossFilters,
}) => {
const fd = formData;
@@ -56,7 +116,6 @@ export const getLayer: GetLayerType<HeatmapLayer> = ({
let data = payload.data.features;
if (jsFnMutator) {
- // Applying user defined data mutator if defined
const jsFnMutatorFunction = sandboxedEval(fd.js_data_mutator);
data = jsFnMutatorFunction(data);
}
@@ -74,6 +133,8 @@ export const getLayer: GetLayerType<HeatmapLayer> = ({
colorScale,
})?.reverse();
+ const tooltipContent = setTooltipContent(fd);
+
return new HeatmapLayer({
id: `heatmap-layer-${fd.slice_id}` as const,
data,
@@ -84,10 +145,12 @@ export const getLayer: GetLayerType<HeatmapLayer> = ({
getPosition: (d: { position: Position; weight: number }) => d.position,
getWeight: (d: { position: number[]; weight: number }) =>
d.weight ? d.weight : 1,
+ opacity: 0.8,
+ threshold: 0.03,
...commonLayerProps({
formData: fd,
setTooltip,
- setTooltipContent,
+ setTooltipContent: tooltipContent,
setDataMask,
filterState,
onContextMenu,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/controlPanel.ts
index 05a337d3a8..fa30977f7e 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Heatmap/controlPanel.ts
@@ -39,6 +39,8 @@ import {
mapboxStyle,
spatial,
viewport,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
@@ -62,6 +64,8 @@ const config: ControlPanelConfig = {
['row_limit'],
[filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
[
{
name: 'intensity',
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/Hex.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/Hex.tsx
index 216d22bb2d..9377ee75b1 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/Hex.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/Hex.tsx
@@ -17,7 +17,11 @@
* under the License.
*/
import { HexagonLayer } from '@deck.gl/aggregation-layers';
-import { t, CategoricalColorNamespace, JsonObject } from '@superset-ui/core';
+import {
+ CategoricalColorNamespace,
+ JsonObject,
+ QueryFormData,
+} from '@superset-ui/core';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
import {
@@ -28,20 +32,22 @@ import {
} from '../common';
import sandboxedEval from '../../utils/sandbox';
import { GetLayerType, createDeckGLComponent } from '../../factory';
+import {
+ createTooltipContent,
+ CommonTooltipRows,
+} from '../../utilities/tooltipUtils';
import TooltipRow from '../../TooltipRow';
import { HIGHLIGHT_COLOR_ARRAY, TRANSPARENT_COLOR_ARRAY } from '../../utils';
-function setTooltipContent(o: JsonObject) {
+function defaultTooltipGenerator(o: JsonObject, formData: QueryFormData) {
+ const metricLabel = formData.size?.label || formData.size?.value || 'Height';
+
return (
<div className="deckgl-tooltip">
+ {CommonTooltipRows.centroid(o)}
<TooltipRow
- label={t('Centroid (Longitude and Latitude): ')}
- value={`(${o.coordinate[0]}, ${o.coordinate[1]})`}
- />
- <TooltipRow
- // eslint-disable-next-line prefer-template
- label={t('Height') + ': '}
- value={`${o.object.elevationValue}`}
+ label={`${metricLabel}: `}
+ value={`${o.object?.elevationValue}`}
/>
</div>
);
@@ -85,6 +91,10 @@ export const getLayer: GetLayerType<HexagonLayer> = function ({
? (p: number[]) => getColorForBreakpoints(aggFunc, p, colorBreakpoints)
: aggFunc;
+ const tooltipContent = createTooltipContent(fd, (o: JsonObject) =>
+ defaultTooltipGenerator(o, fd),
+ );
+
return new HexagonLayer({
id: `hex-layer-${fd.slice_id}-${JSON.stringify(colorBreakpoints)}` as const,
data,
@@ -103,7 +113,7 @@ export const getLayer: GetLayerType<HexagonLayer> = function ({
...commonLayerProps({
formData: fd,
setTooltip,
- setTooltipContent,
+ setTooltipContent: tooltipContent,
setDataMask,
filterState,
onContextMenu,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/controlPanel.ts
index ebf8f9f7fc..7779fa1c75 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Hex/controlPanel.ts
@@ -34,6 +34,8 @@ import {
mapboxStyle,
spatial,
viewport,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
@@ -48,6 +50,8 @@ const config: ControlPanelConfig = {
['row_limit'],
[filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/Path.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/Path.tsx
index 19bce632b5..7408676df7 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/Path.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/Path.tsx
@@ -18,28 +18,26 @@
* under the License.
*/
import { PathLayer } from '@deck.gl/layers';
-import { JsonObject } from '@superset-ui/core';
+import { JsonObject, QueryFormData } from '@superset-ui/core';
import { commonLayerProps } from '../common';
import sandboxedEval from '../../utils/sandbox';
import { GetLayerType, createDeckGLComponent } from '../../factory';
-import TooltipRow from '../../TooltipRow';
import { Point } from '../../types';
+import {
+ createTooltipContent,
+ CommonTooltipRows,
+} from '../../utilities/tooltipUtils';
import { HIGHLIGHT_COLOR_ARRAY } from '../../utils';
-function setTooltipContent(o: JsonObject) {
- return (
- o.object?.extraProps && (
- <div className="deckgl-tooltip">
- {Object.keys(o.object.extraProps).map((prop, index) => (
- <TooltipRow
- key={`prop-${index}`}
- label={`${prop}: `}
- value={`${o.object.extraProps[prop]}`}
- />
- ))}
- </div>
- )
+function setTooltipContent(formData: QueryFormData) {
+ const defaultTooltipGenerator = (o: JsonObject) => (
+ <div className="deckgl-tooltip">
+ {CommonTooltipRows.position(o)}
+ {CommonTooltipRows.category(o)}
+ </div>
);
+
+ return createTooltipContent(formData, defaultTooltipGenerator);
}
export const getLayer: GetLayerType<PathLayer> = function ({
@@ -78,7 +76,7 @@ export const getLayer: GetLayerType<PathLayer> = function ({
...commonLayerProps({
formData: fd,
setTooltip,
- setTooltipContent,
+ setTooltipContent: setTooltipContent(fd),
setDataMask,
filterState,
onContextMenu,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/controlPanel.ts
index b3488d4ec7..658e7c014a 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Path/controlPanel.ts
@@ -30,6 +30,8 @@ import {
lineType,
reverseLongLat,
mapboxStyle,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
import { dndLineColumn } from '../../utilities/sharedDndControls';
@@ -55,6 +57,8 @@ const config: ControlPanelConfig = {
['row_limit'],
[filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/Polygon.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/Polygon.tsx
index 48d1bc8fd5..912b531b40 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/Polygon.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/Polygon.tsx
@@ -57,6 +57,10 @@ import { TooltipProps } from '../../components/Tooltip';
import { GetLayerType } from '../../factory';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
import { DEFAULT_DECKGL_COLOR } from '../../utilities/Shared_DeckGL';
+import {
+ createTooltipContent,
+ CommonTooltipRows,
+} from '../../utilities/tooltipUtils';
import { Point } from '../../types';
function getElevation(
@@ -71,34 +75,32 @@ function getElevation(
return colorScaler(d)[3] === 0 ? 0 : d.elevation;
}
-function setTooltipContent(formData: PolygonFormData) {
- return (o: JsonObject) => {
- const metricLabel = formData?.metric?.label || formData?.metric;
-
- return (
- <div className="deckgl-tooltip">
- {o.object?.name && (
- <TooltipRow
- // eslint-disable-next-line prefer-template
- label={t('name') + ': '}
- value={`${o.object.name}`}
- />
- )}
- {o.object?.[formData?.line_column] && (
- <TooltipRow
- label={`${formData.line_column}: `}
- value={`${o.object[formData.line_column]}`}
- />
- )}
- {formData?.metric && (
- <TooltipRow
- label={`${metricLabel}: `}
- value={`${o.object?.[metricLabel]}`}
- />
- )}
- </div>
- );
- };
+function defaultTooltipGenerator(
+ o: JsonObject,
+ fd: PolygonFormData,
+ metricLabel: string,
+) {
+ return (
+ <div className="deckgl-tooltip">
+ {o.object?.name && (
+ <TooltipRow label={`${t('name')}: `} value={`${o.object.name}`} />
+ )}
+ {o.object?.[fd?.line_column] && (
+ <TooltipRow
+ label={`${fd.line_column}: `}
+ value={`${o.object[fd.line_column]}`}
+ />
+ )}
+ {CommonTooltipRows.centroid(o)}
+ {CommonTooltipRows.category(o)}
+ {fd?.metric && (
+ <TooltipRow
+ label={`${metricLabel}: `}
+ value={`${o.object?.[metricLabel]}`}
+ />
+ )}
+ </div>
+ );
}
export const getLayer: GetLayerType<PolygonLayer> = function ({
@@ -198,12 +200,9 @@ export const getLayer: GetLayerType<PolygonLayer> = function ({
return baseColor;
};
- const tooltipContentGenerator =
- fd.line_column &&
- fd.metric &&
- ['json', 'geohash', 'zipcode'].includes(fd.line_type)
- ? setTooltipContent(fd)
- : () => null;
+ const tooltipContentGenerator = createTooltipContent(fd, (o: JsonObject) =>
+ defaultTooltipGenerator(o, fd, metricLabel),
+ );
return new PolygonLayer({
id: `path-layer-${fd.slice_id}` as const,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/controlPanel.ts
index ba0cf4397b..9aec653e05 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Polygon/controlPanel.ts
@@ -48,6 +48,8 @@ import {
deckGLLinearColorSchemeSelect,
deckGLColorBreakpointsSelect,
breakpointsDefaultColor,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
import { dndLineColumn } from '../../utilities/sharedDndControls';
@@ -89,6 +91,8 @@ const config: ControlPanelConfig = {
['row_limit'],
[reverseLongLat],
[filterNulls],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/Scatter.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/Scatter.tsx
index 18b9f308b3..3ecd3eac0c 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/Scatter.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/Scatter.tsx
@@ -17,42 +17,45 @@
* under the License.
*/
import { ScatterplotLayer } from '@deck.gl/layers';
-import {
- getMetricLabel,
- JsonObject,
- QueryFormData,
- t,
-} from '@superset-ui/core';
+import { JsonObject, QueryFormData, t } from '@superset-ui/core';
import { isPointInBonds } from '../../utilities/utils';
import { commonLayerProps } from '../common';
import { createCategoricalDeckGLComponent, GetLayerType } from '../../factory';
+import { createTooltipContent } from '../../utilities/tooltipUtils';
import TooltipRow from '../../TooltipRow';
import { unitToRadius } from '../../utils/geo';
import { HIGHLIGHT_COLOR_ARRAY } from '../../utils';
-export function getPoints(data: JsonObject[]) {
- return data.map(d => d.position);
+function getMetricLabel(metric: any) {
+ if (typeof metric === 'string') {
+ return metric;
+ }
+ if (metric?.label) {
+ return metric.label;
+ }
+ if (metric?.verbose_name) {
+ return metric.verbose_name;
+ }
+ return metric?.value || 'Metric';
}
function setTooltipContent(
formData: QueryFormData,
verboseMap?: Record<string, string>,
) {
- return (o: JsonObject) => {
+ const defaultTooltipGenerator = (o: JsonObject) => {
const label =
verboseMap?.[formData.point_radius_fixed.value] ||
getMetricLabel(formData.point_radius_fixed?.value);
return (
<div className="deckgl-tooltip">
<TooltipRow
- // eslint-disable-next-line prefer-template
- label={t('Longitude and Latitude') + ': '}
+ label={`${t('Longitude and Latitude')}: `}
value={`${o.object?.position?.[0]}, ${o.object?.position?.[1]}`}
/>
{o.object?.cat_color && (
<TooltipRow
- // eslint-disable-next-line prefer-template
- label={t('Category') + ': '}
+ label={`${t('Category')}: `}
value={`${o.object?.cat_color}`}
/>
)}
@@ -62,6 +65,19 @@ function setTooltipContent(
</div>
);
};
+
+ return createTooltipContent(formData, defaultTooltipGenerator);
+}
+
+interface ScatterDataItem {
+ color: number[];
+ radius: number;
+ position: number[];
+ [key: string]: unknown;
+}
+
+export function getPoints(data: JsonObject[]) {
+ return data.map(d => d.position);
}
export const getLayer: GetLayerType<ScatterplotLayer> = function ({
@@ -93,8 +109,9 @@ export const getLayer: GetLayerType<ScatterplotLayer> = function ({
id: `scatter-layer-${fd.slice_id}` as const,
data: dataWithRadius,
fp64: true,
- getFillColor: (d: any) => d.color,
- getRadius: (d: any) => d.radius,
+ getFillColor: (d: ScatterDataItem): [number, number, number, number] =>
+ d.color as [number, number, number, number],
+ getRadius: (d: ScatterDataItem): number => d.radius,
radiusMinPixels: Number(fd.min_radius) || undefined,
radiusMaxPixels: Number(fd.max_radius) || undefined,
stroked: false,
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/controlPanel.ts
index 997b65b3ea..9545dcd1be 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Scatter/controlPanel.ts
@@ -34,6 +34,8 @@ import {
multiplier,
mapboxStyle,
generateDeckGLColorSchemeControls,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
@@ -57,6 +59,8 @@ const config: ControlPanelConfig = {
[spatial, null],
['row_limit', filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/Screengrid.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/Screengrid.tsx
index 8abddb1dab..9ea46cd453 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/Screengrid.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/Screengrid.tsx
@@ -1,5 +1,3 @@
-/* eslint-disable react/sort-prop-types */
-/* eslint-disable react/jsx-handler-names */
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@@ -20,8 +18,14 @@
*/
import { ScreenGridLayer } from '@deck.gl/aggregation-layers';
-import { CategoricalColorNamespace, JsonObject, t } from '@superset-ui/core';
import { Color } from '@deck.gl/core';
+import {
+ JsonObject,
+ QueryFormData,
+ styled,
+ CategoricalColorNamespace,
+ t,
+} from '@superset-ui/core';
import {
COLOR_SCHEME_TYPES,
ColorSchemeType,
@@ -32,14 +36,29 @@ import { commonLayerProps, getColorRange } from '../common';
import TooltipRow from '../../TooltipRow';
import { GetLayerType, createDeckGLComponent } from '../../factory';
import { HIGHLIGHT_COLOR_ARRAY, TRANSPARENT_COLOR_ARRAY } from '../../utils';
+import {
+ createTooltipContent,
+ CommonTooltipRows,
+} from '../../utilities/tooltipUtils';
+
+const MoreRecordsIndicator = styled.div`
+ margin-top: ${({ theme }) => theme.sizeUnit}px;
+ font-size: ${({ theme }) => theme.fontSizeSM}px;
+ color: ${({ theme }) => theme.colorTextSecondary};
+`;
export function getPoints(data: JsonObject[]) {
return data.map(d => d.position);
}
-function setTooltipContent(o: JsonObject) {
+function defaultTooltipGenerator(o: JsonObject, formData: QueryFormData) {
+ const metricLabel = formData.size?.label || formData.size?.value || 'Weight';
+ const points = o.points || [];
+ const pointCount = points.length || 0;
+
return (
<div className="deckgl-tooltip">
+ {CommonTooltipRows.centroid(o)}
<TooltipRow
// eslint-disable-next-line prefer-template
label={t('Longitude and Latitude') + ': '}
@@ -50,6 +69,35 @@ function setTooltipContent(o: JsonObject) {
label={t('Weight') + ': '}
value={`${o.object?.value}`}
/>
+ <TooltipRow
+ label={`${metricLabel}: `}
+ value={`${o.object?.cellWeight}`}
+ />
+ <TooltipRow label="Points: " value={`${pointCount} records`} />
+ {points.length > 0 && points.length <= 3 && (
+ <div style={{ marginTop: 8, fontSize: '12px' }}>
+ <strong>Records:</strong>
+ {points.slice(0, 3).map((point: JsonObject, index: number) => (
+ <div key={index} style={{ marginTop: 4, paddingLeft: '8px' }}>
+ {Object.entries(point).map(([key, value]) =>
+ key !== 'position' &&
+ key !== 'weight' &&
+ key !== '__timestamp' &&
+ key !== 'points' ? (
+ <span key={key} style={{ marginRight: '8px' }}>
+ <strong>{key}:</strong> {String(value)}
+ </span>
+ ) : null,
+ )}
+ </div>
+ ))}
+ </div>
+ )}
+ {points.length > 3 && (
+ <MoreRecordsIndicator>
+ ... and {points.length - 3} more records
+ </MoreRecordsIndicator>
+ )}
</div>
);
}
@@ -69,7 +117,6 @@ export const getLayer: GetLayerType<ScreenGridLayer> = function ({
let data = payload.data.features;
if (fd.js_data_mutator) {
- // Applying user defined data mutator if defined
const jsFnMutator = sandboxedEval(fd.js_data_mutator);
data = jsFnMutator(data);
}
@@ -94,8 +141,54 @@ export const getLayer: GetLayerType<ScreenGridLayer> = function ({
[189, 0, 38],
] as Color[];
- // Passing a layer creator function instead of a layer since the
- // layer needs to be regenerated at each render
+ const cellSize = fd.grid_size || 50;
+ const cellToPointsMap = new Map();
+
+ data.forEach((point: JsonObject) => {
+ const { position } = point;
+ if (position) {
+ const cellX = Math.floor(position[0] / (cellSize * 0.01));
+ const cellY = Math.floor(position[1] / (cellSize * 0.01));
+ const cellKey = `${cellX},${cellY}`;
+
+ if (!cellToPointsMap.has(cellKey)) {
+ cellToPointsMap.set(cellKey, []);
+ }
+ cellToPointsMap.get(cellKey).push(point);
+ }
+ });
+
+ const tooltipContent = createTooltipContent(fd, (o: JsonObject) =>
+ defaultTooltipGenerator(o, fd),
+ );
+
+ const customOnHover = (info: JsonObject) => {
+ if (info.picked) {
+ const cellCenter = info.coordinate;
+ const cellX = Math.floor(cellCenter[0] / (cellSize * 0.01));
+ const cellY = Math.floor(cellCenter[1] / (cellSize * 0.01));
+ const cellKey = `${cellX},${cellY}`;
+
+ const pointsInCell = cellToPointsMap.get(cellKey) || [];
+ const enhancedInfo = {
+ ...info,
+ object: {
+ ...info.object,
+ points: pointsInCell,
+ },
+ };
+
+ setTooltip({
+ content: tooltipContent(enhancedInfo),
+ x: info.x,
+ y: info.y,
+ });
+ } else {
+ setTooltip(null);
+ }
+ return true;
+ };
+
return new ScreenGridLayer({
id: `screengrid-layer-${fd.slice_id}` as const,
data,
@@ -111,13 +204,15 @@ export const getLayer: GetLayerType<ScreenGridLayer> = function ({
formData: fd,
setDataMask,
setTooltip,
- setTooltipContent,
+ setTooltipContent: tooltipContent,
filterState,
onContextMenu,
emitCrossFilters,
}),
getWeight: aggFunc,
colorScaleType: colorSchemeType === 'default' ? 'linear' : 'quantize',
+ onHover: customOnHover,
+ pickable: true,
opacity: filterState?.value ? 0.3 : 1,
});
};
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/controlPanel.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/controlPanel.ts
index c7a637f55a..32cc050305 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/controlPanel.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/Screengrid/controlPanel.ts
@@ -36,6 +36,8 @@ import {
deckGLFixedColor,
deckGLCategoricalColorSchemeSelect,
deckGLCategoricalColorSchemeTypeSelect,
+ tooltipContents,
+ tooltipTemplate,
} from '../../utilities/Shared_DeckGL';
import { COLOR_SCHEME_TYPES } from '../../utilities/utils';
@@ -50,6 +52,8 @@ const config: ControlPanelConfig = {
['row_limit'],
[filterNulls],
['adhoc_filters'],
+ [tooltipContents],
+ [tooltipTemplate],
],
},
{
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/common.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/common.tsx
index 7ae3932f77..10064b64b1 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/common.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/layers/common.tsx
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-import { ReactNode } from 'react';
+import { ReactNode, isValidElement } from 'react';
import {
ascending as d3ascending,
quantile as d3quantile,
@@ -73,15 +73,29 @@ export function commonLayerProps({
tooltipContentGenerator = sandboxedEval(fd.js_tooltip);
}
if (tooltipContentGenerator) {
+ let currentTooltipContent: ReactNode = null;
+
+ const isCustomTooltip = (content: ReactNode): boolean =>
+ isValidElement(content) &&
+ content.props?.['data-tooltip-type'] === 'custom';
+
onHover = (o: JsonObject) => {
if (o.picked) {
+ currentTooltipContent = tooltipContentGenerator(o);
+ }
+
+ if (
+ currentTooltipContent &&
+ (o.picked || isCustomTooltip(currentTooltipContent))
+ ) {
setTooltip({
- content: tooltipContentGenerator(o),
+ content: currentTooltipContent,
x: o.x,
y: o.y,
});
} else {
setTooltip(null);
+ currentTooltipContent = null;
}
return true;
};
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/HandlebarsRenderer.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/HandlebarsRenderer.tsx
new file mode 100644
index 0000000000..1965eae717
--- /dev/null
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/HandlebarsRenderer.tsx
@@ -0,0 +1,231 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { useEffect, useState, memo } from 'react';
+import { styled, t } from '@superset-ui/core';
+import { SafeMarkdown } from '@superset-ui/core/components';
+import Handlebars from 'handlebars';
+import dayjs from 'dayjs';
+import { isPlainObject } from 'lodash';
+
+export interface HandlebarsRendererProps {
+ templateSource: string;
+ data: any;
+}
+
+const ErrorContainer = styled.pre`
+ white-space: pre-wrap;
+ color: ${({ theme }) => theme.colorError};
+ background-color: ${({ theme }) => theme.colorErrorBg};
+ padding: ${({ theme }) => theme.sizeUnit * 2}px;
+ border-radius: ${({ theme }) => theme.borderRadius}px;
+`;
+
+export const HandlebarsRenderer: React.FC<HandlebarsRendererProps> = memo(
+ ({ templateSource, data }) => {
+ const [renderedTemplate, setRenderedTemplate] = useState('');
+ const [error, setError] = useState('');
+ const appContainer = document.getElementById('app');
+ const { common } = JSON.parse(
+ appContainer?.getAttribute('data-bootstrap') || '{}',
+ );
+ const htmlSanitization = common?.conf?.HTML_SANITIZATION ?? true;
+ const htmlSchemaOverrides =
+ common?.conf?.HTML_SANITIZATION_SCHEMA_EXTENSIONS || {};
+
+ useEffect(() => {
+ try {
+ const template = Handlebars.compile(templateSource);
+ const result = template(data);
+ setRenderedTemplate(result);
+ setError('');
+ } catch (error) {
+ setRenderedTemplate('');
+ setError(error.message || 'Unknown template error');
+ }
+ }, [templateSource, data]);
+
+ if (error) {
+ return <ErrorContainer>{error}</ErrorContainer>;
+ }
+
+ if (renderedTemplate || renderedTemplate === '') {
+ return (
+ <div
+ style={{
+ maxWidth: '300px',
+ wordWrap: 'break-word',
+ fontSize: '12px',
+ lineHeight: '1.4',
+ }}
+ >
+ <SafeMarkdown
+ source={renderedTemplate || ''}
+ htmlSanitization={htmlSanitization}
+ htmlSchemaOverrides={htmlSchemaOverrides}
+ />
+ </div>
+ );
+ }
+
+ return <p>{t('Loading...')}</p>;
+ },
+);
+
+Handlebars.registerHelper('dateFormat', function (context, options) {
+ const format = options.hash.format || 'YYYY-MM-DD HH:mm:ss';
+ if (!context) return '';
+
+ try {
+ if (typeof context === 'number') {
+ const timestamp = context > 1000000000000 ? context : context * 1000;
+ return dayjs(timestamp).format(format);
+ }
+ return dayjs(context).format(format);
+ } catch (e) {
+ return String(context);
+ }
+});
+
+Handlebars.registerHelper('formatNumber', function (number, options) {
+ if (typeof number !== 'number') {
+ return number;
+ }
+
+ const locale = options.hash.locale || 'en-US';
+ const { minimumFractionDigits } = options.hash;
+ const { maximumFractionDigits } = options.hash;
+
+ const formatOptions: Intl.NumberFormatOptions = {};
+ if (minimumFractionDigits !== undefined) {
+ formatOptions.minimumFractionDigits = minimumFractionDigits;
+ }
+ if (maximumFractionDigits !== undefined) {
+ formatOptions.maximumFractionDigits = maximumFractionDigits;
+ }
+
+ return number.toLocaleString(locale, formatOptions);
+});
+
+Handlebars.registerHelper('stringify', function (obj) {
+ if (obj === undefined || obj === null) {
+ return '';
+ }
+
+ if (isPlainObject(obj)) {
+ try {
+ return JSON.stringify(obj, null, 2);
+ } catch (e) {
+ return String(obj);
+ }
+ }
+
+ return String(obj);
+});
+
+Handlebars.registerHelper(
+ 'ifExists',
+ function (this: any, value: any, options: any) {
+ if (value !== null && value !== undefined && value !== '') {
+ return options.fn(this);
+ }
+ return options.inverse(this);
+ },
+);
+
+Handlebars.registerHelper('default', function (value, fallback) {
+ return value !== null && value !== undefined && value !== ''
+ ? value
+ : fallback;
+});
+
+Handlebars.registerHelper('truncate', function (text, length) {
+ if (typeof text !== 'string') {
+ return text;
+ }
+
+ if (text.length <= length) {
+ return text;
+ }
+
+ return `${text.substring(0, length)}...`;
+});
+
+Handlebars.registerHelper('formatCoordinate', function (longitude, latitude) {
+ if (
+ longitude === null ||
+ longitude === undefined ||
+ latitude === null ||
+ latitude === undefined
+ ) {
+ return '';
+ }
+
+ const lng = typeof longitude === 'number' ? longitude.toFixed(6) : longitude;
+ const lat = typeof latitude === 'number' ? latitude.toFixed(6) : latitude;
+
+ return `${lng}, ${lat}`;
+});
+
+Handlebars.registerHelper('first', function (array) {
+ if (Array.isArray(array) && array.length > 0) {
+ return array[0];
+ }
+ return null;
+});
+
+Handlebars.registerHelper('getField', function (array, fieldName) {
+ if (!Array.isArray(array) || array.length === 0) {
+ return '';
+ }
+
+ const values = array
+ .map(item => item[fieldName])
+ .filter(
+ (value, index, self) =>
+ value !== undefined && value !== null && self.indexOf(value) === index,
+ );
+
+ if (values.length === 0) return '';
+ if (values.length === 1) return values[0];
+ return values.slice(0, 3).join(', ') + (values.length > 3 ? '...' : '');
+});
+
+Handlebars.registerHelper('limit', function (value, limit) {
+ if (!value) return '';
+
+ // Handle arrays
+ if (Array.isArray(value)) {
+ const limitedArray = value.slice(0, limit);
+ return limitedArray.join(', ') + (value.length > limit ? '...' : '');
+ }
+
+ // Handle strings (comma-separated values)
+ if (typeof value === 'string') {
+ const items = value.split(',').map(item => item.trim());
+ if (items.length <= limit) return value;
+
+ const limitedItems = items.slice(0, limit);
+ return `${limitedItems.join(', ')}...`;
+ }
+
+ // For other types, return as-is
+ return value;
+});
+
+export default HandlebarsRenderer;
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/Shared_DeckGL.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/Shared_DeckGL.tsx
index e8b57f9f16..be9359a616 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/Shared_DeckGL.tsx
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/Shared_DeckGL.tsx
@@ -17,8 +17,6 @@
* under the License.
*/
-// These are control configurations that are shared ONLY within the DeckGL viz plugin repo.
-
import {
FeatureFlag,
isFeatureEnabled,
@@ -42,6 +40,7 @@ import {
ColorSchemeType,
isColorSchemeTypeVisible,
} from './utils';
+import { TooltipTemplateControl } from './TooltipTemplateControl';
const categoricalSchemeRegistry = getCategoricalSchemeRegistry();
const sequentialSchemeRegistry = getSequentialSchemeRegistry();
@@ -344,9 +343,7 @@ export const viewport = {
label: t('Viewport'),
renderTrigger: false,
description: t('Parameters related to the view and perspective on the map'),
- // default is whole world mostly centered
default: DEFAULT_VIEWPORT,
- // Viewport changes shouldn't prompt user to re-run query
dontRefreshOnChange: true,
},
};
@@ -446,6 +443,78 @@ export const geojsonColumn = {
},
};
+const extractMetricsFromFormData = (formData: any) => {
+ const metrics = new Set<string>();
+
+ if (formData.metrics) {
+ (Array.isArray(formData.metrics)
+ ? formData.metrics
+ : [formData.metrics]
+ ).forEach((metric: any) => metrics.add(metric));
+ }
+
+ if (formData.point_radius_fixed?.value) {
+ metrics.add(formData.point_radius_fixed.value);
+ }
+
+ Object.entries(formData).forEach(([, value]) => {
+ if (!value || typeof value !== 'object') return;
+ if ((value as any).type === 'metric' && (value as any).value) {
+ metrics.add((value as any).value);
+ }
+ });
+
+ return Array.from(metrics).filter(metric => metric != null);
+};
+
+export const tooltipContents = {
+ name: 'tooltip_contents',
+ config: {
+ type: 'DndColumnMetricSelect',
+ label: t('Tooltip contents'),
+ multi: true,
+ freeForm: true,
+ clearable: true,
+ default: [],
+ description: t(
+ 'Drag columns and metrics here to customize tooltip content. Order matters - items will appear in the same order in tooltips. Click the button to manually select columns and metrics.',
+ ),
+ ghostButtonText: t('Drop columns/metrics here or click'),
+ disabledTabs: new Set(['saved', 'sqlExpression']),
+ mapStateToProps: (state: any) => {
+ const { datasource, form_data: formData } = state;
+
+ const selectedMetrics = formData
+ ? extractMetricsFromFormData(formData)
+ : [];
+
+ return {
+ columns: datasource?.columns || [],
+ savedMetrics: datasource?.metrics || [],
+ datasource,
+ selectedMetrics,
+ disabledTabs: new Set(['saved', 'sqlExpression']),
+ formData,
+ };
+ },
+ },
+};
+
+export const tooltipTemplate = {
+ name: 'tooltip_template',
+ config: {
+ type: TooltipTemplateControl,
+ label: t('Customize tooltips template'),
+ debounceDelay: 30,
+ default: '',
+ description: '',
+ placeholder: '',
+ mapStateToProps: (state: any, control: any) => ({
+ value: control.value,
+ }),
+ },
+};
+
export const deckGLCategoricalColorSchemeTypeSelect: CustomControlItem = {
name: 'color_scheme_type',
config: {
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/TooltipTemplateControl.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/TooltipTemplateControl.tsx
new file mode 100644
index 0000000000..163f078179
--- /dev/null
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/TooltipTemplateControl.tsx
@@ -0,0 +1,82 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { useCallback } from 'react';
+import { debounce } from 'lodash';
+import { t, useTheme } from '@superset-ui/core';
+import { InfoTooltip, Constants } from '@superset-ui/core/components';
+import { ControlHeader } from '@superset-ui/chart-controls';
+import { TooltipTemplateEditor } from './TooltipTemplateEditor';
+
+interface TooltipTemplateControlProps {
+ value: string;
+ onChange: (value: string) => void;
+ label?: string;
+ name: string;
+ height?: number;
+}
+
+const debounceFunc = debounce(
+ (func: (val: string) => void, source: string) => func(source),
+ Constants.SLOW_DEBOUNCE,
+);
+
+export function TooltipTemplateControl({
+ value,
+ onChange,
+ label,
+ name,
+}: TooltipTemplateControlProps) {
+ const theme = useTheme();
+
+ const handleTemplateChange = useCallback(
+ (newValue: string) => {
+ debounceFunc(onChange, newValue || '');
+ },
+ [onChange],
+ );
+
+ const tooltipContent = t(
+ 'Use Handlebars syntax to create custom tooltips. Available variables are based on your tooltip contents selection above.',
+ );
+
+ return (
+ <div>
+ <ControlHeader
+ name={name}
+ label={
+ <>
+ {label || t('Customize tooltips template')}
+ <InfoTooltip
+ iconStyle={{ marginLeft: theme.sizeUnit }}
+ tooltip={tooltipContent}
+ />
+ </>
+ }
+ />
+ <TooltipTemplateEditor
+ value={value}
+ onChange={handleTemplateChange}
+ name={name}
+ />
+ </div>
+ );
+}
+
+export default TooltipTemplateControl;
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/TooltipTemplateEditor.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/TooltipTemplateEditor.tsx
new file mode 100644
index 0000000000..f7a1a166f1
--- /dev/null
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/TooltipTemplateEditor.tsx
@@ -0,0 +1,76 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { useCallback, useEffect, useState } from 'react';
+import { styled, css, useThemeMode } from '@superset-ui/core';
+import { CodeEditor } from '@superset-ui/core/components';
+
+const EditorContainer = styled.div`
+ ${({ theme }) => css`
+ min-height: ${theme.sizeUnit * 50}px;
+ width: 100%;
+
+ .ace_editor {
+ font-family: ${theme.fontFamilyCode};
+ }
+ `}
+`;
+
+interface TooltipTemplateEditorProps {
+ value: string;
+ onChange: (value: string) => void;
+ name: string;
+}
+
+export function TooltipTemplateEditor({
+ value,
+ onChange,
+ name,
+}: TooltipTemplateEditorProps) {
+ const [localValue, setLocalValue] = useState(value);
+ const isDarkMode = useThemeMode();
+
+ useEffect(() => {
+ setLocalValue(value);
+ }, [value]);
+
+ const handleChange = useCallback(
+ (newValue: string) => {
+ setLocalValue(newValue);
+ onChange(newValue);
+ },
+ [onChange],
+ );
+
+ return (
+ <div>
+ <EditorContainer>
+ <CodeEditor
+ mode="handlebars"
+ theme={isDarkMode ? 'dark' : 'light'}
+ name={name}
+ height="200px"
+ width="100%"
+ value={localValue}
+ onChange={handleChange}
+ />
+ </EditorContainer>
+ </div>
+ );
+}
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/controlRegistry.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/controlRegistry.tsx
new file mode 100644
index 0000000000..0e20c62e94
--- /dev/null
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/controlRegistry.tsx
@@ -0,0 +1,57 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { ControlType } from '@superset-ui/chart-controls';
+import { TooltipTemplateControl } from './TooltipTemplateControl';
+
+/**
+ * Registry for custom control components used in DeckGL charts
+ */
+export const deckGLControlRegistry = {
+ TooltipTemplateControl,
+};
+
+/**
+ * Expand control type to include local DeckGL controls
+ */
+export function expandDeckGLControlType(controlType: ControlType) {
+ if (typeof controlType === 'string' && controlType in deckGLControlRegistry) {
+ return deckGLControlRegistry[
+ controlType as keyof typeof deckGLControlRegistry
+ ];
+ }
+ return controlType;
+}
+
+/**
+ * HOC to wrap control components with DeckGL-specific logic
+ */
+export function withDeckGLControls(Component: React.ComponentType<any>) {
+ return function DeckGLControlWrapper(props: any) {
+ const { type, ...otherProps } = props;
+ const ExpandedComponent = expandDeckGLControlType(type) || Component;
+ if (typeof ExpandedComponent === 'string') {
+ // If it's a string, it's a built-in control type, use the original Component
+ return <Component {...otherProps} />;
+ }
+ return <ExpandedComponent {...otherProps} />;
+ };
+}
+
+export default deckGLControlRegistry;
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/multiValueUtils.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/multiValueUtils.ts
new file mode 100644
index 0000000000..201c40ae38
--- /dev/null
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/multiValueUtils.ts
@@ -0,0 +1,142 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { QueryFormData } from '@superset-ui/core';
+
+interface TooltipItem {
+ item_type?: string;
+ column_name?: string;
+ metric_name?: string;
+ label?: string;
+ verbose_name?: string;
+}
+
+export const AGGREGATED_DECK_GL_CHART_TYPES = [
+ 'deck_screengrid',
+ 'deck_heatmap',
+ 'deck_contour',
+ 'deck_hex',
+ 'deck_grid',
+];
+
+export const NON_AGGREGATED_DECK_GL_CHART_TYPES = [
+ 'deck_scatter',
+ 'deck_arc',
+ 'deck_path',
+ 'deck_polygon',
+ 'deck_geojson',
+];
+
+export function isAggregatedDeckGLChart(vizType: string): boolean {
+ return AGGREGATED_DECK_GL_CHART_TYPES.includes(vizType);
+}
+
+export function fieldHasMultipleValues(
+ item: TooltipItem | string,
+ formData: QueryFormData,
+): boolean {
+ if (!isAggregatedDeckGLChart(formData.viz_type)) {
+ return false;
+ }
+
+ if (typeof item === 'object' && item?.item_type === 'metric') {
+ return false;
+ }
+
+ // TODO: Currently only screengrid supports multi-value fields. Support for other aggregated charts will be added in future releases
+ const supportsMultiValue = ['deck_screengrid'].includes(formData.viz_type);
+
+ if (!supportsMultiValue) {
+ return false;
+ }
+
+ if (typeof item === 'object' && item?.item_type === 'column') {
+ return true;
+ }
+
+ if (typeof item === 'string') {
+ return true;
+ }
+
+ return false;
+}
+
+const getFieldName = (item: TooltipItem | string): string | null => {
+ if (typeof item === 'string') return item;
+ if (item?.item_type === 'column') return item.column_name ?? null;
+ if (item?.item_type === 'metric')
+ return item.metric_name ?? item.label ?? null;
+ return null;
+};
+
+const getFieldLabel = (item: TooltipItem | string): string => {
+ if (typeof item === 'string') return item;
+ if (item?.item_type === 'column') {
+ return item.verbose_name || item.column_name || 'Column';
+ }
+ if (item?.item_type === 'metric') {
+ return item.verbose_name || item.metric_name || item.label || 'Metric';
+ }
+ return 'Field';
+};
+
+const createMultiValueTemplate = (
+ fieldName: string,
+ fieldLabel: string,
+): string => {
+ const pluralFieldName = `${fieldName}s`;
+ return `<div><strong>${fieldLabel}:</strong> {{#if ${pluralFieldName}}}{{limit ${pluralFieldName} 10}}{{#if ${fieldName}_count}} ({{${fieldName}_count}} total){{/if}}{{else}}N/A{{/if}}</div>`;
+};
+
+const createSingleValueTemplate = (
+ fieldName: string,
+ fieldLabel: string,
+): string =>
+ `<div><strong>${fieldLabel}:</strong> {{#if ${fieldName}}}{{${fieldName}}}{{else}}N/A{{/if}}</div>`;
+
+export function createDefaultTemplateWithLimits(
+ tooltipContents: (TooltipItem | string)[],
+ formData: QueryFormData,
+): string {
+ if (!tooltipContents?.length) {
+ return '';
+ }
+
+ const templateLines: string[] = [];
+
+ tooltipContents.forEach(item => {
+ const fieldName = getFieldName(item);
+ const fieldLabel = getFieldLabel(item);
+
+ if (!fieldName) return;
+
+ const hasMultipleValues = fieldHasMultipleValues(item, formData);
+
+ if (hasMultipleValues) {
+ templateLines.push(createMultiValueTemplate(fieldName, fieldLabel));
+ } else {
+ templateLines.push(createSingleValueTemplate(fieldName, fieldLabel));
+ }
+ });
+
+ return templateLines.join('\n');
+}
+
+export const MULTI_VALUE_WARNING_MESSAGE =
+ 'This metric or column contains many values, they may not be able to be all displayed in the tooltip';
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/tooltipUtils.tsx b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/tooltipUtils.tsx
new file mode 100644
index 0000000000..e2c1ffce23
--- /dev/null
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/tooltipUtils.tsx
@@ -0,0 +1,384 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { t, JsonObject, QueryFormData } from '@superset-ui/core';
+import { useMemo, memo } from 'react';
+import { HandlebarsRenderer } from './HandlebarsRenderer';
+import TooltipRow from '../TooltipRow';
+import { createDefaultTemplateWithLimits } from './multiValueUtils';
+
+const MemoizedHandlebarsRenderer = memo(HandlebarsRenderer);
+
+export const CommonTooltipRows = {
+ position: (o: JsonObject, position?: [number, number]) => (
+ <TooltipRow
+ label={`${t('Longitude and Latitude')}: `}
+ value={`${position?.[0] || o.object?.position?.[0]}, ${position?.[1] || o.object?.position?.[1]}`}
+ />
+ ),
+
+ arcPositions: (o: JsonObject) => (
+ <>
+ <TooltipRow
+ label={t('Start (Longitude, Latitude): ')}
+ value={`${o.object?.sourcePosition?.[0]}, ${o.object?.sourcePosition?.[1]}`}
+ />
+ <TooltipRow
+ label={t('End (Longitude, Latitude): ')}
+ value={`${o.object?.targetPosition?.[0]}, ${o.object?.targetPosition?.[1]}`}
+ />
+ </>
+ ),
+
+ centroid: (o: JsonObject) => (
+ <TooltipRow
+ label={t('Centroid (Longitude and Latitude): ')}
+ value={`(${o.coordinate?.[0]}, ${o.coordinate?.[1]})`}
+ />
+ ),
+
+ category: (o: JsonObject) =>
+ o.object?.cat_color ? (
+ <TooltipRow
+ label={`${t('Category')}: `}
+ value={`${o.object.cat_color}`}
+ />
+ ) : null,
+
+ metric: (
+ o: JsonObject,
+ formData: QueryFormData,
+ verboseMap?: Record<string, string>,
+ ) => {
+ const metricConfig =
+ formData.point_radius_fixed || formData.size || formData.metric;
+ if (!metricConfig) return null;
+
+ const label =
+ verboseMap?.[metricConfig.value] ||
+ metricConfig?.value ||
+ metricConfig?.label ||
+ 'Metric';
+ return o.object?.metric ? (
+ <TooltipRow label={`${label}: `} value={`${o.object.metric}`} />
+ ) : null;
+ },
+};
+
+function extractValue(
+ o: JsonObject,
+ fieldName: string,
+ checkPoints = true,
+): any {
+ let value =
+ o.object?.[fieldName] ||
+ o.object?.properties?.[fieldName] ||
+ o.object?.data?.[fieldName] ||
+ '';
+
+ if (!value && checkPoints && Array.isArray(o.object?.points)) {
+ const allVals = o.object.points
+ .map((pt: any) => pt[fieldName])
+ .filter((v: any) => v !== undefined && v !== null);
+ if (allVals.length > 0) {
+ value = allVals[0];
+ return { value, allValues: allVals };
+ }
+ }
+
+ return { value, allValues: [] };
+}
+
+function formatValue(value: any): string {
+ if (value === '') return '';
+
+ if (
+ typeof value === 'string' &&
+ value.match(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/)
+ ) {
+ return new Date(value).toLocaleString();
+ }
+
+ return `${value}`;
+}
+
+function buildFieldBasedTooltipItems(
+ o: JsonObject,
+ formData: QueryFormData,
+): JSX.Element[] {
+ const tooltipItems: JSX.Element[] = [];
+
+ formData.tooltip_contents.forEach((item: any, index: number) => {
+ let label = '';
+ let fieldName = '';
+
+ if (typeof item === 'string') {
+ label = item;
+ fieldName = item;
+ } else if (item.item_type === 'column') {
+ label = item.verbose_name || item.column_name || item.label;
+ fieldName = item.column_name;
+ } else if (item.item_type === 'metric') {
+ label = item.verbose_name || item.metric_name || item.label;
+ fieldName = item.metric_name || item.label;
+ }
+
+ if (!label || !fieldName) return;
+
+ let { value } = extractValue(o, fieldName);
+ if (!value && item.item_type === 'metric') {
+ value = o.object?.metric || '';
+ }
+
+ if (
+ formData.viz_type === 'deck_screengrid' &&
+ !value &&
+ Array.isArray(o.object?.points)
+ ) {
+ const { allValues } = extractValue(o, fieldName);
+ if (allValues.length > 0) {
+ value = allValues.join(', ');
+ }
+ }
+
+ if (value !== '') {
+ const formattedValue = formatValue(value);
+ tooltipItems.push(
+ <TooltipRow
+ key={`tooltip-${index}`}
+ label={`${label}: `}
+ value={formattedValue}
+ />,
+ );
+ }
+ });
+
+ return tooltipItems;
+}
+
+function createScreenGridData(
+ o: JsonObject,
+ fieldName: string,
+ extractResult: { value: any; allValues: any[] },
+): Record<string, any> {
+ const result: Record<string, any> = {};
+
+ if (extractResult.allValues.length > 0) {
+ result[fieldName] = extractResult.allValues;
+ result[`${fieldName}s`] = extractResult.allValues.join(', ');
+ result[`${fieldName}_count`] = extractResult.allValues.length;
+ } else {
+ const count = o.object?.count || 0;
+ const value = o.object?.value || 0;
+ const aggregatedValue = `Aggregated: ${count} points, total value: ${value}`;
+ result[fieldName] = aggregatedValue;
+ result[`${fieldName}_aggregated`] = aggregatedValue;
+ }
+
+ return result;
+}
+
+function processTooltipContentItem(
+ item: any,
+ o: JsonObject,
+ formData: QueryFormData,
+): Record<string, any> {
+ let fieldName = '';
+
+ if (typeof item === 'string') {
+ fieldName = item;
+ } else if (item?.item_type === 'column') {
+ fieldName = item.column_name;
+ } else if (item?.item_type === 'metric') {
+ fieldName = item.metric_name || item.label;
+ }
+
+ if (!fieldName) return {};
+
+ const extractResult = extractValue(o, fieldName);
+ let { value } = extractResult;
+
+ if (item?.item_type === 'metric' && !value) {
+ value = o.object?.metric || '';
+ }
+
+ if (formData.viz_type === 'deck_screengrid' && !value) {
+ return createScreenGridData(o, fieldName, extractResult);
+ }
+
+ if (extractResult.allValues.length > 0) {
+ return {
+ [fieldName]: extractResult.allValues,
+ [`${fieldName}s`]: extractResult.allValues.join(', '),
+ [`${fieldName}_count`]: extractResult.allValues.length,
+ };
+ }
+
+ if (value !== '') {
+ return { [fieldName]: value };
+ }
+
+ return {};
+}
+
+export function createHandlebarsTooltipData(
+ o: JsonObject,
+ formData: QueryFormData,
+): Record<string, any> {
+ const initialData: Record<string, any> = {
+ ...(o.object || {}),
+ coordinate: o.coordinate,
+ index: o.index,
+ picked: o.picked,
+ title: formData.viz_type || 'Chart',
+ coordinateString: o.coordinate
+ ? `${o.coordinate[0]}, ${o.coordinate[1]}`
+ : '',
+ positionString: o.object?.position
+ ? `${o.object.position[0]}, ${o.object.position[1]}`
+ : '',
+ threshold: o.object?.contour?.threshold,
+ contourThreshold: o.object?.contour?.threshold,
+ nearbyPoints: o.object?.nearbyPoints,
+ totalPoints: o.object?.totalPoints,
+ };
+
+ let data = { ...initialData };
+
+ if (
+ formData.viz_type === 'deck_heatmap' ||
+ formData.viz_type === 'deck_contour'
+ ) {
+ if (o.object?.position) {
+ data = {
+ ...data,
+ LON: o.object.position[0],
+ LAT: o.object.position[1],
+ };
+ }
+ if (o.coordinate) {
+ data = {
+ ...data,
+ LON: o.coordinate[0],
+ LAT: o.coordinate[1],
+ };
+ }
+
+ if (!o.object && formData.viz_type === 'deck_heatmap') {
+ data = {
+ ...data,
+ aggregated: true,
+ note: 'Aggregated cell - individual point data not available',
+ };
+ }
+ }
+
+ if (formData.tooltip_contents && formData.tooltip_contents.length > 0) {
+ const tooltipData = formData.tooltip_contents.reduce(
+ (acc: any, item: any) => {
+ const itemData = processTooltipContentItem(item, o, formData);
+ return { ...acc, ...itemData };
+ },
+ {},
+ );
+
+ data = { ...data, ...tooltipData };
+ }
+
+ return data;
+}
+
+export function generateEnhancedDefaultTemplate(
+ tooltipContents: any[],
+ formData: QueryFormData,
+): string {
+ return createDefaultTemplateWithLimits(tooltipContents, formData);
+}
+
+export function useTooltipContent(
+ formData: QueryFormData,
+ defaultTooltipGenerator: (o: JsonObject) => JSX.Element,
+) {
+ const tooltipContentGenerator = useMemo(
+ () => (o: JsonObject) => {
+ if (
+ formData.tooltip_template?.trim() &&
+ !formData.tooltip_template.includes(
+ 'Drop columns/metrics in "Tooltip contents" above',
+ )
+ ) {
+ const tooltipData = createHandlebarsTooltipData(o, formData);
+ return (
+ <div className="deckgl-tooltip" data-tooltip-type="custom">
+ <MemoizedHandlebarsRenderer
+ templateSource={formData.tooltip_template}
+ data={tooltipData}
+ />
+ </div>
+ );
+ }
+
+ if (formData.tooltip_contents && formData.tooltip_contents.length > 0) {
+ const tooltipItems = buildFieldBasedTooltipItems(o, formData);
+ return <div className="deckgl-tooltip">{tooltipItems}</div>;
+ }
+
+ return defaultTooltipGenerator(o);
+ },
+ [
+ formData.tooltip_template,
+ formData.tooltip_contents,
+ formData.viz_type,
+ defaultTooltipGenerator,
+ ],
+ );
+
+ return tooltipContentGenerator;
+}
+
+export function createTooltipContent(
+ formData: QueryFormData,
+ defaultTooltipGenerator: (o: JsonObject) => JSX.Element,
+) {
+ return (o: JsonObject) => {
+ if (
+ formData.tooltip_template?.trim() &&
+ !formData.tooltip_template.includes(
+ 'Drop columns/metrics in "Tooltip contents" above',
+ )
+ ) {
+ const tooltipData = createHandlebarsTooltipData(o, formData);
+ return (
+ <div className="deckgl-tooltip" data-tooltip-type="custom">
+ <MemoizedHandlebarsRenderer
+ templateSource={formData.tooltip_template}
+ data={tooltipData}
+ />
+ </div>
+ );
+ }
+
+ if (formData.tooltip_contents && formData.tooltip_contents.length > 0) {
+ const tooltipItems = buildFieldBasedTooltipItems(o, formData);
+ return <div className="deckgl-tooltip">{tooltipItems}</div>;
+ }
+
+ return defaultTooltipGenerator(o);
+ };
+}
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/utils.ts b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/utils.ts
index 107a6ac057..bf84124838 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/utils.ts
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/src/utilities/utils.ts
@@ -28,8 +28,6 @@ export const COLOR_SCHEME_TYPES = {
export type ColorSchemeType =
(typeof COLOR_SCHEME_TYPES)[keyof typeof COLOR_SCHEME_TYPES];
-/* eslint camelcase: 0 */
-
export function formatSelectOptions(options: (string | number)[]) {
return options.map(opt => [opt, opt.toString()]);
}
diff --git a/superset-frontend/plugins/legacy-preset-chart-deckgl/tsconfig.json b/superset-frontend/plugins/legacy-preset-chart-deckgl/tsconfig.json
index b3af9a1d19..b5b28fc618 100644
--- a/superset-frontend/plugins/legacy-preset-chart-deckgl/tsconfig.json
+++ b/superset-frontend/plugins/legacy-preset-chart-deckgl/tsconfig.json
@@ -4,7 +4,10 @@
"composite": true,
"rootDir": "src",
"outDir": "lib",
- "baseUrl": "."
+ "baseUrl": ".",
+ "paths": {
+ "@superset-ui/core/components": ["../../packages/superset-ui-core/src/components"]
+ }
},
"include": ["src/**/*", "types/**/*"],
"exclude": ["lib", "test"],
diff --git a/superset-frontend/plugins/plugin-chart-handlebars/src/components/CodeEditor/CodeEditor.tsx b/superset-frontend/plugins/plugin-chart-handlebars/src/components/CodeEditor/CodeEditor.tsx
index ef37e5468a..099f7c5650 100644
--- a/superset-frontend/plugins/plugin-chart-handlebars/src/components/CodeEditor/CodeEditor.tsx
+++ b/superset-frontend/plugins/plugin-chart-handlebars/src/components/CodeEditor/CodeEditor.tsx
@@ -17,64 +17,9 @@
* under the License.
*/
-import { FC } from 'react';
-import AceEditor, { IAceEditorProps } from 'react-ace';
-
-// must go after AceEditor import
-import 'ace-builds/src-min-noconflict/mode-handlebars';
-import 'ace-builds/src-min-noconflict/mode-css';
-import 'ace-builds/src-noconflict/theme-github';
-import 'ace-builds/src-noconflict/theme-monokai';
-
-export type CodeEditorMode = 'handlebars' | 'css';
-export type CodeEditorTheme = 'light' | 'dark';
-
-export interface CodeEditorProps extends IAceEditorProps {
- mode?: CodeEditorMode;
- theme?: CodeEditorTheme;
- name?: string;
-}
-
-export const CodeEditor: FC<CodeEditorProps> = ({
- mode,
- theme,
- name,
- width,
- height,
- value,
- ...rest
-}: CodeEditorProps) => {
- const m_name = name || Math.random().toString(36).substring(7);
- const m_theme = theme === 'light' ? 'github' : 'monokai';
- const m_mode = mode || 'handlebars';
- const m_height = height || '300px';
- const m_width = width || '100%';
-
- return (
- <div className="code-editor" style={{ minHeight: height, width: m_width }}>
- <AceEditor
- mode={m_mode}
- theme={m_theme}
- name={m_name}
- height={m_height}
- width={m_width}
- fontSize={14}
- showPrintMargin
- focus
- editorProps={{ $blockScrolling: true }}
- wrapEnabled
- highlightActiveLine
- value={value}
- setOptions={{
- enableBasicAutocompletion: true,
- enableLiveAutocompletion: true,
- enableSnippets: true,
- showLineNumbers: true,
- tabSize: 2,
- showGutter: true,
- }}
- {...rest}
- />
- </div>
- );
-};
+export {
+ CodeEditor,
+ type CodeEditorProps,
+ type CodeEditorMode,
+ type CodeEditorTheme,
+} from '@superset-ui/core/components';
diff --git a/superset-frontend/plugins/plugin-chart-handlebars/src/components/Handlebars/HandlebarsViewer.tsx b/superset-frontend/plugins/plugin-chart-handlebars/src/components/Handlebars/HandlebarsViewer.tsx
index 701d8949b6..c897605f57 100644
--- a/superset-frontend/plugins/plugin-chart-handlebars/src/components/Handlebars/HandlebarsViewer.tsx
+++ b/superset-frontend/plugins/plugin-chart-handlebars/src/components/Handlebars/HandlebarsViewer.tsx
@@ -76,7 +76,7 @@ export const HandlebarsViewer = ({
return <p>{t('Loading...')}</p>;
};
-// usage: {{dateFormat my_date format="MMMM YYYY"}}
+// usage: {{ dateFormat my_date format="MMMM YYYY" }}
Handlebars.registerHelper('dateFormat', function (context, block) {
const f = block.hash.format || 'YYYY-MM-DD';
return dayjs(context).format(f);
diff --git a/superset-frontend/spec/helpers/setup.ts b/superset-frontend/spec/helpers/setup.ts
index 6af5a181ff..9ec6d6661f 100644
--- a/superset-frontend/spec/helpers/setup.ts
+++ b/superset-frontend/spec/helpers/setup.ts
@@ -32,3 +32,9 @@ expect.extend(matchers);
// Allow JSX tests to have React import readily available
global.React = React;
+
+// Mock ace-builds globally for tests
+jest.mock('ace-builds/src-min-noconflict/mode-handlebars', () => ({}));
+jest.mock('ace-builds/src-min-noconflict/mode-css', () => ({}));
+jest.mock('ace-builds/src-noconflict/theme-github', () => ({}));
+jest.mock('ace-builds/src-noconflict/theme-monokai', () => ({}));
diff --git a/superset-frontend/src/explore/components/ControlPanelsContainer.tsx b/superset-frontend/src/explore/components/ControlPanelsContainer.tsx
index 8ab2368477..b39f433afc 100644
--- a/superset-frontend/src/explore/components/ControlPanelsContainer.tsx
+++ b/superset-frontend/src/explore/components/ControlPanelsContainer.tsx
@@ -149,9 +149,35 @@ const Styles = styled.div`
}
.tab-content {
- overflow: auto;
+ overflow: visible;
flex: 1 1 100%;
}
+
+ // Ensure Ant Design tabs allow content to expand
+ .ant-tabs-content {
+ overflow: visible;
+ height: auto;
+ }
+
+ .ant-tabs-content-holder {
+ overflow: visible;
+ height: auto;
+ }
+
+ .ant-tabs-tabpane {
+ overflow: visible;
+ height: auto;
+ }
+
+ // Ensure collapse components can expand
+ .ant-collapse-content {
+ overflow: visible;
+ }
+
+ .ant-collapse-content-box {
+ overflow: visible;
+ }
+
.Select__menu {
max-width: 100%;
}
diff --git a/superset-frontend/src/explore/components/ExploreViewContainer/index.jsx b/superset-frontend/src/explore/components/ExploreViewContainer/index.jsx
index 7781f13045..1fd22603de 100644
--- a/superset-frontend/src/explore/components/ExploreViewContainer/index.jsx
+++ b/superset-frontend/src/explore/components/ExploreViewContainer/index.jsx
@@ -247,6 +247,28 @@ function setSidebarWidths(key, dimension) {
setItem(key, newDimension);
}
+// Chart types that use aggregation and can have multiple values in tooltips
+const AGGREGATED_CHART_TYPES = [
+ // Deck.gl aggregated charts
+ 'deck_screengrid',
+ 'deck_heatmap',
+ 'deck_contour',
+ 'deck_hex',
+ 'deck_grid',
+ // Other aggregated chart types can be added here
+ 'heatmap',
+ 'treemap',
+ 'sunburst',
+ 'pie',
+ 'donut',
+ 'histogram',
+ 'table',
+];
+
+function isAggregatedChartType(vizType) {
+ return AGGREGATED_CHART_TYPES.includes(vizType);
+}
+
function ExploreViewContainer(props) {
const dynamicPluginContext = usePluginContext();
const dynamicPlugin = dynamicPluginContext.dynamicPlugins[props.vizType];
@@ -349,6 +371,15 @@ function ExploreViewContainer(props) {
props.form_data,
]);
+ // Simple debounced auto-query for non-renderTrigger controls
+ const debouncedAutoQuery = useMemo(
+ () =>
+ debounce(() => {
+ onQuery();
+ }, 1000), // 1 second delay
+ [onQuery],
+ );
+
const handleKeydown = useCallback(
event => {
const controlOrCommand = event.ctrlKey || event.metaKey;
@@ -488,6 +519,53 @@ function ExploreViewContainer(props) {
),
);
+ if (changedControlKeys.includes('tooltip_contents')) {
+ const tooltipContents = props.controls.tooltip_contents?.value || [];
+ const currentTemplate = props.controls.tooltip_template?.value || '';
+
+ if (tooltipContents.length > 0) {
+ const getFieldName = item => {
+ if (typeof item === 'string') return item;
+ if (item?.item_type === 'column') return item.column_name;
+ if (item?.item_type === 'metric') {
+ return item.metric_name || item.label;
+ }
+ return null;
+ };
+
+ const vizType = props.form_data?.viz_type || '';
+ const isAggregatedChart = isAggregatedChartType(vizType);
+
+ const DEFAULT_TOOLTIP_LIMIT = 10; // Maximum number of values to show in aggregated tooltips
+
+ const fieldNames = tooltipContents.map(getFieldName).filter(Boolean);
+ const missingVariables = fieldNames.filter(
+ fieldName =>
+ !currentTemplate.includes(`{{ ${fieldName} }}`) &&
+ !currentTemplate.includes(`{{ limit ${fieldName}`),
+ );
+
+ if (missingVariables.length > 0) {
+ const newVariables = missingVariables.map(fieldName => {
+ const item = tooltipContents[fieldNames.indexOf(fieldName)];
+ const isColumn =
+ item?.item_type === 'column' || typeof item === 'string';
+
+ if (isAggregatedChart && isColumn) {
+ return `{{ limit ${fieldName} ${DEFAULT_TOOLTIP_LIMIT} }}`;
+ }
+ return `{{ ${fieldName} }}`;
+ });
+ const updatedTemplate =
+ currentTemplate +
+ (currentTemplate ? ' ' : '') +
+ newVariables.join(' ');
+
+ props.actions.setControlValue('tooltip_template', updatedTemplate);
+ }
+ }
+ }
+
// this should also be handled by the actions that are actually changing the controls
const displayControlsChanged = changedControlKeys.filter(
key => props.controls[key].renderTrigger,
@@ -495,8 +573,25 @@ function ExploreViewContainer(props) {
if (displayControlsChanged.length > 0) {
reRenderChart(displayControlsChanged);
}
+
+ // Auto-update for non-renderTrigger controls
+ const queryControlsChanged = changedControlKeys.filter(
+ key =>
+ !props.controls[key].renderTrigger &&
+ !props.controls[key].dontRefreshOnChange,
+ );
+ if (queryControlsChanged.length > 0) {
+ // Check if there are no validation errors before auto-updating
+ const hasErrors = Object.values(props.controls).some(
+ control =>
+ control.validationErrors && control.validationErrors.length > 0,
+ );
+ if (!hasErrors) {
+ debouncedAutoQuery();
+ }
+ }
}
- }, [props.controls, props.ownState]);
+ }, [props.controls, props.ownState, debouncedAutoQuery]);
const chartIsStale = useMemo(() => {
if (lastQueriedControls) {
@@ -790,7 +885,7 @@ function mapStateToProps(state) {
saveModal,
} = state;
const { controls, slice, datasource, metadata, hiddenFormData } = explore;
- const hasQueryMode = !!controls.query_mode?.value;
+ const hasQueryMode = !!controls?.query_mode?.value;
const fieldsToOmit = hasQueryMode
? retainQueryModeRequirements(hiddenFormData)
: Object.keys(hiddenFormData ?? {});
@@ -835,6 +930,7 @@ function mapStateToProps(state) {
}
if (
+ controls &&
form_data.viz_type === 'big_number_total' &&
slice?.form_data?.subheader &&
(!controls.subtitle?.value || controls.subtitle.value === '')
diff --git a/superset-frontend/src/explore/components/RunQueryButton/index.tsx b/superset-frontend/src/explore/components/RunQueryButton/index.tsx
index c03cdc1eba..d8b3c4c3e5 100644
--- a/superset-frontend/src/explore/components/RunQueryButton/index.tsx
+++ b/superset-frontend/src/explore/components/RunQueryButton/index.tsx
@@ -31,6 +31,7 @@ export type RunQueryButtonProps = {
canStopQuery: boolean;
chartIsStale: boolean;
};
+
export const RunQueryButton = ({
loading,
onQuery,
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopover.tsx b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopover.tsx
index 3c61ab8532..2d8b19812e 100644
--- a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopover.tsx
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopover.tsx
@@ -34,6 +34,9 @@ import {
styled,
css,
DatasourceType,
+ Metric,
+ QueryFormMetric,
+ // useTheme,
} from '@superset-ui/core';
import { ColumnMeta, isSavedExpression } from '@superset-ui/chart-controls';
import Tabs from '@superset-ui/core/components/Tabs';
@@ -74,10 +77,24 @@ const StyledSelect = styled(Select)`
}
`;
+const MetricOptionContainer = styled.div`
+ display: flex;
+ align-items: center;
+`;
+
+const MetricIcon = styled.span`
+ margin-right: ${({ theme }) => theme.sizeUnit * 2}px;
+ color: ${({ theme }) => theme.colorSuccess};
+`;
+
+const MetricLabel = styled.span`
+ color: ${({ theme }) => theme.colorText};
+`;
+
export interface ColumnSelectPopoverProps {
columns: ColumnMeta[];
editedColumn?: ColumnMeta | AdhocColumn;
- onChange: (column: ColumnMeta | AdhocColumn) => void;
+ onChange: (column: ColumnMeta | AdhocColumn | Metric) => void;
onClose: () => void;
hasCustomLabel: boolean;
setLabel: (title: string) => void;
@@ -86,6 +103,8 @@ export interface ColumnSelectPopoverProps {
isTemporal?: boolean;
setDatasetModal?: Dispatch<SetStateAction<boolean>>;
disabledTabs?: Set<string>;
+ metrics?: Metric[];
+ selectedMetrics?: QueryFormMetric[];
datasource?: any;
}
@@ -116,8 +135,11 @@ const ColumnSelectPopover = ({
setDatasetModal,
setLabel,
disabledTabs = new Set<'saved' | 'simple' | 'sqlExpression'>(),
+ metrics = [],
+ selectedMetrics = [],
datasource,
}: ColumnSelectPopoverProps) => {
+ // const theme = useTheme(); // Unused variable
const datasourceType = useSelector<ExplorePageState, string | undefined>(
state => state.explore.datasource.type,
);
@@ -134,6 +156,9 @@ const ColumnSelectPopover = ({
const [selectedSimpleColumn, setSelectedSimpleColumn] = useState<
ColumnMeta | undefined
>(initialSimpleColumn);
+ const [selectedMetric, setSelectedMetric] = useState<Metric | undefined>(
+ undefined,
+ );
const [selectedTab, setSelectedTab] = useState<string | null>(null);
const [resizeButton, width, height] = useResizeButton(
@@ -159,11 +184,31 @@ const ColumnSelectPopover = ({
[columns],
);
+ // Filter metrics that are already selected in the chart
+ const availableMetrics = useMemo(() => {
+ if (!metrics?.length) return [];
+ const selectedMetricsSet = new Set(selectedMetrics);
+ return metrics.filter(metric => selectedMetricsSet.has(metric.metric_name));
+ }, [metrics, selectedMetrics]);
+
+ const columnMap = useMemo(
+ () => Object.fromEntries(simpleColumns.map(col => [col.column_name, col])),
+ [simpleColumns],
+ );
+ const metricMap = useMemo(
+ () =>
+ Object.fromEntries(
+ availableMetrics.map(metric => [metric.metric_name, metric]),
+ ),
+ [availableMetrics],
+ );
+
const onSqlExpressionChange = useCallback(
sqlExpression => {
setAdhocColumn({ label, sqlExpression, expressionType: 'SQL' });
setSelectedSimpleColumn(undefined);
setSelectedCalculatedColumn(undefined);
+ setSelectedMetric(undefined);
},
[label],
);
@@ -175,6 +220,7 @@ const ColumnSelectPopover = ({
);
setSelectedCalculatedColumn(selectedColumn);
setSelectedSimpleColumn(undefined);
+ setSelectedMetric(undefined);
setAdhocColumn(undefined);
setLabel(
selectedColumn?.verbose_name || selectedColumn?.column_name || '',
@@ -190,6 +236,7 @@ const ColumnSelectPopover = ({
);
setSelectedCalculatedColumn(undefined);
setSelectedSimpleColumn(selectedColumn);
+ setSelectedMetric(undefined);
setAdhocColumn(undefined);
setLabel(
selectedColumn?.verbose_name || selectedColumn?.column_name || '',
@@ -198,6 +245,38 @@ const ColumnSelectPopover = ({
[setLabel, simpleColumns],
);
+ const onSimpleMetricChange = useCallback(
+ selectedMetricName => {
+ const selectedMetric = availableMetrics.find(
+ metric => metric.metric_name === selectedMetricName,
+ );
+ setSelectedCalculatedColumn(undefined);
+ setSelectedSimpleColumn(undefined);
+ setSelectedMetric(selectedMetric);
+ setAdhocColumn(undefined);
+ setLabel(
+ selectedMetric?.verbose_name || selectedMetric?.metric_name || '',
+ );
+ },
+ [setLabel, availableMetrics],
+ );
+
+ const onSimpleItemChange = useCallback(
+ selectedValue => {
+ const selectedColumn = columnMap[selectedValue];
+ if (selectedColumn) {
+ onSimpleColumnChange(selectedValue);
+ return;
+ }
+
+ const selectedMetric = metricMap[selectedValue];
+ if (selectedMetric) {
+ onSimpleMetricChange(selectedValue);
+ }
+ },
+ [columnMap, metricMap, onSimpleColumnChange, onSimpleMetricChange],
+ );
+
const defaultActiveTabKey = initialAdhocColumn
? 'sqlExpression'
: selectedCalculatedColumn
@@ -241,10 +320,11 @@ const ColumnSelectPopover = ({
}
const selectedColumn =
adhocColumn || selectedCalculatedColumn || selectedSimpleColumn;
- if (!selectedColumn) {
+ const selectedItem = selectedColumn || selectedMetric;
+ if (!selectedItem) {
return;
}
- onChange(selectedColumn);
+ onChange(selectedItem);
onClose();
}, [
adhocColumn,
@@ -253,11 +333,13 @@ const ColumnSelectPopover = ({
onClose,
selectedCalculatedColumn,
selectedSimpleColumn,
+ selectedMetric,
]);
const onResetStateAndClose = useCallback(() => {
setSelectedCalculatedColumn(initialCalculatedColumn);
setSelectedSimpleColumn(initialSimpleColumn);
+ setSelectedMetric(undefined);
setAdhocColumn(initialAdhocColumn);
onClose();
}, [
@@ -285,16 +367,20 @@ const ColumnSelectPopover = ({
};
const stateIsValid =
- adhocColumn || selectedCalculatedColumn || selectedSimpleColumn;
+ adhocColumn ||
+ selectedCalculatedColumn ||
+ selectedSimpleColumn ||
+ selectedMetric;
const hasUnsavedChanges =
initialLabel !== label ||
selectedCalculatedColumn?.column_name !==
initialCalculatedColumn?.column_name ||
selectedSimpleColumn?.column_name !== initialSimpleColumn?.column_name ||
+ selectedMetric?.metric_name !== undefined ||
adhocColumn?.sqlExpression !== initialAdhocColumn?.sqlExpression;
const savedExpressionsLabel = t('Saved expressions');
- const simpleColumnsLabel = t('Column');
+ const simpleColumnsLabel = t('Columns and metrics');
const keywords = useMemo(
() => sqlKeywords.concat(getColumnKeywords(columns)),
[columns],
@@ -313,95 +399,103 @@ const ColumnSelectPopover = ({
width: ${width}px;
`}
items={[
- {
- key: TABS_KEYS.SAVED,
- label: t('Saved'),
- disabled: disabledTabs.has('saved'),
- children: (
- <>
- {calculatedColumns.length > 0 ? (
- <FormItem label={savedExpressionsLabel}>
- <StyledSelect
- ariaLabel={savedExpressionsLabel}
- value={selectedCalculatedColumn?.column_name}
- onChange={onCalculatedColumnChange}
- allowClear
- autoFocus={!selectedCalculatedColumn}
- placeholder={t('%s column(s)', calculatedColumns.length)}
- options={calculatedColumns.map(calculatedColumn => ({
- value: calculatedColumn.column_name,
- label: (
- <StyledColumnOption
- column={calculatedColumn}
- showType
+ // Only show Saved tab if not disabled
+ ...(disabledTabs.has('saved')
+ ? []
+ : [
+ {
+ key: TABS_KEYS.SAVED,
+ label: t('Saved'),
+ children: (
+ <>
+ {calculatedColumns.length > 0 ? (
+ <FormItem label={savedExpressionsLabel}>
+ <StyledSelect
+ ariaLabel={savedExpressionsLabel}
+ value={selectedCalculatedColumn?.column_name}
+ onChange={onCalculatedColumnChange}
+ allowClear
+ autoFocus={!selectedCalculatedColumn}
+ placeholder={t(
+ '%s column(s)',
+ calculatedColumns.length,
+ )}
+ options={calculatedColumns.map(
+ calculatedColumn => ({
+ value: calculatedColumn.column_name,
+ label: (
+ <StyledColumnOption
+ column={calculatedColumn}
+ showType
+ />
+ ),
+ key: calculatedColumn.column_name,
+ }),
+ )}
/>
- ),
- key: calculatedColumn.column_name,
- }))}
- />
- </FormItem>
- ) : datasourceType === DatasourceType.Table ? (
- <EmptyState
- image="empty.svg"
- size="small"
- title={
- isTemporal
- ? t('No temporal columns found')
- : t('No saved expressions found')
- }
- description={
- isTemporal
- ? t(
- 'Add calculated temporal columns to dataset in "Edit datasource" modal',
- )
- : t(
- 'Add calculated columns to dataset in "Edit datasource" modal',
- )
- }
- />
- ) : (
- <EmptyState
- image="empty.svg"
- size="small"
- title={
- isTemporal
- ? t('No temporal columns found')
- : t('No saved expressions found')
- }
- description={
- isTemporal ? (
- <>
- <span
- role="button"
- tabIndex={0}
- onClick={setDatasetAndClose}
- >
- {t('Create a dataset')}
- </span>{' '}
- {t(' to mark a column as a time column')}
- </>
+ </FormItem>
+ ) : datasourceType === DatasourceType.Table ? (
+ <EmptyState
+ image="empty.svg"
+ size="small"
+ title={
+ isTemporal
+ ? t('No temporal columns found')
+ : t('No saved expressions found')
+ }
+ description={
+ isTemporal
+ ? t(
+ 'Add calculated temporal columns to dataset in "Edit datasource" modal',
+ )
+ : t(
+ 'Add calculated columns to dataset in "Edit datasource" modal',
+ )
+ }
+ />
) : (
- <>
- <span
- role="button"
- tabIndex={0}
- onClick={setDatasetAndClose}
- >
- {t('Create a dataset')}
- </span>{' '}
- {t(' to add calculated columns')}
- </>
- )
- }
- />
- )}
- </>
- ),
- },
+ <EmptyState
+ image="empty.svg"
+ size="small"
+ title={
+ isTemporal
+ ? t('No temporal columns found')
+ : t('No saved expressions found')
+ }
+ description={
+ isTemporal ? (
+ <>
+ <span
+ role="button"
+ tabIndex={0}
+ onClick={setDatasetAndClose}
+ >
+ {t('Create a dataset')}
+ </span>{' '}
+ {t(' to mark a column as a time column')}
+ </>
+ ) : (
+ <>
+ <span
+ role="button"
+ tabIndex={0}
+ onClick={setDatasetAndClose}
+ >
+ {t('Create a dataset')}
+ </span>{' '}
+ {t(' to add calculated columns')}
+ </>
+ )
+ }
+ />
+ )}
+ </>
+ ),
+ },
+ ]),
{
key: TABS_KEYS.SIMPLE,
label: t('Simple'),
- disabled: disabledTabs.has('simple'),
children: (
<>
{isTemporal && simpleColumns.length === 0 ? (
@@ -432,18 +526,41 @@ const ColumnSelectPopover = ({
<FormItem label={simpleColumnsLabel}>
<Select
ariaLabel={simpleColumnsLabel}
- value={selectedSimpleColumn?.column_name}
- onChange={onSimpleColumnChange}
+ value={
+ selectedSimpleColumn?.column_name ||
+ selectedMetric?.metric_name
+ }
+ onChange={onSimpleItemChange}
allowClear
- autoFocus={!selectedSimpleColumn}
- placeholder={t('%s column(s)', simpleColumns.length)}
- options={simpleColumns.map(simpleColumn => ({
- value: simpleColumn.column_name,
- label: (
- <StyledColumnOption column={simpleColumn} showType />
- ),
- key: simpleColumn.column_name,
- }))}
+ autoFocus={!selectedSimpleColumn && !selectedMetric}
+ placeholder={t(
+ '%s item(s)',
+ simpleColumns.length + availableMetrics.length,
+ )}
+ options={[
+ ...simpleColumns.map(simpleColumn => ({
+ value: simpleColumn.column_name,
+ label: (
+ <StyledColumnOption
+ column={simpleColumn}
+ showType
+ />
+ ),
+ key: `column-${simpleColumn.column_name}`,
+ })),
+ ...availableMetrics.map(metric => ({
+ value: metric.metric_name,
+ label: (
+ <MetricOptionContainer>
+ <MetricIcon>Æ’</MetricIcon>
+ <MetricLabel>
+ {metric.verbose_name || metric.metric_name}
+ </MetricLabel>
+ </MetricOptionContainer>
+ ),
+ key: `metric-${metric.metric_name}`,
+ })),
+ ]}
/>
</FormItem>
)}
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopoverTrigger.tsx b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopoverTrigger.tsx
index 0a8e538243..935b570e3a 100644
--- a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopoverTrigger.tsx
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopoverTrigger.tsx
@@ -17,9 +17,15 @@
* under the License.
*/
import { useCallback, useEffect, useMemo, useState, ReactNode } from 'react';
-
import { useSelector } from 'react-redux';
-import { AdhocColumn, t, isAdhocColumn } from '@superset-ui/core';
+
+import {
+ AdhocColumn,
+ t,
+ isAdhocColumn,
+ Metric,
+ QueryFormMetric,
+} from '@superset-ui/core';
import { ColumnMeta, isColumnMeta } from '@superset-ui/chart-controls';
import { ExplorePopoverContent } from 'src/explore/components/ExploreContentPopover';
import { SaveDatasetModal } from 'src/SqlLab/components/SaveDatasetModal';
@@ -27,6 +33,9 @@ import ColumnSelectPopover from './ColumnSelectPopover';
import { DndColumnSelectPopoverTitle } from './DndColumnSelectPopoverTitle';
import ControlPopover from '../ControlPopover/ControlPopover';
+const defaultPopoverLabel = t('My column');
+const editableTitleTab = 'sqlExpression';
+
interface ColumnSelectPopoverTriggerProps {
columns: ColumnMeta[];
editedColumn?: ColumnMeta | AdhocColumn;
@@ -38,12 +47,26 @@ interface ColumnSelectPopoverTriggerProps {
children: ReactNode;
isTemporal?: boolean;
disabledTabs?: Set<string>;
+ metrics?: Metric[];
+ selectedMetrics?: QueryFormMetric[];
}
-const defaultPopoverLabel = t('My column');
-const editableTitleTab = 'sqlExpression';
+const ColumnSelectPopoverTriggerWrapper = (
+ props: ColumnSelectPopoverTriggerProps,
+) => {
+ const datasource = useSelector(
+ (state: any) => state?.explore?.datasource || null,
+ );
-const ColumnSelectPopoverTrigger = ({
+ return <ColumnSelectPopoverTriggerInner {...props} datasource={datasource} />;
+};
+
+interface ColumnSelectPopoverTriggerInnerProps
+ extends ColumnSelectPopoverTriggerProps {
+ datasource?: any;
+}
+
+const ColumnSelectPopoverTriggerInner = ({
columns,
editedColumn,
onColumnEdit,
@@ -51,10 +74,11 @@ const ColumnSelectPopoverTrigger = ({
children,
isTemporal,
disabledTabs,
+ metrics,
+ selectedMetrics,
+ datasource,
...props
-}: ColumnSelectPopoverTriggerProps) => {
- // @ts-ignore
- const datasource = useSelector(state => state.explore.datasource);
+}: ColumnSelectPopoverTriggerInnerProps) => {
const [popoverLabel, setPopoverLabel] = useState(defaultPopoverLabel);
const [popoverVisible, setPopoverVisible] = useState(false);
const [isTitleEditDisabled, setIsTitleEditDisabled] = useState(true);
@@ -112,6 +136,8 @@ const ColumnSelectPopoverTrigger = ({
getCurrentTab={getCurrentTab}
isTemporal={isTemporal}
disabledTabs={disabledTabs}
+ metrics={metrics}
+ selectedMetrics={selectedMetrics}
datasource={datasource}
/>
</ExplorePopoverContent>
@@ -126,29 +152,39 @@ const ColumnSelectPopoverTrigger = ({
onColumnEdit,
popoverLabel,
disabledTabs,
+ metrics,
+ selectedMetrics,
datasource,
],
);
const onLabelChange = useCallback(
- (e: any) => {
+ (e: React.ChangeEvent<HTMLInputElement>) => {
setPopoverLabel(e.target.value);
setHasCustomLabel(true);
},
[setPopoverLabel, setHasCustomLabel],
);
- const popoverTitle = useMemo(
- () => (
+ const popoverTitle = useMemo(() => {
+ if (disabledTabs?.has('saved') && disabledTabs?.has('sqlExpression')) {
+ return <span>{t('Tooltip contents')}</span>;
+ }
+ return (
<DndColumnSelectPopoverTitle
title={popoverLabel}
onChange={onLabelChange}
isEditDisabled={isTitleEditDisabled}
hasCustomLabel={hasCustomLabel}
/>
- ),
- [hasCustomLabel, isTitleEditDisabled, onLabelChange, popoverLabel],
- );
+ );
+ }, [
+ hasCustomLabel,
+ isTitleEditDisabled,
+ onLabelChange,
+ popoverLabel,
+ disabledTabs,
+ ]);
return (
<>
@@ -179,4 +215,4 @@ const ColumnSelectPopoverTrigger = ({
);
};
-export default ColumnSelectPopoverTrigger;
+export default ColumnSelectPopoverTriggerWrapper;
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndColumnMetricSelect.test.tsx b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndColumnMetricSelect.test.tsx
new file mode 100644
index 0000000000..efdd8b948d
--- /dev/null
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndColumnMetricSelect.test.tsx
@@ -0,0 +1,344 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import {
+ fireEvent,
+ render,
+ screen,
+ within,
+} from 'spec/helpers/testing-library';
+import { DndColumnMetricSelect } from 'src/explore/components/controls/DndColumnSelectControl/DndColumnMetricSelect';
+import DatasourcePanelDragOption from '../../DatasourcePanel/DatasourcePanelDragOption';
+import { DndItemType } from '../../DndItemType';
+
+const defaultProps = {
+ name: 'test-control',
+ actions: {},
+ savedMetrics: [
+ {
+ metric_name: 'metric_a',
+ expression: 'expression_a',
+ verbose_name: 'metric_a',
+ },
+ {
+ metric_name: 'metric_b',
+ expression: 'expression_b',
+ verbose_name: 'Metric B',
+ },
+ ],
+ columns: [
+ {
+ column_name: 'column_a',
+ },
+ {
+ column_name: 'column_b',
+ verbose_name: 'Column B',
+ },
+ ],
+ selectedMetrics: [
+ {
+ metric_name: 'metric_a',
+ expression: 'expression_a',
+ verbose_name: 'metric_a',
+ },
+ {
+ metric_name: 'metric_b',
+ expression: 'expression_b',
+ verbose_name: 'Metric B',
+ },
+ ],
+ onChange: () => {},
+} as any;
+
+test('renders with default props', () => {
+ render(<DndColumnMetricSelect {...defaultProps} />, {
+ useDnd: true,
+ useRedux: true,
+ });
+ expect(
+ screen.getByText('Drop columns/metrics here or click'),
+ ).toBeInTheDocument();
+});
+
+test('renders with default props and multi = true', () => {
+ render(<DndColumnMetricSelect {...defaultProps} multi />, {
+ useDnd: true,
+ useRedux: true,
+ });
+ expect(
+ screen.getByText('Drop columns/metrics here or click'),
+ ).toBeInTheDocument();
+});
+
+test('render selected columns and metrics correctly', () => {
+ const values = ['column_a', 'metric_a'];
+ render(<DndColumnMetricSelect {...defaultProps} value={values} multi />, {
+ useDnd: true,
+ useRedux: true,
+ });
+ expect(screen.getByText('column_a')).toBeVisible();
+ expect(screen.getByText('metric_a')).toBeVisible();
+});
+
+test('can drop columns and metrics', () => {
+ const values = ['column_a', 'metric_a'];
+ const { getByTestId } = render(
+ <>
+ <DatasourcePanelDragOption
+ value={{ column_name: 'column_b', uuid: '1' }}
+ type={DndItemType.Column}
+ />
+ <DatasourcePanelDragOption
+ value={{ metric_name: 'metric_b', uuid: '2' }}
+ type={DndItemType.Metric}
+ />
+ <DndColumnMetricSelect {...defaultProps} value={values} multi />
+ </>,
+ {
+ useDnd: true,
+ useRedux: true,
+ },
+ );
+
+ const columnOption = screen.getAllByTestId('DatasourcePanelDragOption')[0];
+ const metricOption = screen.getAllByTestId('DatasourcePanelDragOption')[1];
+ const currentSelection = getByTestId('dnd-labels-container');
+
+ fireEvent.dragStart(columnOption);
+ fireEvent.dragOver(currentSelection);
+ fireEvent.drop(currentSelection);
+
+ fireEvent.dragStart(metricOption);
+ fireEvent.dragOver(currentSelection);
+ fireEvent.drop(currentSelection);
+
+ expect(currentSelection).toBeInTheDocument();
+});
+
+test('cannot drop duplicate items', () => {
+ const values = ['column_a', 'metric_a'];
+ const { getByTestId } = render(
+ <>
+ <DatasourcePanelDragOption
+ value={{ column_name: 'column_a', uuid: '1' }}
+ type={DndItemType.Column}
+ />
+ <DatasourcePanelDragOption
+ value={{ metric_name: 'metric_a', uuid: '2' }}
+ type={DndItemType.Metric}
+ />
+ <DndColumnMetricSelect {...defaultProps} value={values} multi />
+ </>,
+ {
+ useDnd: true,
+ useRedux: true,
+ },
+ );
+
+ const columnOption = screen.getAllByTestId('DatasourcePanelDragOption')[0];
+ const metricOption = screen.getAllByTestId('DatasourcePanelDragOption')[1];
+ const currentSelection = getByTestId('dnd-labels-container');
+
+ const initialCount = currentSelection.children.length;
+
+ fireEvent.dragStart(columnOption);
+ fireEvent.dragOver(currentSelection);
+ fireEvent.drop(currentSelection);
+
+ fireEvent.dragStart(metricOption);
+ fireEvent.dragOver(currentSelection);
+ fireEvent.drop(currentSelection);
+
+ expect(currentSelection.children).toHaveLength(initialCount);
+});
+
+test('can drop only selected metrics', () => {
+ const values = ['column_a'];
+ const { getByTestId } = render(
+ <>
+ <DatasourcePanelDragOption
+ value={{ metric_name: 'metric_a', uuid: '1' }}
+ type={DndItemType.Metric}
+ />
+ <DatasourcePanelDragOption
+ value={{ metric_name: 'metric_c', uuid: '2' }}
+ type={DndItemType.Metric}
+ />
+ <DndColumnMetricSelect {...defaultProps} value={values} multi />
+ </>,
+ {
+ useDnd: true,
+ useRedux: true,
+ },
+ );
+
+ const selectedMetric = screen.getAllByTestId('DatasourcePanelDragOption')[0];
+ const unselectedMetric = screen.getAllByTestId(
+ 'DatasourcePanelDragOption',
+ )[1];
+ const currentSelection = getByTestId('dnd-labels-container');
+
+ const initialCount = currentSelection.children.length;
+
+ fireEvent.dragStart(unselectedMetric);
+ fireEvent.dragOver(currentSelection);
+ fireEvent.drop(currentSelection);
+
+ expect(currentSelection.children).toHaveLength(initialCount);
+
+ fireEvent.dragStart(selectedMetric);
+ fireEvent.dragOver(currentSelection);
+ fireEvent.drop(currentSelection);
+
+ expect(currentSelection).toBeInTheDocument();
+});
+
+test('can drag and reorder items', async () => {
+ const values = ['column_a', 'metric_a', 'column_b'];
+ render(<DndColumnMetricSelect {...defaultProps} value={values} multi />, {
+ useDnd: true,
+ useRedux: true,
+ });
+
+ const container = screen.getByTestId('dnd-labels-container');
+ expect(container.childElementCount).toBe(4);
+
+ const firstItem = container.children[0] as HTMLElement;
+ const lastItem = container.children[2] as HTMLElement;
+
+ expect(within(firstItem).getByText('column_a')).toBeVisible();
+ expect(within(lastItem).getByText('Column B')).toBeVisible();
+
+ fireEvent.dragStart(firstItem);
+ fireEvent.dragEnter(lastItem);
+ fireEvent.dragOver(lastItem);
+ fireEvent.drop(lastItem);
+
+ expect(container).toBeInTheDocument();
+});
+
+test('shows warning for aggregated DeckGL charts', () => {
+ const values = ['column_a'];
+ const formData = { viz_type: 'deck_heatmap', datasource: 'test' };
+
+ render(
+ <DndColumnMetricSelect
+ {...defaultProps}
+ value={values}
+ multi
+ formData={formData}
+ />,
+ { useDnd: true, useRedux: true },
+ );
+
+ const columnItem = screen.getByText('column_a');
+ expect(columnItem).toBeVisible();
+});
+
+test('handles single selection mode', () => {
+ const values = ['column_a'];
+ const onChange = jest.fn();
+
+ render(
+ <DndColumnMetricSelect
+ {...defaultProps}
+ value={values}
+ multi={false}
+ onChange={onChange}
+ />,
+ { useDnd: true, useRedux: true },
+ );
+
+ expect(screen.getByText('column_a')).toBeVisible();
+ expect(
+ screen.queryByText('Drop columns/metrics here or click'),
+ ).not.toBeInTheDocument();
+});
+
+test('handles custom ghost button text', () => {
+ const customText = 'Custom drop text';
+
+ render(
+ <DndColumnMetricSelect {...defaultProps} ghostButtonText={customText} />,
+ { useDnd: true, useRedux: true },
+ );
+
+ expect(screen.getByText(customText)).toBeInTheDocument();
+});
+
+test('can remove items by clicking close button', () => {
+ const values = ['column_a', 'metric_a'];
+ const onChange = jest.fn();
+
+ render(
+ <DndColumnMetricSelect
+ {...defaultProps}
+ value={values}
+ multi
+ onChange={onChange}
+ />,
+ { useDnd: true, useRedux: true },
+ );
+
+ const closeButtons = screen.getAllByRole('button', { name: /close/i });
+ expect(closeButtons).toHaveLength(2);
+
+ fireEvent.click(closeButtons[0]);
+
+ expect(onChange).toHaveBeenCalledWith(['metric_a']);
+});
+
+test('handles adhoc metric with error', () => {
+ const errorMetric = {
+ metric_name: 'error_metric',
+ error_text: 'This metric has an error',
+ uuid: 'error-uuid',
+ };
+ const values = [errorMetric];
+
+ render(<DndColumnMetricSelect {...defaultProps} value={values} multi />, {
+ useDnd: true,
+ useRedux: true,
+ });
+
+ const metricItem = screen.getByText('error_metric');
+ expect(metricItem).toBeVisible();
+});
+
+test('handles adhoc column values', () => {
+ const values = ['column_a'];
+
+ render(<DndColumnMetricSelect {...defaultProps} value={values} multi />, {
+ useDnd: true,
+ useRedux: true,
+ });
+
+ expect(screen.getByText('column_a')).toBeVisible();
+});
+
+test('handles mixed value types correctly', () => {
+ const mixedValues = ['column_a', 'metric_a'];
+
+ render(
+ <DndColumnMetricSelect {...defaultProps} value={mixedValues} multi />,
+ { useDnd: true, useRedux: true },
+ );
+
+ expect(screen.getByText('column_a')).toBeVisible();
+ expect(screen.getByText('metric_a')).toBeVisible();
+});
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndColumnMetricSelect.tsx b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndColumnMetricSelect.tsx
new file mode 100644
index 0000000000..0be34889c6
--- /dev/null
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndColumnMetricSelect.tsx
@@ -0,0 +1,448 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { useCallback, useMemo, useState } from 'react';
+import {
+ AdhocColumn,
+ tn,
+ t,
+ isAdhocColumn,
+ Metric,
+ ensureIsArray,
+ Datasource,
+ QueryFormMetric,
+ QueryFormData,
+} from '@superset-ui/core';
+import { ColumnMeta, isColumnMeta } from '@superset-ui/chart-controls';
+import { isString } from 'lodash';
+import DndSelectLabel from 'src/explore/components/controls/DndColumnSelectControl/DndSelectLabel';
+import OptionWrapper from 'src/explore/components/controls/DndColumnSelectControl/OptionWrapper';
+import { DatasourcePanelDndItem } from 'src/explore/components/DatasourcePanel/types';
+import { DndItemType } from 'src/explore/components/DndItemType';
+import AdhocMetric from 'src/explore/components/controls/MetricControl/AdhocMetric';
+import MetricDefinitionValue from 'src/explore/components/controls/MetricControl/MetricDefinitionValue';
+import ColumnSelectPopoverTrigger from './ColumnSelectPopoverTrigger';
+import { DndControlProps } from './types';
+
+const AGGREGATED_DECK_GL_CHART_TYPES = [
+ 'deck_screengrid',
+ 'deck_heatmap',
+ 'deck_contour',
+ 'deck_hex',
+ 'deck_grid',
+];
+
+const MULTI_VALUE_WARNING_MESSAGE =
+ 'This metric or column contains many values, they may not be able to be all displayed in the tooltip';
+
+interface TooltipItem {
+ item_type?: string;
+ column_name?: string;
+ metric_name?: string;
+ label?: string;
+}
+
+function isAggregatedDeckGLChart(vizType: string): boolean {
+ return AGGREGATED_DECK_GL_CHART_TYPES.includes(vizType);
+}
+
+function fieldHasMultipleValues(
+ item: TooltipItem | string,
+ formData: QueryFormData,
+): boolean {
+ if (!formData?.viz_type || !isAggregatedDeckGLChart(formData.viz_type)) {
+ return false;
+ }
+
+ if (typeof item === 'string') {
+ return true;
+ }
+
+ if (item.item_type === 'metric') {
+ return false;
+ }
+
+ if (item.item_type === 'column') {
+ return true;
+ }
+
+ return false;
+}
+
+const DND_ACCEPTED_TYPES = [DndItemType.Column, DndItemType.Metric];
+
+type ColumnMetricValue =
+ | string
+ | AdhocColumn
+ | AdhocMetric
+ | { metric_name: string; error_text: string; uuid: string };
+
+export type DndColumnMetricSelectProps = DndControlProps<ColumnMetricValue> & {
+ columns: ColumnMeta[];
+ savedMetrics: Metric[];
+ datasource?: Datasource;
+ selectedMetrics?: QueryFormMetric[];
+ isTemporal?: boolean;
+ disabledTabs?: Set<string>;
+ formData?: any;
+};
+
+const isDictionaryForAdhocMetric = (
+ value: unknown,
+): value is Record<string, unknown> =>
+ value !== null &&
+ value !== undefined &&
+ !(value instanceof AdhocMetric) &&
+ typeof value === 'object' &&
+ 'expressionType' in value;
+
+function DndColumnMetricSelect(props: DndColumnMetricSelectProps) {
+ const {
+ value,
+ columns = [],
+ savedMetrics = [],
+ selectedMetrics = [],
+ datasource,
+ multi = true,
+ onChange,
+ canDelete = true,
+ ghostButtonText,
+ name,
+ label,
+ isTemporal,
+ disabledTabs,
+ formData,
+ } = props;
+
+ const [newColumnPopoverVisible, setNewColumnPopoverVisible] = useState(false);
+
+ const combinedOptionsMap = useMemo(() => {
+ const optionsMap: Record<string, ColumnMeta> = {};
+
+ columns.forEach(column => {
+ optionsMap[column.column_name] = column;
+ });
+
+ return optionsMap;
+ }, [columns]);
+
+ const isMetricSelected = useCallback(
+ (metricName: string) => {
+ if (!selectedMetrics || selectedMetrics.length === 0) {
+ return false;
+ }
+
+ return selectedMetrics.some(metric => {
+ if (isString(metric)) {
+ return metric === metricName;
+ }
+ if (metric instanceof AdhocMetric) {
+ return metric.label === metricName;
+ }
+ if (metric && typeof metric === 'object') {
+ if (metric instanceof AdhocMetric) {
+ return metric.label === metricName;
+ }
+ return 'metric_name' in metric && metric.metric_name === metricName;
+ }
+ return false;
+ });
+ },
+ [selectedMetrics],
+ );
+
+ const coercedValue = useMemo(() => {
+ if (!value) return [];
+
+ const valueArray = ensureIsArray(value);
+ return valueArray.map(item => {
+ if (isString(item) && combinedOptionsMap[item]) {
+ return item;
+ }
+
+ if (isString(item) && savedMetrics.some(m => m.metric_name === item)) {
+ return item;
+ }
+
+ if (isAdhocColumn(item)) {
+ return item;
+ }
+
+ if (isDictionaryForAdhocMetric(item)) {
+ return new AdhocMetric(item);
+ }
+
+ if (item instanceof AdhocMetric) {
+ return item;
+ }
+
+ return item;
+ });
+ }, [value, combinedOptionsMap, savedMetrics]);
+
+ const onDrop = useCallback(
+ (item: DatasourcePanelDndItem) => {
+ const newValues = [...coercedValue];
+
+ if (item.type === DndItemType.Column) {
+ const column = item.value as ColumnMeta;
+
+ if (!multi && newValues.length > 0) {
+ newValues[0] = column.column_name;
+ } else {
+ newValues.push(column.column_name);
+ }
+ }
+ if (item.type === DndItemType.Metric) {
+ const metric = item.value as Metric;
+
+ if (!multi && newValues.length > 0) {
+ newValues[0] = metric.metric_name;
+ } else {
+ newValues.push(metric.metric_name);
+ }
+ }
+
+ onChange(multi ? newValues : newValues[0]);
+ },
+ [onChange, coercedValue, multi],
+ );
+
+ const canDrop = useCallback(
+ (item: DatasourcePanelDndItem) => {
+ if (item.type === DndItemType.Column) {
+ const columnName = (item.value as ColumnMeta).column_name;
+ return (
+ columnName in combinedOptionsMap &&
+ !coercedValue.some(v => v === columnName)
+ );
+ }
+ if (item.type === DndItemType.Metric) {
+ const metric = item.value as Metric;
+ const metricName = metric.metric_name;
+
+ return (
+ isMetricSelected(metricName) &&
+ !coercedValue.some(v => v === metricName)
+ );
+ }
+ return false;
+ },
+ [combinedOptionsMap, coercedValue, isMetricSelected],
+ );
+
+ const onClickClose = useCallback(
+ (index: number) => {
+ const newValues = [...coercedValue];
+ newValues.splice(index, 1);
+ onChange(multi ? newValues : newValues[0]);
+ },
+ [onChange, coercedValue, multi],
+ );
+
+ const onShiftOptions = useCallback(
+ (dragIndex: number, hoverIndex: number) => {
+ const newValues = [...coercedValue];
+ [newValues[hoverIndex], newValues[dragIndex]] = [
+ newValues[dragIndex],
+ newValues[hoverIndex],
+ ];
+ onChange(multi ? newValues : newValues[0]);
+ },
+ [onChange, coercedValue, multi],
+ );
+
+ const isColumnValue = (val: unknown): val is string =>
+ isString(val) && !!combinedOptionsMap[val];
+
+ const valuesRenderer = useCallback(
+ () =>
+ coercedValue.map((item, idx) => {
+ if (isColumnValue(item)) {
+ const column = combinedOptionsMap[item];
+ const datasourceWarningMessage = undefined;
+ const withCaret = true;
+
+ const columnItem = {
+ item_type: 'column',
+ column_name: item,
+ };
+ const hasMultipleValues =
+ formData && fieldHasMultipleValues(columnItem, formData);
+ const multiValueWarningMessage = hasMultipleValues
+ ? MULTI_VALUE_WARNING_MESSAGE
+ : undefined;
+
+ return (
+ <ColumnSelectPopoverTrigger
+ key={`column-${idx}`}
+ columns={columns}
+ onColumnEdit={newColumn => {
+ const newValues = [...coercedValue];
+ if (isColumnMeta(newColumn)) {
+ newValues[idx] = newColumn.column_name;
+ } else {
+ newValues[idx] = newColumn;
+ }
+ onChange(multi ? newValues : newValues[0]);
+ }}
+ editedColumn={column}
+ isTemporal={isTemporal}
+ disabledTabs={disabledTabs}
+ >
+ <OptionWrapper
+ key={`column-${idx}`}
+ index={idx}
+ clickClose={onClickClose}
+ onShiftOptions={onShiftOptions}
+ type={`${DndItemType.ColumnOption}_${name}_${label}`}
+ canDelete={canDelete}
+ column={column}
+ datasourceWarningMessage={datasourceWarningMessage}
+ withCaret={withCaret}
+ multiValueWarningMessage={multiValueWarningMessage}
+ />
+ </ColumnSelectPopoverTrigger>
+ );
+ }
+ const datasourceWarningMessage =
+ (item instanceof AdhocMetric && item.datasourceWarning) ||
+ (item &&
+ typeof item === 'object' &&
+ 'error_text' in item &&
+ item.error_text)
+ ? t('This metric might be incompatible with current dataset')
+ : undefined;
+
+ return (
+ <MetricDefinitionValue
+ key={`metric-${idx}`}
+ index={idx}
+ option={item}
+ onMetricEdit={(changedMetric: Metric | AdhocMetric) => {
+ const newValues = [...coercedValue];
+ if (changedMetric instanceof AdhocMetric) {
+ newValues[idx] = changedMetric;
+ } else {
+ newValues[idx] = (changedMetric as Metric).metric_name;
+ }
+ onChange(multi ? newValues : newValues[0]);
+ }}
+ onRemoveMetric={onClickClose}
+ columns={columns}
+ savedMetrics={savedMetrics}
+ savedMetricsOptions={savedMetrics}
+ datasource={datasource}
+ onMoveLabel={onShiftOptions}
+ onDropLabel={() => {}}
+ type={`${DndItemType.AdhocMetricOption}_${name}_${label}`}
+ multi={multi}
+ datasourceWarningMessage={datasourceWarningMessage}
+ />
+ );
+ }),
+ [
+ coercedValue,
+ isColumnValue,
+ combinedOptionsMap,
+ columns,
+ onChange,
+ multi,
+ isTemporal,
+ disabledTabs,
+ onClickClose,
+ onShiftOptions,
+ name,
+ label,
+ canDelete,
+ savedMetrics,
+ datasource,
+ ],
+ );
+
+ const labelGhostButtonText = useMemo(
+ () =>
+ ghostButtonText ??
+ tn(
+ 'Drop a column/metric here or click',
+ 'Drop columns/metrics here or click',
+ multi ? 2 : 1,
+ ),
+ [ghostButtonText, multi],
+ );
+
+ const toggleColumnPopover = useCallback((visible: boolean) => {
+ setNewColumnPopoverVisible(visible);
+ }, []);
+
+ const closeColumnPopover = useCallback(() => {
+ toggleColumnPopover(false);
+ }, [toggleColumnPopover]);
+
+ const handleClickGhostButton = useCallback(() => {
+ toggleColumnPopover(true);
+ }, [toggleColumnPopover]);
+
+ const addNewColumn = useCallback(
+ (newItem: ColumnMeta | AdhocColumn | Metric | AdhocMetric) => {
+ const newValues = [...coercedValue];
+ if (isColumnMeta(newItem)) {
+ newValues.push(newItem.column_name);
+ } else if (isAdhocColumn(newItem)) {
+ newValues.push(newItem);
+ } else if ('metric_name' in newItem && newItem.metric_name) {
+ newValues.push(newItem.metric_name);
+ } else if (newItem instanceof AdhocMetric) {
+ newValues.push(newItem);
+ }
+ onChange(multi ? newValues : newValues[0]);
+ },
+ [onChange, coercedValue, multi],
+ );
+
+ return (
+ <div>
+ <DndSelectLabel
+ onDrop={onDrop}
+ canDrop={canDrop}
+ valuesRenderer={valuesRenderer}
+ accept={DND_ACCEPTED_TYPES}
+ displayGhostButton={multi || coercedValue.length === 0}
+ ghostButtonText={labelGhostButtonText}
+ onClickGhostButton={handleClickGhostButton}
+ {...props}
+ />
+ <ColumnSelectPopoverTrigger
+ columns={columns}
+ onColumnEdit={addNewColumn}
+ isControlledComponent
+ visible={newColumnPopoverVisible}
+ togglePopover={toggleColumnPopover}
+ closePopover={closeColumnPopover}
+ isTemporal={false}
+ disabledTabs={disabledTabs}
+ metrics={savedMetrics}
+ selectedMetrics={selectedMetrics}
+ >
+ <div />
+ </ColumnSelectPopoverTrigger>
+ </div>
+ );
+}
+
+export { DndColumnMetricSelect };
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/Option.tsx b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/Option.tsx
index f214a4159e..228e92c682 100644
--- a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/Option.tsx
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/Option.tsx
@@ -39,6 +39,7 @@ export default function Option({
isExtra,
datasourceWarningMessage,
canDelete = true,
+ multiValueWarningMessage,
}: OptionProps) {
const theme = useTheme();
const onClickClose = useCallback(
@@ -69,6 +70,13 @@ export default function Option({
</CloseContainer>
)}
<Label data-test="control-label">{children}</Label>
+ {!!multiValueWarningMessage && (
+ <StyledInfoTooltip
+ type="warning"
+ placement="top"
+ tooltip={multiValueWarningMessage}
+ />
+ )}
{(!!datasourceWarningMessage || isExtra) && (
<StyledInfoTooltip
type="warning"
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/OptionWrapper.tsx b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/OptionWrapper.tsx
index be04b71d7f..172364e582 100644
--- a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/OptionWrapper.tsx
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/OptionWrapper.tsx
@@ -60,6 +60,7 @@ export default function OptionWrapper(
datasourceWarningMessage,
canDelete = true,
tooltipOverlay,
+ multiValueWarningMessage,
...rest
} = props;
const ref = useRef<HTMLDivElement>(null);
@@ -188,6 +189,7 @@ export default function OptionWrapper(
isExtra={isExtra}
datasourceWarningMessage={datasourceWarningMessage}
canDelete={canDelete}
+ multiValueWarningMessage={multiValueWarningMessage}
>
<Label />
</Option>
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/index.ts b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/index.ts
index dda99f7d0b..bbd1e374b7 100644
--- a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/index.ts
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/index.ts
@@ -16,7 +16,19 @@
* specific language governing permissions and limitations
* under the License.
*/
+/**
+ * Export DnD (Drag and Drop) control components for building interactive chart controls.
+ * These components enable users to configure visualizations by dragging and dropping
+ * available columns, metrics, and filters.
+ *
+ * DndSelectLabel: Base label component for DnD controls
+ * DndColumnSelect: Column selection control for choosing dataset columns
+ * DndFilterSelect: Filter selection control for data filtering
+ * DndMetricSelect: Metric selection control for aggregations
+ * DndColumnMetricSelect: Combined column and metric selection control
+ */
export { default } from './DndSelectLabel';
export * from './DndColumnSelect';
export * from './DndFilterSelect';
export * from './DndMetricSelect';
+export * from './DndColumnMetricSelect';
diff --git a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/types.ts b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/types.ts
index 32724863c8..873bba01ff 100644
--- a/superset-frontend/src/explore/components/controls/DndColumnSelectControl/types.ts
+++ b/superset-frontend/src/explore/components/controls/DndColumnSelectControl/types.ts
@@ -33,6 +33,7 @@ export interface OptionProps {
datasourceWarningMessage?: string;
canDelete?: boolean;
tooltipOverlay?: ReactNode;
+ multiValueWarningMessage?: string;
}
export interface OptionItemInterface {
diff --git a/superset-frontend/src/explore/components/controls/TextAreaControl.jsx b/superset-frontend/src/explore/components/controls/TextAreaControl.jsx
index e3a65c5e3b..346a2abc1e 100644
--- a/superset-frontend/src/explore/components/controls/TextAreaControl.jsx
+++ b/superset-frontend/src/explore/components/controls/TextAreaControl.jsx
@@ -18,6 +18,7 @@
*/
import { Component } from 'react';
import PropTypes from 'prop-types';
+import { debounce } from 'lodash';
import {
Input,
Tooltip,
@@ -27,6 +28,8 @@ import {
} from '@superset-ui/core/components';
import { t, withTheme } from '@superset-ui/core';
+import 'ace-builds/src-min-noconflict/mode-handlebars';
+
import ControlHeader from 'src/explore/components/ControlHeader';
const propTypes = {
@@ -44,6 +47,7 @@ const propTypes = {
'sql',
'markdown',
'javascript',
+ 'handlebars',
]),
aboveEditorSection: PropTypes.node,
readOnly: PropTypes.bool,
@@ -59,6 +63,7 @@ const propTypes = {
textAreaStyles: PropTypes.object,
tooltipOptions: PropTypes.object,
hotkeys: PropTypes.array,
+ debounceDelay: PropTypes.number,
};
const defaultProps = {
@@ -73,16 +78,45 @@ const defaultProps = {
textAreaStyles: {},
tooltipOptions: {},
hotkeys: [],
+ debounceDelay: null,
};
class TextAreaControl extends Component {
- onControlChange(event) {
- const { value } = event.target;
- this.props.onChange(value);
+ constructor(props) {
+ super(props);
+ if (props.debounceDelay) {
+ this.debouncedOnChange = debounce(props.onChange, props.debounceDelay);
+ }
}
- onAreaEditorChange(value) {
- this.props.onChange(value);
+ componentDidUpdate(prevProps) {
+ if (
+ this.props.onChange !== prevProps.onChange &&
+ this.props.debounceDelay
+ ) {
+ if (this.debouncedOnChange) {
+ this.debouncedOnChange.cancel();
+ }
+ this.debouncedOnChange = debounce(
+ this.props.onChange,
+ this.props.debounceDelay,
+ );
+ }
+ }
+
+ handleChange(value) {
+ const finalValue = typeof value === 'object' ? value.target.value : value;
+ if (this.debouncedOnChange) {
+ this.debouncedOnChange(finalValue);
+ } else {
+ this.props.onChange(finalValue);
+ }
+ }
+
+ componentWillUnmount() {
+ if (this.debouncedOnChange) {
+ this.debouncedOnChange.cancel();
+ }
}
renderEditor(inModal = false) {
@@ -122,7 +156,7 @@ class TextAreaControl extends Component {
readOnly={this.props.readOnly}
key={this.props.name}
{...this.props}
- onChange={this.onAreaEditorChange.bind(this)}
+ onChange={this.handleChange.bind(this)}
/>
</div>
);
@@ -137,7 +171,7 @@ class TextAreaControl extends Component {
<div>
<Input.TextArea
placeholder={t('textarea')}
- onChange={this.onControlChange.bind(this)}
+ onChange={this.handleChange.bind(this)}
defaultValue={this.props.initialValue}
disabled={this.props.readOnly}
style={{ height: this.props.height }}
diff --git a/superset-frontend/src/explore/components/controls/index.ts b/superset-frontend/src/explore/components/controls/index.ts
index f8321fde2f..46b70ac27d 100644
--- a/superset-frontend/src/explore/components/controls/index.ts
+++ b/superset-frontend/src/explore/components/controls/index.ts
@@ -46,6 +46,7 @@ import DndColumnSelectControl, {
DndColumnSelect,
DndFilterSelect,
DndMetricSelect,
+ DndColumnMetricSelect,
} from './DndColumnSelectControl';
import XAxisSortControl from './XAxisSortControl';
import CurrencyControl from './CurrencyControl';
@@ -80,6 +81,7 @@ const controlMap = {
DndColumnSelect,
DndFilterSelect,
DndMetricSelect,
+ DndColumnMetricSelect,
FixedOrMetricControl,
ColorBreakpointsControl,
HiddenControl,
diff --git a/superset/common/query_context_factory.py b/superset/common/query_context_factory.py
index 81f460c08b..0113886eda 100644
--- a/superset/common/query_context_factory.py
+++ b/superset/common/query_context_factory.py
@@ -27,6 +27,7 @@ from superset.common.query_object_factory import QueryObjectFactory
from superset.daos.chart import ChartDAO
from superset.daos.datasource import DatasourceDAO
from superset.models.slice import Slice
+from superset.superset_typing import Column
from superset.utils.core import DatasourceDict, DatasourceType, is_adhoc_column
if TYPE_CHECKING:
@@ -120,8 +121,82 @@ class QueryContextFactory: # pylint: disable=too-few-public-methods
) -> QueryObject:
self._apply_granularity(query_object, form_data, datasource)
self._apply_filters(query_object)
+ self._add_tooltip_columns(query_object, form_data)
return query_object
+ def _add_tooltip_columns(
+ self,
+ query_object: QueryObject,
+ form_data: dict[str, Any] | None,
+ ) -> None:
+ """Add tooltip columns to the query object."""
+ if not form_data:
+ return
+
+ tooltip_columns = self._extract_tooltip_columns(form_data)
+ if not tooltip_columns:
+ return
+
+ existing_columns = self._get_existing_column_names(query_object.columns)
+ self._append_missing_tooltip_columns(
+ query_object, tooltip_columns, existing_columns
+ )
+
+ def _get_existing_column_names(self, columns: list[Column]) -> set[str]:
+ """Extract column names from existing columns."""
+ column_names: set[str] = set()
+ for col in columns:
+ if isinstance(col, dict):
+ column_name = col.get("column_name")
+ if column_name and isinstance(column_name, str):
+ column_names.add(column_name)
+ elif isinstance(col, str):
+ column_names.add(col)
+ return column_names
+
+ def _append_missing_tooltip_columns(
+ self,
+ query_object: QueryObject,
+ tooltip_columns: list[str],
+ existing_columns: set[str],
+ ) -> None:
+ """Append missing tooltip columns to query object."""
+ for col in tooltip_columns:
+ if col not in existing_columns:
+ column_def = self._find_column_definition(query_object, col)
+ query_object.columns.append(column_def or col)
+
+ def _find_column_definition(
+ self, query_object: QueryObject, column_name: str
+ ) -> Any | None:
+ """Find column definition from datasource."""
+ if not (
+ query_object.datasource and hasattr(query_object.datasource, "columns")
+ ):
+ return None
+
+ return next(
+ (
+ c
+ for c in query_object.datasource.columns
+ if c.column_name == column_name
+ ),
+ None,
+ )
+
+ def _extract_tooltip_columns(self, form_data: dict[str, Any]) -> list[str]:
+ """Extract column names from tooltip_contents configuration."""
+ tooltip_columns = []
+ if tooltip_contents := form_data.get("tooltip_contents", []):
+ for item in tooltip_contents:
+ if isinstance(item, str):
+ tooltip_columns.append(item)
+ elif isinstance(item, dict) and item.get("item_type") == "column":
+ column_name = item.get("column_name")
+ if column_name:
+ tooltip_columns.append(column_name)
+ return tooltip_columns
+
def _apply_granularity( # noqa: C901
self,
query_object: QueryObject,
@@ -139,6 +214,8 @@ class QueryContextFactory: # pylint: disable=too-few-public-methods
filter_to_remove = None
if is_adhoc_column(x_axis): # type: ignore
x_axis = x_axis.get("sqlExpression")
+ if isinstance(x_axis, dict) and "sqlExpression" in x_axis:
+ x_axis = x_axis.get("sqlExpression")
if x_axis and x_axis in temporal_columns:
filter_to_remove = x_axis
x_axis_column = next(
diff --git a/superset/config.py b/superset/config.py
index 9290a4123f..dea23c8b43 100644
--- a/superset/config.py
+++ b/superset/config.py
@@ -945,7 +945,7 @@ CORS_OPTIONS: dict[Any, Any] = {
# Disabling this option is not recommended for security reasons. If you wish to allow
# valid safe elements that are not included in the default sanitization schema, use the
# HTML_SANITIZATION_SCHEMA_EXTENSIONS configuration.
-HTML_SANITIZATION = True
+HTML_SANITIZATION = False
# Use this configuration to extend the HTML sanitization schema.
# By default we use the GitHub schema defined in
diff --git a/superset/utils/core.py b/superset/utils/core.py
index bd0c4e4d38..d4a3806e92 100644
--- a/superset/utils/core.py
+++ b/superset/utils/core.py
@@ -1216,6 +1216,11 @@ def get_column_name(column: Column, verbose_map: dict[str, Any] | None = None) -
:return: String representation of column
:raises ValueError: if metric object is invalid
"""
+ if hasattr(column, "column_name"):
+ column_name = getattr(column, "column_name", "")
+ verbose_name = getattr(column, "verbose_name", "")
+ return verbose_name or column_name
+
if isinstance(column, dict):
if label := column.get("label"):
return label
diff --git a/superset/viz.py b/superset/viz.py
index b821033c24..b5a4d5217b 100644
--- a/superset/viz.py
+++ b/superset/viz.py
@@ -1653,6 +1653,66 @@ class BaseDeckGLViz(BaseViz):
credits = '<a href="https://uber.github.io/deck.gl/">deck.gl</a>'
spatial_control_keys: list[str] = []
+ def _extract_tooltip_columns(self) -> list[str]:
+ """Extract column names from tooltip_contents configuration."""
+ tooltip_columns = []
+ if tooltip_contents := self.form_data.get("tooltip_contents", []):
+ for item in tooltip_contents:
+ if isinstance(item, str):
+ tooltip_columns.append(item)
+ elif isinstance(item, dict) and item.get("item_type") == "column":
+ column_name = item.get("column_name")
+ if column_name:
+ tooltip_columns.append(column_name)
+ return tooltip_columns
+
+ def _add_tooltip_columns_to_query(
+ self, query_obj: QueryObjectDict, tooltip_columns: list[str]
+ ) -> None:
+ """Add tooltip columns to the appropriate query field."""
+ if not tooltip_columns:
+ return
+
+ if query_obj.get("metrics"):
+ existing_groupby = set(query_obj.get("groupby", []))
+ for col in tooltip_columns:
+ if col not in existing_groupby:
+ query_obj.setdefault("groupby", []).append(col)
+ else:
+ existing_columns = set(query_obj.get("columns", []))
+ for col in tooltip_columns:
+ if col not in existing_columns:
+ query_obj.setdefault("columns", []).append(col)
+
+ def _integrate_tooltip_columns(self, query_obj: QueryObjectDict) -> QueryObjectDict:
+ """Helper method to integrate tooltip columns into query object."""
+ tooltip_columns = self._extract_tooltip_columns()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+ return query_obj
+
+ def _add_tooltip_properties(
+ self, properties: dict[str, Any], data: dict[str, Any]
+ ) -> dict[str, Any]:
+ """Helper method to add tooltip fields to properties dictionary."""
+ tooltip_columns = self._extract_tooltip_columns()
+ for col in tooltip_columns:
+ if col in data:
+ properties[col] = data[col]
+ return properties
+
+ def _get_base_properties(self, data: dict[str, Any]) -> dict[str, Any]:
+ """Get base properties common to most deck.gl layers."""
+ return {
+ "position": data.get("spatial"),
+ "weight": (data.get(self.metric_label) if self.metric_label else None) or 1,
+ }
+
+ def _setup_metric_label(self) -> None:
+ """Setup metric label for the visualization."""
+ self.metric_label: str | None = ( # pylint: disable=attribute-defined-outside-init
+ utils.get_metric_name(self.metric) if self.metric else None
+ )
+
def __init__(
self, datasource: BaseDatasource, form_data: dict[str, Any], **kwargs: Any
) -> None:
@@ -1910,7 +1970,9 @@ class DeckScatterViz(BaseDeckGLViz):
"type": "fix",
"value": 500,
}
- return super().query_obj()
+
+ query_obj = super().query_obj()
+ return self._integrate_tooltip_columns(query_obj)
@deprecated(deprecated_in="3.0")
def get_metrics(self) -> list[str]:
@@ -1923,7 +1985,7 @@ class DeckScatterViz(BaseDeckGLViz):
@deprecated(deprecated_in="3.0")
def get_properties(self, data: dict[str, Any]) -> dict[str, Any]:
- return {
+ properties = {
"metric": data.get(self.metric_label) if self.metric_label else None,
"radius": (
self.fixed_value
@@ -1937,10 +1999,12 @@ class DeckScatterViz(BaseDeckGLViz):
DTTM_ALIAS: data.get(DTTM_ALIAS),
}
+ return self._add_tooltip_properties(properties, data)
+
@deprecated(deprecated_in="3.0")
def get_data(self, df: pd.DataFrame) -> VizData:
+ self._setup_metric_label()
# pylint: disable=attribute-defined-outside-init
- self.metric_label = utils.get_metric_name(self.metric) if self.metric else None
self.point_radius_fixed = self.form_data.get("point_radius_fixed")
self.fixed_value = None
self.dim = self.form_data.get("dimension")
@@ -1957,19 +2021,69 @@ class DeckScreengrid(BaseDeckGLViz):
spatial_control_keys = ["spatial"]
is_timeseries = True
+ def _extract_tooltip_columns(self) -> list[str]:
+ """Extract column names from tooltip_contents configuration."""
+ tooltip_columns = []
+ if tooltip_contents := self.form_data.get("tooltip_contents", []):
+ for item in tooltip_contents:
+ if isinstance(item, str):
+ tooltip_columns.append(item)
+ elif isinstance(item, dict) and item.get("item_type") == "column":
+ column_name = item.get("column_name")
+ if column_name:
+ tooltip_columns.append(column_name)
+ return tooltip_columns
+
+ def _add_tooltip_columns_to_query(
+ self, query_obj: QueryObjectDict, tooltip_columns: list[str]
+ ) -> None:
+ """Add tooltip columns to the appropriate query field."""
+ if not tooltip_columns:
+ return
+
+ if query_obj.get("metrics"):
+ # Add to groupby when metrics exist
+ existing_groupby = set(query_obj.get("groupby", []))
+ for col in tooltip_columns:
+ if col not in existing_groupby:
+ query_obj.setdefault("groupby", []).append(col)
+ else:
+ # Add to columns when no metrics
+ existing_columns = set(query_obj.get("columns", []))
+ for col in tooltip_columns:
+ if col not in existing_columns:
+ query_obj.setdefault("columns", []).append(col)
+
@deprecated(deprecated_in="3.0")
def query_obj(self) -> QueryObjectDict:
self.is_timeseries = bool(self.form_data.get("time_grain_sqla"))
- return super().query_obj()
+ tooltip_columns = self._extract_tooltip_columns()
+ query_obj = super().query_obj()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+ return query_obj
@deprecated(deprecated_in="3.0")
def get_properties(self, data: dict[str, Any]) -> dict[str, Any]:
- return {
+ properties = {
"position": data.get("spatial"),
"weight": (data.get(self.metric_label) if self.metric_label else None) or 1,
"__timestamp": data.get(DTTM_ALIAS) or data.get("__time"),
}
+ # For Screengrid, the frontend handles the cell-to-points mapping
+ # The backend just provides the aggregated data and tooltip fields
+
+ # For Screengrid, automatically collect all values for tooltip fields
+ # When user selects LON as tooltip field, {{ LON }} will show all LON values
+ tooltip_columns = self._extract_tooltip_columns()
+ for col in tooltip_columns:
+ if col in data:
+ # For Screengrid, each cell contains multiple points, provide as-is
+ # The frontend will handle displaying multiple values appropriately
+ properties[col] = data[col]
+
+ return properties
+
@deprecated(deprecated_in="3.0")
def get_data(self, df: pd.DataFrame) -> VizData:
self.metric_label = ( # pylint: disable=attribute-defined-outside-init
@@ -1979,18 +2093,31 @@ class DeckScreengrid(BaseDeckGLViz):
class DeckGrid(BaseDeckGLViz):
- """deck.gl's DeckLayer"""
+ """deck.gl's GridLayer"""
viz_type = "deck_grid"
verbose_name = _("Deck.gl - 3D Grid")
spatial_control_keys = ["spatial"]
+ @deprecated(deprecated_in="3.0")
+ def query_obj(self) -> QueryObjectDict:
+ tooltip_columns = self._extract_tooltip_columns()
+ query_obj = super().query_obj()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+ return query_obj
+
@deprecated(deprecated_in="3.0")
def get_properties(self, data: dict[str, Any]) -> dict[str, Any]:
- return {
+ properties = {
"position": data.get("spatial"),
"weight": (data.get(self.metric_label) if self.metric_label else None) or 1,
}
+ # Add tooltip fields to properties
+ tooltip_columns = self._extract_tooltip_columns()
+ for col in tooltip_columns:
+ if col in data:
+ properties[col] = data[col]
+ return properties
@deprecated(deprecated_in="3.0")
def get_data(self, df: pd.DataFrame) -> VizData:
@@ -2025,10 +2152,39 @@ class DeckPathViz(BaseDeckGLViz):
"geohash": geohash_to_json,
}
+ def _extract_tooltip_columns(self) -> list[str]:
+ tooltip_columns = []
+ if tooltip_contents := self.form_data.get("tooltip_contents", []):
+ for item in tooltip_contents:
+ if isinstance(item, str):
+ tooltip_columns.append(item)
+ elif isinstance(item, dict) and item.get("item_type") == "column":
+ column_name = item.get("column_name")
+ if column_name:
+ tooltip_columns.append(column_name)
+ return tooltip_columns
+
+ def _add_tooltip_columns_to_query(
+ self, query_obj: QueryObjectDict, tooltip_columns: list[str]
+ ) -> None:
+ if not tooltip_columns:
+ return
+ if query_obj.get("metrics"):
+ existing_groupby = set(query_obj.get("groupby", []))
+ for col in tooltip_columns:
+ if col not in existing_groupby:
+ query_obj.setdefault("groupby", []).append(col)
+ else:
+ existing_columns = set(query_obj.get("columns", []))
+ for col in tooltip_columns:
+ if col not in existing_columns:
+ query_obj.setdefault("columns", []).append(col)
+
@deprecated(deprecated_in="3.0")
def query_obj(self) -> QueryObjectDict:
# pylint: disable=attribute-defined-outside-init
self.is_timeseries = bool(self.form_data.get("time_grain_sqla"))
+ tooltip_columns = self._extract_tooltip_columns()
query_obj = super().query_obj()
self.metric = self.form_data.get("metric")
line_col = self.form_data.get("line_column")
@@ -2038,6 +2194,7 @@ class DeckPathViz(BaseDeckGLViz):
else:
self.has_metrics = False
query_obj["columns"].append(line_col)
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
return query_obj
@deprecated(deprecated_in="3.0")
@@ -2049,8 +2206,6 @@ class DeckPathViz(BaseDeckGLViz):
if self.form_data.get("reverse_long_lat"):
path = [(o[1], o[0]) for o in path]
data[self.deck_viz_key] = path
- if line_type != "geohash":
- del data[line_column]
data["__timestamp"] = data.get(DTTM_ALIAS) or data.get("__time")
return data
@@ -2069,14 +2224,44 @@ class DeckPolygon(DeckPathViz):
deck_viz_key = "polygon"
verbose_name = _("Deck.gl - Polygon")
+ def _extract_tooltip_columns(self) -> list[str]:
+ tooltip_columns = []
+ if tooltip_contents := self.form_data.get("tooltip_contents", []):
+ for item in tooltip_contents:
+ if isinstance(item, str):
+ tooltip_columns.append(item)
+ elif isinstance(item, dict) and item.get("item_type") == "column":
+ column_name = item.get("column_name")
+ if column_name:
+ tooltip_columns.append(column_name)
+ return tooltip_columns
+
+ def _add_tooltip_columns_to_query(
+ self, query_obj: QueryObjectDict, tooltip_columns: list[str]
+ ) -> None:
+ if not tooltip_columns:
+ return
+ if query_obj.get("metrics"):
+ existing_groupby = set(query_obj.get("groupby", []))
+ for col in tooltip_columns:
+ if col not in existing_groupby:
+ query_obj.setdefault("groupby", []).append(col)
+ else:
+ existing_columns = set(query_obj.get("columns", []))
+ for col in tooltip_columns:
+ if col not in existing_columns:
+ query_obj.setdefault("columns", []).append(col)
+
@deprecated(deprecated_in="3.0")
def query_obj(self) -> QueryObjectDict:
- # pylint: disable=attribute-defined-outside-init
self.elevation = self.form_data.get("point_radius_fixed") or {
"type": "fix",
"value": 500,
}
- return super().query_obj()
+ tooltip_columns = self._extract_tooltip_columns()
+ query_obj = super().query_obj()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+ return query_obj
@deprecated(deprecated_in="3.0")
def get_metrics(self) -> list[str]:
@@ -2105,12 +2290,25 @@ class DeckHex(BaseDeckGLViz):
verbose_name = _("Deck.gl - 3D HEX")
spatial_control_keys = ["spatial"]
+ @deprecated(deprecated_in="3.0")
+ def query_obj(self) -> QueryObjectDict:
+ tooltip_columns = self._extract_tooltip_columns()
+ query_obj = super().query_obj()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+ return query_obj
+
@deprecated(deprecated_in="3.0")
def get_properties(self, data: dict[str, Any]) -> dict[str, Any]:
- return {
+ properties = {
"position": data.get("spatial"),
"weight": (data.get(self.metric_label) if self.metric_label else None) or 1,
}
+ # Add tooltip fields to properties
+ tooltip_columns = self._extract_tooltip_columns()
+ for col in tooltip_columns:
+ if col in data:
+ properties[col] = data[col]
+ return properties
@deprecated(deprecated_in="3.0")
def get_data(self, df: pd.DataFrame) -> VizData:
@@ -2127,12 +2325,27 @@ class DeckHeatmap(BaseDeckGLViz):
verbose_name = _("Deck.gl - Heatmap")
spatial_control_keys = ["spatial"]
+ @deprecated(deprecated_in="3.0")
+ def query_obj(self) -> QueryObjectDict:
+ tooltip_columns = self._extract_tooltip_columns()
+ query_obj = super().query_obj()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+ return query_obj
+
+ @deprecated(deprecated_in="3.0")
def get_properties(self, data: dict[str, Any]) -> dict[str, Any]:
- return {
+ properties = {
"position": data.get("spatial"),
"weight": (data.get(self.metric_label) if self.metric_label else None) or 1,
}
+ tooltip_columns = self._extract_tooltip_columns()
+ for col in tooltip_columns:
+ if col in data:
+ properties[col] = data[col]
+
+ return properties
+ @deprecated(deprecated_in="3.0")
def get_data(self, df: pd.DataFrame) -> VizData:
self.metric_label = ( # pylint: disable=attribute-defined-outside-init
utils.get_metric_name(self.metric) if self.metric else None
@@ -2147,12 +2360,32 @@ class DeckContour(BaseDeckGLViz):
verbose_name = _("Deck.gl - Contour")
spatial_control_keys = ["spatial"]
+ @deprecated(deprecated_in="3.0")
+ def query_obj(self) -> QueryObjectDict:
+ query_obj = super().query_obj()
+
+ # Extract and add tooltip columns
+ tooltip_columns = self._extract_tooltip_columns()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+
+ return query_obj
+
def get_properties(self, data: dict[str, Any]) -> dict[str, Any]:
- return {
+ properties = {
"position": data.get("spatial"),
"weight": (data.get(self.metric_label) if self.metric_label else None) or 1,
+ # Include all original data for tooltip access
+ "_originalData": data,
}
+ # Add tooltip data at top level too for backward compatibility
+ tooltip_columns = self._extract_tooltip_columns()
+ for col in tooltip_columns:
+ if col in data:
+ properties[col] = data[col]
+
+ return properties
+
def get_data(self, df: pd.DataFrame) -> VizData:
self.metric_label = ( # pylint: disable=attribute-defined-outside-init
utils.get_metric_name(self.metric) if self.metric else None
@@ -2188,26 +2421,62 @@ class DeckArc(BaseDeckGLViz):
spatial_control_keys = ["start_spatial", "end_spatial"]
is_timeseries = True
+ def _extract_tooltip_columns(self) -> list[str]:
+ tooltip_columns = []
+ if tooltip_contents := self.form_data.get("tooltip_contents", []):
+ for item in tooltip_contents:
+ if isinstance(item, str):
+ tooltip_columns.append(item)
+ elif isinstance(item, dict) and item.get("item_type") == "column":
+ column_name = item.get("column_name")
+ if column_name:
+ tooltip_columns.append(column_name)
+ return tooltip_columns
+
+ def _add_tooltip_columns_to_query(
+ self, query_obj: QueryObjectDict, tooltip_columns: list[str]
+ ) -> None:
+ if not tooltip_columns:
+ return
+ if query_obj.get("metrics"):
+ existing_groupby = set(query_obj.get("groupby", []))
+ for col in tooltip_columns:
+ if col not in existing_groupby:
+ query_obj.setdefault("groupby", []).append(col)
+ else:
+ existing_columns = set(query_obj.get("columns", []))
+ for col in tooltip_columns:
+ if col not in existing_columns:
+ query_obj.setdefault("columns", []).append(col)
+
@deprecated(deprecated_in="3.0")
def query_obj(self) -> QueryObjectDict:
self.is_timeseries = bool(self.form_data.get("time_grain_sqla"))
- return super().query_obj()
+ tooltip_columns = self._extract_tooltip_columns()
+ query_obj = super().query_obj()
+ self._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+ return query_obj
@deprecated(deprecated_in="3.0")
def get_properties(self, data: dict[str, Any]) -> dict[str, Any]:
dim = self.form_data.get("dimension")
- return {
+ properties = {
"sourcePosition": data.get("start_spatial"),
"targetPosition": data.get("end_spatial"),
"cat_color": data.get(dim) if dim else None,
DTTM_ALIAS: data.get(DTTM_ALIAS),
}
+ # Add tooltip fields to properties
+ tooltip_columns = self._extract_tooltip_columns()
+ for col in tooltip_columns:
+ if col in data:
+ properties[col] = data[col]
+ return properties
@deprecated(deprecated_in="3.0")
def get_data(self, df: pd.DataFrame) -> VizData:
if df.empty:
return None
-
return {
"features": super().get_data(df)["features"],
"mapboxApiKey": current_app.config["MAPBOX_API_KEY"],
diff --git a/tests/integration_tests/viz_tests.py b/tests/integration_tests/viz_tests.py
index 2da9ef425d..23aab39147 100644
--- a/tests/integration_tests/viz_tests.py
+++ b/tests/integration_tests/viz_tests.py
@@ -660,6 +660,204 @@ class TestBaseDeckGLViz(SupersetTestCase):
result = test_viz_deckgl.get_metrics()
assert result == []
+ def test_extract_tooltip_columns_string_items(self):
+ """Test _extract_tooltip_columns with string items in tooltip_contents"""
+ form_data = {"tooltip_contents": ["column1", "column2", "column3"]}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._extract_tooltip_columns()
+ assert result == ["column1", "column2", "column3"]
+
+ def test_extract_tooltip_columns_dict_items(self):
+ """Test _extract_tooltip_columns with dict items in tooltip_contents"""
+ form_data = {
+ "tooltip_contents": [
+ {"item_type": "column", "column_name": "LAT"},
+ {"item_type": "column", "column_name": "LON"},
+ {"item_type": "metric", "metric_name": "count"},
+ {"item_type": "column", "column_name": "CITY"},
+ ]
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._extract_tooltip_columns()
+ assert result == ["LAT", "LON", "CITY"]
+
+ def test_extract_tooltip_columns_mixed_items(self):
+ """Test _extract_tooltip_columns with mixed string and dict items"""
+ form_data = {
+ "tooltip_contents": [
+ "string_column",
+ {"item_type": "column", "column_name": "dict_column"},
+ {
+ "item_type": "invalid",
+ "column_name": "invalid_column",
+ },
+ {"item_type": "column"},
+ ]
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._extract_tooltip_columns()
+ assert result == ["string_column", "dict_column"]
+
+ def test_extract_tooltip_columns_empty(self):
+ """Test _extract_tooltip_columns with empty or missing tooltip_contents"""
+ form_data = {"tooltip_contents": []}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._extract_tooltip_columns()
+ assert result == []
+
+ form_data = {}
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._extract_tooltip_columns()
+ assert result == []
+
+ def test_add_tooltip_columns_to_query_with_metrics(self):
+ """Test _add_tooltip_columns_to_query when query has metrics"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ query_obj = {
+ "metrics": ["count", "avg_value"],
+ "groupby": ["existing_column"],
+ "columns": [],
+ }
+ tooltip_columns = ["tooltip_col1", "tooltip_col2", "existing_column"]
+
+ test_viz._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+
+ # Should add to groupby, avoiding duplicates
+ assert "tooltip_col1" in query_obj["groupby"]
+ assert "tooltip_col2" in query_obj["groupby"]
+ assert query_obj["groupby"].count("existing_column") == 1 # No duplicate
+
+ def test_add_tooltip_columns_to_query_without_metrics(self):
+ """Test _add_tooltip_columns_to_query when query has no metrics"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ query_obj = {"metrics": [], "groupby": [], "columns": ["existing_column"]}
+ tooltip_columns = ["tooltip_col1", "tooltip_col2", "existing_column"]
+
+ test_viz._add_tooltip_columns_to_query(query_obj, tooltip_columns)
+
+ # Should add to columns, avoiding duplicates
+ assert "tooltip_col1" in query_obj["columns"]
+ assert "tooltip_col2" in query_obj["columns"]
+ assert query_obj["columns"].count("existing_column") == 1 # No duplicate
+
+ def test_add_tooltip_columns_to_query_empty_columns(self):
+ """Test _add_tooltip_columns_to_query with empty tooltip columns"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ query_obj = {"metrics": [], "groupby": [], "columns": []}
+ original_query_obj = query_obj.copy()
+
+ test_viz._add_tooltip_columns_to_query(query_obj, [])
+
+ # Should not modify query_obj
+ assert query_obj == original_query_obj
+
+ def test_integrate_tooltip_columns(self):
+ """Test _integrate_tooltip_columns helper method"""
+ form_data = {"tooltip_contents": ["LON", "LAT"]}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ query_obj = {"metrics": ["count"], "groupby": ["region"]}
+
+ result = test_viz._integrate_tooltip_columns(query_obj)
+
+ assert "LON" in result["groupby"]
+ assert "LAT" in result["groupby"]
+ assert "region" in result["groupby"]
+ assert result is query_obj # Should return the same object
+
+ def test_add_tooltip_properties(self):
+ """Test _add_tooltip_properties helper method"""
+ form_data = {"tooltip_contents": ["CITY", "POPULATION", "missing_column"]}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ properties = {"position": [1, 2], "weight": 100}
+ data = {"CITY": "New York", "POPULATION": 8000000, "other_column": "value"}
+
+ result = test_viz._add_tooltip_properties(properties, data)
+
+ assert result["CITY"] == "New York"
+ assert result["POPULATION"] == 8000000
+ assert "missing_column" not in result # Missing column should not be added
+ assert "other_column" not in result # Non-tooltip column should not be added
+ assert result["position"] == [1, 2] # Original properties should remain
+ assert result["weight"] == 100
+ assert result is properties # Should return the same object
+
+ def test_get_base_properties(self):
+ """Test _get_base_properties helper method"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+ test_viz.metric_label = "test_metric"
+
+ data = {"spatial": [10.5, 20.3], "test_metric": 42, "other_field": "value"}
+
+ result = test_viz._get_base_properties(data)
+
+ assert result["position"] == [10.5, 20.3]
+ assert result["weight"] == 42
+ assert len(result) == 2 # Should only have position and weight
+
+ def test_get_base_properties_no_metric(self):
+ """Test _get_base_properties when no metric is available"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+ test_viz.metric_label = None
+
+ data = {"spatial": [10.5, 20.3]}
+
+ result = test_viz._get_base_properties(data)
+
+ assert result["position"] == [10.5, 20.3]
+ assert result["weight"] == 1 # Should default to 1
+
+ def test_setup_metric_label(self):
+ """Test _setup_metric_label helper method"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+ test_viz.metric = "SUM(sales)"
+
+ with patch("superset.utils.core.get_metric_name") as mock_get_metric_name:
+ mock_get_metric_name.return_value = "sum__sales"
+
+ test_viz._setup_metric_label()
+
+ assert test_viz.metric_label == "sum__sales"
+ mock_get_metric_name.assert_called_once_with("SUM(sales)")
+
+ def test_setup_metric_label_no_metric(self):
+ """Test _setup_metric_label when metric is None"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+ test_viz.metric = None
+
+ test_viz._setup_metric_label()
+
+ assert test_viz.metric_label is None
+
def test_scatterviz_get_metrics(self):
form_data = load_fixture("deck_path_form_data.json")
datasource = self.get_datasource_mock()
@@ -762,6 +960,183 @@ class TestBaseDeckGLViz(SupersetTestCase):
with self.assertRaises(SpatialException): # noqa: PT027
test_viz_deckgl.parse_coordinates("fldkjsalkj,fdlaskjfjadlksj")
+ def test_deckscatter_query_obj_integration(self):
+ """Test DeckScatterViz query_obj uses new tooltip integration"""
+ form_data = {
+ "tooltip_contents": ["CITY", "POPULATION"],
+ "time_grain_sqla": "P1D",
+ "point_radius_fixed": {"type": "fix", "value": 500},
+ "spatial": {
+ "type": "latlong",
+ "lonCol": "longitude",
+ "latCol": "latitude",
+ },
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.DeckScatterViz(datasource, form_data)
+
+ with patch.object(test_viz, "_integrate_tooltip_columns") as mock_integrate:
+ mock_integrate.return_value = {"mocked": "result"}
+
+ result = test_viz.query_obj()
+
+ # Should call the new helper method
+ mock_integrate.assert_called_once()
+ assert result == {"mocked": "result"}
+
+ # Should set up instance variables
+ assert test_viz.is_timeseries is True
+ assert test_viz.point_radius_fixed == {"type": "fix", "value": 500}
+
+ def test_deckscatter_query_obj_no_time_grain(self):
+ """Test DeckScatterViz query_obj when time_grain_sqla is not set"""
+ form_data = {
+ "tooltip_contents": ["CITY"],
+ "point_radius_fixed": {"type": "metric", "value": "count"},
+ "spatial": {
+ "type": "latlong",
+ "lonCol": "longitude",
+ "latCol": "latitude",
+ },
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.DeckScatterViz(datasource, form_data)
+
+ with patch.object(test_viz, "_integrate_tooltip_columns") as mock_integrate:
+ mock_integrate.return_value = {"result": "data"}
+
+ test_viz.query_obj()
+
+ # Should set timeseries to False when no time_grain_sqla
+ assert test_viz.is_timeseries is False
+
+ def test_deckscatter_get_properties_uses_helper(self):
+ """Test DeckScatterViz get_properties uses new helper method"""
+ form_data = {"tooltip_contents": ["CITY", "STATE"], "dimension": "region"}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.DeckScatterViz(datasource, form_data)
+ test_viz.metric_label = "count"
+ test_viz.fixed_value = 10
+ test_viz.dim = "region"
+
+ data = {
+ "spatial": [40.7, -74.0],
+ "count": 100,
+ "region": "northeast",
+ "CITY": "New York",
+ "STATE": "NY",
+ "__timestamp": "2023-01-01",
+ }
+
+ with patch.object(test_viz, "_add_tooltip_properties") as mock_add_tooltip:
+ mock_add_tooltip.return_value = {"final": "result"}
+
+ result = test_viz.get_properties(data)
+
+ expected_base_properties = {
+ "metric": 100,
+ "radius": 10,
+ "cat_color": "northeast",
+ "position": [40.7, -74.0],
+ "__timestamp": "2023-01-01",
+ }
+ mock_add_tooltip.assert_called_once_with(expected_base_properties, data)
+ assert result == {"final": "result"}
+
+ def test_deckscatter_get_data_uses_setup_metric_label(self):
+ """Test DeckScatterViz get_data uses new _setup_metric_label helper"""
+ form_data = {
+ "point_radius_fixed": {"type": "metric", "value": "avg_sales"},
+ "dimension": "category",
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.DeckScatterViz(datasource, form_data)
+ test_df = pd.DataFrame({"col1": [1, 2], "col2": [3, 4]})
+
+ with patch.object(test_viz, "_setup_metric_label") as mock_setup:
+ with patch("superset.viz.BaseDeckGLViz.get_data") as mock_super_get_data:
+ mock_super_get_data.return_value = {"test": "data"}
+
+ result = test_viz.get_data(test_df)
+
+ mock_setup.assert_called_once()
+
+ assert test_viz.point_radius_fixed == {
+ "type": "metric",
+ "value": "avg_sales",
+ }
+ assert test_viz.fixed_value is None
+ assert test_viz.dim == "category"
+
+ mock_super_get_data.assert_called_once_with(test_df)
+ assert result == {"test": "data"}
+
+ def test_deckscatter_get_data_with_fixed_radius(self):
+ """Test DeckScatterViz get_data with fixed radius type"""
+ form_data = {
+ "point_radius_fixed": {"type": "fix", "value": 25},
+ "dimension": "location",
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.DeckScatterViz(datasource, form_data)
+ test_df = pd.DataFrame({"col1": [1, 2]})
+
+ with patch.object(test_viz, "_setup_metric_label"):
+ with patch("superset.viz.BaseDeckGLViz.get_data") as mock_super_get_data:
+ mock_super_get_data.return_value = {"result": "ok"}
+
+ test_viz.get_data(test_df)
+
+ # Should set fixed_value when type is not 'metric'
+ assert test_viz.fixed_value == 25
+
+ def test_tooltip_integration_end_to_end(self):
+ """Test complete tooltip integration from query_obj to get_properties"""
+ form_data = {
+ "tooltip_contents": ["CITY", "POPULATION"],
+ "size": "count",
+ "time_grain_sqla": None,
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.DeckScatterViz(datasource, form_data)
+
+ with patch("superset.viz.BaseDeckGLViz.query_obj") as mock_super_query:
+ mock_super_query.return_value = {
+ "metrics": ["count"],
+ "groupby": ["region"],
+ "columns": [],
+ }
+
+ query_result = test_viz.query_obj()
+
+ # Should have added tooltip columns to groupby
+ assert "CITY" in query_result["groupby"]
+ assert "POPULATION" in query_result["groupby"]
+ assert "region" in query_result["groupby"]
+
+ test_viz.metric_label = "count"
+ test_viz.fixed_value = None
+ test_viz.dim = "region"
+
+ data = {
+ "spatial": [40.7, -74.0],
+ "count": 5000,
+ "region": "northeast",
+ "CITY": "New York",
+ "POPULATION": 8000000,
+ "__timestamp": "2023-01-01",
+ }
+
+ properties_result = test_viz.get_properties(data)
+
+ # Should include both base properties and tooltip properties
+ assert properties_result["position"] == [40.7, -74.0]
+ assert properties_result["metric"] == 5000
+ assert properties_result["cat_color"] == "northeast"
+ assert properties_result["__timestamp"] == "2023-01-01"
+ assert properties_result["CITY"] == "New York"
+ assert properties_result["POPULATION"] == 8000000
+
def test_filter_nulls(self):
test_form_data = {
"latlong_key": {"type": "latlong", "lonCol": "lon", "latCol": "lat"},
@@ -892,94 +1267,106 @@ class TestBaseDeckGLViz(SupersetTestCase):
assert result is False
def test_should_apply_layer_filtering_false_missing_adhoc_filters(self):
- """Test _should_apply_layer_filtering returns False when adhoc_filters is
- missing."""
- datasource = self.get_datasource_mock()
- test_viz = viz.BaseDeckGLViz(datasource, {})
-
+ """Test _should_apply_layer_filtering returns False when
+ adhoc_filters missing"""
form_data = {"slice_id": 123}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
result = test_viz._should_apply_layer_filtering(form_data)
+
assert result is False
def test_should_apply_layer_filtering_false_no_layer_scoped_filters(self):
- """Test _should_apply_layer_filtering returns False when no layer scoped
- filters exist."""
- datasource = self.get_datasource_mock()
- test_viz = viz.BaseDeckGLViz(datasource, {})
-
+ """Test _should_apply_layer_filtering returns False when no
+ layer scoped filters"""
form_data = {
"slice_id": 123,
- "adhoc_filters": [{"clause": "WHERE", "subject": "col1"}],
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ }
+ ],
}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
result = test_viz._should_apply_layer_filtering(form_data)
+
assert result is False
def test_has_layer_scoped_filters_true_with_dict(self):
- """Test _has_layer_scoped_filters returns True when filter dict has
- layerFilterScope."""
- datasource = self.get_datasource_mock()
- test_viz = viz.BaseDeckGLViz(datasource, {})
-
+ """Test _has_layer_scoped_filters returns True when filter
+ has layerFilterScope"""
form_data = {
- "adhoc_filters": [{"layerFilterScope": [0, 1]}, {"clause": "WHERE"}]
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [0, 1],
+ }
+ ],
}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
result = test_viz._has_layer_scoped_filters(form_data)
+
assert result is True
def test_has_layer_scoped_filters_true_with_non_none_value(self):
- """Test _has_layer_scoped_filters returns True when layerFilterScope is not
- None."""
- datasource = self.get_datasource_mock()
- test_viz = viz.BaseDeckGLViz(datasource, {})
-
+ """Test _has_layer_scoped_filters returns True when layerFilterScope not None"""
form_data = {
"adhoc_filters": [
- {"layerFilterScope": []}, # Empty list is not None
- {"clause": "WHERE"},
- ]
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [],
+ }
+ ],
}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
result = test_viz._has_layer_scoped_filters(form_data)
+
assert result is True
def test_has_layer_scoped_filters_false_none_value(self):
- """Test _has_layer_scoped_filters returns False when layerFilterScope is
- None."""
- datasource = self.get_datasource_mock()
- test_viz = viz.BaseDeckGLViz(datasource, {})
-
+ """Test _has_layer_scoped_filters returns False when layerFilterScope is None"""
form_data = {"adhoc_filters": [{"layerFilterScope": None}, {"clause": "WHERE"}]}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
result = test_viz._has_layer_scoped_filters(form_data)
+
assert result is False
def test_has_layer_scoped_filters_false_no_scoped_filters(self):
- """Test _has_layer_scoped_filters returns False when no filters have
- layerFilterScope."""
- datasource = self.get_datasource_mock()
- test_viz = viz.BaseDeckGLViz(datasource, {})
-
+ """Test _has_layer_scoped_filters returns False when no filters
+ have layerFilterScope"""
form_data = {
"adhoc_filters": [
- {"clause": "WHERE", "subject": "col1"},
- {"clause": "WHERE", "subject": "col2"},
- ]
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ }
+ ],
}
-
- result = test_viz._has_layer_scoped_filters(form_data)
- assert result is False
-
- def test_has_layer_scoped_filters_empty_filters(self):
- """Test _has_layer_scoped_filters returns False when adhoc_filters is empty."""
datasource = self.get_datasource_mock()
- test_viz = viz.BaseDeckGLViz(datasource, {})
-
- form_data = {"adhoc_filters": []}
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
result = test_viz._has_layer_scoped_filters(form_data)
+
assert result is False
def test_apply_multilayer_filtering_filters_by_layer_scope(self):
@@ -1140,14 +1527,11 @@ class TestBaseDeckGLViz(SupersetTestCase):
def test_get_filter_layer_scope_object_without_attribute(self):
"""Test _get_filter_layer_scope with object missing layerFilterScope
attribute."""
+ filter_item = Mock()
+ del filter_item.layerFilterScope
datasource = self.get_datasource_mock()
test_viz = viz.BaseDeckGLViz(datasource, {})
- from unittest.mock import Mock
-
- filter_item = Mock()
- del filter_item.layerFilterScope # Remove the attribute
-
result = test_viz._get_filter_layer_scope(filter_item)
assert result is None
@@ -1431,6 +1815,397 @@ class TestDeckGLMultiLayer(SupersetTestCase):
assert result["slices"] == []
assert result["mapboxApiKey"] == "test_key"
+ def test_get_base_properties_no_metric(self):
+ """Test _get_base_properties when metric_label is None"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+ test_viz.metric_label = None
+
+ data = {"spatial": [10.5, 20.3], "other_field": "value"}
+
+ result = test_viz._get_base_properties(data)
+
+ assert result["position"] == [10.5, 20.3]
+ assert result["weight"] == 1
+ assert len(result) == 2
+
+ def test_setup_metric_label(self):
+ """Test _setup_metric_label with metric"""
+ form_data = {"size": "test_metric"}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+ test_viz.metric = Mock()
+ test_viz.metric.value = "test_metric"
+
+ with patch("superset.viz.utils.get_metric_name") as mock_get_name:
+ mock_get_name.return_value = "test_metric"
+ test_viz._setup_metric_label()
+
+ assert test_viz.metric_label == "test_metric"
+ mock_get_name.assert_called_once_with(test_viz.metric)
+
+ def test_setup_metric_label_no_metric(self):
+ """Test _setup_metric_label without metric"""
+ form_data = {}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+ test_viz.metric = None
+
+ test_viz._setup_metric_label()
+
+ assert test_viz.metric_label is None
+
+ def test_should_apply_layer_filtering_true(self):
+ """Test _should_apply_layer_filtering returns True when conditions are met"""
+ form_data = {
+ "slice_id": 123,
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [0, 1],
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._should_apply_layer_filtering(form_data)
+
+ assert result is True
+
+ def test_should_apply_layer_filtering_false_missing_slice_id(self):
+ """Test _should_apply_layer_filtering returns False when slice_id is missing"""
+ form_data = {
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [0, 1],
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._should_apply_layer_filtering(form_data)
+
+ assert result is False
+
+ def test_should_apply_layer_filtering_false_missing_adhoc_filters(self):
+ """Test _should_apply_layer_filtering returns False when
+ adhoc_filters missing"""
+ form_data = {"slice_id": 123}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._should_apply_layer_filtering(form_data)
+
+ assert result is False
+
+ def test_should_apply_layer_filtering_false_no_layer_scoped_filters(self):
+ """Test _should_apply_layer_filtering returns False when no layer
+ scoped filters"""
+ form_data = {
+ "slice_id": 123,
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._should_apply_layer_filtering(form_data)
+
+ assert result is False
+
+ def test_has_layer_scoped_filters_true_with_dict(self):
+ """Test _has_layer_scoped_filters returns True when filter
+ has layerFilterScope"""
+ form_data = {
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [0, 1],
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._has_layer_scoped_filters(form_data)
+
+ assert result is True
+
+ def test_has_layer_scoped_filters_true_with_non_none_value(self):
+ """Test _has_layer_scoped_filters returns True when layerFilterScope not None"""
+ form_data = {
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [],
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._has_layer_scoped_filters(form_data)
+
+ assert result is True
+
+ def test_has_layer_scoped_filters_false_none_value(self):
+ """Test _has_layer_scoped_filters returns False when layerFilterScope is None"""
+ form_data = {
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": None,
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._has_layer_scoped_filters(form_data)
+
+ assert result is False
+
+ def test_has_layer_scoped_filters_false_no_scoped_filters(self):
+ """Test _has_layer_scoped_filters returns False when no filters have
+ layerFilterScope"""
+ form_data = {
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._has_layer_scoped_filters(form_data)
+
+ assert result is False
+
+ def test_apply_multilayer_filtering_filters_by_layer_scope(self):
+ """Test _apply_multilayer_filtering filters adhoc_filters by layer scope"""
+ form_data = {
+ "slice_id": 123,
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [0, 1],
+ "deck_slices": [123, 456],
+ },
+ {
+ "clause": "WHERE",
+ "subject": "col2",
+ "operator": "!=",
+ "comparator": "value2",
+ "layerFilterScope": [1],
+ "deck_slices": [123, 456],
+ },
+ {
+ "clause": "WHERE",
+ "subject": "col3",
+ "operator": ">",
+ "comparator": "value3",
+ "layerFilterScope": [2],
+ "deck_slices": [123, 456],
+ },
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._apply_multilayer_filtering(form_data)
+
+ assert len(result["adhoc_filters"]) == 1
+ assert result["adhoc_filters"][0]["subject"] == "col1"
+
+ def test_apply_multilayer_filtering_no_deck_slices(self):
+ """Test _apply_multilayer_filtering when no deck_slices in filters"""
+ form_data = {
+ "slice_id": 123,
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [0],
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._apply_multilayer_filtering(form_data)
+
+ assert len(result["adhoc_filters"]) == 1
+ assert result["adhoc_filters"][0]["subject"] == "col1"
+
+ def test_apply_multilayer_filtering_slice_not_in_deck_slices(self):
+ """Test _apply_multilayer_filtering when slice_id not in deck_slices"""
+ form_data = {
+ "slice_id": 999,
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "layerFilterScope": [0],
+ "deck_slices": [123, 456],
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._apply_multilayer_filtering(form_data)
+
+ # Should return original form_data unchanged when slice_id not in deck_slices
+ assert result == form_data
+
+ def test_get_deck_slices_from_filters_found(self):
+ """Test _get_deck_slices_from_filters when deck_slices found"""
+ form_data = {
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ "deck_slices": [123, 456],
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._get_deck_slices_from_filters(form_data)
+
+ assert result == [123, 456]
+
+ def test_get_deck_slices_from_filters_not_found(self):
+ """Test _get_deck_slices_from_filters when no deck_slices found"""
+ form_data = {
+ "adhoc_filters": [
+ {
+ "clause": "WHERE",
+ "subject": "col1",
+ "operator": "==",
+ "comparator": "value1",
+ }
+ ],
+ }
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._get_deck_slices_from_filters(form_data)
+
+ assert result is None
+
+ def test_get_deck_slices_from_filters_empty_filters(self):
+ """Test _get_deck_slices_from_filters with empty adhoc_filters"""
+ form_data = {"adhoc_filters": []}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, form_data)
+
+ result = test_viz._get_deck_slices_from_filters(form_data)
+
+ assert result is None
+
+ def test_get_filter_layer_scope_dict(self):
+ """Test _get_filter_layer_scope with dict filter"""
+ filter_item = {"layerFilterScope": [0, 1]}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, {})
+
+ result = test_viz._get_filter_layer_scope(filter_item)
+
+ assert result == [0, 1]
+
+ def test_get_filter_layer_scope_dict_none(self):
+ """Test _get_filter_layer_scope with dict filter having None layerFilterScope"""
+ filter_item = {"layerFilterScope": None}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, {})
+
+ result = test_viz._get_filter_layer_scope(filter_item)
+
+ assert result is None
+
+ def test_get_filter_layer_scope_dict_missing_key(self):
+ """Test _get_filter_layer_scope with dict filter missing layerFilterScope key"""
+ filter_item = {"other_key": "value"}
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, {})
+
+ result = test_viz._get_filter_layer_scope(filter_item)
+
+ assert result is None
+
+ def test_get_filter_layer_scope_object_with_attribute(self):
+ """Test _get_filter_layer_scope with object having layerFilterScope attribute"""
+ filter_item = Mock()
+ filter_item.layerFilterScope = [0, 1]
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, {})
+
+ result = test_viz._get_filter_layer_scope(filter_item)
+
+ assert result == [0, 1]
+
+ def test_get_filter_layer_scope_object_without_attribute(self):
+ """Test _get_filter_layer_scope with object missing
+ layerFilterScope attribute"""
+ filter_item = Mock()
+ del filter_item.layerFilterScope
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, {})
+
+ result = test_viz._get_filter_layer_scope(filter_item)
+
+ assert result is None
+
+ def test_get_filter_layer_scope_non_dict_non_object(self):
+ """Test _get_filter_layer_scope with non-dict, non-object filter"""
+ filter_item = "string_filter"
+ datasource = self.get_datasource_mock()
+ test_viz = viz.BaseDeckGLViz(datasource, {})
+
+ result = test_viz._get_filter_layer_scope(filter_item)
+
+ assert result is None
+
class TestTimeSeriesViz(SupersetTestCase):
def test_timeseries_unicode_data(self):
diff --git a/tests/unit_tests/common/test_query_context_factory.py b/tests/unit_tests/common/test_query_context_factory.py
new file mode 100644
index 0000000000..c334ee3e42
--- /dev/null
+++ b/tests/unit_tests/common/test_query_context_factory.py
@@ -0,0 +1,438 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from unittest.mock import Mock, patch
+
+from superset.common.query_context_factory import QueryContextFactory
+from superset.common.query_object import QueryObject
+from superset.models.slice import Slice
+
+
+class TestQueryContextFactory:
+ def setup_method(self):
+ self.factory = QueryContextFactory()
+
+ def test_extract_tooltip_columns_string_items(self):
+ """Test _extract_tooltip_columns with string items in tooltip_contents"""
+ form_data = {"tooltip_contents": ["column1", "column2", "column3"]}
+
+ result = self.factory._extract_tooltip_columns(form_data)
+
+ assert result == ["column1", "column2", "column3"]
+
+ def test_extract_tooltip_columns_dict_items(self):
+ """Test _extract_tooltip_columns with dict items in tooltip_contents"""
+ form_data = {
+ "tooltip_contents": [
+ {"item_type": "column", "column_name": "LAT"},
+ {"item_type": "column", "column_name": "LON"},
+ {"item_type": "metric", "metric_name": "count"},
+ {"item_type": "column", "column_name": "CITY"},
+ ]
+ }
+
+ result = self.factory._extract_tooltip_columns(form_data)
+
+ assert result == ["LAT", "LON", "CITY"]
+
+ def test_extract_tooltip_columns_mixed_items(self):
+ """Test _extract_tooltip_columns with mixed string and dict items"""
+ form_data = {
+ "tooltip_contents": [
+ "string_column",
+ {"item_type": "column", "column_name": "dict_column"},
+ {"item_type": "invalid", "column_name": "invalid_column"},
+ {"item_type": "column"},
+ ]
+ }
+
+ result = self.factory._extract_tooltip_columns(form_data)
+
+ assert result == ["string_column", "dict_column"]
+
+ def test_extract_tooltip_columns_empty(self):
+ """Test _extract_tooltip_columns with empty or missing tooltip_contents"""
+ form_data = {"tooltip_contents": []}
+
+ result = self.factory._extract_tooltip_columns(form_data)
+
+ assert result == []
+
+ form_data = {}
+
+ result = self.factory._extract_tooltip_columns(form_data)
+
+ assert result == []
+
+ def test_get_existing_column_names_dict_columns(self):
+ """Test _get_existing_column_names with dict columns"""
+ columns = [
+ {"column_name": "col1"},
+ {"column_name": "col2"},
+ {"column_name": "col3"},
+ ]
+
+ result = self.factory._get_existing_column_names(columns)
+
+ assert result == {"col1", "col2", "col3"}
+
+ def test_get_existing_column_names_string_columns(self):
+ """Test _get_existing_column_names with string columns"""
+ columns = ["col1", "col2", "col3"]
+
+ result = self.factory._get_existing_column_names(columns)
+
+ assert result == {"col1", "col2", "col3"}
+
+ def test_get_existing_column_names_mixed_columns(self):
+ """Test _get_existing_column_names with mixed column types"""
+ columns = [
+ {"column_name": "dict_col1"},
+ "string_col1",
+ {"column_name": "dict_col2"},
+ "string_col2",
+ ]
+
+ result = self.factory._get_existing_column_names(columns)
+
+ assert result == {"dict_col1", "string_col1", "dict_col2", "string_col2"}
+
+ def test_get_existing_column_names_empty(self):
+ """Test _get_existing_column_names with empty columns"""
+ columns = []
+
+ result = self.factory._get_existing_column_names(columns)
+
+ assert result == set()
+
+ def test_get_existing_column_names_invalid_dict(self):
+ """Test _get_existing_column_names with invalid dict columns"""
+ columns = [
+ {"column_name": "valid_col"},
+ {"invalid_key": "invalid_col"},
+ {"column_name": None},
+ {"column_name": 123},
+ ]
+
+ result = self.factory._get_existing_column_names(columns)
+
+ assert result == {"valid_col"}
+
+ def test_append_missing_tooltip_columns(self):
+ """Test _append_missing_tooltip_columns"""
+ query_object = Mock(spec=QueryObject)
+ query_object.columns = []
+
+ tooltip_columns = ["tooltip_col1", "tooltip_col2", "existing_col"]
+ existing_columns = {"existing_col"}
+
+ with patch.object(self.factory, "_find_column_definition") as mock_find:
+ mock_find.side_effect = (
+ lambda qo, col: f"def_{col}" if col != "tooltip_col2" else None
+ )
+
+ self.factory._append_missing_tooltip_columns(
+ query_object, tooltip_columns, existing_columns
+ )
+
+ assert len(query_object.columns) == 2
+ assert "def_tooltip_col1" in query_object.columns
+ assert "tooltip_col2" in query_object.columns
+ assert "existing_col" not in query_object.columns
+
+ def test_find_column_definition_found(self):
+ """Test _find_column_definition when column is found"""
+ query_object = Mock(spec=QueryObject)
+ query_object.datasource = Mock()
+ query_object.datasource.columns = [
+ Mock(column_name="found_col"),
+ Mock(column_name="other_col"),
+ ]
+
+ result = self.factory._find_column_definition(query_object, "found_col")
+
+ assert result.column_name == "found_col"
+
+ def test_find_column_definition_not_found(self):
+ """Test _find_column_definition when column is not found"""
+ query_object = Mock(spec=QueryObject)
+ query_object.datasource = Mock()
+ query_object.datasource.columns = [
+ Mock(column_name="other_col1"),
+ Mock(column_name="other_col2"),
+ ]
+
+ result = self.factory._find_column_definition(query_object, "missing_col")
+
+ assert result is None
+
+ def test_find_column_definition_no_datasource(self):
+ """Test _find_column_definition when datasource is None"""
+ query_object = Mock(spec=QueryObject)
+ query_object.datasource = None
+
+ result = self.factory._find_column_definition(query_object, "any_col")
+
+ assert result is None
+
+ def test_find_column_definition_no_columns_attr(self):
+ """Test _find_column_definition when datasource has no columns attribute"""
+ query_object = Mock(spec=QueryObject)
+ query_object.datasource = Mock()
+ del query_object.datasource.columns
+
+ result = self.factory._find_column_definition(query_object, "any_col")
+
+ assert result is None
+
+ def test_add_tooltip_columns_no_form_data(self):
+ """Test _add_tooltip_columns with no form_data"""
+ query_object = Mock(spec=QueryObject)
+ query_object.columns = Mock()
+ query_object.columns.append = Mock()
+
+ self.factory._add_tooltip_columns(query_object, None)
+
+ query_object.columns.append.assert_not_called()
+
+ def test_add_tooltip_columns_no_tooltip_columns(self):
+ """Test _add_tooltip_columns with no tooltip columns"""
+ query_object = Mock(spec=QueryObject)
+ query_object.columns = Mock()
+ query_object.columns.append = Mock()
+ form_data = {"tooltip_contents": []}
+
+ self.factory._add_tooltip_columns(query_object, form_data)
+
+ query_object.columns.append.assert_not_called()
+
+ def test_add_tooltip_columns_with_tooltip_columns(self):
+ """Test _add_tooltip_columns with tooltip columns"""
+ query_object = Mock(spec=QueryObject)
+ query_object.columns = []
+ form_data = {"tooltip_contents": ["tooltip_col1", "tooltip_col2"]}
+
+ with (
+ patch.object(self.factory, "_extract_tooltip_columns") as mock_extract,
+ patch.object(
+ self.factory, "_get_existing_column_names"
+ ) as mock_get_existing,
+ patch.object(
+ self.factory, "_append_missing_tooltip_columns"
+ ) as mock_append,
+ ):
+ mock_extract.return_value = ["tooltip_col1", "tooltip_col2"]
+ mock_get_existing.return_value = set()
+
+ self.factory._add_tooltip_columns(query_object, form_data)
+
+ mock_extract.assert_called_once_with(form_data)
+ mock_get_existing.assert_called_once_with(query_object.columns)
+ mock_append.assert_called_once_with(
+ query_object, ["tooltip_col1", "tooltip_col2"], set()
+ )
+
+ @patch("superset.common.query_context_factory.DatasourceDAO")
+ def test_convert_to_model(self, mock_dao):
+ """Test _convert_to_model"""
+ datasource = {"type": "table", "id": 123}
+ mock_dao.get_datasource.return_value = Mock()
+
+ result = self.factory._convert_to_model(datasource)
+
+ mock_dao.get_datasource.assert_called_once()
+ assert result is not None
+
+ @patch("superset.common.query_context_factory.ChartDAO")
+ def test_get_slice_found(self, mock_dao):
+ """Test _get_slice when slice is found"""
+ slice_id = 123
+ mock_slice = Mock(spec=Slice)
+ mock_dao.find_by_id.return_value = mock_slice
+
+ result = self.factory._get_slice(slice_id)
+
+ mock_dao.find_by_id.assert_called_once_with(slice_id)
+ assert result == mock_slice
+
+ @patch("superset.common.query_context_factory.ChartDAO")
+ def test_get_slice_not_found(self, mock_dao):
+ """Test _get_slice when slice is not found"""
+ slice_id = 123
+ mock_dao.find_by_id.return_value = None
+
+ result = self.factory._get_slice(slice_id)
+
+ mock_dao.find_by_id.assert_called_once_with(slice_id)
+ assert result is None
+
+ def test_apply_granularity_with_x_axis(self):
+ """Test _apply_granularity with x_axis in form_data"""
+ query_object = Mock(spec=QueryObject)
+ query_object.granularity = "P1D"
+ query_object.columns = ["ds", "other_col"]
+ query_object.post_processing = []
+ query_object.filter = []
+
+ form_data = {"x_axis": "ds"}
+ datasource = Mock()
+ datasource.columns = [{"column_name": "ds", "is_dttm": True}]
+
+ self.factory._apply_granularity(query_object, form_data, datasource)
+
+ assert query_object.columns == ["P1D", "other_col"]
+
+ def test_apply_granularity_with_x_axis_dict(self):
+ """Test _apply_granularity with x_axis as dict in form_data"""
+ query_object = Mock(spec=QueryObject)
+ query_object.granularity = "P1D"
+ query_object.columns = [{"sqlExpression": "ds", "label": "ds"}, "other_col"]
+ query_object.post_processing = []
+ query_object.filter = []
+
+ form_data = {"x_axis": {"sqlExpression": "ds"}}
+ datasource = Mock()
+ datasource.columns = [{"column_name": "ds", "is_dttm": True}]
+
+ self.factory._apply_granularity(query_object, form_data, datasource)
+
+ assert query_object.columns[0]["sqlExpression"] == "P1D"
+ assert query_object.columns[0]["label"] == "P1D"
+
+ def test_apply_granularity_with_pivot_post_processing(self):
+ """Test _apply_granularity with pivot post_processing"""
+ query_object = Mock(spec=QueryObject)
+ query_object.granularity = "P1D"
+ query_object.columns = ["ds", "other_col"]
+ query_object.post_processing = [
+ {"operation": "pivot", "options": {"index": ["ds"]}}
+ ]
+ query_object.filter = []
+
+ form_data = {"x_axis": "ds"}
+ datasource = Mock()
+ datasource.columns = [{"column_name": "ds", "is_dttm": True}]
+
+ self.factory._apply_granularity(query_object, form_data, datasource)
+
+ assert query_object.post_processing[0]["options"]["index"] == ["P1D"]
+
+ def test_apply_granularity_with_temporal_filter(self):
+ """Test _apply_granularity with temporal filter"""
+ query_object = Mock(spec=QueryObject)
+ query_object.granularity = "P1D"
+ query_object.columns = ["other_col"]
+ query_object.post_processing = []
+ query_object.filter = [
+ {"col": "ds", "op": "TEMPORAL_RANGE", "val": "2023-01-01 : 2023-01-31"}
+ ]
+
+ form_data = {}
+ datasource = Mock()
+ datasource.columns = [{"column_name": "ds", "is_dttm": True}]
+
+ self.factory._apply_granularity(query_object, form_data, datasource)
+
+ assert len(query_object.filter) == 0
+
+ def test_apply_granularity_with_granularity_in_temporal_filters(self):
+ """Test _apply_granularity when granularity is already in temporal filters"""
+ query_object = Mock(spec=QueryObject)
+ query_object.granularity = "P1D"
+ query_object.columns = ["other_col"]
+ query_object.post_processing = []
+ query_object.filter = [
+ {"col": "P1D", "op": "TEMPORAL_RANGE", "val": "2023-01-01 : 2023-01-31"},
+ {"col": "ds", "op": "TEMPORAL_RANGE", "val": "2023-01-01 : 2023-01-31"},
+ ]
+
+ form_data = {}
+ datasource = Mock()
+ datasource.columns = [{"column_name": "ds", "is_dttm": True}]
+
+ self.factory._apply_granularity(query_object, form_data, datasource)
+
+ assert len(query_object.filter) == 1
+ assert query_object.filter[0]["col"] == "ds"
+
+ def test_apply_granularity_no_granularity(self):
+ """Test _apply_granularity when no granularity is set"""
+ query_object = Mock(spec=QueryObject)
+ query_object.granularity = None
+ query_object.columns = ["ds", "other_col"]
+ query_object.post_processing = []
+ query_object.filter = []
+
+ form_data = {"x_axis": "ds"}
+ datasource = Mock()
+ datasource.columns = [{"column_name": "ds", "is_dttm": True}]
+
+ self.factory._apply_granularity(query_object, form_data, datasource)
+
+ assert query_object.columns == ["ds", "other_col"]
+
+ def test_apply_granularity_x_axis_not_temporal(self):
+ """Test _apply_granularity when x_axis is not a temporal column"""
+ query_object = Mock(spec=QueryObject)
+ query_object.granularity = "P1D"
+ query_object.columns = ["ds", "other_col"]
+ query_object.post_processing = []
+ query_object.filter = []
+
+ form_data = {"x_axis": "other_col"}
+ datasource = Mock()
+ datasource.columns = [{"column_name": "ds", "is_dttm": True}]
+
+ self.factory._apply_granularity(query_object, form_data, datasource)
+
+ assert query_object.columns == ["ds", "other_col"]
+
+ def test_apply_filters_with_time_range(self):
+ """Test _apply_filters with time_range"""
+ query_object = Mock(spec=QueryObject)
+ query_object.time_range = "2023-01-01 : 2023-01-31"
+ query_object.filter = [
+ {"col": "ds", "op": "TEMPORAL_RANGE", "val": "old_value"},
+ {"col": "other_col", "op": "==", "val": "value"},
+ ]
+
+ self.factory._apply_filters(query_object)
+
+ assert query_object.filter[0]["val"] == "2023-01-01 : 2023-01-31"
+
+ assert query_object.filter[1]["val"] == "value"
+
+ def test_apply_filters_no_time_range(self):
+ """Test _apply_filters without time_range"""
+ query_object = Mock(spec=QueryObject)
+ query_object.time_range = None
+ query_object.filter = [
+ {"col": "ds", "op": "TEMPORAL_RANGE", "val": "old_value"}
+ ]
+
+ self.factory._apply_filters(query_object)
+
+ assert query_object.filter[0]["val"] == "old_value"
+
+ def test_apply_filters_no_temporal_filters(self):
+ """Test _apply_filters with no temporal filters"""
+ query_object = Mock(spec=QueryObject)
+ query_object.time_range = "2023-01-01 : 2023-01-31"
+ query_object.filter = [{"col": "other_col", "op": "==", "val": "value"}]
+
+ self.factory._apply_filters(query_object)
+
+ assert query_object.filter[0]["val"] == "value"