Optional
onA callback to be called when a match is clicked.
undefined
Optional
onA callback to be called when a match's label is clicked.
undefined
Optional
customA function to deeply customize the names of the rounds.
If you just want to translate some words, please use addLocale()
instead.
undefined
Optional
selectorAn optional selector to select the root element.
'.brackets-viewer'
Optional
participantWhere the position of a participant is placed relative to its name.
none
, the position is not added.before
, the position is prepended before the participant name. "#1 Team"after
, the position is appended after the participant name, in parentheses. "Team (#1)"'before'
Optional
separatedWhether to show the child count of a BoX match separately in the match label.
false
, the match label and the child count are in the same place. (Example: "M1.1, Bo3")true
, the match label and the child count are in an opposite place. (Example: "M1.1 (right-->) Bo3")false
Optional
showWhether to show the origin of a slot (wherever possible).
true
Optional
showWhether to show the origin of a slot (in the lower bracket of an elimination stage).
true
Optional
showDisplay a popover when the label of a match with child games is clicked.
true
Optional
highlightWhether to highlight every instance of a participant on hover.
true
Optional
showWhether to show a ranking table on round-robin stages.
true
Optional
rankingA formula to compute the ranking of the participants on round-robin stages.
See RankingItem for the possible properties on item
.
(item) => 3 * item.wins + 1 * item.draws + 0 * item.losses
Optional
clearWhether to clear any previously displayed data.
false
Generated using TypeDoc
An optional config to provide to
brackets-viewer.js