Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

2.6 KB
Raw Blame
import { PART_OF_WHOLE_DISPLAY_TYPES } from 'lib/constants'

import { ChartDisplayType } from '~/types'

import { Column, applyVisualizationType } from './dataVisualizationLogic'

type VisualizationSupport = 'none' | 'axes' | 'manual'

const VISUALIZATION_SUPPORT: Record<ChartDisplayType, VisualizationSupport> = {
    [ChartDisplayType.Auto]: 'none',
    [ChartDisplayType.ActionsTable]: 'none',
    [ChartDisplayType.BoldNumber]: 'none',
    [ChartDisplayType.ActionsLineGraph]: 'axes',
    [ChartDisplayType.ActionsAreaGraph]: 'axes',
    [ChartDisplayType.ActionsBar]: 'axes',
    [ChartDisplayType.ActionsStackedBar]: 'axes',
    [ChartDisplayType.ActionsUnstackedBar]: 'axes',
    [ChartDisplayType.ActionsPie]: 'axes',
    [ChartDisplayType.ActionsDonut]: 'axes',
    [ChartDisplayType.ActionsProportionBar]: 'axes',
    [ChartDisplayType.ActionsLineGraphCumulative]: 'axes',
    [ChartDisplayType.ScatterPlot]: 'manual',
    [ChartDisplayType.TwoDimensionalHeatmap]: 'manual',
    [ChartDisplayType.ActionsBarValue]: 'axes',
    [ChartDisplayType.Metric]: 'axes',
    [ChartDisplayType.WorldMap]: 'manual',
    [ChartDisplayType.CalendarHeatmap]: 'manual',
    [ChartDisplayType.BoxPlot]: 'manual',
    [ChartDisplayType.SlopeGraph]: 'manual',
}

const MANUAL_SETUP_REASON = 'Open the insight to pick which column goes on each axis'

export function sqlVisualizationDisabledReason(
    displayType: ChartDisplayType,
    query: Parameters<typeof applyVisualizationType>[0],
    columns: Column[],
    rowCount: number,
    autoVisualizationType: ChartDisplayType
): string | undefined {
    const drawnAs = displayType === ChartDisplayType.Auto ? autoVisualizationType : displayType

    if (VISUALIZATION_SUPPORT[drawnAs] === 'manual') {
        return displayType === ChartDisplayType.Auto
            ? `Auto picks a chart here that needs its axes set. ${MANUAL_SETUP_REASON}.`
            : MANUAL_SETUP_REASON
    }

    if (VISUALIZATION_SUPPORT[drawnAs] !== 'axes') {
        return undefined
    }

    const nextQuery = applyVisualizationType(query, displayType, columns, rowCount)
    const hasYAxis = !!nextQuery.chartSettings?.yAxis?.length
    // A pie, donut or proportion bar draws one part per numeric column, so like `Metric` it needs no X-axis column.
    if (
        hasYAxis &&
        (drawnAs === ChartDisplayType.Metric ||
            PART_OF_WHOLE_DISPLAY_TYPES.includes(drawnAs) ||
            nextQuery.chartSettings?.xAxis)
    ) {
        return undefined
    }

    return hasYAxis
        ? 'This insight has no column left to label the X-axis'
        : 'This insight has no numeric column to plot'
}