Skip to content

core

D3jsPlot

Bases: pathpyG.visualisations.plot.PathPyPlot

Base class for plotting d3js objects.

Source code in src/pathpyG/visualisations/_d3js/core.py 
 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
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
class D3jsPlot(PathPyPlot):
    """Base class for plotting d3js objects."""

    def generate(self) -> None:
        """Generate the plot."""
        raise NotImplementedError

    def save(self, filename: str, **kwargs: Any) -> None:
        """Save the plot to the hard drive."""
        with open(filename, "w+") as new:
            new.write(self.to_html())

    def show(self, **kwargs: Any) -> None:
        """Show the plot on the device."""
        if config["environment"]["interactive"]:
            from IPython.display import display_html, HTML

            display_html(HTML(self.to_html()))
        else:
            # create temporal file
            with tempfile.NamedTemporaryFile(delete=False) as temp_file:
                # save html
                self.save(temp_file.name)
                # open the file
                webbrowser.open(r"file:///" + temp_file.name)

    def to_json(self) -> str:
        """Convert data to json."""
        raise NotImplementedError

    def to_html(self) -> str:
        """Convert data to html."""
        # generate unique dom uids
        dom_id = "#x" + uuid.uuid4().hex

        # get path to the pathpy templates
        template_dir = os.path.join(
            os.path.dirname(os.path.dirname(__file__)),
            os.path.normpath("_d3js/templates"),
        )

        # get d3js version
        local = self.config.get("d3js_local", False)
        if local:
            d3js = os.path.join(template_dir, "d3.v5.min.js")
        else:
            d3js = "https://d3js.org/d3.v5.min.js"

        # get template files
        with open(os.path.join(template_dir, f"{self._kind}.js")) as template:
            js_template = template.read()

        with open(os.path.join(template_dir, "setup.js")) as template:
            setup_template = template.read()

        with open(os.path.join(template_dir, "styles.css")) as template:
            css_template = template.read()

        # load custom template
        _template = self.config.get("template", None)
        if _template and os.path.isfile(_template):
            with open(_template) as template:
                js_template = template.read()

        # load custom css template
        _template = self.config.get("css", None)
        if _template and os.path.isfile(_template):
            with open(_template) as template:
                css_template += template.read()

        # update config
        self.config["selector"] = dom_id
        data = self.to_json()

        # generate html file
        html = "<style>\n" + css_template + "\n</style>\n"

        # div environment for the plot object
        html += f'\n<div id = "{dom_id[1:]}"> </div>\n'

        # add d3js library
        html += f'<script charset="utf-8" src="{d3js}"></script>\n'

        # start JavaScript
        html += '<script charset="utf-8">\n'

        # add setup code to run d3js in multiple environments
        html += Template(setup_template).substitute(d3js=d3js)

        # start d3 environment
        html += "require(['d3'], function(d3){ //START\n"

        # add data and config
        html += f"const data = {data}\n"
        html += f"const config = {json.dumps(self.config)}\n"

        # add JavaScript
        html += js_template

        # end d3 environment
        html += "\n}); //END\n"

        # end JavaScript
        html += "\n</script>"

        return html

generate

Generate the plot.

Source code in src/pathpyG/visualisations/_d3js/core.py 
32
33
34
def generate(self) -> None:
    """Generate the plot."""
    raise NotImplementedError

save

Save the plot to the hard drive.

Source code in src/pathpyG/visualisations/_d3js/core.py 
36
37
38
39
def save(self, filename: str, **kwargs: Any) -> None:
    """Save the plot to the hard drive."""
    with open(filename, "w+") as new:
        new.write(self.to_html())

show

Show the plot on the device.

Source code in src/pathpyG/visualisations/_d3js/core.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
def show(self, **kwargs: Any) -> None:
    """Show the plot on the device."""
    if config["environment"]["interactive"]:
        from IPython.display import display_html, HTML

        display_html(HTML(self.to_html()))
    else:
        # create temporal file
        with tempfile.NamedTemporaryFile(delete=False) as temp_file:
            # save html
            self.save(temp_file.name)
            # open the file
            webbrowser.open(r"file:///" + temp_file.name)

to_html

Convert data to html.

Source code in src/pathpyG/visualisations/_d3js/core.py 
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def to_html(self) -> str:
    """Convert data to html."""
    # generate unique dom uids
    dom_id = "#x" + uuid.uuid4().hex

    # get path to the pathpy templates
    template_dir = os.path.join(
        os.path.dirname(os.path.dirname(__file__)),
        os.path.normpath("_d3js/templates"),
    )

    # get d3js version
    local = self.config.get("d3js_local", False)
    if local:
        d3js = os.path.join(template_dir, "d3.v5.min.js")
    else:
        d3js = "https://d3js.org/d3.v5.min.js"

    # get template files
    with open(os.path.join(template_dir, f"{self._kind}.js")) as template:
        js_template = template.read()

    with open(os.path.join(template_dir, "setup.js")) as template:
        setup_template = template.read()

    with open(os.path.join(template_dir, "styles.css")) as template:
        css_template = template.read()

    # load custom template
    _template = self.config.get("template", None)
    if _template and os.path.isfile(_template):
        with open(_template) as template:
            js_template = template.read()

    # load custom css template
    _template = self.config.get("css", None)
    if _template and os.path.isfile(_template):
        with open(_template) as template:
            css_template += template.read()

    # update config
    self.config["selector"] = dom_id
    data = self.to_json()

    # generate html file
    html = "<style>\n" + css_template + "\n</style>\n"

    # div environment for the plot object
    html += f'\n<div id = "{dom_id[1:]}"> </div>\n'

    # add d3js library
    html += f'<script charset="utf-8" src="{d3js}"></script>\n'

    # start JavaScript
    html += '<script charset="utf-8">\n'

    # add setup code to run d3js in multiple environments
    html += Template(setup_template).substitute(d3js=d3js)

    # start d3 environment
    html += "require(['d3'], function(d3){ //START\n"

    # add data and config
    html += f"const data = {data}\n"
    html += f"const config = {json.dumps(self.config)}\n"

    # add JavaScript
    html += js_template

    # end d3 environment
    html += "\n}); //END\n"

    # end JavaScript
    html += "\n</script>"

    return html

to_json

Convert data to json.

Source code in src/pathpyG/visualisations/_d3js/core.py 
55
56
57
def to_json(self) -> str:
    """Convert data to json."""
    raise NotImplementedError