Adicionar um gráfico
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
Saiba como você pode adicionar gráficos às suas extensões. Os gráficos podem ser adicionados a qualquer extensão Azure DevOps Services.
Dica
Confira nossa documentação mais recente sobre o desenvolvimento de extensão usando o SDK da Extensão do Azure DevOps.
Os gráficos são fáceis de criar, redimensionáveis, interativos e consistentes com a aparência Azure DevOps Services. Há suporte para os seguintes tipos de gráfico:
- Linha
- Barras
- Coluna
- Área
- Barra empilhada
- Coluna empilhada
- Área empilhada
- Pie
- Tabela dinâmica
- Histograma
Se você estiver com pressa e quiser colocar as mãos no código imediatamente, baixe os exemplos completos.
Depois de baixado, vá para a charts pasta e siga as instruções de empacotamento e publicação para publicar a extensão de exemplo.
A extensão contém widgets de gráfico de exemplo.
Como organizar seu código
Para este tutorial, criamos um widget e adicionamos um gráfico a ele.
Para fazer isso, na pasta do home seu projeto, crie um chart.html arquivo com o seguinte conteúdo:
Arquivo HTML
<!DOCTYPE html>
<html>
<head>
<script src="sdk/scripts/VSS.SDK.js"></script>
<script src="scripts/pie-chart.js"></script>
</head>
<body>
<div class="widget">
<h2 class="title">Chart Widget</h2>
<div id="Chart-Container"></div>
</div>
</body>
</html>
Use o comando npm install para recuperar o SDK:
npm install vss-web-extension-sdk. Para saber mais sobre o SDK, visite a Página do GitHub do SDK do Cliente.
Verifique se o VSS.SDK.js arquivo está dentro da sdk/scripts pasta para que o caminho seja home/sdk/scripts/VSS.SDK.js.
Imagens
Adicione imagens a uma img pasta no diretório do projeto para que o caminho seja home/img/logo.png e home/img/CatalogIcon.png.
Confira nossa documentação mais recente, o Sistema de Design de Fórmulas e o SDK de exemplo de extensão do Azure DevOps.
Arquivo de manifesto de extensão
Na pasta do projeto, crie o home arquivo de manifesto da extensão. Crie um arquivo vss-extension.json com os conteúdos a seguir:
{
"manifestVersion": 1,
"id": "samples-charts",
"version": "1.0.0",
"name": "Interactive Charts in Azure DevOps Services",
"description": "Samples of interactive charts from the Chart SDK.",
"publisher": "Fabrikam",
"targets": [
{
"id": "Microsoft.VisualStudio.Services"
}
],
"icons": {
"default": "img/logo.png"
},
"demands": ["contribution/ms.vss-dashboards-web.widget-sdk-version-2", "contribution/ms.vss-web.charts-service"],
"contributions": [
{
"id": "chart",
"type": "ms.vss-dashboards-web.widget",
"targets": [
"ms.vss-dashboards-web.widget-catalog"
],
"properties": {
"name": "Sample Chart",
"description": "A simple chart widget with no configuration and hard-coded data.",
"catalogIconUrl": "img/CatalogIcon.png",
"uri": "chart.html",
"supportedSizes": [
{
"rowSpan": 2,
"columnSpan": 2
}
],
"supportedScopes": [
"project_team"
]
}
}
],
"files": [
{
"path": "chart.html",
"addressable": true
},
{
"path": "sdk/scripts/VSS.SDK.js",
"addressable": true
},
{
"path": "img",
"addressable": true
},
{
"path": "scripts",
"addressable": true
}
],
"scopes": [
]
}
Antes de carregar essa extensão, você deve atualizar o para o publisher seu.
Coloque os snippets de código a seguir em um chart.js arquivo em uma scripts pasta, para que o caminho seja home/scripts/chart.js.
Em seguida, siga as instruções de empacotamento e publicação para publicar sua extensão.
Gráficos
Gráfico
Este exemplo renderiza um gráfico. O data e labelValues foram codificados aqui e precisariam ser alterados para os dados que você deseja visualizar.
VSS.init({
explicitNotifyLoaded: true,
usePlatformStyles: true
});
VSS.require([
"TFS/Dashboards/WidgetHelpers",
"Charts/Services"
],
function (WidgetHelpers, Services) {
WidgetHelpers.IncludeWidgetStyles();
VSS.register("chart", function () {
return {
load:function() {
return Services.ChartsService.getService().then(function(chartService){
var $container = $('#Chart-Container');
var chartOptions = {
"hostOptions": {
"height": "290",
"width": "300"
},
"chartType": "pie",
"series": [{
"data": [11, 4, 3, 1]
}],
"xAxis": {
"labelValues": ["Design", "On Deck", "Completed", "Development"]
},
"specializedOptions": {
"showLabels": "true",
"size": 200
}
};
chartService.createChart($container, chartOptions);
return WidgetHelpers.WidgetStatusHelper.Success();
});
}
}
});
VSS.notifyLoadSucceeded();
});
Aqui, o tamanho do gráfico é definido em hostOptions. A propriedade series é uma matriz e contém um único objeto com dados nela. O xAxis objeto contém labelValues, que correspondem ao data.
Para gráficos de pizza, também temos algumas opções especiais definidas pela specializedOptions propriedade . Aqui, estamos habilitando explicitamente rótulos de dados para o gráfico de pizza.
Também precisamos definir o tamanho do gráfico de pizza especificando seu diâmetro externo.
O gráfico requer um contêiner, as opções do gráfico e uma chamada para o Serviço de Gráfico para inicializar e renderizar. Para obter mais informações sobre opções de gráfico, consulte vss-web-extension-sdk/typings/charts.
Gráfico de áreas empilhadas
O exemplo a seguir renderiza um gráfico de área empilhada. Esse tipo de gráfico é ideal para comparar uma relação de partes com um todo e realçar tendências gerais entre categorias. Normalmente, ele é usado para comparar tendências ao longo do tempo. Este exemplo também especifica uma cor personalizada para uma das séries que estão sendo renderizadas.
VSS.init({
explicitNotifyLoaded: true,
usePlatformStyles: true
});
VSS.require([
"TFS/Dashboards/WidgetHelpers",
"Charts/Services"
],
function (WidgetHelpers, Services) {
WidgetHelpers.IncludeWidgetStyles();
VSS.register("StackedAreaChart", function () {
return {
load:function() {
return Services.ChartsService.getService().then(function(chartService){
var $container = $('#Chart-Container');
var chartOptions = {
"hostOptions": {
"height": "290",
"width": "300"
},
"chartType": "stackedArea",
"series": [
{
"name": "Completed",
"data": [1,3,4,3,6,1,9,0,8,11]
},
{
"name": "Development",
"data": [1,1,0,3,0,2,8,9,2,8]
},
{
"name": "Design",
"data": [0,0,0,6,1,1,9,9,1,9],
"color": "#207752"
},
{
"name": "On Deck",
"data": [1,2,4,5,4,2,1,7,0,6]
}
],
"xAxis": {
"labelFormatMode": "dateTime_DayInMonth",
"labelValues": [
"1/1/2016",
"1/2/2016",
"1/3/2016",
"1/4/2016",
"1/5/2016",
"1/6/2016",
"1/7/2016",
"1/8/2016",
"1/9/2016",
"1/10/2016"
]
}
}
chartService.createChart($container, chartOptions);
return WidgetHelpers.WidgetStatusHelper.Success();
});
}
}
});
VSS.notifyLoadSucceeded();
});
Tabela dinâmica
Este exemplo renderiza uma Tabela Dinâmica. Esse tipo de gráfico ajuda a organizar e resumir dados complexos em um formulário tabular.
VSS.init({
explicitNotifyLoaded: true,
usePlatformStyles: true
});
VSS.require([
"TFS/Dashboards/WidgetHelpers",
"Charts/Services"
],
function (WidgetHelpers, Services) {
WidgetHelpers.IncludeWidgetStyles();
VSS.register("PivotTable", function () {
return {
load:function() {
return Services.ChartsService.getService().then(function(chartService){
var $container = $('#Chart-Container');
var chartOptions = {
"hostOptions": {
"height": "290",
"width": "300"
},
"chartType": "table",
"xAxis": {
"labelValues": ["Design","In Progress","Resolved","Total"]
},
"yAxis": {
"labelValues": ["P1","P2","P3","Total"]
},
"series": [
{
"name": "Design",
"data": [
[0,0,1],
[0,1,2],
[0,2,3]
]
},
{
"name": "In Progress",
"data": [
[1,0,4],
[1,1,5],
[1,2,6]
]
},
{
"name": "Resolved",
"data": [
[2,0,7],
[2,1,8],
[2,2,9]
]
},
{
"name": "Total",
"data": [
[3,0,12],
[3,1,15],
[3,2,18],
[0,3,6],
[1,3,15],
[2,3,24],
[3,3,10]
],
"color": "rgba(255,255,255,0)"
}
]
}
chartService.createChart($container, chartOptions);
return WidgetHelpers.WidgetStatusHelper.Success();
});
}
}
});
VSS.notifyLoadSucceeded();
});