Functionality Guide

On this page

In the guide below all widgets are described in detail, including all existing functionality and parameters to tweak each widget to your preference. In addition to the widget specific parameters there are also a couple of generic parameters that work for every widget. The following parameters are part of that category:

  • auto_dark_mode: regulates the functionality that the mode of the environment (browser or app) is detected and based on that the widget switches automatically to our most suited widget style. In light mode the widgets use our default style and in dark mode our dark style is used. By default this functionality is enabled (yes). If set to no this automatic switch is disabled. There are two use cases where you would disable this functionality:
    • Your website or app doesn’t support dark mode.
    • You use custom styling. In that case we switched off the auto dark mode functionality, since we don’t want to overwrite your custom styling with our default and dark mode. If you use a custom stylesheet and still want to use this functionality, check our Custom CSS guide.
  • show_heading: defines if there will be a header shown above the widget with the widget’s name. By default (no) the header is hidden, since in most environments widgets will be integrated in a native navigation. With yes the widget gets its own header.

Bracket

In Bracket the knockout phases of a league season can be followed. The widget consists of all matches of the knockout phases presented in a well known tree diagram. For scheduled matches the scheduled date and start time in the user’s time zone is shown, for live matches live score updates will be provided and for finished matches the final score is visible. Currently Bracket only works with single-elimination tournaments (clean brackets).

Features

  • At the top of the widget the phase navigation bar is shown. With arrows navigating to the next or previous phase of the bracket can be done. Besides the arrows other phases can also be reached by swiping (mobile) or dragging (desktop) to the left and right.
  • The match blocks consist by default of a home and an away participant and their logo or flag and dependent of the status of the match the following information:
    • Scheduled: date and start time. Not applicable to match series.
    • Live: live score and minute of the match.
    • Finished: final score.
    • Note: the format of the final score depends on the type of competition. For single matches it is the match score of that single match.

Data Parameters

Adjusting Bracket to your preferences can be done with the following parameters:

  • league_id: configures the league that the widget is displayed for.
  • participant_alias_type: defines the names of the participants. The following values are possible:
    • abbreviation: shortest alias type, 2, 3 or 4 characters.
    • default: name that is commonly used to refer to a participant (by default used in the widget as well). For a person this is the first + last name.
    • full: the complete, official name of a participant.
    • short: max. 10 characters version of the default alias Can be the same as the default if that default hasn’t got more than 10 characters. For a person this is always the first letter of the first name and the full last name.
    • first: first name of a participant. Only applicable to persons.
    • last: last name of a participant. Only applicable to persons.
  • show_date_dow: defines if the date is shown for a scheduled match. The possible values are “yes” and “no”.
  • show_result_status: defines if the status of the match (e.g. ‘Final’ for a finished match) is explicitly mentioned. The possible values are “yes” and “no”.
  • bracket_matchdetail_link: clicking on a specific match in the Bracket will bring you by default to the Match Detail widget. This can be disabled with the input “widget:false”.
  • format_time: format of the start time of a match. All Luxon formats can be used.
  • format_date_dow_short: format of the match dates. All Luxon formats can be used.
  • show_timezone_abbr: by default set to “no”, but if set to “yes” the time zone abbreviation of the user’s local time will be displayed behind the start time of the match. The Luxon formats of the time zones are used.
  • custom_date_abbr: only works if the show_timezone_abbr parameter is set to “yes”. The output of the time zone can be adjusted to whatever name is desired, e.g. “CET:time” to display ‘time’ instead of ‘CET’.

Calendar

A flexible widget that can display any type of calendar that is desired. Whether you are looking for an overview of one series season, a season of an entire sport, a multi-sport calendar of a specific year or an ongoing multi-sport calendar, everything is possible with the Calendar widget. Leagues can be both series (e.g. Golf PGA Tour) and standalone leagues (e.g. Athletics World Championships). Also matches leagues (e.g. FIFA World Cup) can be included. We advise to restrict this to shorter matches tournaments and not to add matches leagues that take the entire season (e.g. NBA or Premier League). The widget displays the start and end dates of leagues together with clickthrough options to detailed schedules, results, standings and bracket views.

