Skip to content

Commit 33fc0ca

Browse files
committed
chore(spec): regenerate the reference docs and the react-block contract after the merge
Step 4 of the os-regen-merge sequence, on its own commit so a reviewer can read "what main brought" apart from "what the change produces". The only movement is the structure-key note's wording, shortened so the half that matters to a react author survives the generated table's truncation. Claude-Session: https://claude.ai/code/session_01LvwGppdonww4zGLWZo5rho Co-authored-by: Claude <noreply@anthropic.com>
1 parent 436f8e2 commit 33fc0ca

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

‎content/docs/references/ui/chart.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ Inline aggregation for an object-bound chart
108108
| **title** | `string \| Record<string, string>` | optional | Chart title |
109109
| **subtitle** | `string \| Record<string, string>` | optional | Chart subtitle |
110110
| **description** | `string \| Record<string, string>` | optional | Accessibility description — announced to screen readers as the chart’s label |
111-
| **xAxis** | `{ field: string; title?: string \| Record<string, string>; format?: string; min?: number; … }` | optional | X-Axis configuration. Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021) — select `dimensions` / `values` on the widget instead. It stays authorable on an inline-data react `<ObjectChart>`. |
112-
| **yAxis** | `{ field: string; title?: string \| Record<string, string>; format?: string; min?: number; … }[]` | optional | Y-Axis configuration (support dual axis). Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021) — select `dimensions` / `values` on the widget instead. It stays authorable on an inline-data react `<ObjectChart>`. |
113-
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021) — select `dimensions` / `values` on the widget instead. It stays authorable on an inline-data react `<ObjectChart>`. |
111+
| **xAxis** | `{ field: string; title?: string \| Record<string, string>; format?: string; min?: number; … }` | optional | X-Axis configuration. Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, where the dataset decides it (ADR-0021). |
112+
| **yAxis** | `{ field: string; title?: string \| Record<string, string>; format?: string; min?: number; … }[]` | optional | Y-Axis configuration (support dual axis). Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, where the dataset decides it (ADR-0021). |
113+
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, where the dataset decides it (ADR-0021). |
114114
| **colors** | `string[] \| Record<string, string>` | optional | Color palette (string[]) or value→color map (`{ value: color }`) |
115115
| **height** | `number` | optional | Fixed plot height in pixels (overrides the container default) |
116116
| **showLegend** | `boolean` | optional (default: `true`) | Display legend |

‎content/docs/references/ui/report.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const result = JoinedReportBlockSchema.parse(data);
4949
| **description** | `string \| Record<string, string>` | optional | Accessibility description — announced to screen readers as the chart’s label |
5050
| **xAxis** | `string` | ✅ | Dataset dimension name for the X-axis (bound-dataset dimension, not a raw field) |
5151
| **yAxis** | `string` | ✅ | Dataset measure name for the Y-axis (bound-dataset measure, not a raw field) |
52-
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021) — select `dimensions` / `values` on the widget instead. It stays authorable on an inline-data react `<ObjectChart>`. |
52+
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, where the dataset decides it (ADR-0021). |
5353
| **colors** | `string[] \| Record<string, string>` | optional | Color palette (string[]) or value→color map (`{ value: color }`) |
5454
| **height** | `number` | optional | Fixed plot height in pixels (overrides the container default) |
5555
| **showLegend** | `boolean` | optional (default: `true`) | Display legend |
@@ -113,7 +113,7 @@ const result = JoinedReportBlockSchema.parse(data);
113113
| **description** | `string \| Record<string, string>` | optional | Accessibility description — announced to screen readers as the chart’s label |
114114
| **xAxis** | `string` | ✅ | Dataset dimension name for the X-axis (bound-dataset dimension, not a raw field) |
115115
| **yAxis** | `string` | ✅ | Dataset measure name for the Y-axis (bound-dataset measure, not a raw field) |
116-
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021) — select `dimensions` / `values` on the widget instead. It stays authorable on an inline-data react `<ObjectChart>`. |
116+
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, where the dataset decides it (ADR-0021). |
117117
| **colors** | `string[] \| Record<string, string>` | optional | Color palette (string[]) or value→color map (`{ value: color }`) |
118118
| **height** | `number` | optional | Fixed plot height in pixels (overrides the container default) |
119119
| **showLegend** | `boolean` | optional (default: `true`) | Display legend |
@@ -161,7 +161,7 @@ const result = JoinedReportBlockSchema.parse(data);
161161
| **description** | `string \| Record<string, string>` | optional | Accessibility description — announced to screen readers as the chart’s label |
162162
| **xAxis** | `string` | ✅ | Dataset dimension name for the X-axis (bound-dataset dimension, not a raw field) |
163163
| **yAxis** | `string` | ✅ | Dataset measure name for the Y-axis (bound-dataset measure, not a raw field) |
164-
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021) — select `dimensions` / `values` on the widget instead. It stays authorable on an inline-data react `<ObjectChart>`. |
164+
| **series** | `{ name: string; label?: string \| Record<string, string>; type?: Enum<'bar' \| 'horizontal-bar' \| 'column' \| 'line' \| 'area' \| 'pie' \| 'donut' \| …>; color?: string; … }[]` | optional | Defined series configuration. Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, where the dataset decides it (ADR-0021). |
165165
| **colors** | `string[] \| Record<string, string>` | optional | Color palette (string[]) or value→color map (`{ value: color }`) |
166166
| **height** | `number` | optional | Fixed plot height in pixels (overrides the container default) |
167167
| **showLegend** | `boolean` | optional (default: `true`) | Display legend |

‎skills/objectstack-ui/references/react-blocks.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ Chart over an object’s aggregated data. Bind objectName + aggregate; the axes
9393
| `subtitle` | `string \| object` | data | | Chart subtitle |
9494
| `description` | `string \| object` | data | | Accessibility description — announced to screen readers as the chart’s label |
9595
| `height` | `number` | data | | Fixed plot height in pixels (overrides the container default) |
96-
| `xAxis` | `object` | data | | X-Axis configuration. Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021) — selec… |
97-
| `yAxis` | `object[]` | data | | Y-Axis configuration (support dual axis). Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by nam… |
98-
| `series` | `object[]` | data | | Defined series configuration. Structure, not appearance: on a dataset-bound dashboard widget the dataset decides this and the key is refused by name (ADR-0021)… |
96+
| `xAxis` | `object` | data | | X-Axis configuration. Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, where the da… |
97+
| `yAxis` | `object[]` | data | | Y-Axis configuration (support dual axis). Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard … |
98+
| `series` | `object[]` | data | | Defined series configuration. Structure, not appearance — authorable where the chart has inline data; refused by name on a dataset-bound dashboard widget, wher… |
9999
| `colors` | `string[] \| object` | data | | Color palette (string[]) or value→color map ({ value: color }) |
100100
| `showLegend` | `boolean` | data | | Display legend |
101101
| `showDataLabels` | `boolean` | data | | Display data labels |

0 commit comments

Comments
 (0)