Diseño de informes¶

En términos más sencillos, los informes se crean rellenando una plantilla de informe con datos textuales o espaciales de uno o más trabajos. Es importante tener en cuenta que los informes se generan a nivel de capa/banda, por lo que el número de informes de un solo trabajo se corresponderá con el número de bandas predeterminadas para el trabajo en cuestión.

El diseño de informes es un proceso de dos pasos que implica:

Diseñar plantillas utilizando el marco de diseño de QGIS;
Especificar los parámetros de configuración en un archivo de configuración de informes.

Requisitos previos¶

Antes de embarcarse en el diseño de nuevos informes o en la personalización de los existentes, se recomienda familiarizarse con los siguientes temas:

«Marco de expresión QGIS <https://docs.qgis.org/3.16/en/docs/user_manual/working_with_vector/expression.html>»_
«Marco de diseño QGIS <https://docs.qgis.org/3.16/en/docs/user_manual/print_composer/index.html>»_
«Formato de datos JSON <https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON>»_

Variables de expresión del diseño¶

Un informe se compone de contenido estático (como logotipos, texto de renuncia, etc.) que no cambia de un informe a otro. También puede incluir contenido dinámico (como mapas o información de atributos) que se genera en tiempo de ejecución durante el proceso de ejecución.

La caja de herramientas de Trends.Earth proporciona una serie de variables de expresión de diseño que pueden utilizarse para insertar contenido dinámico en un diseño. Algunas de ellas están disponibles en tiempo de diseño, mientras que otras solo están disponibles en tiempo de ejecución. La siguiente tabla ofrece un resumen de las variables disponibles.

Variables de trabajo¶

Estos se caracterizan por un prefijo «te_job_» y solo están disponibles en tiempo de ejecución.

Nombre de la variable	Descripción	Tipo de datos
«te_job_id»	Identificado único correspondiente al UUID del trabajo	Cadena
te_job_input_params	Representación JSON de los parámetros de entrada de un trabajo	Cadena
te_job_paths	Ruta local al conjunto o conjuntos de datos del trabajo	Cadena
te_job_alg_name	Nombre del algoritmo del trabajo	Cadena
te_job_creation_date	Fecha/hora de creación de un trabajo	Cadena en formato %Y-%m-%d %H:%M
te_job_status	Estado de finalización de un trabajo, por ejemplo, DESCARGADO, GENERADO_LOCALMENTE, etc.	Cadena
te_job_name	Nombre del trabajo introducido por el usuario.	Cadena
te_job_comments	Comentarios a un trabajo tal y como los ha introducido el usuario.	Cadena

Variables de la capa¶

Se caracterizan por el prefijo te_current_layer_ y solo están disponibles en tiempo de ejecución.

Nombre de la variable	Descripción	Tipo de datos
te_current_layer_name	Nombre de la capa en el contexto de ejecución actual	Cadena

Variables de configuración del informe¶

Se caracterizan por un prefijo te_report_ y están disponibles tanto en tiempo de diseño como en tiempo de ejecución. Consulte la sección Informes para obtener una descripción detallada de los ajustes del informe y los nombres de las variables correspondientes.

Tipos de plantillas¶

Hay dos tipos principales de plantillas de informes:

Plantilla completa¶

Está diseñada para contener, o permitir incluir, más información, como el nombre del autor. La plantilla por defecto se establece en una página A4 e incluye un título de diseño, un mapa, una leyenda, una barra de escala, una flecha del norte, un texto de exención de responsabilidad. y un logotipo.

Plantilla simple¶

La plantilla por defecto se establece en un tamaño de página de 83 mm por 59 mm (en modo horizontal) o viceversa en modo vertical y contiene un mapa, una leyenda, una flecha del norte, una barra de escala, un texto de descargo de responsabilidad y un logotipo.

Nota

Para cada tipo de plantilla, tendrá que proporcionar tanto la versión vertical como la apaisada, ya que la caja de herramientas seleccionará una de ellas en función de las dimensiones de la capa del mapa que se esté representando.

Diseño de plantillas de informes¶

Se pueden crear plantillas de cualquiera de los dos modos siguientes:

Crear uno nuevo¶

Vaya a Proyecto > Nuevo diseño de impresión….
Especifique un nombre fácil de usar para el diseño.

Modificación de uno existente¶

Navegue hasta Proyecto > Gestor de diseños….
Seleccione Específico en el menú desplegable de la sección Nuevo desde plantilla.
Haga clic en el botón de búsqueda (con tres puntos) para seleccionar una plantilla qpt existente. Las plantillas por defecto se encuentran en [base_data_directory]/reports/templates.
Pulse el botón Crear….
Especifique un nombre fácil de usar para la plantilla.

Añadir elementos de la plantilla¶

