本文へ移動

Chizu地図

SVGの地図を描き、地域を表示範囲に収め、番号付きの注記や地理クイズを英語と日本語の名前で作れます。

「地図」は、土地や場所を図で表したものです。 名前について(英語)

目次

リファレンス · 表示範囲・形・クイズの道具

insetFor関数

リファレンスの説明と例は英語です。見出しと目次は日本語です。

The inset a region is drawn in, or null when it is drawn where it is.

インポート

import { insetFor } from "@johnmorrisdotca/chizu";

定義

function insetFor(map: Pick<ChizuMap, "insets">, code: string | number): ChizuInset | null

引数

名前型説明
mapPick<ChizuMap, "insets">

The native map or map fields required by this signature; coordinates and region codes belong to its canvas.

codestring | number

The native region or country code; null clears a region selection where accepted.

戻り値

ChizuInset | null

The region’s first inset, or null when it has no inset.

例

import { loadDivisions } from "@johnmorrisdotca/chizu/load";
import { insetFor } from "@johnmorrisdotca/chizu";

const us = (await loadDivisions("us"))!;
console.log(insetFor(us, "AK")?.box, insetFor(us, "TX"));
// { x: 20, y: 610, width: 360, height: 120 } null
{ x: 20, y: 610, width: 360, height: 120 } null

出力(このページを作ったときに実行した結果)

ソースを見るGitHub で編集@johnmorrisdotca/chizu 1.5.0 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。