NHL Widgets

## Overview

Sportradar offers a vast array of customizable NHL widgets, with in-depth statistics.

> Click here for our NHL 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 NHL 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.

### NHL Widgets by Type

Widget Type	Widget Name
Headers	Linescore Player Header Player Header Small Scoreboard	Score Score Small Score Nano Team Header	Team Header Small Team Score Small Venue Header
Game	Boxscore Game Leaders Game Scorers Game Scratches	Game Team Stats Game Tracker Goaltenders	Live Game Tracker Play by Play Shot Chart
Team	Recent Games Team Schedule	Team Leaders Team Roster	Team Stats Graphic
Season	Score Per Game Ranks Standings	Standings Slim Top Players	Top Teams
Betting	Bet Percentage Tracking Betting Score Future Odds Future Odds Table	Money Percentage Tracking Odds Odds Comparison	Pregame Betting Statistics Player Comparison Win Probability
Carousel	Live Game Carousel Season Players Carousel	Standings Carousel	Top Players Carousel
League	Game List	Score Ticker	Season Scores
Player	Player Career Stats	Player Game Logs	Player Stats Graphic
Playoffs	Playoff Bracket	Playoff Rounds
Stats	Player Seasonal Statistics	Team Seasonal Statistics
Other	Articles News	Injuries Team Selector	Transactions

