inputs#

Various kinds of input widgets and form controls.

class AutocompleteInput(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: TextInput

Single-line input widget with auto-completion.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "case_sensitive": true,
  "classes": [],
  "completions": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p126969",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_completions": null,
  "max_height": null,
  "max_length": null,
  "max_width": null,
  "min_characters": 2,
  "min_height": null,
  "min_width": null,
  "name": null,
  "placeholder": "",
  "prefix": null,
  "resizable": false,
  "restrict": true,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "suffix": null,
  "syncable": true,
  "tags": [],
  "title": "",
  "value": "",
  "value_input": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

completions

A list of completion strings.

max_completions

Optional maximum number of completions displayed.

min_characters

The number of characters a user must type before completions are presented.

case_sensitive

Enable or disable case sensitivity.

restrict

Set to False in order to allow users to enter text that is not present in the list of completion strings.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from TextInput

prefix

An optional string prefix to display before the input.

suffix

An optional string suffix to display after the input.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from TextLikeInput

value

Initial or entered text value.

value_input

Initial or current value.

placeholder

Placeholder for empty input field.

max_length

Max count of characters in field

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, case_sensitive, ...])

Inherited from TextInput

__init__(*[, aspect_ratio, classes, ...])

Inherited from TextLikeInput

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

case_sensitive = True#
Type:

Bool

Enable or disable case sensitivity.

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

completions = []#
Type:

List

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

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_completions = None#
Type:

Nullable(Positive)

Optional maximum number of completions displayed.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_length = None#
Type:

Nullable(Int)

Max count of characters in field

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_characters = 2#
Type:

NonNegative

The number of characters a user must type before completions are presented.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

placeholder = ''#
Type:

String

Placeholder for empty input field.

prefix = None#
Type:

Nullable(String)

An optional string prefix to display before the input. This is useful to indicate e.g. a variable the entered value will be assigned to.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

restrict = True#
Type:

Bool

Set to False in order to allow users to enter text that is not present in the list of completion strings.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

suffix = None#
Type:

Nullable(String)

An optional string suffix to display after the input. This is useful to indicate e.g. the units of measurement of the entered value.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = ''#
Type:

String

Initial or entered text value.

Change events are triggered whenever <enter> is pressed.

value_input = ''#
Type:

String

Initial or current value.

Change events are triggered whenever any update happens, i.e. on every keypress.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class Checkbox(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: ToggleInput

A checkbox widget.

JSON Prototype
{
  "active": false,
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127007",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "label": "",
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

label

The label next to the checkbox.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from ToggleInput

active

The state of the widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, align, aspect_ratio, classes, ...])

Inherited from ToggleInput

__init__(*[, align, aspect_ratio, classes, ...])

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


active = False#
Type:

Bool

The state of the widget.

align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

label = ''#
Type:

String

