Skip to content

docs(charts): rewrite the inline-series chart examples into the model the renderer implements #7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-sam merged 1 commit into from
Sep 5, 2026
+44 −13
Merged

docs(charts): rewrite the inline-series chart examples into the model the renderer implements #7679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions content/docs/api/schema-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,29 +457,43 @@ A chart visualization supporting multiple chart types.
"showLegend": true,
"showGrid": true,
"animate": true,
"categories": ["Jan", "Feb", "Mar", "Apr", "May", "Jun"],
"xAxisKey": "month",
"data": [
{ "month": "Jan", "Revenue": 4200, "Expenses": 3100 },
{ "month": "Feb", "Revenue": 5100, "Expenses": 3400 },
{ "month": "Mar", "Revenue": 4800, "Expenses": 3200 },
{ "month": "Apr", "Revenue": 6200, "Expenses": 3800 },
{ "month": "May", "Revenue": 5800, "Expenses": 3600 },
{ "month": "Jun", "Revenue": 7100, "Expenses": 4000 }
],
"series": [
{
"name": "Revenue",
"data": [4200, 5100, 4800, 6200, 5800, 7100],
"color": "#3b82f6"
},
{
"name": "Expenses",
"data": [3100, 3400, 3200, 3800, 3600, 4000],
"color": "#ef4444"
}
]
}
```

The rows live on the chart node's own `data`, one object per row keyed by column
name. Each series' `name` (or `dataKey`) selects the column it plots within those
rows, and `xAxisKey` names the column on the category axis. A series carries no
numbers of its own: `ChartDataSeries.data` is a retirement tombstone
(objectui#6896) and an authored array is refused by name at parse.

| Property | Type | Description |
|----------|------|-------------|
| `chartType` | `ChartType` | **Required.** `"bar"`, `"line"`, `"area"`, `"pie"`, `"donut"`, `"radar"`, `"scatter"`, `"heatmap"`. |
| `title` | `string` | Chart title. |
| `description` | `string` | Chart description / subtitle. |
| `categories` | `string[]` | X-axis category labels. |
| `series` | `ChartSeries[]` | Data series, each with `name`, `data` array, and optional `color`. |
| `categories` | `string[]` | An **alternative series list** — column names to plot, read only when `series` is absent, and ignored outright when it is present. Not axis labels: the category axis comes from `xAxisKey`. |
| `series` | `ChartDataSeries[]` | Data series. Each entry's `name` (or `dataKey`) names the column it plots within a `data` row; optional `color` and a per-series `type` (`"bar"`, `"line"`, `"area"`) for combo charts. |
| `data` | `Array<Record<string, any>>` | Rows to plot — one object per row, keyed by column name. |
| `xAxisKey` | `string` | Row key holding the category (x) axis. The bare-string `xAxis: "month"` spelling folds onto this key at parse. |
| `height` / `width` | `string \| number` | Chart dimensions. |
| `showLegend` | `boolean` | Display the legend. |
| `showGrid` | `boolean` | Display grid lines. |
Expand Down Expand Up @@ -961,8 +975,15 @@ A widget-based dashboard with configurable grid layout and auto-refresh.
"body": {
"type": "chart",
"chartType": "area",
"categories": ["Mon", "Tue", "Wed", "Thu", "Fri"],
"series": [{ "name": "Sales", "data": [120, 180, 150, 210, 190] }]
"xAxisKey": "day",
"data": [
{ "day": "Mon", "Sales": 120 },
{ "day": "Tue", "Sales": 180 },
{ "day": "Wed", "Sales": 150 },
{ "day": "Thu", "Sales": 210 },
{ "day": "Fri", "Sales": 190 }
],
"series": [{ "name": "Sales" }]
}
},
{
Expand Down
10 changes: 7 additions & 3 deletions content/docs/core/report-schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,12 +318,16 @@ const comprehensiveReport: ReportComponentSchema = {
chart: {
type: 'chart',
chartType: 'line',
categories: ['January', 'February', 'March'],
xAxisKey: 'month',
data: [
{ month: 'January', Revenue: 120000 },
{ month: 'February', Revenue: 145000 },
{ month: 'March', Revenue: 132000 }
],
series: [
{
name: 'Revenue',
type: 'line',
data: [120000, 145000, 132000]
type: 'line'
}
]
}
Expand Down
12 changes: 9 additions & 3 deletions packages/types/examples/data-display-examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,16 +130,22 @@
"chartType": "bar",
"title": "Monthly Sales",
"description": "Revenue breakdown by month",
"categories": ["Jan", "Feb", "Mar", "Apr", "May", "Jun"],
"data": [
{ "month": "Jan", "Revenue": 12000, "Expenses": 8000 },
{ "month": "Feb", "Revenue": 15000, "Expenses": 9000 },
{ "month": "Mar", "Revenue": 18000, "Expenses": 11000 },
{ "month": "Apr", "Revenue": 14000, "Expenses": 10000 },
{ "month": "May", "Revenue": 22000, "Expenses": 13000 },
{ "month": "Jun", "Revenue": 25000, "Expenses": 14000 }
],
"xAxisKey": "month",
"series": [
{
"name": "Revenue",
"data": [12000, 15000, 18000, 14000, 22000, 25000],
"color": "#3b82f6"
},
{
"name": "Expenses",
"data": [8000, 9000, 11000, 10000, 13000, 14000],
"color": "#ef4444"
}
],
Expand Down
Loading