Reference · Framing, geometry and quiz tools
ChizuMaptype
A map: a canvas and its regions. What every file of data holds, and what every function of the engine takes.
Import it
import type { ChizuMap } from "@johnmorrisdotca/chizu";Definition
interface ChizuMap {
id: string;
kind: "world" | "country" | "divisions" | "local";
name: string;
nameJa?: string;
regionName: string;
regionNamePlural: string;
viewBox: string;
width: number;
height: number;
wraps: boolean;
projection: ChizuProjection;
insets: ChizuInset[];
source: string;
regions: ChizuRegion[];
}Members
| Name | Type | Description |
|---|---|---|
id | string |
|
kind | "world" | "country" | "divisions" | "local" | What its regions are: the whole |
name | string | The map's name in English and Japanese. |
nameJa (optional) | string | undefined | |
regionName | string | What a region is called here, singular and plural, in English: |
regionNamePlural | string | |
viewBox | string | The canvas: |
width | number | |
height | number | |
wraps | boolean | Whether its east edge is its west edge: a map of the earth is a cylinder cut open, and pans round without stopping. |
projection | ChizuProjection | |
insets | ChizuInset[] | The regions drawn in boxes of their own. |
source | string | Where the outlines come from, in a line. |
regions | ChizuRegion[] |
Examples
import WORLD from "@johnmorrisdotca/chizu/world";
import type { ChizuMap } from "@johnmorrisdotca/chizu";
const map: ChizuMap = WORLD;
console.log(map.id, map.kind, map.viewBox, map.regions.length, map.wraps);
// world world 0 0 1000 489 173 trueworld world 0 0 1000 489 173 trueWhat it prints (run when this page was built)