Skip to the content

Taisen Brackets documentation

Taisen Brackets API: every export

Every export of every entry point, each with its own page. This page keeps the addresses the old one-page reference had.

@johnmorrisdotca/taisen-brackets/layout

advanceWinnersfunction

Fills the sides of every tie from the ties that feed it: a decided tie's winner takes its place in the next tie (the loser, for a third-place match).

BackgroundImageOptionstype

Your own picture as the background: an image address (http(s), relative or data:image/…; anything else is refused), laid under a veil so the text reads.

BackgroundOptionstype

A preset, tuned: your own colours (hex or rgb(), the first two the ground), the gradient's angle, how strong the pattern is (0 to 1, default 0.6), a seed for the scattered parts, and which of its two variants.

BracketInputtype

A bracket's input with its teams listed once: { matchups, teams }.

BracketLayouttype

The shape of a bracket worked out from its ties: the ties, the halves, the rounds, the rows and the champion.

collectTeamsfunction

A bracket's teams: the list given, plus a team made from every id that a matchup names and the list does not.

countryNamefunction

The name of a country in a language, from its ISO 3166 code, through Intl.DisplayNames: no list to write ("DE" is Germany, Allemagne, ドイツ, Alemania, Deutschland).

defineLocalefunction

A language of your own: what you give, on top of the base language's (English unless base says another) for what you leave out.

describeTiefunction

A tie in a sentence, for a tooltip, a table and a description: "Argentina 3, France 3 (after extra time, 4–2 on penalties).

Detailtype

How much a box shows: both names and scores, an abbreviation and the score, or only the marks.

DrawOptionstype

Everything a drawing can be told: the layout, look, size, theme, background, language, marks, flags, trophy, links and titles.

EmblemRenderertype

A function from an emblem id and a request to an SVG string; renderEmblem of @johnmorrisdotca/dougu-sports/emblems is one.

EmblemStyletype

How an emblem is drawn; the names are those of @johnmorrisdotca/dougu-sports.

Feedtype

