Skip to main content

A diagram visualization extension for JupyterLab and Jupyter Notebooks powered by yFiles for HTML

Project description

yFiles Graphs for Jupyter logo

PyPI version

A graph diagram visualization widget for Jupyter Notebooks and Labs powered by yFiles for HTML.

A screenshot showing the yFiles graph widget in a jupyter lab notebook



If you already have Jupyter installed, just pip install the prebuilt extension from the Python Package Index.

pip install yfiles_jupyter_graphs

If you want to start clean and get a fresh new Jupyter Lab with the widget readily installed and available, you can use docker, too:

Form a shell, create a docker image that contains all that is required:

mkdir yfiles-jupyter && cd yfiles-jupyter
echo -e "FROM jupyter/scipy-notebook\nRUN pip install yfiles-jupyter-graphs" > Dockerfile
docker build -t yfiles-jupyter-graphs-on-docker .

(the above has been tested successfully with scipy-notebook:lab-3.4.7 and yfiles-jupyter-graphs==1.2.1), but we want to make sure that it will also work with upcoming versions - file an issue if it doesn't work for you!)

You can then create a fresh new instance of your server from this image like so:

docker run -it -p 8888:8888 --name yfiles-jupyter yfiles-jupyter-graphs-on-docker


In a notebook which has the wiget installed in the server, in a Python cell, you can then do this:


"""Execute in jupyter notebook or jupyter lab"""
from yfiles_jupyter_graphs import GraphWidget
# shows empty widget

You can find the full documentation here.


neighborhood sidebar See Node Neighborhood layouts Choose Graph Layout
data sidebar Investigate Nodes or Edges Data search sidebar Search for Nodes or Edges
importer Import Graph Data element color mapping Make Data Dependent Property Changes

For example code look here.


You can find the documentation here.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to


This widget is by no means perfect. If you find something is not working as expected we are glad to receive an issue report from you. Please make sure to search for existing issues first and check if the issue is not an unsupported feature or known issue. If you did not find anything related, report a new issue with necessary information. Please also provide a clear and descriptive title and stick to the issue templates. See issues.



See LICENSE file.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yfiles_jupyter_graphs-1.3.2.tar.gz (7.8 MB view hashes)

Uploaded Source

Built Distribution

yfiles_jupyter_graphs-1.3.2-py2.py3-none-any.whl (14.6 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page