shyft.dashboard.widgets.sliders¶
Classes
|
Create new instance of RangeSliderData(start, end, step, range, callback) |
|
A slider widget to select a range of values between two values and send it onward via a port. |
|
Create new instance of SliderData(start, end, step, value, callback) |
|
A slider widget to select a value between two values and send it onward via a port. |
- class shyft.dashboard.widgets.sliders.SliderData(start, end, step, value, callback)[source]¶
Bases:
NamedTupleCreate new instance of SliderData(start, end, step, value, callback)
- Parameters:
start (int)
end (int)
step (int)
value (int)
callback (bool)
- start: int¶
Alias for field number 0
- end: int¶
Alias for field number 1
- step: int¶
Alias for field number 2
- value: int¶
Alias for field number 3
- callback: bool¶
Alias for field number 4
- class shyft.dashboard.widgets.sliders.RangeSliderData(start, end, step, range, callback)[source]¶
Bases:
NamedTupleCreate new instance of RangeSliderData(start, end, step, range, callback)
- Parameters:
start (int)
end (int)
step (int)
range (Tuple[float, float])
callback (bool)
- start: int¶
Alias for field number 0
- end: int¶
Alias for field number 1
- step: int¶
Alias for field number 2
- range: Tuple[float, float]¶
Alias for field number 3
- callback: bool¶
Alias for field number 4
- class shyft.dashboard.widgets.sliders.SliderSelect(start, step, end, width=210, height=50, title='slider', padding=None, sizing_mode=None, logger=None, **kwargs)[source]¶
Bases:
WidgetA slider widget to select a value between two values and send it onward via a port.
- Parameters:
start (int)
step (int)
end (int)
width (int)
height (int)
title (str)
padding (int | None)
sizing_mode (str | None)
logger (LoggerBox | None)
- __init__(start, step, end, width=210, height=50, title='slider', padding=None, sizing_mode=None, logger=None, **kwargs)[source]¶
A slider widget to select a value between two values and send it onward via a port.
- Parameters:
start (int)
step (int)
end (int)
width (int)
height (int)
title (str)
padding (int | None)
sizing_mode (str | None)
logger (LoggerBox | None)
- Return type:
None
- property layout: LayoutDOM¶
- property layout_components: Dict[str, List[Any]]¶
Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.
- Returns:
layout_components as
- Return type:
{‘widgets’: [], ‘figures’: []}
- class shyft.dashboard.widgets.sliders.RangeSliderSelect(start, step, end, width=210, height=50, title='slider', value=None, padding=None, sizing_mode=None, logger=None, show_value=False, **kwargs)[source]¶
Bases:
WidgetA slider widget to select a range of values between two values and send it onward via a port.
- Parameters:
start (int)
step (int)
end (int)
width (int)
height (int)
title (str)
value (Tuple[int, int] | None)
padding (int | None)
sizing_mode (str | None)
logger (LoggerBox | None)
show_value (bool)
- __init__(start, step, end, width=210, height=50, title='slider', value=None, padding=None, sizing_mode=None, logger=None, show_value=False, **kwargs)[source]¶
A slider widget to select a range of values between two values and send it onward via a port.
- Parameters:
start (int)
step (int)
end (int)
width (int)
height (int)
title (str)
value (Tuple[int, int] | None)
padding (int | None)
sizing_mode (str | None)
logger (LoggerBox | None)
show_value (bool)
- Return type:
None
- property layout: LayoutDOM¶
- property layout_components: Dict[str, List[Any]]¶
Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.
- Returns:
layout_components as
- Return type:
{‘widgets’: [], ‘figures’: []}