What takes a side of a tie: a tie's id (its winner, as feeds always meant) or { tie, result }, which can name the tie's loser as well (a play-in's loser goes on to a decider).

FlagRenderertype

A function from a country code and a request to an SVG string, or null or undefined for a code it has no flag for.

FlagRequesttype

What a drawing asks a flags renderer for.

FlagShapetype

How a flag is framed: round in a circle, square, or rect in its own proportions.

Gametype

One game of a tie: a match of a knockout, a game of a series, a leg of an aggregate, a replay.

GamesOptionstype

How the games of a flat list are grouped into ties: the stages in order, which one is the third-place match, which are two legs, and how long each series is.

JudoResulttype

The result of one judo contest, the sides in the order of the matchup's sides: the first is white, the second blue.

JudoSidetype

What one side scored in a contest.

layoutBracketfunction

The shape of a knockout, worked out from its ties: which tie feeds which (a winner goes on to the next tie its team plays, or the tie that feeds names), the rounds, which half each tie sits in, and which side has a bye.

LayoutNametype

How the ties are drawn: tree (the default) is the bracket as ever; the others are other ways to draw the same ties.

LayoutOptionstype

What layoutBracket can be told: the shape (halves or left to right) and the order of the groups.

LayoutSidetype

One half of a bracket: its boxes, its rows and the name of its group.

Localetype

A language: its words, the names of the rounds (by their English names), and the tag Intl formats numbers and dates for.

LOCALE_CODESconstant

The codes of the built-in languages, English first.

localeOffunction

The language an option names: a code of a built-in one, or a Locale.

LOCALESconstant

The built-in languages, by code.

Looktype

How a bracket is drawn: classic (the default) or road, with large round marks, big scores and a dotted path.

Matchuptype

One tie: two sides and who went through.

matchupsFromGamesfunction

Matchups from a flat list of games: the games of one pair in one stage become one tie (a replay, two legs or a series), the stage orders the rounds, and the third-place stage becomes the third-place match.

noteLongfunction

The notes of a tie written out, for a sentence or a table: "after extra time", "4–2 on penalties".

notePartsfunction

The pieces of a note under a tie's score, short: "a.e.t.", "pens", "in 7", "agg.".

Placetype

Where the layout put a tie.

PlayedGametype

One played game, in the flat shape that most data sources give.

resolveMatchupfunction

One matchup as a tie: sides resolved to teams, the winner and the result worked out.

Resulttype

What a tie came to, worked out from its games.

roundLabelfunction

The name of round round (1 is the first) of a layout, from the names given (which may be only the last rounds) or the generic ones.

roundNamefunction

The name of a round that has remaining teams left in it, counting from the final: Final, Semi-finals, Quarter-finals, Round of 16…

roundNamesForfunction

The generic names of count rounds, first round first: roundNamesFor(3) is Quarter-finals, Semi-finals, Final.

SideIdtype

A side's key: a team code, a franchise id, anything that is unique within one bracket.

singleEliminationfunction

The matchups of a single-elimination bracket for any number of teams, seeded in the standard way: the top seeds meet the lowest first, and when the number is not a power of two the top seeds have byes.

Sizetype

A size in pixels: a width and, when it is not worked out from the drawing, a height.

SizeNametype

The sizes a drawing has by name: wide, square, card and phone.

Sourcetype

Where a side of a tie comes from: the winner or the loser of the tie at tie (its index).

standardSeedsfunction

The seeds in the order a standard bracket lists them, so that 1 meets 2 only in the final and the top seeds meet the bottom ones first: standardSeeds(8) is [1, 8, 4, 5, 2, 7, 3, 6].

Teamtype

A side of a tie: a team, with the marks and labels a drawing needs.

ThemeNametype

The colours of a drawing: auto follows the page's light or dark, light, dark, poster is dark with gold lines, and none writes no style, for your own CSS.

Tietype

A tie as the layout knows it.

Voicetype

A language ready to write with: the words with any replacements, and the formats.

voiceOffunction

Builds the voice of a drawing from its locale, words and teamName options.

Wordstype

The words a drawing and a table use, in one language.

WORDSconstant

The English words, as they were before there were languages.

@johnmorrisdotca/taisen-brackets/presets

Leaguetype

A league with a playoff format by era: nhl, nba, mlb, nfl, cfl, mls or worldcup.

LEAGUE_EMBLEMSconstant

The emblem each league's champion gets by default: an id of @johnmorrisdotca/dougu-sports (generic forms, no league's own mark).

LEAGUESconstant

The leagues that have a format here.

playoffErasfunction

Every era of a league, oldest first.

playoffFormatfunction

The playoff format of a league in a season (or a World Cup in its year), or null when there was none or this package does not cover it.

PlayoffFormattype

A league's playoff format in one era: the years it ran, its rounds, how many teams it took, its byes and its sources.

PlayoffRoundtype

One round of a playoff format: its name and how many games a series is (null for a single game).

roundNamefunction

The name of a round that has remaining teams left in it, counting from the final: Final, Semi-finals, Quarter-finals, Round of 16…

roundNamesForfunction

The generic names of count rounds, first round first: roundNamesFor(3) is Quarter-finals, Semi-finals, Final.

@johnmorrisdotca/taisen-brackets/road

RoadDecidedtype

How a match was decided: ft (full time, the default), aet (after extra time) or pens (a shoot-out after extra time).

RoadFinaltype

The final, when it has been played.

RoadFinalisttype

A finalist: a team and the matches it played on the way, the earliest first.

RoadGroupMatchtype

One match of the group stage: as a knockout match, without a round.

RoadInputtype

What roadToFinal takes: the two finalists with their paths, or a tournament (a list of matchups, { matchups, teams } or a layout) whose final has two sides.

RoadOptionstype

What roadToFinal takes besides the finalists or the tournament.

RoadScoretype

