Reference · Framing, geometry and quiz tools
shapeGlyphBoxfunction
A square window on one region's own outline, for drawing it as an icon: every shape gets the same box and fills it, so a small region is as legible in a list as a large one.
Import it
import { shapeGlyphBox } from "@johnmorrisdotca/chizu";
Definition
function shapeGlyphBox(bbox: readonly [number, number, number, number]): MapBox
Parameters
| Name | Type | Description |
|---|---|---|
bbox | readonly [number, number, number, number] | The native left, top, right and bottom bounds of the geometry. |
Returns
MapBox
A square window on one region's own outline, for drawing it as an icon: every shape gets the same box and fills it, so a small region is as legible in a list as a large one.
Examples
import WORLD from "@johnmorrisdotca/chizu/world";
import { shapeGlyphBox } from "@johnmorrisdotca/chizu";
const chile = WORLD.regions.find((region) => region.code === "CL")!;
const box = shapeGlyphBox(chile.bbox);
console.log(box.width === box.height);
// truetrueWhat it prints (run when this page was built)