-
Notifications
You must be signed in to change notification settings - Fork 862
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Implement Slider class for JupyterViz
This provides API parity with the previous Tornado viz.
- Loading branch information
Showing
4 changed files
with
92 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
class UserParam: | ||
_ERROR_MESSAGE = "Missing or malformed inputs for '{}' Option '{}'" | ||
|
||
def maybe_raise_error(self, param_type, valid): | ||
if valid: | ||
return | ||
msg = self._ERROR_MESSAGE.format(param_type, self.label) | ||
raise ValueError(msg) | ||
|
||
|
||
class Slider(UserParam): | ||
""" | ||
A number-based slider input with settable increment. | ||
Example: | ||
slider_option = Slider("My Slider", value=123, min=10, max=200, step=0.1) | ||
Args: | ||
label: The displayed label in the UI | ||
value: The initial value of the slider | ||
min: The minimum possible value of the slider | ||
max: The maximum possible value of the slider | ||
step: The step between min and max for a range of possible values | ||
dtype: either int or float | ||
""" | ||
|
||
def __init__( | ||
self, | ||
label="", | ||
value=None, | ||
min=None, | ||
max=None, | ||
step=1, | ||
dtype=None, | ||
): | ||
self.label = label | ||
self.value = value | ||
self.min = min | ||
self.max = max | ||
self.step = step | ||
|
||
# Validate option type to make sure values are supplied properly | ||
valid = not (self.value is None or self.min is None or self.max is None) | ||
self.maybe_raise_error("slider", valid) | ||
|
||
if dtype is None: | ||
self.is_float_slider = self._check_values_are_float(value, min, max, step) | ||
else: | ||
self.is_float_slider = dtype == float | ||
|
||
def _check_values_are_float(self, value, min, max, step): | ||
return any(isinstance(n, float) for n in (value, min, max, step)) | ||
|
||
def get(self, attr): | ||
return getattr(self, attr) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
from .jupyter_viz import JupyterViz, make_text # noqa | ||
from .jupyter_viz import JupyterViz, make_text, Slider # noqa |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters