@krizaka/charts 0.0.0-stage → 0.2.0

package/registry/geo-map.json

@@ -0,0 +1,484 @@
+{
+  "name": "geo-map",
+  "package": "@krizaka/charts",
+  "type": "chart",
+  "title": "Geo map",
+  "summary": "Where: a world choropleth in one sequential hue, bubbles on places, country names in the reader's language — plain SVG, the world loaded on demand.",
+  "description": "Where: a world choropleth in one sequential hue, bubbles on places, country names in the reader's language — plain SVG, the world loaded on demand.",
+  "status": "beta",
+  "category": "charts",
+  "platforms": "web",
+  "engine": "svg",
+  "tier": "advanced",
+  "whenToUse": [
+    "An audience by country: a creator's viewers, a service's users.",
+    "Places with an amount: cities, data centres, as bubbles."
+  ],
+  "whenNotToUse": [
+    {
+      "when": "Deployment regions and the links between them, as a showpiece.",
+      "use": "globe"
+    },
+    {
+      "when": "A precise comparison between a few countries.",
+      "use": "bar-chart"
+    }
+  ],
+  "bestPractices": [
+    "Key the regions by ISO 3166-1 alpha-2 (`FR`, `US`): the names come from `Intl.DisplayNames` in the reader's locale.",
+    "Map rates (per viewer, per capita) rather than raw counts when the countries' sizes differ widely.",
+    "Pair it with a ranked table or bars when the exact order matters."
+  ],
+  "accessibility": {
+    "keyboard": [
+      {
+        "keys": "Arrow keys",
+        "action": "Walk the regions that have data, largest first, then the places."
+      },
+      {
+        "keys": "Home / End",
+        "action": "Jump to the largest or the last item."
+      },
+      {
+        "keys": "Esc",
+        "action": "Clears the active region."
+      }
+    ],
+    "notes": [
+      "The summary names the five largest regions with their shares; the table lists every region and place.",
+      "The Equal Earth projection keeps areas true: no country looks larger than it is.",
+      "The world's countries (~38 kB) are loaded only when a map is drawn; a skeleton holds the height meanwhile."
+    ]
+  },
+  "related": [
+    "globe",
+    "bar-chart",
+    "heatmap"
+  ],
+  "source": "packages/charts/src/meta/geo-map.ts",
+  "install": {
+    "web": "npm install @krizaka/charts",
+    "native": "npx expo install react-native-svg\nnpm install @krizaka/charts"
+  },
+  "web": {
+    "entry": "@krizaka/charts/geo",
+    "import": "import { GeoMap } from \"@krizaka/charts/geo\";",
+    "props": [
+      {
+        "component": "GeoMap",
+        "description": "",
+        "props": [
+          {
+            "name": "data",
+            "type": "readonly T[]",
+            "default": null,
+            "description": "One row per region with a value.",
+            "required": true
+          },
+          {
+            "name": "region",
+            "type": "string | ((datum: T, index: number) => string)",
+            "default": null,
+            "description": "The field (or function) of the region's ISO 3166-1 alpha-2 code (`\"FR\"`, `\"US\"`).",
+            "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": "value",
+            "type": "string | ((datum: T, index: number) => number)",
+            "default": null,
+            "description": "The field (or function) of its value.",
+            "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.",
+            "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": "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": "onSelect",
+            "type": "((datum: T, index: number) => void)",
+            "default": null,
+            "description": "Called with the row when a region is clicked (or Enter is pressed on it).",
+            "required": false
+          },
+          {
+            "name": "points",
+            "type": "readonly GeoPoint[]",
+            "default": null,
+            "description": "Bubbles on places, their area by `value`.",
+            "required": false
+          },
+          {
+            "name": "regionLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the regions and of the values in the table (“Country”, “Viewers”).",
+            "required": false
+          },
+          {
+            "name": "steps",
+            "type": "number",
+            "default": null,
+            "description": "The number of colour steps of the scale. Default 5.",
+            "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": "valueLabel",
+            "type": "string",
+            "default": null,
+            "description": "The header of the values (“Viewers”).",
+            "required": false
+          }
+        ]
+      }
+    ],
+    "examples": [
+      {
+        "name": "viewers",
+        "title": "Viewers by country",
+        "description": "A creator's viewers by country, the top cities as bubbles.",
+        "path": "examples/geo-map/viewers.tsx",
+        "module": "@krizaka/charts/registry/examples/geo-map/viewers",
+        "code": "import { GeoMap } from \"@krizaka/charts/geo\";\n\nconst countries = [\n  { code: \"FR\", viewers: 48_200 }, { code: \"CA\", viewers: 31_500 }, { code: \"BE\", viewers: 9_800 },\n  { code: \"CH\", viewers: 7_400 }, { code: \"MA\", viewers: 12_900 }, { code: \"SN\", viewers: 6_100 },\n  { code: \"US\", viewers: 15_300 }, { code: \"DE\", viewers: 4_200 }, { code: \"TN\", viewers: 5_600 },\n  { code: \"CI\", viewers: 4_900 }, { code: \"BR\", viewers: 2_300 }, { code: \"JP\", viewers: 1_800 },\n];\nconst cities = [\n  { label: \"Paris\", lon: 2.35, lat: 48.86, value: 21_400 },\n  { label: \"Montréal\", lon: -73.57, lat: 45.5, value: 17_800 },\n  { label: \"Casablanca\", lon: -7.59, lat: 33.57, value: 6_300 },\n  { label: \"Dakar\", lon: -17.45, lat: 14.69, value: 3_900 },\n];\n\nexport default function Viewers() {\n  return (\n    <GeoMap\n      title=\"Viewers by country, last 90 days\"\n      data={countries}\n      region=\"code\"\n      value=\"viewers\"\n      points={cities}\n      format=\"compact\"\n      regionLabel=\"Country\"\n      valueLabel=\"Viewers\"\n    />\n  );\n}\n"
+      }
+    ]
+  },
+  "native": null,
+  "files": [],
+  "dependencies": [
+    "@krizaka/intl@workspace:^",
+    "d3-geo@^3.1.1",
+    "echarts@^6.1.0",
+    "topojson-client@^3.1.0"
+  ],
+  "registryDependencies": [],
+  "demo": {
+    "path": "examples/geo-map/viewers.tsx",
+    "content": "import { GeoMap } from \"@krizaka/charts/geo\";\n\nconst countries = [\n  { code: \"FR\", viewers: 48_200 }, { code: \"CA\", viewers: 31_500 }, { code: \"BE\", viewers: 9_800 },\n  { code: \"CH\", viewers: 7_400 }, { code: \"MA\", viewers: 12_900 }, { code: \"SN\", viewers: 6_100 },\n  { code: \"US\", viewers: 15_300 }, { code: \"DE\", viewers: 4_200 }, { code: \"TN\", viewers: 5_600 },\n  { code: \"CI\", viewers: 4_900 }, { code: \"BR\", viewers: 2_300 }, { code: \"JP\", viewers: 1_800 },\n];\nconst cities = [\n  { label: \"Paris\", lon: 2.35, lat: 48.86, value: 21_400 },\n  { label: \"Montréal\", lon: -73.57, lat: 45.5, value: 17_800 },\n  { label: \"Casablanca\", lon: -7.59, lat: 33.57, value: 6_300 },\n  { label: \"Dakar\", lon: -17.45, lat: 14.69, value: 3_900 },\n];\n\nexport default function Viewers() {\n  return (\n    <GeoMap\n      title=\"Viewers by country, last 90 days\"\n      data={countries}\n      region=\"code\"\n      value=\"viewers\"\n      points={cities}\n      format=\"compact\"\n      regionLabel=\"Country\"\n      valueLabel=\"Viewers\"\n    />\n  );\n}\n"
+  },
+  "props": [
+    {
+      "component": "GeoMap",
+      "description": "",
+      "props": [
+        {
+          "name": "data",
+          "type": "readonly T[]",
+          "default": null,
+          "description": "One row per region with a value.",
+          "required": true
+        },
+        {
+          "name": "region",
+          "type": "string | ((datum: T, index: number) => string)",
+          "default": null,
+          "description": "The field (or function) of the region's ISO 3166-1 alpha-2 code (`\"FR\"`, `\"US\"`).",
+          "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": "value",
+          "type": "string | ((datum: T, index: number) => number)",
+          "default": null,
+          "description": "The field (or function) of its value.",
+          "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.",
+          "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": "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": "onSelect",
+          "type": "((datum: T, index: number) => void)",
+          "default": null,
+          "description": "Called with the row when a region is clicked (or Enter is pressed on it).",
+          "required": false
+        },
+        {
+          "name": "points",
+          "type": "readonly GeoPoint[]",
+          "default": null,
+          "description": "Bubbles on places, their area by `value`.",
+          "required": false
+        },
+        {
+          "name": "regionLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the regions and of the values in the table (“Country”, “Viewers”).",
+          "required": false
+        },
+        {
+          "name": "steps",
+          "type": "number",
+          "default": null,
+          "description": "The number of colour steps of the scale. Default 5.",
+          "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": "valueLabel",
+          "type": "string",
+          "default": null,
+          "description": "The header of the values (“Viewers”).",
+          "required": false
+        }
+      ]
+    }
+  ]
+}