Features

  • The base of the widget consists of league blocks that contain the league start and end dates, name, logo or flag of the nationality of the league and click throughs to detailed schedules, results, standings and bracket views.
  • Leagues are grouped based on the months they are scheduled in. The start date is used for this grouping. The months are shown in a chronological order from top to bottom. Only the current and upcoming months are unfolded. The past months are collapsed. This allows the user to quickly access the next scheduled leagues instead of scrolling down too much.
  • Optionally a couple of other features can be added to the view. This might depend on your use case or preference.
    • Navigation: by default the view only consists of the months in which leagues are scheduled in the current season. A navigation row can be added on top that displays each month as an unique item. The months navigation bar always opens on the current month to enable the user to immediately access the most important information. If the user wants to go back in time any previous month needs to be selected. If the navigation bar is shown always a maximum of 12 months is immediately visible in the body.
    • Sport icon and name: for each league the name of the sport accompanied by a sport icon can be added. This is for example desired if there are multiple sports included in the calendar and you want to make clear to the user to which sport a league belongs.
    • Series name: also for each league that is linked to a specific series (e.g. Wimbledon is part of the ATP Race and WTA Race) the name of the series can be added between brackets behind the league name. This is mostly applicable to calendars where multiple series of the same sport are included. If a league is linked to multiple series and those series are all included in the widget, all series name will be shown. In case of a Tennis calendar including the ATP and the WTA Race, Wimbledon will be shown as Wimbledon (ATP Race/WTA Race).
    • Sport league filter: adds a sport and league dropdown in between the navigation bar and the league blocks, where the user can select a sport and/or league after which the league underneath it will be filtered on the selected sport or league. Only the sport and leagues visible in the content in the dropdowns. The sport is pre-filled if there is only one sport available.
  • These are the most important use cases for the Calendar widget:
    • Single-series calendar: this is the most common use case where calendars are often needed for. It displays all leagues that are part of one specific series.
      • Examples: Alpine Skiing World Cup 2024/2025, Golf PGA Tour 2024 and Tennis ATP Race 2024
    • Sport calendar:
      • Examples: Cycling Road 2024, Speed Skating 2024/2025 and Tennis 2024
    • Multi-sport calendar of a specific year:
      • Examples: existing of multiple series and standalone leagues (e.g. Cycling World Championships and FIFA World Cup)
    • Ongoing multi-sport calendar:
      • Examples: existing of multiple series and standalone leagues (e.g. Cycling World Championships and FIFA World Cup)
  • The following parameter settings are recommended for the different use cases. Check the Data Parameters section below to see what each parameter does.
    • Single-series calendar
      • show_season: current
      • show_navigation: no
      • show_sport: no
      • show_series: no
    • Sport calendar
      • show_season: current
      • show_navigation: no
      • show_sport: no
      • show_series: yes
    • Multi-sport calendar of a specific year
      • show_season: current_year
      • show_navigation: yes
      • show_sport: yes
      • show_series: yes
    • Ongoing multi-sport calendar
      • show_season: extended
      • show_navigation: yes
      • show_sport: yes
      • show_series: yes

Data Parameters

Adjusting Calendar to your preferences can be done with the following parameters:

  • league_id: configures the league that the widget is displayed for. For a single-series view only one league_id should be given, for a multi-league view multiple IDs are needed, each divided with a comma. The order of the IDs also decided the order of the series names if the show_series parameter is enabled.
  • show_season: decides what is precisely shown in the calendar. These are the possible values:
    • current: default option. This displays the current season of the leagues included. This can be a summer season (e.g. 2024) or a winter season (e.g. 2024/2025) or a combination.
    • current_year: shows all leagues that are scheduled in the current calendar year.
    • extended: shows all leagues that are scheduled in the previous, current and next calendar year. This option thus always displays three full calendar years. This is mostly applicable to ongoing sport calendars.
  • show_navigation: decides how the calendar is shown. These are the possible values:
    • default: default option. This is what Gracenote configured as most suitable for every possible value of the show_season parameter. For current and current_year the month navigation bar is hidden, for extended the navigation bar is shown.
    • yes: the navigation bar is shown.
    • no: the navigation bar is hidden.
  • show_sport: puts the sport icon and name in front of the league name. Possible values are no (default option) and yes.
  • show_series: shows the series name between brackets behind the league name. Possible values are no (default option) and yes.
  • sport_league_filter: adds a sport and league dropdown in between the navigation bar and the league blocks. These are the possible values:
    • default: default option. If there is only one sport included, the filter will be hidden, but if there are multiple sports shown in the calendar the filter will be shown.
    • yes: the sport league filter is shown.
    • no: the sport league filter is hidden.
  • accordion_behavior: controls the behavior of the month buckets. These are the possible values:
    • default: default option. Without the navigation by default only the current and next months are expanded, previous months are collapsed. When the navigation is shown all months are always expanded.
    • expand: all months are always expanded.
    • collapse: all months are always collapsed.
  • format_month_year: format of the months in the month headers. All Luxon formats can be used.
  • calendar_schedule_link: by default (widget:default) a Schedule link will be available that brings the user to the Schedule widget for the selected league. This link can be hidden with the input widget:false.
  • calendar_results_link: by default (widget:default) a Results link will be available that brings the user to the Phase Detail widget for the selected league. This will be the case if the league consist of one event (e.g. Cycling Road Tour de France). This link can be hidden with the input widget:false.
  • calendar_results_overview_link: by default (widget:default) a Results link will be available that brings the user to the Results Overview widget for the selected league. This will be the case if the league consist of multiple events (e.g. Athletics World Championships). This link can be hidden with the input widget:false.
  • calendar_bracket_link: by default (widget:default) a Knockout or Draw(s) link will be available that brings the user to the Bracket widget for the selected league. This will be the case for sports with draws (e.g. Tennis and Snooker, but also the knockout phase of a matches tournament like the FIFA World Cup). This link can be hidden with the input widget:false.
  • calendar_standings_link: by default (widget:default) a Standings link will be available that brings the user to the Standings widget for the selected league. This will be the case for matches sports with a group phase (e.g. FIFA World Cup). This link can be hidden with the input widget:false.

League Stats

In League Stats both player and team statistics of a league season are presented. Here users can check if a team should be higher up the ranking based on the stats and how their favorite player is doing compared to other players in the league. The widget has an overview page with a top 5 preview of all stats, where users can click through to see full rankings in a large, sortable table. The stats are grouped per category, which makes scanning the content easier.

