Add support for opts in explorer #1159

ahuang11 · 2023-10-01T07:35:35Z

As title says, allows using opts; very crude at the moment simply using dict, but it's still useful as an escape hatch.

* WIP overlaying rasterized * Clean up * Add rasterize to check for categorical * Add test * Add version check * Update hvplot/converter.py Co-authored-by: Simon Høxbro Hansen <simon.hansen@me.com> --------- Co-authored-by: Simon Høxbro Hansen <simon.hansen@me.com>

* Add version check for test * commit

…explorer (#1146) * call param.objects() after super().__init__ * add tests * update the docs * update error message

* Add autorange option * Add small documentation about autorange --------- Co-authored-by: Simon Høxbro Hansen <simon.hansen@me.com>

maximlt · 2023-10-03T22:26:40Z

I'm not sure to be convinced by this functionality, it seems to only cater to advanced users while it is likely a lot of explorer users are beginner hvPlot users (since it's a good way to access hvPlot's plotting API without having to learn dozens of parameters). I can easily imagine there will be a lot of users clicking on this generic Opts tab and being puzzled by what they see.

If it's a feature that you believe would have unblocked you while working with the explorer, let's see how it could be adapted so that it's obvious it's for advanced usage. For instance, it's not uncommon for GUIs have advanced options that are made visible only after ticking a checkbox. Some text around the options widget would also help understand what kind of input you can provide, with an example.

ahuang11 · 2023-10-04T02:49:01Z

I don't view the explorer as just for beginners. I imagine it's for both beginners and advanced users, with advanced users eventually using it to quickly take a look at their files as others have described here (once CLI is designed and released) . One of the things users need to quickly take a look is adjusting the colorbar like this.

I agree that additional text can be added to help the user out.

maximlt

For this PR to be merged and released in hvPlot 0.9.0, in addition to my inline comments I'd add that:

I'd suggest renaming the tab to Advanced and for this tab to be the last one.
I'd suggest adding text above the options input to indicate how to use it, what data it accepts (an example could help).

I've tried to run the explorer but the tabs don't show. Ah I realized just know this PR is not targeting main but another PR, something is broken.

hvplot/ui.py

hvplot/tests/testui.py

maximlt · 2023-10-08T20:30:16Z

hvplot/ui.py

        df = self._data
        if len(df) > MAX_ROWS and not (self.kind in KINDS["stats"] or kwargs.get('rasterize') or kwargs.get('datashade')):
            df = df.sample(n=MAX_ROWS)
        self._layout.loading = True
        try:
            self._hvplot = _hvPlot(df)(
                kind=self.kind, x=self.x, y=y, by=self.by, groupby=self.groupby, **kwargs
-            )
+            ).opts(**opts_kwargs)


Why not the options to the converter directly? hvPlot has some special options handling given the backend configuration https://hvplot.holoviz.org/user_guide/Plotting_Extensions.html#plot-styling-options

I wasn't aware that was available, but from my experience, it's less robust, and not all opts are available.

Co-authored-by: Maxime Liquet <35924738+maximlt@users.noreply.github.com>

ahuang11 · 2023-10-09T20:03:33Z

To address the following:

I'd suggest renaming the tab to Advanced and for this tab to be the last one.
I'd suggest adding text above the options input to indicate how to use it, what data it accepts (an example could help).

Renamed to advanced and add a doc tooltip which could be copied / pasted. I didn't like how adding text above looked.

I've tried to run the explorer but the tabs don't show. Ah I realized just know this PR is not targeting main but another PR, something is broken.

In regards to that, during a merge conflict, I confused self._tabs with pn.Tabs(plot, code) and dropped self._tabs. I renamed self._tabs -> self._control_tabs for clarity.

hvplot/ui.py

maximlt · 2023-10-10T07:54:23Z

Thanks for renaming the tab, I find that much clearer! The tooltip is also very useful.

I need to think more about using .opts(). This is hvPlot and I consider the explorer to be an easy way to learn how to use hvPlot's API, I'm not sure about steering users towards .opts(), specially since hvPlot has some support for passing down options to HoloViews. I've observed with you that it doesn't always work as you'd expect, e.g. color_levels isn't supported, I need to check again how the options (plot, style, norm) are handled.

hvplot/ui.py

ahuang11 · 2023-10-10T14:50:22Z

To me, opts is essential to get the final plot desired. Here's another example that I don't think hvplot alone can do:

import hvplot.xarray
import xarray as xr

df = xr.tutorial.open_dataset("air_temperature")
df.hvplot("lon", "lat").opts(colorbar_opts={"title": "Air Temperature", "width": 10, "bar_line_alpha": 0})

learn how to use hvPlot's API

Opts can also be a convenient way for users to understand the connection between hvplot + holoviews.