Puede añadir elementos a la plantilla de forma similar a la definida en el «Manual de QGIS <https://docs.qgis.org/3.16/en/docs/user_manual/print_composer/composer_items/index.html>»_. Las variables de expresión de Trends.Earth están disponibles en el diálogo Creador de expresiones y pueden insertarse en los elementos de la etiqueta como cualquier otra variable de QGIS.
Por ejemplo, para insertar el nombre del algoritmo de un trabajo en un elemento de etiqueta, puede utilizar la siguiente expresión: [% @te_job_alg_name %].
Para un elemento de mapa, no añada ninguna capa ni especifique un tema de mapa, ya que las capas y su ordenación se establecerán automáticamente durante el proceso de generación del informe.
Cuando utilice un elemento de leyenda, asegúrese de que la opción Actualización automática esté seleccionada. La caja de herramientas determinará qué elementos de la leyenda debe mostrar/ocultar en función del contexto de representación.
En el caso de los elementos del mapa que representan las capas de un trabajo o los elementos de la etiqueta que utilizan las variables de expresión de la caja de herramientas, asegúrese de definir sus correspondientes identificadores de elementos para que se puedan marcar para su actualización durante el proceso de generación de informes. Una convención de nomenclatura preferida para el identificador del elemento es [item_type.context_name], por ejemplo label.layer_name, label.job_alg_name, map.main. Veremos cómo se utilizan estos identificadores de elementos en la sección item_scope_mapping.

Configuración de los parámetros del informe¶

El siguiente paso es definir qué plantillas se utilizarán para cada algoritmo. Esto se hace mediante un archivo de configuración de informes,`templates.json`, que se crea en [base_data_directory]/reports/templates al cargar la caja de herramientas por primera vez.

templates.json es una lista de objetos de configuración de informes en la que cada objeto de configuración corresponde a uno o más ámbitos. Un ámbito, en este caso, se refiere a un algoritmo. Una configuración se compone de dos partes:

template_info: contiene información sobre las plantillas de informes de QGIS asociadas a uno o más ámbitos de algoritmos.
output_options: opciones de salida para exportar un informe.

Vea el ejemplo que aparece a continuación:

 {
   "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¶

Contiene información sobre las plantillas de informes de QGIS asociadas con uno o más rangos de algoritmos.

Nombre de la propiedad	Descripción	Requerido
id	Un identificador UUID único en formato de cadena	Sí
name	Un nombre descriptivo de la configuración de la plantilla	No
description	Una breve descripción de la configuración de la plantilla	No
simple_portrait_path	Nombre del archivo de plantilla para un diseño vertical simple	Sí
simple_landscape_path	Nombre del archivo de plantilla para un diseño horizontal simple	Sí
full_portrait_path	Nombre del archivo de plantilla para un diseño vertical completo	Sí
full_landscape_path	Nombre del archivo de plantilla para un diseño horizontal completo	Sí
item_scopes	Una lista de objetos de alcance. Debe contener al menos una definición de alcance. Consulte item_scope_mapping para obtener más información.	Sí

Nota

Las rutas anteriordefinidas arriba son básicamente nombres de archivo pertinentes a la ubicación del archivo de configuración templates.json.

output_options¶

Opciones para exportar un informe de salida.

Nombre de la propiedad

Descripción

Requerido

formats

Una lista de objetos de formato que especifica el formato de salida del informe. El informe puede elaborarse en diversos tipos de archivo, tales como PDF y PNG.

Es necesario definir al menos un formato de salida.

Consulte output_format para conocer las opciones de configuración de un objeto de formato de salida.

Sí

template_type

Tipo de plantilla de informe en formato de cadena.

Las opciones admitidas incluyen SIMPLE, FULL o ALL.

Tenga presente que estas deben estar en mayúsculas como se indica más arriba.

Sí

item_scope_mapping¶

Proporciona un mecanismo para agrupar elementos de diseño en función de un alcance (es decir, algoritmo).

Nombre de la propiedad

Descripción

Requerido

name

Nombre del algoritmo que coincidirá con esta configuración, como productivity, sdg-15-3-1-sub-indicators, etc. Hace referencia a los nombres de algoritmo definidos en scripts.json en la carpeta de datos de la caja de herramientas.

Sí

type_id_mapping

Un diccionario que contiene una enumeración de los tipos de elementos de diseño y la lista correspondiente de identificadores de elementos definidos en la plantilla.

Los tipos de elementos de diseño admitidos incluyen map, label, picture

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

Consulte Añadir elementos de la plantilla para aprender a especificar los identificadores de elementos.

Sí

output_format¶

Información del formato de salida del informe.

Nombre de la propiedad

Descripción

Requerido

format_type

Una enumeración de los tipos de archivo de salida.

Las opciones de enumeración admitidas incluyen PDF e IMAGE.

Tenga presente que estas deben estar en mayúsculas como se indica más arriba.

Sí

params

Según el tipo de salida especificado, esta propiedad contiene información adicional sobre el formato.

Por ejemplo, si se especifica IMAGE como formato de salida, esta propiedad se podrá usar para especificar el tipo de imagen. No tendrá efecto sobre el tipo PDF y utilizará PNG como tipo de imagen predeterminado.

No

Restablecimiento de plantillas y configuración predeterminadas¶

Para recuperar las plantillas y el archivo de configuración de informes que se incluyen por defecto con la caja de herramientas, lleve a cabo los siguientes pasos:

Cierre QGIS y luego haga una copia de seguridad de la carpeta templates en [base_data_directory]/reports/templates.
Proceda a eliminar la carpeta templates y luego reinicie QGIS.