A match's score from the finalist's side: [for, against] (numbers, or text such as a series' 4), or one text, "4-2", that is split at its dash.

RoadSizetype

The sizes of the road chart are the bracket's: card (the default here), square, wide (the finalists at the two ends) and phone.

RoadTeamtype

A team of a road chart: a Team whose id is optional (a standalone finalist needs only a name), with logo as another name for mark.

roadToFinalfunction

The road to the final: the two finalists as large round marks with their names at the top, each one's matches on its side (the round mark of both teams with the score between them, and FT, AET or the shoot-out under it), the round names down the middle, and the group stage as a compact row of small marks, codes and scores.

@johnmorrisdotca/taisen-brackets/backgrounds

BackgroundInktype

The colours that read well over a background: text, lines, boxes, edges and its dominant colours.

BackgroundSvgtype

A drawn background: the defs and the body to put in an SVG, and the ink that reads over it.

BackgroundSvgOptionstype

What a background is drawn for: its width and height, the theme, colours, angle, intensity and seed.

contrastRatiofunction

The contrast between two colours, from 1 (the same) to 21 (black on white).

luminancefunction

How light a colour is, from 0 (black) to 1 (white), as the WCAG contrast rules measure it.

parseColorfunction

Reads a colour written as #rgb, #rrggbb or rgb(…).

toHexfunction

Writes a colour as #rrggbb.

@johnmorrisdotca/taisen-brackets

abbreviatefunction

A short name for a small box: the initials of a name of several words ("NYR"), else its first three letters; capitals.

advanceWinnersfunction

Fills the sides of every tie from the ties that feed it: a decided tie's winner takes its place in the next tie (the loser, for a third-place match).

BackgroundImageOptionstype

Your own picture as the background: an image address (http(s), relative or data:image/…; anything else is refused), laid under a veil so the text reads.

BackgroundInktype

The colours that read well over a background: text, lines, boxes, edges and its dominant colours.

BackgroundOptionstype

A preset, tuned: your own colours (hex or rgb(), the first two the ground), the gradient's angle, how strong the pattern is (0 to 1, default 0.6), a seed for the scattered parts, and which of its two variants.

BackgroundSvgtype

A drawn background: the defs and the body to put in an SVG, and the ink that reads over it.

BackgroundSvgOptionstype

What a background is drawn for: its width and height, the theme, colours, angle, intensity and seed.

BOARD_SIZESconstant

The sizes of a board: a TV's 1920 by 1080, a tablet on its side (1280 by 800) and upright (800 by 1280), a phone's 600 by 1300, and the social-card shapes, square (1080) and 4:5 (1080 by 1350).

BoardSizeNametype

The sizes of a board: tv, tablet, tablet-tall, phone, square and portrait.

boutBoardfunction

The bout presentation board as a standalone SVG.

BoutBoardOptionstype

What a bout board can be told: the name style and case, and the options of every broadcast board.

boutBoardSizefunction

The width and the height of a bout board with officialCount officials: the width given (1280 by default) and a height of 64 + 38 + 10 + 62 + 10 + 38 + 42 an official + 10, in units of the width over 1280.

BoutBoardSourcetype

A bout to draw: the title, the phase, the bout number, the red and blue athletes and the officials.

BracketInputtype

A bracket's input with its teams listed once: { matchups, teams }.

BracketLayouttype

The shape of a bracket worked out from its ties: the ties, the halves, the rounds, the rows and the champion.

bracketStylefunction

The stylesheet of a drawing with these options, for a page that draws the same bracket twice (a desk's size and a phone's): put it in the page once, give each drawing the same styleScope and style: false, and every drawing takes its colours from it.

bracketTablefunction

The bracket as an HTML table, for a reader the drawing does not serve: one row for every tie, round by round, with the two sides, the score, the winner in bold, the date where the tie has one (written as the language writes dates) and a note.

BROADCAST_LOOKSconstant

The looks: blue (a broadcast's deep blue with a bright title band), night (near black with a cyan band) and paper (white, with the same blue band).

BroadcastIcontype

The icons of the title band's square, drawn by the package: a medal and a stopwatch.

BroadcastLooktype

The looks of a broadcast board: blue, night and paper.

BroadcastMedalOptionstype

What a broadcast medal table can be told: labels (the codes or the names), ranks, the sort and the rows, and the options of every broadcast board.

broadcastMedalSizefunction

The width and the height of a broadcast medal table of rowCount rows: the width given (1280 by default) and a height of 64 + 36 + 10 + 48 a row + 10, in units of the width over 1280.

BroadcastOptionstype

What every broadcast board takes: the width, the look, the icon, the flags, the language, a title and an id.

cleanSvgfunction

Takes inline SVG markup from a caller and makes it safe to put inside a drawing: the outer <svg>'s viewBox is kept, and scripts, event handlers, <style>, <foreignObject>, comments and javascript: addresses are removed.

collectTeamsfunction

A bracket's teams: the list given, plus a team made from every id that a matchup names and the list does not.

CONFERENCE_COLORSconstant

The colours of the two halves (conferences) of the layouts that colour them, each with white letters on it: --tb-conf-a and --tb-conf-b.

contrastRatiofunction

The contrast between two colours, from 1 (the same) to 21 (black on white).

countryNamefunction

The name of a country in a language, from its ISO 3166 code, through Intl.DisplayNames: no list to write ("DE" is Germany, Allemagne, ドイツ, Alemania, Deutschland).

defineLocalefunction

A language of your own: what you give, on top of the base language's (English unless base says another) for what you leave out.

describeBracketfunction

The text a screen reader gets for the drawing as a whole, in the language of locale.

describeJudoCardfunction

The contest card as a sentence, the drawing's description.

describeJudoContestfunction

The words of the state in a sentence, for the drawing's description.

describeJudoQueuefunction

The mat queue as a sentence: for each mat, its contests in order.

describeRankingfunction

The ranking as a sentence, the drawing's description.

describeTiefunction

A tie in a sentence, for a tooltip, a table and a description: "Argentina 3, France 3 (after extra time, 4–2 on penalties).

Detailtype

How much a box shows: both names and scores, an abbreviation and the score, or only the marks.

DrawOptionstype

Everything a drawing can be told: the layout, look, size, theme, background, language, marks, flags, trophy, links and titles.

EmblemRenderertype

A function from an emblem id and a request to an SVG string; renderEmblem of @johnmorrisdotca/dougu-sports/emblems is one.

EmblemStyletype

How an emblem is drawn; the names are those of @johnmorrisdotca/dougu-sports.

EntryListOptionstype

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

EntryListSourcetype

An entry list to draw: a title, a category, a date and the athletes entered, with their rank if they have one.

Feedtype

What takes a side of a tie: a tie's id (its winner, as feeds always meant) or { tie, result }, which can name the tie's loser as well (a play-in's loser goes on to a decider).

FlagRenderertype

A function from a country code and a request to an SVG string, or null or undefined for a code it has no flag for.

FlagRequesttype

What a drawing asks a flags renderer for.

FlagShapetype

How a flag is framed: round in a circle, square, or rect in its own proportions.

Gametype

One game of a tie: a match of a knockout, a game of a series, a leg of an aggregate, a replay.

GamesOptionstype

How the games of a flat list are grouped into ties: the stages in order, which one is the third-place match, which are two legs, and how long each series is.

GroupRowtype

One team's line of a group's table.

groupsTablefunction

The table of the groups as HTML, for a reader the drawing does not serve: one <table> a group, its caption the group's name, a row a team.

groupStandingsfunction

The tables of the group stage: one for each group, from the round-robin games (round: 0) of the ties.

GroupTabletype

One group: its name in the language and its teams, the best first.

isEmblemIdfunction

Whether a trophy value names an emblem ("trophy:hockey-cup", "medal:gold/line") rather than being inline SVG or an image address.

JUDO_BOARD_SIZESconstant

The sizes: a TV's 1920 by 1080, a tablet on its side, 1280 by 800, and a tablet held upright, 800 by 1280.

JUDO_MAT_COLORSconstant

The IJF-style mat colours, in turn: red, green, yellow, purple, orange, teal.

JUDO_WEIGHT_CLASSESconstant

The IJF's senior weight classes in kilograms, the lightest first: a number is "up to and including", a text starting + is "over".

JudoBoardOptionstype

What a judo board can be told: the size, the theme, the style (board or flip cards), which side is on the left, the coaches, the flags and the language.

judoBracketfunction

The contests of one judo weight category for any number of athletes, seeded in the standard way (the top seeds have the byes when the number is not a power of two).

JudoBracketOptionstype

What judoBracket can be told: the system and a prefix for the ties' ids.

JudoCardContesttype

What the contest card shows: the two athletes and the header.

JudoCategorytype

A judo category: the sex and the weight class.

judoCategoryLabelfunction

A weight category as a heading in a language: "Men -66 kg", "Women +78 kg".

JudoContesttype

The state of a contest: who is on the mat, what has been scored, and the clock.

judoContestCardfunction

The contest card: the weight class and the round on top, then the white athlete over the blue one, each as a wide band with the flag, the name as big as the band lets it be, and the country code.

JudoMattype

One mat: its number or name, its colour (any CSS colour that a hex code gives, default by position) and its contests in the order they will be fought.

judoMatQueuefunction

The mat queue board: for each mat a big number in the mat's colour and the contests to come, in order, each a row with the contest number, the white athlete and the blue one (name, code, flag).

judoOutcomefunction

Checks a result against the rules and works out who won and how.

judoPodiumfunction

The gold, silver and two bronze medals of a bracket (matchups, input or layout), from the final, the bronze medal contests or the semi-finals.

JudoPodiumtype

The medallists of a judo tournament, as far as it has been fought.

JudoQueueContesttype

One contest of a mat's queue: its number ("G-24", 24) and the two athletes, and optionally the weight class and the round (for a caption).

JudoQueueOptionstype

What a mat queue can be told: the size, the theme, how many rows, whether the first contest is marked as the current one, and the mat colours.

JudoResulttype

The result of one judo contest, the sides in the order of the matchup's sides: the first is white, the second blue.

JudoRoadOptionstype

What a road panel can be told: the weight class, the side's colour, the order of the wins, how many rows, the size, the theme and the language.

judoRoadPanelfunction

The road-to-the-final panel for an athlete: their block (flag, name, code, coach) in the colour of a judogi, and a row for each contest won, most recent first: the round, the opponent's flag, code and name, and how it was won.

JudoRoadSourcetype

What a road panel shows: the athlete and the contests they won.

judoSecondsfunction

A time as seconds: a number, or "m:ss".

JudoSidetype

What one side scored in a contest.

JudoSystemtype

How a judo tournament is drawn: repechage (the IJF's quarter-final repechage, with its two bronze medal contests), or direct (a direct knockout in which both semi-final losers are bronze medallists).

JudoWintype

One win on the road: the round it was in, the opponent (none for a bye), and how it was won in words ("ippon · 1:12", "decision · GS · 5:12", or a score).

judoWinsfunction

The contests an athlete has won in a bracket, oldest first, with a bye for each round skipped at the start: the opponent, the round (a repechage and a bronze medal contest are named as such) and how it was won, from the judo result's notes or the score.

JudoWinsOptionstype

What judoWins can be told: the language, the round names, how to make an athlete of a team, and whether byes are listed.

layoutBracketfunction

The shape of a knockout, worked out from its ties: which tie feeds which (a winner goes on to the next tie its team plays, or the tie that feeds names), the rounds, which half each tie sits in, and which side has a bye.

LayoutNametype

How the ties are drawn: tree (the default) is the bracket as ever; the others are other ways to draw the same ties.

LayoutOptionstype

What layoutBracket can be told: the shape (halves or left to right) and the order of the groups.

LAYOUTSconstant

The names of the layouts, the tree first.

LayoutSidetype

One half of a bracket: its boxes, its rows and the name of its group.

Leaguetype

A league with a playoff format by era: nhl, nba, mlb, nfl, cfl, mls or worldcup.

LEAGUE_EMBLEMSconstant

The emblem each league's champion gets by default: an id of @johnmorrisdotca/dougu-sports (generic forms, no league's own mark).

LEAGUESconstant

The leagues that have a format here.

Localetype

A language: its words, the names of the rounds (by their English names), and the tag Intl formats numbers and dates for.

LOCALE_CODESconstant

The codes of the built-in languages, English first.

localeOffunction

The language an option names: a code of a built-in one, or a Locale.

LOCALESconstant

The built-in languages, by code.

localizedLayoutfunction

The layout with each team's name in the language: what the drawing, the table and the description are written from.

Looktype

How a bracket is drawn: classic (the default) or road, with large round marks, big scores and a dotted path.

Matchuptype

One tie: two sides and who went through.

MatchupOptionstype

What a matchup board can be told: how many meetings are listed, the name and rank style, the precision, and the options of every board.

matchupRecordfunction

The record of the meetings: how many each athlete won.

matchupsFromGamesfunction

Matchups from a flat list of games: the games of one pair in one stage become one tie (a replay, two legs or a series), the stage orders the rounds, and the third-place stage becomes the third-place match.

MatchupSourcetype

A matchup to draw: the two athletes with their ranks and points, and their earlier meetings.

MedalAwardtype

A medal won: who won it and what kind, with whatever you filter on.

MedalFiltertype

What tallyMedals keeps: awards equal to every field given.

medalRanksfunction

The ranks of a list of rows, as medalTable draws them ([1, 2, 2, 4]), in the order they are drawn.

MedalRowtype

One row of a medal table: a country or a team and its medals.

MedalTableOptionstype

What a medal table can be told: the sort (gold, total or given), ties, how many rows, columns, highlighting, and the options of every board.

MedalTableSourcetype

A medal table to draw: the title, the sport or event, the date, the source and the rows.

noteLongfunction

The notes of a tie written out, for a sentence or a table: "after extra time", "4–2 on penalties".

notePartsfunction

The pieces of a note under a tie's score, short: "a.e.t.", "pens", "in 7", "agg.".

NUMBER_ONE_COLORSconstant

Orange, crimson, blue, teal, purple and amber, each dark enough for white type (4.5 to 1 or better).

NumberOnesOptionstype

What the number-ones board can be told: the columns, the card colours, and the options of every board.

NumberOnesSourcetype

The number ones to draw: a title, a date, a source and one card for each category.

Palettetype

The colours of one look.

Placetype

Where the layout put a tie.

PlayedGametype

One played game, in the flat shape that most data sources give.

playoffErasfunction

Every era of a league, oldest first.

playoffFormatfunction

The playoff format of a league in a season (or a World Cup in its year), or null when there was none or this package does not cover it.

PlayoffFormattype

A league's playoff format in one era: the years it ran, its rounds, how many teams it took, its byes and its sources.

PlayoffRoundtype

One round of a playoff format: its name and how many games a series is (null for a single game).

rankingCategoryLabelfunction

A category as a heading ("U18 · Men -60 kg"): an age group, a sex and a weight, any of them, joined by a dot.

rankingEntryListfunction

An event's entry list: a numbered row for each athlete in the order of the draw, with the flag, the name and club, the country's letters and the athlete's ranking (NR for none) at the right.

rankingMatchupfunction

The head-to-head card for two athletes and their meetings.

RankingNametype

A name in two parts: the family name is written in capitals and first by default (SURNAME Given, as judo and the IJF write it).

rankingNumberOnesfunction

The number ones as cards in a grid: a coloured panel with the 1, the flag, the name and the club or country, the points and a pill that says "#1 in -57 kg".

RankingOptionstype

What a ranking can be told: the style (podium, list or featured), rows and page, columns, movement arrows, name and rank style, and the size, theme and language.

rankingRanksfunction

The ranks of a list, in order: an entry's own rank, else its position, with equal points sharing a rank; null for a champion row.

RankingSourcetype

A ranking to draw: the title, the category, the date, the source and the entries.

resolveBackgroundfunction

Reads the background option for a drawing width by height in the look theme, with prefix for the ids.

ResolvedBackgroundtype

A background ready to put in a drawing: its definitions, its body and the ink that reads over it.

resolveMatchupfunction

One matchup as a tie: sides resolved to teams, the winner and the result worked out.

Resulttype

What a tie came to, worked out from its games.

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.

resultsBoardSizefunction

The width and the height of a results board with rowCount rows: the width given (1280 by default) and a height of 64 + 36 + 20 + 54 a row, in units of the width over 1280.

ResultsBoardSourcetype

A results board to draw: the title, the phase, the columns and the rows.

ResultsColumntype

A column of scores: its heading in the sub bar, and the decimals of its numbers.

ROAD_THEMESconstant

The road look's colours for each theme: light, dark and poster.

RoadDecidedtype

How a match was decided: ft (full time, the default), aet (after extra time) or pens (a shoot-out after extra time).

RoadFinaltype

The final, when it has been played.

RoadFinalisttype

A finalist: a team and the matches it played on the way, the earliest first.

RoadGroupMatchtype

One match of the group stage: as a knockout match, without a round.

RoadInputtype

What roadToFinal takes: the two finalists with their paths, or a tournament (a list of matchups, { matchups, teams } or a layout) whose final has two sides.

RoadOptionstype

What roadToFinal takes besides the finalists or the tournament.

RoadPalettetype

What the road look adds to a palette: the ring and the hairline round a mark, the pill behind a round's name, and the road's dots.

RoadScoretype

A match's score from the finalist's side: [for, against] (numbers, or text such as a series' 4), or one text, "4-2", that is split at its dash.

RoadSizetype

The sizes of the road chart are the bracket's: card (the default here), square, wide (the finalists at the two ends) and phone.

RoadTeamtype

A team of a road chart: a Team whose id is optional (a standalone finalist needs only a name), with logo as another name for mark.

roadToFinalfunction

The road to the final: the two finalists as large round marks with their names at the top, each one's matches on its side (the round mark of both teams with the score between them, and FT, AET or the shoot-out under it), the round names down the middle, and the group stage as a compact row of small marks, codes and scores.

roundLabelfunction

The name of round round (1 is the first) of a layout, from the names given (which may be only the last rounds) or the generic ones.

roundNamefunction

The name of a round that has remaining teams left in it, counting from the final: Final, Semi-finals, Quarter-finals, Round of 16…

roundNamesForfunction

The generic names of count rounds, first round first: roundNamesFor(3) is Quarter-finals, Semi-finals, Final.

safeHreffunction

Whether an address may be a link in a drawing: http(s), a relative path or a # fragment.

safeUrlfunction

Whether an image address is one a drawing will load: http(s), a relative path, or a data:image/.

SideIdtype

A side's key: a team code, a franchise id, anything that is unique within one bracket.

singleEliminationfunction

The matchups of a single-elimination bracket for any number of teams, seeded in the standard way: the top seeds meet the lowest first, and when the number is not a power of two the top seeds have byes.

Sizetype

A size in pixels: a width and, when it is not worked out from the drawing, a height.

SizeNametype

The sizes a drawing has by name: wide, square, card and phone.

SIZESconstant

The sizes by name.

Sourcetype

Where a side of a tie comes from: the winner or the loser of the tie at tie (its index).

standardSeedsfunction

The seeds in the order a standard bracket lists them, so that 1 meets 2 only in the final and the top seeds meet the bottom ones first: standardSeeds(8) is [1, 8, 4, 5, 2, 7, 3, 6].

TableOptionstype

What bracketTable can be told: the language and words, the round names, a caption and a class.

tallyMedalsfunction

Adds up a list of medals into the rows of a table, one row for each name, keeping the first flag, mark, code and note given for it.

Teamtype

A side of a tie: a team, with the marks and labels a drawing needs.

ThemeNametype

The colours of a drawing: auto follows the page's light or dark, light, dark, poster is dark with gold lines, and none writes no style, for your own CSS.

Tietype

A tie as the layout knows it.

VERSIONconstant

The package's version.

Voicetype

A language ready to write with: the words with any replacements, and the formats.

voiceOffunction

Builds the voice of a drawing from its locale, words and teamName options.

Wordstype

The words a drawing and a table use, in one language.

WORDSconstant

The English words, as they were before there were languages.