This is an old revision of the document!
Export Renkan
Renkan export les cartes au format JSON
Objet racine
| propriété | type | contenu |
| users | liste d'objets utilisateur ? | Liste des utilisateurs enregistrés |
| nodes | liste d'objet node | Liste des nodes |
| edges | liste d'objet edge | Liste des liens |
| views | Array | ? |
| title | String | Titre du renkan |
| uri | ? null ou String | ? |
| color | ? null ou String ? | ? |
| revCounter | Int | nombre de révisions ? |
| created | timestamp ? | timestamp de la date de création ? |
| updated | timestamp ? | timestamp de la date de la dernière mise à jour ? |
| schema_version | String | version du schéma/modèle |
Objet Node
| propriété | type | contenu |
| title | String | titre du node |
| uri | String | url associée |
| description | String | texte de description |
| position | objet position | position du node |
| image | String | url de l'image |
| style | NodeStyle | éléments de style du node |
| created_by | ? null ou String (uuid?) ? | identifiant du créateur du node |
| size | Int | taille du node |
| shape | String | forme du node |
| type | ? ou null | ? |
| @id | String | uuid ? |
notes : à faire
* identifier d'éventuelles propriétés pouvant être des listes, notamment uri/image
* déterminer les strings possibles pour la propriété shape
* déterminer la nature exacte de la propriété @id
Objet Edge
| propriété | type | contenu |
| title | String | titre de l'edge |
| uri | String | url associé à l'edge |
| description | String | description associée au lien |
| from | String (uuid?) | uuid du node de départ |
| to | String (uuid?) | uuid du node d'arrivée |
| style | EdgeStyle | éléments de style de l'edge |
| created_by | ? null ou String (uuid?) ? | identifiant du créateur de l'edge |
Objet NodeStyle
| propriété | type | contenu |
| dash | Boolean | Booléen |
| color | String | hex color, ex : “#ffffff” |
| thickness | Int | épaisseur du contour ? |
Objet EdgeStyle
| propriété | type | contenu |
| color | String | hex color, ex : “#ffffff” |
| arrow | Boolean | Booléen, présence d'une flêche ou non |
| thickness | Int | épaisseur du contour ? |
Objet position
| propriété | type | contenu |
| x | Float | position en x |
| y | Float | position en y |
Vocabulaire de la propriété shape
circle
rectangle
ellipse
polygon
diamond
star
cloud
triangle
Définition Python des types d'objets exportés par Renkan
Objet Racine
class rkRootObject(object):
"""Renkan root object definition"""
users = None
nodes = None
edges = None
views = None
title = None
uri = None
color = None
revCounter = None
created = None
updated = None
schema_version = None
Objet Node
class rkNode(object):
"""Renkan node object definition"""
title = None
uri = None
description = None
position = None
image = None
style = None
created_by = None
size = None
shape = None
type = None
@id = None
Objet Edge
class rkEdge(object):
"""Renkan edge object definition"""
title = None
uri = None
description = None
from = None
to = None
style = None
created_by = None
Objet NodeStyle
class rkNodeStyle(object):
"""Renkan node style object definition"""
dash = None
color = None
thickness = None
Objet EdgeStyle
class rkEdgeStyle(object):
"""Renkan edge style object definition"""
color = None
arrow = None
thickness = None
Objet Position
class rkPos(object):
"""Renkan position object definition"""
x = None
y = None