Features

  • On the overview page there are two rows of tabs that work as a filter in the widget to make navigating easier. The first row consists of player, where only the player stats are shown, and team, where the team stats are displayed. Below that for both player and team stats the available stats are divided into subcategories that will help users to find the stat they are interested in.
  • The second method to navigate through the widget is the dropdown menu. In that menu all available stats, independent of the category and subcategory, are listed. This is the easiest way to check the complete ranking if you are interested in one specific stat. Simply clicking on the name of the stat brings you to the full ranking.
  • Underneath the navigation tabs and the dropdown menu all available stats are displayed with a preview of the ranking. The best 5 performing players and teams per stats are displayed. If the user is only interested in the best performing players and team per stat they only have to scroll through the overview page. If they are interested in the full rankings of a stat they can click through on the stat header.
  • On the full ranking page the complete list of players and team for a specific stat are shown. Players and teams that don’t have ‘real numbers’ for a stat (0 goals, 0 shots, etc.) are not included in the list. If you want to go back to the League Stats overview page the back button inside the widget can be used for that.

Data Parameters

Adjusting League Stats to your preferences can be done with the following parameters:

  • league_id: configures the leagues that the widget is displayed for.
  • show_person_team_stats: defines the appearance and the order of the player and team tab. There are four options:
    • Person, Team. Show both tabs with a default landing on Person (player).
    • Team, Person. Show both tabs with a default landing on Team.
    • Person. Only show Person without the Team tab.
    • Team. Only show Team without the Person tab (player).
  • hide_player_headshots_league_ids: if you are entitled to use headshots these will be displayed by default. The headshots can be hidden by adding the league ID to this parameter.

Match Detail

Match Detail includes match information on match based leagues (Team A vs. Team B or Person A vs. Person B). It allows users to view in depth information about matches including interesting match preview information, line-ups, play-by-play, team stats, player stats and standings. All data is updated live when a play happens. The available information and the data depth is dependent on the entry level of the league.

Features

  • The first information visible when opening the Match Detail widget of a match is the info block. This block groups the most important information of the match together at the top of the widget. Depending on the state of the match different information is available in this part of the widget. When a match is scheduled only the teams and some general match information, like phase, venue, location and attendance. During the match extra information will become available, depending on the sport and league, like the score, goalscorers and a visual representation of the match.
  • Underneath the info block all other information is available in tabs. One tab can be viewed at the same time. The following tabs can be available:
    • Line-ups: information about starters and substitutes for both teams. There will always be a line-up list with all players of the match squad, where the most important match actions will be shown behind the players names once the match has started. Depending on the sport also visual formations can be available above the line-up list. This is for example the case for some Football competitions like the FIFA World Cup.
    • Summary: for American Football and Ice Hockey the Summary tab displays an overview of all scoring actions of the match, as well as all penalties and shots on goal per period for Ice Hockey matches.
    • Play-By-Play: timeline with match actions. From 700px onwards actions will be shown on both sides of a timeline that is available in the middle of the page. Headshots will be shown for scoring actions if you are entitled for the headshots.
    • Team Stats: list of the most important team stats, depending on the league. Besides a list of stats and bare numbers also a visual representation to clearly mark which team does better in a certain stat.
    • Player Stats: list of players and their bare numbers for the most important player stats. Only players that actually played during the match are included in the list.
    • Standings: table ranking of the group where this match features in. If the match doesn’t belong to one specific group, for example with the major North American leagues, all associated group standings are shown.
    • History: only available in the scheduled state of a match. This tab shows the maximum 10 last confrontations between the two teams or persons of a match, as well as the last 10 matches played by the two teams that indicate their form.
    • Season Stats: only available in the scheduled state of a match. Shows the most important league team stats of the two teams for the current season, displayed in a Head-To-Head fashion.
  • The view of the Match Detail widget is completely adjustable with parameters. If you are only interested in the match info block, the tabs underneath can be hidden. If you are only interested in one of the tabs, the match info block, other tabs and tab navigation bar can be hidden. The match info block and tabs are displayed/hidden based on parameters. For the tab navigation bar there is no separate parameter available, but it will behave based on the input for the match info block and tabs.

Data Parameters

Adjusting Match Detail to your preferences can be done with the following parameters:

  • match_id: configures the match that the widget is displayed for.
  • hide_info_block: by default the match info block (the top block) is always displayed, but it can be hidden by setting this parameter to “yes”.
  • hide_tabs: by default all tabs defined for a certain sport/league are displayed, but if some information isn’t of any interest to you, one, multiple of all tabs can be hidden. The following input values can be given to this parameter:
    • no. Default value where all tabs are displayed.
    • yes. All tabs will be hidden.
    • Hiding one or multiple tabs by entering the name of those tabs. If multiple tabs are inputted, these need to be divided with a comma. All input values are lower case based and spaces in tab names are replaced with a – in this parameter. Some examples are:
      • “line-ups” will hide the line-ups tab
      • “line-ups,player-stats” will hide the line-ups and player stats tabs.
      • Find the complete list of tab names in the Features section.
  • format_time: format of the start time of a match. All Luxon formats can be used.
  • format_date_year: format of the match year. All Luxon formats can be used.
  • show_timezone_abbr: by default set to “no”, but if set to “yes” the time zone abbreviation of the user’s local time will be displayed behind the start time of the match. The Luxon formats of the time zones are used.
  • custom_date_abbr: only works if the show_timezone_abbr parameter is set to “yes”. The output of the time zone can be adjusted to whatever name is desired, e.g. “CET:time” to display ‘time’ instead of ‘CET’.
  • show_league_header: by default the league name is not displayed for a match, but by switching this parameter to “yes” the widget header will show the league name.
  • away_first: by default the home team is shown first. If this parameter is set to “yes” the away team is shown first for all leagues where you use Mach Detail.
  • away_first_league_id: if you use Match Detail for multiple leagues and you want to differentiate between leagues if the home or away team is shown first, this parameter needs to be used. Include the IDs of all leagues for which the away team should be shown first.
  • hide_player_headshots_league_ids: if you are entitled to use headshots these will be displayed by default. The headshots can be hidden by adding the league ID to this parameter.
  • show_result_status: defines if the status of the match (e.g. ‘Final’ for a finished match) is explicitly mentioned. The possible values are “yes” and “no”.
  • show_standings_records: adds standings related records underneath the team names, which is mainly common in the North American market. These consist of the number of wins, losses and possibly draws in the league. Currently these records are only available for the big North American leagues. By default these records are hidden (input “no”), but with the value “records” they can be added.
  • standings_team_link: clicking on a specific team in the Standings tab will bring you by default to the Team Profile widget (“widget:default”). It is possible to disable the clickthrough totally by changing the input to “widget:false”.

