Skip to the content

Taisen Brackets対戦

Knockout brackets as SVG, from a list of ties.

Taisen (対戦, たいせん) is Japanese for a matchup: two sides facing each other. About the name

Contents

Reference · Draw a bracket, a table or a road to the final

ResultsBoardOptionstype

What a results board can be told: the width, the look, the icon, the rank style, the name style and case, and the language.

Import it

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

Definition

interface ResultsBoardOptions extends BroadcastOptions, Pick<RankingOptions, "nameStyle"> {
    rankStyle?: "box" | "medal" | "plain";
    precision?: number;
    ties?: boolean;
    nameCase?: "as-is" | "upper";
}

Members

NameTypeDescription
rankStyle (optional)"plain" | "box" | "medal" | undefined

box (the default: a red square, as a broadcast has it), medal (gold, silver and bronze boxes for the first three) or plain (a white numeral).

precision (optional)number | undefined

Decimals for numeric values where a column names none (3 writes 38.387). Default: as many as the number has, up to three.

ties (optional)boolean | undefined

Equal results share a rank (1, 2, 2, 4). Default true.

nameCase (optional)"as-is" | "upper" | undefined

upper writes the names in capitals; as-is (the default) leaves them as given.

width (optional)number | undefined

The width of the board; the height follows from the rows. Default 1280, from 320 to 4000.

look (optional)BroadcastLook | undefined

blue (the default), night or paper.

icon (optional)BroadcastIcon | undefined

The icon in the square at the left of the title: medal (the default), stopwatch, none, or an iconMark of your own.

iconMark (optional)string | undefined

A mark of your own for that square (inline SVG or an image address), in place of icon.

flags (optional)FlagRenderer | undefined

Draws a flag from its code, as for drawBracket; it is asked for the shape rect (Hata's "4:3").

flagHref (optional)((code: string) => string | null | undefined) | undefined

The address of a flag as a picture to load, tried where flags gives none.

locale (optional)string | Locale | undefined
words (optional)Partial<Words> | undefined
title (optional)string | undefined

The <title> of the drawing. Default: the board's own heading.

id (optional)string | undefined
className (optional)string | undefined
nameStyle (optional)"surname-first" | "given-first" | "as-is" | undefined

surname-first (the default: SURNAME Given), given-first (Given SURNAME) or as-is, for a name given in two parts.

Examples

import { resultsBoard, type ResultsBoardOptions } from "@johnmorrisdotca/taisen-brackets";

const options: ResultsBoardOptions = { width: 960, look: "night", rankStyle: "medal", nameCase: "upper" };
console.log(resultsBoard({
  title: "Men's 100m butterfly",
  phase: "Results · Final",
  columns: [{ precision: 2 }],
  rows: [
    { code: "USA", flag: "US", name: "Michael Phillips", values: [50.58], record: "OR" },
    { code: "HUN", flag: "HU", name: "Laszlo Czigany", values: [50.59] },
  ],
}, options).startsWith("<svg"));
true

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/taisen-brackets 0.20.0.