Dash 2.11 and later supports running Dash apps in classic Jupyter Notebooks and in JupyterLab without the need to update the code or use the additional JupyterDash library. If you are using an earlier version of Dash, you can run Dash apps in a notebook using JupyterDash. This page documents additional options available when running Dash apps in notebooks as well as troubleshooting information.
When you run an app in a cell, it displays inline by default:
<img>
External mode
You can also configure it to display a link to visit to view the app by using external mode:
app.run(jupyter_mode="external")
Tab mode
Use tab mode to automatically open the app in a new browser tab:
app.run(jupyter_mode="tab")
Jupyterlab mode
In jupyterlab mode, the notebook displays the app in a separate tab in JupyterLab.
app.run(jupyter_mode="jupyterlab")
<img>
To use jupyterlab mode, you’ll also need to build the @plotly/dash-jupyterlab extension. When you launch a new JupyterLab notebook after installing Dash, you’ll be prompted to build @plotly/dash-jupyterlab.
JupyterLab version 3 is required to run a Dash app in
jupyterlabmode.
Set the mode at a notebook level
In the above examples, we configure the jupyter_mode on the Dash app. You can also apply this setting at a notebook level so that all Dash apps rendered in the notebook use it. Here, we set the default mode to “external”:
from dash import jupyter_dash
jupyter_dash.default_mode="external"
Set the server URL for the app
By default, the app in external or tab mode is served at http://127.0.0.1:8050/ (the localhost address on port 8050) if you don’t set a different host or port on app.run. If you are using a hosted notebook, you will need to specify the URL used by that hosted environment. In Dash Enterprise workspaces, this is detected automatically and the external URL printed out in the notebook will be your Dash Enterprise app’s full URL. In other environments, you can configure the URL by setting jupyter_server_url on app.run:
app.run(jupyter_server_url="<your-url>")
In hosted environments, you can also use jupyter_dash.infer_jupyter_proxy_config(), which will attempt to detect the URL and path that the hosted environment uses.
For more details, see the troubleshooting section below.
Notes on display modes
- Setting jupyter_mode on an individual app within the notebook overrides the default mode for that app.
- jupyterlab and tab modes are not supported in Google Colab.
Dash apps run in a notebook at a default width of “100%” and height of “650”. You can configure these with jupyter_width and jupyter_height on app.run:
app.run(jupyter_height=500, jupyter_width="70%")
By default, any exceptions in your app’s callbacks display inline.
<img>
You can disable inline callback errors by setting jupyter_dash.inline_exceptions to False:
from dash import jupyter_dash
jupyter_dash.inline_exceptions = False
If you try to run a Dash app on a port that is already in use outside of the notebook (for example, if you have a Dash app running elsewhere on your computer), you’ll receive an “Address already in use” message in the notebook. To resolve, either stop the other process that is using the port, or specify a different port in the Dash app in the notebook.
Dash apps run on port 8050 by default. You can specify a different port in app.run:
python
app.run(port=8060)
If your notebook is hosted on a web server behind a proxy, Dash may not run correctly in your notebook. Try executing jupyter_dash.infer_jupyter_proxy_config() in a cell before your app and Dash will attempt to determine the proxy configuration.
```python
from dash import jupyter_dash
jupyter_dash.infer_jupyter_proxy_config()
```
Note: This may not work for all notebooks hosted on a web server behind a proxy. If you encounter an issue with a specific notebook environment, please open an issue in the Dash GitHub repo.