Use Cases

  • Smart TV use case – Our Match Detail Widget fits the use case of allowing MVPDs to load our widget connect service URL in their TV programming and use it to link to our Match Detail Widget via the service URL. If Golden State Warriors vs Boston Celtics is live, our widget connect can be a more info button on that TV programming which will link to the Match Detail Widget of that game. Giving users the most relevant information about that game.

Phase Detail

Phase Detail is the Match Detail equivalent for phases. The widget brings you the detailed, full results of all non-matches sports. The list of sports for which this widget is suited include Athletics, Auto Racing, Cycling, Golf, various Winter Sports and many more. Also for this widget the available information, the speed at which results are available and the data depth is dependent on the entry level of the league.

Features

  • The first information visible when opening the Phase Detail widget is the info block. This block groups the most important information of the phase together at the top of the widget. For phases the following information is available in the info block:
    • League logo or flag: the appearance depends on which graphics we keep track of. If we have a league logo, we display that. If we don’t have a league logo, but a series logo (like for Formula 1) we display that. If we don’t have both a league logo and a series logo, we display the flag of the league nationality (not to be confused with the venue nationality)
    • Name of the league
    • Name of the event: only available if there are multiple events in the league, like for the Athletics World Championships
    • Phase dropdown: only available if there are multiple phases in the event, like for every Golf tournament or for a Cycling stage race
    • General phase info: start date/time and venue (usually a country or a city)
    • Status: in the right top corner the status of the phase is displayed
  • Underneath the info block all other information is available in tabs. One tab can be viewed at the same time. The following tabs can be available:
    • Start List: only available if we enter start lists before the start of the phase
    • Results: main results table. If there are sub phases (like Heat 1, 2, 3) each sub phase has it’s own results table.
    • Summary: only available if a phase has sub phases. One table is created from the results of all the different sub phases, for example the overall Heats results for Athletics
    • Standings: only available if an accumulation of phase results takes place, for example with the Athletics Decathlon/Heptathlon and the Cycling stage races
    • Leaderboard: specific results table for Golf that combines both Results and Standings in a common view for the sport
  • The view of the Phase Detail widget is completely adjustable with parameters. If you are only interested in the phase info block, the tabs underneath can be hidden. If you are only interested in one of the tabs, the phase info block, other tabs and tab navigation bar can be hidden. The phase info block and tabs are displayed/hidden based on parameters. For the tab navigation bar there is no separate parameter available, but it will behave based on the input for the phase info block and tabs.

Data Parameters

Adjusting Phase Detail to your preferences can be done with the following parameters:

  • overall_id: configures the overall (=event) that the widget is shown for. If the overall consists of multiple phases, the widget will by default open on the most relevant phase. That is always the phase that is scheduled the closest to the current time.
  • phase_id: configures the phase that the widget is shown for. This parameter can be used to display the widget for one specific phase, for example to add to a page with a written article about that page.
  • hide_info_block: by default the match info block (the top block) is always displayed, but it can be hidden by setting this parameter to “yes”.
  • hide_tabs: by default all tabs defined for a certain sport/league are displayed, but if some information isn’t of any interest to you, one, multiple of all tabs can be hidden. The following input values can be given to this parameter:
    • no. Default value where all tabs are displayed.
    • yes. All tabs will be hidden.
    • Hiding one or multiple tabs by entering the name of those tabs. If multiple tabs are inputted, these need to be divided with a comma. All input values are lower case based and spaces in tab names are replaced with a – in this parameter. Some examples are:
      • “startlist” will hide the Start List tab
      • “startlist,standings” will hide the Start List and Standings tab
      • Find the complete list of tab names in the Features section.
  • format_date_year: format of the match year. All Luxon formats can be used.
  • format_time: format of the start time of a match. All Luxon formats can be used.
  • show_timezone_abbr: by default set to “no”, but if set to “yes” the time zone abbreviation of the user’s local time will be displayed behind the start time of the match. The Luxon formats of the time zones are used.
  • custom_date_abbr: only works if the show_timezone_abbr parameter is set to “yes”. The output of the time zone can be adjusted to whatever name is desired, e.g. “CET:time” to display ‘time’ instead of ‘CET’.

Results Overview

Results Overview is a widget that lists all events that are held in a league and additionally displays the medal winners in these events. This gives the user a great overview of which countries and athletes finished in the different top 3s and therefore performed well. The widget also serves as a bridge from the Calendar widget to the Phase Detail widget, where detailed results can be obtained.

