From e390f69a0124522c4dab52b7b134fe9fcee6a415 Mon Sep 17 00:00:00 2001
From: Sofian Pujo <sofian.pujo@veremes.com>
Date: Mon, 17 Jun 2024 11:58:51 +0200
Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20documentation?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../administrator/rapports/definition_html.md | 46 +++++++++----------
.../rapports/informations_generales.md | 6 ++-
.../administrator/rapports/objet_json.md | 5 +-
3 files changed, 30 insertions(+), 27 deletions(-)
diff --git a/doc/source/administrator/rapports/definition_html.md b/doc/source/administrator/rapports/definition_html.md
index 9850746e..ce419a5d 100644
--- a/doc/source/administrator/rapports/definition_html.md
+++ b/doc/source/administrator/rapports/definition_html.md
@@ -30,6 +30,28 @@ En plus des variables possibles à renseigner depuis la couche associée, les ra
- **user_email** : adresse mail de l'utilisateur
- **user_id** : identifiant de l'utilisateur
+## Intégrer une image dynamiquement
+
+Il est possible d'intégrer une image dans un rapport en utilisant la balise HTML **img** et en modifiant la source dynamiquement. Deux formats sont alors pris en compte :
+
+- Lien (de type https://...)
+- Base 64 (de type data:image/png;base64,...)
+
+<u>Exemple :</u>
+```html
+<img src="https://www.example.com/image.png" alt="Description de l'image">
+<img src="data:image/png;base64,..." alt="Description de l'image">
+```
+
+Il est aussi possible de mettre un id="..." à la balise et de la lier à un objet JSON pour afficher l'image dynamiquement.
+
+*Exemple avec id et lien à un objet JSON :*
+```html
+<img id="sig_logo" src="" alt="Image dynamique">
+```
+
+**Note :** Si à la fois l'attribut id de la balise HTML et l'attribut src sont tous deux remplis, l'objet JSON prendra le dessus pour déterminer l'URL finale de l'image affichée.
+
## Intégrer une valeur dynamique à l'aide d'une boucle
Dans certains cas, vous pourriez avoir besoin d'itérer à travers une liste d'objets pour afficher des données dynamiques dans votre rapport. Pour cela, vous pouvez utiliser la syntaxe `ng-repeat` dans votre modèle HTML.
@@ -56,26 +78,4 @@ Supposons que vous ayez une liste d'objets représentant des intersections de ro
Dans cet exemple :
- ng-repeat="intersection in intersections" indique que vous itérez à travers la liste d'intersections stockée dans la variable intersections.
-- {{intersection.nom}}, {{intersection.nombre_routes}}, etc., représentent les propriétés de chaque objet intersection que vous affichez dans votre rapport.
-
-## Intégrer une image dynamiquement
-
-Il est possible d'intégrer une image dans un rapport en utilisant la balise HTML **img** et en modifiant la source dynamiquement. Deux formats sont alors pris en compte :
-
-- Lien (de type https://...)
-- Base 64 (de type data:image/png;base64,...)
-
-<u>Exemple :</u>
-```html
-<img src="https://www.example.com/image.png" alt="Description de l'image">
-<img src="data:image/png;base64,..." alt="Description de l'image">
-```
-
-Il est aussi possible de mettre un id="..." à la balise et de la lier à un objet JSON pour afficher l'image dynamiquement.
-
-*Exemple avec id et lien à un objet JSON :*
-```html
-<img id="sig_logo" src="" alt="Image dynamique">
-```
-
-**Note :** Si à la fois l'attribut id de la balise HTML et l'attribut src sont tous deux remplis, l'objet JSON prendra le dessus pour déterminer l'URL finale de l'image affichée.
\ No newline at end of file
+- {{intersection.nom}}, {{intersection.nombre_routes}}, etc., représentent les propriétés de chaque objet intersection que vous affichez dans votre rapport.
\ No newline at end of file
diff --git a/doc/source/administrator/rapports/informations_generales.md b/doc/source/administrator/rapports/informations_generales.md
index f27e1c9b..719454b8 100644
--- a/doc/source/administrator/rapports/informations_generales.md
+++ b/doc/source/administrator/rapports/informations_generales.md
@@ -1,6 +1,7 @@
# Informations générales
-Un rapport est un document personnalisable permettant d'afficher diverses informations selon les besoins des utilisateurs. Il peut être généré à partir de deux endroits dans l'application :
+Un rapport est un document PDF généré dans vMap et personnalisable permettant d'afficher diverses informations selon les besoins des utilisateurs. Ce document est basé sur un modèle écrit par un administrateur de l'application.
+Il peut être généré à partir de deux endroits dans l'application :
- Le requêteur
- Edition d'un objet métier
@@ -16,4 +17,5 @@ Lors de la création d'un rapport, plusieurs paramètres doivent être renseign
- **Couche** : Le rapport doit être associé à une couche unique pour laquelle il sera disponible. Par exemple, si un rapport doit être généré lors de la sélection d'un objet de la couche "Ville" sur la carte, il faut associer ce rapport à la couche "Ville".
- **Rapport sur plusieurs éléments dans un fichier** : En cas de sélection multiple, ce paramètre indique si l'application doit générer un rapport par élément (Non) ou un seul rapport contenant tous les éléments (Oui).
- **Active les styles d'impression** : Si activé, une fenêtre modale s'ouvrira lorsque l'utilisateur demandera la génération d'un rapport, pour sélectionner le style d'impression à utiliser.
-- **Définition HTML** : Voir [Définition du modèle HTML](definition_html.md).
\ No newline at end of file
+- **Définition HTML** : Voir [Définition du modèle HTML](definition_html.md).
+- **Objet JSON** : Voir [Objet JSON](objet_json.md).
\ No newline at end of file
diff --git a/doc/source/administrator/rapports/objet_json.md b/doc/source/administrator/rapports/objet_json.md
index ddcdd61f..e2f0d517 100644
--- a/doc/source/administrator/rapports/objet_json.md
+++ b/doc/source/administrator/rapports/objet_json.md
@@ -62,9 +62,10 @@ Il y a deux possibilités pour ce type de ressource :
- **params** :
- **schema** : Schéma de la base de données.
- **table** : Table de la base de données.
- - **filter** : Filtre pour la requête SQL. Le filtre doit être sous forme de chaîne de caractères avec les guillemets échappés, comme suit :
+ - **filter** : Filtre pour la requête SQL. Il est possible d'inclure des variables dynamiques ou fixes, et d'inclure plusieurs filtres si besoin.
+ Le filtre doit être sous forme de chaîne de caractères avec les guillemets échappés, comme suit :
```json
- "{\"column\":\"id_par\", \"compare_operator\":\"=\", \"value\": \"{{BO.id_par}}\"}"
+ "[{\"column\":\"id_par\", \"compare_operator\":\"=\", \"value\": \"{{BO.id_par}}\"}, {\"column\":\"id_par\", \"compare_operator\":\"=\", \"value\": \"AZ0001\"}]"
```
- **column** : Nom de la colonne à filtrer.
- **compare_operator** : Opérateur de comparaison. Les opérateurs disponibles sont :
--
GitLab