Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add JupyterChart section to Users Guide #3137

Merged
merged 9 commits into from
Aug 10, 2023
Merged

Add JupyterChart section to Users Guide #3137

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7ea8079
Add JupyterChart section to Users Guide
jonmmease Aug 2, 2023
089c445
Add Limitations section
jonmmease Aug 3, 2023
e097995
Add images/videos to _static directory
jonmmease Aug 4, 2023
49d4529
ChartWidget -> JupyterChart
jonmmease Aug 4, 2023
94b7f06
Add limitation for setting selection states
jonmmease Aug 4, 2023
56c9fe0
Move filter query to separate line
jonmmease Aug 4, 2023
a9d4152
Handle ParameterName values
jonmmease Aug 10, 2023
5723c28
Rename section to JupyterChart Interactivity
jonmmease Aug 10, 2023
2ee9d76
Add info on converting point and interval selections to pandas query …
jonmmease Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/user_guide/data.rst
View file
Open in desktop
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this section should be just under the section "Interactive Charts". It is definitely the closest to that section thematically even if it is not as central to Altair as some of the other section. I also wonder if we should call this section `JupyterChart Interactivity" or something similar to more clearly signal what it is about.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed to "JupyterChart Interactivity" in 5723c28



.. toctree::
Expand Down
16 changes: 8 additions & 8 deletions doc/user_guide/interactions.rst
View file
Open in desktop
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