Features

  • The widget only consists of event blocks. These blocks consist of the following elements:
    • Event name including the gender
    • Rank
    • Medal icon
    • Athlete/team name
    • Athlete/team nationality
    • End time of the events in case the event is scheduled or in progress and the medal winners are not known yet

Data Parameters

Adjusting Results Overview to your preferences can be done with the following parameters:

  • format_date_year: format of the date that is displayed when an event isn’t finished yet. All Luxon formats can be used.
  • format_time: format of the time that is displayed when an event isn’t finished yet. All Luxon formats can be used.
  • show_timezone_abbr: by default set to no, but if set to yes the time zone abbreviation of the user’s local time will be displayed behind the end time of the event. The Luxon formats of the time zones are used.
  • resultsoverview_results_link: by default (widget:default) the event name is clickable and brings the user to the Phase Detail widget to check the detailed results. This clickthrough option can be hidden with the input widget:false.

Schedule

Schedule brings the full schedule of a league season in both a single and multi-league view. This enables the user to see all matches of their favorite league, together with the scheduled date and start time in the user’s time zone for scheduled matches, live scores for live matches and the final scores for finished matches. By default Schedule in the single-league view opens on the most relevant date or phase from a schedule perspective. In the multi-league view Schedule always opens on today’s date. This widget only works for match based competitions.

Features

  • Single-league view navigation:
    • The schedule is always opened at the most relevant date or phase from a schedule perspective, based on the match dates and times and the date and time the widget is requested. Example: if the previous match was played on Sunday and the next match will be played on Friday, the widget opens on Tuesday at last Sunday’s match, while on Thursday it will open on next Friday’s match.
    • There is a general logic in place that the widget never breaks match days. This always ensures the widget to display the matches together that are locally played on the same day. If the widget is requested in another timezone than the matches are played, this then can cause that not all matches on the user’s day are displayed together.
    • Navigating through a schedule for a complete league season can be done in a few ways:
      • With the ‘Previous matches’ button at the top of the widget the user goes back in time. Each previous matches click will load one extra match day in the past.
      • With the ‘Next matches’ button at the bottom of the widget the user goes forward in time. Each next matches button click uses the same threshold logic as the number of matches that is displayed by default. More information on this is available in the parameters section.
      • With the calendar function, available in both the ‘Previous matches’ and ‘Next matches’ bar, the user can select a specific date in the entire league season. Only the match days are selectable. This option is preferred if the user directly wants to go to a date further in the past or future, without needing to click the previous and next buttons all the time.
    • There is an alternative way of displaying all matches of the league season. Instead of having all matches in one list, it is also possible to switch on the phase/matchround navigation. With this option the matches are sorted and displayed per phase/matchround. The widget is defaulted to the current phase/match round. This option only works for leagues that actually have phases/match rounds, like the NFL weeks or the Premier League match days.
    • For every match date there is a header with the specific date displayed above the matches as a marker for the matches below.
  • Multi-league view navigation:
    • The schedule always opens on today’s date, even if there are no matches scheduled for the selected leagues.
    • With arrow buttons it is possible to quickly navigate to the previous or next day.
    • With the calendar function, similarly looking to the calendar in the single-league view, a specific date can be selected.
    • There is a leagues and a time view, where only the presentation of the matches differs. In the leagues view all matches are available underneath a league header and are displayed chronologically based on the start time, except for matches with an edge case status (postponed, abandoned, canceled). In the time view three buckets are available: live, upcoming and finished in that particular order. In the upcoming bucket matches are sorted chronologically based on the start time to have a clear overview of next matches, while in the live and finished bucket matches are sorted a-chronologically. This way always the latest started match is shown first.
    • It is possible to filter the sports and leagues available on a specific day using dropdowns. This is especially useful if a lot of sports and leagues are included in the widget, giving users the opportunity to quickly access the matches they are looking for.
  • The match blocks consist by default of a home and an away participant and their logo or flag, depending on the league ranking specific information and depending of the status of the match the following information:
    • Scheduled: date and start time.
    • Live: live score, minute of the match and depending on the league specific live features such as MLB bases and NFL ball possession.
    • Finished: final score and possible overtime/extra time indicator.
  • If applicable also phase info and other relevant information for the match will be shown above the participants.
    • League name for all matches in the time view of the multi-league Schedule.
      Phase name for all matches in a group or knockout stage.
    • If no phase info output is desired, e.g. for all regular season matches of the NBA, the phase info bar isn’t visible.
    • Standings related information (only available for NBA, WNBA, NCAAB, MLB, NFL, NCAAF, CFL and NHL)

Data Parameters

