Soccer Widgets
Sportradar offers a vast array of customizable Soccer widgets, with in-depth statistics.
> Click here for our Soccer Widget Showcase. >The Widget Showcase provides an interactive display of all widgets available. Each widget can be viewed in Desktop, Tablet, and Mobile widths, and with or without a border. >Click the three-barred icon to view an individual widget in a new window. Click the carrot icon to view integration code samples, and copy to your clipboard.Please check out our Soccer product demonstration below for an overview of every possible configuration.
Reference the left sidebar or below table for a direct link to each individual widget, which includes product descriptions, parameter specifications, and live clickable samples.
We currently offer widgets for the following leagues: English Premier League, Major League Soccer, UEFA Champions League, UEFA Europa League, La Liga, Serie A, Bundesliga, and Ligue 1
### Soccer Widgets by Type ## Attacking Performance Indicator us.match.soccer.attackDefensePerformanceIndicator displays a dashboard of a team's performance in defense or in attack during a given match. > For the widget to render you must provide a validmatchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
mode |
string | optional | attack | Performance indication mode. Valid options are: attack or defense . |
||
team |
string | optional | away | Choice of home or away team. |
||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Average Goals
us.match.soccer.AverageGoalsScoredConceded displays a graph of average goals scored and conceded for each team in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
disableWidgetTitle |
boolean | optional | If true removes the the match title. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Average Goals Per Period
us.match.soccer.averageGoalsPerPeriod displays a graph of average goals per 15-minute period for each team in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
minMatchesThisSeason |
number | optional | Minimum number of matches to include for the season. | |||
allowLast |
boolean | optional | If true the display will include data from the previous season. |
|||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
showTitle |
boolean | optional | If true displays the match title above the graph. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Ball Possession
us.match.soccer.ballPossessionExtended provides a ball possession graph for a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
disableballPossession |
boolean | optional | If true hides ball possession. |
|||
disablePitchStatistics |
boolean | optional | If true hides pitch statistics. |
|||
disablePlayDirection |
boolean | optional | If true hides the play direction arrow. |
|||
layout |
string | optional | circular | Choose between circular and line graphical options. |
||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Bet Percentage Tracking
us.betting.match.betPercentageTrackingSlim displays a small bet tracking graph for a given match, with selections for bet percentage (Spread, Moneyline, Total).
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
type |
string | optional | 'moneyline' | Betting percentage type to display. Options are: moneyline , spread , total . |
||
hideDropdown |
boolean | optional | If true hides the dropdown and displays the type title. |
|||
border |
boolean | optional | 'true' | If false hides a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Betting Player Comparison
us.betting.match.soccer.playerComparison compares statistics of two players of the same position among a variety of timeframes (Provided Game, Last 5 Games, Season, or Career). Also includes betting data for the given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
type |
string | optional | Selects stats type dropdownn. Valid options are match , matchup , last5 , season , or career . |
|||
awayPlayerId |
number | optional | Player ID from away team. | |||
homePlayerId |
number | optional | Player ID from home team. | |||
hasPlayed |
boolean | optional | If true only actually played matches are considered for last matchup and last 5 meetings. |
|||
disableScore |
boolean | optional | If true disables the Setting Score header. |
|||
border |
boolean | optional | 'true' | If false hides a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Betting Score
us.betting.match.soccer.score displays a small scoreboard with odds from a given soccer match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
showDate |
boolean | optional | 'true' | If true displays the scheduled date. |
||
showBroadcastNetwork |
boolean | optional | 'true' | If true displays broadcast network info. |
||
showVenueInfo |
boolean | optional | 'true' | If true shows venue info. |
||
disableMatchClick |
boolean | optional | If true disables onItemClick handler for the match. |
|||
disableTeamClick |
boolean | optional | If true disables onItemClick handler for teams. |
|||
border |
boolean | optional | 'true' | If false hides a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Correct Score Matrix
us.match.soccer.CorrectScoreMatrix provides scoring probabilities for a live match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Facts and Figures Carousel
us.match.soccer.FactsAndFigures provides historical facts about team performance, including losing and winning streaks, scoring averages, and an intelligent algorithm that provides relevant insights during a live match.
>
>
This widget is for upcoming and live matches only. For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
matchId |
number | required | Match ID | |
disableWidgetHeader |
boolean | optional | false | If true hides the widget header. |
enableBettingStimulationMode |
boolean | optional | false | If true displays odds for the match. |
defaultCollapsed |
boolean | optional | false | If true sets the widget to collapsible mode. |
enableAutoplay |
boolean | optional | false | If true turns on autoplay. |
autoplayInterval |
boolean | optional | 30 | Sets autoplay interval in seconds. |
border |
boolean | optional | If true draws a border around the widget. |
|
oddsDeeplinkLabels |
object | optional | An object of deeplinking labels. | |
deeplinkParams |
object | optional | An object of deeplinking parameters. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Future Odds
us.betting.season.futureOdds provides future odds for a variety of outrights.
>
For the widget to render you must provide a valid uniqueTournamentId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
uniqueTournamentId |
number | required | Unique Tournament ID | |
outrightId |
number | optional | Outright ID | |
competitorsLimit |
number | optional | '5' | Sets the competitor limit per outright. |
oddsTypeOverride |
string | optional | Overrides the default oddsType. Valid values are: us (money line), eu (decimal) and uk (fractional). |
|
sanitizeOdds |
boolean | optional | true | If true filters out indeterminate odds. |
addWordOddsToOutrightNaming |
boolean | optional | If true includes the word "ODDS" in the title of each outright. |
|
disableDropdown |
boolean | optional | If true disables the dropdown and displays the title of the outright. |
|
displayGrid |
boolean | optional | If true displays all available outrights as a grid. outrightId prop and dropdown are disabled. |
|
enableTeamColors |
boolean | optional | Team colors switch. | |
border |
boolean | optional | If true draws a border around the widget. |
|
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Future Odds Table
us.betting.season.futureOddsTable provides an outright odds table with specific bookmakers, as well as a consensus average betting line.
>
For the widget to render you must provide a valid uniqueTournamentId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
uniqueTournamentId |
number | required | Unique Tournament ID | |
outrightId |
number | optional | Outright ID | |
competitorId |
number | optional | Competitor ID | |
filter |
string | optional | Determines the entity by which outrights are grouped and filtered. It reflects the values in the dropdown. Valid values are: futures , competitors and competitorTypes . |
|
oddsTypeOverride |
string | optional | Overrides the default oddsType. Valid values are: us (money line), eu (decimal) and uk (fractional). |
|
sanitizeOdds |
boolean | optional | true | If true filters out indeterminate odds. |
addWordOddsToOutrightNaming |
boolean | optional | If true includes the word "ODDS" in the title of each outright. |
|
disableAvgColumn |
boolean | optional | If true hides the average column in the table. |
|
disableHeader |
boolean | optional | If true hides the header. |
|
disableTournamentDropdown |
boolean | optional | If true hides the tournament dropdown. |
|
disableFeatureDropdown |
boolean | optional | If true disables the feature dropdown. Applicable to the futures layout. |
|
disableCompetitorTypeDropdown |
boolean | optional | If true disables the competitor type dropdown. Applicable to the competitors and competitorsType layout. |
|
disableCompetitorDropdown |
boolean | optional | If true disables the competitor dropdown. Applicable to the competitors layout. |
|
disableSorting |
boolean | optional | If true disables the table sorting. Single-row tables have sorting turned off by default. |
|
enableTeamColors |
boolean | optional | Enables team colors. | |
border |
boolean | optional | If true draws a border around the widget. |
|
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team click or touch and matchId on widget click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Head to Head
us.match.soccer.headToHead provides detailed head to head statistics for teams in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
disableHeader |
boolean | optional | If true hides the header. |
|||
disableHeaderDetails |
boolean | optional | If true hides the header details. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Live Match Carousel
us.match.soccer.liveMatchCarousel displays a scrolling carousel of live or upcoming soccer matches.
>
For the widget to render you must provide a valid uniqueTournamentId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
uniqueTournamentId |
number | required | Unique tournament ID | |||
limit |
number | optional | 10 | Maximum number of matches shown. | ||
autoplay |
boolean | optional | 'true' | If false stops the carousel autoplay. |
||
autoplaySpeed |
number | optional | 500 | Carousel autoplay speed in ms. | ||
showDate |
boolean | optional | If true displays the date next to the match time. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onMatchesSet |
function | optional | Function/event handler. Emits matchIds array on team click or touch. |
|||
onItemClick |
function | optional | Function/click handler. Emits target and data on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
JS/Example of using Click Handlers
Return to top
## Live Match Tracker
us.match.lmt provides live scoring, statistics, and win probabilities for a given match.
>
For the widget to render you must provide a valid matchId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Match General Statistics
us.match.generalStatistics provides general statistics for a given match, including ball possession, shots on/off target, yellow and red cards, free kicks, offsides, fouls, and substitutions.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | false | If true hides the widget header. |
||
disableMatchHeader |
boolean | optional | false | If true hides the match header. |
||
disablePeriods |
boolean | optional | false | If true hides the period tabs. |
||
disableCharts |
boolean | optional | false | If true hides the statistics charts. |
||
disableGroups |
boolean | optional | false | If true hides the statistics groups. |
||
chartType |
string | optional | bar | Display mode of the charts. Possible options: bar , bullet . |
||
layout |
string | optional | normal | When set to compact , switches to a compact display. Possible options: normal , compact . |
||
visibleStats |
array | optional | [] | When set to non-empty value, it only displays statistics types specified in the array (if they are available for selected match). See below for valid options. When disableGroups is set to true the stats are ordered as specified in the visibleStats prop. |
||
border |
boolean | optional | If true draws a border around the widget. |
ball_possession |
dangerous_attack |
attack |
ball_safe |
goal_attempts |
ball_possession |
shot_on_target |
shot_off_target |
corner_kick |
free_kick |
offside |
goal_kick |
thown_in |
yellow_card |
yellow_red_card |
red_card |
player_substitution |
save |
fouls |
injury |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Match Linescore
us.match.linescore provides a score summary per half and the current situation in a live game.
>
For the widget to render you must provide a valid matchId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
onItemClick |
function | optional | false | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Match Lineups
us.match.soccer.Lineups provides full lineup details for a given match, including tactics, cards, formations, and substitutions.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
disableSubstitutes |
boolean | optional | If true hides the substitution data. |
|||
onItemClick |
function | optional | Function/event handler. Emits playerId or seasonId on player click or touch. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Match List
us.common.MatchList displays a daily list of past, present and future matches. Scores are automatically updated in real-time during live matches.
>
This widget uses local storage for persisting end-user selection (date, live, show/hide odds). The widget displays date/time in the end user's local timezone (based on operating system settings).
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | optional | Match ID | |||
dayOffset |
number | optional | 0 | Day offset from the current date. Default value is 0 (current date). |
||
sportId |
number | optional | 1 | Sport ID. 1 (Soccer), 2 (Basketball), 3 (Baseball), 4 (Ice Hockey), 9 (Golf), 16 (American Football). |
||
isLive |
boolean | optional | false | Displays only live matches when set to true . |
||
showOdds |
boolean | optional | false | When set to true includes odds data for each match. |
||
disableOdds |
boolean | optional | false | When set to true disables the odds button in the right corner. |
||
onItemClick |
function | optional | Function/Event handler, emits matchId on click or touch. |
|||
filterUtIds |
string | optional | Comma-separated unique tournament IDs. When set, only matches within specified unique tournaments will be listed. | |||
filterRcIds |
string | optional | Comma-separated real category IDs. When set, only matches within specified real categories will be listed. | |||
favoriteTournaments |
string | optional | Comma-separated unique tournament IDs. When set, tournaments with a specified unique ID will be added to the top of the match list. | |||
oddsDeeplinkLabels |
object | optional | An object of deeplinking labels. | |||
deeplinkParams |
object | optional | An object of deeplinking parameters. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Match Momentum
us.match.soccer.Momentum provides a graphical timeline for events in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
chartContainerHeight |
boolean | optional | 130 | The height of the momentum chart in pixels. | ||
chartStyle |
string | optional | bars | Choose the graphical display of the timeline. Options: bars , thisoccerrs , line , timeLine . |
||
disableCrests |
boolean | optional | If true team logos are not displayed. |
|||
disableTeamNames |
boolean | optional | If true team names are not displayed. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Match Odds
us.match.odds provides odds for a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
oddsType |
string | optional | 'spread' | Odds Type Filter. Choose between: spread , moneyLine , or overunder . |
||
type |
string | optional | 'mixed' | Determines height of the odds markets' buttons. Valid values are: mixed , line , and block . |
||
disableHeader |
boolean | optional | false | If true hides the widget header. |
||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Match Play by Play
us.match.PlayByPlay displays a running timeline of every event in a given match.
>
For the widget to render you must provide a valid matchId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
sortOrder |
string | optional | descending | Determines the sort order. Valid options are ascending and descending . |
||
activeEvent |
number | optional | Active event ID | |||
showFunfacts |
boolean | optional | true | If false hides the fun facts. |
||
showPhrases |
boolean | optional | true | If false hides the phrases. |
||
isExpanded |
boolean | optional | false | If true displays an expanded tree. |
||
disableFilter |
boolean | optional | false | If true hides all filters, selectors, dropdowns, and tabs. |
||
flipOnLiveMatch |
boolean | optional | false | If true displays the last period only. |
||
compactPeriodLayout |
boolean | optional | false | If true displays a compact period layout. |
||
showLast10 |
boolean | optional | false | If true limits the list to the last 10 events. |
||
disableHeader |
boolean | optional | If true hides the header. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onToggle |
function | optional | Function/event handler. Emits toggle object on period header click or touch. |
|||
onItemClick |
function | optional | Function/event handler. Emits event object on player cell click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Match Score
us.match.score is a variant of the smaller scoreboard with links. Match Score features the current score, the teams represented by name and logo, the status of a match, and other key game related information (depending on sport and/or unique tournament) as collapsible content. Also supports navigation to other widgets/content.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
matchId |
number | required | Match ID | |
showDate |
boolean | optional | If true displays the scheduled date beside the time (pre-match only). |
|
isCollapsed |
boolean | optional | 'true' | If false expands all collapsible content. |
showOdds |
boolean | optional | 'true' | If false hides odds (pre-match only). |
disableHeader |
boolean | optional | false | If true hides the widget header. |
disableGameInfo |
boolean | optional | false | If true hides collapsible game information. |
disableGameInfoXSmall |
boolean | optional | false | If true hides collapsible game information on X-Small responsive breakpoint. |
disableAttendance |
boolean | optional | false | If true hides attendance content. |
disableTeamClick |
boolean | optional | false | If true disable onItemClick handler for teams. |
disablePlayerClick |
boolean | optional | false | If true disable onItemClick handler for players (i.e. team leaders under game information). |
enableMatchClick |
boolean | optional | false | If true the whole widget triggers match target event on onItemClick; all other targets get disabled. |
preMatchLinks |
string | optional | Comma separated string of link keys for pre-match. Can be: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . Entering default is the same as entering preview, lineups . |
|
liveMatchLinks |
string | optional | Comma separated string of link keys for pre-match. Can be: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . Entering default is the same as entering boxscore, gametracker . |
|
postMatchLinks |
string | optional | Comma separated string of link keys for pre-match. Can be: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . Entering default is the same as entering boxscore, recap . |
|
border |
boolean | optional | If true enables a border around the widget. |
|
onItemClick |
function | optional | Function/event handler. By default, the widget has two click targeting areas: team and player . The player targets appear in the Game Information section depending on match status. With preMatchLinks , liveMatchLinks , and/or postMatchLinks set the Score widget can get additional targets: preview , boxscore , gametracker , recap , lineups , and matchstats links. When enableMatchClick is set to 'true' the whole Score widget becomes a match target and all other targets gets disabled. All targets emit the following match props on click or touch: matchId , sportId , realCategoryId , seasonId , tournamentId , uniqueTournamentId , awayTeamUid , homeTeamUid , or matchStatus . Team target adds uniqueTeamId , player target adds playerId . Valid matchStatus values are: pre , live , or post . |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Examples of onItemClick targets and emitted props
"team",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post","uniqueTeamId":2836}
"player",{"matchId":27543026,"matchStatus":"pre","playerId":36476,"seasonId":78917,"tournamentId":10560,"uniqueTournamentId":234,"realCategoryId":37,"sportId":4,"awayTeamUid":3703,"homeTeamUid":3677}
"box_score",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post"}
"match",{"matchId":27543026,"seasonId":78917,"tournamentId":10560,"uniqueTournamentId":234,"realCategoryId":37,"sportId":4,"awayTeamUid":3703,"homeTeamUid":3677,"matchStatus":"pre"}
Return to top
## Match Scoreboard
us.match.scoreboard features the current score, the teams represented by name and logo, the status of a game, and other key game related information (depending on the sport).
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
showOdds |
boolean | optional | 'true' | If false hides odds (pre-match only). |
||
showWinsDrawsLosses |
boolean | optional | 'true' | If false hides WDL information (pre-match only). |
||
showMatchTitle |
boolean | optional | 'true' | If false hides the match title (playoffs only). |
||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Match Statistics
us.match.soccer.statistics provides detailed statistics for a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
disableBallPossession |
boolean | optional | If true hides the ball possession. |
|||
disableGeneralStatistic |
boolean | optional | If true hides the general statistics. |
|||
disableAttackPerformance |
boolean | optional | If true hides the attack performance. |
|||
disableSubstitutions |
boolean | optional | If true hides the substitutions. |
|||
disableWidgetSubheaders |
boolean | optional | If true hides all of the sub-headers. |
|||
disablePadding |
boolean | optional | If true disables the padding around the widget. |
|||
disableFooter |
boolean | optional | If true hides the footer. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Match Win Probability
us.match.winProbability displays the win probability for each team in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
border |
boolean | optional | 'true' | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Odds Comparison
us.betting.season.oddsComparison provides daily bookmaker odds for all matches in a given season/tournament.
>
For the widget to render you must provide a valid uniqueTournamentId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
uniqueTournamentId |
number | required | Unique Tournament ID | |
matchStatus |
string | optional | 'pre' | Match Status Filter. You can choose between pre or live . |
oddsType |
string | optional | 'spread' | Odds Type Filter. Choose between: spread , moneyLine , or overunder . |
bookmakers |
string | optional | Comma separated string for selected bookmakers. Options are: draftkings , fanduel , mgm , williamhillnewjersey , caesarsnewjersey , caesarspennsylvania , sugarhousenj , bet365newjersey , and pointsbet . |
|
selectedDate |
string | optional | Selects particular date. Supports YYYY-MM-DD . |
|
onItemClick |
function | optional | Function/event handler. Emits matchId and other props on table row click or touch. |
|
border |
boolean | optional | If true draws a border around the widget. |
|
enableLimit |
boolean | optional | 'true' | If true enables a 5 game limit on the table. If more games are available, a "more" button appears and after clicking it, 5 more games can be seen. |
disableOddsColor |
boolean | optional | If true disables odds colors on live games. |
|
disableOddsHighlighting |
boolean | optional | If true disables highlighting for odds changes. |
|
disableHeader |
boolean | optional | If true disables season info header. |
|
enableDeeplink |
boolean | If true bookmaker column headings become clickable, opening the corresponding bookmaker's website in a new browser tab. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Money Percentage Tracking
us.betting.match.moneyPercentageTrackingSlim displays a small money tracking graph for a given match, with selections for money percentage (Spread, Moneyline, Total).
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
type |
string | optional | 'moneyline' | Betting percentage type to display. Options are: moneyline , spread , total . |
||
hideDropdown |
boolean | optional | If true hides the dropdown and displays the type title. |
|||
border |
boolean | optional | 'true' | If false hides a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on team click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Player Comparison
us.player.soccer.comparison compares statistical categories of two players.
>
For the widget to render, a valid matchId
or both TeamUids
must be provided. To render specific players, both playerIds
must be provided. To limit the statistics to a particular season, include seasonId
or uniqueTournamentId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
playerId1 |
number | optional | Player 1 ID | |||
playerId2 |
number | optional | Player 2 ID | |||
teamUid1 |
number | optional | Unique Team 1 ID | |||
teamUid2 |
number | optional | Unique Team 2 ID | |||
seasonId |
number | optional | Season ID | |||
uniqueTournamentId |
number | optional | Unique Tournament ID | |||
matchId |
number | optional | Match ID | |||
disableWidgetHeader |
boolean | optional | false | If false hides the widget header. |
||
disableProfile |
boolean | optional | false | If false hides the profile data. |
||
disableStatistics |
boolean | optional | false | If false hides the statistics data. |
||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Player Header
us.player.header provides biographical information and current seasonal stats for a given player.
>
For the widget to render you must provide a valid playerId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
playerId |
number | required | Player ID | |||
seasonId |
number | optional | active season | Season ID | ||
type |
string | optional | 'main' | Season Type. Valid values are: main , auto , and playoffs . |
||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Player Header Small
us.player.headerSmall provides basic player information with a headshot.
>
For the widget to render you must provide a valid playerId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
playerId |
number | required | Player ID | |||
seasonId |
number | optional | active season | Season ID | ||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Player Info
us.player.soccer.Info displays key information about a particular player such as age, height, and preferred foot. The widget also displays live match information (when available), including number of goals scored, assists, cards, conversion rate and minutes played.
>
For the widget to render you must provide a valid playerId
and teamUid
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
playerId |
number | required | Player ID | |||
seasonId |
number | optional | Season ID | |||
uniqueTournamentId |
number | optional | Unique Tournament ID | |||
teamUid |
number | required | Unique Team ID | |||
disableWidgetHeader |
boolean | optional | false | If true hides the widget header. |
||
disablePlayerHeader |
boolean | optional | false | If true hides the player header. |
||
disableAttack |
boolean | optional | false | If true hides the attack info. |
||
disableAppearances |
boolean | optional | false | If true hides the appearances info. |
||
disableOffense |
boolean | optional | false | If true hides the offense info. |
||
disableProfileInfo |
boolean | optional | false | If true hides the profile info. |
||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Score Nano
us.match.scoreNano is a nano variant of the scoreboard. Nano features the current score, the teams represented by name and logo, and the status of a game.
>
For the widget to render you must provide a valid matchId
. All other properties are optional. Minimal widget width is 170px.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
border |
boolean | optional | 'true' | If true enables a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Only target item is match. Emits various match props on click or touch as matchId , sportId , realCategoryId , seasonId , tournamentId , uniqueTournamentId , awayTeamUid , homeTeamUid , matchStatus . Valid matchStatus values are: pre , live , post . |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Score Small
us.match.scoreSmall is a small variant of the scoreboard. This widget features the current score, the teams represented by name and logo, and the status of the game.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
showDate |
boolean | optional | 'true' | If true displays the scheduled date beside the time (pre-match only). |
||
showOdds |
boolean | optional | 'true' | If false hides odds (pre-match only). |
||
border |
boolean | optional | 'true' | If true enables a border around the widget. |
||
onItemClick |
function | optional | Function/event handler. Emits matchId , seasonId , tournamentId , or uniqueTournamentId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Score Ticker
us.common.scoreTicker provides a condensed ticker of daily matchups. The user has the ability to view previous and upcoming dates, as well as all other leagues and sports currently offered.
>
To see a full-sized version of this widget, click here.
There are two options for generating the Score Ticker widget.
Option 1
WithoutmatchId
, sport
or uniqueTournamentId
props being set, the widget attempts to find and auto-select sports with live matches.
If there are multiple sports that are live at one time, the widget follows this order of operations: NFL playoffs, NBA playoffs, NCAAF playoffs, NCAAB NCAA tournament, MLB playoffs, NHL playoffs, NFL pro bowl, NBA All-Star game, MLB All-Star game, NHL All-Star game, NFL regular season, NBA regular season, NCAAF regular season, NCAAB regular season, MLB regular season, NHL regular season, Premier League, Champions League, La Liga, Bundesliga, MLS playoffs, MLS regular season, Serie A, Ligue 1, Europa League, NCAAB NIT, NCAAB CBI, NCAAB CIT, NFL preseason, NBA preseason, MLB spring training, NHL preseason, NBA summer league.
The widget picks from the allowedSports
prop, if set. Otherwise, it picks from all supported sports. For soccer it further picks from the allowedUniqueTournaments
prop, if set. Otherwise, it picks from all supported unique tournaments.
Failing to find a live sport, and with the considerNearest
prop set to true, the widget will select a sport with the soonest upcoming match.
Failing to find a live sport or an upcoming match with the considerNearest
prop, the widget falls back to the NFL Score Ticker for the current day.
The widget automatically reselects live matches, or the soonest upcoming sport, to follow status changes that occur over time.
Once a user selects another sport using the sport selector, the widget will stop automatically reselecting games and sports until the widget is reloaded.
Option 2
IfmatchId
, sport
or uniqueTournamentId
props are set, the widget will initialize with that sport. Auto-selecting sport is turned off in this scenario.
Parameters
Name | Type | Argument | Default | Description |
matchId |
number | optional | Match ID. Has priority over sport . |
|
sport |
number | string | optional | nfl | A name (string) or ID (number) of the sport that will initially be displayed. Supported: soccer (1 ), nba (2 ), mlb (3 ), nhl (4 ), nfl (5 ), ncaaf (6 ), ncaab (7 ). |
allowedSports |
array | string | optional | 'spread' | Array or comma-separated string of allowed sports (names or ids) to chose from sport selector or sport prop. Also denotes live/nearest sport auto-selecting feature and sport selector items order. If sport prop default is not on the list its default changes to first allowed sport. Supported: soccer (1 ), nba (2 ), mlb (3 ), nhl (4 ), nfl (5 ), ncaaf (6 ), ncaab (7 ). In case of one sport (with the exception of soccer - see allowedUniqueTournaments ), the sport toggle ability is removed and a sport label is displayed instead of the sport selector. |
uniqueTournamentId |
number | optional | Unique tournament ID (Soccer). Supported: 17 (EPL), 242 (MLS), 7 (UCL), 679 (UEL), 8 (LaLiga), 23 (Serie A), 35 (BundesLiga), 34 (Ligue 1). Has no effect in combination with other supported sports. |
|
allowedUniqueTournaments |
array | string | optional | Array or comma-separated string of allowed soccer unique tournaments IDs to choose from sport selector or uniqueTournamentId prop. Also impacts live/nearest auto-selecting feature and sport selector soccer items order. Supported: 17 (EPL), 242 (MLS), 7 (UCL), 679 (UEL), 8 (LaLiga), 23 (Serie A), 35 (BundesLiga), 34 (Ligue 1). In case of only soccer and one soccer unique tournament, the sport toggle ability is removed and a selected soccer unique tournament label is displayed instead of the sport selector. If not set, all supported soccer unique tournaments are allowed. |
|
prevDays |
number | optional | 1 | Number of previous days to select from the date control. |
nextDays |
number | optional | 1 | Number of upcoming days to select from the date control. |
flipOnEndDay |
boolean | optional | Forces to flip to the next day at day's end. If a sport has games being played on consecutive days (e.g. Monday and Tuesday), the ticker will automatically flip to Tuesday's games at the end of the current day/start of the next day. If, however, a sport has games separated by a day (e.g. Monday and Wednesday), then the flipOnEndDay prop can be set to "true" and force the ticker to flip at the end of Monday/start of Tuesday. If set to "false" or left as the default option, the ticker would not flip to the next set of games until the end of Tuesday/start of Wednesday. As a rule, NFL and NCAAF are not affected by this prop's functionality. These two sports are set to flip based on weekly timers. NFL is set to flip to the next week at 5 a.m. UTC on Wednesdays, while NCAAF is set to flip to the next week at 5 a.m. UTC on Tuesdays. If there are live games from the previous week still taking place at those times, the week flip will be delayed until the conclusion of those games. |
|
dayFlipUTCHours |
number | optional | Integer between 0 and 23. Forces flipping to current day's games at a specified time based on UTC time zone, but not before start of the current day (in local time). Although the time is set according to UTC, it will effect end users according to their local time zone. Example: if the current date is 1/19/22, a value of 20 will set flipping at 12:00 for a user in PST time zone, 15:00 for EST and 21:00 for CET. However, using a value of 6 will set flipping at 0:00 PST (rather than 1/18/22 22:00 PST), 1:00 EST and 7:00 CET. dayFlipUTCHours has priority over dayFlipHoursBefore . |
|
dayFlipHoursBefore |
number | optional | Integer between 0 and 23. Forces flipping to current day's games a specific number of hours before the scheduled time of the first match, but not before the start of the current day (in local time). Example: if the first game of the day is at 7:30pm EST, a value of 7 would leave last night's games displayed until 12:30pm EST. | |
mergeLive |
boolean | optional | Displays all live games no matter when they were originally scheduled/started. Any games that were scheduled the day before and continued past midnight will be moved to the previous day (their original displayed day) as soon as they are finished. | |
considerNearest |
boolean | optional | true | Auto-selects the sport with the soonest game if there are currently no live games. |
hasHorizontalSelectors |
number | optional | Renders horizontal selectors instead of dropdowns. Typical use case: the HTML Inline Frame element. | |
h80 |
boolean | optional | Sets the widget fixed height at 80px. Typical use case: the HTML Inline Frame element. | |
h90 |
boolean | optional | Sets the widget fixed height at 90px. Typical use case: the HTML Inline Frame element. | |
layout |
string | optional | 'normal' | Sets the type of layout. Valid values are normal and compact . normal breaks the navigation and match list for mobile breakpoint (480px) in 2 lines; compact layout keeps the sport selector and match list for mobile breakpoint in one line, omitting the date selector. The Compact layout also has different paddings and widths, and uses a carrot icon instead of hamburger icon for the sport selector. |
disableSportDropdown |
boolean | optional | If true hides the sports dropdown/label and takes away from the user the ability to change sport/unique tournament. In the case of a disabled sport selector and unset sport and uniqueTournamentId props, the widget will operate in auto-selecting mode indefinitely. |
|
onItemClick |
function | optional | Function/event handler. Possible target items are match and us-sport . When the target is match it means a match has been clicked or touched and it emits various match values: matchId , sportId , usSport , realCategoryId , seasonId , tournamentId, uniqueTournamentId , awayTeamUid , homeTeamUid , matchStatus . When the target is us-sport it means a different sport (or a different soccer league) has been selected in the score ticker, and it emits usSport and uniqueTournamentId values. Valid matchStatus values are: pre , live , post . The usSport value is a numerical sport ID, it can contains the same IDs as the sport prop. Example below. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
JS/Allowing MLS(242) soccer league and all non soccer leagues (using array notation)
JS/Allowing European soccer leagues (using comma separated string notation)
onItemClick Example
Return to top
## Scoring Probability Per Period
us.match.soccer.scoringProbabilityPerPeriod displays a graph of scoring probabilities per 15-minute period for each team in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
minMatchesThisSeason |
number | Minimum number of matches to include in the season. | ||||
allowLast |
boolean | If true the display will include data from the previous season. |
||||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
disableTitle |
boolean | optional | If true hides the widget title. |
|||
disableLegend |
boolean | optional | If true hides the widget legend. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Season Injuries
us.season.injuries displays injuries for a given season, with the ability to filter by team.
>
For the widget to render you must provide a valid seasonId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | required | Season ID | |||
teamUid |
number | optional | Team Unique Id | |||
showSeasonYearTitle |
boolean | optional | 'false' | When set to true adds season year to the header title. |
||
disableHeader |
boolean | optional | 'false' | When set to true disables header with the team selection dropdown. |
||
disableDropdown |
boolean | optional | 'false' | When set to true disables the team dropdown in the header. |
||
disableTeamHeaders |
boolean | optional | 'false' | When set to true disables team headers. |
||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits playerId on player row click or touch. Emits teamId and uniqueTeamId on team header click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Season Players Carousel
us.season.playersCarousel provides a moving carousel of headers for provided players.
>
For the widget to render you must provide a valid seasonId
or uniqueTournamentId
and any number of playerIds
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
playerId |
number or string | required | Player ID or a comma separated list of player IDs. | |||
seasonId |
number | required | Season ID | |||
uniqueTournamentId |
number | optional | If seasonId is not provided, uniqueTournamentId can be used to get the current active season in that tournament. |
|||
seasonType |
string | optional | 'regular' | Season Type. Valid options are: regular and playoffs . |
||
disableHeader |
boolean | optional | If set to true disables the team header. |
|||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Season Playoff Rounds
us.season.playoffRounds displays all playoff games for a selected season, with clickable dropdowns to select by round and conference.
>
For the widget to render you must provide a valid seasonId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | required | Season ID | |||
selectedRound |
number | optional | '1' | The playoff round to display. | ||
conference |
string | optional | 'western' | The selected conference. Valid options are: western or eastern . |
||
disableRoundsDropdown |
boolean | optional | If true disables the rounds dropdown. |
|||
disableConferenceDropdown |
boolean | optional | If true disables the conference dropdown. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Season Scores
us.season.scores displays scoreboard information broken down by a day or a round (according to local time).
>
For the widget to render you must provide a valid uniqueTournamentId
or seasonId
. All other properties are optional.
Important to note when using this widget:
- The combination of properties matters.
seasonId
has priority overuniqueTournamentId
.uniqueTournamentId
alone denotes the nearest play day / round of the active season to a current day or a current round.- If
seasonId
is entered the unique tournament is derived from that season, not the input foruniqueTournamentId
. seasonId
alone denotes the nearest play day / round of the season to a current day or a current round. For older seasons it is always the last play day/last round of the season.numFutureDays
extends the scores list into the future (i.e. numFutureDays are shown); defaults to 2; this only works in the middle of the season.selectedDate
andselectedIdx
enables selection of a particular day or round.tableroundId
andcuproundId
enables selection of a particular round by precise table/cup round id (advanced use). These options work for all seasons.- "round by round" is a property of a tournament; by default all "round by round" tournaments are broken down by round, unless
isRoundByRound
is set tofalse
; then they are broken down by day. - The widget will automatically flip to the next day (when broken down by a day during auto-selecting mode), unless
dayFlipUTCHours
ordayFlipHoursBefore
are set. - A Score widget is used to render a single game. Scope of the displayed information depends on the sport and/or unique tournament. Score widgets feature links for navigating to other widgets/content.
- Clickable items are teams, players (i.e. team leaders) and links.
seasonId
, selectedData
and numFutureDays
to 5. If a tournament is 'round by round' you can also set isRoundByRound
to false
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Argument | Default | Description |
seasonId |
number | Season ID | ||
uniqueTournamentId |
number | Unique Tournament ID | ||
numFutureDays |
number | optional | 2 | Extends the scores list into the future. |
selectedDate |
string | optional | Selected date in YYYY-MM-DD format. | |
selectedIdx |
number | optional | Selects particular day/round. | |
isRoundByRound |
boolean | optional | 'true' | If false it forces breaking down by day even if the tournament is typically 'round by round'. However, true breaks down by round only 'round by round' tournaments. |
tableroundId |
number | optional | Matches round by particular table round id. | |
cuproundId |
number | optional | Matches round by particular cup round id. | |
dayFlipUTCHours |
number (integer between 0 and 23.) | optional | Forces flipping to current day's games at a specified time based on UTC time zone, but not before start of the current day (in local time). Although the time is set according to UTC, it will effect end users according to their local time zone. Example: if the current date is 1/19/22, a value of 20 will set flipping at 12:00 for a user in PST time zone, 15:00 for EST and 21:00 for CET. However, using a value of 6 will set flipping at 0:00 PST (rather than 1/18/22 22:00 PST), 1:00 EST and 7:00 CET. An integer between 0 and 23. dayFlipUTCHours has priority over dayFlipHoursBefore . |
|
dayFlipHoursBefore |
number (integer between 0 and 23.) | optional | Forces flipping to current day's games a specific number of hours before scheduled time of the first match, but not before start of the current day (in local time). Example: if the first game of the day is at 7:30pm EST, a value of 7 would leave last night's games displayed until 12:30pm EST. An integer between 0 and 23. | |
showOdds |
boolean | optional | 'true' | If false odds for all pre-gamees visualizations are hidden. |
disableGameHeader |
boolean | optional | If true hides the game header. |
|
disableDateSwitcher |
boolean | optional | If true hides the date/round switcher control. |
|
dropdownReverese |
boolean | optional | If true reverses switcher items when in round/dropdown mode. |
|
disableGameInfo |
boolean | optional | If true hides collapsible content (i.e. game information). |
|
disableGameInfoXSmall |
boolean | optional | 'true' | If true hides collapsible content (i.e. game information) on X-Small responsive breakpoint (<321px). |
preMatchLinks |
string | optional | Comma separated string of link keys for pre-game. Valid options are: undefined , default , preview , boxscore , gametracker , recap , lineups , and matchstats . Entering default is the same as entering preview . |
|
liveMatchLinks |
string | optional | Comma separated string of link keys for live games. Can be undefined , default , preview , boxscore , gametracker , recap , lineups , matchstats . Entering default is the same as entering 'boxscore, gametracker '. |
|
postMatchLinks |
string | optional | Comma separated string of link keys for post-game. Can be undefined , default , preview , boxscore , gametracker , recap , lineups , matchstats . Entering default is the same as entering 'boxscore, recap '. |
|
border |
boolean | optional | If true enables a border around the widget. |
|
onItemClick |
function | optional | Function/event handler. By default, the widget has two click target areas: team and player . The player targets appear in the Game Information section, depending on game status. With preMatchLinks , liveMatchLinks and/or postMatchLinks set, the Score widget can get additional targets: preview , boxscore , gametracker , recap , lineups , matchstats links. All targets emit the following match props on click or touch: matchId , sportId , realCategoryId , seasonId , tournamentId , uniqueTournamentId , awayTeamUid , homeTeamUid , matchStatus . Team target adds uniqueTeamId , player target adds playerId . Valid matchStatus values are: pre , live , post . |
Examples
HTML/Declarative
JS/Programmatic
JS/Programmatic using Event Handlers
Examples of onItemClick targets and emitted props
"team",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post","uniqueTeamId":2836}
"player",{"matchId":27543026,"matchStatus":"pre","playerId":36476,"seasonId":78917,"tournamentId":10560,"uniqueTournamentId":234,"realCategoryId":37,"sportId":4,"awayTeamUid":3703,"homeTeamUid":3677}
"box_score",{"matchId":23361061,"seasonId":77361,"tournamentId":36,"uniqueTournamentId":8,"realCategoryId":32,"sportId":1,"awayTeamUid":2836,"homeTeamUid":2831,"matchStatus":"post"}
Return to top
## Standings
us.season.soccer.standings provides detailed standings info for a given season.
>
By default, the widget provides the Major League Soccer active season standings.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | optional | Season ID. Takes precedence over uniqueTournamentId . |
|||
uniqueTournamentId |
number | optional | 242 | Unique tournament ID. Valid options are: 242 - MLS, 17 - Premier League,35 - Bundesliga,23 - Serie A,8 - La Liga,33 - Ligue 1,7 - Champions League. |
||
type |
string | optional | 'overall' | Displays standings as overall or home/away. Possible options: overall , home , away . |
||
mode |
string | optional | 'conference' | Separates the teams into groups. Possible options: league or conference . Applicable for MLS only. |
||
border |
boolean | optional | If true enables a border around the widget. |
|||
showSeasonSelector |
boolean | optional | 'true' | If false the season dropdown is hidden. |
||
disableDropdown |
boolean | optional | If true hides the tournament dropdown. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Standings Carousel
us.season.soccer.standingscarousel provides a moving carousel of seasonal standings by conference or division.
>
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | optional | active season | Season ID | ||
disableHeader |
boolean | optional | true | If set to true disables the header. |
||
autoplay |
boolean | optional | true | If set to true the carousel will automatically switch the selected item periodically. |
||
autoplaySpeed |
number | optional | 5000 | The speed for autoplay in milliseconds. |
||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Standings Slim
us.season.soccer.standingsSlim is a lightweight version of the standings table.
>
By default, the widget renders the active standings for MLS.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | optional | Active MLS season | Season ID | ||
uniqueTournamentId |
number | optional | 242 | Unique tournament ID. Valid options are: 242 - MLS, 17 - Premier League,35 - Bundesliga,23 - Serie A,8 - La Liga,33 - Ligue 1,7 - Champions League. |
||
conference |
string | optional | Selects conference (MLS only). Valid options are: eastern or western . |
|||
uniqueTeamId |
number | optional | Unique team ID | |||
border |
boolean | optional | If true enables a border around the widget. |
|||
disableHeader |
boolean | optional | If true hides the widget header. |
|||
enableDropdown |
boolean | optional | If true enables conference dropdown selector. Unless uniqueTeamId is set. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Comparison
us.team.soccer.comparison compares key seasonal statistics between two teams.
>
For the widget to render you must provide one of the following parameter combinations:
matchId
teamUid1
,teamUid2
, andseasonId
teamUid1
,teamUid2
, andtournamentId
teamUid1
,teamUid2
, anduniqueTournamentId
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | optional | Match ID | |||
teamUid1 |
number | optional | Unique team 1 ID | |||
teamUid2 |
number | optional | Unique team 2 ID | |||
seasonId |
number | optional | Season ID | |||
tournamentId |
number | optional | Tournament ID | |||
uniqueTournamentId |
number | optional | Unique tournament ID | |||
disableWidgetHeader |
boolean | optional | false | When set to true hides the widget header. |
||
disableMatchHeader |
boolean | optional | false | When set to true hides the match header. |
||
disableTeamInfoAverages |
boolean | optional | false | When set to true hides the team info averages. |
||
disableTopScorer |
boolean | optional | false | When set to true hides the top scorer. |
||
disableSquadAverages |
boolean | optional | false | When set to true hides the squad averages. |
||
disableTeamSelector |
boolean | optional | false | When set to true hides the dropdown menu for team selection. |
||
hideNoDataErrors |
boolean | optional | true | When set to true hides No Data Errors (if they exist). |
||
border |
boolean | optional | When set to true draws a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits playerId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Header
us.team.header provides the team record and standing for a given team and season.
>
For the widget to render you must provide a valid teamUid
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique Team ID | |||
seasonId |
number | required | Season ID | |||
leagueType |
string | optional | Select league standings to display. Valid options are: full , division , conference , and all |
|||
tiedRankIndicator |
boolean | optional | If true displays a tie ranking indicator based solely on win percentage or total points (depending on the sport). It does not factor in all tiebreaking scenarios that you would otherwise see using the regular standings positions. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTournamentId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Header Small
us.team.headerSmall provides the team record and standing for a given team and season.
>
For the widget to render you must provide a valid teamUid
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique Team ID | |||
seasonId |
number | required | Season ID | |||
leagueType |
string | optional | Select league standings to display. Valid options are: full , division , conference , and all |
|||
tiedRankIndicator |
boolean | optional | If true displays a tie ranking indicator based solely on win percentage or total points (depending on the sport). It does not factor in all tiebreaking scenarios that you would otherwise see using the regular standings positions. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTournamentId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Info
us.team.soccer.TeamInfo provides key information of a given team, including team logos, league rankings, top scorer, and squad averages.
>
For the widget to render you must provide one of the following parameter combinations:
teamUid
andseasonId
teamUid
andtournamentId
teamUid
anduniqueTournamentId
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
teamUid |
number | required | Unique team ID | |||
seasonId |
number | optional | Season ID | |||
tournamentId |
number | optional | Tournament ID | |||
uniqueTournamentId |
number | optional | Unique tournament ID | |||
disableWidgetHeader |
boolean | optional | false | When set to true hides the widget header. |
||
disableMatchHeader |
boolean | optional | false | When set to true hides the match header. |
||
disableTeamInfoAverages |
boolean | optional | false | When set to true hides the team info averages. |
||
disableScorer |
boolean | optional | false | When set to true hides the top scorer. |
||
disableSquadAverages |
boolean | optional | false | When set to true hides the squad averages. |
||
disableTeamTablePosition |
boolean | optional | false | When set to true hides the team table position. |
||
border |
boolean | optional | When set to true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Team Leaderboard
us.team.soccer.TeamLeaderboard displays a given team's rankings across four statistical categories: Goals, Assists, Cards and Injuries.
>
For the widget to render you must provide one of the following parameter combinations:
matchId
andteam
(home or away)teamUid
andseasonId
teamUid
andtournamentId
teamUid
anduniqueTournamentId
Parameters
Name | Type | Argument | Default | Description |
matchId |
number | Match ID | ||
teamUid |
number | Unique team ID | ||
seasonId |
number | Season ID | ||
tournamentId |
number | Tournament ID | ||
uniqueTournamentId |
number | Unique tournament ID | ||
team |
string | home | Displays the stats for the home or away team. |
|
categories |
string | optional | all | A comma-separated list of categories (goals , assists , cards , injuries ) to display. Categories will be displayed in the same order as they have been defined. Does not work with dynamic change. |
disableWidgetHeader |
boolean | optional | true | When set to true hides the widget header. |
limit |
number | optional | 5 | Limits the number of rows to display. |
disableContrChart |
boolean | optional | false | When set to true hides the contribution chart. Does not work with dynamic change. |
activeTab |
string | optional | id_tab_goals | Determines active category tab. Valid values: id_tab_goals , id_tab_assists , id_tab_cards , id_tab_injuries . |
border |
boolean | optional | When set to true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Team Ranks
us.season.soccer.teamRanks provides a given team's seasonal rankings for several statistics.
>
For the widget to render you must provide a valid teamUid
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique Team ID | |||
seasonId |
number | required | Season ID | |||
tournamentId |
number | optional | Tournament ID | |||
uniqueTournamentId |
number | optional | Unique Tournament ID | |||
disableHeader |
boolean | optional | If true hides the widget header. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits uniqueTeamId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Recent Games
us.team.soccer.recentGames displays upcoming and/or past games of a selected team.
>
For the widget to render you must provide a valid teamUid
, with uniqueTournamentId
or seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | optional | Season ID | |||
uniqueTournamentId |
number | optional | Unique tournament ID | |||
teamUid |
number | required | Unique team ID | |||
pastGames |
number | optional | 20 | Number of past games to display. | ||
nextGames |
number | optional | 1 | Number of future games to display. | ||
currentSeason |
boolean | optional | true | If true provides games of current season only. |
||
sortDirection |
string | optional | desc | Changes groups and games sort direction. Valid options are: asc and desc . |
||
disableDropdown |
boolean | optional | If true disables the team selection dropdown. |
|||
disableHeader |
boolean | optional | If true disables the entire header. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits matchId , seasonId and other props on table row upon click or touch. See example below. |
Examples
HTML/Declarative
Please note that in HTML prop names changes from CamelCase to hyphen-word-delimited notation, i.e. pastGames to past-games
JS/Programmatic
JS/Example of using Event Handler
Example of onItemClick targets and emitted props
match:{"matchId":26574092,"seasonId":81550,"tournamentId":18,"uniqueTournamentId":242,"realCategoryId":26,"sportId":1,"awayTeamUid":2512,"homeTeamUid":2513,"matchStatus":"post"}
Return to top
## Team Roster
us.season.soccer.teamRoster visualizes a complete team roster.
>
For the widget to render you must provide a valid teamUid
and seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique team ID | |||
seasonId |
number | optional | Season ID | |||
disableHeader |
boolean | optional | If true hides the widget header. |
|||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits playerId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Schedule
us.team.soccer.schedule displays the entire season schedule for a given team.
>
For the widget to render you must provide a valid teamUid
, with uniqueTournamentId
or seasonId
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
teamUid |
number | required | Unique team ID | |||
uniqueTournamentId |
number | required | Unique tournament ID | |||
seasonId |
number | optional | Season ID | |||
border |
boolean | optional | If true enables a border around the widget. |
|||
disableDropdown |
boolean | optional | If true disables the team selection dropdown. |
|||
disableHeader |
boolean | optional | If true disables the entire header. |
|||
onItemClick |
function | optional | Function/event handler. Emits matchId , seasonId and other props on table row opon click or touch. See example below. |
Examples
HTML/Declarative
Please note that in HTML prop names changes from CamelCase to hyphen-word-delimited notation, i.e. pastGames to past-games
JS/Programmatic
JS/Example of using Event Handler
Examples of onItemClick targets and emitted props
match:{"matchId":26398080,"seasonId":81550,"tournamentId":18,"uniqueTournamentId":242,"realCategoryId":26,"sportId":1,"awayTeamUid":2506,"homeTeamUid":2513,"matchStatus":"post"}
Return to top
## Team Selector
us.common.TeamSelector displays all teams from a given league.
>
For the widget to render you must provide a valid seasonId
or uniqueTournamentId
. Entering uniqueTournamentId
without year
renders the active season.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
seasonId |
number | optional | Season ID. Has priority over uniqueTournamentId . |
|||
uniqueTournamentId |
number | optional | Unique tournament ID. Valid options: 132 (NBA), 234 (NHL), 109 (MLB), 31 (NFL), 27653 (NCAAF), 648 (NCAAB), 242 (MLS), 7 (Champions League), 679 (Europa League), 17 (Premier League), 35 (Bundesliga), 8 (La Liga), 23 (Serie A), 34 (Ligue 1) |
|||
year |
number | optional | Season year (format: YYYY). Works with unique tournament ID. | |||
uniqueTeamId |
number | optional | Unique team ID | |||
border |
number | optional | When set to true draws a border around the widget. |
|||
onItemClick |
function | optional | OnClick callback function. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Stats Comparison
us.match.soccer.teamStatsComparison displays graphical team comparisons for a variety of statistics in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | required | Match ID | |||
disableHeader |
boolean | optional | If true hides the header. |
|||
border |
boolean | optional | If true draws a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits playerId on substitution click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Top Players
us.season.soccer.topPlayers displays a top 5 leaderboard for a given season, with a dropdown to select by statistic.
>
For the widget to render you must provide a valid seasonId
.
To have specific stats for players, statType
must be set. Valid stat keys are:
- goals (Goals)
- assists (Assists)
- cards (Cards)
Parameters
Description | |||||||
---|---|---|---|---|---|---|---|
properties | |||||||
Name | Type | Argument | Default | Description | |||
seasonId |
number | required | Season ID | ||||
statType |
string | optional | 'goals' | Selected Stat. Valid options: goals , assists , cards . |
|||
disableDropdown |
boolean | optional | If true hides the dropdown. |
||||
disableHeader |
boolean | optional | If true hides the widget header. |
||||
showTitle |
boolean | optional | If true turns the dropdown into a title. |
||||
hidePlayers |
boolean | optional | true | If true hides player images. |
|||
playersLimit |
number | optional | 5 | Limits the number of players displayed. | |||
border |
boolean | optional | If true enables a border around the widget. |
||||
onItemClick |
function | optional | Function/event handler. Emits playerId on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Top Players Carousel
us.season.soccer.topPlayersCarousel displays a moving top 5 leaderboard for a variety of player statistics.
>
To have specific stats for players, statString
must be set. Valid stat keys are:
- g (Goals)
- ast (Assists)
- c (Cards)
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
seasonId |
number | optional | Season ID | |||
statString |
string | optional | String with stat Keys. Valid options: g , ast and c . |
|||
autoplay |
boolean | optional | 'true' | Carousel autoplay turned on/off. | ||
autoplaySpeed |
number | optional | 5000 | Carousel autoplay speed in milliseconds. | ||
border |
boolean | optional | If true enables a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Tournament Bracket
us.season.soccer.tournamentBracket displays a full tournament bracket for a given season, including the result of each matchup.
>
All properties are optional, but in order to render a tournament bracket you will need to provide a valid seasonId
, matchId
, utid
, or tid
.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | optional | Match ID | |||
seasonId |
number | optional | Season ID | |||
utid |
number | optional | Unique Tournament ID | |||
tid |
number | optional | Tournament ID | |||
disableWidgetHeader |
boolean | optional | false | If true hides the widget title. |
||
border |
boolean | optional | If true enables a border around the widget. |
|||
onItemClick |
function | optional | Function/event handler. Emits { matchId: matchId , seasonId: seasonId } on click or touch. |
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Venue Header
us.common.VenueHeader displays the venue name for a given game, including the team logo and other relevant venue properties.
>
For the widget to render you must provide a valid matchId
or stadiumId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Description | |||
matchId |
number | string | required | Match ID | |||
stadiumId |
number | optional | Venue ID | |||
border |
boolean | optional | When set to true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Vertical Match Timeline
us.match.soccer.verticalTimeline provides a vertical timeline for all events in a given match.
>
For the widget to render you must provide a valid matchId
. All other properties are optional.
To see a full-sized version of this widget, click here.
Parameters
Name | Type | Description | ||||
---|---|---|---|---|---|---|
props |
object | properties | ||||
Name | Type | Argument | Default | Description | ||
matchId |
number | required | Match ID | |||
disableWidgetHeader |
boolean | optional | If true hides the widget header. |
|||
disableMatchHeader |
boolean | optional | If true hides the match header. |
|||
filter |
string | optional | Comma separated filtering of events displayed in the timeline. Valid options are: goals , cards , substitutions , corners , penalties , ther . |
|||
sortByPeriods |
boolean | optional | If true the timeline is divided into period tabs. |
|||
eventsLayoutOption |
string | optional | mixed | Layout of the timeline. Valid options are: mixed , central , toSides . |
||
disableFooter |
boolean | optional | If true hides the footer. |
|||
border |
boolean | optional | If true draws a border around the widget. |
Examples
HTML/Declarative
JS/Programmatic
Return to top
Docs Navigation
- Documentation
- Football (American Football)
- Football (Soccer)
- Australian Rules Football
- Baseball
- Basketball
- NBA v8
- NBA v7
- NBA v5
- NBA v4
- WNBA v8
- WNBA v7
- WNBA v4
- WNBA v3
- NBA G League v8
- NBA G League v7
- NBA G League v5
- NCAA Men's Basketball v8
- NCAA Men's Basketball v7
- NCAA Men's Basketball v4
- NCAA Men's Basketball v3
- NCAA Women's Basketball v8
- NCAA Women's Basketball v7
- NCAA Women's Basketball v3
- Global Basketball v2
- Global Basketball v1
- NBA Historical v1
- Combat Sports
- Cricket
- Editorial Content
- Golf
- Handball
- Hockey
- Images
- Insights
- Insights User Interface
- NBA Insights v1
- NHL Insights v1
- MLB Insights v1
- NFL Insights v1
- MLB Betting Splits v2
- MLB Betting Splits v1
- NBA Betting Splits v2
- NBA Betting Splits v1
- NCAAFB Betting Splits v2
- NCAAFB Betting Splits v1
- NCAAMB Betting Splits v2
- NCAAMB Betting Splits v1
- NFL Betting Splits v2
- NFL Betting Splits v1
- NHL Betting Splits v2
- NHL Betting Splits v1
- Soccer Betting Splits v2
- Soccer Betting Splits v1
- Odds
- Racing
- Rugby
- Tennis
- Widgets
- Baseline Sports Coverage
- Badminton v2
- Badminton v1
- Bandy v2
- Bandy v1
- Beach Soccer v2
- Beach Soccer v1
- Curling v2
- Curling v1
- Cycling v2
- Darts v2
- Darts v1
- Field Hockey v2
- Field Hockey v1
- Floorball v2
- Floorball v1
- Futsal v2
- Futsal v1
- Pesapallo v2
- Pesapallo v1
- Snooker v2
- Snooker v1
- Squash v2
- Squash v1
- Table Tennis v2
- Volleyball (Beach) v2
- Volleyball (Beach) v1
- Volleyball (Indoor) v2
- Volleyball (Indoor) v1
- Waterpolo v2
- Waterpolo v1
- Winter Sports v1