Conception de rapports

Les rapports sont, dans les termes les plus simples, créés en remplissant un modèle de rapport avec des données textuelles et/ou spatiales provenant d’un ou de plusieurs travaux. Il est important de noter que les rapports sont générés au niveau de la couche/bande et que le nombre de rapports d’un seul travail correspondra au nombre de bandes par défaut pour le travail en question.

La conception des rapports est un processus en deux étapes qui implique :

  1. Conception de modèles à l’aide du cadre de mise en page de QGIS ;

  2. Spécifier les paramètres de configuration dans un fichier de configuration de rapport.

Conditions préalables

Avant de se lancer dans la conception de nouveaux rapports ou la personnalisation de rapports existants, il est recommandé de se familiariser avec les sujets suivants :

Variables d’expression de mise en page

Un rapport est composé de contenu statique (comme des logos, du texte d’avertissement, etc.) qui ne change pas d’un rapport à l’autre. Il peut également inclure du contenu dynamique (comme des cartes ou des informations sur les attributs) qui est généré au moment de l’exécution du rapport.

La boîte à outils Trends.Earth fournit un certain nombre de variables d’expression de mise en page qui peuvent être utilisées pour insérer du contenu dynamique dans une mise en page. Certaines de ces variables sont disponibles au moment de la conception, tandis que d’autres ne sont disponibles qu’au moment de l’exécution. Le tableau ci-dessous fournit un résumé des variables disponibles.

Variables d’emploi

Celles-ci sont caractérisées par un préfixe te_job_ et ne sont disponibles qu’au moment de l’exécution.

Nom de la variable

Description

Type de données

te_job_id

Identifié unique correspondant à l’UUID de la tâche.

Chaîne de caractères

te_job_input_params

Représentation JSON des paramètres d’entrée d’une tâche

Chaîne de caractères

te_job_paths

Chemin local vers le(s) jeu(x) de données de la tâche

Chaîne de caractères

te_job_alg_name

Nom de l’algorithme du travail

Chaîne de caractères

te_job_creation_date

Date/heure de création d’un travail

Chaîne au format %Y-%m-%d %H:%M

te_job_status

État d’achèvement d’un travail, par exemple : TELECHARGÉ, GENERÉ_LOCALEMENT, etc.

Chaîne de caractères

te_job_name

Nom de l’emploi tel que saisi par l’utilisateur.

Chaîne de caractères

te_job_comments

Commentaires sur un travail tels que fournis par l’utilisateur

Chaîne de caractères

Variables de couche

Ils sont caractérisés par un préfixe te_current_layer_ et ne sont disponibles qu’au moment de l’exécution.

Nom de la variable

Description

Type de données

te_current_layer_name

Nom de la couche dans le contexte d’exécution actuel

Chaîne de caractères

Variables des paramètres du rapport

Ils sont caractérisés par un préfixe te_report_ et sont disponibles à la fois au moment de la conception et de l’exécution. Reportez-vous à la section Rapports pour une description détaillée des paramètres de rapport et des noms de variables correspondants.

Types de modèles

Il existe deux principaux types de modèles de rapports :

Modèle complet

Il est conçu pour contenir – ou permettre d’inclure – des informations supplémentaires telles que le nom de l’auteur. Le modèle par défaut est établi sur une page A4 et comprend un titre de mise en page, une carte, une légende, une barre d’échelle, une flèche orientée au nord, un texte d’avertissement et un logo.

Modèle simple

Il s’agit d’une version allégée du modèle, le modèle par défaut étant réglé sur une taille de page de 83 mm sur 59 mm (en mode paysage) ou vice versa en mode portrait. Il contient une carte, une légende, une flèche orientée au nord, une barre d’échelle, un texte d’avertissement et un logo.

Note

Pour chaque type de modèle, vous devrez fournir les versions portrait et paysage, car la boîte à outils sélectionnera l’une d’entre elles en fonction des dimensions de la couche cartographique à restituer.

Conception de modèles de rapports

Vous pouvez créer des modèles soit en :

Créant un nouveau

  1. Naviguez vers Projet > Nouvelle mise en page d’impression….

    ../../_images/report_new_layout.png
  2. Spécifiez un nom convivial pour la mise en page.

    ../../_images/report_template_name.png

Modifiant un modèle existant

  1. Naviguez vers ** Projet > Gestionnaire de mise en page… **.

    ../../_images/report_project_layout_manager.png
  2. Sélectionnez Spécifique dans le menu déroulant sous la section Nouveau à partir du modèle.

    ../../_images/report_layout_manager_specific.png
  3. Cliquez sur le bouton parcourir (avec trois points) pour sélectionner un modèle QPT existant. Le modèle par défaut se trouve dans [base_data_directory]/reports/templates.

    ../../_images/report_layout_manager_browse.png
  4. Cliquez sur le bouton Créer….

    ../../_images/report_layout_manager_create.png
  5. Spécifiez un nom convivial pour le modèle.

    ../../_images/report_template_name.png

Ajouter un élément de mise en page

  • Vous pouvez ajouter des éléments au modèle de la même façon que celle définie dans le QGIS manual. Les variables d’expression Trends.Earth sont disponibles dans la boîte de dialogue Constructeur d’expressions et peut être insérée dans un élément d’étiquette comme toute autre variable QGIS.

    ../../_images/report_expression_builder.png
  • Par exemple, pour insérer un nom d’algorithme pour une tâche dans un élément d’étiquette, vous pouvez utiliser l’expression suivante : [% @te_job_alg_name %].

    ../../_images/report_label_expression.png
  • Pour un projet de carte, n’ajoutez pas de calques ou ne spécifiez pas de thème de carte, car les calques et leur ordre sont automatiquement définis lors de la génération du rapport.

  • Lorsque vous utilisez des éléments schématiques, assurez-vous que l’option Mise à jour automatique est sélectionnée. La boîte à outils détermine quels éléments de légende afficher/masquer en fonction du contexte de rendu.

    ../../_images/report_legend_auto_update.png
  • Pour les éléments de carte qui rendent les couches de travail ou les éléments d’étiquette qui utilisent des variables d’expression de la boîte à outils, assurez-vous que leurs identifiants d’élément respectifs sont définis afin qu’ils soient marqués pour la mise à jour pendant la génération du rapport. La Convention de dénomination préférée pour l’identifiant du projet est [item_type.context_name], par exemple : label.layer_name, label.job_alg_name, map.main. Nous apprendrons comment utiliser ces ID d’élément dans la section : item_scope_mapping.

    ../../_images/report_item_id.png

