@subtitle

A short description about the visualization displayed under the title throughout the UI

Quick Reference

-- @subtitle: Sales over time grouped by month

Valid Types

String

A short sentence string that describes the chart.

Full Example

-- @title: Auto Heatmap
-- @subtitle: An example auto generated heatmap comparing two categories
SELECT
Owner,
Channel,
count(*) as Sales
FROM Sales
WHERE Sales.Status = 'Won'
GROUP BY Owner, Channel

Use Cases

Use a subtitle when the title is insufficient to convery the purpose of the chart, and you want to add a short description. Subtitles are used in various places in the ChartSQL UI

Example of a subtitle in the file list