data2list

Cette action fait partie du groupe d'actions gérant l'affichage de données JSON, XML ou CSV issues d'un fichier sur le serveur ou récupérées avec l'API d'un site web. Un mécanisme de cache permet de limiter les interrogations du serveur distant. Très pratique pour les sites avec une formule gratuite limitée en nombre d'appels.

• data2list : sous forme d'une liste arborescente
• data2table : dans un tableau HTML
• data-info : selon votre modèle de mise en page

Ces actions utilisent les mêmes principes et options que vous pouvez décoouvrir à l'aide des boutons bleus ci-dessous.

Informations sur les sources de données utilisables Explications détaillées sur les options des 3 actions data...

Un exemple simple

Nous voulons afficher les données des villes partageant le même code postal en utilisant les données fournies le site geo.api.gouv.fr

Le shortcode

{up data2list=https://geo.api.gouv.fr/communes?codePostal=13600}

L'option principale du shortcode est l'url vers les données. Voir la documentation sur geo.api.gouv.fr/decoupage-administratif/communes

Améliorer la présentation

Le principal reproche que l'on peut faire au résultat précédent est la présence des indices des tableaux que l'on voit aussi dans la source de données.

Pour éviter cela, l'action data2list propose 2 options : col-type et array-subtitle.
Voyons-les en action avec ce shortcode.

{up treeview}
  {up data2list=images/actions-demo/data/communes-01460.json
   | array-subtitle=root:[b]##nom##[/b] (##codesPostaux/0##)
   | col-type=codesPostaux:compact, population:##num## hab., siren:mask ###-###-###
   | col-empty=population:[span class="t-red"]aucun habitant[/span]
  }
{/up treeview}

• l'option array-subtitle substitue l'indice du tableau par le contenu du champ nom et de la première valeur de codesPostaux.
  L'argument est composé du mot "root" pour indiquer que la règle s'applique à la racine du tableau, suivi d'un double-point, puis d'un modèle décrivant le contenu attendu au format bbcode.
  On indique le nom des champs entre 2 double dièses selon la méthode habituelle avec UP.
  Si la valeur désirée n'est pas un enfant direct, on indique le chemin en séparant les champs par des slash (voir codesPostaux). 
  Cette option accepte plusieurs règles en les séparant par des virgules. Pour les sous-tableaux dont les éléments sont des sous-tableaux, on utilise le nom du champ parent à la place de root.
• l'option col-type spécifie le traitement à apporter au contenu du champ.
  Dans notre exemple, nous voulons que le tableau interne de codesPostaux soit converti en chaîne et que la valeur du champ population soit exprimée avec un espace tous les milliers, puis suivie du mot 'hab.'.  Pour siren, le mot-clé mask introduit le modèle de présentation. Plus d'informations sur les options des 3 actions data
• l'option col-empty indique le texte à utiliser si la valeur est zéro ou vide pour le champ "population". La démo utilise une version modifiée des données avec une population à zéro pour "Brion".

Sélectionner les données

Il est possible de limiter les données à la ville de Nantua OU de Montréal-la-Cluse en les spécifiant dans une option select.
Juste pour montrer l'usage du ET, il faut également que ces 2 villes soient dans la région 84.

l'option col-exclude permet de ne pas afficher certains champs et col-label permet de renommer les champs.

{up data2list=https://geo.api.gouv.fr/communes?codePostal=01460
| lign-select=nom:NANTUA; Montréal-la-Cluse , codeRegion:84
| col-exclude=codeDepartement, codeEpci
| col-label=code:code INSEE, codesPostaux:CP
| array-subtitle=root:[b]##nom##[/b] (##codesPostaux/0##)
| fields-type=codesPostaux:compact, population:##num## hab.}

Une variante pour montrer la sélection par l'indice des lignes (la première et la dernière) et l'usage de l'option col-include.

{up data2list=https://geo.api.gouv.fr/communes?codePostal=01460
| lign-select=1,-1
| col-include=population
| array-subtitle=root:[b]##nom##[/b] (##codesPostaux/0##)
| fields-type=population:%s hab.}