Objet graph¶
Les attributs de l'objet graph du layout file permettent de définir les caractéristiques générales du résultat produit par GraphLayouter telles que la taille du résultat ou la taille de la page produite. Certains attributs influent spécifiquement sur la génération des documents Excel à partir de GraphLayouterForExcel.
Les attributs supplémentaires pour FME qui sont décrits dans la section graph du fichier de mise en forme se retrouvent au final ajoutés à l'ensemble des entités générées par les trois ports de GraphLayouter (frame, node et edge).
gb_output_format¶
Description : Définit le format de sortie envisagé pour les entités traitées avec le fichier de mise en forme.
L'utilisation de ce mot-clef a une utilité documentaire pour l'utilisateur qui peut ainsi savoir rapidement pour quel format de sortie le layout file a été conçu. Il a également un rôle pour GraphLayouter qui peut optimiser les entités en sortie en ajoutant des attributs de format propres au format d'écriture.Valeur attendue : Chaîne de caractères correspondant au nom court du format tel qu'il est visible dans la galerie des formats de FME Workbench. Menu Outils > Consulter la galerie des formats.
Exemples de valeurs : "PDF2D" pour le format "Adobe Geospatial PDF", "ACAD" pour le format "Autodesk AutoCAD DWG/DXF". La définition de mot-clef est optionnelle mais conseillée.Valeur par défaut : "PDF2D"
Exemple :
"gb_output_format": "PDF2D",
L'exemple ci-dessus permet à GraphLayouter d'ajouter des valeurs par défaut à des attributs de format nécessaires à l'écriture au format PDF2D : pdf_frame_rectangle, pdf_page_number, pdf_frame_order, pdf_frame_fixed_aspect, pdf_frame_clipping_enabled, pdf_page_size.
gb_frame_unit¶
Description : Unité utilisée pour saisir les valeurs numériques des mots-clefs gb_frame_internalmargin, gb_frame_size, gb_frame_offset, gb_page_size. Ces valeurs peuvent être définies en centimètre (cm), en pouce (inch), ou en point pica (point) correspondant à 1/72 de pouce.
Valeur attendue : Chaîne de caractères dans la liste ("point","cm","inch")
Valeur par défaut : point
gb_frame_size¶
Description : Dimension du cadre du graphe.
Si ce paramètre n'est pas défini ou s'il vaut une chaîne vide, la représentation graphique n'est pas contrainte à un espace donné et utilise tout l'espace nécessaire. Le choix de définir une limite ou non dépend notamment du format de sortie. Pour maîtriser la production de documents PDF2D, il est nécessaire de fixer le cadre dans lequel va venir s'inscrire le graphe. Pour les autres formats, les deux options sont possibles et dépendent des besoins des ut59555ilisateurs.
Attention, le choix de définir un cadre ou non a des impacts sur la taille des textes, symboles et images spécifiés dans le fichier de mise en forme. Dans un espace contraint, ces valeurs sont définies en point, dans un espace sans limite, elles sont définies en unité terrain comme dans les outils de CAO.
Les mot-clefs de la forme gb_frame_* (gb_frame_internalmargin, gb_frame_offset, gb_frame_color, gb_frame_fillcolor) ne sont pris en compte que si gb_frame_size est défini.
La notion de cadre n'est pas exploitée par GraphLayouterForExcel.
Valeur attendue : Tableau de 2 nombres sous la forme [largeur,hauteur] ou "" (pas de cadre).
Valeur par défaut : [595*842], 21*29.7 en cm
gb_frame_internalmargin¶
Description : Marge entre la bordure du graphe et le cadre.
Le respect de cette valeur n'est pas garanti avec la version 1.0 de graphBuilder.Valeur attendue : Tableau de 4 nombres sous la forme [gauche,bas,haut,droite]
Valeur par défaut : [0.5,0.5,0.5,0.5] en cm
gb_frame_offset¶
Description : Décalage à appliquer aux coordonnées du cadre et du graphe.
Cette valeur permet notamment de définir l'emplacement du coin inférieur gauche du cadre sur une page d'un document au format pdf (PDF2D).Valeur attendue : Tableau de 2 nombres sous la forme [décalage vers la droite,décalage vers le haut]
Valeur par défaut : [0,0]
gb_frame_color¶
Description : Couleur de la bordure du cadre du graphe.
Valeur attendue : Couleur
Valeur par défaut : Noir (#000000)
gb_frame_fillcolor¶
Description : Couleur de fond du cadre du graphe
Valeur attendue : Couleur
Valeur par défaut : Blanc (#FFFFFF)
gb_page_size¶
Description : Taille de la page. Ce mot-clef n'est utilisé que pour les graphes destinés à l'écriture au format pdf (PDF2D). Il doit être utilisé en conjonction avec gb_output_format.
Valeur attendue : Tableau de 2 nombres sous la forme [largeur,hauteur]
Valeur par défaut : [595*842] (point) = 21*29.7 cm soit le format A4 en mode portrait.
Exemple : A4 en mode Paysage
"gb_output_format": "PDF2D",
"gb_frame_unit": "cm",
"gb_page_size": [29.7, 21],
gb_symbol_library¶
Description : Emplacement de la librairie au format GeoJSon contenant les différents symboles pouvant être utilisés dans le fichier de mise en forme. La production et l'utilisation des librairies de symboles est décrite dans la section Utilitaires/svg2geojson.
Valeur attendue : Chemin
Valeur par défaut : null. L'emplacement de la librairie doit être défini si une représentation graphique de type symbol est utilisée dans le fichier de mise en forme.
gb_image_dir¶
Description : Répertoire contenant les images exploitées pour la représentation des noeuds.
Ce mot-clef doit être utilisé en coordination avec le mot-clef gb_image_path des objets layout.
Le nom du répertoire doit se terminer par "/" (Windows et Linux) ou "\" (Windows). Le chemin exploité par GraphLayouter pour localiser les images est la concaténation de gb_image_dir et de gb_image_path.
Si gb_image_dir est vide ou non défini, le chemin des images doit être saisi de manière absolue dans gb_image_path. Dans le cas contraire, gb_image_path doit contenir des chemins relatifs.
cf.gb_image_path.Valeur attendue : Chemin de répertoire
Valeur par défaut : Chaîne vide.
gb_graph_xlorigin¶
Description : Définit l'emplacement de la cellule correspondant au nœud racine du graphe et représenté en haut à gauche du tableau Excel.
Valeur attendue : Tableau de 2 nombres entiers positifs non nuls sous la forme [abscisse, ordonnée]. L'unité est la cellule Excel, la première cellule (A1) se trouve à l'emplacement [1,1]. L'axe des ordonnées d'Excel est orienté vers le bas du tableau, une origine de [1,3] correspond donc à la troisième cellule vers le bas (A3).
Valeur par défaut : [3,3]
Utilisation : Cet attribut est exploité par GraphLayouterForExcel.
gb_graph_xlinterval¶
Description : Définit l'intervalle horizontal et vertical entre deux nœuds. L'unité est la cellule Excel.
Valeur attendue : Tableau de 2 nombres entiers positifs sous la forme [intervalle horizontal, intervalle vertical].
Valeur par défaut : [3,3]
Utilisation : Cet attribut est exploité par GraphLayouterForExcel.
gb_graph_xlshowgrid¶
Valeur attendue : Booléen dans la liste (true,false)
Valeur par défaut : true
Description : Indique si la grille de la feuille Excel générée doit être visible (true) ou invisible (false). Mot-clef exploité uniquement par GraphLayouterForExcel.
gb_graph_xlcellheight¶
Valeur attendue : Numérique
Valeur par défaut : 15
Description : Hauteur des cellules. Mot-clef exploité uniquement par GraphLayouterForExcel.
gb_graph_xlnodecellwidth¶
Valeur attendue : Numérique
Valeur par défaut : 30
Description : Largeur des cellules utilisées pour représenter les nœuds. Mot-clef exploité uniquement par GraphLayouterForExcel.
gb_graph_xledgecellwidth¶
Valeur attendue : Numérique
Valeur par défaut : 5
Description : Largeur des cellules utilisées pour représenter les arêtes. Mot-clef exploité uniquement par GraphLayouterForExcel.
gb_graph_xledgestepwidth¶
Valeur attendue : Entier positif ou nul
Valeur par défaut : 0
Description : Nombre de cellules parcourues horizontalement par une arête quand elle part du nœud source avant de rejoindre verticalement la ligne de la cellule cible. Mot-clef exploité uniquement par GraphLayouterForExcel.
gb_graph_xledgetextlocation¶
Valeur attendue : Entier relatif
Valeur par défaut : -1
Description : Nombre de cellules parcourues le long de l'arête en partant du nœud source avant de positionner le label d'une arête. Si la valeur est négative, l'arête est parcourue en partant du nœud cible et en remontant vers la source. Mot-clef exploité uniquement par GraphLayouterForExcel.