groupBox関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The window that shows a group whole, shaped to the frame it is drawn in (aspect, how much wider than tall), with
a little room round it. Each member is framed on its mainland (mainlandBounds), so France's overseas
departments, drawn on the world as part of France, do not stretch Europe's window to South America; a region drawn
in a box is framed where it is drawn. The whole map for a group the map has none of.
インポート
import { groupBox } from "@johnmorrisdotca/chizu";定義
function groupBox(map: ChizuMap, codes: ReadonlyArray<string | number>, aspect?: number): MapBox引数
| 名前 | 型 | 説明 |
|---|---|---|
map | ChizuMap | The native map or map fields required by this signature; coordinates and region codes belong to its canvas. |
codes | readonly (string | number)[] | Native region codes from this map, in the requested order. |
aspect (省略可) | number | The desired window width divided by its height. |
戻り値
MapBox
The window that shows a group whole, shaped to the frame it is drawn in (aspect, how much wider than tall), with a little room round it. Each member is framed on its mainland (mainlandBounds), so France's overseas departments, drawn on the world as part of France, do not stretch Europe's window to South America; a region drawn in a box is framed where it is drawn. The whole map for a group the map has none of.
例
import WORLD from "@johnmorrisdotca/chizu/world";
import { CHIZU_CONTINENTS } from "@johnmorrisdotca/chizu/names";
import { drawChizu } from "@johnmorrisdotca/chizu/draw";
import { groupBox, groupTones } from "@johnmorrisdotca/chizu";
const europe = CHIZU_CONTINENTS.find((continent) => continent.code === "EU")!;
const svg = drawChizu(WORLD, { box: groupBox(WORLD, europe.codes, 4 / 3), tones: groupTones(WORLD, europe.codes) });
console.log(svg.startsWith("<svg"));
// truetrue出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。