bokeh.models.widgets.inputs

Various kinds of input widgets and form controls.

class AutocompleteInput(**kwargs)[source]

Bases: bokeh.models.widgets.inputs.TextInput

Single-line input widget with auto-completion.

completions

property type: List ( String )

A list of completion strings. This will be used to guide the user upon typing the beginning of a desired value.

JSON Prototype
{
  "callback": null,
  "completions": [],
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "31989",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "placeholder": "",
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "title": "",
  "value": "",
  "width": null
}
class DatePicker(**kwargs)[source]

Bases: bokeh.models.widgets.inputs.InputWidget

Calendar-based date picker widget.

callback

property type: Instance ( Callback )

A callback to run in the browser whenever the current date value changes.

max_date

property type: Date

Optional latest allowable date.

min_date

property type: Date

Optional earliest allowable date.

value

property type: Date

The initial or picked date.

JSON Prototype
{
  "callback": null,
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "31991",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "max_date": null,
  "min_date": null,
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "title": "",
  "value": null,
  "width": null
}
class InputWidget(**kwargs)[source]

Bases: bokeh.models.widgets.widget.Widget

Abstract base class for input widgets.

Note

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.

title

property type: String

Widget’s label.

classmethod coerce_value(val)[source]
JSON Prototype
{
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "31996",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "title": "",
  "width": null
}
class MultiSelect(**kwargs)[source]

Bases: bokeh.models.widgets.inputs.InputWidget

Multi-select widget.

callback

property type: Instance ( Callback )

A callback to run in the browser whenever the current selection value changes.

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.

size

property type: Int

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

property type: List ( String )

Initial or selected values.

JSON Prototype
{
  "callback": null,
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "31998",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "options": [],
  "size": 4,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "title": "",
  "value": [],
  "width": null
}
class PasswordInput(**kwargs)[source]

Bases: bokeh.models.widgets.inputs.TextInput

Single-line password input widget. Note: Despite PasswordInput inheriting from TextInput the password cannot be inspected on the field value. Also, note that this field functionally just hides the input on the browser, transmitting safely a password as a callback, e.g., to a bokeh server would require some secure connection.

JSON Prototype
{
  "callback": null,
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "32003",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "placeholder": "",
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "title": "",
  "value": "",
  "width": null
}
class Select(**kwargs)[source]

Bases: bokeh.models.widgets.inputs.InputWidget

Single-select widget.

callback

property type: Instance ( Callback )

A callback to run in the browser whenever the current Select dropdown value changes.

options

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

value

property type: String

Initial or selected value.

JSON Prototype
{
  "callback": null,
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "32004",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "options": [],
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "title": "",
  "value": "",
  "width": null
}
class TextInput(**kwargs)[source]

Bases: bokeh.models.widgets.inputs.InputWidget

Single-line input widget.

callback

property type: Instance ( Callback )

A callback to run in the browser whenever the user unfocuses the TextInput widget by hitting Enter or clicking outside of the text box area.

placeholder

property type: String

Placeholder for empty input field

value

property type: String

Initial or entered text value.

JSON Prototype
{
  "callback": null,
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "32008",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "placeholder": "",
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "title": "",
  "value": "",
  "width": null
}