hoxbro and others added 30 commits July 30, 2022 17:40

Enhancement to Geo tab in explorer

3af4174

Naming the geo_controls

5242f88

Merge branch 'master' into explorer_enhancement_geo

eefcc28

Only setting default value if not set

433100f

Merge branch 'main' into explorer_enhancement_geo

734c6c9

DEBUG: Try to fix failing tests

997375a

Try without pin

7b90c56

Step towards implementing xarray explorer

ba21dc9

Group by kinds and add auto refresh

69854e0

Fix layout and by

7ef37a0

Add back geo

a8c6a51

Tweak y_multi

d7323ca

Fix missing kwarg

cc1d8d2

Add tests

ac94126

Add more tests

4279754

Improve defaults

c04f38e

Fix geo

d4144e2

Prevent class name conflict with kwarg geo and fix tests

a7e6da7

Add docs

4ffcfa0

Improve default

92605c7

Add code tab

67f3cbf

Fix tests

006f997

Refactor into param, add tests, docs

8f7be4d

Update hvplot/ui.py

59d9b39

Add another test and fix

a0eb5f5

Handle wkt format (#1092)

ba9eb92

Add version check for test (#1144)

98c2612

* Add version check for test * commit

Param 2: don't call param.objects() before super().__init__ in the …

8923efe

…explorer (#1146) * call param.objects() after super().__init__ * add tests * update the docs * update error message

Add autorange option (#1128)

4a9b8d2

* Add autorange option * Add small documentation about autorange --------- Co-authored-by: Simon Høxbro Hansen <simon.hansen@me.com>

ahuang11 and others added 3 commits October 1, 2023 00:18

Add opts

e54fcc6

Merge branch 'main' into hvplot_gridded_explorer

dd1a00e

Merge branch 'hvplot_gridded_explorer' into explorer_code

b7ea90f

ahuang11 added this to the 0.9.0 milestone Oct 1, 2023

ahuang11 added 3 commits October 1, 2023 03:40

Merge branch 'explorer_code' into add_opts

3ed8142

Update hvplot/ui.py

7db9198

Merge branch 'explorer_code' into add_opts

57c29fd

maximlt reviewed Oct 8, 2023

View reviewed changes

ahuang11 and others added 11 commits October 8, 2023 16:51

Update hvplot/ui.py

8dee660

Co-authored-by: Maxime Liquet <35924738+maximlt@users.noreply.github.com>

Update hvplot/ui.py

33e9c2c

Fix tests

4e9a946

Update hvplot/ui.py

be87151

Co-authored-by: Maxime Liquet <35924738+maximlt@users.noreply.github.com>

Update hvplot/ui.py

308145b

Fix tests

6892af5

Add opts

8133a02

Address comments

10c20bc

Merge branch 'explorer_code' into add_opts

447dcfc

Fix merge conflict

a8904f4

Add doc

35310cc

maximlt reviewed Oct 10, 2023

View reviewed changes

hvplot/ui.py Outdated Show resolved Hide resolved

ahuang11 commented Oct 10, 2023

View reviewed changes

hvplot/ui.py Outdated Show resolved Hide resolved

Update hvplot/ui.py

ab65b99

Base automatically changed from explorer_code to main October 12, 2023 16:17

maximlt mentioned this pull request Oct 12, 2023

Add support for opts in explorer (v2) #1171

Merged

maximlt closed this Oct 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for opts in explorer #1159

Add support for opts in explorer #1159

ahuang11 commented Oct 1, 2023 •

edited

maximlt commented Oct 3, 2023

ahuang11 commented Oct 4, 2023 •

edited

maximlt left a comment

maximlt Oct 8, 2023

ahuang11 Oct 9, 2023 •

edited

ahuang11 commented Oct 9, 2023 •

edited

maximlt commented Oct 10, 2023

ahuang11 commented Oct 10, 2023 •

edited

Add support for opts in explorer #1159

Add support for opts in explorer #1159

Conversation

ahuang11 commented Oct 1, 2023 • edited

maximlt commented Oct 3, 2023

ahuang11 commented Oct 4, 2023 • edited

maximlt left a comment

Choose a reason for hiding this comment

maximlt Oct 8, 2023

Choose a reason for hiding this comment

ahuang11 Oct 9, 2023 • edited

Choose a reason for hiding this comment

ahuang11 commented Oct 9, 2023 • edited

maximlt commented Oct 10, 2023

ahuang11 commented Oct 10, 2023 • edited

ahuang11 commented Oct 1, 2023 •

edited

ahuang11 commented Oct 4, 2023 •

edited

ahuang11 Oct 9, 2023 •

edited

ahuang11 commented Oct 9, 2023 •

edited

ahuang11 commented Oct 10, 2023 •

edited