Steps
- Intent Recognition: Select the chart type based on user intent and data characteristics
- Determine Output Mode: Choose Syntax mode or Code mode based on the context
- Generate Output: Generate content according to the selected mode
Supported Chart Types
| type value | Applicable Scenario |
|---|---|
| line | Time series trends |
| area | Time series trends + totals |
| column | Comparison of categorical data |
| bar | Categorical comparison (long labels) |
| pie | Proportion of parts to the whole |
| scatter | Relationship between two variables |
| dual-axes | Comparison of data at different magnitudes |
| histogram | Frequency distribution of continuous values |
| boxplot | Data distribution and outliers |
| violin | Data distribution density |
| radar | Multidimensional comparison |
| funnel | Process conversion rate |
| waterfall | Cumulative increase/decrease changes |
| liquid | Percentage/progress |
| word-cloud | Word frequency display |
| venn | Set intersection and union relationships |
| treemap | Proportion of hierarchical data |
| sankey | Traffic flow |
| flow-diagram | Process steps |
| mindmap | Hierarchical knowledge organization |
| indented-tree | Tree node hierarchy/directory |
| network-graph | Association relationships between entities |
| organization-chart | Organizational hierarchy |
| fishbone-diagram | Root cause analysis |
| table | Tabular data display |
| summary | Content summary |
Output Modes
Mode 1: Syntax Mode (Syntax / JSON)
Used for LLM application integration scenarios, generating chart configurations for consumption by GPTVis.render() . Supports two formats:
- Syntax format: Markdown-like indentation syntax, suitable for streaming output (can be rendered in real time when the LLM generates token by token)
- JSON format: Standard JSON object, suitable for structured API calls
The two formats are equivalent,GPTVis.render() can directly accept both.
Mode 2: Code Mode
Used for scenarios where the user needs complete code that can be run directly. Generate output including installation instructions and complete code.
GPTVis API
GPTVis is the library's unified entry class, responsible for creating, rendering, and destroying charts.
Constructor
new GPTVis(options: VisualizationOptions)
VisualizationOptions:
| Parameter | Type | Required | Default Value | Description |
|---|---|---|---|---|
container |
string | HTMLElement |
Yes | — | CSS selector or DOM element |
width |
number |
No | — | Chart width (px) |
height |
number |
No | — | Chart height (px) |
theme |
'default' | 'light' | 'dark' | 'academy' |
No | 'light' |
Theme |
wrapper |
boolean |
No | false |
Whether to display the outer UI container (including tabs, download, copy, etc.) |
locale |
string |
No | 'zh-CN' |
Language of the text within the wrapper |
Methods
render(config: string | object): void
Render the chart. Accepts two types of input:
- Syntax string: Text starting with
vis [type], automatically parsed into a configuration object - JSON configuration object: Contains
typeobject with field - Plain text: A string not starting with
viswill be rendered as the summary type
Calling render() multiple times will automatically destroy the previous chart before rendering the new chart.
destroy(): void
Destroy the current chart instance and release resources.
Syntax mode: JSON format
Directly output a JSON object conforming to the chart TypeScript types,GPTVis.render() can be consumed directly.
JSON example
{
"type": "column",
"data": [
{ "category": "A产品", "value": 30, "group": "线上" },
{ "category": "B产品", "value": 50, "group": "线上" }
],
"title": "产品销量对比",
"axisXTitle": "产品",
"axisYTitle": "销量(万)",
"stack": true,
"theme": "academy",
"style": {
"palette": ["#5B8FF9", "#61DDAA"]
}
}
Syntax mode: Syntax format
Markdown-like indentation syntax, supports streaming rendering. The first line must be vis [type]。
Syntax rules
Basic properties — key value, one per line:
title 年度趋势
theme dark
Array of objects — data each item starts with - , subfields are indented:
{ data: { time: string; value: number; }[]; }
Corresponds to:
data
- time 2020
value 100
- time 2021
value 120
Array of plain values — each item starts with - :
{ data: number[] }
Corresponds to:
data
- 10
- 20
String values containing spaces — wrap in quotes (single or double); quotes can be omitted when there are no spaces:
categories
- "North America"
- '东南 亚'
- 欧洲
Nested objects — the object name occupies one line, sub-properties are indented:
{ style?: { backgroundColor?: string; palette?: string[] } }
Corresponds to:
style
backgroundColor #f0f2f5
palette
- #5B8FF9
- #61DDAA
Recursive tree — children array is indented with - :
type TreeData = { name: string; children?: TreeData[] };
{ data: TreeData; }
Corresponds to:
data
name 根节点
children
- name 子节点A
children
- name 孙节点
- name 子节点B
Complete Syntax example
vis column
data
- category A产品
value 30
group 线上
- category B产品
value 50
group 线上
title 产品销量对比
axisXTitle 产品
axisYTitle 销量(万)
stack true
theme academy
style
palette
- #5B8FF9
- #61DDAA
Markdown syntax
When the output is in Markdown format, use GPT-Vis as the language tag for the fenced code block, and write the complete Syntax format:
```GPT-Vis
vis line
data
- time 2020
value 100
```
Format:
```GPT-Vis
<完整的 Syntax 内容,首行 vis <chart-type>>
```
Syntax rules:
- The language tag is fixed as
GPT-Vis - The content area uses the Syntax formatrules,the first line must contain
vis <chart-type>(for the complete list, seeSupported chart types) - above); the code block will be converted by the Markdown plugin and rendered by the browser
Note: In Markdown mode, the content areamustwrite the first line
vis <type>, consistent with the plain Syntax mode format.
Code mode
Generate complete runnable code for the target framework.
Installation method
NPM:
npm install @antv/gpt-vis
import { GPTVis } from '@antv/gpt-vis';
CDN:
<script src="https://unpkg.com/@antv/gpt-vis/dist/umd/index.min.js"></script>
After importing via CDN, access the main class through GPTVis.GPTVis .
Complete HTML example
<html>
<head>
<script src="https://unpkg.com/@antv/gpt-vis/dist/umd/index.min.js"></script>
</head>
<body>
<div id="container"></div>
<script>
const gptVis = new GPTVis.GPTVis({
container: '#container',
width: 600,
height: 400,
});
gptVis.render(`
vis line
data
- time 2020
value 100
- time 2021
value 120
title 年度趋势
`);
</script>
</body>
</html>
Chart type configuration
Common configuration
All charts include the following fields; these fields are omitted in the definitions of the chart types below. The title of each subsection is the type value (e.g., line、column), corresponding to the type column in the chart type table above.
{ type: string; title?: string; theme?: 'default' | 'light' | 'dark' | 'academy'; style?: { backgroundColor?: string; palette?: string[] } }
line / area
{ data: { time: string | number; value: number; group?: string }[]; axisXTitle?: string; axisYTitle?: string; stack?: boolean; style?: { lineWidth?: number } }
stack only supported by area.
column / bar
{ data: { category: string; value: number; group?: string }[]; axisXTitle?: string; axisYTitle?: string; stack?: boolean; group?: boolean }
pie
value cannot use percentage numbers.
{ data: { category: string; value: number }[]; innerRadius?: number }
innerRadius set to 0.6 becomes a donut chart.
scatter
{ data: { x: number; y: number; group?: string }[]; axisXTitle?: string; axisYTitle?: string }
dual-axes
{ categories: string[]; series: { type: 'line' | 'column'; data: number[]; axisYTitle?: string }[]; axisXTitle?: string; style?: { startAtZero?: boolean } }
histogram
{ data: number[]; binNumber?: number; axisXTitle?: string; axisYTitle?: string }
boxplot / violin
The same category requires multiple data entries to show the distribution.
{ data: { category: string; value: number; group?: string }[]; axisXTitle?: string; axisYTitle?: string; style?: { startAtZero?: boolean } }
radar
{ data: { name: string; value: number; group?: string }[]; align?: boolean }
align: Whether to align the scales of all dimensions, default false (each axis scales independently); when true, all axes share the same maximum value, suitable for comparing absolute values across multiple series.
funnel
{ data: { category: string; value: number; }[]; }
waterfall
value can be negative to indicate a decrease. palette is an array of colors, in the order [positive value color, negative value color, total color].
{ data: { category: string; value: number }[]; axisXTitle?: string; axisYTitle?: string; style?: { palette?: string[] } }
liquid
percent range 0~1.
{ percent: number; shape?: 'rect' | 'circle' | 'pin' | 'triangle' }
word-cloud
{ data: { text: string; value: number; }[]; }
venn
For intersections, separate set identifiers with commas:sets: "A,B"。label used to display the names of the corresponding sets on the chart
{ data: { sets: string | string[]; value: number; label?: string }[] }
treemap
type TreeNode = { name: string; value: number; children?: TreeNode[] };
{ data: TreeNode[] }
sankey
{ data: { source: string; target: string; value: number }[]; nodeAlign?: 'left' | 'center' | 'right' | 'justify' }
flow-diagram / network-graph
source/target of the referenced node name。
type GraphData = { nodes: { name: string }[]; edges: { source: string; target: string; name?: string }[] };
// flow-diagram
{ data: GraphData }
// network-graph
{ data: GraphData; layout?: 'force' | 'circular' | 'grid' | 'radial' | 'concentric' | 'dagre' }
mindmap / indented-tree / organization-chart
type TreeData = { name: string; children?: TreeData[] };
// mindmap
{ data: TreeData; direction?: 'H' | 'LR' | 'RL' }
// indented-tree
{ data: TreeData; direction?: 'LR' | 'RL' | 'H' }
// organization-chart
type OrganizationChartData = {
name: string;
description?: string;
children?: OrganizationChartData[];
};
{ data: OrganizationChartData }
mindmap defaults to 'H', indented-tree defaults to 'LR'。
fishbone-diagram
type FishboneNode = { name: string; children?: FishboneNode[] };
{ data: FishboneNode; style?: { texture?: 'rough' | 'default' } }
texture: 'rough' is hand-drawn style.
table
{ data: Record<string, string | number>[]; }
summary
summary is completely different from other chart types: it does not use Syntax/JSON configuration, but uses T8 syntax (Markdown + semantic annotations).
⚠️ Before generating summary, you must: first read references/summary.md to get the T8 syntax rules, the complete entity type list, attribute field definitions, generation requirements, and examples, and then generate the content. Skipping this step will cause syntax errors.
Best practices
- Pie charts should have no more than 5 categories; if more, it is recommended to merge them into "Other" or switch to a bar chart
- Do not use pie charts to show trends, and do not use line charts to show unordered categories
- Numeric fields must be of number type, and category fields must be of text type
- The distribution of continuous numeric values (such as salary, scores, age) must use a histogram
- Multi-dimensional data field mapping: when there are two categorical dimensions, write the x-axis dimension as
time/category, and the other asgroup - For syntax mode, prefer the Syntax format (streaming-friendly)
- Code mode generates the HTML + CDN solution by default (zero installation); use the npm solution only when the user specifies a framework