ChizuCityPlacedtype
A city placeCities named: where its dot is on the canvas, the name printed and the side of the dot it is on.
Import it
import type { ChizuCityPlaced } from "@johnmorrisdotca/chizu/cities";
Also exported from: @johnmorrisdotca/chizu
Definition
type ChizuCityPlaced = {
city: ChizuCity;
x: number;
y: number;
name: string;
side: "right" | "left" | "above" | "below";
};
Members
| Name | Type | Description |
|---|---|---|
city | ChizuCity | The city, as it was given. |
x | number | Its dot's place on the canvas, in the copy of the canvas it was named in. |
y | number | |
name | string | The name printed: Japanese on a Japanese page where the city has one (its short form, |
side | "right" | "left" | "above" | "below" | Which side of the dot the name is on: tried right, left, above, below in that order. |
Examples
import WORLD from "@johnmorrisdotca/chizu/world";
import { placeCities, wholeMapBox, type ChizuCityPlaced } from "@johnmorrisdotca/chizu";
const tokyo = { id: "Q1490", name: { en: "Tokyo" }, lat: 35.69, lon: 139.69, population: 14_000_000 };
const placed: ChizuCityPlaced[] = placeCities(WORLD, [tokyo], wholeMapBox(WORLD), [0], { language: "en" });
console.log(placed[0]?.side);
// rightrightWhat it prints (run when this page was built)