Adds option for Slider to snap to discrete values #9137

jcalbert · 2017-08-31T17:11:06Z

PR Summary

Addresses #9129, allows the slider UI widget to snap to multiples of optional kwarg valstep.

PR Checklist

Has Pytest style unit tests
Code is PEP 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

…iples of 'valstep' (and valmax, if closedmax is True).

makes the value take on integer multiples of parameter valstep.

value.

in _update.

WeatherGod

Just a few small comments. Otherwise, this looks good. This will need a whats_new section, but if you hurry, it could get into v2.1 (cut is tonight, hopefully!)

WeatherGod · 2017-08-31T17:13:19Z

lib/matplotlib/widgets.py

-                 slidermax=None, dragging=True, **kwargs):
+    def __init__(self, ax, label, valmin, valmax, valstep=None, valinit=0.5,
+                 valfmt='%1.2f', closedmin=True, closedmax=True,
+                 slidermin=None, slidermax=None, dragging=True, **kwargs):


Don't change the order of the arguments in an existing function, even if they are keyword arguments.

What's the proper place to put them, before kwargs?

WeatherGod · 2017-08-31T17:14:35Z

lib/matplotlib/widgets.py

@@ -368,6 +372,8 @@ def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt='%1.2f',

    def _value_in_bounds(self, val):
        """ Makes sure self.val is with given bounds."""
+        if self.valstep:
+            val = round(val/self.valstep)*self.valstep


should use np.round() to get consistent behavior in python 2.7 and py3k.

tacaswell · 2017-08-31T17:18:39Z

I am 50/50 on rushing this for 2.1.

jcalbert · 2017-08-31T17:23:59Z

Before setting it in stone, a few questions about expected behavior:

Would it be preferable for the little blue bar to track the cursor while dragging, and then snap back to an allowed value on button_release?
For valmin=.2, valmax=4.5, valstep=1.0 should the points go [0.2, 1.2, 2.2, 3.2, 4.2, 4.5] or [0.2, 1.0, 2.0, 3.0, 4.0, 4.5] ?

WeatherGod · 2017-08-31T17:31:13Z

Personally, I think it should track the cursor. It provides visual feedback to the user that the slider is active. However, is it possible to implement without it reporting non-valid numbers?

For the second point, that's a toughie. I think I like the first option better.

jcalbert · 2017-08-31T19:50:34Z

@WeatherGod I tried a version with the tracking cursor, but I don't think it 'feels' right. Even with some tick marks as a guide, it feels like the UI is just being laggy. You can try it here.

dstansby

Nice new feature! Just a small formatting comment, but otherwise this looks good to me.

dstansby · 2017-09-05T16:17:34Z

doc/users/next_whats_new/2017-08-31_discrete-sliders.rst

@@ -0,0 +1,8 @@
+Slider UI widget can snap to discrete values
+--------------------------


These dashes should be exactly the same length as the title

jcalbert · 2017-09-05T20:49:49Z

By the way, in doing this PR noticed that the slider widget doesn't implement blitting like most of the other widgets do. Is that something worth looking into?

WeatherGod · 2017-09-05T21:07:01Z

Blitting makes sense for things like drawing a rubber band, but I doubt it'll really be useful for sliders. If people find that there is room for performance improvements, then possibly. For now, I'd leave that off.

…

On Tue, Sep 5, 2017 at 4:49 PM, J. ***@***.***> wrote: ^BTW, I noticed that the slider widget doesn't implement blitting like most of the other widgets do. Is that something worth looking into? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#9137 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARy-HqRZ8t_Zq6Yvu_qpt-tqxx_rd2Fks5sfbPugaJpZM4PJI1p> .

WeatherGod

Thank you for your patience. This looks good!

emmyzero added 5 commits August 31, 2017 11:45

Slider kwarg 'valstep' allows restricts slider values to integer mult…

82c64c2

…iples of 'valstep' (and valmax, if closedmax is True).

Second slider in slider_demo exhibits the valstep feature, which

d9d08b5

makes the value take on integer multiples of parameter valstep.

Better document the valstep feature.

62066d8

Don't redraw everything if we haven't actually changed the slider's

5b448c7

value.

Moved check for value change from inside set_val to its invocation

98fbf3c

in _update.

tacaswell added this to the 2.2 (next next feature release) milestone Aug 31, 2017

tacaswell added the topic: widgets/UI label Aug 31, 2017

WeatherGod reviewed Aug 31, 2017

View reviewed changes

Replace round() with np.round()

794894b

Moved new argument to avoid changing previous order.

1ad3a6b

emmyzero added 4 commits August 31, 2017 16:30

PEP8 compliance

adb20e2

Snap-to values behave more like np.arange now.

db6adff

Added relevant whats_new

9e45298

Formatting

e23b522

dstansby approved these changes Sep 5, 2017

View reviewed changes

Formatting fix.

07597b1

WeatherGod approved these changes Oct 17, 2017

View reviewed changes

WeatherGod merged commit ffc20d4 into matplotlib:master Oct 17, 2017

QuLogic modified the milestones: needs sorting, v2.2.0 Feb 13, 2018

dstansby mentioned this pull request May 7, 2018

Slider Class: Option for discrete values #9129

Closed

jcalbert deleted the discrete_slider branch May 3, 2019 23:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Adds option for Slider to snap to discrete values #9137

Adds option for Slider to snap to discrete values #9137

Uh oh!

jcalbert commented Aug 31, 2017 •

edited

Loading

Uh oh!

WeatherGod left a comment

Uh oh!

WeatherGod Aug 31, 2017

Uh oh!

jcalbert Aug 31, 2017

Uh oh!

WeatherGod Aug 31, 2017

Uh oh!

WeatherGod Aug 31, 2017

Uh oh!

tacaswell commented Aug 31, 2017

Uh oh!

jcalbert commented Aug 31, 2017

Uh oh!

WeatherGod commented Aug 31, 2017

Uh oh!

jcalbert commented Aug 31, 2017

Uh oh!

dstansby left a comment

Uh oh!

dstansby Sep 5, 2017

Uh oh!

jcalbert commented Sep 5, 2017 •

edited

Loading

Uh oh!

WeatherGod commented Sep 5, 2017 via email

Uh oh!

WeatherGod left a comment

Uh oh!

Uh oh!

		@@ -0,0 +1,8 @@
		Slider UI widget can snap to discrete values
		--------------------------

Uh oh!

Adds option for Slider to snap to discrete values #9137

Adds option for Slider to snap to discrete values #9137

Uh oh!

Conversation

jcalbert commented Aug 31, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

WeatherGod left a comment

Choose a reason for hiding this comment

Uh oh!

WeatherGod Aug 31, 2017

Choose a reason for hiding this comment

Uh oh!

jcalbert Aug 31, 2017

Choose a reason for hiding this comment

Uh oh!

WeatherGod Aug 31, 2017

Choose a reason for hiding this comment

Uh oh!

WeatherGod Aug 31, 2017

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Aug 31, 2017

Uh oh!

jcalbert commented Aug 31, 2017

Uh oh!

WeatherGod commented Aug 31, 2017

Uh oh!

jcalbert commented Aug 31, 2017

Uh oh!

dstansby left a comment

Choose a reason for hiding this comment

Uh oh!

dstansby Sep 5, 2017

Choose a reason for hiding this comment

Uh oh!

jcalbert commented Sep 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WeatherGod commented Sep 5, 2017 via email

Uh oh!

WeatherGod left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jcalbert commented Aug 31, 2017 •

edited

Loading

jcalbert commented Sep 5, 2017 •

edited

Loading