groupTones関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
Tones that fade every region outside a group (faint unless another tone is named) and leave the group's own as
they are, or give them inside's tones: for a map of a continent drawn on the world, with its neighbours as a
pale coast round it.
インポート
import { groupTones } from "@johnmorrisdotca/chizu";定義
function groupTones(map: Groupable, codes: ReadonlyArray<string | number>, outside?: string, inside?: Readonly<Record<string, string>>): Record<string, string>引数
| 名前 | 型 | 説明 |
|---|---|---|
map | Groupable | 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. |
outside (省略可) | string | The tone assigned to regions outside the chosen group. |
inside (省略可) | Readonly<Record<string, string>> | Optional tone overrides for regions inside the chosen group. |
戻り値
Record<string, string>
Tones that fade every region outside a group (faint unless another tone is named) and leave the group's own as they are, or give them inside's tones: for a map of a continent drawn on the world, with its neighbours as a pale coast round it.
例
import WORLD from "@johnmorrisdotca/chizu/world";
import { groupTones } from "@johnmorrisdotca/chizu";
const tones = groupTones(WORLD, ["JP", "KR"], "muted", { JP: "selected" });
console.log(tones.JP, tones.KR, tones.CN);
// selected undefined mutedselected undefined muted出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。