Skip to content

example-analytics-widget.md

Latest commit

 

History

History
61 lines (41 loc) · 3.63 KB

example-analytics-widget.md

File metadata and controls

61 lines (41 loc) · 3.63 KB
title Example of an Analytics Widget
titleSuffix Azure DevOps
description Learn how to build your own Analytics widget to display in a dashboard in Azure DevOps.
ms.subservice azure-devops-analytics
ms.assetid 37253E50-28D5-4AA9-B0E1-9D09D951739F
ms.author chcomley
author chcomley
ms.topic how-to
monikerRange >= azure-devops-2019
ms.date 09/30/2020

Create an Analytics widget for Azure DevOps

[!INCLUDE version-gt-eq-2019]

You can build your own Analytics widget to display in a dashboard in Azure DevOps. The example widget on github demonstrates:

[!div class="checklist"]

  • How to render trend lines associated with work item states
  • How to query a dataset, whe a user will configure through the widget configuration view
  • How to build and publish the widget to the Azure DevOps marketplace

With this information, you'll be able to create your own Analytics widget.

View of Configuration with Preview of Widget

[!INCLUDE temp]

Prerequisites

This example provides a ready-made widget, covering basics from topics in Dashboards, Charting, and Analytics. The following documents provide more grounding on details demonstrated in this example:

  1. Create an Azure DevOps Widget Extension, reference the Widget extensions sample
  2. Render an Azure DevOps Chart Control, reference Add a Chart
  3. Query OData from Analytics

Provide a configuration view

  1. Run simple analytics queries required by UI controls used for configuring a view.
  2. Manage state of configuration UI, with updates based on user actions, and with new data from Analytics queries.
  3. Render configuration UI using Typescript and React.

Render data within a Widget

  1. Run a user configured query as a POST Request
  2. Interpret data from analytics to render a chart

Next steps

To avoid excess complexity in the sample, we omitted certain technologies and practices, which a production widget should certainly include. The ui-fabric-react sample on github highlights a build process that exercises these details.

  1. JavaScript bundling and content minification - The set of small, loose script files in the sample can load much more quickly when combined into a single file, and minified.
  2. Fabric UI Controls - Fabric UI controls provide a rich set of configuration UI components for React.

Related articles