allow not drawing the line marking initial slider position

ianhi · ianhi · commit 0baa16b50624 · 2020-11-07T22:47:51.000-05:00
diff --git a/examples/widgets/slider_snap_demo.py b/examples/widgets/slider_snap_demo.py
@@ -1,9 +1,9 @@
 """
-==========================
-Slider Value Snapping Demo
-==========================
+===================================
+Snapping Sliders to Discrete Values
+===================================
 
-You can snap slider values to a discrete values using the ``valstep`` argument.
+You can snap slider values to discrete values using the ``valstep`` argument.
 
 In this example the Freq slider is constrained to be multiples of pi, and the
 Amp slider uses an array as the ``valstep`` argument to more densely sample
@@ -39,10 +39,8 @@
 sfreq = Slider(
     ax_freq, "Freq", 0, 10*np.pi,
     valinit=2*np.pi, valstep=np.pi,
-    initcolor=None
+    initcolor='none' # Remove the line marking the valinit position.
 )
-# initcolor is set to None to remove the line marking the valinit position
-
 
 def update(val):
     amp = samp.val
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -255,7 +255,7 @@ class Slider(AxesWidget):
     def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt=None,
                  closedmin=True, closedmax=True, slidermin=None,
                  slidermax=None, dragging=True, valstep=None,
-                 orientation='horizontal', **kwargs):
+                 orientation='horizontal', *, initcolor='r', **kwargs):
         """
         Parameters
         ----------
@@ -295,13 +295,17 @@ def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt=None,
         dragging : bool, default: True
             If True the slider can be dragged by the mouse.
 
-        valstep : float or arraylike, default: None
+        valstep : float or array-like, default: None
             If a float, the slider will snap to multiples of *valstep*.
             If an array the slider will snap to the values in the array.
 
         orientation : {'horizontal', 'vertical'}, default: 'horizontal'
             The orientation of the slider.
 
+        initcolor : color, default: 'r'
+            The color of the line at the *valinit* position. Set to ``'none'``
+            for no line.
+
         Notes
         -----
         Additional kwargs are passed on to ``self.poly`` which is the
@@ -338,10 +342,10 @@ def __init__(self, ax, label, valmin, valmax, valinit=0.5, valfmt=None,
         self.valinit = valinit
         if orientation == 'vertical':
             self.poly = ax.axhspan(valmin, valinit, 0, 1, **kwargs)
-            self.hline = ax.axhline(valinit, 0, 1, color='r', lw=1)
+            self.hline = ax.axhline(valinit, 0, 1, color=initcolor, lw=1)
         else:
             self.poly = ax.axvspan(valmin, valinit, 0, 1, **kwargs)
-            self.vline = ax.axvline(valinit, 0, 1, color='r', lw=1)
+            self.vline = ax.axvline(valinit, 0, 1, color=initcolor, lw=1)
 
         if orientation == 'vertical':
             ax.set_ylim((valmin, valmax))
