`boutBoard`関数

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

The bout presentation board as a standalone SVG. Throws a RangeError for a board with no title, an athlete or official with no name, more than 12 officials, a role that is not a text, an unknown option value, or a width outside 720 to 4000.

インポート

import { boutBoard } from "@johnmorrisdotca/taisen-brackets";

定義

function boutBoard(source: BoutBoardSource, options?: BoutBoardOptions): string

引数

名前	型	説明
`source`	`BoutBoardSource`	The bout, its athletes and its officials.
`options` (省略可)	`BoutBoardOptions`	The width, the look, the icon, the language and the flags.

戻り値

string

The SVG, a string that begins with <svg.

例

import { boutBoard, boutBoardSize } from "@johnmorrisdotca/taisen-brackets";

const source = {
  title: "Women's 57-60 kg",
  phase: "Preliminaries",
  bout: 142,
  red: { code: "BRA", flag: "BR", name: "TAVARES M." },
  blue: { code: "USA", flag: "US", name: "MAYER M." },
  officials: [{ role: "referee", code: "MGL", flag: "MN", name: "KHISHIGEE Khas-Erdene" }, { code: "POL", flag: "PL", name: "GORNY Mariusz" }],
};
const svg = boutBoard(source, { width: 960 });
console.log(svg.includes("BOUT: 142"), svg.includes("REFEREE AND JUDGES"), JSON.stringify(boutBoardSize(source.officials.length, { width: 960 })));

true true {"width":960,"height":237}

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

ソースを見る GitHub で編集@johnmorrisdotca/taisen-brackets 0.20.0 のソースから作成しました。

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

boutBoard関数

定義

引数

戻り値

例

`boutBoard`関数