Widget catalog

VSTS | TFS 2018 | TFS 2017 | TFS 2015.1-2015.3

Widgets display information and charts on dashboards. Many of them are configurable and display information available from one or more data stores or charts maintained within the system.

To add a widget to a dashboard or copy a widget from one dashboard to another, see Add a widget to a dashboard.

Note

Feature availability: You can access the widget catalog from VSTS or the web portal for TFS 2015.1 or later version. All widgets listed below are available from the web portal for VSTS. Some widgets listed below are only available when you connect to TFS 2015 Update 2 or later version.

With TFS 2015, you have access to a single team dashboard with which you can pin items but can't add widgets to the dashboard. Install TFS 2015 Update 1 or later version to get access to the widget catalog and multiple team dashboards. To determine the platform and version you're on, see Provide product and content feedback, Platforms and version support.

User-focused and team-scoped widgets

User-focused widgets display information based on the logged-in user.

Team-scoped widgets display data based on the selected team context.

Code

Code tile

Code tile widget

Adds a configurable tile to display the summary of a code folder or Git repository. To configure, simply click the added tile, select a repository, select a branch (Git only) and select a path. The code tile supports both TFVC and Git repositories.


Pull request (user-focused or team-scoped)

Pull request widget

Note

Feature availability: Available from VSTS or TFS 2015.2 or later version.

Adds a configurable tile to display active pull requests requested by the team, or assigned to or requested by the person logged in. Select the Git repository for the pull requests of interest.

You need to add a widget for each Git repository of interest. To learn more about pull requests, see Review code with pull requests.

Plan and track work

Assigned to me (user-focused)

Assigned to me widget

Note

Feature availability: You can access this widget from VSTS and TFS 2017.

Displays the list of work items currently assigned to the currently logged in user. The list ignores closed or deleted work items.


Burndown chart

Burndown chart widget

Note

Feature availability: This widget is available for VSTS. To add it to your dashboard, you first need to install the Analyics Marketplace extension. You can then add the widget(s) to your dashboard. You must be an account owner or a member of the Project Collection Administrator group to add extensions.

Adds a tile that displays a burndown chart which you can configure to span one or more teams, work item types, and time period. With it, you can create a release burndown, sprint burndown, or any burndown that spans teams and sprints. To learn more, see Configure a Burndown or Burnup widget.


Burnup chart

Burnup chart widget

Note

Feature availability: This widget is available for VSTS. To add it to your dashboard, you first need to install the Analyics Marketplace extension. You can then add the widget(s) to your dashboard. You must be an account owner or a member of the Project Collection Administrator group to add extensions.

Adds a tile that displays a burnup chart which you can configure to span one or more teams, work item types, and time period. With it, you can create a release burnup, sprint burnup, or any burnup that spans teams and sprints. To learn more, see Configure a Burndown or Burnup widget.


Chart for work items

Chart work item query widget

Note

Feature availability: You can access this widget from VSTS or TFS 2015.2 or later version. For TFS 2015.1 and earlier versions, see Add charts to a dashboard to add shared query charts to a dashboard.

Adds a tile to display a progress or trend chart that builds off a shared work item query.
From the configuration dialog, select a shared query and specify the chart type and values.


Cumulative flow diagram (team-scoped)

Cumulative flow diagram widget

Note

Feature availability: This widget is available for VSTS. To add it to your dashboard, you first need to install the Analyics Marketplace extension. You can then add the widget(s) to your dashboard. You must be an account owner or a member of the Project Collection Administrator group to add extensions.

Displays the cumulative flow of backlog items based on the time frame, team, backlog level and swimlane you select.

From the configuration dialog, specify the team, backlog level, and other parameters you want.

Hover over each color within the chart to see the count of items for a particular Kanban column.


Cycle time (team-scoped)

Cumulative flow diagram widget

Note

Feature availability: This widget is available for VSTS. To add it to your dashboard, you first need to install the Analyics Marketplace extension. You can then add the widget(s) to your dashboard. You must be an account owner or a member of the Project Collection Administrator group to add extensions.

Displays the cycle time of work items closed in a specified timeframe for a single team and backlog level. The cycle time of a work item is defined as the time taken to close a work item after work on it has started.

Each marker on the chart corresponds to one or more work items with a particular cycle time. The lower the cycle time, the faster work is progressing through your development pipeline.


Lead time (team-scoped)

Lead time widget

Note

Feature availability: This widget is available for VSTS. To add it to your dashboard, you first need to install the Analyics Marketplace extension. You can then add the widget(s) to your dashboard. You must be an account owner or a member of the Project Collection Administrator group to add extensions.

Displays the lead time of work items closed in a specified timeframe for a single team and backlog level. The lead time of a work item is defined as the time taken to close a work item after it was created.

Each marker on the chart corresponds to one or more work items with a particular lead time. The lower the lead time, the faster work is being delivered to the customer.


New Work item (team-scoped)

New work item widget

Enables you to add work items from the dashboard. You use work items to plan and track work.

Work items that you add using this widget are automatically scoped to the team's default area path and the team's current sprint (TFS) or the default iteration (VSTS). To change team defaults, see Set team defaults.


Other links widget

Provides links to the following features:

For on-premises TFS, additional links are displayed when the corresponding resource is configured for the team project:

On-premises TFS with configured resources

Other links widget


Query results

Query results widget

Adds a configurable tile that lists the results of a shared query. From the configuration dialog, select either a team favorite or shared query.
To create a shared query, see Use the query editor to list and manage queries.


Query tile

Query tile widget

Adds a configurable tile to display the summary of a shared query results. From the configuration dialog, select either a team favorite or shared query. You can optionally specify rules to change the query tile color based on the number of work items returned by the query. To create a shared query, see Use the query editor to list and manage queries.


