# Copyright 2019-2020 QuantumBlack Visual Analytics Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
# NONINFRINGEMENT. IN NO EVENT WILL THE LICENSOR OR OTHER CONTRIBUTORS
# BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
# The QuantumBlack Visual Analytics Limited ("QuantumBlack") name and logo
# (either separately or in combination, "QuantumBlack Trademarks") are
# trademarks of QuantumBlack. The License does not grant you any right or
# license to the QuantumBlack Trademarks. You may not use the QuantumBlack
# Trademarks or any confusingly similar mark as a trademark for your product,
# or use the QuantumBlack Trademarks in any other manner that might cause
# confusion in the marketplace, including but not limited to in advertising,
# on websites, or on software.
#
# See the License for the specific language governing permissions and
# limitations under the License.
"""Methods to display styled pyvis plots."""
import json
from html import escape
from typing import Dict
from IPython.lib.display import IFrame
from pyvis.network import Network
[docs]def display_plot_ipython(
viz: Network,
output_filename: str,
layout_kwargs: Dict[str, Dict] = None,
) -> IFrame:
"""
Displays a PyVis object using ipython.
Args:
viz: pyvis object to render.
output_filename: write html to a given path, e.g. "./plot.html". File as to end in ".html"
layout_kwargs: Dictionary to set the `layout` and `physics` of the graph.
Example:
::
>>> layout_kwargs = {
"physics": {
"solver": "repulsion"
},
"layout": {
"hierarchical": {
"enabled": True
}
}
}
Returns:
IPython IFrame object. Renders in a notebook.
Raises:
ImportError: if IPython is not installed (optional dependency).
"""
layout_kwargs = layout_kwargs or {}
viz.set_options(options=json.dumps(layout_kwargs))
html = viz.generate_html()
with open(output_filename, mode="w", encoding="UTF-8") as f:
f.write(html)
return IFrame(
src=output_filename,
width=viz.width,
height=viz.height,
extras=[f"srcdoc='{escape(viz.generate_html(notebook=False))}'"],
)