exporter.to_web_viz_payload()

Build a web-visualization payload from a NetworkX DiGraph.

Usage

Source

exporter.to_web_viz_payload(
    nx_graph,
    *,
    max_local_nodes=None,
    max_local_edges=None,
    include_guarded_edges=True,
    include_guarded_edges_for_partition=False,
    layout="stratified_multipartite",
    layout_config=None,
    include_formula_on_nodes=True,
    max_formula_length=120,
    seed=0,
    weight_attr=None,
    include_module_overlay=True
)

Layout is selected by layout (registered web layout plugin id or a direct WebVizLayoutPlugin callable). The default stratified_multipartite uses SCC-condensation longest-path rank on the vertical axis and Louvain community ordering on the horizontal axis when include_module_overlay is true. Other built-in ids include spring, forceatlas2, multipartite (NetworkX multipartite_layout), graphviz_dot, and graphviz_sfdp.

Set include_module_overlay=False to skip the partition overlay (single module color; overview still draws local graph edges in the viewer).