Various kinds of input widgets and form controls.
AutocompleteInput
Bases: bokeh.models.widgets.inputs.TextInput
bokeh.models.widgets.inputs.TextInput
Single-line input widget with auto-completion.
align
property type: Either ( Enum ( Align ), Tuple ( Enum ( Align ), Enum ( Align ) ) )
Either
Enum
Align
Tuple
The alignment point within the parent container.
This property is useful only if this component is a child element of a layout (e.g. a grid). Self alignment can be overridden by the parent container (e.g. grid track align).
aspect_ratio
property type: Either ( Enum ( Enumeration(auto) ), Float )
Float
Describes the proportional relationship between component’s width and height.
This works if any of component’s dimensions are flexible in size. If set to a number, width / height = aspect_ratio relationship will be maintained. Otherwise, if set to "auto", component’s preferred width and height will be used to determine the aspect (if not set, no aspect will be preserved).
width / height = aspect_ratio
"auto"
background
property type: Color
Color
Background color of the component.
completions
property type: List ( String )
List
String
A list of completion strings. This will be used to guide the user upon typing the beginning of a desired value.
css_classes
A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.
It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.
default_size
property type: Int
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
disabled
property type: Bool
Bool
Whether the widget will be disabled when rendered.
If True, the widget will be greyed-out and not responsive to UI events.
True
height
property type: NonNegativeInt
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
height_policy
property type: Either ( Auto , Enum ( SizingPolicy ) )
Auto
SizingPolicy
Describes how the component should maintain its height.
Use component’s preferred sizing policy.
"fixed"
Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit"
Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min"
Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max"
Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
Note
This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.
sizing_mode
js_event_callbacks
property type: Dict ( String , List ( Instance ( CustomJS ) ) )
Dict
Instance
CustomJS
A mapping of event names to lists of CustomJS callbacks.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:
Model.js_on_event
callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
js_property_callbacks
A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:
Model.js_on_change
callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
margin
property type: Tuple ( Int , Int , Int , Int )
Allows to create additional space around the component.
max_height
Minimal height of the component (in pixels) if height is adjustable.
max_width
Minimal width of the component (in pixels) if width is adjustable.
min_characters
property type: PositiveInt
PositiveInt
The number of characters a user must type before completions are presented.
min_height
min_width
name
property type: String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
orientation
property type: Enum ( Enumeration(horizontal, vertical) )
Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
placeholder
Placeholder for empty input field.
property type: Enum ( SizingMode )
SizingMode
How the component should size itself.
This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode).
width_policy
Possible scenarios:
Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events.
"stretch_width"
Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_height"
Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_both"
Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component.
"scale_width"
Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio.
"scale_height"
Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio.
"scale_both"
Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.
subscribed_events
List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
tags
property type: List ( Any )
Any
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
title
Widget’s label.
value
Initial or entered text value.
Change events are triggered whenever <enter> is pressed.
value_input
Initial or current value.
Change events are triggered whenever any update happens, i.e. on every keypress.
visible
Whether the component will be visible and a part of a layout.
width
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
Describes how the component should maintain its width.
Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
apply_theme
Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).
HasProps
property_values (dict) – theme values to use in place of defaults
None
dataspecs
Collect the names of all DataSpec properties on this class.
DataSpec
This method always traverses the class hierarchy and includes properties defined on any parent classes.
names of DataSpec properties
set[str]
dataspecs_with_props
Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.
mapping of names and DataSpec properties
dict[str, DataSpec]
equals
Structural equality of models.
other (HasProps) – the other instance to compare to
True, if properties are structurally equal, otherwise False
js_link
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.
attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
other
attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr
attr
Added in version 1.1
ValueError –
Examples
This code with js_link:
select.js_link('value', plot, 'sizing_mode')
is equivalent to the following:
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
which is equivalent to:
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
js_on_change
Attach a CustomJS callback to an arbitrary BokehJS model event.
On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:
"change:property_name"
"change:"
# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
PropertyDescriptor
name (str) – name of the property to search for
descriptor for property named name
on_change
Add a callback on this object to trigger when attr changes.
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
properties
Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
property names
properties_containers
Collect the names of all container properties on this class.
names of container properties
properties_with_refs
Collect the names of all properties on this class that also have references.
names of properties that have references
properties_with_values
Collect a dict mapping property names to their values.
Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
mapping from property names to their values
dict
query_properties_with_values
Query the properties values of HasProps instances with a predicate.
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
mapping of property names and values for matching properties
references
Returns all Models that this object has references to.
Models
remove_on_change
Remove a callback from this object
select
Query this object and all of its references for objects that match the given selector.
selector (JSON-like) –
seq[Model]
select_one
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
Model
set_from_json
Set a property value on this object from JSON.
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
set_select
Update objects that match a given selector with the specified attribute/value updates.
updates (dict) –
themed_values
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
to_json
Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json()
For most purposes it’s best to serialize and deserialize entire documents.
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
to_json_string
Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json_string()
trigger
unapply_theme
Remove any themed values and restore defaults.
update
Updates the object’s properties from the given keyword arguments.
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
update_from_json
Updates the object’s properties from a JSON attributes dictionary.
json_attributes – (JSON-dict) : attributes and values to update
document
The Document this model is attached to (can be None)
Document
struct
A Bokeh protocol “structure” of this model, i.e. a dict of the form:
{ 'type' : << view model name >> 'id' : << unique model id >> }
Additionally there may be a subtype field if this model is a subtype.
{ "align": "start", "aspect_ratio": null, "background": null, "completions": [], "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "16725", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_characters": 2, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "placeholder": "", "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "value": "", "value_input": "", "visible": true, "width": null, "width_policy": "auto" }
ColorPicker
Bases: bokeh.models.widgets.inputs.InputWidget
bokeh.models.widgets.inputs.InputWidget
Color picker widget
Warning
This widget as a limited support on Internet Explorer (it will be displayed as a simple text input).
color
property type: ColorHex
ColorHex
The initial color of the picked color (named or hexadecimal)
{ "align": "start", "aspect_ratio": null, "background": null, "color": "#000000", "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "16755", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "visible": true, "width": null, "width_policy": "auto" }
DatePicker
Calendar-based date picker widget.
disabled_dates
property type: List ( Either ( Date , Tuple ( Date , Date ) ) )
Date
A list of dates of (start, end) date ranges to make unavailable for selection. All other dates will be avalable.
(start, end)
Only one of disabled_dates and enabled_dates should be specified.
enabled_dates
A list of dates of (start, end) date ranges to make available for selection. All other dates will be unavailable.
inline
Whether the calendar sholud be displayed inline.
max_date
property type: Date
Optional latest allowable date.
min_date
Optional earliest allowable date.
position
property type: Enum ( CalendarPosition )
CalendarPosition
Where the calendar is rendered relative to the input when inline is False.
The initial or picked date.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "disabled_dates": [], "enabled_dates": [], "height": null, "height_policy": "auto", "id": "16781", "inline": false, "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_date": null, "max_height": null, "max_width": null, "min_date": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "position": "auto", "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "value": null, "visible": true, "width": null, "width_policy": "auto" }
FileInput
Bases: bokeh.models.widgets.widget.Widget
bokeh.models.widgets.widget.Widget
Present a file-chooser dialog to users and return the contents of the selected files.
accept
Comma-separated list of standard HTML file input filters that restrict what files the user can pick from. Values can be:
Specific file extension(s) (e.g: .gif, .jpg, .png, .doc) are pickable
all sound files are pickable
all video files are pickable
all image files are pickable
A valid IANA Media Type, with no parameters.
filename
property type: Either ( String , List ( String ) )
The name(s) of the file or files that were loaded.
If mulitiple is set to False (default), this value is a single string with the name of the single file that was chosen.
If multiple is True, this value is a list of strings, each containing the name of one of the multiple files that were chosen.
This list provides the sequence of files for the respective lists in value and mime-type
The full file path is not included since browsers will not provide access to that information for security reasons.
mime_type
The mime-type of the file or files that were loaded.
If mulitiple is set to False (default), this value is a single string with the mime-type of the single file that was chosen.
If multiple is True, this value is a list of strings, each containing the mime-type of one of the multiple files that were chosen.
The sequence of files is given by the list of filename (see below)
multiple
set multiple=False (default) for single file selection, set multiple=True if selection of more than one file at a time should be possible.
The base64-enconded contents of the file or files that were loaded.
If mulitiple is set to False (default), this value is a single string with the contents of the single file that was chosen.
If multiple is True, this value is a list of strings, each containing the contents of one of the multiple files that were chosen.
The sequence of files is given by the list of filenames (see below)
{ "accept": "", "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "filename": "", "height": null, "height_policy": "auto", "id": "16813", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "mime_type": "", "min_height": null, "min_width": null, "multiple": false, "name": null, "orientation": "horizontal", "sizing_mode": null, "subscribed_events": [], "tags": [], "value": "", "visible": true, "width": null, "width_policy": "auto" }
InputWidget
Abstract base class for input widgets.
This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "16842", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "visible": true, "width": null, "width_policy": "auto" }
MultiChoice
MultiChoice widget.
delete_button
Whether to add a button to remove a selected option.
max_items
The maximum number of items that can be selected.
option_limit
The number of choices that will be rendered in the dropdown.
options
property type: List ( Either ( String , Tuple ( String , String ) ) )
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.
(value, label)
A string that is displayed if not item is added.
solid
Specify whether the choices should be solidly filled.
Initial or selected values.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "delete_button": true, "disabled": false, "height": null, "height_policy": "auto", "id": "16867", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_items": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "option_limit": null, "options": [], "orientation": "horizontal", "placeholder": null, "sizing_mode": null, "solid": true, "subscribed_events": [], "tags": [], "title": "", "value": [], "visible": true, "width": null, "width_policy": "auto" }
MultiSelect
Multi-select widget.
size
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.)
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "16899", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "options": [], "orientation": "horizontal", "size": 4, "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "value": [], "visible": true, "width": null, "width_policy": "auto" }
PasswordInput
Single-line password input widget.
This widget hides the input value so that it is not visible in the browser.
Secure transmission of the password to Bokeh server application code requires configuring the server for SSL (i.e. HTTPS) termination.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "16927", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "placeholder": "", "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "value": "", "value_input": "", "visible": true, "width": null, "width_policy": "auto" }
Select
Single-select widget.
property type: Either ( List ( Either ( String , Tuple ( Either ( Int , String ), String ) ) ), Dict ( String , List ( Either ( String , Tuple ( Either ( Int , String ), String ) ) ) ) )
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. Option groupings can be provided by supplying a dictionary object whose values are in the aforementioned list format
Initial or selected value.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "16955", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "options": [], "orientation": "horizontal", "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "value": "", "visible": true, "width": null, "width_policy": "auto" }
Spinner
Spinner widget for numerical inputs
high
property type: Float
Optional highest allowable value.
low
Optional lowest allowable value.
step
property type: Interval
Interval
The step added or subtracted to the current value
The initial value of the spinner
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "high": null, "id": "16982", "js_event_callbacks": {}, "js_property_callbacks": {}, "low": null, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "sizing_mode": null, "step": 1, "subscribed_events": [], "tags": [], "title": "", "value": 0, "visible": true, "width": null, "width_policy": "auto" }
TextInput
Single-line input widget.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "17011", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "placeholder": "", "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "value": "", "value_input": "", "visible": true, "width": null, "width_policy": "auto" }
TextAreaInput
Multi-line input widget.
cols
Specifies the width of the text area (in average character width). Default: 20
max_length
Max count of characters in field
rows
Specifies the height of the text area (in lines). Default: 2
{ "align": "start", "aspect_ratio": null, "background": null, "cols": 20, "css_classes": [], "default_size": 300, "disabled": false, "height": null, "height_policy": "auto", "id": "17039", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 5, 5, 5, 5 ], "max_height": null, "max_length": 500, "max_width": null, "min_height": null, "min_width": null, "name": null, "orientation": "horizontal", "placeholder": "", "rows": 2, "sizing_mode": null, "subscribed_events": [], "tags": [], "title": "", "value": "", "value_input": "", "visible": true, "width": null, "width_policy": "auto" }