Configurer les paramètres du rapport

L’étape suivante consiste à définir quels modèles seront utilisés pour quels algorithmes. Ceci est fait à partir du modèle de profil de rapport -templates.json- créé dans [base_data_directory]/reports/templates lors du premier chargement de la boîte à outils.

templates.json est une liste d’objets de configuration de rapport, chacun correspondant à un ou plusieurs Scopes. Dans ce cas, la portée fait référence à l’algorithme. La configuration se compose de deux parties :

  • template_info - Contient des informations sur les modèles de rapport QGIS associés à une ou plusieurs plages d’algorithmes.

  • output_options - Options de sortie pour l’exportation des rapports.

Voir l’exemple suivant :

 {
   "template_info":{
      "id":"70ca4be7-839e-4248-be14-34ba8665ed98",
      "name":"Land Productivity",
      "description":"Overview of land productivity indicator.",
      "simple_portrait_path":"simple_layout_template_portrait.qpt",
      "simple_landscape_path":"simple_layout_template_landscape.qpt",
      "full_portrait_path":"full_layout_template_portrait.qpt",
      "full_landscape_path":"full_layout_template_landscape.qpt",
      "item_scopes":[
         {
            "name":"productivity",
            "type_id_mapping":{
               "map":["map.main"],
               "label":["label.layer_title"]
            }
         }
      ]
   },
   "output_options":{
      "template_type": "ALL",
      "formats": [
         {
            "format_type": "PDF"
         },
         {
            "format_type": "IMAGE",
            "params": {
               "image_type": "png"
            }
         }
      ]
   }
}

template_info

Contient des informations sur les modèles de rapport QGIS associés à une ou plusieurs plages d’algorithmes.

Nom de la propriété

Description

Requis

id

Un identifiant UUID unique au format de chaîne

Oui

name

Un nom convivial pour la configuration du modèle

Non

description

Brève description de la configuration du modèle

Non

simple_portrait_path

Nom du fichier modèle pour une disposition verticale simple

Oui

simple_landscape_path

Nom du fichier modèle pour une disposition horizontale simple

Oui

full_portrait_path

Nom du fichier modèle pour la disposition verticale complète

Oui

full_landscape_path

Nom du fichier modèle pour la disposition horizontale complète

Oui

item_scopes

Liste des objets de portée du projet. Il devrait contenir au moins une définition de la portée.

Pour plus de détails, voir : item_scope_mapping.

Oui

Note

Le chemin défini ci-dessus est essentiellement le nom du fichier par rapport à l’emplacement du modèle templates.json.

output_options

Options pour exporter les rapports de sortie.

Nom de la propriété

Description

Requis

formats

Une liste des éléments de format indiquant le format d’exportation du rapport. Votre rapport peut être exporté vers de multiples formats comme PDF et PNG.

Vous devez définir au moins un format d’exportation.

Voir output_format pour les options de configuration des éléments de format d’exportation.

Oui

template_type

Type de modèle de rapport au format string.

Les options supportées incluent : SIMPLE, ENTIER ou TOUT.

Veuillez noter que ceux-ci doivent être en majuscules comme indiqué ci-dessus.

Oui

item_scope_mapping

Fournit un mécanisme pour regrouper les éléments de mise en page en fonction de l’échelle (c’est-à-dire un algorithme).

Nom de la propriété

Description

Requis

name

Le nom de l’algorithme qui sera associé à cette configuration, par exemple “productivité”, “odd-15-3-1-sous-indicateurs” etc. Correspond aux noms d’algorithmes définis dans “script.json” dans le dossier de données de la boîte à outils.

Oui

type_id_mapping

Un dictionnaire contenant une énumération des types d’éléments de mise en page et la liste correspondante des identifiants des éléments définis dans le modèle.

Les types d’éléments de format supportés incluent : carte, étiquette, image

"type_id_mapping":{
   "map":["map.main"],
   "label":["label.layer_title"]
}

Voir Ajouter un élément de mise en page pour savoir comment définir les identifiants des éléments.

Oui

output_format

Informations sur le format du rapport exporté.

Nom de la propriété

Description

Requis

format_type

Une énumération des types de fichiers exportés.

Les options d’énumération supportées incluent : PDF et IMAGE.

Veuillez noter que ceux-ci doivent être en majuscules comme indiqué ci-dessus.

Oui

params

En fonction du type de fichier d’exportation défini, cette propriété contient des informations additionnelles sur le format.

Par exemple, si IMAGE est défini comme le format d’exportation, cette propriété peut être utilisée pour définir le type IMAGE. N’affecte pas le type PDF et définit par défaut PNG pour un type IMAGE.

Non

Réinitialise les modèles et la configuration par défaut

Pour revenir aux modèles et au ficher de configuration du rapport par défaut édité avec la boîte à outils, suivez les étapes ci-dessous :

  1. Fermez QGIS puis restaurez le dossier templates dans [base_data_directory]/reports/templates.

  2. Supprimez le dossier “templates” puis relancez QGIS.