Inheritance diagram for MPCDAnalysis.PlotTools.DiscreteSliderWidget:
Collaboration diagram for MPCDAnalysis.PlotTools.DiscreteSliderWidget:
Public Member Functions | |
| def | __init__ (self, *args, **kwargs) |
| def | set_val (self, continuousValue) |
Public Attributes | |
| val | |
Detailed Description
A matplotlib-compatible slider widget, the values of which are discrete.
Definition at line 87 of file PlotTools.py.
Constructor & Destructor Documentation
◆ __init__()
| def MPCDAnalysis.PlotTools.DiscreteSliderWidget.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs | ||
| ) |
The constructor.
The following keyword arguments are accepted for speacial treatment in
this class:
- `stepSize` specifies the step size with which the slider is allowed
to move. That is, values that can be taken on by the slider are
integer multiples of `stepSize`. This value must be of type `int` and
be positive. Defaults to `1`.
@throw TypeError
Throws if any of the parameters described in the main body of
the documentation of this class is of the wrong type.
@throw ValueError
Throws if any of the parameters described in the main body of
the documentation of this class has an invalid value.
@param[in] args
Positional arguments, which will be passed to the base class'
constructor.
@param[in] kwargs
Keyword arguments, which will be passed to the base class'
constructor, with the exception of the keyword arguments
described in the main body of the documentation of this
function.
Definition at line 116 of file PlotTools.py.
Member Function Documentation
◆ set_val()
| def MPCDAnalysis.PlotTools.DiscreteSliderWidget.set_val | ( | self, | |
| continuousValue | |||
| ) |
Called when the slider moves.
@param[in] continuousValue
The value the slider has been moved to, as a continuous
variable.
Definition at line 141 of file PlotTools.py.
The documentation for this class was generated from the following file:
