20 Arborescence de navigation des cartes

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 Arborescence de navigation des cartes 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 Arborescence de navigation des cartes, 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 Arborescence de navigation des cartes.

Paramètre type name value
Intervalle d’actualisation 0 rf_rate 0 - Aucune actualisation;
10 - 10 secondes;
30 - 30 secondes;
60 - 1 minute;
120 - 2 minutes;
600 - 10 minutes;
900 - (par défaut) 15 minutes.
Afficher les cartes indisponibles 1 show_unavailable 0 - (par défaut) Désactivé;
1 - Activé.
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 dans le tableau de bord auquel appartient le widget.

Comportement des paramètres :
- obligatoire

Les paramètres suivants sont pris en charge pour configurer les éléments de l’arborescence de navigation des cartes.

Paramètre type name value
Nom 1 navtree.1.name Toute valeur de chaîne.

Remarque : Le numéro dans le nom de la propriété définit le numéro de l’élément.
Carte liée 8 navtree.1.sysmapid ID de la carte.

Remarque : Le numéro dans le nom de la propriété fait référence à l’élément auquel la carte est liée.
Paramètres de création de la hiérarchie des éléments 0 navtree.1.parent Numéro de l’élément parent.

Remarque : Le numéro dans le nom de la propriété fait référence à l’élément enfant. La valeur de la propriété fait référence à l’élément parent.
0 navtree.1.order Position de l’élément dans l’arborescence de navigation des cartes.

Remarque : Le numéro dans le nom de la propriété fait référence au numéro de l’élément. La valeur de la propriété fait référence à la position de l’élément dans l’arborescence de navigation des cartes. La position de l’élément parent est déterminée dans l’ensemble de l’arborescence de navigation des cartes. La position de l’élément enfant est déterminée au sein de l’élément parent.

Exemples

Les exemples suivants visent à décrire uniquement la configuration des objets de champ du widget de tableau de bord pour le widget Arborescence de navigation de carte. Pour plus d'informations sur la configuration d'un tableau de bord, consultez dashboard.create.

Configuration d’un widget Map navigation tree

Configurez un widget Map navigation tree qui affiche l’arborescence de navigation de cartes suivante :

  • Élément A
    • Élément A1
    • Élément A2
  • Élément B
    • Élément B1 (contient la carte liée « 1 » qui peut être affichée dans un widget Map lié)
    • Élément B2
  • Élément C

Requête :

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "navtree",
                        "name": "Map navigation tree",
                        "x": 0,
                        "y": 0,
                        "width": 18,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "navtree.1.name",
                                "value": "Element A"
                            },
                            {
                                "type": 1,
                                "name": "navtree.2.name",
                                "value": "Element B"
                            },
                            {
                                "type": 1,
                                "name": "navtree.3.name",
                                "value": "Element C"
                            },
                            {
                                "type": 1,
                                "name": "navtree.4.name",
                                "value": "Element A1"
                            },
                            {
                                "type": 1,
                                "name": "navtree.5.name",
                                "value": "Element A2"
                            },
                            {
                                "type": 1,
                                "name": "navtree.6.name",
                                "value": "Element B1"
                            },
                            {
                                "type": 1,
                                "name": "navtree.7.name",
                                "value": "Element B2"
                            },
                            {
                                "type": 0,
                                "name": "navtree.4.parent",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "navtree.5.parent",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "navtree.6.parent",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "navtree.7.parent",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "navtree.1.order",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "navtree.2.order",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "navtree.3.order",
                                "value": 3
                            },
                            {
                                "type": 0,
                                "name": "navtree.4.order",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "navtree.5.order",
                                "value": 2
                            },
                            {
                                "type": 0,
                                "name": "navtree.6.order",
                                "value": 1
                            },
                            {
                                "type": 0,
                                "name": "navtree.7.order",
                                "value": 2
                            },
                            {
                                "type": 8,
                                "name": "navtree.6.sysmapid",
                                "value": 1
                            },
                            {
                                "type": 1,
                                "name": "reference",
                                "value": "HJQXF"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Voir également