Adjusting Schedule to your preferences can be done with the following parameters:

  • league_id: configures the league that the widget is displayed for. For a single-league view only one league_id should be given, for a multi-league view multiple IDs are needed, each divided with a comma. The order of the IDs is also the order of the leagues in the Leagues view and is therefore important.
  • number_of_matches_min: decides how many matches will be shown when the widget is opened in the single-league view. This is a threshold value. Based on the input value of this parameter, no match days are split. Example: if the input value is 10 and on the current match day there are 8 matches and on the next match day there are 3 matches, the sum is 11 and therefore these two match days are displayed. Besides regular numbers, the following special values can be entered:
    • 0: only the matches of the current match day are displayed, without the previous and next navigation buttons. This value can be used if your use case is to only display today’s matches, without a context of the full schedule.
    • “ALL”: all matches of a league are retrieved, without a default to the current match day. Our advice is to only use this for tournaments where the amount of matches is limited.
    • Another option to display the full schedule of a short-term tournament, is to enter at least the number representing the total number of matches. This enables you to output the full schedule before the tournament starts, but, in contrast to the “ALL” option, during the tournament the widget opens at the current match day. Therefore all finished matches are available under the ‘Previous matches’ button.
  • number_of_matches_max: decides what the maximum number of matches is that will be shown in the single-league view. The default value is 80. Also here, based on the input value in this parameter, no match days are split. This parameter can be important because:
    • It enables you to decide the maximum length of the widget yourself.
    • It makes sure the widget won’t be too long. We cannot guarantee that the widget will keep performing smoothly if the match limit is really high.
    • If the user clicks on the previous or next matches button and after that the input value of the parameter will be exceeded, one or multiple other match day(s) at the other end of the schedule will be removed. If the user clicks next, matches on the top will be removed and vice versa.
  • show_phase_navigation: the matches within a single-league view schedule are displayed with the default navigation of one list of matches with the next/previous matches buttons. It is also possible to display the matches of a league based on the phase they belong to. For NFL and NCAAF it is for example common to show the schedule per week. Therefore this option can be enabled. For NFL and NCAAF the default value of this parameter is already “yes”, for other leagues it is not by default enabled (“no”), but can be turned on if required and if possible for that specific league. Example: for the Football Premier League with this option it is possible to display the entire schedule per matchday. However, our default values are the preferred settings to display the different league schedules and the phase navigation is not suited for every league.
  • sport_league_filter: by default in the multi-league view a layer with a sport and league dropdown is available, where the user can select a sport and/or league after which the matches underneath it will be filtered on the selected sport or league. Only the sport and leagues scheduled on a specific day are selectable in the dropdowns. When setting this parameter to “no”, the filters will be hidden.
  • sort_events_by: decides in the multi-league Schedule which views are available and in which order. By default the leagues and time view are available in that particular order, but by changing the input to “time,leagues” suddenly the time view is shown first. It is also possible to only display one specific view with the input of “leagues” or “time”. The other view then gets ignored and the entire leagues/time view navigation disappears from the widget.
  • tier_conference_id: for all college leagues a dropdown with the Tiers and Conferences is available in the single-league view. By default all Tiers and/or Conferences of a league are shown, with the schedule opening on the default for a specific league (i.e. FBS for NCAAF). The selectable Tiers and/or Conferences can be narrowed down by adding IDs of the Tiers and/or Conferences to this parameter. If this parameter is filled, only the Tiers and/or Conferences included with their ID in this parameter will be displayed. If a Tier is included, all Conferences of that Tier will be included by default. If you want to filter out Conferences, the IDs of the Conferences that do need to be displayed need to be entered in this parameter. Currently this dropdown only works for the phase navigation of the NCAAF. We are working on making this available for the other college leagues as well.
    In the multi-league view there is no dropdown available, but the input in the parameter filters the schedule directly on these Tiers and/or Conferences. It is not possible for an end user to set the filter themselves or to overrule that.
  • accordion_behavior: controls the behavior of the league buckets in the Leagues view. These are the possible values:
    • default: default option. Only the live leagues are expanded, the other leagues are collapsed. Also on a day where maximum 5 matches are displayed, the league buckets are expanded.
    • live: only live leagues are expanded.
    • expand: all leagues are always expanded.
    • collapse: all leagues are always collapsed.
  • participant_alias_type: defines the names of the participants. The following values are possible:
    • abbreviation: shortest alias type, 2, 3 or 4 characters.
    • default: name that is commonly used to refer to a participant (by default used in the widget as well). For a person this is the first + last name.
    • full: the complete, official name of a participant.
    • short: max. 10 characters version of the default alias  Can be the same as the default if that default hasn’t got more than 10 characters. For a person this is always the first letter of the first name and the full last name.
    • first: first name of a participant. Only applicable to persons.
    • last: last name of a participant. Only applicable to persons.
  • away_first_league_id: by default this parameter is empty, but by adding the league ID the home and away participants and their scores are reversed. When you click through to Match Detail, this setting will be applied to that widget as well.
  • format_time: format of the start time of a match. All Luxon formats can be used.
  • format_date_dow: format of the dates in the date headers. This parameter doesn’t work for the dates in the match blocks. All Luxon formats can be used.
  • format_date_dow_short: format of the dates within the match blocks. This parameter doesn’t work for the dates in the date headers. All Luxon formats can be used.
  • format_date_short: format of the dates within the phase navigation. Therefore this is only applicable if the “show_phase_navigation” parameter is set to “yes”. All Luxon formats can be used.
  • schedule_match_link: clicking on a specific match will bring you by default to the Match Detail widget of this match. This can be disabled with the input “widget:false”.
  • schedule_league_schedule_link: in the leagues view of the multi-league Schedule by default a clickthrough is available to the full schedule (single-league Schedule). This is shown inside the bucket underneath the last match of a league on the selected date. This clickthrough can be displayed by changing the input of this parameter to “widget:false”.
  • schedule_league_standings_link: in the leagues view of the multi-league Schedule besides a full schedule link by default also a clickthrough is available to Standings widget. Again this clickthrough is shown inside the bucket underneath the last match of a league on the selected date. This clickthrough can be displayed by changing the input of this parameter to “widget:false”.
  • show_result_status: defines if the status of the match (e.g. ‘Final’ for a finished match) is explicitly mentioned. The possible values are “yes” and “no”.
  • show_standings_records: adds standings related records behind the team names, which is mainly common in the North American market. These consist of the number of wins, losses and possibly draws in the league. Currently these records are only available for the big North American leagues. By default these records are hidden (input “no”), but with the value “records” they can be added.
  • show_date_dow: defines if the date is shown for a scheduled match. The possible values are “yes” and “no”. By default this is set to know and therefore only the start time of a match is displayed.
  • first_week_day: defines the order of the days in the calendar. By default Monday is displayed as the first day of the week, but this can be adjusted to any other day. The following values are valid:
    • “Sunday” or “0”
    • “Monday“ or “1“
    • “Tuesday“ or “2“
    • “Wednesday“ or “3“
    • “Thursday“ or ‘’4“
    • “Friday“ or “5“
    • “Saturday“ or “6”
  • hide_results: by default all live and final results are always visible. With this parameter these results can be hidden to not give any spoilers, for example if the widget is implemented on places where you can rewatch matches or highlights.

