Add styling support to Check and Radio buttons

QuLogic · QuLogic · commit 5f49bd9bd1a5 · 2023-01-12T23:12:50.000-05:00
diff --git a/examples/widgets/check_buttons.py b/examples/widgets/check_buttons.py
@@ -20,9 +20,9 @@
 s2 = np.sin(6*np.pi*t)
 
 fig, ax = plt.subplots()
-l0, = ax.plot(t, s0, visible=False, lw=2, color='k', label='2 Hz')
-l1, = ax.plot(t, s1, lw=2, color='r', label='4 Hz')
-l2, = ax.plot(t, s2, lw=2, color='g', label='6 Hz')
+l0, = ax.plot(t, s0, visible=False, lw=2, color='k', label='1 Hz')
+l1, = ax.plot(t, s1, lw=2, color='r', label='2 Hz')
+l2, = ax.plot(t, s2, lw=2, color='g', label='3 Hz')
 fig.subplots_adjust(left=0.2)
 
 lines_by_label = {l.get_label(): l for l in [l0, l1, l2]}
@@ -32,7 +32,10 @@
 check = CheckButtons(
     ax=rax,
     labels=lines_by_label.keys(),
-    actives=[l.get_visible() for l in lines_by_label.values()]
+    actives=[l.get_visible() for l in lines_by_label.values()],
+    label_props={'color': ['k', 'r', 'g']},
+    frame_props={'edgecolor': ['k', 'r', 'g']},
+    check_props={'facecolor': ['k', 'r', 'g']},
 )
 
 
diff --git a/examples/widgets/radio_buttons.py b/examples/widgets/radio_buttons.py
@@ -25,23 +25,31 @@
 
 axcolor = 'lightgoldenrodyellow'
 rax = fig.add_axes([0.05, 0.7, 0.15, 0.15], facecolor=axcolor)
-radio = RadioButtons(rax, ('2 Hz', '4 Hz', '8 Hz'))
+radio = RadioButtons(rax, ('1 Hz', '2 Hz', '4 Hz'),
+                     label_props={'color': 'cmy', 'fontsize': [12, 18, 24]},
+                     radio_props={'s': [16, 32, 64]})
 
 
 def hzfunc(label):
-    hzdict = {'2 Hz': s0, '4 Hz': s1, '8 Hz': s2}
+    hzdict = {'1 Hz': s0, '2 Hz': s1, '4 Hz': s2}
     ydata = hzdict[label]
     l.set_ydata(ydata)
-    plt.draw()
+    fig.canvas.draw()
 radio.on_clicked(hzfunc)
 
 rax = fig.add_axes([0.05, 0.4, 0.15, 0.15], facecolor=axcolor)
-radio2 = RadioButtons(rax, ('red', 'blue', 'green'))
+radio2 = RadioButtons(
+    rax, ('red', 'blue', 'green'),
+    label_props={'color': ['red', 'blue', 'green']},
+    radio_props={
+        'facecolor': ['red', 'blue', 'green'],
+        'edgecolor': ['darkred', 'darkblue', 'darkgreen'],
+    })
 
 
 def colorfunc(label):
     l.set_color(label)
-    plt.draw()
+    fig.canvas.draw()
 radio2.on_clicked(colorfunc)
 
 rax = fig.add_axes([0.05, 0.1, 0.15, 0.15], facecolor=axcolor)
@@ -50,7 +58,7 @@ def colorfunc(label):
 
 def stylefunc(label):
     l.set_linestyle(label)
-    plt.draw()
+    fig.canvas.draw()
 radio3.on_clicked(stylefunc)
 
 plt.show()
diff --git a/lib/matplotlib/tests/test_widgets.py b/lib/matplotlib/tests/test_widgets.py
@@ -1017,6 +1017,21 @@ def test_radio_buttons(fig_test, fig_ref):
     ax.text(.25, 1/3, "coffee", transform=ax.transAxes, va="center")
 
 
+@check_figures_equal(extensions=['png'])
+def test_radio_buttons_props(fig_test, fig_ref):
+    label_props = {'color': ['red'], 'fontsize': [24]}
+    radio_props = {'facecolor': 'green', 'edgecolor': 'blue', 'linewidth': 2}
+
+    widgets.RadioButtons(fig_ref.subplots(), ['tea', 'coffee'],
+                         label_props=label_props, radio_props=radio_props)
+
+    cb = widgets.RadioButtons(fig_test.subplots(), ['tea', 'coffee'])
+    cb.set_label_props(label_props)
+    # Setting the label size automatically increases default marker size, so we
+    # need to do that here as well.
+    cb.set_radio_props({**radio_props, 's': (24 / 2)**2})
+
+
 @check_figures_equal(extensions=["png"])
 def test_check_buttons(fig_test, fig_ref):
     widgets.CheckButtons(fig_test.subplots(), ["tea", "coffee"], [True, True])
@@ -1029,6 +1044,29 @@ def test_check_buttons(fig_test, fig_ref):
     ax.text(.25, 1/3, "coffee", transform=ax.transAxes, va="center")
 
 
+@check_figures_equal(extensions=['png'])
+def test_check_button_props(fig_test, fig_ref):
+    label_props = {'color': ['red'], 'fontsize': [24]}
+    frame_props = {'facecolor': 'green', 'edgecolor': 'blue', 'linewidth': 2}
+    check_props = {'facecolor': 'red', 'linewidth': 2}
+
+    widgets.CheckButtons(fig_ref.subplots(), ['tea', 'coffee'], [True, True],
+                         label_props=label_props, frame_props=frame_props,
+                         check_props=check_props)
+
+    cb = widgets.CheckButtons(fig_test.subplots(), ['tea', 'coffee'],
+                              [True, True])
+    cb.set_label_props(label_props)
+    # Setting the label size automatically increases default marker size, so we
+    # need to do that here as well.
+    cb.set_frame_props({**frame_props, 's': (24 / 2)**2})
+    # FIXME: Axes.scatter promotes facecolor to edgecolor on unfilled markers,
+    # but Collection.update doesn't do that (it forgot the marker already).
+    # This means we cannot pass facecolor to both setters directly.
+    check_props['edgecolor'] = check_props.pop('facecolor')
+    cb.set_check_props({**check_props, 's': (24 / 2)**2})
+
+
 @check_figures_equal(extensions=["png"])
 def test_check_buttons_rectangles(fig_test, fig_ref):
     # Test should be removed once .rectangles is removed
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
