tree_data#

tree_data(G, root, ident='id', children='children')[source]#

Returns data in tree format that is suitable for JSON serialization and use in JavaScript documents.

Parameters:
GNetworkX graph

G must be an oriented tree

rootnode

The root of the tree

identstring

Attribute name for storing NetworkX-internal graph data. ident must have a different value than children. The default is ‘id’.

childrenstring

Attribute name for storing NetworkX-internal graph data. children must have a different value than ident. The default is ‘children’.

Returns:
datadict

A dictionary with node-link formatted data.

Raises:
NetworkXError

If children and ident attributes are identical.

See also

tree_graph, node_link_data, adjacency_data

Notes

Node attributes are stored in this format but keys for attributes must be strings if you want to serialize with JSON.

Graph and edge attributes are not stored.

Examples

>>> from networkx.readwrite import json_graph
>>> G = nx.DiGraph([(1, 2)])
>>> data = json_graph.tree_data(G, root=1)

To serialize with json

>>> import json
>>> s = json.dumps(data)