Add widgets to a dashboard

VSTS | TFS 2018 | TFS 2017 | TFS 2015.1

Widgets smartly format data to provide access to easily consumable data. You add widgets to your team dashboards to gain visibility into the status and trends occurring as you develop your software project.

Each widget provides access to a chart, user-configurable information, or a set of links that open a feature or function.

You can add one or more charts or widgets to your dashboard. You add several widgets at a time simply by selecting each one. See Manage dashboards to determine the permissions you need to add and remove widgets from a dashboard.

Prerequisites

  • You must be a member of a team project. If you don't have a team project yet, create one in VSTS.
  • If you haven't been added as a team member, get added now.
  • Anyone with access to the team project, including stakeholders, can view dashboards.
  • To add, edit, or manage a team dashboard, you must be a team admin, a project admin, or have dashboard permissions. In general, you need to be a team admin for the currently selected team to edit dashboards. Request your current team or project admin to add you as a team admin.

Prerequisites

  • You must be a member of a team project. If you don't have a team project yet, create one in an on-premises TFS.
  • If you haven't been added as a team member, get added now.
  • Anyone with access to the team project, including stakeholders, can view dashboards.
  • To add a widget to a team dashboard, you must be a team admin, a project admin, or have dashboard permissions. In general, you need to be a team admin for the currently selected team to edit dashboards. Request your current team or project admin to add you as a team admin.

Prerequisites

Connect to the web portal for your team project

To add a widget to a dashboard, you connect to your team project using a supported web browser. If you don't have a team project yet, create one in VSTS.

Open a browser window and click the Dashboards hub. If you haven't been added as a team member, get added now.

Open the Dashboards hub

If you don't see the team or team project you want, click the project icon project icon to browse all team projects and teams.

Select a dashboard to modify

All dashboards are associated with a team. You need to be a team administrator, project administrator, or a team member with permissions to modify a dashboard.

To enable the New Dashboard experience, see Enable preview features.

  1. From the Dashboards hub, open the selector and choose the Browse all dashboards option.

    Dashboards hub, Browse all dashboards option

  2. The All page lists all dashboards defined for the team project in alphabetical order. You can filter the list by team or by keyword.

    Dashboards hub, Browse all dashboards option

The New Dashboard experience is only available from VSTS at this time.

Add a widget to a dashboard

To enable the New Dashboard experience, see Enable preview features.

To add widgets to the dashboard, click Edit dashboard icon.

The widget catalog will automatically open. Add all the widgets that you want and drag their tiles into the sequence you want.

When you're finished with your additions, click Done Editing to exit dashboard editing. This will dismiss the widget catalog. You can then configure the widgets as needed.

Tip

When you're in dashboard edit mode, you can remove, rearrange, and configure widgets, as well as add new widgets. Once you leave edit mode, the widget tiles remain locked, reducing the chances of accidentally moving a widget.

To remove a widget, click the actions icon actions icon and select the Delete option from the menu.

Delete a widget from a dashboard

The New Dashboard experience is only available from VSTS at this time.

Configure a widget

Most widgets support configuration, which may include specifying the title, seeting the widget size, and other widget-specific variables.

To configure a widget, add the widget to a dashboard, click open the actions icon menu, and select Configure.

Open the create a dashboard dialog

To configure a widget, add the widget to a dashboard and then click the configure icon configure icon.

Work item chart unconfigured widget

Once you've configured the widget, you can edit it by opening the actions menu.

Edit configured widget

Move or delete a widget from a dashboard

To move a widget, you need to enable the dashboard edit mode. To delete a widget, simply select the delete option provided from the widget's options menu.

Just as you have to be a team or project admin to add items to a dashboard, you must have admin permissions to remove items.

Click Edit dashboard icon to modify your dashboard. You can then add widgets or drag tiles to reorder their sequence on the dashboard.

To remove a widget, click the actions icon actions icon and select the Delete option from the menu.

Delete a widget from a dashboard

When you're finished with your changes, click Done Editing to exit dashboard editing.

Copy a widget to another dashboard

You can copy a widget to another dashboard defined for your team. If you want to move widgets you have configured to another dashboard, this is how you do it. Before you begin, add the dashboard you want to copy or move the widget to. Once you've copied the widget, you can delete it from the current dashboard.

To copy a configured widget to another team dashboard, click the Actions icon actions icon and select Copy to dashboard and then the dashboard to copy it to.

Copy a widget to another dashboard

To copy a configured widget to another team dashboard, click the Actions icon actions icon and select Add to dashboard and then the dashboard to copy it to.

Copy a widget to another team dashboard

Analytics Service widgets

The Analytics Service is in preview and provides access to several widgets. To learn more, see these topics:

Try this next

Extensibility

In addition to the widgets described in the Widget catalog, you can create your own widgets using the Widget REST APIs.

Widget size

Some widgets are pre-sized and can't be changed. Others are configurable through their configuration dialog.

For example, the Chart for work items widget allows you to select an area size ranging from 2 x 2 to 4 x 4 (tiles).

Change widget size

Disabled Marketplace widget

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.