Skip to content

Commit

Permalink
Add JupyterChart section to Users Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jonmmease committed Aug 3, 2023
1 parent 0534853 commit 7ea8079
Show file tree
Hide file tree
Showing 3 changed files with 402 additions and 8 deletions.
1 change: 1 addition & 0 deletions doc/user_guide/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,7 @@ data before usage in Altair using GeoPandas for example as such:
customization
configuration
saving_charts
jupyter_chart


.. toctree::
Expand Down
16 changes: 8 additions & 8 deletions doc/user_guide/interactions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -991,11 +991,11 @@ For more information on how to fine-tune selections, including specifying other
mouse and keystroke options, see the `Vega-Lite Selection documentation
<https://vega.github.io/vega-lite/docs/selection.html>`_.

Limitations
~~~~~~~~~~~

Some possible use cases for the above interactivity are not currently supported by Vega-Lite, and hence are not currently supported by Altair. Here are some examples.

1. If we are using a ``selection_point``, it would be natural to want to return information about the chosen data point, and then process that information using Python. This is not currently possible, so any data processing will have to be handled using tools such as ``transform_calculate``, etc. You can follow the progress on this in the following issue: https://github.com/altair-viz/altair/issues/1153.

- The dashboarding package ``Panel`` has added support for processing Altair selections with custom callbacks in their 0.13 release. This is currently the only Python dashboarding package that supports custom callbacks for Altair selections and you can read more about how to use this functionality in `the Panel documentation <https://pyviz-dev.github.io/panel/reference/panes/Vega.html#selections>`_.
Access Params From Python
~~~~~~~~~~~~~~~~~~~~~~~~~
As of Vega-Altair 5.1, it's now possible to access the values of variable and selection parameters
from Python using the :ref:`user-guide-jupyterchart` class.

Additionally, the dashboarding package ``Panel`` includes support for processing Altair selections
with custom callbacks. See the
`Panel documentation <https://panel.holoviz.org/reference/panes/Vega.html#selections>`_.
Loading

0 comments on commit 7ea8079

Please sign in to comment.