@krizaka/charts 0.0.0-stage → 0.1.0

package/registry/bar-chart.json

@@ -0,0 +1,783 @@
+{
+  "name": "bar-chart",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Bar chart",
+  "summary": "Amounts compared across categories: grouped, stacked or horizontal bars, each value written at its tip.",
+  "description": "Amounts compared across categories: grouped, stacked or horizontal bars, each value written at its tip.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "both",
+  "engine": "svg",
+  "whenToUse": [
+    "Counts per category or per period: jobs per day by status, revenue per plan.",
+    "A ranking with long names, as horizontal bars: top supporters, busiest models.",
+    "The parts of a total per category, stacked: completed, failed and queued jobs."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "A continuous trend over many points.",
+      "use": "line-chart"
+    },
+    {
+      "when": "Two dimensions of the same measure (weekday × hour).",
+      "use": "heatmap"
+    },
+    {
+      "when": "Stages that lose people on the way.",
+      "use": "funnel"
+    }
+  ],
+  "bestPractices": [
+    "Sort a ranking by value; keep time in its own order.",
+    "Bars always start at zero: a bar's length is its value.",
+    "Stack at most four parts; give each a word in the legend, never a colour alone.",
+    "Use the status tones (`color: \"danger\"`) for statuses only, never for an ordinary series."
+  ],
+  "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."
+      },
+      {
+        "keys": "Enter",
+        "action": "Selects the active bar (calls `onSelect` with its row)."
+      }
+    ],
+    "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.",
+      "A 2 px gap separates the stacked segments, so neighbours stay apart without relying on their colours."
+    ]
+  },
+  "related": [
+    "line-chart",
+    "area-chart",
+    "funnel",
+    "heatmap"
+  ],
+  "source": "packages/charts/src/meta/bar-chart.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/bar",
+    "import": "import { BarChart } from \"@krizaka/charts/bar\";",
+    "props": [
+      {
+        "component": "BarChart",
+        "description": "Compare amounts across categories: grouped, stacked or horizontal bars, each value at its tip.",
+        "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": "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": "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": "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": "horizontal",
+            "type": "boolean",
+            "default": null,
+            "description": "Bars grow to the right, the categories down the side: long labels, rankings.",
+            "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 in one bar per category (a total and its parts); default: grouped side by side.",
+            "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": "valueLabels",
+            "type": "boolean",
+            "default": "true",
+            "description": "Write each value at the tip of its bar (one series, up to 16 bars). Default true.",
+            "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": "jobs-by-status",
+        "title": "Jobs by status",
+        "description": "A week of Orazaka jobs per day, stacked by status in the status tones.",
+        "path": "examples/bar-chart/jobs-by-status.tsx",
+        "module": "@krizaka/charts/registry/examples/bar-chart/jobs-by-status",
+        "code": "import { BarChart } from \"@krizaka/charts/bar\";\n\nconst days = [\n  { day: \"2026-10-05\", completed: 1_240, failed: 38, queued: 12 },\n  { day: \"2026-10-06\", completed: 1_612, failed: 41, queued: 20 },\n  { day: \"2026-10-07\", completed: 1_505, failed: 95, queued: 31 },\n  { day: \"2026-10-08\", completed: 1_788, failed: 27, queued: 18 },\n  { day: \"2026-10-09\", completed: 1_934, failed: 33, queued: 44 },\n  { day: \"2026-10-10\", completed: 1_102, failed: 19, queued: 9 },\n  { day: \"2026-10-11\", completed: 986, failed: 12, queued: 63 },\n];\n\nexport default function JobsByStatus() {\n  return (\n    <BarChart\n      title=\"Jobs per day, by status\"\n      description=\"Orazaka · all workspaces\"\n      data={days}\n      x=\"day\"\n      xFormat=\"day\"\n      series={[\n        { key: \"completed\", label: \"Completed\", color: \"success\" },\n        { key: \"failed\", label: \"Failed\", color: \"danger\" },\n        { key: \"queued\", label: \"Queued\", color: \"neutral\" },\n      ]}\n      format=\"integer\"\n      stacked\n      exportable={[\"csv\", \"png\"]}\n    />\n  );\n}\n"
+      },
+      {
+        "name": "top-supporters",
+        "title": "Ranking",
+        "description": "Horizontal bars: a creator's top supporters, the value at each tip.",
+        "path": "examples/bar-chart/top-supporters.tsx",
+        "module": "@krizaka/charts/registry/examples/bar-chart/top-supporters",
+        "code": "import { BarChart } from \"@krizaka/charts/bar\";\n\n// Cents, sorted by amount: a ranking reads top to bottom.\nconst supporters = [\n  { name: \"Léa Fontaine\", total: 48_500 },\n  { name: \"Marcus Oyelaran\", total: 36_200 },\n  { name: \"Hana Watanabe\", total: 29_900 },\n  { name: \"Tomás Ferreira-Lindqvist\", total: 21_400 },\n  { name: \"Eric Dubois\", total: 17_800 },\n  { name: \"Amira Haddad\", total: 12_050 },\n];\n\nexport default function TopSupporters() {\n  return (\n    <BarChart\n      title=\"Top supporters this quarter\"\n      data={supporters}\n      x=\"name\"\n      xLabel=\"Supporter\"\n      y=\"total\"\n      yLabel=\"Total\"\n      format={{ style: \"money\", currency: \"EUR\" }}\n      horizontal\n      height={260}\n    />\n  );\n}\n"
+      },
+      {
+        "name": "plans-by-quarter",
+        "title": "Grouped",
+        "description": "Revenue per plan, grouped by quarter.",
+        "path": "examples/bar-chart/plans-by-quarter.tsx",
+        "module": "@krizaka/charts/registry/examples/bar-chart/plans-by-quarter",
+        "code": "import { BarChart } from \"@krizaka/charts/bar\";\n\n// Thousands of euros per quarter.\nconst quarters = [\n  { quarter: \"Q4 2025\", starter: 18, pro: 42, studio: 26 },\n  { quarter: \"Q1 2026\", starter: 21, pro: 51, studio: 34 },\n  { quarter: \"Q2 2026\", starter: 24, pro: 58, studio: 47 },\n  { quarter: \"Q3 2026\", starter: 22, pro: 66, studio: 61 },\n];\n\nexport default function PlansByQuarter() {\n  return (\n    <BarChart\n      title=\"Revenue per plan (k€)\"\n      data={quarters}\n      x=\"quarter\"\n      xLabel=\"Quarter\"\n      series={[\n        { key: \"starter\", label: \"Starter\" },\n        { key: \"pro\", label: \"Pro\" },\n        { key: \"studio\", label: \"Studio\" },\n      ]}\n      format=\"integer\"\n    />\n  );\n}\n"
+      }
+    ]
+  },
+  "native": {
+    "entry": "@krizaka/charts/native",
+    "import": "import { BarChart } from \"@krizaka/charts/native\";",
+    "differences": [
+      "Vertical bars only (no `horizontal`), no value labels at the tips.",
+      "No data table or export: swipe up and down on the chart to hear each category."
+    ],
+    "props": [
+      {
+        "component": "BarChart",
+        "description": "Amounts across categories (React Native): grouped or `stacked` bars.",
+        "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": "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 in one bar per category; default: grouped side by side.",
+            "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": "jobs-by-status",
+        "title": "Jobs by status",
+        "description": "A week of jobs, stacked by status.",
+        "path": "examples/bar-chart/native/jobs-by-status.tsx",
+        "module": "@krizaka/charts/registry/examples/bar-chart/native/jobs-by-status",
+        "code": "import { BarChart } from \"@krizaka/charts/native\";\n\nconst days = [\n  { day: \"2026-10-07\", completed: 1_505, failed: 95 },\n  { day: \"2026-10-08\", completed: 1_788, failed: 27 },\n  { day: \"2026-10-09\", completed: 1_934, failed: 33 },\n  { day: \"2026-10-10\", completed: 1_102, failed: 19 },\n  { day: \"2026-10-11\", completed: 986, failed: 12 },\n];\n\nexport default function JobsByStatus() {\n  return (\n    <BarChart\n      title=\"Jobs per day\"\n      data={days}\n      x=\"day\"\n      xFormat=\"day\"\n      series={[\n        { key: \"completed\", label: \"Completed\", color: \"success\" },\n        { key: \"failed\", label: \"Failed\", color: \"danger\" },\n      ]}\n      format=\"compact\"\n      stacked\n    />\n  );\n}\n",
+        "screenshots": {
+          "dark": "examples/bar-chart/native/jobs-by-status.dark.png",
+          "light": "examples/bar-chart/native/jobs-by-status.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/bar-chart/jobs-by-status.tsx",
+    "content": "import { BarChart } from \"@krizaka/charts/bar\";\n\nconst days = [\n  { day: \"2026-10-05\", completed: 1_240, failed: 38, queued: 12 },\n  { day: \"2026-10-06\", completed: 1_612, failed: 41, queued: 20 },\n  { day: \"2026-10-07\", completed: 1_505, failed: 95, queued: 31 },\n  { day: \"2026-10-08\", completed: 1_788, failed: 27, queued: 18 },\n  { day: \"2026-10-09\", completed: 1_934, failed: 33, queued: 44 },\n  { day: \"2026-10-10\", completed: 1_102, failed: 19, queued: 9 },\n  { day: \"2026-10-11\", completed: 986, failed: 12, queued: 63 },\n];\n\nexport default function JobsByStatus() {\n  return (\n    <BarChart\n      title=\"Jobs per day, by status\"\n      description=\"Orazaka · all workspaces\"\n      data={days}\n      x=\"day\"\n      xFormat=\"day\"\n      series={[\n        { key: \"completed\", label: \"Completed\", color: \"success\" },\n        { key: \"failed\", label: \"Failed\", color: \"danger\" },\n        { key: \"queued\", label: \"Queued\", color: \"neutral\" },\n      ]}\n      format=\"integer\"\n      stacked\n      exportable={[\"csv\", \"png\"]}\n    />\n  );\n}\n"
+  },
+  "props": [
+    {
+      "component": "BarChart",
+      "description": "Compare amounts across categories: grouped, stacked or horizontal bars, each value at its tip.",
+      "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": "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": "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": "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": "horizontal",
+          "type": "boolean",
+          "default": null,
+          "description": "Bars grow to the right, the categories down the side: long labels, rankings.",
+          "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 in one bar per category (a total and its parts); default: grouped side by side.",
+          "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": "valueLabels",
+          "type": "boolean",
+          "default": "true",
+          "description": "Write each value at the tip of its bar (one series, up to 16 bars). Default true.",
+          "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
+        }
+      ]
+    }
+  ]
+}