Reference · Framing, geometry and quiz tools
insetForfunction
The inset a region is drawn in, or null when it is drawn where it is.
Import it
import { insetFor } from "@johnmorrisdotca/chizu";Definition
function insetFor(map: Pick<ChizuMap, "insets">, code: string | number): ChizuInset | nullParameters
| 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 | null
The region’s first inset, or null when it has no inset.
Examples
import { loadDivisions } from "@johnmorrisdotca/chizu/load";
import { insetFor } from "@johnmorrisdotca/chizu";
const us = (await loadDivisions("us"))!;
console.log(insetFor(us, "AK")?.box, insetFor(us, "TX"));
// { x: 20, y: 610, width: 360, height: 120 } null{ x: 20, y: 610, width: 360, height: 120 } nullWhat it prints (run when this page was built)