21 Diagramme circulaire
Description
Ces paramètres et les valeurs de propriété possibles pour les objets de champ du widget de tableau de bord correspondants permettent de configurer le widget Pie chart dans les méthodes dashboard.create et dashboard.update.
Les propriétés fields du widget ne sont pas validées lors de la création ou de la mise à jour d’un tableau de bord.
Cela permet aux utilisateurs de modifier les widgets intégrés et de créer des widgets personnalisés, mais introduit également le risque de créer ou de mettre à jour des widgets de manière incorrecte.
Pour garantir la réussite de la création ou de la mise à jour du widget Pie chart, veuillez vous référer au comportement des paramètres décrit dans les tableaux ci-dessous.
Paramètres
Les paramètres suivants sont pris en charge pour le widget Diagramme circulaire.
| Paramètre | type | name | value |
|---|---|---|---|
| Intervalle d’actualisation | 0 | rf_rate | 0 - Aucune actualisation; 10 - 10 secondes; 30 - 30 secondes; 60 - (par défaut) 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
Ensemble de données
Les paramètres suivants sont pris en charge pour configurer un Ensemble de données.
Le premier nombre dans le nom de la propriété (par exemple, ds.0.hosts.0, ds.0.items.0) représente l'ensemble de données concerné, tandis que le deuxième nombre, s'il est présent, représente le hôte ou l'élément configuré.
| Parameter | type | name | value | |
|---|---|---|---|---|
| Type d'ensemble de données | 0 | ds.0.dataset_type | 0 - Liste d'éléments ; 1 - Motifs d'éléments (par défaut). |
|
| Éléments | 4 | ds.0.itemids.0 | ID de l'élément. Lors de la configuration du widget sur un tableau de bord de modèle, seuls les éléments configurés sur le modèle doivent être définis. Remarque : pour configurer plusieurs éléments, créez un objet de champ de widget de tableau de bord pour chaque élément, avec un nombre incrémenté dans le nom de la propriété. Comportement du paramètre : - obligatoire si le Type d'ensemble de données est défini sur « Liste d'éléments » et si Éléments (Widget) n'est pas défini |
|
| Éléments (Widget) | 1 | ds.0.itemids.0._reference | Au lieu de l'ID de l'élément :ABCDE._itemid - définissez un widget compatible (avec son paramètre Référence défini sur « ABCDE ») comme source de données des éléments.Remarque : pour configurer plusieurs widgets, créez un objet de champ de widget de tableau de bord pour chaque widget, avec un nombre incrémenté dans le nom de la propriété. Comportement du paramètre : - obligatoire si le Type d'ensemble de données est défini sur « Liste d'éléments » et si Éléments n'est pas défini |
|
| Couleur | 1 | ds.0.color.0 | Code couleur hexadécimal (par exemple, FF0000).Comportement du paramètre : - obligatoire si le Type d'ensemble de données est défini sur « Liste d'éléments » |
|
| Type d'élément | 0 | ds.0.type.0 | 0 - Normal (par défaut) ; 1 - Total. La valeur « Total » ne peut être définie que pour un seul élément dans l'ensemble du graphique. Comportement du paramètre : - pris en charge si le Type d'ensemble de données est défini sur « Liste d'éléments » |
|
| Motifs de hôtes | 1 | ds.0.hosts.0 | Nom ou motif de hôte (par exemple, « Zabbix* »). Comportement du paramètre : - obligatoire si le Type d'ensemble de données est défini sur « Motifs d'éléments » Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Motifs d'éléments | 1 | ds.0.items.0 | Nom ou motif d'élément (par exemple, « *: Nombre de *valeurs traitées par seconde »). Lors de la configuration du widget sur un tableau de bord de modèle, seuls les motifs des éléments configurés sur le modèle doivent être définis. Comportement du paramètre : - obligatoire si le Type d'ensemble de données est défini sur « Motifs d'éléments » |
|
| Couleur | 1 | ds.0.color | Code couleur hexadécimal (par exemple, FF0000).Comportement du paramètre : - pris en charge si le Type d'ensemble de données est défini sur « Motifs d'éléments » et si Palette de couleurs n'est pas défini |
|
| Palette de couleurs | 0 | ds.0.color_palette | Index de la palette de couleurs. Les valeurs possibles vont de 0 à 11. Valeur par défaut : 0. Comportement du paramètre : - pris en charge si le Type d'ensemble de données est défini sur « Motifs d'éléments » et si Couleur n'est pas défini |
|
| Fonction d'agrégation | 0 | ds.0.aggregate_function | 1 - min ; 2 - max ; 3 - moyenne ; 4 - nombre ; 5 - somme ; 6 - premier ; 7 - dernier (par défaut). |
|
| Agrégation de l'ensemble de données | 0 | ds.0.dataset_aggregation | 0 - aucune (par défaut) ; 1 - min ; 2 - max ; 3 - moyenne ; 4 - nombre ; 5 - somme. Comportement du paramètre : - pris en charge si le Type d'élément est défini sur « Total » |
|
| Libellé de l'ensemble de données | 1 | ds.0.data_set_label | Toute valeur de chaîne. Valeur par défaut : "" (vide). |
|
| Étiquettes d'éléments | ||||
| Type d'évaluation | 0 | ds.0.item_tags_evaltype | 0 - Et/Ou (par défaut) ; 2 - Ou. |
|
| Nom de l'étiquette | 1 | ds.0.item_tags.0.tag | Toute valeur de chaîne. Remarque : le nombre dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes. Comportement du paramètre : - obligatoire lors de la configuration des Étiquettes d'éléments |
|
| Opérateur | 0 | ds.0.item_tags.0.operator | 0 - Contient ; 1 - Est égal à ; 2 - Ne contient pas ; 3 - N'est pas égal à ; 4 - Existe ; 5 - N'existe pas. Remarque : le nombre dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes. Comportement du paramètre : - obligatoire lors de la configuration des Étiquettes d'éléments |
|
| Valeur de l'étiquette | 1 | ds.0.item_tags.0.value | Toute valeur de chaîne. Remarque : le nombre dans le nom de la propriété fait référence à l'ordre de l'étiquette dans la liste d'évaluation des étiquettes. Comportement du paramètre : - obligatoire lors de la configuration des Étiquettes d'éléments |
|
Options d’affichage
Les paramètres suivants sont pris en charge pour configurer les options d’affichage.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Sélection des données d’historique | 0 | source | 0 - (par défaut) Automatique ; 1 - Historique ; 2 - Tendances. |
|
| Dessiner | 0 | draw_type | 0 - (par défaut) Secteurs ; 1 - Anneau. |
|
| Largeur | 0 | width | 20 - 20 % du rayon ; 30 - 30 % du rayon ; 40 - 40 % du rayon ; 50 - (par défaut) 50 % du rayon. Comportement du paramètre : - pris en charge si Dessiner est défini sur « Anneau » |
|
| Largeur du contour | 0 | stroke | Les valeurs possibles vont de 0 à 10. Valeur par défaut : 0. Comportement du paramètre : - pris en charge si Dessiner est défini sur « Anneau » |
|
| Afficher la valeur totale | 0 | total_show | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Dessiner est défini sur « Anneau » |
|
| Taille | 0 | value_size_type | 0 - (par défaut) Automatique ; 1 - Personnalisée. Comportement du paramètre : - pris en charge si Afficher la valeur totale est défini sur « Activé » |
|
| Taille (valeur pour la taille personnalisée) | 0 | value_size | Les valeurs possibles vont de 1 à 100. Valeur par défaut : 20. Comportement du paramètre : - pris en charge si Afficher la valeur totale est défini sur « Activé » |
|
| Décimales | 0 | decimal_places | Les valeurs possibles vont de 0 à 6. Valeur par défaut : 2. Comportement du paramètre : - pris en charge si Afficher la valeur totale est défini sur « Activé » |
|
| Unités (case à cocher) | 0 | units_show | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Afficher la valeur totale est défini sur « Activé » |
|
| Unités (valeur) | 1 | units | Toute valeur de type chaîne. Comportement du paramètre : - pris en charge si Unités (case à cocher) est défini sur « Activé » |
|
| Gras | 0 | value_bold | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Afficher la valeur totale est défini sur « Activé » |
|
| Couleur | 1 | value_color | Code couleur hexadécimal (par exemple, FF0000).Comportement du paramètre : - pris en charge si Afficher la valeur totale est défini sur « Activé » |
|
| Espace entre les secteurs | 0 | space | Les valeurs possibles vont de 0 à 10. Valeur par défaut : 1. |
|
| Fusionner les secteurs inférieurs à N % (case à cocher) | 0 | merge | 0 - (par défaut) Désactivé ; 1 - Activé. |
|
| Fusionner les secteurs inférieurs à N % (valeur) | 0 | merge_percent | Les valeurs possibles vont de 1 à 10. Valeur par défaut : 1. Comportement du paramètre : - pris en charge si Fusionner les secteurs inférieurs à N % (case à cocher) est défini sur « Activé » |
|
| Fusionner les secteurs inférieurs à N % (couleur) | 1 | merge_color | Code couleur hexadécimal (par exemple, FF0000).Comportement du paramètre : - pris en charge si Fusionner les secteurs inférieurs à N % (case à cocher) est défini sur « Activé » |
|
Période de temps
Les paramètres suivants sont pris en charge pour configurer la Période de temps.
| Paramètre | type | name | value | |
|---|---|---|---|---|
| Période de temps | 1 | time_period._reference | DASHBOARD._timeperiod - définit le sélecteur de période de temps du tableau de bord comme source de données ;ABCDE._timeperiod - définit un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données.Par défaut : DASHBOARD._timeperiodVous pouvez également définir la période de temps uniquement dans les paramètres From et To. |
|
| From | 1 | time_period.from | Chaîne de temps valide en syntaxe temporelle absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période de temps n’est pas défini - obligatoire si time_period.to est défini |
|
| To | 1 | time_period.to | Chaîne de temps valide en syntaxe temporelle absolue (YYYY-MM-DD hh:mm:ss) ou relative (now, now/d, now/w-1w, etc.).Comportement du paramètre : - pris en charge si Période de temps n’est pas défini - obligatoire si time_period.from est défini |
|
Légende
Les paramètres suivants sont pris en charge pour configurer la Légende.
| Paramètre | type | name | value |
|---|---|---|---|
| Afficher la légende | 0 | legend | 0 - Désactivé ; 1 - (par défaut) Activé. |
| Afficher la valeur | 0 | legend_value | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
| Afficher la fonction d’agrégation | 0 | legend_aggregation | 0 - (par défaut) Désactivé ; 1 - Activé. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
| Lignes | 0 | legend_lines_mode | 0 - (par défaut) Fixe ; 1 - Variable. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
| Nombre de lignes/ Nombre maximal de lignes |
0 | legend_lines | Les valeurs possibles vont de 1 à 10. Valeur par défaut : 1. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » |
| Nombre de colonnes | 0 | legend_columns | Les valeurs possibles vont de 1 à 4. Valeur par défaut : 4. Comportement du paramètre : - pris en charge si Afficher la légende est défini sur « Activé » et Afficher la valeur sur « Désactivé » |
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ de widget de tableau de bord pour le widget Pie chart.
Pour plus d’informations sur la configuration d’un tableau de bord, consultez dashboard.create.
Configuration d’un widget Camembert
Configurez un widget Camembert de la manière suivante :
- 2 jeux de données pour un total de 9 éléments sur 1 hôte.
- Le premier jeu de données est de type « Liste d’éléments » et se compose de 3 éléments, tous de type « Normal » et représentés par une couleur différente.
- Le second jeu de données est de type « Modèles d’éléments », se compose de 6 éléments, possède une agrégation configurée pour chaque élément et est représenté par une couleur personnalisée.
- Le second jeu de données possède également un libellé de jeu de données personnalisé.
- Les données du graphique circulaire sont affichées sous forme de diagramme en anneau avec une largeur personnalisée et la valeur totale avec les unités au centre.
- Les données du graphique circulaire sont affichées et agrégées pour une période personnalisée correspondant aux 3 dernières heures.
- La légende du graphique circulaire affiche les éléments configurés sur 4 lignes.
Requête :
{
"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
}
Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}