Reference · Framing, geometry and quiz tools
insetsForfunction
Every box a region is drawn in, in the map's order: none for most, one for Alaska, three for Okinawa (its main islands, the Sakishima Islands and the Daito Islands, each in a box of its own) and three for Tokyo's far islands.
Import it
import { insetsFor } from "@johnmorrisdotca/chizu";Definition
function insetsFor(map: Pick<ChizuMap, "insets">, code: string | number): ChizuInset[]Parameters
| Name | Type | Description |
|---|---|---|
map | Pick<ChizuMap, "insets"> | The native map or map fields required by this signature; coordinates and region codes belong to its canvas. |
code | string | number | The native region or country code; null clears a region selection where accepted. |
Returns
ChizuInset[]
Every box a region is drawn in, in the map's order: none for most, one for Alaska, three for Okinawa (its main islands, the Sakishima Islands and the Daito Islands, each in a box of its own) and three for Tokyo's far islands.
Examples
import { loadDivisions } from "@johnmorrisdotca/chizu/load";
import { insetsFor } from "@johnmorrisdotca/chizu";
const japan = (await loadDivisions("jp"))!;
console.log(insetsFor(japan, "47").length, insetsFor(japan, "13").length, insetsFor(japan, "1").length);
// 3 3 03 3 0What it prints (run when this page was built)