Objet layout¶
L'objet layout est un tableau décrivant les différentes représentations graphiques du nœud ou de l'arête. Une représentation graphique est décrite par un objet JSon contenant un attribut gb_layout_type spécifiant le type de représentation et par un nombre illimité de mots-clefs. Les types de représentations graphiques disponibles varient en fonction du transformer et du composant du graphe.
gb_layout_type¶
Description : Type de représentation graphique à associer au nœud ou à l'arête.
Valeur attendue :
Pour GraphLayouter :
Pour les nœuds : valeur dans la liste ("box","label","image","symbol","point")
Pour les arêtes : valeur dans la liste ("line,label")
Pour GraphLayouterForExcel :
Pour les nœuds : valeur dans la liste ("cell,label")
Pour les arêtes : valeur dans la liste ("line,label")
Valeur par défaut : Pas de valeur par défaut. si gb_layout_type n'est pas défini le traitement se termine avec une erreur.
Utilisation : Cet attribut est exploité par GraphLayouter et GraphLayouterForExcel.
gb_label_string¶
Description : Valeur du label à afficher.
Valeur attendue : Chaîne de caractères ou nom d'un attribut de l'entité du graphe sous la forme "{{attributname}}".
Valeur par défaut : Chaîne vide.
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type label. Utilisez gb_cell_string pour définir la valeur du texte d'une cellule Excel avec GraphLayouterForExcel.
gb_label_size¶
Description : Définit la taille de la police de caractères utilisée pour écrire le texte. Cette taille est exprimée en points pour le format PDF et en unité terrain pour les autres formats.
Valeur attendue : Numérique
Valeur par défaut : 8
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type label. Pour produire un document au format XLSX avec GraphLayouterForExcel, utilisez le mot-clef gb_xlfontSize.
gb_label_rotation¶
Description : Définit l'angle de rotation à appliquer à la chaîne de caractères. Cet angle est exprimé en degrés dans le sens trigonométrique (anti-horaire).
Valeur attendue : Numérique
Valeur par défaut : 0
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type label.
gb_label_offset¶
Description : Définit la valeur de décalage entre la base du texte et l'arête qui lui sert de support. L'unité est le point pour la sortie au format PDF. Dans les autres cas de figure, le décalage est mesuré en unité terrain.
Valeur attendue : Un nombre relatif
Valeur par défaut : 0
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type label dans la section edgeclasses du fichier de mise en forme. Mot-clef sujet à modification future.
gb_box_shape¶
Description : Définit la forme de la représentation graphique du nœud, rectangulaire ou circulaire.
Valeur attendue : Chaîne de caractères dans la liste ("rectangle","circle")
Valeur par défaut : rectangle
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type box.
gb_box_size¶
Description : Définit la largeur et la hauteur de la boîte représentant le nœud. L'unité est le point pour la sortie au format PDF. Dans les autres cas, la taille est mesurée en unité terrain.
Valeur attendue : Un tableau de deux nombres positifs non nuls sous la forme [largeur,hauteur].
Valeur par défaut : [10,10]
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type box.
gb_box_rotation¶
Description : Définit l'angle de rotation à appliquer à la forme représentant le noeud. Cet angle est exprimé en degrés dans le sens trigonométrique (anti-horaire).
Valeur attendue : Numérique
Valeur par défaut : 0
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type box.
gb_image_path¶
Description : Définit l'emplacement de l'image à utiliser pour représenter le nœud.
Ce chemin est généralement stocké dans un attribut de l'entité. Si le chemin est relatif, un répertoire de référence peut-être défini grâce au mot-clé gb_image_dir de l'objet Graph. Le chemin exploité par GraphLayouter pour localiser les images est la concaténation de gb_image_dir et de gb_image_path.
Cf. gb_image_dir.Valeur attendue : Un Chemin absolu ou relatif vers une image de format png ou jpeg.
Valeur par défaut : En l'absence de valeur ou si l'image n'existe pas, aucune image n'est affichée.
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type image.
Exemple :
"gb_layout_type":"image",
"gb_image_path":"{{image}}",
"gb_image_size": [14,9],
"gb_offset":[-5,5],
gb_image_size¶
Description : Définit la largeur et la hauteur de l'image représentant le nœud. L'unité est le point pour la sortie au format PDF. Dans les autres cas, la taille est mesurée en unité terrain.
Valeur attendue : Un tableau de deux nombres positifs non nuls sous la forme [largeur,hauteur].
Valeur par défaut : [10,10]
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type image.
gb_symbol_name¶
Description : Définit le nom du symbole vectoriel à utiliser pour représenter le nœud. La production et l'utilisation des librairies de symboles est décrite dans la section Utilitaires/svg2geojson.
Valeur attendue : Chaîne de caractères correspondant à un nom de symbole se trouvant dans la librairie localisée par le mot-clef gb_symbol_library de l'objet graph.
Valeur par défaut : En l'absence de valeur ou si le symbole n'existe pas, aucun symbole n'est affiché.
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type symbol.
Exemple :
"gb_layout_type":"symbol",
"gb_symbol_name":"print",
"gb_symbol_size":[20,20],
"gb_color":"#47BA83"
gb_symbol_size¶
Description : Définit la largeur et la hauteur du symbole représentant le nœud. L'unité est le point pour la sortie au format PDF.
Dans les autres cas, la taille est mesurée en unité terrain.Valeur attendue : Un tableau de deux nombres positifs non nuls sous la forme [largeur,hauteur].
Valeur par défaut : [10,10]
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type symbol.
gb_offset¶
Description : Définit la valeur de décalage entre les coordonnées du nœud et l'emplacement de sa représentation graphique. L'unité est le point pour la sortie au format PDF. Dans les autres cas de figure, le décalage est mesuré en unité terrain.
Valeur attendue : Un tableau de deux nombres relatifs sous la forme [décalage vers la droite, décalage vers le haut].
Valeur par défaut : [0,0]
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type box, symbol, image ou label.
gb_color¶
Description : Définit la couleur de la bordure de la représentation graphique de l'entité.
Valeur attendue : Couleur
Valeur par défaut : Noir (#000000)
Utilisation : Cet attribut est exploité par GraphLayouter avec tous les types de représentation graphique sauf image et avec GraphLayouterForExcel pour les représentations graphique de type line.
gb_fillcolor¶
Description : Définit la couleur de fond de la représentation graphique de l'entité.
Valeur attendue : Couleur
Valeur par défaut : Blanc (#FFFFFF)
Utilisation : Cet attribut est exploité par GraphLayouter lorsque la représentation graphique (gb_layout_type) est de type box ou symbol.
gb_feature_order¶
Description : Définit l'ordre de sortie des représentations graphiques (objet layout) et valorise automatiquement l'attribut de format pdf_feature_order lorsque le format de sortie est PDF2D.
Les entités ayant une petite valeur de gb_feature_order sortiront en premier et seront donc dessinées dessous les entités ayant une valeur plus élevée. Par défaut, la valeur de gb_feature_order pour toutes les entités sortant par les ports Node et Edge de GraphLayouter est 100. Elle est 0 pour l'entité frame ce qui assure que le cadre soit toujours dessiné en premier.Valeur attendue : Nombre entier positif ou nul.
Valeur par défaut : 100 pour Node et Edge, 0 pour Frame
Utilisation : Cet attribut est exploité par GraphLayouter pour tous les types de représentation graphique.
gb_cell_string¶
Description : Valeur du texte à écrire dans une cellule Excel.
Valeur attendue : Chaîne de caractère ou nom d'un attribut de l'entité du graphe sous la forme "{{attributname}}".
Valeur par défaut : Chaîne vide.
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell. Utilisez gb_label_string pour définir la valeur d'un texte avec GraphLayouter.
gb_xloffset¶
Description : Définit la valeur de décalage entre les coordonnées du nœud et l'emplacement de sa représentation graphique.
Valeur attendue : Un tableau de deux nombres entiers relatifs sous la forme [décalage vers la droite, décalage vers le bas]. L'unité est la cellule Excel. L'axe des ordonnées d'Excel est orienté vers le bas du tableau, un décalage de [-1,3] signifie donc une cellule à gauche et 3 cellules vers le bas.
Valeur par défaut : [0,0]
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell.
gb_xlmerge¶
Description : Définit l'étendue des cellules voisines à fusionner en une seule cellule.
Valeur attendue : Un tableau de deux nombres entiers relatifs sous la forme [décalage vers la droite, décalage vers le bas].
La fusion concerne la cellule du nœud (après éventuel décalage par gb_xloffset) et toutes les cellules englobées dans le décalage ainsi défini.Valeur par défaut : [0,0], ce qui correspond à aucune fusion.
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell.
Exemple : L'exemple ci-dessous va entrainer la fusion des 6 cellules définies par : La cellule du nœud, les deux cellules à sa droite et les trois cellules au dessus. La cellule fusionnée sera représentée en rouge.
"gb_xlmerge":[2,-1],
"gb_xlbackgroundColor":"red"
gb_xlfontSize¶
Description : Définit la taille de la police de caractères utilisée pour écrire le texte dans une cellule Excel.
Valeur attendue : Numérique
Valeur par défaut : 11
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell. Pour définir la taille d'un texte avec GraphLayouter, utilisez le mot-clef gb_label_size.
gb_xlfontName¶
Description : Définit le nom de la police de caractères utilisée pour écrire le texte dans une cellule Excel.
Valeur attendue : Chaîne de caractères
Valeur par défaut : 'Calibri'
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlhorizontalAlign¶
Description : Définit l'emplacement horizontal du texte dans la cellule.
Valeur attendue : Chaîne de caractères dans la liste ('left','centerContinuous','center','distributed','fill','justify','right','general')
Valeur par défaut : 'general'
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlverticalAlign¶
Description : Définit l'emplacement vertical du texte dans la cellule.
Valeur attendue : Chaîne de caractères dans la liste ('bottom’, 'center', 'distributed', 'justify', 'top')
Valeur par défaut : 'bottom'
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xltextRotation¶
Description : Angle de rotation du texte. En degrés dans le sens trigonométrique (anti-horaire).
Valeur attendue : Entier positif dans l'intervale [0,180].** à compléter.
Valeur par défaut : 0
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlwrapText¶
Description : Définit si l'option "Renvoyer à la ligne automatiquement" d'Excel est activée pour la cellule.
Valeur attendue : Booléen (true|false)
Valeur par défaut : false
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlshrink¶
Description : Définit si l'option "Ajuster" d'Excel est activée pour la cellule. Cette fonction permet de réduire automatiquement la taille de la police pour permettre au texte de tenir dans la largeur de la cellule.
Valeur attendue : Booléen (true|false)
Valeur par défaut : false
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlitalic¶
Description : Définit si le texte gb_label_string est écrit en italique.
Valeur attendue : Booléen (true|false)
Valeur par défaut : false
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlstrike¶
Description : Définit si le texte gb_label_string est écrit en caractères barrés.
Valeur attendue : Booléen (true|false)
Valeur par défaut : false
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlbold¶
Description : Définit si le texte gb_label_string est écrit en caractères gras.
Valeur attendue : Booléen (true|false)
Valeur par défaut : false
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlunderline¶
Description : Définit si le texte gb_label_string doit être souligné.
Valeur attendue : Chaîne de caractères dans la liste ('double','singleAccounting','doubleAccounting','single','none').
Valeur par défaut : 'none'
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlfontColor¶
Description : Définit la couleur du texte dans un document Excel.
Valeur attendue : Couleur
Valeur par défaut : '#000000' (noir)
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell, en conjonction avec gb_cell_string.
gb_xlbackgroundColor¶
Description : Définit la couleur de fond d'une cellule dans un document Excel.
Valeur attendue : Couleur
Valeur par défaut : '#FFFFFF' (blanc)
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell.
gb_xlborderColor¶
Description : Définit la couleur des quatres bordures d'une cellule dans un document Excel. Pour spécifier la couleur d'une seule bordure, utilisez l'un des attributs suivants :
gb_xlborderColorTop : Couleur de la bordure du haut
gb_xlborderColorBottom : Couleur de la bordure du bas
gb_xlborderColorLeft : Couleur de la bordure de gauche
gb_xlborderColorRight : Couleur de la bordure de droiteValeur attendue : Couleur
Valeur par défaut : '#000000'
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell. Attention, le mot-clef gb_xlborderStyle ou une de ses variantes doit être défini sinon la bordure n'est pas visible.
gb_xlborderColorTop¶
cf. gb_xlborderColor
gb_xlborderColorBottom¶
cf. gb_xlborderColor
gb_xlborderColorLeft¶
cf. gb_xlborderColor
gb_xlborderColorRight¶
cf. gb_xlborderColor
gb_xlborderStyle¶
Description : Définit le style des quatre bordures d'une cellule dans un document Excel. Pour spécifier le style d'une seule bordure, utilisez l'un des attributs suivants :
gb_xlborderStyleTop : Style de la bordure du haut
gb_xlborderStyleBottom : Style de la bordure du bas
gb_xlborderStyleLeft : Style de la bordure de gauche
gb_xlborderStyleRight : Style de la bordure de droite
Valeur attendue : Chaîne de caractères dans la liste : ('none','dotted', 'mediumDashDotDot', 'dashed', 'dashDotDot', 'thick', 'dashDot', 'double', 'medium', 'mediumDashed', 'slantDashDot', 'thin', 'mediumDashDot', 'hair'). Attention à respecter la casse.
Valeur par défaut : 'none'
Utilisation : Cet attribut est exploité par GraphLayouterForExcel lorsque la représentation graphique (gb_layout_type) est de type cell.
Les différents styles de bordure de cellule
gb_xlborderStyleTop¶
cf. gb_xlborderStyle
gb_xlborderStyleBottom¶
cf. gb_xlborderStyle
gb_xlborderStyleLeft¶
cf. gb_xlborderStyle
gb_xlborderStyleRight¶
cf. gb_xlborderStyle