Reference · Framing, geometry and quiz tools
placePortsfunction
Which places a window marks and where: the tier the window's ground calls for (or options.tier), in the list's order,
each place left out where its mark would touch one already placed. Places off the window, or on a map that cannot
place a point, are left out; on a map of one country alone, only that country's.
Import it
import { placePorts } from "@johnmorrisdotca/chizu";
Definition
function placePorts(map: Pick<ChizuMap, "projection"> & Partial<Pick<ChizuMap, "kind" | "regions">>, ports: readonly ChizuPort[], box: MapBox, offsets: readonly number[], options?: ChizuPortOptions): ChizuPortPlaced[]
Parameters
| Name | Type | Description |
|---|---|---|
map | Pick<ChizuMap, "projection"> & Partial<Pick<ChizuMap, "regions" | "kind">> | The map the places go on. |
ports | readonly ChizuPort[] | The places to choose from, most important first. |
box | MapBox | The window. |
offsets | readonly number[] | The copies of the canvas drawn across a wrapping map ( |
options (optional) | ChizuPortOptions | The tier and the kinds. |
Returns
ChizuPortPlaced[]
The places marked, with their place on the canvas.
Examples
import WORLD from "@johnmorrisdotca/chizu/world";
import { placePorts, wholeMapBox } from "@johnmorrisdotca/chizu";
const port = { id: "yokohama", kind: "harbour", name: { en: "Yokohama" }, country: "JP", lat: 35.45, lon: 139.65, tier: 1 } as const;
console.log(placePorts(WORLD, [port], wholeMapBox(WORLD), [0]).map((placed) => placed.port.id).join(" "));
// yokohamayokohamaWhat it prints (run when this page was built)