Sportradar offers a vast array of customizable NCAA Football widgets, with in-depth statistics.
> Click here for our NCAA Football 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 NCAA Football 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.
## Articles
us.common.articlesList displays a list of editorial articles.
>
To see a full-sized version of this widget, click here.
Parameters
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
## Betting Player Comparison
us.betting.match.ncaaf.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 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
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 QB, RB, WR, TE, DL, LB, DB, K, P, KR, or PR.
awayPlayerId
number
optional
Player ID from away team.
homePlayerId
number
optional
Player ID from home team.
hasPlayed
boolean
optional
If true only actually played games 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.ncaaf.score displays a small scoreboard with odds from a given NCAA Football 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 diplays 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
## Boxscore
us.match.ncaaf.boxScore provides a structured summary of team totals and player statistics 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
homeStats
string
optional
'team'
Selects stats type for the home team. Valid values are team or players.
awayStats
string
optional
'team'
Selects stats type for the away team. Valid values are team or players.
enableTeamTabs
boolean
optional
If true the widget displays tabs instead of a dropdown for mobile breakpoint, making apparent which teams are competing.
border
boolean
optional
If true enables a border around the widget.
onItemClick
function
optional
Function/event handler. Emits uniqueTeamId and playerId when a player is clicked (target: player), and uniqueTeamId and page when a dropdown selection has been made (target: team).
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
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.
>![NCAAFB Future Odds Table](../../../files/Widget_NCAAF_FutureOddsTable_Sample.png "NCAAFB Future Odds Table")
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.ncaa.leaders provides a moving carousel of stat leaders 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
chartType
string
optional
bars
Chart type: bars or circular.
autoplay
boolean
optional
true
If false stops the carousel autoplay.
autoplaySpeed
number
optional
3000
Carousel autoplay speed in milliseconds.
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/Programmatic
Return to top
## Game Odds
us.match.ncaa.odds provides odds data for a given NCAA Football 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
oddsTypes
string
optional
all odds types
Comma-separated list of odds types. Options are: moneyline, 2way, spread, overunder.
type
string
optional
mixed
Determines the height of the odds market buttons. Valid values: mixed, line, block.
disableHeader
boolean
optional
false
When set to true hides the widget header.
border
boolean
optional
If true enables a border around the widget.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Game Tracker
us.match.ncaaf.gameTracker provides a live visualization of real-time action, including: a scoring graph, player comparisons, and an event timeline.
>
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
border
boolean
If true enables a border around the widget.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Linescore
us.match.ncaaf.linescore provides a score summary per quarter for a given game, including the current situation for 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
Description
matchId
number
required
Match ID
border
boolean
optional
If true enables a border around the widget.
onItemClick
function
optiona>
Function/event handler. Emits uniqueTeamId on click or touch.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Live Game Carousel
us.match.ncaaf.liveMatchCarousel displays a scrolling carousel of live or upcoming NCAA Football games.
>
To see a full-sized version of this widget, click here.
Parameters
Name
Type
Description
props
object
properties
Name
Type
Argument
Default
Description
uniqueTournamentId
string
optional
With this prop empty, both regular season and playoffs games are displayed. To display regular season: 27653. To display playoffs: 27625.
division
string
optional
'fbs'
The divisions to display: fbs, fcs, dII, dIII.
conference
string
optional
all conferences
Selected conference. Click *here* for a list of all valid conference names.
limit
number
optional
10
Max number of games shown.
autoplay
boolean
optional
'true'
If false stops carousel autoplay.
autoplaySpeed
number
optional
5000
Carousel autoplay speed in ms.
showDate
boolean
optional
If true displays date alongside game 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 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
## 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 Comparison
us.betting.season.ncaaf.oddsComparison is a compiled table of bookmaker odds. It shows pre-game and live odds based on the game's status and odds type.
>
To see a full-sized version of this widget, click here.
Parameters
Name
Type
Argument
Default
Description
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.
division
string
optional
'fbs'
Selected division, either: fbs or fcs.
conference
string
optional
all conferences
Selected conference. Click *here* for a list of all valid conference names.
selectedDate
number
optional
Selects particular NCAAF week which contains selectedDate. Format: YYYY-MM-DD.
onItemClick
function
optional
Function/event handler. Emits matchId on match 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.
disableDivisionDropdown
boolean
optional
If true disables/hides the Division dropdown.
disableConferenceDropdown
boolean
optional
If true disables/hides the Conference dropdown.
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 the 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.ncaaf.playByPlay displays a running timeline of every drive in a given game, as well as an interactive field display.
>
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
disableInnerScrolling
boolean
optional
When set to true the inner fixed-height drives scroll area is disabled. The widget displays full height.
listOrder
string
optional
The order of quarters, drives, and plays in the list. Valid values are: 'default' - during a live game quarters, drives, and plays are listed in a descending order, otherwise in an ascending order; 'desc' lists quarters, drives, and plays in a descending order; 'descq' lists quarters in a descending order, and drives and plays in an ascending order; 'asc' lists quarters, drives, and plays in an ascending order.
selectedQuarter
number
optional
null
The number of the quarter, when selecting a play with the triplet selectedQuarter, selectedDrive, selectedPlay. Can be one of 1, 2, 3, 4, or 5 (overtime). Defaults to the last quarter played.
selectedDrive
number
optional
null
The number of the drive, when selecting a play with the triplet selectedQuarter, selectedDrive, selectedPlay. Numbering starts at 1. Defaults to the last drive played.
selectedPlay
number
optional
null
The number of the play, when selecting a play with the triplet selectedQuarter, selectedDrive, selectedPlay. Numbering starts at 1. Defaults to the last play played.
filterQuarter
number
optional
null
When set, displays only drives of the specified quarter. Can be one of: null, 1, 2, 3, 4, 5 (overtime). Null represents no restriction.
filterDrive
number
optional
null
Can be one of: null, scoring, team. When scoring, displays only scoring drives. When team, displays only drives where the team set with filterDriveTeamId is in possession. Null represents no restriction.
filterDriveTeamId
number
optional
null
Sets the team ID to use when filterDrive is team.
useTeamColors
boolean
optional
null
Valid values are: null(Uses your settings. If you are configured to use team colors, then the theme can be overridden with the teamColorsTheme parameter.), true(team colors will be used, as specified with the teamColorsTheme parameter. If your configuration does not specify a team colors theme, then team colors will not be used.), or false(team colors will not be used).
teamColorsTheme
string
optional
null
When set (and not disabled by useTeamColors), specifies the name of the formula to calculate team colors (e.g. mono-team-colors-light).
enableTeamSelect
boolean
optional
false
When set to true enables team selection. Interactive areas are: team name and logo in a match header, team logos in the statistics sub-headers, rows in the scoring table of the match header, and team logos in the driveList and on the pitch. TeamId is emitted on click or touch.
onTeamSelected
function
optional
A callback that is invoked when a team has been selected. enableTeamSelect must be set to true.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Player Career Stats
us.player.ncaaf.CareerStats displays the career stats of a given NCAA Football 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
Argument
Default
Description
playerId
number
required
Player ID
seasonDefaultSortDirection
string
optional
'asc'
Sets initial season column sort direction. Valid options are asc and desc.
passingColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: pc, pa, pcp, pt, pi, py, pr, pyg, pya, ps, pl.
rushingColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: ra, ry, ravg, rt, rag, ryg, rl.
receivingColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: recr, recy, rect, recyg, recyr, recl.
defenseColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: dt, dat, dct, dtfl, ds, dsy, ff, tfr, di, diy, dit.
kickingColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: kt, ktb, kny, fgm, fga, fgp, sfgl, epkm, epka, epkp.
puntingColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: puntt, puntgy, puntgya, puntb, punttb, puntio, puntl.
kickoffReturnsColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: kr, kry, krya, krfc, krl, krt.
puntReturnsColumns
string
optional
Comma separated string of table statistics column keys. Used for picking fewer columns and different order. Valid options are: puntr, puntry, puntrya, puntrfc, puntrl, puntrt.
filterSeasons
boolean
optional
When set to true seasons are not added to category tables if all relevant stats are 0. If all category tables are empty, NoDataError is displayed.
border
boolean
optional
When set to true the table is displayed with a border.
props.passingColumns Option Descriptions
Option
Description
pc
Passing completions
pa
Passing attempts
pcp
Passing completion percentage
pt
Passing touchdowns
pi
Passing interceptions
py
Passing yards
pr
Passing rating
pyg
Passing yards per gameer
pya
Passing yards per attempt
ps
Passing sacks
pl
Passing longest
props.rushingColumns Option Descriptions
Option
Description
ra
Rushing attempts
ry
Rushing yards
ravg
Rushing average
rt
Rushing touchdowns
rag
Rushing attempts per game
ryg
Rushing yards per game
rl
Rushing longest
props.receivingColumns Option Descriptions
Option
Description
recr
Receptions
recy
Receiving yards
rect
Receiving touchdowns
reypg
Receiving yards per game
recyr
Yards per reception
recl
Receiving longest
props.defenseColumns Option Descriptions
Option
Description
dt
Defensive tackles
dat
Defensive assisted tackles
dct
Defensive combined tackles
dtfl
Defensive tackles for loss
ds
Defensive sacks
dsy
Defensive sack yards
ff
Forced fumbles
tfr
Total fumbles recovered
di
Defensive interceptions
diy
Defensive interception yards
dit
Defensive interception touchdowns
props.kickingColumns Option Descriptions
Option
Description
kt
Kickoffs total
ktb
Kickoff touchbacks
kny
Kickoff net yards
fgm
Field goals made
fga
Field goals attempted
fgp
Field goal percentage
sfgl
Special teams longest field goal
epkm
Extra points made
epka
Extra points attempted
epkp
Extra point percentage
props.puntingColumns Option Descriptions
Option
Description
puntt
Total punts
puntgy
Gross punt yards
puntgya
Gross punt yard average
puntb
Punts blocked
punttb
Punt touchbacks
puntio
Punts inside opponents 20 yardline
puntl
Longest Punt
props.kickoffReturnsColumns Option Descriptions
Option
Description
kr
Kickoff returns
kry
Kickoff return yards
krya
Average kickoff return yards
krfc
Kickoff return fair catches
krl
Longest kickoff return
krt
Kickoff return touchdowns
props.puntReturnsColumns Option Descriptions
Option
Description
puntr
Punt returns
puntry
Punt return yards
puntrya
Average punt return yards
puntrfc
Punt return fair catches
puntrl
Longest punt return
puntrt
Punt return touchdowns
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Player Comparison
us.match.ncaaf.playerComparison compares statistics of two players of the same position 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
Description
matchId
number
required
Match ID
team1Id
number
optional
Team1 ID
matchId
number
optional
Team2 ID
playerPosition
string
optional
Sets player position to be compared: QB, RB, WR/TE, DL, LB, DB, K, P.
border
boolean
optional
If true enables a border around the widget.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Player Game Logs
us.player.ncaaf.gameLogs shows game-by-game statistics for a given player in a season.
>
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
Description
playerId
number
required
Player ID
seasonId
number
optional
Season ID. If not provided, the current season is used.
seasonType
string
optional
Season type: regular / playoffs
sortIdx
number
optional
Overrides table default sort column index. 1, 2, 3..; Usually used with sortDirection.
sortDirection
string
optional
Overrides 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":23634887,"seasonId":75093,"tournamentId":85,"uniqueTournamentId":27653,"realCategoryId":43,"sportId":16,"awayTeamUid":4352,"homeTeamUid":4338}Return to top
## Player Header
us.player.ncaaf.header provides biographical information and current seasonal stats for a given player.
>
For the widget to render you must provide a valid playerId and 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
Description
playerId
number
required
Player ID
seasonId
number
required
Season ID
seasonType
string
optional
Season Type. Valid values are: main and playoffs.
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
## Player Header Small
us.player.headerSmall provides basic player information.
>
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
year
number
optional
'main'
Selected year as friendly alternative to seasonId. Used in conjunction with seasonType.
seasonType
string
optional
'regular'
Season type. Valid options are: total, regular, 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 Seasonal Statistics
us.season.ncaaf.playersStats displays seasonal statistics for NCAA Football players.
>
All properties are optional. By default, the widget provides player statistics for the active season.
To see a full-sized version of this widget, click here.
Filter teams by conference. Valid options are: aac, acc, big12, b1g, cusa, indepfbs, mac, mw, pac12, sec, sunbelt.
seasonType
string
optional
'regular'
Season type. Valid options are: regular, playoffs.
border
boolean
optional
When set to true the table is displayed with a border.
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.
defenseColumns
string
optional
Comma separated string of defensive statistics column keys. Used for picking fewer columns and different order. Valid options are team, defense_tackles, defense_assisted_tackles, defense_sacks, defense_sack_yards, fumbles_forced, defense_interception, defense_interception_yards, defense_tackles_for_loss.
kickingColumns
string
optional
Comma separated string of kicking table statistics column keys. Used for picking fewer columns and different order. Valid options are team, kickoffs_total, kickoffs_touchbacks_percent, kickoffs_net_yards, kickoffs_avg_yards, specteam_field_goal, specteam_field_goal_attempt, specteam_field_goal_percent.
passingColumns
string
optional
Comma separated string of passing statistics column keys. Used for picking fewer columns and different order. Valid options are: team, passing_completions, passing_attempts, passing_completions_percent, passing_touchdowns, passing_interception.
puntingColumns
string
optional
Comma separated string of punting table statistics column keys. Used for picking fewer columns and different order. Valid options are team, punts_total, punts_gross_yards, punts_gross_yards_avg, punts_blocked, punts_touchbacks.
receivingColumns
string
optional
Comma separated string of receiving statistics column keys. Used for picking fewer columns and different order. Valid options are team, receiving_receptions, receiving_yards, receiving_touchdowns, receiving_yards_per_reception.
puntReturnsColumns
string
optional
Comma separated string of punt returns table statistics column keys. Used for picking fewer columns and different order. Valid options are team, punts_returned, punt_return_yards, punt_return_yards_avg, punt_return_fair_catches, punt_return_touchdowns.
kickoffReturnsColumns
string
optional
Comma separated string of punt returns table statistics column keys. Used for picking fewer columns and different order. Valid options are team, kickoffs_returns, kickoffs_return_yards, kickoffs_return_yards_avg, kick_return_fair_catches, kick_return_touchdowns.
rushingColumns
string
optional
Comma separated string of rushing statistics column keys. Used for picking fewer columns and different order. Valid options are: team, rushing_attempts, rushing_yards, rushing_touchdowns, rushing_touchdowns_percent.
Function/event handler. Emits playerId, uniqueTeamId, seasonId, uniqueTournamentId on table row click or touch.
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Player Stats Graphic
us.season.ncaaf.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. 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
required
Season ID
seasonType
string
optional
'regular'
Selected season type: total, regular or playoffs.
disableHeader
boolean
optional
If true hides the header.
qualifiers
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.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Playoffs
us.season.ncaaf.playoffs displays a full bracket for the College Football Playoff.
>
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
Default
Description
seasonId
number
optional
Season ID. Has priority over year.
year
number
optional
Selected year as friendly alternative to seasonId. It is the end year property of the selected playoffs season.
showHeaderTitle
boolean
optional
true
If false hides the header title.
showHeaderRounds
boolean
optional
true
If false hides the header rounds.
showTournamentSelector
boolean
optional
true
If false hides the tournament selector.
showYearSelector
boolean
optional
true
If false hides the year selector.
hideTeamLogos
boolean
optional
If true hides the team logo.
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
Return to top
## Polls
us.season.ncaaf.polls provides a display of the AP Top 25, Coaches Poll, and College Football Playoff Rankings.
>
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. (Regular season ID only)
pollTypes
string
optional
'ap'
Comma separated string of types of poll tables. When no pollTypes are provided, all are displayed. Valid options are: ap, coachespoll, cfp.
border
boolean
optional
When set to true the table is displayed with a border.
onItemClick
function
optional
Function/event handler. Emits uniqueTeamId on table row click or touch.
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Pregame Betting Statistics
us.betting.match.ncaaf.pregameBettingStatistics displays betting statistics of a given NCAA Football 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
Description
matchId
number
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 teamId on team click or touch.
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handlers
Return to top
## Score
us.match.ncaaf.score displays the current score, the teams represented by name and logo, the game status, and other key game-related information as collapsible 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
Description
props
object
properties
Name
Type
Argument
Default
Description
matchId
number
required
Match ID
showDate
boolean
optional
Shows the date of future games.
showOdds
boolean
optional
true
If false hides odds (pre-game only).
isCollapsed
boolean
optional
true
If false collapses collapsible content (i.e. game information).
disablePitch
boolean
optional
If true hides the field/pitch.
disableHeader
boolean
optional
If true hides the header.
disableGameInfo
boolean
optional
If true hides the expandable bottom section containing game details.
disableAttendance
function
optional
If true hides attendance content.
autoSlide
boolean
optional
true
Disables auto sliding of the content in the game info section.
autoSlideSpeed
number
optional
5000
Sets the delay of auto sliding of the content in the game info section (in milliseconds).
disableTeamClick
boolean
optional
If true disables onItemClick handler for teams.
disablePlayerClick
boolean
optional
If true disables onItemClick handler for players (i.e. team leaders under game information).
enableMatchClick
boolean
optional
If true the whole widget triggers match target event on onItemClick and disables all other targets.
preMatchLinks
string
optional
Comma separated string of link keys for pre-game. Can be undefined, default, preview, boxscore, gametracker, or recap. Entering default is the same as entering 'preview'.
liveMatchLinks
string
optional
Comma separated string of link keys for a live game. Can be undefined, default, preview, boxscore, gametracker, or recap. 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, or recap. Entering default is the same as entering 'boxscore, recap'.
border
boolean
optional
true
If false hides a border around the widget.
onItemClick
function
optional
Function/event handler. More info below.
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 links.
When enableMatchClick is set to true the whole Score widget becomes a match target and all other targets are disabled. 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.
Return to top
## Scoreboard
us.match.ncaaf.scoreboard provides the current score of a given game, a quarter-by-quarter linescore, and other top-level game 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
Description
matchId
number
required
Match ID
border
boolean
optional
If true draws a border around the widget.
onItemClick
function
optional
Function/event handler. Emits playerId, teamId, matchId on click or touch.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Score Nano
us.match.ncaaf.scorenano is a condensed version of the scoreboard widget. It provides the current score and status of a given NCAA football 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
If false hides a border around the widget.
onItemClick
function
optional
Function/event handler. Only target item is match. More info below.
onItemClick property emits various match props on click or touch, such as matchId, sportId, realCategoryId, seasonId, uniqueTournamentId, awayTeamUid, homeTeamUid, and matchStatus.
Valid matchStatus values are: pre, live, post.
Return to top
## Score Small
us.match.ncaaf.ScoreSmall is a smaller version of the scoreboard widget. It provides the current score and status of a given NCAA football 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
Description
matchId
number
required
Match ID
showDate
boolean
optional
If true shows the date of future games.
border
boolean
optional
If true draws a border around the widget.
onItemClick
function
optional
Function/event handler. Emits playerId, teamId, matchId on click or touch.
Examples
HTML/Declarative
JS/Programmatic
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
## Scoring
us.match.ncaaf.scoring displays a time scale graph for each team's scoring 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
Description
matchId
number
required
Match ID
border
boolean
optional
If true draws a border around the widget.
Examples
HTML/Declarative
JS/Programmatic
Return to top
## Season Players Carousel
us.season.ncaaf.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
string
required
Player ID or a comma separated list of player IDs.
seasonId
number
required
Season ID
year
number
optional
Year
seasonType
string
optional
'regular'
Season Type. Valid options are: regular, playoffs and total.
onItemClick
function
optional
Function/event handler. Emits uniqueTeamId on click or touch.
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 Scores
us.season.ncaaf.scores displays weekly schedules and results for all NCAA Football games.
>![NCAAFB Season Scores](../../../files/Widget_NCAAF_SeasonScores_Sample.png "NCAAFB Season Scores")
All the properties are optional. By default, the widget will render the active season and week.
To see a full-sized version of this widget, click here.
Important to note when using this widget
1. Select division and conference to determine what games are displayed in any given week. The week switcher control will allow you to navigate across every week of the current season. Selecting division narrows the available games and the week switcher to games pertaining to that division. The conference filtering applies only to regular season.
By default, when roundFilteringLast is set to false the week switcher control is applied after the division filter and navigates through all selected division weeks where games are being played, conference is applied last and filters the games list for a selected week. The conference selector is displayed and enabled only for regular season weeks. An empty list of games on a particular ncaaf week is possible. A "No matches available" message will be displayed in this instance.
If roundFilteringLast is set to true the conference filter is applied after the division narrows down the week navigation to only display the weeks in which a team from the specified conference is playing. So, if this prop is set to true and no B1G team plays in week 2 of a season, the week selector will skip from week 1 to week 3 when the end user is navigating through the various available weeks. Note that the week selector auto selects among the available ncaaf weeks on every conference change in this scenario. Postseason games are filtered by the bowls week - the conference must select all items.
2. For older seasons, the auto selected week is always the last week of the season (e.g Bowls)
3. Props selectedDate and selectedIdx you to select a particular week to display.
4. Among all the available leaguewide scores, a Score widget is used to render each individual game and features the option to include links for navigating to other widgets/content.
5. Clickable items are teams, players (i.e. team leaders) and links as noted in the Parameters section of the documentation.
Parameters
Name
Type
Argument
Default
Description
seasonId
number
optional
Season ID. Can be any NCAAF unique tournament ID.
division
string
optional
Selected division. See *HERE* for a list of valid divisions.
conference
string
optional
all conferences
Conference ID of the selected division. Applies only to regular season. See *HERE* for a list of valid conferences.
selectedIdx
number
optional
Selects particular NCAAF "week" by index. Index starts with 0.
selectedDate
number
optional
Selects particular NCAAF "week" that contains selectedDate.
roundFilteringLast
boolean
optional
false
If true the round switcher filtering is applied last.
showOdds
boolean
optional
'true'
If false hides odds for all games.
disableDateSwitcher
boolean
optional
If true disables the date switcher.
dropdownReverse
boolean
optional
If true reverses the switcher dropdown items.
disableDivisionDropdown
boolean
optional
If true hides the division dropdown.
disableConferenceDropdown
boolean
optional
If true hides the conference dropdown.
disableGameHeader
boolean
optional
If true the game headers are hidden.
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. Can be undefined, default, preview, boxscore, gametracker, recap, lineups. Entering default is the same as entering 'preview'.
liveMatchLinks
string
optional
Comma separated string of link keys for a live game. Can be undefined, default, preview, boxscore, gametracker, recap, lineups. 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. Entering default is the same as entering 'boxscore, recap'.
border
boolean
optional
If true draws a border around the widget.
onItemClick
function
optional
Function/event handler. More info below.
*onItemClick Info:*
By default, the widget has two click target areas: team and player. The player targets appear in the game information section depending on the game status.
With preMatchLinks, liveMatchLinks and/or postMatchLinks you may set the Score widget to display additional targets: preview, boxscore, gametracker, recap 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.
Return to top
## Standings
us.season.ncaaf.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
Description
seasonId
number
optional
Season ID
uniqueTournamentId
string
optional
Unique tournament ID
selectedLeague
string
optional
Name of the league. Options are: fbs, fcs, dII, dIII.
selectedConference
string
optional
Name of the conference. See *HERE* for a list of valid names.
columns
string
optional
Comma separated string of column keys. Used for picking fewer columns and different order. Valid options are w, l, t, pct, h, r, c, pf, pa, pd, d, sos, sov, s.
border
boolean
optional
If true enables a border around the widget.
onItemClick
function
optional
Function/event handler. Emits uniqueTeamId on click or touch.
disableHeader
boolean
optional
If true hides the header.
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Standings Carousel
us.season.ncaaf.standingscarousel provides a moving carousel of conference standings.
>
To see a full-sized version of this widget, click here.
If set to true the conferences will split into subconferences. Each subconference will have its own slide.
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.ncaaf.standingsSlim is a lightweight version of the standings table.
>
By default, the widget renders the active standings for the AAC.
To see a full-sized version of this widget, click here.
Name of the conference. See *HERE* for valid options.
uniqueTeamId
number
optional
Unique team ID.
disableHeader
boolean
optional
If true hides the widget header.
enableDropdown
boolean
optional
If true enables division dropdown selector. Unless uniqueTeamId is set.
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 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.ncaaf.teamLeaders displays leaders (passing, rushing, receiving, sacks, tackles, interceptions) for a provided team.
>
For the widget to render you must provide a valid uniqueTeamId 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
uniqueTeamId
number
required
Unique team ID
seasonId
number
optional
Season ID. Has priority over year and seasonType.
year
number
optional
Selected year as friendly alternative to seasonId. Used in conjunction with seasonType.
seasonType
string
optional
'total'
Season type. Valid options are: mainplayoffs, or total. Used in conjunction with year.
qualifiesAsLeagueLeader
boolean
optional
true
If true enables statistical minimums to qualify a player for inclusion in a statistical category.
disableHeader
boolean
optional
If true hides the widget header.
disableTeamTag
boolean
optional
If true hides the header team tag.
disableHeaderDetails
boolean
optional
If true hides the header season 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
## Team Ranks
us.season.ncaaf.teamRanks provides a given team's seasonal rankings for several statistics.
>
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
year
number
optional
current season year
Year
seasonType
string
optional
'regular'
Season type: regular, playoffs, total.
rankType
string
optional
'division'
division or conference. If set to conference, displays team conference ranks.
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
Return to top
## Team Recent Games
us.team.ncaaf.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
division
string
optional
'fbs'
The division to display: 'fbs', 'fcs', 'dII', 'dIII'
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.
disableTeamDropdown
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, tournamentId, uniqueTournamentId 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":27121956,"seasonId":81054,"tournamentId":85,"uniqueTournamentId":27653,"realCategoryId":43,"sportId":16,"awayTeamUid":4311,"homeTeamUid":4316,"matchStatus":"pre"}Return to top
## Team Roster
us.season.ncaaf.teamRoster visualizes a complete team roster.
>
For the widget to render you must provide a valid uniqueTeamId.
To see a full-sized version of this widget, click here.
Parameters
Name
Type
Description
props
object
properties
Name
Type
Argument
Description
uniqueTeamId
number
required
Unique team ID
seasonId
number
optional
Season ID. Has a priority over year.
year
number
optional
Selected year as a friendly alternative to seasonId.
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.ncaaf.schedule displays the entire season schedule for a given 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
seasonId
number
optional
Season ID
sortDirection
string
optional
asc
Changes groups and games sort direction. Valid options are: asc and desc.
division
string
optional
fbs
Division prop to filter teams in dropdown. Valid options are fbs, fcs, dii, diii.
disableHeader
boolean
optional
If true disables the entire header section and displays all groups and games.
disableTeamDropdown
boolean
optional
If true omits team dropdown. Team can still be set by "teamUid" props.
disableGroupDropdown
boolean
optional
true
If true omits group dropdown and displays all groups and games.
border
boolean
optional
If true enables a border around the widget.
onItemClick
function
optional
Function/event handler. Emits matchId, seasonId, tournamentId, uniqueTournamentId and other props on table row on 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":27121956,"seasonId":81054,"tournamentId":85,"uniqueTournamentId":27653,"realCategoryId":43,"sportId":16,"awayTeamUid":4311,"homeTeamUid":4316,"matchStatus":"pre"}Return to top
## Team Score Small
us.team.ncaaf.scoreSmall displays the score of 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
teamUid
number
optional
Unique Team ID. The id must be one of the two teams that played in the provided game.
border
boolean
optional
If true enables a border around the widget.
onItemClick
function
optional
Function/event handler. Emits matchId, matchStatus, uniqueTeamId, seasonId, tournamentId, uniqueTournamentId on click or touch.
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Team Seasonal Statistics
us.season.ncaaf.teamsStats displays a sortable team statistics table for all teams in a given season. Data can be filtered by season type (regular season, bowl games) and by stats categories (offense, defense).
>
All widget properties are optional. By default, the widget will provide 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
year
number
optional
Season year.
seasonType
string
optional
Season type: total, regular, or playoffs.
mode
string
optional
'offense'
Mode: offense or defense.
conference
string
optional
'fbs'
Conference: fbs.
pageLength
number
optional
50
Number of teams to display per page.
border
boolean
optional
When set to true the table is displayed with a border.
disableTitle
boolean
optional
When set to true hides the widget title.
hideFilters
boolean
optional
When set to true hides all filters / dropdown.
offenseColumns
string
optional
Comma separated string of offensive table statistics column keys. Used for picking fewer columns and different order. Valid options are: pts, ptsg, tyrd, tyrdg, pyrd, pyrdg, ryrd, ryrdg.
defenseColumns
string
optional
Comma separated string of defensive table statistics column keys. Used for picking fewer columns and different order. Valid options are: ptsa, ptsag, tyrd, tyrdg, ttacks, sacks, sacky, ff, dint, intyds.
onItemClick
function
optional
Function/event handler. Emits uniqueTeamId, seasonId, uniqueTournamentId on table row click or touch.
props.offenseColumns Option Descriptions
Option
Description
pts
Points
ptsg
Points Per Game
tyrd
Total Yards
tyrdg
Total Yards Per Game
pyrd
Passing Yards
pyrdg
Passing Yards Per Game
ryrd
Rushing Yards
ryrdg
Rushing Yards Per Game
props.defenseColumns Option Descriptions
Option
Description
ptsa
Points Against
ptsag
Opponent Points Per Game
tyrd
Total Yards Allowed
tyrdg
Total Yards Allowed Per Game
ttacks
Total Tackles
sacks
Sacks
sacky
Defensive Sack Yards
ff
Fumbles Forced
dint
Defensive Interceptions
ff
Defensive Interception Yards
Examples
HTML/Declarative
JS/Programmatic
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.
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 Graphic
us.season.ncaaf.teamStatsGraphic provides top-level team seasonal statistics for offense and defense, 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
year
number
required
Year. Can replace the season ID.
teamUid
number
optional
Unique team ID
seasonType
string
optional
'regular'
Selected season type. Valid options: regular or playoffs.
division
string
optional
'fbs'
Selected division. Can be fbs, fcs, dii, diii.
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 team dropdown change.
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Top Performers
us.season.ncaaf.topPerformers provides top performers (passing, rushing and receiving) for each week of the regular 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
Description
props
object
properties
Name
Type
Argument
Default
Description
seasonId
number
required
Season ID (regular season only)
year
number
optional
Year of the season.
week
number
optional
Week number prop. When not applied, the final week will be displayed.
tableTypes
string
optional
Comma separated string of types of performer tables. When no tableTypes are written, all tables will be displayed. Valid options are: passing, rushing, receiving.
passingPlayers
number
optional
3
Maximum number of players to show in the passing table.
receivingPlayers
number
optional
3
Maximum number of players to show in the receiving table.
rushingPlayers
number
optional
3
Maximum number of players to show in the rushing table.
hideTitle
boolean
optional
When set to true hides the title of the widget.
hideDropdowns
boolean
optional
When set to true hides the the week and season dropdowns.
border
boolean
optional
If true enables a border around the table.
onItemClick
function
optional
Function/event handler. Emits uniqueTeamId on table row click or touch.
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Top Players
us.season.ncaaf.topPlayers displays a top 5 leaderboard for a given season, with a dropdown to select by statistic.
>
All properties are optional. By default, the widget will display the active season.
To have specific stats for players, statType must be set.
To see a full-sized version of this widget, click here.
Parameters
Description
properties
Name
Type
Argument
Default
Description
seasonId
number
required
Season ID. Has priority over year and seasonType.
year
number
optional
Selected year as friendly alternative to seasonId. Used in conjunction with seasonType.
seasonType
string
optional
'total'
Season type. Valid options are: regular, playoffs, or total. Used in conjunction with year.
statType
string
optional
'passing_yards'
Selected Stat. See below for valid options.
playersLimit
number
optional
5
Maximum number of players to display.
conference
string
optional
all conferences
The conference to display. Options are: aac, acc, big12, b1g, cusa, indepfbs, mac, mw, pac12, sec, sunbelt.
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.
border
boolean
optional
If true enables a border around the widget.
onItemClick
function
optional
Function/event handler. Emits playerId on click or touch.
Valid options for statType:
Option
Description
passing_yards
Passing Yards
passing_touchdowns
Passing Touchdowns
passing_completion_percentage
Completion Percentage
passing_interception
Interceptions Thrown
rushing_attempts
Rushing Attempts
rushing_yards
Rushing Yards
rushing_touchdowns
Rushing Touchdowns
yards_per_carry
Yards Per Carry
points_per_game
Points Per Game
receiving_receptions
Receptions
receiving_yards
Receiving Yards
receiving_touchdowns
Receiving Touchdowns
sacks
Sacks
interceptions
Interceptions
interception_yards
Interception Yards
forced_fumbles
Forced Fumbles
tackles
Tackles
Examples
HTML/Declarative
JS/Programmatic
JS/Example of using Event Handler
Return to top
## Top Players Carousel
us.season.ncaaf.topPlayersCarousel displays a moving top 5 leaderboard for a variety of player statistics.
>
To have specific stats for players, statString must be set.
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
year
number
optional
Season year
statString
string
optional
String with stat Keys. See below for valid options.
seasonType
string
optional
'regular'
Season type. Valid options are: regular, total or playoffs.
Return to top
## Top Teams
us.season.ncaaf.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
year
number
optional
current season year
Season year.
seasonType
string
optional
'regular'
Season type. Valid options are: regular, playoffs, or total.
conference
string
optional
all conferences
Selected conference. Can be aac, acc, big12, b1g, cusa, independent, mac, mwc, sec, sbelt, pac12.
statType
string
optional
'points'
Selected Stat. See below for valid options.
disableHeader
boolean
optional
If true hides the header.
disableStatsDropdown
boolean
optional
If true hides the statistic type dropdown.
disableConferenceDropdown
boolean
optional
If true hides the conference 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.
Valid options for statType:
Option
Description
points
Points
total_yards_yards
Total Yards
passing_yards
Passing Yards
passing_attempts
Passing Attempts
passing_interception
Interceptions Thrown
rushing_yards
Rushing Yards
rushing_attempts
Rushing Attempts
rushing_touchdowns
Rushing Touchdowns
receiving_receptions
Receptions
receiving_yards
Receiving Yards
receiving_touchdowns
Receiving Touchdowns
turnovers
Turnovers
punts_total
Punts
penalties_total
Penalties
penalties_yards
Penalty Yards
defense_tackles
Tackles
defense_tackles_for_loss
Tackles for Loss
defense_sacks
Sacks
defense_interception
Interceptions
possession_time
Time of Possession
opponents_points
Opponent Points
opponents_passing_yards
Opponent Passing Yards
opponents_passing_touchdowns
Opponent Receiving Touchdowns
opponents_rushing_yards
Opponent Rushing Yards
opponents_rushing_touchdowns
Opponent Rushing Touchdowns
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
## Win Probability
us.match.ncaa.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.