groups#

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

Bases: Widget

Abstract base class for all kinds of groups.

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, 
  "context_menu": null, 
  "css_classes": [], 
  "disabled": false, 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p121642", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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:

labels

List of text labels contained in this group.
Inherited from : py: class: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.

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.
Inherited from : py: class:UIElement

visible

Whether the component should be displayed on screen.

css_classes

A 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.
Inherited from : py: class: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.
Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

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

Inherited from : py: class:Widget

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

Inherited from : py: class:LayoutDOM

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

Inherited from : py: class:UIElement

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

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

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

__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 : py: class:HasProps

__init_subclass__()

This method is called when a class is subclassed.

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

__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(name, *[, raises])

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

properties(*[, _with_props])

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.

clone()

Duplicate a HasProps object.
Inherited from : py: class:Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from : py: class:HasDocumentRef

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

Inherited from : py: class:PropertyCallbackManager

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

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

Inherited from : py: class:EventCallbackManager

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

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

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 additional CSS classes to add to the underlying DOM element.

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.

labels = []#
Type:

List

List of text labels contained in this group.

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

clone() → HasProps#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated.

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 CheckboxButtonGroup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: ToggleButtonGroup

A group of check boxes rendered as toggle buttons.

JSON Prototype
{
  "active": [], 
  "align": "auto", 
  "aspect_ratio": null, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "disabled": false, 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p121667", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "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:

active

The list of indices of selected check boxes.
Inherited from : py: class:ToggleButtonGroup

orientation

Orient the button group either horizontally (default) or vertically.
Inherited from : py: class:AbstractGroup

labels

List of text labels contained in this group.
Inherited from : py: class: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.

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.
Inherited from : py: class:UIElement

visible

Whether the component should be displayed on screen.

css_classes

A 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.
Inherited from : py: class: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.
Inherited from : py: class:ButtonLike

button_type

A style for the button, signifying it's role.
Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

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

Inherited from : py: class:ToggleButtonGroup

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

Inherited from : py: class:AbstractGroup

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

Inherited from : py: class:Widget

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

Inherited from : py: class:LayoutDOM

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

Inherited from : py: class:UIElement

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

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

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

__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 : py: class:ButtonLike

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

Inherited from : py: class:HasProps

__init_subclass__()

This method is called when a class is subclassed.

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

__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(name, *[, raises])

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

properties(*[, _with_props])

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.

clone()

Duplicate a HasProps object.
Inherited from : py: class:Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from : py: class:HasDocumentRef

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

Inherited from : py: class:PropertyCallbackManager

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

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

Inherited from : py: class:EventCallbackManager

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

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model
active = []#
Type:

List

The list of indices of selected check boxes.

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

button_type = 'default'#
Type:

Enum(ButtonType)

A style for the button, signifying it’s role. Possible values are one of the following:

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 additional CSS classes to add to the underlying DOM element.

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.

labels = []#
Type:

List

List of text labels contained in this group.

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.

orientation = 'horizontal'#
Type:

Enum(Enumeration(horizontal, vertical))

Orient the button group either horizontally (default) or vertically.

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

clone() → HasProps#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated.

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 CheckboxGroup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: ToggleInputGroup

A group of check boxes.

JSON Prototype
{
  "active": [], 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "disabled": false, 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p121702", 
  "inline": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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:

active

The list of indices of selected check boxes.
Inherited from : py: class:ToggleInputGroup

inline

Should items be arrange vertically (False) or horizontally in-line (True).
Inherited from : py: class:AbstractGroup

labels

List of text labels contained in this group.
Inherited from : py: class: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.

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.
Inherited from : py: class:UIElement

visible

Whether the component should be displayed on screen.

css_classes

A 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.
Inherited from : py: class: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.
Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

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

Inherited from : py: class:ToggleInputGroup

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

Inherited from : py: class:AbstractGroup

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

Inherited from : py: class:Widget

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

Inherited from : py: class:LayoutDOM

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

Inherited from : py: class:UIElement

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

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

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

__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 : py: class:HasProps

__init_subclass__()

This method is called when a class is subclassed.

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

__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(name, *[, raises])

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

properties(*[, _with_props])

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.

clone()

Duplicate a HasProps object.
Inherited from : py: class:Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from : py: class:HasDocumentRef

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

Inherited from : py: class:PropertyCallbackManager

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

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

Inherited from : py: class:EventCallbackManager

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

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model
active = []#
Type:

List

The list of indices of selected check boxes.

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

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 additional CSS classes to add to the underlying DOM element.

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.

inline = False#
Type:

Bool

Should items be arrange vertically (False) or horizontally in-line (True).

labels = []#
Type:

List

List of text labels contained in this group.

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

clone() → HasProps#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated.

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 RadioButtonGroup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: ToggleButtonGroup

A group of radio boxes rendered as toggle buttons.

JSON Prototype
{
  "active": null, 
  "align": "auto", 
  "aspect_ratio": null, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "disabled": false, 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p121729", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "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:

active

The index of the selected radio box, or None if nothing is selected.
Inherited from : py: class:ToggleButtonGroup

orientation

Orient the button group either horizontally (default) or vertically.
Inherited from : py: class:AbstractGroup

labels

List of text labels contained in this group.
Inherited from : py: class: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.

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.
Inherited from : py: class:UIElement

visible

Whether the component should be displayed on screen.

css_classes

A 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.
Inherited from : py: class: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.
Inherited from : py: class:ButtonLike

button_type

A style for the button, signifying it's role.
Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

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

Inherited from : py: class:ToggleButtonGroup

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

Inherited from : py: class:AbstractGroup

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

Inherited from : py: class:Widget

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

Inherited from : py: class:LayoutDOM

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

Inherited from : py: class:UIElement

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

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

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

__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 : py: class:ButtonLike

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

Inherited from : py: class:HasProps

__init_subclass__()

This method is called when a class is subclassed.

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

__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(name, *[, raises])

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

properties(*[, _with_props])

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.

clone()

Duplicate a HasProps object.
Inherited from : py: class:Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from : py: class:HasDocumentRef

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

Inherited from : py: class:PropertyCallbackManager

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

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

Inherited from : py: class:EventCallbackManager

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

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model
active = None#
Type:

Nullable(Int)

The index of the selected radio box, or None if nothing is selected.

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

button_type = 'default'#
Type:

Enum(ButtonType)

A style for the button, signifying it’s role. Possible values are one of the following:

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 additional CSS classes to add to the underlying DOM element.

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.

labels = []#
Type:

List

List of text labels contained in this group.

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.

orientation = 'horizontal'#
Type:

Enum(Enumeration(horizontal, vertical))

Orient the button group either horizontally (default) or vertically.

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

clone() → HasProps#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated.

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 RadioGroup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: ToggleInputGroup

A group of radio boxes.

JSON Prototype
{
  "active": null, 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "disabled": false, 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p121764", 
  "inline": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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:

active

The index of the selected radio box, or None if nothing is selected.
Inherited from : py: class:ToggleInputGroup

inline

Should items be arrange vertically (False) or horizontally in-line (True).
Inherited from : py: class:AbstractGroup

labels

List of text labels contained in this group.
Inherited from : py: class: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.

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.
Inherited from : py: class:UIElement

visible

Whether the component should be displayed on screen.

css_classes

A 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.
Inherited from : py: class: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.
Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

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

Inherited from : py: class:ToggleInputGroup

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

Inherited from : py: class:AbstractGroup

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

Inherited from : py: class:Widget

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

Inherited from : py: class:LayoutDOM

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

Inherited from : py: class:UIElement

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

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

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

__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 : py: class:HasProps

__init_subclass__()

This method is called when a class is subclassed.

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

__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(name, *[, raises])

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

properties(*[, _with_props])

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.

clone()

Duplicate a HasProps object.
Inherited from : py: class:Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from : py: class:HasDocumentRef

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

Inherited from : py: class:PropertyCallbackManager

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

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

Inherited from : py: class:EventCallbackManager

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

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model
active = None#
Type:

Nullable(Int)

The index of the selected radio box, or None if nothing is selected.

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

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 additional CSS classes to add to the underlying DOM element.

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.

inline = False#
Type:

Bool

Should items be arrange vertically (False) or horizontally in-line (True).

labels = []#
Type:

List

List of text labels contained in this group.

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

clone() → HasProps#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated.

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 ToggleButtonGroup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: AbstractGroup, ButtonLike

Abstract base class for groups with items rendered as buttons.

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, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "disabled": false, 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p121791", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "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:

orientation

Orient the button group either horizontally (default) or vertically.
Inherited from : py: class:AbstractGroup

labels

List of text labels contained in this group.
Inherited from : py: class: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.

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.
Inherited from : py: class:UIElement

visible

Whether the component should be displayed on screen.

css_classes

A 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.
Inherited from : py: class: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.
Inherited from : py: class:ButtonLike

button_type

A style for the button, signifying it's role.
Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

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

Inherited from : py: class:AbstractGroup

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

Inherited from : py: class:Widget

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

Inherited from : py: class:LayoutDOM

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

Inherited from : py: class:UIElement

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

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

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

__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 : py: class:ButtonLike

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

Inherited from : py: class:HasProps

__init_subclass__()

This method is called when a class is subclassed.

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

__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(name, *[, raises])

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

properties(*[, _with_props])

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.

clone()

Duplicate a HasProps object.
Inherited from : py: class:Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from : py: class:HasDocumentRef

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

Inherited from : py: class:PropertyCallbackManager

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

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

Inherited from : py: class:EventCallbackManager

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

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

button_type = 'default'#
Type:

Enum(ButtonType)

A style for the button, signifying it’s role. Possible values are one of the following:

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 additional CSS classes to add to the underlying DOM element.

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.

labels = []#
Type:

List

List of text labels contained in this group.

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.

orientation = 'horizontal'#
Type:

Enum(Enumeration(horizontal, vertical))

Orient the button group either horizontally (default) or vertically.

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

clone() → HasProps#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated.

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 ToggleInputGroup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: AbstractGroup

Abstract base class for groups with items rendered as check/radio boxes.

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, 
  "context_menu": null, 
  "css_classes": [], 
  "disabled": false, 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p121825", 
  "inline": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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:

inline

Should items be arrange vertically (False) or horizontally in-line (True).
Inherited from : py: class:AbstractGroup

labels

List of text labels contained in this group.
Inherited from : py: class: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.

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.
Inherited from : py: class:UIElement

visible

Whether the component should be displayed on screen.

css_classes

A 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.
Inherited from : py: class: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.
Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

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

Inherited from : py: class:AbstractGroup

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

Inherited from : py: class:Widget

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

Inherited from : py: class:LayoutDOM

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

Inherited from : py: class:UIElement

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

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args[, id])

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

__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 : py: class:HasProps

__init_subclass__()

This method is called when a class is subclassed.

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

__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(name, *[, raises])

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

properties(*[, _with_props])

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.

clone()

Duplicate a HasProps object.
Inherited from : py: class:Serializable

to_serializable(serializer)

Converts this object to a serializable representation.
Inherited from : py: class:HasDocumentRef

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

Inherited from : py: class:PropertyCallbackManager

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

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

Inherited from : py: class:EventCallbackManager

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

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

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 additional CSS classes to add to the underlying DOM element.

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.

inline = False#
Type:

Bool

Should items be arrange vertically (False) or horizontally in-line (True).

labels = []#
Type:

List

List of text labels contained in this group.

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

clone() → HasProps#

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated.

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)