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

EntryListOptionstype

What an entry list can be told: the sort (entry or ranking), numbers, columns, rows and page.

Import it

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

Definition

interface EntryListOptions extends BoardOptions, Shared {
    sort?: "entry" | "ranking";
    numbers?: boolean;
    columns?: number;
    rows?: number;
    page?: number;
    badge?: boolean;
}

Members

NameTypeDescription
sort (optional)"entry" | "ranking" | undefined

entry (the default) keeps the order given; ranking puts the best ranked first and the unranked last.

numbers (optional)boolean | undefined

Number the rows 1, 2, 3 in the order drawn. Default true.

columns (optional)number | undefined

Columns of rows, 1 to 3. Default: as many as the size needs to keep the rows readable.

rows (optional)number | undefined

The most entries drawn, from the first of the page, and which page (0 is the first). Default: as many as fit at a readable size.

page (optional)number | undefined
badge (optional)boolean | undefined

Draw a club's (or the athlete's) initials on a badge for an entry with no flag or mark, even where none has one.

size (optional)BoardSizeName | { width: number; height: number; } | undefined

One of BOARD_SIZES (tv by default), or a size of your own, { width, height }, at least 200 each way.

theme (optional)"auto" | "light" | "dark" | undefined

auto (the default) follows the page's light or dark, light and dark fix it.

flags (optional)FlagRenderer | undefined

Draws a flag from its code, as for drawBracket: a synchronous function from a code (CA-BC, JP) and { shape, size, theme } to an SVG string, such as one made from @johnmorrisdotca/hata.

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

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

flagShape (optional)"round" | "square" | undefined

round (the default) or square: the shape a flag is asked for and drawn in.

locale (optional)string | Locale | undefined

The language: en, fr, ja, es, de or a Locale.

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

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

id (optional)string | undefined

Prefix for the drawing's ids. Default: a hash of the state and the options.

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.

precision (optional)number | undefined

Decimals for numeric points (2 writes 91.60 and 50.00). Default: as many as the number has, up to three.

Examples

import { rankingEntryList, type EntryListOptions } from "@johnmorrisdotca/taisen-brackets";

const options: EntryListOptions = { sort: "ranking", numbers: true, columns: 2 };
console.log(rankingEntryList({ entries: [{ name: "A", rank: 2 }, { name: "B" }] }, 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.