SliderCustomValue#

class stixpy.visualisation.plotters.SliderCustomValue(*args, format_func=None, **kwargs)[source]#

Bases: Slider

A slider with a customisable formatter

Parameters:

  • ax (Axes) – The Axes to put the slider in.

  • label (str) – Slider label.

  • valmin (float) – The minimum value of the slider.

  • valmax (float) – The maximum value of the slider.

  • valinit (float, default: 0.5) – The slider initial position.

  • valfmt (str, default: None) – %-format string used to format the slider value. If None, a ScalarFormatter is used instead.

  • closedmin (bool, default: True) – Whether the slider interval is closed on the bottom.

  • closedmax (bool, default: True) – Whether the slider interval is closed on the top.

  • slidermin (Slider, default: None) – Do not allow the current slider to have a value less than the value of the Slider slidermin.

  • slidermax (Slider, default: None) – Do not allow the current slider to have a value greater than the value of the Slider slidermax.

  • dragging (bool, default: True) – If True the slider can be dragged by the mouse.

  • 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.

  • track_color (color, default: ‘lightgrey’) – The color of the background track. The track is accessible for further styling via the track attribute.

  • handle_style (dict) –

    Properties of the slider handle. Default values are

    Key

    Value

    Default

    Description

    facecolor

    color

    ’white’

    The facecolor of the slider handle.

    edgecolor

    color

    ’.75’

    The edgecolor of the slider handle.

    size

    int

    10

    The size of the slider handle in points.

    Other values will be transformed as marker{foo} and passed to the Line2D constructor. e.g. handle_style = {'style'='x'} will result in markerstyle = 'x'.

Notes

Additional kwargs are passed on to self.poly which is the Rectangle that draws the slider knob. See the Rectangle documentation for valid property names (facecolor, edgecolor, alpha, etc.).