## Articles us.common.articlesList displays a list of editorial articles. > To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Default	Description
		`providerId`	number	optional		Provider ID. `2` for Associated Press, `3` for Associated Press Premium.
		`seasonId`	number	optional		Season ID
		`matchId`	string	optional		Match ID
		`playerId`	string	optional		Player ID
		`numItems`	number	optional		Max number of items allowed in the list.
		`editorialSeasonType`	string	optional	'league'	Either 'league' or 'matches'.
		`editorialMatchType`	string	optional	'previews'	Either 'previews' or 'recaps'.
		`border`	boolean	optional		If `true` enables a border around the widget.
		`onItemClick`	function	optional		Callback that is invoked when a user selects an article. Two arguments are given, `type` (a string) and `parameters` (an object). When `type` is `'article'`, `parameters` will contain an `articleId` of the clicked article, which can then e.g. be used with the News widget.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Bet Percentage Tracking us.betting.match.betPercentageTrackingSlim displays a small bet tracking graph for a given game, 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 Score us.betting.match.score displays a small scoreboard with odds from a given 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.
		`showBroadcastNetwork`	boolean	optional	'true'	If `true` displays broadcast network info.
		`showVenueInfo`	boolean	optional	'true'	If `true` displays venue info.
		`disableMatchClick`	boolean	optional		If `true` disables onItemClick handler for the game.
		`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 ## Boxscore us.match.nhl.boxScore provides player statistics for all players in a given 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	Description
		`matchId`	number	required	Match ID
		`disableHeader`	boolean		If `true` hides the header.
		`enableTeamTabs`	boolean		If `true` the widget displays tabs instead of a dropdown for mobile breakpoint, making apparent which teams are competing.
		`enableSideBySideDisplay`	boolean		If `true` places team tables side by side for desktop breakpoint.
		`border`	boolean		If `true` enables a border around the widget.
		`onItemClick`	function		Function/event handler. Emits `playerId` on player cell click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

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	Description
`props`	object	properties
		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 ## Game Leaders us.match.leaders displays a carousel of team leaders for important game statistics. > 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
		`chartType`	string	optional	'bars'	Chart type. Valid options are: `bars` or `circular`.
		`autoplay`	boolean	optional	'true'	If `false` stops carousel autoplay.
		`disableHeader`	boolean	optional		If `true` hides the header.
		`disableHeaderDetails`	boolean	optional		If `true` hides the header details.
		`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 ## Game Linescore us.match.linescore provides a score summary per period 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 ## Game List us.common.MatchList displays a daily list of past, present and future games. Scores are automatically updated in real-time during live games. > 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 games when set to `true`.
		`showOdds`	boolean	optional	false	When set to `true` includes odds data for each game.
		`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 games within specified unique tournaments will be listed.
		`filterRcIds`	string	optional		Comma-separated real category IDs. When set, only games 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 games 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 ## Game Tracker us.match.nhl.gameTracker provides a live visualization of game action, including an event timeline, rink visualization, scoring information, and game leaders. >![NHL Game Tracker](../../../files/NHL_GameTracker_1.png "NHL Game Tracker") >![NHL Game Tracker 2](../../../files/NHL_GameTracker_2.png "NHL Game Tracker") 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	Description
		`matchId`	number	required	Match ID
		`isExpanded`	boolean		If `true` expands all periods of event list.
		`disableHeader`	boolean		If `true` hides the header.
		`pitchHasTitle`	boolean		If `true` displays game tracker title above pitch.
		`border`	boolean		If `true` enables a border around the widget.
		`onItemClick`	boolean		Function/event handler. Emits `playerId` on scorer (goal list) click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Game Score us.match.score is a variant of the smaller scoreboard with links. Game Score features the current score, the teams represented by name and logo, the status of a game, 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-game only).
`isCollapsed`	boolean	optional	'true'	If `false` expands all collapsible content.
`showOdds`	boolean	optional	'true'	If `false` hides odds (pre-game 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-game. Can be: `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 pre-game. 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-game. 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 ## Game 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. > 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-game only).
		`showWinsDrawsLosses`	boolean	optional	'true'	If `false` hides WDL information (pre-game 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 ## Game Scorers us.match.nhl.scorers provides scoring event details in a collapsible period list. > 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
		`disableHeader`	boolean			If `true` hides the header.
		`disableHeaderDetails`	boolean			If `true` hides the header details.
		`border`	boolean			If `true` enables a border around the widget.
		`onItemClick`	function			Function/event handler. Emits `uniqueTeamId` on team click or touch, `playerId` on player click or touch and `matchId`, `seasonId`, `tournamentId`, `uniqueTournamentId` on link click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Game Scratches us.match.nhl.scratches provides scratched players on each team for a given 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	Description
		`matchId`	number	required	Match ID
		`team`	string		Possible values: `home`, `away`. If set then displays only scratches of the given team. This is an alternative to `uniqueTeamId`: set either `team` or `uniqueTeamId`, not both.
		`uniqueTeamId`	number		Unique team ID. If set then displays only scratches of given team. This is an alternative to `team`: set either `team` or `uniqueTeamId`, not both.
		`border`	boolean		If `true` enables a border around the widget.
		`onItemClick`	function		Function/event handler. Emits `uniqueTeamId` on team click or touch, and `playerId` on player click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handlers

Return to top ## Goaltenders us.match.nhl.goaltenders provides game statistics for each goaltender in a given 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	Description
		`matchId`	number	required	Match ID
		`disableHeader`	boolean		If `true` hides the header.
		`disableHeaderDetails`	boolean		If `true` hides the header details.
		`border`	boolean		If `true` enables a border around the widget.
		`onItemClick`	function		Function/event handler. Emits `playerId` on player click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Live Game Carousel us.match.nhl.liveMatchCarousel displays a scrolling carousel of live or upcoming NHL games. > To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Default	Description
		`tournaments`	string		''	Tournaments to display in a comma-separated string. Valid options are `regular`, `preseason`, `allstar` or an empty value (all tournaments). More than one can be included.
		`limit`	number		10	Max number of games shown.
		`autoplay`	boolean		'true'	If `false` stops carousel autoplay.
		`autoplaySpeed`	number		5000	Carousel autoplay speed in ms.
		`showDate`	boolean			If `true` displays date along match time.
		`border`	boolean			If `true` enables a border around the widget.
		`onMatchesSet`	function			Function/event handler. Emits `matchIds` array on team click or touch.
		`onItemClick`	function			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 Game Tracker us.match.lmt provides live scoring, statistics, and win probabilities for a given 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

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Money Percentage Tracking us.betting.match.moneyPercentageTrackingSlim displays a small money tracking graph for a given game, 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 ## News us.common.News displays full news articles, with the capability to filter by season, game, and player. >

To display player news, the parameters playerId, seasonId and providerId must be set.
To display game news, the parameters matchId, providerId and type must be set.
To display season news, the parameters seasonId and providerId must be set.

To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Description
		`seasonId`	number	optional	Season ID
		`matchId`	string	optional	Match ID
		`playerId`	string	optional	Player ID
		`articleId`	string	optional	Article ID
		`limit`	number	optional	Maximum number of articles to display.
		`type`	string	optional	Type of content. Valid types: `previews`, `recaps`, or `contents`.
		`providerId`	number	optional	ID of the news provider. `2` for Associated Press, `3` for Associated Press Premium.
		`border`	boolean	optional	If `true` enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Odds us.match.odds provides odds for a given game (upcoming and live 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	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`. In NHL the `spread` stands for puckline.
		`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 ## Odds Comparison us.betting.season.oddsComparison provides daily bookmaker odds for all games 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`. In NHL the `spread` stands for puckline.
`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 ## Play by Play us.match.nhl.playByPlay displays a running timeline of every event in a given NHL game. >![NHL Play by Play](../../../files/Widget_NHL_PBP_1.png "NHL Play by Play") 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		'ascending'	Determines sort order. Valid options are `ascending` or `descending`.
		`isExpanded`	boolean		'false'	If `true` displays an expanded tree.
		`disableFilter`	boolean			If `true` hides all filters, selectors, dropdowns, tabs.
		`flipOnLiveMatch`	boolean			If `true` displays last period only.
		`compactPeriodLayout`	boolean		'false'	If `true` displays compact period layout.
		`showLast10`	boolean		'false'	If `true` limits list to last 10 events.
		`disableHeader`	boolean			If `true` hides the header.
		`border`	boolean			If `true` enables a border around the widget.
		`onToggle`	function			Function/event handler. Emits `toggle` object on period heder click or touch.
		`onItemClick`	function			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 ## Player Career Stats us.player.nhl.careerStats displays the career stats of a given NHL player. > For the widget to render you must provide a valid playerId. 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	optional		Player ID
		`seasonDefaultSortDirection`	string	optional	'asc'	Sets initial season column sort direction. Valid options are: `asc` / `desc`.
		`skaterColumns`	string	optional		Comma separated string of skater table statistics column keys. Used for picking fewer columns and different order. Valid options are: `gp`, `g`, `a`, `p`, `pm`, `pim`, `ppg`, `shg`, `shp`, `gwg`, `otg`, `sog`, `sp`, `toigp`, `fowp`. A table of definitions is included below.
		`goaliesColumns`	string	optional		Comma separated string of goalie table statistics column keys. Used for picking fewer columns and different order. Valid options are: `gp`, `gs`, `w`, `l`, `otl`, `ga`, `gaa`, `sa`, `s`, `svp`, `sho`, `toi`. A table of definitions is included below.
		`border`	boolean	optional		When set to `true` the table is displayed with border.

skaterColumns Option Descriptions

Option	Description
`gp`	Games Played
`g`	Goals
`a`	Assists
`p`	Points
`pm`	Plus / Minus
`pim`	Penalty Minutes
`ppg`	Power Play Goals
`shg`	Short Handed Goals
`shp`	Short Handed Points
`gwg`	Winning Goals
`otg`	Overtime Goals
`sog`	Shots on Goal
`sp`	Shooting Percentage
`toigp`	Time on Ice per Game
`fowp`	Faceoff Win Percentage

goalieColumns Option Descriptions

Option	Description
`gp`	Games Played
`gs`	Games Started
`w`	Wins
`l`	Losses
`otl`	Overtime Losses
`ga`	Goals Against
`gaa`	Goals Against Average
`sa`	Shots Against
`s`	Saves
`svp`	Saves Percentage
`sho`	Shutouts
`toi`	Time on Ice

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Player Comparison us.betting.match.nhl.playerComparison compares statistics of two players of the same position (skater or goalie) among a variety of timeframes (Provided Game, Last 5 Games, Season, or Career). > 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 dropdown. Valid options are `match`, `matchup`, `last5`, `season`, or `career`.
		`positions`	string	optional		Selects position dropdown. Valid options are `AS` or `G`.
		`awayPlayerId`	number	optional		Player Id from away match squad.
		`homePlayerId`	number	optional		Player Id from home match squad.
		`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 border around the widget.
		`onItemClick`	boolean	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 ## Player Game Logs us.player.gameLogs shows per game statistics for a given player in a season. > For the widget to render you must provide a valid playerId and seasonId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Description
		`playerId`	number	required	Player ID
		`seasonId`	number	required	Season ID
		`seasonType`	string	optional	Season Type: `regular` / `playoffs`
		`uniqueTournamentId`	number	optional	If `seasonId` is not provided, `uniqueTournamentId` can be used to get the current active season in that tournament.
		`sortIdx`	string	optional	Overrides table default sort column index. 1, 2, 3..; Usually used with `sortDirection`.
		`sortDirection`	string	optional	Overrides skater table default sort direction. Valid options are `asc` and `desc`. Usually used with `sortIdx`.
		`enableLimit`	boolean	optional	Switches into limited mode. If there are more than 10 games, it shows only 10 games with an option to extend the games view. Games are sorted from newest on.
		`border`	boolean	optional	If `true` enables a border around the widget.
		`onItemClick`	boolean		Function/event handler. Emits `matchId` and other props on table row click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Example of onItemClick targets and emitted props

match: {"matchId":"sd:match:f0e1490c-e9c3-479d-b937-cb2e3930b29b","seasonId":2021,"awayTeamId":"sd:team:e6aa13a4-0055-48a9-bc41-be28dc106929","homeTeamId":"sd:team:4254d319-1bc7-4f81-b4ab-b5e6f3402b69"}

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, including headshot, number, and position. > 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 Seasonal Statistics us.season.nhl.playersStats provides a seasonal statistics table for all NHL players. >

All properties are optional. By default, the widget will render a player statistics table for the active season. 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
		`seasonType`	string	optional	'regular'	Season Type: `regular` / `playoffs`
		`category`	string	optional	'skater'	Statistics Mode: `skater` / `goalie`
		`conference`	string	optional	'skater'	Conference Filter: `eastern` / `western` except for the 2020/21 season the division names are used instead: `central` / `east` / `north` / `west`
		`uniqueTeamId`	number	optional		Unique team ID filter.
		`qualifiesAsLeagueLeader`	boolean	optional	'true'	When set to `true` enables statistical minimums to qualify a player for inclusion in a statistical category.
		`disableTitle`	boolean	optional		When set to `true` hides the widget title.
		`hideFilters`	boolean	optional		When set to `true` hides all filters / dropdown.
		`skaterColumns`	string	optional		Comma separated string of skater table statistics column keys. Used for picking fewer columns and different order. Valid options are: `gp`, `g`, `a`, `p`, `pm`, `pim`, `ppg`, `shg`, `sog`, `sp`, `toigp`, `shiftsgp`, `fowp`. A table of definitions is included below.
		`goaliesColumns`	string	optional		Comma separated string of goalie table statistics column keys. Used for picking fewer columns and different order. Valid options are: `gp`, `w`, `l`, `otl`, `ga`, `gaa`, `sa`, `s`, `svp`, `sho`, `toi`. A table of definitions is included below.
		`skaterSortIdx`	string	optional		Overrides skater table default sort statistics column index. 1, 2, 3....
		`goalieSortIdx`	string	optional		Overrides goalie table default sort statistics column index. 1, 2, 3....
		`pageLength`	number	optional	50	How many players display per page.
		`border`	boolean	optional		When set to `true` the table is displayed with border.
		`onItemClick`	function	optional		Function/event handler. Emits `playerId`, `uniqueTeamId`, `seasonId`, `uniqueTournamentId` on table row click or touch.

skaterColumns Option Descriptions

Option	Description
`gp`	Games Played
`g`	Goals
`a`	Assists
`p`	Points
`pm`	Plus / Minus
`pim`	Penalty Minutes
`ppg`	Power Play Goals
`shg`	Short Handed Goals
`sog`	Shots on Goal
`sp`	Shooting Percentage
`toigp`	Time on Ice per Game
`shiftsgp`	Shifts per Game
`fowp`	Faceoff Win Percentage

goalieColumns Option Descriptions

Option	Description
`gp`	Games Played
`w`	Wins
`l`	Losses
`otl`	Overtime Losses
`ga`	Goals Against
`gaa`	Goals Against Average
`sa`	Shots Against
`s`	Saves
`svp`	Saves Percentage
`sho`	Shutouts
`toi`	Time on Ice

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Player Stats Graphic us.season.nhl.playerStatsGraphic visualizes seasonal statistics for a given player, including a breakdown of the last 5 games played. > For the widget to render you must provide a valid playerId and seasonId. 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	required		Season ID
		`seasonType`	string	optional	'regular'	Season Type: `regular` / `playoffs`
		`disableDropdown`	boolean	optional		If `true` hides the team dropdown.
		`qualifiesAsLeagueLeader`	boolean	optional	'true'	When set to `true` enables statistical minimums to qualify a player for inclusion in a statistical category.
		`border`	boolean	optional		If `true` enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Playoffs us.season.nhl.playoffs displays a full playoff bracket, including results for each series. > This widget will display the playoff bracket for the active season by default. 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
		`disableSeasonSelector`	boolean	optional	Hides the season selector.
		`onItemClick`	function	optional	Function/event handler. Emits `uniqueTeamId` on click or touch.
		`border`	boolean	optional	If `true` enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Pregame Betting Statistics us.betting.match.pregameBettingStatistics displays betting statistics of a given game. > For the widget to render you must provide a valid matchId. All other properties are optional. This widget is not supported for exhibition or preseason games. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Description
		`matchId`	string	required	Match ID
		`disableHeader`	boolean	optional	If `true` hides the widget header.
		`border`	boolean	optional	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 ## 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-game only).
		`showOdds`	boolean	optional	'true'	If `false` hides odds (pre-game 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

Without matchId, sport or uniqueTournamentId props being set, the widget attempts to find and auto-select sports with live games. 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 game. Failing to find a live sport or an upcoming game with the considerNearest prop, the widget falls back to the NFL Score Ticker for the current day. The widget automatically reselects live games, 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

If matchId, 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 ## Season Injuries us.season.injuries displays all current 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, conference, and division. > 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 Score Per Game Ranks us.season.scorePerGameRanks displays the average goals per game for two provided teams. > For the widget to render you must provide 1. a valid matchId or 2. teamUid1 & teamUid2 combined with one of the following: seasonId, tournamentId, 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
		`matchId`	number	required		Match ID. Has priority over other options.
		`teamUid1`	number	optional		Unique team ID 1
		`teamUid2`	number	optional		Unique team ID 2
		`seasonId`	number			Season ID
		`tournamentId`	number			Tournament ID. Deduces season.
		`uniqueTournamentId`	number			Unique Tournament ID. Deduces season.
		`showRankTitle`	boolean	optional		If set to `true` shows rank title.
		`statisticType`	string	optional	'own'	Selects with score to show. Valid options are: `own` or `opponent`.
		`disableHeader`	boolean	optional		If set to `true` hides the header.
		`border`	boolean	optional		If set to `true` enables a boarder around the widget.

Examples

HTML/Declarative

JS/Programmatic

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 over uniqueTournamentId.
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 for uniqueTournamentId.
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 and selectedIdx enables selection of a particular day or round. tableroundId and cuproundId 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 to false; 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 or dayFlipHoursBefore 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.

Example: To display five days of scores broken down by day, in the middle of a season: set 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	Description
`props`	object	properties
		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-match. 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-match. 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 Game the 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`, `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 ## Shot Chart us.match.nhl.shotChart visualizes rink locations for all goals and shots in a given game, as well as a list of clickable skaters. > 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
		`tabType`	string	optional	'goals'	Selects `goals` or `shots` view.
		`stripedVersion`	boolean	optional		If `true` hides scorers and shooters list.
		`onlyPitch`	boolean	optional		If `true` hides navigation, along with scorers and shooters list.
		`disableHeader`	boolean	optional		If `true` hides the header.
		`disableHeaderDetails`	boolean	optional		If `true` hides the header details.
		`border`	boolean	optional		If `true` enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Standings us.season.nhl.standings provides detailed standings info for a given season. > By default, the widget provides the 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	active season	Season ID
		`organizationType`	string	optional	'conference'	Separates/filters the teams in standings into groups. Possible options: `conference`, `division`, `wildCard`.
		`border`	boolean	optional		If `true` enables a border around the widget.
		`showSeasonSelector`	boolean	optional	'true'	If `false` hides season 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.nhl.standingsCarousel provides a moving carousel of divisional standings. > By default, the widget provides the 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	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.nhl.standingsSlim provides detailed standings info for one division. > By default, the widget renders the active standings for the Atlantic 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
		`division`	string	optional	'atlantic'	Selects division. Valid options: `eastern`, `western`, `metropolitan`, `atlantic`, `central`, or `pacific`. For season 20/21 (Season Id: 78917) valid options: `east`, `central`, `north`, or `west`
		`uniqueTeamId`	number	optional		Unique team ID. Denotes division.
		`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 division 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 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 Leaders us.season.nhl.teamLeaders displays a top 3 leaderboard for a provided team and statistic. > For the widget to render you must provide a valid uniqueTeamId and seasonId. The default display is 'goals' for the regular season. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Default	Description
		`uniqueTeamId`	number	required		Unique team ID
		`seasonId`	number	required		Season ID
		`seasonType`	string	optional	'regular'	Season type. Valid options are: `regular` or `playoffs`.
		`category`	string	optional	'goals'	Statistic category. Valid options are: `goals`, `points`, `assists`, `plus_minus`, `acc`, `pim`, `wins`, `shutouts`, `saves`, and `save_percentage`.
		`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 Ranks us.season.nhl.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.nhl.recentGames displays upcoming and/or past games of a selected team. > For the widget to render you must provide a valid teamUid. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Default	Description
		`teamUid`	number	required		Unique team ID
		`pastGames`	number	optional	10	Number of past games to display.
		`nextGames`	number	optional	1	Number of future games to display.
		`currentSeason`	boolean	optional	true	If `true` filters matches of current season only.
		`sortDirection`	string	optional	desc	Changes groups and games sort direction. Valid options are: `asc` and `desc`.
		`disableTeamDropdown`	boolean	optional		If `true` disables team selection dropdown.
		`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 `matchId` `seasonId` and other props on table row on click or touch. See example below.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Example of onItemClick targets and emitted props

match:{"matchId":25042420,"seasonId":78917,"tournamentId":142,"uniqueTournamentId":234,"realCategoryId":37,"sportId":4,"awayTeamUid":3697,"homeTeamUid":3691,"matchStatus":"post"}

Return to top ## Team Roster us.season.nhl.teamRoster visualizes a complete team roster for a given 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
		`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.nhl.schedule displays the entire season schedule for a given team. >![NHL Team Schedule](../../../files/Widget_NHL_TeamSchedule.png "NHL Team Schedule") For the widget to render you must provide a valid teamUid. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Default	Description
		`teamUid`	number	required		Unique team ID
		`seasonId`	number	optional		Season ID
		`sortDirection`	string	optional	asc	Changes groups and games sort direction. Valid options are: `asc` and `desc`.
		`currentSeason`	boolean	optional	true	If `true` filters matches of current season only.
		`sortDirection`	string	optional	desc	Changes groups and games sort direction. Valid options are: `asc` and `desc`.
		`disableHeader`	boolean	optional		If `true` hides the widget header.
		`disableTeamDropdown`	boolean	optional		If `true` disables team selection dropdown.
		`disableGroupDropdown`	boolean	optional		If `true` omits group dropdown and displays all groups and matches.
		`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 on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Team Score Small us.team.scoreSmall displays the score of a given game. > For the widget to render you must provide a valid teamUid and matchId. 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. The ID must be one of the two teams that played in the provided game.
		`matchId`	number	required	Match ID
		`border`	boolean	optional	If `true` enables a border around the widget.
		`onItemClick`	function	optional	Function/event handler. Emits `matchId`, `matchStatus`, `uniqueTeamId`, `seasonId`, `tournamentId`, and `uniqueTournamentId` on click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Team Seasonal Statistics us.season.nhl.teamsStats displays a sortable team statistics table for all teams in a given season. > All widget properties are optional. By default, the widget will a table for the active season. 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
		`seasonType`	string	optional	'regular'	Season type: `regular` / `playoffs`.
		`conference`	string	optional		Conference filter: `eastern` / `western`. For the 2020/21 season the division names are used instead: `central`, `east`, `north`, `west`.
		`border`	boolean	optional		When set to `true` the table is displayed with border.
		`disableTitle`	boolean	optional		When set to `true` hides the widget title.
		`hideFilters`	boolean	optional		When set to `true` hides all filters / dropdown.
		`columns`	string	optional		Comma separated string of hitting table statistics column keys. Used for picking fewer columns and different order. Valid options are: `gp`, `w`, `l`, `otl`, `pts`, `pp`, `g`, `a`, `sog`, `pim`, `ga`, `sho`, `sowins`, `gfgp`, `gagp`, `ppp`, `pkp`.
		`onItemClick`	function	optional		Function/event handler. Emits `uniqueTeamId`, `seasonId`, `uniqueTournamentId` on table row click or touch.

Columns Option Descriptions

Option	Description
`gp`	Games Played
`w`	Wins Total
`l`	Losses Total
`otl`	Overtime Losses Total
`pts`	Points
`pp`	Points Percentage
`g`	Goals
`a`	Assists
`sog`	Shots On Goal
`pim`	Penalty Minutes
`ga`	Opponent Goals
`sho`	Shutouts
`sowins`	Team Shootout Wins
`gfgp`	Goals For per Games Played
`gagp`	Goals Against per Games Played
`ppp`	Powerplay Conversion Percentage
`pkp`	Penalty Kill Percentage

Examples

HTML/Declarative

JS/Programmatic

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 > us.match.nhl.teamStats provides a statistical comparison between two teams in a given 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
		`disableHeader`	boolean	optional		If `true` hides the header.
		`border`	boolean	optional		If `true` enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top ## Team Stats Graphic us.match.nhl.teamStatsGraphic provides top-level team seasonal statistics, with a dropdown for team selection. > For the widget to render you must provide a valid 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	required		Season ID
		`teamUid`	number	optional		Team Unique ID
		`seasonType`	string	optional	'regular'	Selected season type. Valid options: `regular` or `playoffs`.
		`disableDropdown`	boolean	optional		If `true` hides the team 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 ## Top Players us.season.nhl.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. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
`seasonId`	number	required		Season ID
`seasonType`	string	optional	'main'	Season type. Valid options are: `main` or `playoffs`.
`statType`	string	optional	'points'	Selected Stat. Valid options: `points`, `goals`, `assists`, `plus_minus`, `goaltending_total_average_goals_against`, `goaltending_total_saves_percentage`, `goaltending_total_wins`, or `goaltending_total_shutouts`.
`disableDropdown`	boolean	optional	'points'	If `true` hides dropdown.
`disableHeader`	boolean	optional		If `true` hides the widget header.
`showTitle`	boolean	optional		If `true` turns dropdown to title.
`hidePlayers`	boolean	optional		If `true` hides player images.
`playersLimit`	number	optional	5	Limits list length.
`qualifiesAsLeagueLeader`	boolean	optional	'true'	If `true` enables statistical minimums to qualify a player for inclusion in a statistical category.
`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.nhl.topPlayersCarousel displays a moving top 5 leaderboard for a variety of NHL player statistics. > To have specific stats for players, statString must be set. List of stat keys:

pts (Points)
g (Goals)
ast (Assists)
pm (Plus Minus)
gaa (Goaltending Total Average Goals Against)
svp (Goaltending Total Saves Percentage)
w (Goaltending Total Wins)
sho (Goaltending Total Shutouts)

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
		`statString`	string	optional		String with stat Keys. Valid options: `pts`, `g`, `ast`, `pm`, `gaa`, `svp`, `w`, or `sho`.
		`seasonType`	string	optional	'regular'	Season type. Valid options are: `regular` or `playoffs`.
		`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 ## Top Teams us.season.nhl.topTeams provides a team leaderboard for a selected statistic and season. > For the widget to render you must provide a valid seasonId. To see a full-sized version of this widget, click here.

Parameters

Name	Type	Argument	Default	Description
`seasonId`	number	required		Season ID
`seasonType`	string	optional	'regular'	Season type. Valid options are: `regular` or `playoffs`.
`statType`	string	optional	'points'	Selected Stat. Valid options: `points`, `goals`, `assists`, `shots_on_goal`, `penalty_minutes`, `opponents_goals`, `goaltending_total_shutouts`, `games_played`, `power_play_goals`, `power_play_opportunities`, `opponents_power_play_goals`, or `opponents_power_play_opportunities`.
`disableDropdown`	boolean	optional	'points'	If `true` hides dropdown.
`teamsLimit`	number	optional	5	Limits list length.
`border`	boolean	optional		If `true` enables a border around the widget.
`onItemClick`	function	optional		Function/event handler. Emits `event` on team row click or touch.

Examples

HTML/Declarative

JS/Programmatic

JS/Example of using Event Handler

Return to top ## Transactions us.common.Transactions displays transactions by season, team, or player. > To see a full-sized version of this widget, click here. To display recent transactions, you must use a valid uniqueTournamentId, and recent must be set to 'true'. To display seasonal transactions, either the uniqueTournamentId or the seasonId parameter must be set. If only uniqueTournamentId is provided, the current season is displayed. To display team transactions, use the parameter uniqueTeamId. If seasonId is set, the team transactions of the given season are displayed. If only uniqueTeamId is provided, the most recent team transactions are displayed. To display a player's transactions, use the parameter playerId.

Parameters

Name	Type	Description
`props`	object	properties
		Name	Type	Argument	Description
		`uniqueTournamentId`	number	optional	Unique tournament ID
		`recent`	boolean	optional	When set to `true` displays the recent transactions in a season.
		`seasonId`	number	optional	Season ID
		`uniqueTeamId`	number	optional	Unique team ID
		`playerId`	number	optional	Player ID
		`border`	boolean	optional	When set to `true` draws a border around the widget.
		`pageSize`	number	optional	Enables table pagination and defines the number of rows per page.
		`pageIndex`	number	optional	Sets the 0-based index of the table page to display. Default is 0.

Examples

HTML/Declarative

JS/Programmatic

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 ## Win Probability us.match.winProbability displays the win probability for each team in a given 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
		`border`	boolean	optional	'true'	If `true` enables a border around the widget.

Examples

HTML/Declarative

JS/Programmatic

Return to top

version 103 as of 9 months ago by Paul Sutton