Standings

Standings gives an up to date overview of all standings for a particular season of a league, so users know how their favorite team or person or a team/person they are interested in is doing in their respective series, league, conference, division or group. The widget is therefore suited for both matches leagues (e.g. NBA and Premier League) and series (e.g. Formula One World Championship). The type of standings differ per sport and league, but always follows what is best practice for a sport and/or league. This includes ordering of the participants and the most important stat columns. The widget updates after every finished match.

Features

  • At the top of the widget a phase navigator can be available, depending on the structure of the league. In this navigator all conferences, divisions, phases and/or groups are visible and this enables you to click through to any of the conferences, divisions, phases or groups directly. The navigation panel isn’t available for leagues that consist of one phase with only one standings table. This navigator doesn’t work when the widgets are implemented within an iFrame. Our advice is in that situation to remove the group selector through custom CSS.
  • All standings have a header with the name of the conference, division, phase or group followed by the standings table with the participants and all important stat columns. On smaller viewports there can be more stats available than that fit the width of the widget. Therefore scrolling through the table is possible. The most important columns (at least the participants) always remain visible and are not included in the scrollable section.
    If wanted also the matches belonging to a specific group can be displayed below the standings table of that group. This is basically the Schedule By League filtered on a specific group.
  • For series at the top also an event dropdown can be visible. This happens if a series consists of multiple events (e.g. Alpine Skiing World Cup that consists of Men’s and Women’s Downhill, Super G, Giant Slalom, Slalom and Overall events).
  • If a series standings consists of persons that represent a team, that team is referenced in the widget (e.g. Formula One World Championship).

Data Parameters

Adjusting Standings to your preferences can be done with the following parameters:

  • league_id: configures the league that the widget is displayed for.
  • phase_id: the widget can be filtered on one specific phase of a league using the ID of that phase.
  • include_matches: by default only the standings are shown (“no”). By setting this parameter to “yes” matches are shown below the standings table of that group. This doesn’t work for leagues where matches are played between teams of different standings tables, like conferences and divisions, and for leagues where the entire league exists of only one phase with one group, like the Premier League. In general it is recommended to enable this for leagues with a limited amount of matches per group.
  • show_leading_stat_first: by default the most important stat column within a league is shown first (“yes”). For sports like Football this is points, for North American leagues this is the win percentage. By setting this parameter to “no” the most important stat will be placed according to what is common for the sport and/or league. This parameter will particularly be used for the bigger viewports when all columns are immediately visible.
  • format_date_dow: format of the dates in the date headers if matches are included. This parameter doesn’t work for the dates in the match blocks. All Luxon formats can be used.
  • format_date_dow_short: format of the match dates in the match blocks if matches are included. All Luxon formats can be used.
  • format_time: format of the start time of a match if matches are included. All Luxon formats can be used.
  • standings_team_link: clicking on a specific team in the standings table will bring you by default to the Team Profile widget (“widget:default”). This can be changed to the Team Roster widget by changing the input to “widget:games/teamroster”. It is also possible to disable the clickthrough by changing the input to “widget:false”.
  • standings_match_link: clicking on a specific match if the include_matches parameter is set to “yes” will bring you by default to the Match Detail widget of this match. This can be disabled with the input “widget:false”.
  • participant_alias_type: defines the names of the participants. The following values are possible:
    • abbreviation: shortest alias type, 2, 3 or 4 characters.
    • default: name that is commonly used to refer to a participant (by default used in the widget as well). For a person this is the first + last name.
    • full: the complete, official name of a participant.
    • short: max. 10 characters version of the default alias Can be the same as the default if that default hasn’t got more than 10 characters. For a person this is always the first letter of the first name and the full last name.
    • first: first name of a participant. Only applicable to persons.
    • last: last name of a participant. Only applicable to persons.

Team

The Team widget is the starting point of the journey of a specific team. The widget combines all the relevant information of a team. Currently the team’s schedule, roster and standings are available, but in the future also stats will be added.

