placePorts関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
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 { placePorts } from "@johnmorrisdotca/chizu";
定義
function placePorts(map: Pick<ChizuMap, "projection"> & Partial<Pick<ChizuMap, "kind" | "regions">>, ports: readonly ChizuPort[], box: MapBox, offsets: readonly number[], options?: ChizuPortOptions): ChizuPortPlaced[]
引数
| 名前 | 型 | 説明 |
|---|---|---|
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 (省略可) | ChizuPortOptions | The tier and the kinds. |
戻り値
ChizuPortPlaced[]
The places marked, with their place on the canvas.
例
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(" "));
// yokohamayokohama出力(このページを作ったときに実行した結果)
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。