GraphLayouterForExcel

Description

GraphLayouterForExcel est une version spécialisée de GraphLayouter dédiée à la production de jeux de données au format MS-Excel .xlsx.

Avec GraphLayouterForExcel un noeud du graphe est représenté par une cellule et une arête est dessinée à partir des bordures horizontales et verticales entre les deux noeuds (cellules) source et cible.

Compte tenu des possibilités graphiques limitées du format Excel, GraphLayouterForExcel présente de nombreuses limitations par rapport à GraphLayouter :

Le graphe en entrée doit correspondre à un arbre, il ne doit donc pas contenir de cycle. L'utilisation avec des graphes cycliques donne des résultats aléatoires et non supportés.
Le graphe est considéré comme non orienté. Le paramètre "ID du Noeud Racine" de GraphLayouterForExcel permet de spécifier l'origine de l'arbre. Ce fonctionnement est sujet à évolution dans les futures versions.
Un seul algorithme de placement est utilisé 1-Arbre sur Grille. Celui-ci est adapté à la représentation des arbres sur une grille.
Les formes de représentation graphique sont limitées aux types cell et line.
Les mots-clefs destinés à la représentation des noeuds et des arêtes sont préfixés par "gb_xlsx_" (dans les objets styles ou layout), ceux destinés à la mise en page générale du document sont préfixés par "gb_graph_xl" (dans l'objet graph).
Il n'est pas possible de choisir la forme des arêtes.
L'unité de mesure pour les mots-clef gb_graph_xlorigin, gb_xloffset, gb_xlmerge, gb_graph_xledgestepwidth et gb_graph_xledgetextlocation est la cellule.

L'axe des ordonnées d'Excel est orienté vers le bas du tableau.

  "gb_xloffset":[-1,3]

L'exemple ci-dessus correspond donc à un décalage d'une cellule vers la gauche et de trois cellules vers le bas.

La section Génération de représentations graphiques au format MS-Excel décrit les paramètres de mise en forme des documents Excel.

Entrée

Graph

Le port Graph doit recevoir des entités constituant un graphe correctement structuré et formaté pour une utilisation dans GraphLayouterForExcel. Il existe deux moyens de produire un tel graphe :

utiliser le Transformer GraphBuilder pour transformer n'importe quel jeu de données en graphe.
exploiter directement un jeu de données source au format GraphML à partir du Reader GraphML de GraphBuilder pour FME.

Les graphes traités par GraphLayouterForExcel doivent être des arbres

Sortie

Summary

Une seule entité ressort par le port Summary. Elle fournit une synthèse du document Excel généré.
_dataset : Emplacement du document Excel produit
_total_features_written : Nombre d'entités écrites dans le document excel

Paramètres

Fichier de mise en forme (.ly.json)

Emplacement du fichier de mise en forme au format JSon. L'extension de ce type de fichier est .ly.json par convention.

ID du nœud racine (Optionnel)

Identifiant du Nœud racine. C'est la valeur de l'attribut node.id du nœud considéré comme la racine de l'arbre. Si le nœud racine n'est pas fourni, le premier nœud entrant dans le Transformer est utilisé pour assurer cette fonction.

Document Excel cible

Emplacement et nom du fichier Excel à générer. Il peut s'agir d'un document existant ou à créer. Attention, s'il existe déjà, ce document ne doit pas être ouvert dans Excel sinon le traitement échoue.

Feuille du document excel (Optionnel)

Nom de la feuille Excel où doit être écrit le résultat. La valeur par défaut est "Sheet".

Ecraser le document s'il existe

Si le document Excel cible existe déjà, ce paramètre permet de spécifier s'il doit être supprimé et remplacé par un nouveau document (valeur Oui). Si ce paramètre vaut Non, le document est conservé et GraphLayouterForExcel écrit uniquement dans la feuille indiquée (paramètre précédent).