[comment]: # ({4f11bfeb-0ca55492})
# 21 Gráfico de pizza
[comment]: # ({/4f11bfeb-0ca55492})
[comment]: # ({a2d27881-732288b3})
### Descrição
Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget do dashboard permitem configurar o widget [*Gráfico de pizza*](/manual/web_interface/frontend_sections/dashboards/widgets/pie_chart) nos métodos `dashboard.create` e `dashboard.update`.
::: noteimportant
As propriedades `fields` do widget não são validadas durante a criação ou atualização de um dashboard.
Isso permite que os usuários modifiquem [widgets internos](/manual/web_interface/frontend_sections/dashboards/widgets) e criem [widgets personalizados](/devel/modules/tutorials/widget), mas também introduz o risco de criar ou atualizar widgets incorretamente.
Para garantir a criação ou atualização bem-sucedida do widget *Gráfico de pizza*, consulte o comportamento dos parâmetros descrito nas tabelas abaixo.
:::
[comment]: # ({/a2d27881-732288b3})
[comment]: # ({cec6505f-26d25426})
### Parâmetros
Os seguintes parâmetros são suportados para o widget *Gráfico de pizza*.
|Parâmetro|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-----|-|-----|-------------------|
|*Intervalo de atualização*|0|rf_rate|0 - Sem atualização;
10 - 10 segundos;
30 - 30 segundos;
60 - *(padrão)* 1 minuto;
120 - 2 minutos;
600 - 10 minutos;
900 - 15 minutos.|
[comment]: # ({/cec6505f-26d25426})
[comment]: # ({85a8987c-4242ce63})
#### Conjunto de dados
Os seguintes parâmetros são suportados para configurar um *Conjunto de dados*.
::: noteclassic
O primeiro número no nome da propriedade (por exemplo, ds.0.hosts.0, ds.0.items.0) representa o conjunto de dados específico, enquanto o segundo número, se presente, representa o host ou item configurado.
:::
|Parâmetro|<|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-|--------|--|--------|-------------------------------|
|*Tipo de conjunto de dados*|<|0|ds.0.dataset_type|0 - Lista de items;
1 - *(padrão)* Padrões de items.|
|<|*Items*|4|ds.0.itemids.0|ID do [Item](/manual/api/reference/item/get).
Ao configurar o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object), apenas items configurados no template devem ser definidos.
Nota: Para configurar múltiplos items, crie um objeto de campo de widget de dashboard para cada item com um número incrementado no nome da propriedade.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se o *Tipo de conjunto de dados* estiver definido como "Lista de items" e *Items (Widget)* não estiver definido|
|^|*Items (Widget)*|1|ds.0.itemids.0.\_reference|Em vez do ID do [Item](/manual/api/reference/item/get):
`ABCDE._itemid` - defina um [widget compatível](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (com seu parâmetro *Referência* definido como "`ABCDE`") como a fonte de dados para os items.
Nota: Para configurar múltiplos widgets, crie um objeto de campo de widget de dashboard para cada widget com um número incrementado no nome da propriedade.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se o *Tipo de conjunto de dados* estiver definido como "Lista de items" e *Items* não estiver definido|
|^|*Cor*|1|ds.0.color.0|Código de cor hexadecimal (por exemplo, `FF0000`).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se o *Tipo de conjunto de dados* estiver definido como "Lista de items"|
|^|*Tipo de item*|0|ds.0.type.0|0 - *(padrão)* Normal;
1 - Total.
O valor "Total" pode ser definido apenas para um item em todo o gráfico.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se o *Tipo de conjunto de dados* estiver definido como "Lista de items"|
|^|*Padrões de host*|1|ds.0.hosts.0|Nome ou padrão do [Host](/manual/api/reference/host/get) (por exemplo, "Zabbix\*").
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se o *Tipo de conjunto de dados* estiver definido como "Padrões de items"
Este parâmetro não é suportado ao configurar o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object).|
|^|*Padrões de items*|1|ds.0.items.0|Nome ou padrão do [Item](/manual/api/reference/item/get) (por exemplo, "\*: Número de valores processados por segundo").
Ao configurar o widget em um [dashboard de template](/manual/api/reference/templatedashboard/object), apenas os padrões para items configurados no template devem ser definidos.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se o *Tipo de conjunto de dados* estiver definido como "Padrões de items"|
|^|*Cor*|1|ds.0.color|Código de cor hexadecimal (por exemplo, `FF0000`).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se o *Tipo de conjunto de dados* estiver definido como "Padrões de items" e *Paleta de cores* não estiver definida|
|^|*Paleta de cores*|0|ds.0.color_palette|Índice da paleta de cores.
Os valores possíveis variam de 0-11.
Padrão: 0.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se o *Tipo de conjunto de dados* estiver definido como "Padrões de items" e *Cor* não estiver definida|
|*Função de agregação*|<|0|ds.0.aggregate_function|1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum;
6 - first;
7 - *(padrão)* last.|
|*Agregação do conjunto de dados*|<|0|ds.0.dataset_aggregation|0 - *(padrão)* nenhum;
1 - min;
2 - max;
3 - avg;
4 - count;
5 - sum.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se o *Tipo de item* estiver definido como "Total"|
|*Rótulo do conjunto de dados*|<|1|ds.0.data_set_label|Qualquer valor de string.
Padrão: `""` (vazio).|
|*Tags de item*|<|<|<|<|
|<|*Tipo de avaliação*|0|ds.0.item_tags_evaltype|0 - *(padrão)* And/Or;
2 - Or.|
|^|*Nome da tag*|1|ds.0.item_tags.0.tag|Qualquer valor de string.
Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se estiver configurando *Tags de item*|
|^|*Operador*|0|ds.0.item_tags.0.operator|0 - Contém;
1 - Igual;
2 - Não contém;
3 - Não é igual;
4 - Existe;
5 - Não existe.
Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se estiver configurando *Tags de item*|
|^|*Valor da tag*|1|ds.0.item_tags.0.value|Qualquer valor de string.
Nota: O número no nome da propriedade faz referência à ordem da tag na lista de avaliação de tags.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *obrigatório* se estiver configurando *Tags de item*|
[comment]: # ({/85a8987c-4242ce63})
[comment]: # ({de5a8634-0a101fc7})
#### Opções de exibição
Os seguintes parâmetros são suportados para configurar as *Opções de exibição*.
|Parâmetro|<|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-|--------|--|--------|-------------------------------|
|*Seleção de dados históricos*|<|0|source|0 - *(padrão)* Automático;
1 - Histórico;
2 - Tendências.|
|*Desenhar*|<|0|draw_type|0 - *(padrão)* Pizza;
1 - Rosquinha.|
|<|*Largura*|0|width|20 - 20% do raio;
30 - 30% do raio;
40 - 40% do raio;
50 - *(padrão)* 50% do raio.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Desenhar* estiver definido como "Rosquinha"|
|^|*Largura do traço*|0|stroke|Os valores possíveis variam de 0-10.
Padrão: 0.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Desenhar* estiver definido como "Rosquinha"|
|^|*Exibir valor total*|0|total_show|0 - *(padrão)* Desabilitado;
1 - Habilitado.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Desenhar* estiver definido como "Rosquinha"|
|^|*Tamanho*|0|value_size_type|0 - *(padrão)* Automático;
1 - Personalizado.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor total* estiver definido como "Habilitado"|
|^|*Tamanho* (valor para tamanho personalizado)|0|value_size|Os valores possíveis variam de 1-100.
Padrão: 20.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor total* estiver definido como "Habilitado"|
|^|*Casas decimais*|0|decimal_places|Os valores possíveis variam de 0-6.
Padrão: 2.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor total* estiver definido como "Habilitado"|
|^|*Unidades* (checkbox)|0|units_show|0 - *(padrão)* Desabilitado;
1 - Habilitado.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor total* estiver definido como "Habilitado"|
|^|*Unidades* (valor)|1|units|Qualquer valor de string.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Unidades* (checkbox) estiver definido como "Habilitado"|
|^|*Negrito*|0|value_bold|0 - *(padrão)* Desabilitado;
1 - Habilitado.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor total* estiver definido como "Habilitado"|
|^|*Cor*|1|value_color|Código de cor hexadecimal (ex: `FF0000`).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Exibir valor total* estiver definido como "Habilitado"|
|*Espaço entre setores*|<|0|space|Os valores possíveis variam de 0-10.
Padrão: 1.|
|*Mesclar setores menores que N%* (checkbox)|<|0|merge|0 - *(padrão)* Desabilitado;
1 - Habilitado.|
|*Mesclar setores menores que N%* (valor)|<|0|merge_percent|Os valores possíveis variam de 1-10.
Padrão: 1.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Mesclar setores menores que N%* (checkbox) estiver definido como "Habilitado"|
|*Mesclar setores menores que N%* (cor)|<|1|merge_color|Código de cor hexadecimal (ex: `FF0000`).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Mesclar setores menores que N%* (checkbox) estiver definido como "Habilitado"|
[comment]: # ({/de5a8634-0a101fc7})
[comment]: # ({5ed444e7-eaf18233})
#### Período de tempo
Os seguintes parâmetros são suportados para configurar o *Período de tempo*.
|Parâmetro|<|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-|--------|--|--------|-------------------------------|
|*Período de tempo*|<|1|time_period.\_reference|`DASHBOARD._timeperiod` - define o [seletor de período de tempo](/manual/web_interface/time_period_selector) do dashboard como fonte de dados;
`ABCDE._timeperiod` - define um [widget compatível](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (com o parâmetro *Referência* definido como "`ABCDE`") como fonte de dados.
Padrão: `DASHBOARD._timeperiod`
Alternativamente, você pode definir o período de tempo apenas nos parâmetros *De* e *Até*.|
|<|*De*|1|time_period.from|String de tempo válida na sintaxe absoluta (`YYYY-MM-DD hh:mm:ss`) ou [relativa](/manual/web_interface/time_period_selector) (`now`, `now/d`, `now/w-1w`, etc.).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Período de tempo* não estiver definido
- *obrigatório* se `time_period.to` estiver definido|
|^|*Até*|1|time_period.to|String de tempo válida na sintaxe absoluta (`YYYY-MM-DD hh:mm:ss`) ou [relativa](/manual/web_interface/time_period_selector) (`now`, `now/d`, `now/w-1w`, etc.).
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Período de tempo* não estiver definido
- *obrigatório* se `time_period.from` estiver definido|
[comment]: # ({/5ed444e7-eaf18233})
[comment]: # ({374045cf-14fe7001})
#### Legenda
Os seguintes parâmetros são suportados para configurar a *Legenda*.
|Parâmetro|[tipo](/manual/api/reference/dashboard/object#dashboard-widget-field)|nome|valor|
|-----|-|-----|-------------------|
|*Mostrar legenda*|0|legend|0 - Desabilitado;
1 - *(padrão)* Habilitado.|
|*Mostrar valor*|0|legend_value|0 - *(padrão)* Desabilitado;
1 - Habilitado.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Mostrar legenda* estiver definido como "Habilitado"|
|*Mostrar função de agregação*|0|legend_aggregation|0 - *(padrão)* Desabilitado;
1 - Habilitado.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Mostrar legenda* estiver definido como "Habilitado"|
|*Linhas*|0|legend_lines_mode|0 - *(padrão)* Fixo;
1 - Variável.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Mostrar legenda* estiver definido como "Habilitado"|
|*Número de linhas/*
*Número máximo de linhas*|0|legend_lines|Os valores possíveis variam de 1-10.
Padrão: 1.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Mostrar legenda* estiver definido como "Habilitado"|
|*Número de colunas*|0|legend_columns|Os valores possíveis variam de 1-4.
Padrão: 4.
[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):
- *suportado* se *Mostrar legenda* estiver definido como "Habilitado" e *Mostrar valor* estiver definido como "Desabilitado"|
[comment]: # ({/374045cf-14fe7001})
[comment]: # ({fe51a06c-6e39aeb1})
### Exemplos
Os exemplos a seguir têm como objetivo apenas descrever a configuração dos objetos de campo do widget do dashboard para o widget *Gráfico de pizza*.
Para obter mais informações sobre como configurar um dashboard, consulte [`dashboard.create`](/manual/api/reference/dashboard/create).
[comment]: # ({/fe51a06c-6e39aeb1})
[comment]: # ({965cf4d2-87f20d96})
#### Configurando um widget *Pie chart*
Configure um widget *Pie chart* da seguinte forma:
- 2 conjuntos de dados para um total de 9 items em 1 host.
- O primeiro conjunto de dados é do tipo "Lista de items" e consiste em 3 items, todos do tipo "Normal" e representados por uma cor diferente.
- O segundo conjunto de dados é do tipo "Padrões de items", consiste em 6 items, possui uma agregação configurada para cada item e é representado por uma cor personalizada.
- O segundo conjunto de dados também possui um rótulo de conjunto de dados personalizado.
- Os dados no gráfico de pizza são exibidos como um gráfico de rosca com uma largura personalizada e valor total com unidades no centro.
- Os dados no gráfico de pizza são exibidos e agregados para um período de tempo personalizado das últimas 3 horas.
- A legenda do gráfico de pizza exibe os items configurados em 4 linhas.
[Requisição](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "piechart",
"name": "Pie chart",
"x": 0,
"y": 0,
"width": 24,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "ds.0.dataset_type",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.0",
"value": 23264
},
{
"type": 1,
"name": "ds.0.color.0",
"value": "FF0000"
},
{
"type": 0,
"name": "ds.0.type.0",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.1",
"value": 23269
},
{
"type": 1,
"name": "ds.0.color.1",
"value": "BF00FF"
},
{
"type": 0,
"name": "ds.0.type.1",
"value": 0
},
{
"type": 4,
"name": "ds.0.itemids.2",
"value": 23257
},
{
"type": 1,
"name": "ds.0.color.2",
"value": "0040FF"
},
{
"type": 0,
"name": "ds.0.type.2",
"value": 0
},
{
"type": 1,
"name": "ds.1.hosts.0",
"value": "Zabbix server"
},
{
"type": 1,
"name": "ds.1.items.0",
"value": "*: Number of processed *values per second"
},
{
"type": 1,
"name": "ds.1.color",
"value": "000000"
},
{
"type": 0,
"name": "ds.1.aggregate_function",
"value": 3
},
{
"type": 1,
"name": "ds.1.data_set_label",
"value": "Number of processed values per second"
},
{
"type": 0,
"name": "draw_type",
"value": 1
},
{
"type": 0,
"name": "width",
"value": 30
},
{
"type": 0,
"name": "total_show",
"value": 1
},
{
"type": 0,
"name": "units_show",
"value": 1
},
{
"type": 0,
"name": "graph_time",
"value": 1
},
{
"type": 1,
"name": "time_period.from",
"value": "now-3h"
},
{
"type": 1,
"name": "time_period.to",
"value": "now"
},
{
"type": 0,
"name": "legend_lines",
"value": 4
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}
```
Resposta:
```json
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}
```
[comment]: # ({/965cf4d2-87f20d96})
[comment]: # ({e9d30322-f3cd71ca})
### Veja também
- [Campo do widget do dashboard](/manual/api/reference/dashboard/object#dashboard-widget-field)
- [`dashboard.create`](/manual/api/reference/dashboard/create)
- [`dashboard.update`](/manual/api/reference/dashboard/update)
[comment]: # ({/e9d30322-f3cd71ca})