Features

  • The first information visible when opening the Team widget is the info block. This block groups the most important information of the team together at the top of the widget. This consists of the team name, the home venue for the team and the last 5 played match results of the team representing their form. To spicy things up, for the leagues where we keep track of team colors, we have implemented that team color to give each Team widget a unique look and feel.
  • Underneath the info block all other information is available in tabs. One tab can be viewed at the same time. The following tabs can be available:
    • Schedule: gives an overview of all matches of a team. By default, just as in the Schedule widget, matches will be displayed starting from today’s date. By using the previous matches button matches from the past can be obtained, with the next matches button a user can look further in the future.
    • Roster: displays the squad of the team. Players are grouped based on common positions for the different sports. By default shirt number, name, nationality and birth date, if available, are shown. For Football (Soccer) also incoming and outgoing transfers during the season are shown.
    • Standings: all standings of the leagues a team is part of are shown, as long as the league actually has standings. For each team the domestic league is the default league to land on when the widget is opened.
    • Stats: not yet available. This tab will display the stats of team members in the various leagues they are playing in.
  • The view of the Team widget is completely adjustable with parameters. If you are only interested in the info block, the tabs underneath can be hidden. If you are only interested in one of the tabs, the info block, other tabs and tab navigation bar can be hidden. The info block and tabs are displayed/hidden based on parameters. For the tab navigation bar there is no separate parameter available, but it will behave based on the input for the info block and tabs.

Data Parameters

Adjusting Standings to your preferences can be done with the following parameters:

  • team_id: configures the team that the widget is displayed for.
  • hide_info_block: by default the info block (the top block) is always displayed, but it can be hidden by setting this parameter to “yes”.
  • hide_tabs: by default all tabs are displayed, but if some information isn’t of any interest to you, one, multiple of all tabs can be hidden. The following input values can be given to this parameter:
    • no. Default value where all tabs are displayed.
    • yes. All tabs will be hidden.
    • Hiding one or multiple tabs by entering the name of those tabs. If multiple tabs are inputted, these need to be divided with a comma. Find the complete list of tab names in the Features section. Some examples are:
      • schedule will hide the Schedule tab
      • schedule,roster will hide the Schedule and Roster tabs
  • number_of_matches_min: decides how many matches will be shown in the Schedule tab when opening the widget. By default this is 10.
  • number_of_matches_max: decides what the maximum number of matches is that will be shown in the Schedule tab. The default value is 20. Also here, based on the input value in this parameter, no match days are split. This parameter can be important because:
    • It enables you to decide the maximum length of the widget yourself.
    • It makes sure the widget won’t be too long. We cannot guarantee that the widget will keep performing smoothly if the match limit is really high.
    • If the user clicks on the previous or next matches button and after that the input value of the parameter will be exceeded, one or multiple other match day(s) at the other end of the schedule will be removed. If the user clicks next, matches on the top will be removed and vice versa.
  • participant_alias_type: defines the names of the participants. The following values are possible:abbreviation: shortest alias type, 2, 3 or 4 characters.
    • default: name that is commonly used to refer to a participant (by default used in the widget as well). For a person this is the first + last name.
    • full: the complete, official name of a participant.
    • short: max. 10 characters version of the default alias  Can be the same as the default if that default hasn’t got more than 10 characters. For a person this is always the first letter of the first name and the full last name.
    • first: first name of a participant. Only applicable to persons.
    • last: last name of a participant. Only applicable to persons.
  • away_first_league_id: by default this parameter is empty, but by adding the league ID the home and away participants and their scores are reversed. When you click through to Match Detail, this setting will be applied to that widget as well.
  • format_time: format of the start time of a match. All Luxon formats can be used.
  • format_date_dow: format of the dates in the date headers. This parameter doesn’t work for the dates in the match blocks. All Luxon formats can be used.
  • format_date_dow_short: format of the dates within the match blocks. This parameter doesn’t work for the dates in the date headers. All Luxon formats can be used.
  • format_date_short: format of the dates within the phase navigation. Therefore this is only applicable if the “show_phase_navigation” parameter is set to “yes”. All Luxon formats can be used.
  • schedule_match_link: clicking on a specific match will bring you by default to the Match Detail widget of this match. This can be disabled with the input “widget:false”.
  • hide_player_headshots_league_ids: if you are entitled to use headshots these will be displayed by default. The headshots can be hidden by adding the league ID to this parameter.
  • show_result_status: defines if the status of the match (e.g. ‘Final’ for a finished match) is explicitly mentioned. The possible values are “yes” and “no”.
  • show_standings_records: adds standings related records behind the team names, which is mainly common in the North American market. These consist of the number of wins, losses and possibly draws in the league. Currently these records are only available for the big North American leagues. By default these records are hidden (input “no”), but with the value “records” they can be added.
  • hide_results: by default all live and final results are always visible. With this parameter these results can be hidden to not give any spoilers, for example if the widget is implemented on places where you can rewatch matches or highlights.

Teams By League

In Teams By League all teams participating in a league season are presented in one list. This widget offers users information about the participants of a specific league with the possibility to click through on each team to see Team Roster information.

Features

  • All teams of a league season are included in one big list. For all teams the flag or logo is available followed by the team name.

Data Parameters

Adjusting Teams By League to your preferences can be done with the following parameters:

  • league_id: configures the league that the widget is displayed for.
  • teamsbyleague_team_link: clicking on a specific team will bring you by default to the Team Profile widget of this team. However, there are some other options as well:
    • “widget:games/teamroster”: the only linking option currently is the Team Roster.
    • “widget:false”: disables the linking.
Gracenote, the Gracenote logo and logotype are either a registered trademark or a trademark of Gracenote, Inc. in the United States and/or other countries. © 2000-present. Gracenote, Inc. All rights reserved.