The label next to the checkbox.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class ColorPicker(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InputWidget

Color picker widget

Warning

This widget as a limited support on Internet Explorer (it will be displayed as a simple text input).

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "color": "#000000",
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127034",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

color

The initial color of the picked color (named or hexadecimal)

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, color, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

color = '#000000'#
Type:

ColorHex

The initial color of the picked color (named or hexadecimal)

Acceptable values are:

  • any of the named CSS colors, e.g 'green', 'indigo'

  • RGB(A) hex strings, e.g., '#FF0000', '#44444444'

  • CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'

  • a 3-tuple of integers (r, g, b) between 0 and 255

  • a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1

  • a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class DatePicker(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InputWidget

Calendar-based date picker widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "disabled_dates": null,
  "enabled_dates": null,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127062",
  "inline": false,
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_date": null,
  "max_height": null,
  "max_width": null,
  "min_date": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "position": "auto",
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

value

The initial or picked date.

min_date

Optional earliest allowable date.

max_date

Optional latest allowable date.

disabled_dates

A list of dates of (start, end) date ranges to make unavailable for selection.

enabled_dates

A list of dates of (start, end) date ranges to make available for selection.

position

Where the calendar is rendered relative to the input when inline is False.

inline

Whether the calendar sholud be displayed inline.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

disabled_dates = None#
Type:

Nullable(List)

A list of dates of (start, end) date ranges to make unavailable for selection. All other dates will be avalable.

Note

Only one of disabled_dates and enabled_dates should be specified.

enabled_dates = None#
Type:

Nullable(List)

A list of dates of (start, end) date ranges to make available for selection. All other dates will be unavailable.

Note

Only one of disabled_dates and enabled_dates should be specified.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

inline = False#
Type:

Bool

Whether the calendar sholud be displayed inline.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_date = None#
Type:

Nullable(Date)

Optional latest allowable date.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_date = None#
Type:

Nullable(Date)

Optional earliest allowable date.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

position = 'auto'#
Type:

Enum(CalendarPosition)

Where the calendar is rendered relative to the input when inline is False.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = Undefined#
Type:

Date

The initial or picked date.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class FileInput(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InputWidget

Present a file-chooser dialog to users and return the contents of the selected files.

JSON Prototype
{
  "accept": "",
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "filename": "",
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127096",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_width": null,
  "mime_type": "",
  "min_height": null,
  "min_width": null,
  "multiple": false,
  "name": null,
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "value": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

value

The base64-enconded contents of the file or files that were loaded.

mime_type

The mime-type of the file or files that were loaded.

filename

The name(s) of the file or files that were loaded.

accept

Comma-separated list of standard HTML file input filters that restrict what files the user can pick from.

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.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, align, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


accept = ''#
Type:

Either(String, List)

Comma-separated list of standard HTML file input filters that restrict what files the user can pick from. Values can be:

<file extension>:

Specific file extension(s) (e.g: .gif, .jpg, .png, .doc) are pickable

audio/*:

all sound files are pickable

video/*:

all video files are pickable

image/*:

all image files are pickable

<media type>:

A valid IANA Media Type, with no parameters.

Note

A bug in some versions of Chrome on macOS Big Sur may limit how you can set a file input filter for those users. In those cases, it is impossible to limit the user’s selection to specific file extensions - instead, the browser will limit users to predefined sets of file types, such as Text/* or Image/*. See #10888 for more information.

align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

filename = ''#
Type:

Readonly

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

Note

The full file path is not included since browsers will not provide access to that information for security reasons.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

mime_type = ''#
Type:

Readonly

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)

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

multiple = False#
Type:

Bool

set multiple=False (default) for single file selection, set multiple=True if selection of more than one file at a time should be possible.

name = None#
Type:

Nullable(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', ...)]

Note

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.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = ''#
Type:

Readonly

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)

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class InputWidget(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: 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.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127128",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class MultiChoice(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InputWidget

MultiChoice widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "delete_button": true,
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127155",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_items": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "option_limit": null,
  "options": [],
  "placeholder": null,
  "resizable": false,
  "search_option_limit": null,
  "sizing_mode": null,
  "solid": true,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "value": [],
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

options

Available selection options.

value

Initial or selected values.

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.

search_option_limit

The number of choices that will be rendered in the dropdown when search string is entered.

placeholder

A string that is displayed if not item is added.

solid

Specify whether the choices should be solidly filled.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

delete_button = True#
Type:

Bool

Whether to add a button to remove a selected option.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_items = None#
Type:

Nullable(Int)

The maximum number of items that can be selected.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

option_limit = None#
Type:

Nullable(Int)

The number of choices that will be rendered in the dropdown.

options = []#
Type:

List

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.

placeholder = None#
Type:

Nullable(String)

A string that is displayed if not item is added.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

search_option_limit = None#
Type:

Nullable(Int)

The number of choices that will be rendered in the dropdown when search string is entered.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

solid = True#
Type:

Bool

Specify whether the choices should be solidly filled.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = []#
Type:

List

Initial or selected values.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class MultiSelect(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InputWidget

Multi-select widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127190",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "options": [],
  "resizable": false,
  "size": 4,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "value": [],
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

options

Available selection options.

value

Initial or selected values.

size

The number of visible options in the dropdown list.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

options = []#
Type:

List

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.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

size = 4#
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.)

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = []#
Type:

List

Initial or selected values.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class NumericInput(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InputWidget

Numeric input widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "format": null,
  "height": null,
  "height_policy": "auto",
  "high": null,
  "id": "p127220",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "low": null,
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "mode": "int",
  "name": null,
  "placeholder": "",
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "value": null,
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

value

Initial or entered value.

low

Optional lowest allowable value.

high

Optional highest allowable value.

placeholder

Placeholder for empty input field.

mode

Define the type of number which can be enter in the input

format

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

format = None#
Type:

Either(Null, String, Instance(TickFormatter))

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

high = None#
Type:

Either(Null, Float, Int)

Optional highest allowable value.

low = None#
Type:

Either(Null, Float, Int)

Optional lowest allowable value.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

mode = 'int'#
Type:

Enum(Enumeration(int, float))

Define the type of number which can be enter in the input

example mode int: 1, -1, 156 mode float: 1, -1.2, 1.1e-25

name = None#
Type:

Nullable(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', ...)]

Note

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.

placeholder = ''#
Type:

String

Placeholder for empty input field.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = None#
Type:

Either(Null, Float, Int)

Initial or entered value.

Change events are triggered whenever <enter> is pressed.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class PasswordInput(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: TextInput

Single-line password input widget.

This widget hides the input value so that it is not visible in the browser.

Warning

Secure transmission of the password to Bokeh server application code requires configuring the server for SSL (i.e. HTTPS) termination.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127253",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_length": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "placeholder": "",
  "prefix": null,
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "suffix": null,
  "syncable": true,
  "tags": [],
  "title": "",
  "value": "",
  "value_input": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from TextInput

prefix

An optional string prefix to display before the input.

suffix

An optional string suffix to display after the input.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from TextLikeInput

value

Initial or entered text value.

value_input

Initial or current value.

placeholder

Placeholder for empty input field.

max_length

Max count of characters in field

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from TextInput

__init__(*[, aspect_ratio, classes, ...])

Inherited from TextLikeInput

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_length = None#
Type:

Nullable(Int)

Max count of characters in field

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

placeholder = ''#
Type:

String

Placeholder for empty input field.

prefix = None#
Type:

Nullable(String)

An optional string prefix to display before the input. This is useful to indicate e.g. a variable the entered value will be assigned to.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

suffix = None#
Type:

Nullable(String)

An optional string suffix to display after the input. This is useful to indicate e.g. the units of measurement of the entered value.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = ''#
Type:

String

Initial or entered text value.

Change events are triggered whenever <enter> is pressed.

value_input = ''#
Type:

String

Initial or current value.

Change events are triggered whenever any update happens, i.e. on every keypress.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class Select(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InputWidget

Single-select widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127286",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "options": [],
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "value": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

options

Available selection options.

value

Initial or selected value.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

options = []#
Type:

Either(List, Dict(String, List))

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

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = ''#
Type:

String

Initial or selected value.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class Spinner(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: NumericInput

Numeric Spinner input widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "format": null,
  "height": null,
  "height_policy": "auto",
  "high": null,
  "id": "p127315",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "low": null,
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "mode": "float",
  "name": null,
  "page_step_multiplier": 10,
  "placeholder": "",
  "resizable": false,
  "sizing_mode": null,
  "step": 1,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "value": null,
  "value_throttled": null,
  "visible": true,
  "wheel_wait": 100,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

value_throttled

value reported at the end of interactions

step

The step added or subtracted to the current value

page_step_multiplier

Defines the multiplication factor applied to step when the page up and page down keys are pressed

wheel_wait

Defines the debounce time in ms before updating value_throttled when the mouse wheel is used to change the input

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from NumericInput

value

Initial or entered value.

low

Optional lowest allowable value.

high

Optional highest allowable value.

placeholder

Placeholder for empty input field.

mode

Define the type of number which can be enter in the input

format

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from NumericInput

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

format = None#
Type:

Either(Null, String, Instance(TickFormatter))

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

high = None#
Type:

Either(Null, Float, Int)

Optional highest allowable value.

low = None#
Type:

Either(Null, Float, Int)

Optional lowest allowable value.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

mode = 'float'#
Type:

Enum(Enumeration(int, float))

Define the type of number which can be enter in the input

example mode int: 1, -1, 156 mode float: 1, -1.2, 1.1e-25

name = None#
Type:

Nullable(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', ...)]

Note

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.

page_step_multiplier = 10#
Type:

Interval

Defines the multiplication factor applied to step when the page up and page down keys are pressed

placeholder = ''#
Type:

String

Placeholder for empty input field.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

step = 1#
Type:

Interval

The step added or subtracted to the current value

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = None#
Type:

Either(Null, Float, Int)

Initial or entered value.

Change events are triggered whenever <enter> is pressed.

value_throttled = None#
Type:

Readonly

value reported at the end of interactions

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

wheel_wait = 100#
Type:

Either(Int, Float)

Defines the debounce time in ms before updating value_throttled when the mouse wheel is used to change the input

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class Switch(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: ToggleInput

A checkbox-like widget.

JSON Prototype
{
  "active": false,
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127352",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "visible": true,
  "width": 32,
  "width_policy": "auto"
}

Public Data Attributes:

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from ToggleInput

active

The state of the widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, align, aspect_ratio, classes, ...])

Inherited from ToggleInput

__init__(*[, align, aspect_ratio, classes, ...])

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


active = False#
Type:

Bool

The state of the widget.

align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = 32#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class TextAreaInput(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: TextLikeInput

Multi-line input widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "cols": 20,
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127378",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_length": 500,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "placeholder": "",
  "resizable": false,
  "rows": 2,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "title": "",
  "value": "",
  "value_input": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

cols

Specifies the width of the text area (in average character width).

rows

Specifies the height of the text area (in lines).

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from TextLikeInput

value

Initial or entered text value.

value_input

Initial or current value.

placeholder

Placeholder for empty input field.

max_length

Max count of characters in field

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, cols, ...])

Inherited from TextLikeInput

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

cols = 20#
Type:

Int

Specifies the width of the text area (in average character width). Default: 20

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_length = 500#
Type:

Nullable(Int)

Max count of characters in field

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

placeholder = ''#
Type:

String

Placeholder for empty input field.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

rows = 2#
Type:

Int

Specifies the height of the text area (in lines). Default: 2

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = ''#
Type:

String

Initial or entered text value.

Change events are triggered whenever <enter> is pressed.

value_input = ''#
Type:

String

Initial or current value.

Change events are triggered whenever any update happens, i.e. on every keypress.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)

class TextInput(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: TextLikeInput

Single-line input widget.

JSON Prototype
{
  "align": "auto",
  "aspect_ratio": null,
  "classes": [],
  "context_menu": null,
  "css_classes": [],
  "description": null,
  "disabled": false,
  "flow_mode": "block",
  "height": null,
  "height_policy": "auto",
  "id": "p127411",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "margin": null,
  "max_height": null,
  "max_length": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "placeholder": "",
  "prefix": null,
  "resizable": false,
  "sizing_mode": null,
  "styles": {
    "type": "map"
  },
  "stylesheets": [],
  "subscribed_events": {
    "type": "set"
  },
  "suffix": null,
  "syncable": true,
  "tags": [],
  "title": "",
  "value": "",
  "value_input": "",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

prefix

An optional string prefix to display before the input.

suffix

An optional string suffix to display after the input.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from TextLikeInput

value

Initial or entered text value.

value_input

Initial or current value.

placeholder

Placeholder for empty input field.

max_length

Max count of characters in field

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from InputWidget

title

Widget's label.

description

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Widget

width

The width of the component (in pixels).

height

The height of the component (in pixels).

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from LayoutDOM

background

disabled

Whether the widget will be disabled when rendered.

width

The width of the component (in pixels).

height

The height of the component (in pixels).

min_width

Minimal width of the component (in pixels) if width is adjustable.

min_height

Minimal height of the component (in pixels) if height is adjustable.

max_width

Maximal width of the component (in pixels) if width is adjustable.

max_height

Maximal height of the component (in pixels) if height is adjustable.

margin

Allows to create additional space around the component.

width_policy

Describes how the component should maintain its width.

height_policy

Describes how the component should maintain its height.

aspect_ratio

Describes the proportional relationship between component's width and height.

flow_mode

Defines whether the layout will flow in the block or inline dimension.

sizing_mode

How the component should size itself.

align

The alignment point within the parent container.

css_classes

A list of CSS class names to add to this DOM element.

context_menu

A menu to display when user right clicks on the component.

resizable

Whether the layout is interactively resizable, and if so in which dimensions.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from UIElement

visible

Whether the component should be displayed on screen.

classes

List of additional CSS classes to add to the underlying DOM element.

styles

Inline CSS styles applied to the underlying DOM element.

stylesheets

Additional style-sheets to use for the underlying DOM element.

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

id

subscribed_events

Collection of events that are subscribed to by Python callbacks.

Inherited from Model

id

ref

name

An arbitrary, user-supplied name for this model.

tags

An optional list of arbitrary, user-supplied values to attach to this model.

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

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.

subscribed_events

Collection of events that are subscribed to by Python callbacks.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

document

The Document this model is attached to (can be None)

Inherited from HasDocumentRef

document

The Document this model is attached to (can be None)

Inherited from PropertyCallbackManager

document

Inherited from EventCallbackManager

document

id

subscribed_events

Public Methods:

__init__(*[, aspect_ratio, classes, ...])

Inherited from TextLikeInput

__init__(*[, aspect_ratio, classes, ...])

Inherited from InputWidget

__init__(*[, aspect_ratio, classes, ...])

coerce_value(val)

Inherited from Widget

__init__(*[, aspect_ratio, classes, ...])

Inherited from LayoutDOM

__init__(*[, aspect_ratio, classes, ...])

Inherited from UIElement

__init__(*[, name, styles, stylesheets, ...])

Inherited from Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

parameters()

Generate Python Parameter values suitable for functions that are derived from the glyph.

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

references()

Returns all Models that this object has references to.

select(selector)

Query this object and all of its references for objects that match the given selector.

select_one(selector)

Query this object and all of its references for objects that match the given selector.

set_select(selector, updates)

Update objects that match a given selector with the specified attribute/value updates.

to_serializable(serializer)

Converts this object to a serializable representation.

trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()

This method is called when a class is subclassed.

__init__(**properties)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

to_serializable(serializer)

Converts this object to a serializable representation.

set_from_json(name, value, *[, setter])

Set a property value on this object from JSON.

update(**kwargs)

Updates the object's properties from the given keyword arguments.

lookup()

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

properties()

Collect the names of properties on this class.

descriptors()

List of property descriptors in the order of definition.

properties_with_refs()

Collect the names of all properties on this class that also have references.

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

unapply_theme()

Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)

on_change(attr, *callbacks)

Add a callback on this object to trigger when attr changes.

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

__init__(*args, **kw)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'auto'#
Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

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 = None#
Type:

Either(Null, Auto, 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).

classes = []#
Type:

List

List of additional CSS classes to add to the underlying DOM element.

context_menu = None#
Type:

Nullable(Instance(Menu))

A menu to display when user right clicks on the component.

Note

To display a native context menu, the viewer will need to right-click twice. The second click closes the Bokeh context menu and falls back back the native one.

css_classes = []#
Type:

List

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.

description = None#
Type:

Nullable(Either(String, Instance(Tooltip)))

Either a plain text or a tooltip with a rich HTML description of the function of this widget.

disabled = False#
Type:

Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

flow_mode = 'block'#
Type:

Enum(FlowMode)

Defines whether the layout will flow in the block or inline dimension.

height = None#
Type:

Nullable(NonNegative)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto"

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.

margin = None#
Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None#
Type:

Nullable(NonNegative)

Maximal height of the component (in pixels) if height is adjustable.

max_length = None#
Type:

Nullable(Int)

Max count of characters in field

max_width = None#
Type:

Nullable(NonNegative)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None#
Type:

Nullable(NonNegative)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None#
Type:

Nullable(NonNegative)

Minimal width of the component (in pixels) if width is adjustable.

name = None#
Type:

Nullable(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', ...)]

Note

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.

placeholder = ''#
Type:

String

Placeholder for empty input field.

prefix = None#
Type:

Nullable(String)

An optional string prefix to display before the input. This is useful to indicate e.g. a variable the entered value will be assigned to.

resizable = False#
Type:

Either(Bool, Enum(Dimensions))

Whether the layout is interactively resizable, and if so in which dimensions.

sizing_mode = None#
Type:

Nullable(Enum(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).

Possible scenarios:

"inherit"

The sizing mode is inherited from the parent layout. If there is no parent layout (or parent is not a layout), then this value is treated as if no value for sizing_mode was provided.

"fixed"

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.

styles = {}#
Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []#
Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

suffix = None#
Type:

Nullable(String)

An optional string suffix to display after the input. This is useful to indicate e.g. the units of measurement of the entered value.

syncable = True#
Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []#
Type:

List

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.

Note

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 = ''#
Type:

String

Widget’s label.

value = ''#
Type:

String

Initial or entered text value.

Change events are triggered whenever <enter> is pressed.

value_input = ''#
Type:

String

Initial or current value.

Change events are triggered whenever any update happens, i.e. on every keypress.

visible = True#
Type:

Bool

Whether the component should be displayed on screen.

width = None#
Type:

Nullable(NonNegative)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'#
Type:

Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto"

Use component’s preferred sizing policy.

"fixed"

Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.

"fit"

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.

"min"

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.

"max"

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.

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.

apply_theme(property_values: dict[str, Any]) None#

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).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod dataspecs() dict[str, DataSpec]#

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() list[PropertyDescriptor[Any]]#

List of property descriptors in the order of definition.

destroy() None#

Clean up references to the document and property

equals(other: HasProps) bool#

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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.

Parameters:
  • 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

  • attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

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(event: str, *callbacks: JSEventCallback) None#

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:

# 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:

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:
  • name (str) – name of the property to search for

  • raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) None#

Add a callback on this object to trigger when attr changes.

Parameters:
  • attr (str) – an attribute name on this object

  • *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: EventCallback) None#

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() list[Parameter]#

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() dict[str, Property[Any]]#

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

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.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#

Query the properties values of HasProps instances with a predicate.

Parameters:
  • 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)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() set[Model]#

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) None#

Remove a callback from this object

select(selector: SelectorType) Iterable[Model]#

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) Model | None#

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

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#

Set a property value on this object from JSON.

Parameters:
  • 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.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#

Update objects that match a given selector with the specified attribute/value updates.

Parameters:
  • selector (JSON-like) –

  • updates (dict) –

Returns:

None

themed_values() dict[str, Any] | None#

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.

Returns:

dict or None

to_serializable(serializer: Serializer) ObjectRefRep#

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
unapply_theme() None#

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) None#

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

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)
property document: Document | None#

The Document this model is attached to (can be None)