@krizaka/charts 0.0.0-stage → 0.1.0

package/registry/area-chart.json

@@ -0,0 +1,784 @@
+{
+  "name": "area-chart",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Area chart",
+  "summary": "A volume over time: a line over a soft wash, or stacked areas whose parts add up to a total.",
+  "description": "A volume over time: a line over a soft wash, or stacked areas whose parts add up to a total.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "both",
+  "engine": "svg",
+  "whenToUse": [
+    "A volume whose size matters, not only its direction: credits consumed, storage used.",
+    "The parts of a total over time, stacked: credits by model, views by source."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "Several series whose lines cross: the washes would hide each other.",
+      "use": "line-chart"
+    },
+    {
+      "when": "Parts of a total at one moment.",
+      "use": "pie-chart"
+    }
+  ],
+  "bestPractices": [
+    "Stack only parts of one total, in a stable order: the series keep their palette slot whatever is filtered.",
+    "The tooltip of a stacked chart adds the total: do not add a series for it.",
+    "Start at zero (the default): an area's height is read as an amount."
+  ],
+  "accessibility": {
+    "keyboard": [
+      {
+        "keys": "Tab",
+        "action": "Moves the focus to the plot (one tab stop), then to the data and export buttons."
+      },
+      {
+        "keys": "Arrow keys",
+        "action": "Walk the points one by one: each is announced and its tooltip shown."
+      },
+      {
+        "keys": "Home / End",
+        "action": "Jump to the first or the last point."
+      },
+      {
+        "keys": "Esc",
+        "action": "Hides the tooltip and clears the active point."
+      }
+    ],
+    "notes": [
+      "The plot is a group named by the title and described by a summary written from the data (extremes, trend), read before anything else.",
+      "The data table is always in the page for assistive technology; “Show data” reveals it for everyone.",
+      "Colour never carries a meaning alone: a legend from two series, direct labels, the table.",
+      "The entrance plays once, when the chart comes on screen, and never under reduced motion."
+    ]
+  },
+  "related": [
+    "line-chart",
+    "bar-chart",
+    "pie-chart"
+  ],
+  "source": "packages/charts/src/meta/area-chart.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/line",
+    "import": "import { AreaChart } from \"@krizaka/charts/line\";",
+    "props": [
+      {
+        "component": "AreaChart",
+        "description": "A volume over time: a line over a soft wash (stacked: the parts of a total).",
+        "props": [
+          {
+            "name": "data",
+            "type": "readonly T[]",
+            "default": null,
+            "description": "The rows, in the order of the x axis.",
+            "required": true
+          },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
+            "required": true
+          },
+          {
+            "name": "brand",
+            "type": "BrandId",
+            "default": null,
+            "description": "The brand whose palette the charts use. Without it, a chart follows a `.brand-<id>` ancestor, else Krizaka. Set it\nwhen the app loads a brand stylesheet on `:root` (`@krizaka/tokens/brands/orazaka.css`).",
+            "required": false
+          },
+          {
+            "name": "className",
+            "type": "string",
+            "default": null,
+            "description": "A class on the figure (layout: margins, grid placement).",
+            "required": false
+          },
+          {
+            "name": "curve",
+            "type": "Curve",
+            "default": null,
+            "description": "The shape between points: `monotone` (default, never overshoots), `linear`, `step` (a value that holds).",
+            "required": false
+          },
+          {
+            "name": "dataTable",
+            "type": "boolean",
+            "default": null,
+            "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+            "required": false
+          },
+          {
+            "name": "description",
+            "type": "ReactNode",
+            "default": null,
+            "description": "A sentence under the title: the period, the unit, the source.",
+            "required": false
+          },
+          {
+            "name": "dots",
+            "type": "boolean",
+            "default": null,
+            "description": "A dot on every point (short series). Default false: the end of each line carries one.",
+            "required": false
+          },
+          {
+            "name": "empty",
+            "type": "ReactNode",
+            "default": null,
+            "description": "What to show when there is nothing to draw (default: the `empty` label). An `EmptyState` of\n@krizaka /ui fits.",
+            "required": false
+          },
+          {
+            "name": "endLabels",
+            "type": "boolean",
+            "default": "true",
+            "description": "Write the last value at the end of each line (up to three series). Default true.",
+            "required": false
+          },
+          {
+            "name": "error",
+            "type": "ReactNode",
+            "default": null,
+            "description": "The data could not be loaded: `true` says the default words, a node says yours (a retry button…).",
+            "required": false
+          },
+          {
+            "name": "exportable",
+            "type": "boolean | readonly ExportFormat[]",
+            "default": null,
+            "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+            "required": false
+          },
+          {
+            "name": "format",
+            "type": "ValueFormat",
+            "default": null,
+            "description": "How the values are written (axis, tooltip, table, summary). Default `\"number\"`.",
+            "required": false
+          },
+          {
+            "name": "height",
+            "type": "number",
+            "default": null,
+            "description": "The height of the plot in pixels. Default 280 (a sparkline: 32).",
+            "required": false
+          },
+          {
+            "name": "hideTitle",
+            "type": "boolean",
+            "default": null,
+            "description": "Visually hide the title (it stays the chart's accessible name): a card that already has its heading.",
+            "required": false
+          },
+          {
+            "name": "id",
+            "type": "string",
+            "default": null,
+            "description": "The id of the figure.",
+            "required": false
+          },
+          {
+            "name": "labels",
+            "type": "ChartLabelsInput",
+            "default": null,
+            "description": "The words, translated: the buttons, the states, the written summary.",
+            "required": false
+          },
+          {
+            "name": "legend",
+            "type": "boolean",
+            "default": null,
+            "description": "Show the legend (from two series). Default true.",
+            "required": false
+          },
+          {
+            "name": "live",
+            "type": "boolean",
+            "default": null,
+            "description": "Streaming data (a job queue, an auction): no entrance on updates, no announcement of every new point.",
+            "required": false
+          },
+          {
+            "name": "loading",
+            "type": "boolean",
+            "default": null,
+            "description": "The data is on its way: a skeleton of the chart, announced once.",
+            "required": false
+          },
+          {
+            "name": "locale",
+            "type": "Locale",
+            "default": null,
+            "description": "The locale of every figure and date (`\"fr-FR\"`). Default `\"en-US\"`.",
+            "required": false
+          },
+          {
+            "name": "markers",
+            "type": "readonly Marker[]",
+            "default": null,
+            "description": "Vertical markers at a category: a launch, an incident.",
+            "required": false
+          },
+          {
+            "name": "onSelect",
+            "type": "((datum: T, index: number) => void)",
+            "default": null,
+            "description": "Called with the row when a point or a bar is clicked (or Enter is pressed on it).",
+            "required": false
+          },
+          {
+            "name": "series",
+            "type": "readonly SeriesSpec<T>[]",
+            "default": null,
+            "description": "The series to draw, each with its field and its name; the palette follows their order.",
+            "required": false
+          },
+          {
+            "name": "stacked",
+            "type": "boolean",
+            "default": null,
+            "description": "Stack the series: a total and its parts over time.",
+            "required": false
+          },
+          {
+            "name": "style",
+            "type": "CSSProperties",
+            "default": null,
+            "description": "Inline style on the figure (layout only: colours come from the tokens).",
+            "required": false
+          },
+          {
+            "name": "summary",
+            "type": "\"hidden\" | \"visible\"",
+            "default": null,
+            "description": "The written summary: read by screen readers only (`\"hidden\"`, default), or shown under the chart (`\"visible\"`).",
+            "required": false
+          },
+          {
+            "name": "summaryText",
+            "type": "string",
+            "default": null,
+            "description": "Your own summary instead of the generated one (still read first by screen readers).",
+            "required": false
+          },
+          {
+            "name": "thresholds",
+            "type": "readonly Threshold[]",
+            "default": null,
+            "description": "Horizontal lines at a value: a goal, a payout threshold.",
+            "required": false
+          },
+          {
+            "name": "x",
+            "type": "string | ((datum: T, index: number) => unknown)",
+            "default": null,
+            "description": "The field (or function) of the category: a month (`\"2026-04\"`), a day, a label. Default: the row's position.",
+            "required": false
+          },
+          {
+            "name": "xFormat",
+            "type": "CategoryFormat",
+            "default": null,
+            "description": "How the categories are written. Default: dates by their precision (`2026-04` → `Apr 2026`), text as is.",
+            "required": false
+          },
+          {
+            "name": "xLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the categories in the data table (`Month`).",
+            "required": false
+          },
+          {
+            "name": "y",
+            "type": "string | ((datum: T, index: number) => number | null)",
+            "default": null,
+            "description": "A single series: its field. Use `series` for several.",
+            "required": false
+          },
+          {
+            "name": "yLabel",
+            "type": "string",
+            "default": null,
+            "description": "The name of the single `y` series (legend, tooltip, table). Default: the field's name.",
+            "required": false
+          },
+          {
+            "name": "zero",
+            "type": "boolean",
+            "default": null,
+            "description": "Start the value axis at zero. Default: true for bars and areas; for lines, unless the values sit far from zero.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "credits-usage",
+        "title": "Credits by model",
+        "description": "Eight weeks of Orazaka credits, stacked by model, the plan's weekly allowance as a threshold.",
+        "path": "examples/area-chart/credits-usage.tsx",
+        "module": "@krizaka/charts/registry/examples/area-chart/credits-usage",
+        "code": "import { AreaChart } from \"@krizaka/charts/line\";\n\nconst weeks = [\n  { week: \"2026-08-03\", chat: 9_400, image: 4_100, video: 1_200 },\n  { week: \"2026-08-10\", chat: 10_200, image: 4_600, video: 1_900 },\n  { week: \"2026-08-17\", chat: 9_800, image: 5_300, video: 2_400 },\n  { week: \"2026-08-24\", chat: 11_600, image: 5_100, video: 3_100 },\n  { week: \"2026-08-31\", chat: 12_300, image: 6_200, video: 3_600 },\n  { week: \"2026-09-07\", chat: 12_900, image: 6_000, video: 4_800 },\n  { week: \"2026-09-14\", chat: 13_400, image: 6_900, video: 5_200 },\n  { week: \"2026-09-21\", chat: 14_100, image: 7_400, video: 6_100 },\n];\n\nexport default function CreditsUsage() {\n  return (\n    <AreaChart\n      title=\"Credits used per week, by model\"\n      description=\"Workspace “Atelier Nord”, Pro plan\"\n      data={weeks}\n      x=\"week\"\n      xFormat=\"day\"\n      series={[\n        { key: \"chat\", label: \"Chat\" },\n        { key: \"image\", label: \"Image\" },\n        { key: \"video\", label: \"Video\" },\n      ]}\n      format=\"integer\"\n      stacked\n      thresholds={[{ value: 25_000, label: \"Weekly allowance\", tone: \"warning\" }]}\n    />\n  );\n}\n"
+      },
+      {
+        "name": "storage",
+        "title": "Single area",
+        "description": "One volume over time: storage used by a workspace.",
+        "path": "examples/area-chart/storage.tsx",
+        "module": "@krizaka/charts/registry/examples/area-chart/storage",
+        "code": "import { AreaChart } from \"@krizaka/charts/line\";\n\nconst days = [12.4, 12.9, 13.1, 13.8, 14.6, 14.9, 15.7, 16.2, 16.4, 17.3, 18.1, 18.6, 19.4, 20.2].map((gb, i) => ({\n  day: `2026-09-${String(i + 1).padStart(2, \"0\")}`,\n  gb,\n}));\n\nexport default function Storage() {\n  return (\n    <AreaChart\n      title=\"Storage used\"\n      data={days}\n      x=\"day\"\n      xFormat=\"day\"\n      y=\"gb\"\n      yLabel=\"Storage\"\n      format={{ style: \"unit\", unit: \"gigabyte\" }}\n      height={220}\n    />\n  );\n}\n"
+      }
+    ]
+  },
+  "native": {
+    "entry": "@krizaka/charts/native",
+    "import": "import { AreaChart } from \"@krizaka/charts/native\";",
+    "differences": [
+      "No data table or export: the summary is the accessible label, swipe up and down to hear each week.",
+      "A tap selects the nearest point; no hover."
+    ],
+    "props": [
+      {
+        "component": "AreaChart",
+        "description": "A volume over time (React Native): a line over a wash; `stacked` for the parts of a total.",
+        "props": [
+          {
+            "name": "data",
+            "type": "readonly T[]",
+            "default": null,
+            "description": "The rows, in the order of the x axis.",
+            "required": true
+          },
+          {
+            "name": "title",
+            "type": "string",
+            "default": null,
+            "description": "What the chart shows: its heading and accessible name.",
+            "required": true
+          },
+          {
+            "name": "brand",
+            "type": "BrandId",
+            "default": null,
+            "description": "The brand whose palette leads. Default Krizaka.",
+            "required": false
+          },
+          {
+            "name": "curve",
+            "type": "Curve",
+            "default": "monotone",
+            "description": "`monotone` (default), `linear` or `step`.",
+            "required": false
+          },
+          {
+            "name": "empty",
+            "type": "ReactNode",
+            "default": null,
+            "description": "Shown instead of the plot when there is nothing to draw. Default: the `empty` label.",
+            "required": false
+          },
+          {
+            "name": "format",
+            "type": "ValueFormat",
+            "default": null,
+            "description": "How the values are written.",
+            "required": false
+          },
+          {
+            "name": "height",
+            "type": "number",
+            "default": null,
+            "description": "The plot's height.",
+            "required": false
+          },
+          {
+            "name": "hideTitle",
+            "type": "boolean",
+            "default": null,
+            "description": "Hide the heading (it stays the accessible name).",
+            "required": false
+          },
+          {
+            "name": "labels",
+            "type": "ChartLabelsInput",
+            "default": null,
+            "description": "The words: the readout, the summary.",
+            "required": false
+          },
+          {
+            "name": "loading",
+            "type": "boolean",
+            "default": null,
+            "description": "The data is on its way.",
+            "required": false
+          },
+          {
+            "name": "locale",
+            "type": "Locale",
+            "default": null,
+            "description": "The locale of every figure and date. Default `\"en-US\"`.",
+            "required": false
+          },
+          {
+            "name": "scheme",
+            "type": "Mode",
+            "default": null,
+            "description": "Dark or light. Default: the device's (pass `useTheme().scheme` of\n@krizaka /ui/native to follow the app).",
+            "required": false
+          },
+          {
+            "name": "series",
+            "type": "readonly SeriesSpec<T>[]",
+            "default": null,
+            "description": "The series, each with its field and name.",
+            "required": false
+          },
+          {
+            "name": "stacked",
+            "type": "boolean",
+            "default": null,
+            "description": "Stack the series: the parts of a total over time.",
+            "required": false
+          },
+          {
+            "name": "style",
+            "type": "ViewStyle",
+            "default": null,
+            "description": "The style of the chart's container (layout only: colours come from the theme).",
+            "required": false
+          },
+          {
+            "name": "theme",
+            "type": "Partial<ChartTheme>",
+            "default": null,
+            "description": "The app's colour roles (`useTheme().theme` of\n@krizaka /ui/native): a product's brand overrides apply.",
+            "required": false
+          },
+          {
+            "name": "thresholds",
+            "type": "readonly Threshold[]",
+            "default": null,
+            "description": "Horizontal lines at a value.",
+            "required": false
+          },
+          {
+            "name": "x",
+            "type": "string | ((datum: T, index: number) => unknown)",
+            "default": null,
+            "description": "The field (or function) of the category.",
+            "required": false
+          },
+          {
+            "name": "xFormat",
+            "type": "CategoryFormat",
+            "default": null,
+            "description": "How the categories are written.",
+            "required": false
+          },
+          {
+            "name": "y",
+            "type": "string | ((datum: T, index: number) => number | null)",
+            "default": null,
+            "description": "A single series: its field.",
+            "required": false
+          },
+          {
+            "name": "yLabel",
+            "type": "string",
+            "default": null,
+            "description": "The name of the single `y` series.",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "credits-usage",
+        "title": "Credits by model",
+        "description": "Credits stacked by model.",
+        "path": "examples/area-chart/native/credits-usage.tsx",
+        "module": "@krizaka/charts/registry/examples/area-chart/native/credits-usage",
+        "code": "import { AreaChart } from \"@krizaka/charts/native\";\n\nconst weeks = [\n  { week: \"2026-08-03\", chat: 9_400, image: 4_100 },\n  { week: \"2026-08-10\", chat: 10_200, image: 4_600 },\n  { week: \"2026-08-17\", chat: 9_800, image: 5_300 },\n  { week: \"2026-08-24\", chat: 11_600, image: 5_100 },\n  { week: \"2026-08-31\", chat: 12_300, image: 6_200 },\n  { week: \"2026-09-07\", chat: 12_900, image: 6_000 },\n];\n\nexport default function CreditsUsage() {\n  return (\n    <AreaChart\n      title=\"Credits used per week\"\n      data={weeks}\n      x=\"week\"\n      xFormat=\"day\"\n      series={[\n        { key: \"chat\", label: \"Chat\" },\n        { key: \"image\", label: \"Image\" },\n      ]}\n      format=\"compact\"\n      stacked\n    />\n  );\n}\n",
+        "screenshots": {
+          "dark": "examples/area-chart/native/credits-usage.dark.png",
+          "light": "examples/area-chart/native/credits-usage.light.png"
+        }
+      }
+    ]
+  },
+  "files": [],
+  "dependencies": [
+    "@krizaka/intl@workspace:^",
+    "d3-geo@^3.1.1",
+    "echarts@^6.1.0",
+    "topojson-client@^3.1.0"
+  ],
+  "registryDependencies": [],
+  "demo": {
+    "path": "examples/area-chart/credits-usage.tsx",
+    "content": "import { AreaChart } from \"@krizaka/charts/line\";\n\nconst weeks = [\n  { week: \"2026-08-03\", chat: 9_400, image: 4_100, video: 1_200 },\n  { week: \"2026-08-10\", chat: 10_200, image: 4_600, video: 1_900 },\n  { week: \"2026-08-17\", chat: 9_800, image: 5_300, video: 2_400 },\n  { week: \"2026-08-24\", chat: 11_600, image: 5_100, video: 3_100 },\n  { week: \"2026-08-31\", chat: 12_300, image: 6_200, video: 3_600 },\n  { week: \"2026-09-07\", chat: 12_900, image: 6_000, video: 4_800 },\n  { week: \"2026-09-14\", chat: 13_400, image: 6_900, video: 5_200 },\n  { week: \"2026-09-21\", chat: 14_100, image: 7_400, video: 6_100 },\n];\n\nexport default function CreditsUsage() {\n  return (\n    <AreaChart\n      title=\"Credits used per week, by model\"\n      description=\"Workspace “Atelier Nord”, Pro plan\"\n      data={weeks}\n      x=\"week\"\n      xFormat=\"day\"\n      series={[\n        { key: \"chat\", label: \"Chat\" },\n        { key: \"image\", label: \"Image\" },\n        { key: \"video\", label: \"Video\" },\n      ]}\n      format=\"integer\"\n      stacked\n      thresholds={[{ value: 25_000, label: \"Weekly allowance\", tone: \"warning\" }]}\n    />\n  );\n}\n"
+  },
+  "props": [
+    {
+      "component": "AreaChart",
+      "description": "A volume over time: a line over a soft wash (stacked: the parts of a total).",
+      "props": [
+        {
+          "name": "data",
+          "type": "readonly T[]",
+          "default": null,
+          "description": "The rows, in the order of the x axis.",
+          "required": true
+        },
+        {
+          "name": "title",
+          "type": "string",
+          "default": null,
+          "description": "What the chart shows, in a few words: its accessible name, and its heading unless `hideTitle`.",
+          "required": true
+        },
+        {
+          "name": "brand",
+          "type": "BrandId",
+          "default": null,
+          "description": "The brand whose palette the charts use. Without it, a chart follows a `.brand-<id>` ancestor, else Krizaka. Set it\nwhen the app loads a brand stylesheet on `:root` (`@krizaka/tokens/brands/orazaka.css`).",
+          "required": false
+        },
+        {
+          "name": "className",
+          "type": "string",
+          "default": null,
+          "description": "A class on the figure (layout: margins, grid placement).",
+          "required": false
+        },
+        {
+          "name": "curve",
+          "type": "Curve",
+          "default": null,
+          "description": "The shape between points: `monotone` (default, never overshoots), `linear`, `step` (a value that holds).",
+          "required": false
+        },
+        {
+          "name": "dataTable",
+          "type": "boolean",
+          "default": null,
+          "description": "The \"Show data\" button (the table is in the page for screen readers either way). Default true.",
+          "required": false
+        },
+        {
+          "name": "description",
+          "type": "ReactNode",
+          "default": null,
+          "description": "A sentence under the title: the period, the unit, the source.",
+          "required": false
+        },
+        {
+          "name": "dots",
+          "type": "boolean",
+          "default": null,
+          "description": "A dot on every point (short series). Default false: the end of each line carries one.",
+          "required": false
+        },
+        {
+          "name": "empty",
+          "type": "ReactNode",
+          "default": null,
+          "description": "What to show when there is nothing to draw (default: the `empty` label). An `EmptyState` of\n@krizaka /ui fits.",
+          "required": false
+        },
+        {
+          "name": "endLabels",
+          "type": "boolean",
+          "default": "true",
+          "description": "Write the last value at the end of each line (up to three series). Default true.",
+          "required": false
+        },
+        {
+          "name": "error",
+          "type": "ReactNode",
+          "default": null,
+          "description": "The data could not be loaded: `true` says the default words, a node says yours (a retry button…).",
+          "required": false
+        },
+        {
+          "name": "exportable",
+          "type": "boolean | readonly ExportFormat[]",
+          "default": null,
+          "description": "Export buttons: `true` for PNG, SVG and CSV, or the formats you want.",
+          "required": false
+        },
+        {
+          "name": "format",
+          "type": "ValueFormat",
+          "default": null,
+          "description": "How the values are written (axis, tooltip, table, summary). Default `\"number\"`.",
+          "required": false
+        },
+        {
+          "name": "height",
+          "type": "number",
+          "default": null,
+          "description": "The height of the plot in pixels. Default 280 (a sparkline: 32).",
+          "required": false
+        },
+        {
+          "name": "hideTitle",
+          "type": "boolean",
+          "default": null,
+          "description": "Visually hide the title (it stays the chart's accessible name): a card that already has its heading.",
+          "required": false
+        },
+        {
+          "name": "id",
+          "type": "string",
+          "default": null,
+          "description": "The id of the figure.",
+          "required": false
+        },
+        {
+          "name": "labels",
+          "type": "ChartLabelsInput",
+          "default": null,
+          "description": "The words, translated: the buttons, the states, the written summary.",
+          "required": false
+        },
+        {
+          "name": "legend",
+          "type": "boolean",
+          "default": null,
+          "description": "Show the legend (from two series). Default true.",
+          "required": false
+        },
+        {
+          "name": "live",
+          "type": "boolean",
+          "default": null,
+          "description": "Streaming data (a job queue, an auction): no entrance on updates, no announcement of every new point.",
+          "required": false
+        },
+        {
+          "name": "loading",
+          "type": "boolean",
+          "default": null,
+          "description": "The data is on its way: a skeleton of the chart, announced once.",
+          "required": false
+        },
+        {
+          "name": "locale",
+          "type": "Locale",
+          "default": null,
+          "description": "The locale of every figure and date (`\"fr-FR\"`). Default `\"en-US\"`.",
+          "required": false
+        },
+        {
+          "name": "markers",
+          "type": "readonly Marker[]",
+          "default": null,
+          "description": "Vertical markers at a category: a launch, an incident.",
+          "required": false
+        },
+        {
+          "name": "onSelect",
+          "type": "((datum: T, index: number) => void)",
+          "default": null,
+          "description": "Called with the row when a point or a bar is clicked (or Enter is pressed on it).",
+          "required": false
+        },
+        {
+          "name": "series",
+          "type": "readonly SeriesSpec<T>[]",
+          "default": null,
+          "description": "The series to draw, each with its field and its name; the palette follows their order.",
+          "required": false
+        },
+        {
+          "name": "stacked",
+          "type": "boolean",
+          "default": null,
+          "description": "Stack the series: a total and its parts over time.",
+          "required": false
+        },
+        {
+          "name": "style",
+          "type": "CSSProperties",
+          "default": null,
+          "description": "Inline style on the figure (layout only: colours come from the tokens).",
+          "required": false
+        },
+        {
+          "name": "summary",
+          "type": "\"hidden\" | \"visible\"",
+          "default": null,
+          "description": "The written summary: read by screen readers only (`\"hidden\"`, default), or shown under the chart (`\"visible\"`).",
+          "required": false
+        },
+        {
+          "name": "summaryText",
+          "type": "string",
+          "default": null,
+          "description": "Your own summary instead of the generated one (still read first by screen readers).",
+          "required": false
+        },
+        {
+          "name": "thresholds",
+          "type": "readonly Threshold[]",
+          "default": null,
+          "description": "Horizontal lines at a value: a goal, a payout threshold.",
+          "required": false
+        },
+        {
+          "name": "x",
+          "type": "string | ((datum: T, index: number) => unknown)",
+          "default": null,
+          "description": "The field (or function) of the category: a month (`\"2026-04\"`), a day, a label. Default: the row's position.",
+          "required": false
+        },
+        {
+          "name": "xFormat",
+          "type": "CategoryFormat",
+          "default": null,
+          "description": "How the categories are written. Default: dates by their precision (`2026-04` → `Apr 2026`), text as is.",
+          "required": false
+        },
+        {
+          "name": "xLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the categories in the data table (`Month`).",
+          "required": false
+        },
+        {
+          "name": "y",
+          "type": "string | ((datum: T, index: number) => number | null)",
+          "default": null,
+          "description": "A single series: its field. Use `series` for several.",
+          "required": false
+        },
+        {
+          "name": "yLabel",
+          "type": "string",
+          "default": null,
+          "description": "The name of the single `y` series (legend, tooltip, table). Default: the field's name.",
+          "required": false
+        },
+        {
+          "name": "zero",
+          "type": "boolean",
+          "default": null,
+          "description": "Start the value axis at zero. Default: true for bars and areas; for lines, unless the values sit far from zero.",
+          "required": false
+        }
+      ]
+    }
+  ]
+}