7 Géocarte
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 Geomap 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 Geomap, 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 Geomap.
| Parameter | 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. |
|
| Groupes d'hôtes | 2 | groupids.0 | ID du groupe d'hôtes. Remarque : pour configurer plusieurs groupes d'hôtes, créez un objet de champ de widget de tableau de bord pour chaque groupe d'hôtes, avec un numéro incrémenté dans le nom de la propriété. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Groupes d'hôtes (widget) | 1 | groupids._reference | Au lieu de l'ID du groupe d'hôtes :ABCDE._hostgroupids - définissez un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données des groupes d'hôtes.Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Hôtes | 3 | hostids.0 | ID de l'hôte. Remarque : pour configurer plusieurs hôtes, créez un objet de champ de widget de tableau de bord pour chaque hôte, avec un numéro incrémenté dans le nom de la propriété. Pour plusieurs hôtes, le paramètre Groupes d'hôtes doit soit ne pas être configuré, soit être configuré avec au moins un groupe d'hôtes auquel appartiennent les hôtes configurés. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Hôtes (widget/tableau de bord) | 1 | hostids._reference | Au lieu de l'ID de l'hôte :DASHBOARD.hostids - définissez le sélecteur d'hôtes du tableau de bord comme source de données des hôtes ;ABCDE._hostids - définissez un widget compatible (avec son paramètre Reference défini sur "ABCDE") comme source de données des hôtes.Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Étiquettes | ||||
| Type d'évaluation | 0 | evaltype | 0 - (par défaut) Et/Ou ; 2 - Ou. Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Nom de l'étiquette | 1 | tags.0.tag | Toute valeur de chaîne. Remarque : le numéro 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 Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Opérateur | 0 | 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 numéro 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 Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Valeur de l'étiquette | 1 | tags.0.value | Toute valeur de chaîne. Remarque : le numéro 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 Ce paramètre n'est pas pris en charge lors de la configuration du widget sur un tableau de bord de modèle. |
|
| Vue initiale | 1 | default_view | latitude, longitude, niveau de zoom séparés par des virgules (facultatif, les valeurs possibles vont de 0 à 30). Exemple : 40.6892494,-74.0466891,10. |
|
| Regroupement | ||||
| Mode de regroupement | 0 | clustering_mode | 0 - (par défaut) Automatique ; 1 - Niveau de zoom. |
|
| Niveau de zoom du regroupement | 0 | clustering_zoom_level | Les valeurs possibles vont de 0 à 30. Valeur par défaut : 0. Comportement du paramètre : - pris en charge si le Mode de regroupement est défini sur « Niveau de zoom » |
|
| Référence | 1 | reference | Toute valeur de chaîne composée de 5 caractères (par exemple, ABCDE ou JBPNL). Cette valeur doit être unique au sein du tableau de bord auquel appartient le widget.Comportement du paramètre : - obligatoire |
|
Exemples
Les exemples suivants visent uniquement à décrire la configuration des objets de champ du widget de tableau de bord pour le widget Geomap.
Pour plus d’informations sur la configuration d’un tableau de bord, voir dashboard.create.
Configuration d’un widget Geomap
Configurez un widget Geomap qui affiche les hôtes des groupes d’hôtes « 2 » et « 22 » en fonction de la configuration de tags suivante : le tag nommé « component » contient la valeur « node », et le tag nommé « location » est égal à la valeur « New York ». De plus, définissez la vue initiale de la carte sur les coordonnées « 40.6892494 » (latitude), « -74.0466891 » (longitude) avec le niveau de zoom « 10 ».
Requête :
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "geomap",
"name": "Geomap",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 2,
"name": "groupids.0",
"value": 22
},
{
"type": 2,
"name": "groupids.1",
"value": 2
},
{
"type": 1,
"name": "default_view",
"value": "40.6892494,-74.0466891,10"
},
{
"type": 0,
"name": "evaltype",
"value": 2
},
{
"type": 1,
"name": "tags.0.tag",
"value": "component"
},
{
"type": 0,
"name": "tags.0.operator",
"value": 0
},
{
"type": 1,
"name": "tags.0.value",
"value": "node"
},
{
"type": 1,
"name": "tags.1.tag",
"value": "location"
},
{
"type": 0,
"name": "tags.1.operator",
"value": 1
},
{
"type": 1,
"name": "tags.1.value",
"value": "New York"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"3"
]
},
"id": 1
}