Skip to content

Plotly Module

This section documents the plotly components of the Nextmv Python SDK - Local experience.

plotly_handler

Plotly visualization handler module.

This module provides functionality to handle Plotly visualizations by converting them to HTML files for local run processing.

FUNCTION DESCRIPTION
handle_plotly_visual

Handle and write Plotly visuals to HTML files.

handle_plotly_visual 

handle_plotly_visual(
    asset: Asset, visuals_dir: str
) -> None

Handle and write Plotly visuals to HTML files.

This function processes Plotly visualization assets and converts them to HTML files. It handles both single visualizations (dict content) and multiple visualizations (list content). Each visualization is converted from JSON format to a Plotly figure and then saved as an HTML file.

PARAMETER DESCRIPTION

asset

The asset containing the Plotly visualization data. The content can be either a dictionary (single visualization) or a list (multiple visualizations).

TYPE: Asset

visuals_dir

The directory path where the HTML files will be written.

TYPE: str

Notes
  • For list content, each visualization is saved with an index suffix (e.g., "chart_0.html", "chart_1.html")
  • For dict content, the visualization is saved with the asset label (e.g., "chart.html")
  • Content types other than dict or list are currently ignored
Source code in nextmv/nextmv/local/plotly_handler.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def handle_plotly_visual(asset: Asset, visuals_dir: str) -> None:
    """
    Handle and write Plotly visuals to HTML files.

    This function processes Plotly visualization assets and converts them to
    HTML files. It handles both single visualizations (dict content) and
    multiple visualizations (list content). Each visualization is converted
    from JSON format to a Plotly figure and then saved as an HTML file.

    Parameters
    ----------
    asset : Asset
        The asset containing the Plotly visualization data. The content can be
        either a dictionary (single visualization) or a list (multiple
        visualizations).
    visuals_dir : str
        The directory path where the HTML files will be written.

    Notes
    -----
    - For list content, each visualization is saved with an index suffix
      (e.g., "chart_0.html", "chart_1.html")
    - For dict content, the visualization is saved with the asset label
      (e.g., "chart.html")
    - Content types other than dict or list are currently ignored
    """
    if isinstance(asset.content, list):
        for ix, content in enumerate(asset.content):
            fig = pio.from_json(json.dumps(content))
            fig.write_html(os.path.join(visuals_dir, f"{asset.visual.label}_{ix}.html"))

        return

    if isinstance(asset.content, dict):
        fig = pio.from_json(json.dumps(asset.content))
        fig.write_html(os.path.join(visuals_dir, f"{asset.visual.label}.html"))

        return