SouthAfricaMap
Every example on this page is live, drawn by the library's Storybook, where you can also change its props and see the result.
A monochromatic SVG map of South Africa, shading its 9 provinces using fill patterns and optional numeric labels. Uses a Mercator projection. The map keeps its proportions, filling as much of its box as it can and centered in the rest, in any box it is laid out in.
Import
import { SouthAfricaMap } from "~lib/data-display/maps/south-africa-map";
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
data | Partial<Record<SouthAfricaProvinceName, SouthAfricaMapEntry>> | Yes | N/A | Per-province shading and optional value |
showValues | boolean | No | false | Render numeric labels at province centroids |
markers | MapMarker[] | No | N/A | Places to mark, each in its shape with an optional name beside it |
legend | MapLegendEntry[] | No | N/A | What each marker shape stands for, in a row under the map |
width | number | string | No | 360 | Component width (px or CSS string); with height="fill", the column's width unless given |
height | number | "fill" | string | No | 280 | Component height (px or CSS string), or "fill" to be as tall as its width makes it at the map's proportion |
SouthAfricaProvinceName
9 provinces: "Eastern Cape", "Free State", "Gauteng", "KwaZulu-Natal", "Limpopo", "Mpumalanga", "Northern Cape", "North West", "Western Cape".
SouthAfricaMapEntry
type SouthAfricaMapEntry = {
shading: "solid" | "diagonal" | "dots" | "crosshatch";
value?: number;
};
MapMarker
type MapMarker = {
latitude: number;
longitude: number;
label?: string;
shape?: "circle" | "square" | "triangle" | "diamond"; // "circle" by default
};
type MapLegendEntry = {
shape: "circle" | "square" | "triangle" | "diamond";
label: string;
};
Examples
Default
With Values
All Patterns
With Markers
markers puts a dot on each place you give, with its label beside it where there is room, and a marker's shape draws it as a square, a triangle or a diamond instead, which legend names under the map. height="fill" makes the box as tall as its width makes it at the map's proportion. See WorldMap for how labels are placed, how the legend gives way and how a filled map shrinks.