"""
Custom bokeh Widget models.
"""
from bokeh.core.enums import ButtonType
from bokeh.core.properties import (
Any, Bool, Either, Enum, Float, Instance, Int, List, Nullable, Override,
String, Tuple,
)
from bokeh.models.ui import Tooltip
from bokeh.models.ui.icons import Icon
from bokeh.models.widgets import (
Button as bkButton, CheckboxButtonGroup as bkCheckboxButtonGroup,
InputWidget, RadioButtonGroup as bkRadioButtonGroup, Select,
TextAreaInput as BkTextAreaInput, Widget,
)
from .layout import HTMLBox
[docs]class Player(Widget):
"""
The Player widget provides controls to play through a number of frames.
"""
start = Int(0, help="Lower bound of the Player slider")
end = Int(10, help="Upper bound of the Player slider")
value = Int(0, help="Current value of the player app")
value_throttled = Int(0, help="Current throttled value of the player app")
step = Int(1, help="Number of steps to advance the player by.")
interval = Int(500, help="Interval between updates")
direction = Int(0, help="""
Current play direction of the Player (-1: playing in reverse,
0: paused, 1: playing)""")
loop_policy = Enum('once', 'reflect', 'loop', default='once')
show_loop_controls = Bool(True, help="""Whether the loop controls
radio buttons are shown""")
width = Override(default=400)
height = Override(default=250)
[docs]class SingleSelect(InputWidget):
''' Single-select widget.
'''
disabled_options = List(Any, default=[], help="""
List of options to disable.
""")
options = List(Either(String, Tuple(String, String)), help="""
Available selection options. Options may be provided either as a list of
possible string values, or as a list of tuples, each of the form
``(value, label)``. In the latter case, the visible widget text for each
value will be corresponding given label.
""")
size = Int(default=4, help="""
The number of visible options in the dropdown list. (This uses the
``select`` HTML element's ``size`` attribute. Some browsers might not
show less than 3 options.)
""")
value = Nullable(String, help="Initial or selected value.")
class Audio(HTMLBox):
loop = Bool(False, help="""Whether the audio should loop""")
paused = Bool(False, help="""Whether the audio is paused""")
muted = Bool(False, help="""Whether the audio is muted""")
autoplay = Bool(False, help="""Whether the audio is playing automatically""")
time = Float(0, help="""
The current time stamp of the audio playback""")
throttle = Int(250, help="""
The frequency at which the time value is updated in milliseconds.""")
value = Any(help="Encoded file data")
volume = Nullable(Float, help="""The volume of the audio player.""")
class Video(HTMLBox):
loop = Bool(False, help="""Whether the video should loop""")
paused = Bool(False, help="""Whether the video is paused""")
muted = Bool(False, help="""Whether the video is muted""")
autoplay = Bool(False, help="""Whether the video is playing automatically""")
time = Float(0, help="""
The current time stamp of the video playback""")
throttle = Int(250, help="""
The frequency at which the time value is updated in milliseconds.""")
value = Any(help="Encoded file data")
volume = Int(help="""The volume of the video player.""")
class VideoStream(HTMLBox):
format = Enum('png', 'jpeg', default='png')
paused = Bool(False, help="""Whether the video is paused""")
snapshot = Bool(False, help="""On change generate a snapshot of the current video frame""")
timeout = Nullable(Int, help="""
The timeout between snapshots (if None snapshot only generated
when snapshot property is changed""")
value = Any(help="""Snapshot Data""")
height = Override(default=240)
width = Override(default=320)
class Progress(HTMLBox):
active = Bool(True, help="""Whether to animate the bar""")
bar_color = Enum('primary', 'secondary', 'success', 'info',
'danger', 'warning', 'light', 'dark', default='primary')
max = Int(100, help="""Maximum value""")
value = Nullable(Int, help="""Current value""")
css = List(String)
[docs]class FileDownload(InputWidget):
auto = Bool(False, help="""Whether to download on click""")
button_type = Enum(ButtonType, help="""
A style for the button, signifying it's role.
""")
clicks = Int(0, help="""
A private property that used to trigger ``on_click`` event handler.
""")
data = String(help="""Encoded URI data.""")
embed = Bool(False, help="""Whether the data is pre-embedded.""")
icon = Nullable(Instance(Icon), help="""
An optional image appearing to the left of button's text. An instance of
:class:`~bokeh.models.Icon` (such as :class:`~bokeh.models.BuiltinIcon`,
:class:`~bokeh.models.SVGIcon`, or :class:`~bokeh.models.TablerIcon`).`
""")
label = String("", help="""The text label for the button to display.""")
filename = String(help="""Filename to use on download""")
_transfers = Int(0, help="""
A private property to create and click the link.
""")
title = Override(default='')
[docs]class CustomSelect(Select):
''' Custom widget that extends the base Bokeh Select
by adding a parameter to disable one or more options.
'''
disabled_options = List(Any, default=[], help="""
List of options to disable.
""")
size = Int(default=1)
[docs]class TextAreaInput(BkTextAreaInput):
auto_grow = Bool(
default=False,
help="""
Whether the text area should automatically grow vertically to
accommodate the current text."""
)
max_rows = Nullable(Int(), help="""
Maximum number of rows the input area can grow to if auto_grow
is enabled."""
)