Sprint burndown (team-scoped)

Sprint burndown widget

Adds the team's burndown chart for the current sprint to the dashboard. This chart always displays data for the current sprint. Teams use the burndown chart to mitigate risk and check for scope creep throughout the sprint cycle.


Sprint capacity (team-scoped)

Sprint capacity widget

Inserts the team's capacity bar chart for the current sprint. Teams specify their capacity to plan and monitor their sprint resources.


Sprint overview (team-scoped)

Sprint overview widget

For VSTS, inserts a configurable overview of sprint progress. You can choose between a count of story points or number of work items.
For on-premises TFS, inserts a visual overview of sprint progress indicating the number of backlog items in progress, completed, or not started.

Teams plan their sprints by defining sprints and assigning backlog items to an iteration.


Velocity (team-scoped)

Sprint velocity widget

Note

Feature availability: This widget is available for VSTS. To add it to your dashboard, you first need to install the Analyics Marketplace extension. You can then add the widget to your dashboard. You must be an account owner or a member of the Project Collection Administrator group to add extensions.

The velocity widget tracks a team's capacity to deliver work sprint after sprint. You configure the widget by selecting a team, a work item type, an aggregation field, and the number of sprints. The widget takes advantage of the Analytics service. You can track the velocity for a single team, not multiple teams.
For additional guidance, see Velocity.


Work links widget Provides quick access to open the following Agile tools and team resources:

Build, test, release

Chart for build history

Build history widget

Note

Feature availability: You can access this widget from VSTS or TFS 2015.2 or later version. For TFS 2015.1 and earlier versions, see Add charts to a dashboard to add a build summary chart to a dashboard.

Adds a tile to display a histogram of all builds run for the configured build definition. From the configuration dialog, select the build you want to monitor. Hover over a bar to learn how long the build took to complete. Click the bar to open the summary for that specific build. Bar color indicates: green-completed, red-failed, and yellow-completed without tests.


Chart for test plans

Chart work item query widget

Note

Feature availability: You can access this widget from VSTS and TFS 2017.2 and later versions. For TFS 2015.1 and earlier versions, see Add charts to a dashboard to add other supported chart types to a dashboard.

Adds a configurable widget that lets you track the progress of test case authoring or status of test execution for tests in a test plan. Get started by selecting a test plan and a test suite. Then select test case chart for test authoring progress or test results for test execution progress. Finally, select the chart type and the pivots.

To learn more, see Track your test results.


Deployment status

Deployment status widget

Note

Feature availability: You can access this widget from VSTS or TFS 2017.1 or later versions.

Configurable widget that shows a consolidated view of the deployment status and test pass rate across multiple environments for a recent set of builds. You configure the widget by specifying a build definition, branch, and linked release definitions.

To learn more, see View and manage releases.


Release definition overview

Release definition overview widget

Note

Feature availability: You can access this widget from VSTS.

Configurable widget that you can use to view and track the status of a release definition. The widget shows the release as a series of environments, with the name of the release and the date or time it was started. The color of the heading and the icon in each environment indicate the current status of the release, which are the same as are used on the Releases page. Select a release definition in the left column to filter the list to just releases for that definition. To learn more, see Add release information to the dashboard.


Requirements quality

Requirements quality widget

Note

Feature availability: You can access this widget from VSTS or TFS 2017.

Configurable widget that you can use to track quality continuously from a build or release definition. To learn more, see Associate automated test results with requirements.


Test results trend

Test results trend widget

Note

Feature availability: You can access this widget from VSTS or TFS 2017.

Adds a configurable tile that displays the trend of test results, such as passed or failed tests, for the selected build definition.

From the configuration dialog, select the build whose test results you'd like to monitor. Then, choose the type of chart you want displayed. You can track the trend of test duration by adding an optional line chart.

To learn more about creating charts for tracking test results, see Review continuous test results after a build.

Embedded web page

Embedded web page widget

Note

Feature availability: You can access this widget from VSTS or TFS 2017 or later version.

Adds a configurable tile to display the contents of a web page. Only webpages that allow iframe embedding are supported.


Markdown

Markdown widget

Note

Feature availability: For VSTS and TFS 2015.2 or later versions, you can configure the widget to point to a file stored in your repository.

Adds a configurable tile to display any type of information, guidance, or links that you want. From the configuration dialog, add the information you want to share with your team.

To learn more about markdown format, see Markdown guidance.


Team members (team-scoped)

Team members widget

Sows team member profiles and, on-hover, their user account alias. For team admins, supports access to the quick dialog to add or remove team members.

Note

This widget is a convenient way to add team members to specific teams within projects. If you remove it, you can still add members to your team from the team administration page.


Team room (team-scoped)

Team room widget

Provides status and access to team rooms. Team rooms support increased team productivity by providing a space to discuss work in progress, ask questions, share status, and clarify issues that arise. Team administrators can create additional team rooms.


Visual Studio Shortcuts

Visual Studio widget

Provides links to open or download Visual Studio. The Visual Studio IDE client comes with the Team Explorer plug-in which provides quick access to several features (some of which aren't available through the web portal).


Welcome

How to links widget

Provides links to the Work, Code, and Build hubs and reference documentation on how to add charts.

These represent the basic widgets. Look forward to more widgets becoming available in the coming months.

Marketplace widgets

You may find additional widgets of interest from the Marketplace.

If your account or project collection administrator disables a marketplace widget, you'll see the following image:

Disabled widget extension notification

To regain access to it, request your admin to reinstate or reinstall the widget.

Extensibility

Using the REST API service, you can create a dashboard widget. To learn more about the REST APIs for dashboards and widgets, see Dashboards.