Présentation

Un widget est un élément permettant d'afficher une ou plusieurs informations.

L'affichage d'un widget se fait via une grille ( Voir la page Configurer la grille - Édition JSON - Météo ).

Il existe plusieurs types de widgets :

Description

Ajout d'un nouveau widget

Dans le format, JSON, le rajout d'un nouveau widget se fait au niveau de la partie "grid_elements".

...    
"grid_elements": [
	{
		DEFINITION DU WIDGET 1
    },
	{
        DEFINITION DU WIDGET 2
    },
    ...
]
...

Définition d'un Widget

Paramètres des widgets

Les widgets vont être définis à l'aide de paramètres composés d'une clé et d'une valeur.


...
    {
		"position_x": 0,
        "position_y": 3,
        ...
        }
	},
...


Un paramètre peut être non défini, mais avoir une valeur :

  • Si le paramètre n'est pas présent dans le JSON ou s'il existe, mais que sa valeur est égale à "default", la météo va le considérer comme ayant une valeur non définie et va calculer sa valeur par défaut ( voir le chapitre suivant ).


Calcul de la valeur d'un paramètre en cascade

La valeur d'un paramètre peut être définie à 3 niveaux différents :

  • Dans le widget ( servira uniquement pour ce widget ) ;
  • Dans le niveau "layout" d'une grille ( servira de valeur par défaut pour ce paramètre dans cette grille ) ;
  • Dans les "fichiers de configurations" de la météo ( servira de valeur par défaut pour ce paramètre dans toutes les météos ) ;


La valeur d'un paramètre sera déterminée en parcourant les 3 niveaux dans l'ordre jusqu'à ce qu'il trouve une valeur définie

  1. le niveau "widget",
  2. le niveau "layout" de la grille,
  3. le niveau "fichier de configuration ".


Remarque :

  • Le module de météo dispose de valeur par défaut.
    • Si un paramètre n'est défini dans aucun des trois niveaux précédents, le module de météo utilisera sa valeur par défaut.
  • Il est donc déconseillé de se baser dessus, car au fil des livraisons, Shinken pourrait être amené à changer ces valeurs.

( voir la page Édition des valeurs par défaut - Widgets - JSON - Météo )