Skip to content

Commit 0d281ca

Browse files
committed
Add basic docs for VG.render
1 parent 0ad497c commit 0d281ca

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

python-wrapper/src/neo4j_viz/visualization_graph.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,33 @@ def render(
3737
allow_dynamic_min_zoom: bool = True,
3838
max_allowed_nodes: int = 10_000,
3939
) -> HTML:
40+
"""
41+
Render the graph.
42+
43+
Parameters
44+
----------
45+
layout:
46+
The `Layout` to use.
47+
renderer:
48+
The `Renderer` to use.
49+
width:
50+
The width of the rendered graph.
51+
height:
52+
The height of the rendered graph.
53+
pan_position:
54+
The initial pan position.
55+
initial_zoom:
56+
The initial zoom level.
57+
min_zoom:
58+
The minimum zoom level.
59+
max_zoom:
60+
The maximum zoom level.
61+
allow_dynamic_min_zoom:
62+
Whether to allow dynamic minimum zoom level.
63+
max_allowed_nodes:
64+
The maximum allowed number of nodes to render.
65+
"""
66+
4067
num_nodes = len(self.nodes)
4168
if num_nodes > max_allowed_nodes:
4269
raise ValueError(

0 commit comments

Comments
 (0)