broadcastMedalTable関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The broadcast-style medal table as a standalone SVG. Throws a RangeError for what medalTable refuses, more than 24 rows after top and skipEmpty, a labels that is not code or name,
a look or icon that is not one of its values, or a width outside 720 to 4000.
インポート
import { broadcastMedalTable } from "@johnmorrisdotca/taisen-brackets";定義
function broadcastMedalTable(source: MedalTableSource, options?: BroadcastMedalOptions): string引数
| 名前 | 型 | 説明 |
|---|---|---|
source | MedalTableSource | The medal table: the title, the event, the date and the rows. |
options (省略可) | BroadcastMedalOptions | The width, the look, the labels, the ranks, the sort and the language. |
戻り値
string
The SVG, a string that begins with <svg.
例
import { broadcastMedalSize, broadcastMedalTable } from "@johnmorrisdotca/taisen-brackets";
const source = { subtitle: "Day 16", rows: [
{ name: "United States", code: "USA", flag: "US", gold: 46, silver: 29, bronze: 29 },
{ name: "China", code: "CHN", flag: "CN", gold: 38, silver: 27, bronze: 22 },
] };
const svg = broadcastMedalTable(source, { width: 960 });
console.log(svg.includes("TOTAL"), svg.includes("USA"), JSON.stringify(broadcastMedalSize(source.rows.length, { width: 960 })));true true {"width":960,"height":162}出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。