Page History

Qu'est ce que le format JSON

La configuration de la vue météo des services doit être écrite au format JSON.

Le format JSON est un format qui permet de stocker des données de façon organisées et lisible par un humain. Plusieurs règles s'appliquent à ce format :

• Il ne peut y avoir qu'un élément racine, c'est-à-dire un élément qui va contenir toutes les données.
• Les données peuvent être organisées soit dans un objet soit dans un tableau.
• Un objet commence par "{" et finie par "}" et 
• un Un tableau commence par "[" et termine par "]"
• Les propriétés sont formées d'un couple clé/valeurs que l'on affiche sous forme ( clé : "valeurs").
• Le séparateur de chaque propriété est la virgule. Les propriétés qui sont définies en dernier d'un objet ou d'une liste ne DOIVENT PAS se terminer avec une virgule.
• L'imbrication de  deux mêmes types de blocs est possible par exemple : un objet dans un objet ou un tableau dans un tableau

Valeurs possibles :

• Les propriétés : un nombre, un booléen, une chaine de caractères, un tableau, un objet ou bien null
• Les tableaux : des tableaux, des objets ou une propriété séparés par des virgules.
• Les objets : des propriétés séparées par des virgules

Affichage de configuration de la formulaire

Dans le formulaire de configuration de la météo des services, la colorisation syntaxique est la suivante :

• Le nom des propriétés est affiché en : bleu
• Les valeurs apparaissent :
  • en blanc quand l'utilisateur a édité une valeur
  • en violet quand c'est la valeur par défaut 

Indentation

Le format JSON étant un format où les propriétés sont imbriquées les unes par rapport aux autres, cela se matérialise en JSON par une indentation entre les blocs, cette indentation est visualisée à l'aide de trait vertical dans le formulaire de configuration.

Cela permet aux utilisateurs de mieux visualiser la fin de chaque indentation.

Actions possibles dans la zone d'édition

Comportement du copier/coller

Vous pouvez dans le formulaire effectuer des copier-coller à l'aide de la souris ou en passant par les raccourcis clavier CTRL+ C et CTRL+ V.

Si vous souhaitez copier toute la configuration sans passer par le bouton de copie du formulaire , nous vous conseillons de faire les raccourcis clavier suivant : CTRL+ A puis CTRL+ C

Si vous souhaitez coller une configuration éditée depuis un éditeur externe, le texte apparaitra sans la coloration syntaxique et sans indentation. Pour retrouver un affichage correct, nous vous invitons à cliquer le bouton  

Barre de défilement

Les barres de défilement verticales et horizontales sont en permanence affichées afin de permettre à l'utilisateur de pouvoir continuer de configurer même si la configuration prend plus de place sur la largeur ou la hauteur. 

Affichages des erreurs de Syntaxe du JSON

Colorisations syntaxique

Une clé ou une valeur avec une couleur de fond rouge indique que la clé ou la valeur est en erreur. Pour connaitre la nature de l'erreur référez-vous à l'encadré rouge au dessus du formulaire d'édition.

Bulle d'information

Lorsque la clé est en erreur un bulle d'information est affiché au survol de la zone pour indiquer quel est la nature de l'erreur

Localiser les erreurs

Lorsqu'une erreur est présent dans la configuration, vous pouvez facilement localiser la propriété en erreur en cliquant sur le bouton "localiser le widget concerné" lorsque l'erreur concerne un widget ou sur le bouton .