From cb24bd3ef13a59dc584ceeceed3b7d08b81d21c0 Mon Sep 17 00:00:00 2001 From: Jon Mease Date: Sat, 16 Dec 2023 08:30:21 -0500 Subject: [PATCH] Add jupyter renderer doc section --- doc/user_guide/display_frontends.rst | 6 ++++++ doc/user_guide/jupyter_chart.rst | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/user_guide/display_frontends.rst b/doc/user_guide/display_frontends.rst index ad418bea8..573962e62 100644 --- a/doc/user_guide/display_frontends.rst +++ b/doc/user_guide/display_frontends.rst @@ -40,6 +40,12 @@ The most used built-in renderers are: newer versions of JupyterLab_, nteract_, and `VSCode-Python`_, but does not work with the `Jupyter Notebook`_, or with tools like nbviewer_ and nbconvert_. +``alt.renderers.enable("jupyter")`` + *(added in version 5.3.0):* Output the chart using :ref:`user-guide-jupyterchart`. This renderer + is compatible with environments that support third-party Jupyter Widgets including + JupyterLab_, `Jupyter Notebook`_, `VSCode-Python`_, and `Colab`_. + It requires a web connection in order to load relevant Javascript libraries. + In addition, Altair includes the following renderers: - ``"default"``, ``"colab"``, ``"kaggle"``, ``"zeppelin"``: identical to ``"html"`` diff --git a/doc/user_guide/jupyter_chart.rst b/doc/user_guide/jupyter_chart.rst index 92ac6944c..d2bcaa63a 100644 --- a/doc/user_guide/jupyter_chart.rst +++ b/doc/user_guide/jupyter_chart.rst @@ -1,7 +1,7 @@ .. _user-guide-jupyterchart: -JupyterChart Interactivity -========================== +JupyterChart +============ The ``JupyterChart`` class, introduced in Vega-Altair 5.1, makes it possible to update charts after they have been displayed and access the state of :ref:`user-guide-interactions` from Python.