Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=clean_macro_parameter
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmlfalse
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
Panel
titleSommaire

Table of Contents
stylenone

Qu'est ce que le

format JSONLa 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 lisibles 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 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  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 les propriétés :
    • un nombre( 1, 2, ... ),
    • un booléen( true, false ) ,
    • 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
    • ( "default", "mon nom de widget" ),
  • les tableaux ( [ ... ] ),
  • les objets ( { ... } ).

Pour la modification du JSON, il est conseillé :

  • d'utiliser un éditeur de texte spécialisé ( Cela permettra d'avoir la détection d’erreur du langage JSON,voir la page JSON d'exemple pour commencer - Édition JSON - Météo ),
  • de faire les modifications sur celui-ci,
  • puis de copier-coller l'intégralité du JSON dans la fenêtre d'édition de la météo.

Repérer un élément dans la configuration JSON

Lorsque l'éditeur JSON de la configuration de la météo est ouvert, le clic sur le bouton Image Added d'un widget permet se déplacer plus facilement sur le bloc JSON définissant le widget. 


Panel

Image Added

Affichage des définitions d'éléments dans l'éditeur


Dans le formulaire de configuration de la météo des services, la

colorisation

coloration syntaxique est la suivante :

Le
  • 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 
    • défaut.


Panel
titleExtraire d'une configuration JSON

Image Modified

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.


Panel
Image Removed

Image Added

Actions possibles dans la zone d'édition

Comportement du copier

Copier /

collerVous pouvez dans le formulaire effectuer des copier-coller

Coller  

  • Il est possible de copier toute la configuration de la météo, en cliquant sur le bouton qui apparait à 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 Image Removed, nous vous conseillons de faire les raccourcis clavier suivant : CTRL+ A puis CTRL+ C

Si vous souhaitez coller une configuration
  • , en survolant le formulaire JSON.
  • Il est possible de copier une partie en sélectionnant une partie du texte et en utilisant le raccourci clavier Ctrl + C.
Panel

Image Added

  • Il est possible aussi de coller tout ou une partie du JSON, à l'aide du raccourci clavier Ctrl +V.
  • Après avoir collé une configuration ( éditée depuis un éditeur externe par exemple ), le texte apparaitra sans la coloration syntaxique et sans indentation.
  • Pour retrouver un affichage
correct, nous vous invitons à cliquer le bouton Image Removed 
Panel
titleConfiguration coller depuis un éditeur externe

Image Removed

  • correspondant au nouveau contenu du JSON copier, il faudra cliquer sur le bouton Image Added.
Panel

Image Added

Affichages des problèmes de configuration

Coloration

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. 

Panel

Image Removed

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"problème".

  • Pour connaitre la nature
de l'erreur référez-vous
  • du problème, il faut se référer à l'encadré rouge au-dessus du formulaire d'édition.
Panel
titleExemple de valeur en
erreur
problème
Image Removed

Image Added

Panel
titleExemple de clé en
erreur
problème

Image Added

Image Removed
Info

Lorsqu'une clé est

en erreur

à un problème, c'est

tout le bloc de configuration qui apparait

toute la partie concernant cette clé qui apparaitra en rouge.

Bulle d'information

Lorsque la clé ou valeur est en

erreur un

problème, une bulle d'information est

affiché

affichée au survol de la zone pour indiquer

quel

quelle est la nature

de l'erreur

du problème.


Panel
Image Removed

Image Added

Localiser les

erreurs

problèmes


Lorsqu'

une erreur

un problème 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 Image Removed

de la météo, cliquer sur le texte JSON fera défiler le JSON jusqu'à l'endroit où le problème se situe, permettant ainsi de facilement localiser la propriété.

Panel
Image Removed

Image Added