bokeh.models.widgets.inputs¶

Various kinds of input widgets and form controls.

class AutocompleteInput(**kwargs)¶

Bases: bokeh.models.widgets.inputs.TextInput

Single-line input widget with auto-completion.

completions¶

property type: completions:List(String)

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

{
  "callback": null,
  "completions": [],
  "disabled": false,
  "height": null,
  "id": "92a33013-6c43-4ea5-869f-d28986669a97",
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "title": "",
  "value": "",
  "width": null
}

class DatePicker(**kwargs)¶

Bases: bokeh.models.widgets.inputs.InputWidget

Calendar-based date picker widget.

callback¶

property type: callback:Instance(Callback)

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

max_date¶

property type: max_date:Date

Optional latest allowable date.

min_date¶

property type: min_date:Date

Optional earliest allowable date.

value¶

property type: value:Date

The initial or picked date.

{
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "8c22b217-4451-42b7-a106-0fa593017ea0",
  "max_date": null,
  "min_date": null,
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "title": "",
  "value": 1475798400000.0,
  "width": null
}

class DateRangeSlider(**kwargs)¶

Bases: bokeh.models.widgets.inputs.InputWidget

Slider-based date range selection widget.

arrows¶

property type: arrows:Bool

Whether to show clickable arrows on both ends of the slider.

bounds¶

property type: bounds:Tuple(Date, Date)

The earliest and latest allowable dates.

callback¶

property type: callback:Instance(Callback)

A callback to run in the browser whenever either slider’s value changes.

enabled¶

property type: enabled:Bool

Enable or disable this widget.

range¶

property type: range:Tuple(RelativeDelta, RelativeDelta)

[TDB]

step¶

property type: step:RelativeDelta

The step between consecutive dates.

value¶

property type: value:Tuple(Date, Date)

The initial or selected date range.

value_labels¶

property type: value_labels:Enum(‘show’, ‘hide’, ‘change’)

Show or hide value labels on both sides of the slider.

wheel_mode¶

property type: wheel_mode:Enum(‘scroll’, ‘zoom’)

Whether mouse zoom should scroll or zoom selected range (or do nothing).

{
  "arrows": true,
  "bounds": null,
  "callback": null,
  "disabled": false,
  "enabled": true,
  "height": null,
  "id": "eb45f2b2-d026-46a6-a765-5adb39e5c05a",
  "name": null,
  "range": null,
  "sizing_mode": "fixed",
  "step": {},
  "tags": [],
  "title": "",
  "value": null,
  "value_labels": "show",
  "wheel_mode": null,
  "width": null
}

class InputWidget(**kwargs)¶

Bases: bokeh.models.widgets.widget.Widget

Abstract base class for input widgets. InputWidget` is not generally useful to instantiate on its own.

classmethod coerce_value(val)¶

title¶

property type: title:String

Widget’s label.

{
  "disabled": false,
  "height": null,
  "id": "6250ea3f-8880-475d-a654-5c7ade4dac4c",
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "title": "",
  "width": null
}

class MultiSelect(**kwargs)¶

Bases: bokeh.models.widgets.inputs.InputWidget

Multi-select widget.

callback¶

property type: callback:Instance(Callback)

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

options¶

property type: options: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¶

property type: value:List(String)

Initial or selected values.

{
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "c095b607-3659-4ae6-b7aa-1df00d8e9c19",
  "name": null,
  "options": [],
  "sizing_mode": "fixed",
  "tags": [],
  "title": "",
  "value": [],
  "width": null
}

class Select(**kwargs)¶

Bases: bokeh.models.widgets.inputs.InputWidget

Single-select widget.

callback¶

property type: callback:Instance(Callback)

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

options¶

property type: options: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¶

property type: value:String

Initial or selected value.

{
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "c535bea9-28d4-4bca-9007-87ccc8c92af0",
  "name": null,
  "options": [],
  "sizing_mode": "fixed",
  "tags": [],
  "title": "",
  "value": "",
  "width": null
}

class Slider(**kwargs)¶

Bases: bokeh.models.widgets.inputs.InputWidget

Slider-based number selection widget.

callback¶

property type: callback:Instance(Callback)

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

callback_policy¶

property type: callback_policy:Enum(‘continuous’, ‘throttle’, ‘mouseup’)

When the callback is initiated. This parameter can take on only one of three options:

“continuous”: the callback will be executed immediately for each movement of the slider “throttle”: the callback will be executed at most every callback_throttle milliseconds. “mouseup”: the callback will be executed only once when the slider is released.

The mouseup policy is intended for scenarios in which the callback is expensive in time.

callback_throttle¶

property type: callback_throttle:Float

Number of microseconds to pause between callback calls as the slider is moved.

end¶

property type: end:Float

The maximum allowable value.

orientation¶

property type: orientation:Enum(‘horizontal’, ‘vertical’)

Orient the slider either horizontally (default) or vertically.

start¶

property type: start:Float

The minimum allowable value.

step¶

property type: step:Float

The step between consecutive values.

value¶

property type: value:Float

Initial or selected value.

{
  "callback": null,
  "callback_policy": "throttle",
  "callback_throttle": 200,
  "disabled": false,
  "end": 1,
  "height": null,
  "id": "4ea760df-f11c-4e4a-a3ae-714124edb046",
  "name": null,
  "orientation": "horizontal",
  "sizing_mode": "fixed",
  "start": 0,
  "step": 0.1,
  "tags": [],
  "title": "",
  "value": 0.5,
  "width": null
}

class TextInput(**kwargs)¶

Bases: bokeh.models.widgets.inputs.InputWidget

Single-line input widget.

callback¶

property type: callback: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.

value¶

property type: value:String

Initial or entered text value.

{
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "7fcdb956-2333-43ad-a0c9-0555c85bb22c",
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "title": "",
  "value": "",
  "width": null
}