tools<a class="headerlink" href="#module-bokeh.models.tools" title="Permalink to this headline">¶

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

BoxEditTool¶

class BoxEditTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

toolbar icon:

Allows drawing, dragging and deleting Rect glyphs on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. When drawing a new box the data will always be added to the ColumnDataSource on the first supplied renderer.

The tool will modify the columns on the data source corresponding to the x, y, width and height values of the glyph. Any additional columns in the data source will be padded with empty_value, when adding a new box.

The supported actions include:

Add box: Hold shift then click and drag anywhere on the plot or double tap once to start drawing, move the mouse and double tap again to finish drawing.
Move box: Click and drag an existing box, the box will be dropped once you let go of the mouse button.
Delete box: Tap a box to select it then press <<backspace>> key while the mouse is within the plot area.

To Move or Delete multiple boxes at once:

Move selection: Select box(es) with <<shift>>+tap (or another selection tool) then drag anywhere on the plot. Selecting and then dragging on a specific box will move both.
Delete selection: Select box(es) with <<shift>>+tap (or another selection tool) then press <<backspace>> while the mouse is within the plot area.

JSON Prototype

{
  "custom_icon": null,
  "description": null,
  "dimensions": "both",
  "id": "19618",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`dimensions`	Which dimensions the box drawing is to be free in.
`num_objects`	Defines a limit on the number of boxes that can be drawn.

Inherited from EditTool

`custom_tooltip`
`empty_value`	Defines the value to insert on non-coordinate columns when a new glyph is inserted into the `ColumnDataSource` columns, e.g.
`custom_icon`	An icon to display in the toolbar.
`renderers`	An explicit list of renderers corresponding to scatter glyphs that may be edited.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from EditTool

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

custom_icon = None¶

Type: Nullable(Image)

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the box drawing is to be free in. By default, users may freely draw boxes with any dimensions. If only “width” is set, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is set, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.

empty_value = Undefined¶

Type: NonNullable(Either(Bool, Int, Float, Date, Datetime, Color, String))

Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.

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.

num_objects = 0¶

Type: Int

Defines a limit on the number of boxes that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn box will be dropped to make space for the new box being added.

renderers = []¶

Type: List

An explicit list of renderers corresponding to scatter glyphs that may be edited.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

BoxSelectTool¶

class BoxSelectTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Drag, bokeh.models.tools.SelectTool

toolbar icon:

The box selection tool allows users to make selections on a Plot by showing a rectangular region by dragging the mouse or a finger over the plot area. The end of the drag event indicates the selection region is ready.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

JSON Prototype

{
  "description": null,
  "dimensions": "both",
  "id": "19628",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "origin": "corner",
  "overlay": {
    "id": "19629"
  },
  "renderers": "auto",
  "select_every_mousemove": false,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`select_every_mousemove`	Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed.
`dimensions`	Which dimensions the box selection is to be free in.
`overlay`	A shaded annotation drawn to indicate the selection region.
`origin`	Indicates whether the rectangular selection area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.

Inherited from SelectTool

`names`	A list of names to query for.
`renderers`	An explicit list of renderers to hit test against.
`mode`	Defines what should happen when a new selection is made.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the box selection is to be free in. By default, users may freely draw selections boxes with any dimensions. If only “width” is set, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is set, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.

mode = 'replace'¶

Type: Enum(SelectionMode)

Defines what should happen when a new selection is made. The default is to replace the existing selection. Other options are to append to the selection, intersect with it or subtract from it.

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.

names = []¶

Type: List

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

origin = 'corner'¶

Type: Enum(Enumeration(corner, center))

Indicates whether the rectangular selection area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.

overlay = BoxAnnotation(id='19637', ...)¶

Type: Instance(BoxAnnotation)

A shaded annotation drawn to indicate the selection region.

renderers = 'auto'¶

Type: Either(Auto, List)

An explicit list of renderers to hit test against. If unset, defaults to all renderers on a plot.

select_every_mousemove = False¶

Type: Bool

Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed. Default: False

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

BoxZoomTool¶

class BoxZoomTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Drag

toolbar icon:

The box zoom tool allows users to define a rectangular egion of a Plot to zoom to by dragging he mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.

Note

BoxZoomTool is incompatible with GMapPlot due to the manner in which Google Maps exert explicit control over aspect ratios. Adding this tool to a GMapPlot will have no effect.

JSON Prototype

{
  "description": null,
  "dimensions": "both",
  "id": "19642",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "match_aspect": false,
  "name": null,
  "origin": "corner",
  "overlay": {
    "id": "19643"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`dimensions`	Which dimensions the zoom box is to be free in.
`overlay`	A shaded annotation drawn to indicate the selection region.
`match_aspect`	Whether the box zoom region should be restricted to have the same aspect ratio as the plot region.
`origin`	Indicates whether the rectangular zoom area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the zoom box is to be free in. By default, users may freely draw zoom boxes with any dimensions. If only “width” is supplied, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is supplied, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.

match_aspect = False¶

Type: Bool

Whether the box zoom region should be restricted to have the same aspect ratio as the plot region.

Note

If the tool is restricted to one dimension, this value has no effect.

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.

origin = 'corner'¶

Type: Enum(Enumeration(corner, center))

Indicates whether the rectangular zoom area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.

overlay = BoxAnnotation(id='19650', ...)¶

Type: Instance(BoxAnnotation)

A shaded annotation drawn to indicate the selection region.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

CrosshairTool¶

class CrosshairTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.InspectTool

toolbar icon:

The crosshair tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector’s menu associated with the toolbar icon shown above.

The crosshair tool draws a crosshair annotation over the plot, centered on the current mouse position. The crosshair tool may be configured to draw across only one dimension by setting the dimension property to only width or height.

JSON Prototype

{
  "description": null,
  "dimensions": "both",
  "id": "19653",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "line_alpha": 1.0,
  "line_color": "black",
  "line_width": 1,
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "toggleable": true
}

Public Data Attributes:

`dimensions`	Which dimensions the crosshair tool is to track.
`line_color`	A color to use to stroke paths with.
`line_alpha`	An alpha value to use to stroke paths with.
`line_width`	Stroke width in units of pixels.

Inherited from InspectTool

toggleable

Whether an on/off toggle button should appear in the toolbar for this inspection tool.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the crosshair tool is to track. By default, both vertical and horizontal lines will be drawn. If only “width” is supplied, only a horizontal line will be drawn. If only “height” is supplied, only a vertical line will be drawn.

line_alpha = 1.0¶

Type: Alpha

An alpha value to use to stroke paths with.

Acceptable values are floating-point numbers between 0 and 1 (0 being transparent and 1 being opaque).

line_color = 'black'¶

Type: Color

A color to use to stroke paths with.

Acceptable values are:

any of the named CSS colors, e.g 'green', 'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern

line_width = 1¶

Type: Float

Stroke width in units of pixels.

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.

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.

toggleable = True¶

Type: Bool

Whether an on/off toggle button should appear in the toolbar for this inspection tool. If False, the viewers of a plot will not be able to toggle the inspector on or off using the toolbar.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

CustomAction¶

class CustomAction(*args, **kwargs)[source]¶

Execute a custom action, e.g. CustomJS callback when a toolbar icon is activated.

Example

tool = CustomAction(icon="icon.png",
                    callback=CustomJS(code='alert("foo")'))

plot.add_tools(tool)

JSON Prototype

{
  "callback": null,
  "description": "Perform a Custom Action",
  "id": "19663",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`action_tooltip`
`callback`	A Bokeh callback to execute when the custom action icon is activated.
`icon`	An icon to display in the toolbar.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

callback = None¶

Type: Nullable(Instance(Callback))

A Bokeh callback to execute when the custom action icon is activated.

description = 'Perform a Custom Action'¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = Undefined¶

Type: Image

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

CustomJSHover¶

class CustomJSHover(*args, **kwargs)[source]¶

Bases: bokeh.model.model.Model

Define a custom formatter to apply to a hover tool field.

This model can be configured with JavaScript code to format hover tooltips. The JavaScript code has access to the current value to format, some special variables, and any format configured on the tooltip. The variable value will contain the untransformed value. The variable special_vars will provide a dict with the following contents:

x data-space x-coordinate of the mouse
y data-space y-coordinate of the mouse
sx screen-space x-coordinate of the mouse
sy screen-space y-coordinate of the mouse
data_x data-space x-coordinate of the hovered glyph
data_y data-space y-coordinate of the hovered glyph
indices column indices of all currently hovered glyphs
name value of the name property of the hovered glyph renderer

If the hover is over a “multi” glyph such as Patches or MultiLine then a segment_index key will also be present.

Finally, the value of the format passed in the tooltip specification is available as the format variable.

Example

As an example, the following code adds a custom formatter to format WebMercator northing coordinates (in meters) as a latitude:

lat_custom = CustomJSHover(code="""
    const projections = Bokeh.require("core/util/projections");
    const x = special_vars.x
    const y = special_vars.y
    const coords = projections.wgs84_mercator.invert(x, y)
    return "" + coords[1]
""")

p.add_tools(HoverTool(
    tooltips=[( 'lat','@y{custom}' )],
    formatters={'@y':lat_custom}
))

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

JSON Prototype

{
  "args": {},
  "code": "",
  "id": "19670",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`args`	A mapping of names to Bokeh plot objects.
`code`	A snippet of JavaScript code to transform a single value.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

args = {}¶

Type: Dict(String, Instance(Model))

A mapping of names to Bokeh plot objects. These objects are made available to the callback code snippet as the values of named parameters to the callback.

code = ''¶

Type: String

A snippet of JavaScript code to transform a single value. The variable value will contain the untransformed value and can be expected to be present in the function namespace at render time. Additionally, the variable special_vars will be available, and will provide a dict with the following contents:

x data-space x-coordinate of the mouse
y data-space y-coordinate of the mouse
sx screen-space x-coordinate of the mouse
sy screen-space y-coordinate of the mouse
data_x data-space x-coordinate of the hovered glyph
data_y data-space y-coordinate of the hovered glyph
indices column indices of all currently hovered glyphs

If the hover is over a “multi” glyph such as Patches or MultiLine then a segment_index key will also be present.

Finally, the value of the format passed in the tooltip specification is available as the format variable.

The snippet will be made into the body of a function and therefore requires a return statement.

Example:

code = '''
return value + " total"
'''

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Drag¶

class Drag(*args, **kwargs)[source]¶

A base class for tools that respond to drag events.

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

{
  "description": null,
  "id": "19676",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

EditTool¶

class EditTool(*args, **kwargs)[source]¶

A base class for all interactive draw tool types.

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

{
  "custom_icon": null,
  "description": null,
  "id": "19681",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`custom_tooltip`
`empty_value`	Defines the value to insert on non-coordinate columns when a new glyph is inserted into the `ColumnDataSource` columns, e.g.
`custom_icon`	An icon to display in the toolbar.
`renderers`	An explicit list of renderers corresponding to scatter glyphs that may be edited.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

custom_icon = None¶

Type: Nullable(Image)

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

empty_value = Undefined¶

Type: NonNullable(Either(Bool, Int, Float, Date, Datetime, Color, String))

Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.

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.

renderers = []¶

Type: List

An explicit list of renderers corresponding to scatter glyphs that may be edited.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

FreehandDrawTool¶

class FreehandDrawTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

toolbar icon:

Allows freehand drawing of Patches and MultiLine glyphs. The glyph to draw may be defined via the renderers property.

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

The supported actions include:

Draw vertices: Click and drag to draw a line
Delete patch/multi-line: Tap a patch/multi-line to select it then press <<backspace>> key while the mouse is within the plot area.

JSON Prototype

{
  "custom_icon": null,
  "description": null,
  "id": "19689",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

num_objects

Defines a limit on the number of patches or multi-lines that can be drawn.

Inherited from EditTool

`custom_tooltip`
`empty_value`	Defines the value to insert on non-coordinate columns when a new glyph is inserted into the `ColumnDataSource` columns, e.g.
`custom_icon`	An icon to display in the toolbar.
`renderers`	An explicit list of renderers corresponding to scatter glyphs that may be edited.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from EditTool

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

custom_icon = None¶

Type: Nullable(Image)

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

empty_value = Undefined¶

Type: NonNullable(Either(Bool, Int, Float, Date, Datetime, Color, String))

Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.

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.

num_objects = 0¶

Type: Int

Defines a limit on the number of patches or multi-lines that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn patch or multi-line will be overwritten when the limit is reached.

renderers = []¶

Type: List

An explicit list of renderers corresponding to scatter glyphs that may be edited.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

GestureTool¶

class GestureTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Tool

A base class for tools that respond to drag events.

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

{
  "description": null,
  "id": "19698",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

HelpTool¶

class HelpTool(*args, **kwargs)[source]¶

A button tool to provide a “help” link to users.

The hover text can be customized through the help_tooltip attribute and the redirect site overridden as well.

JSON Prototype

{
  "description": "Click the question mark to learn more about Bokeh plot tools.",
  "id": "19703",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "redirect": "https://docs.bokeh.org/en/latest/docs/user_guide/tools.html",
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`help_tooltip`
`redirect`	Site to be redirected through upon click.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = 'Click the question mark to learn more about Bokeh plot tools.'¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

redirect = 'https://docs.bokeh.org/en/latest/docs/user_guide/tools.html'¶

Type: String

Site to be redirected through upon click.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

HoverTool¶

class HoverTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.InspectTool

toolbar icon:

The hover tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector’s menu associated with the toolbar icon shown above.

By default, the hover tool displays informational tooltips whenever the cursor is directly over a glyph. The data to show comes from the glyph’s data source, and what to display is configurable with the tooltips property that maps display names to columns in the data source, or to special known variables.

Here is an example of how to configure and use the hover tool:

# Add tooltip (name, field) pairs to the tool. See below for a
# description of possible field values.
hover.tooltips = [
    ("index", "$index"),
    ("(x,y)", "($x, $y)"),
    ("radius", "@radius"),
    ("fill color", "$color[hex, swatch]:fill_color"),
    ("fill color", "$color[hex]:fill_color"),
    ("fill color", "$color:fill_color"),
    ("fill color", "$swatch:fill_color"),
    ("foo", "@foo"),
    ("bar", "@bar"),
    ("baz", "@baz{safe}"),
    ("total", "@total{$0,0.00}"
]

You can also supply a Callback to the HoverTool, to build custom interactions on hover. In this case you may want to turn the tooltips off by setting tooltips=None.

Warning

When supplying a callback or custom template, the explicit intent of this Bokeh Model is to embed raw HTML and JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Hover tool does not currently work with the following glyphs:

annulus

arc

bezier

image_url

oval

patch

quadratic

ray

step

text

JSON Prototype

{
  "anchor": "center",
  "attachment": "horizontal",
  "callback": null,
  "description": null,
  "formatters": {},
  "id": "19709",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "line_policy": "nearest",
  "mode": "mouse",
  "muted_policy": "show",
  "name": null,
  "names": [],
  "point_policy": "snap_to_data",
  "renderers": "auto",
  "show_arrow": true,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "toggleable": true,
  "tooltips": [
    [
      "index",
      "$index"
    ],
    [
      "data (x, y)",
      "($x, $y)"
    ],
    [
      "screen (x, y)",
      "($sx, $sy)"
    ]
  ]
}

Public Data Attributes:

`names`	A list of names to query for.
`renderers`	An explicit list of renderers to hit test against.
`callback`	A callback to run in the browser whenever the input's value changes.
`tooltips`	The (name, field) pairs describing what the hover tool should display when there is a hit.
`formatters`	Specify the formatting scheme for data source columns, e.g.
`mode`	Whether to consider hover pointer as a point (x/y values), or a span on h or v directions.
`muted_policy`	Whether to avoid showing tooltips on muted glyphs.
`point_policy`	Whether the tooltip position should snap to the "center" (or other anchor) position of the associated glyph, or always follow the current mouse cursor position.
`line_policy`	When showing tooltips for lines, designates whether the tooltip position should be the "previous" or "next" points on the line, the "nearest" point to the current mouse position, or "interpolate" along the line to the current mouse position.
`anchor`	If point policy is set to "snap_to_data", anchor defines the attachment point of a tooltip.
`attachment`	Whether the tooltip should be displayed to the left or right of the cursor position or above or below it, or if it should be automatically placed in the horizontal or vertical dimension.
`show_arrow`	Whether tooltip's arrow should be shown.

Inherited from InspectTool

toggleable

Whether an on/off toggle button should appear in the toolbar for this inspection tool.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

anchor = 'center'¶

Type: Enum(Anchor)

If point policy is set to “snap_to_data”, anchor defines the attachment point of a tooltip. The default is to attach to the center of a glyph.

attachment = 'horizontal'¶

Type: Enum(TooltipAttachment)

Whether the tooltip should be displayed to the left or right of the cursor position or above or below it, or if it should be automatically placed in the horizontal or vertical dimension.

callback = None¶

Type: Nullable(Instance(Callback))

A callback to run in the browser whenever the input’s value changes. The cb_data parameter that is available to the Callback code will contain two HoverTool specific fields:

Index: object containing the indices of the hovered points in the data source
Geometry: object containing the coordinates of the hover cursor

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

formatters = {}¶

Type: Dict(String, Either(Enum(TooltipFieldFormatter), Instance(CustomJSHover)))

Specify the formatting scheme for data source columns, e.g.

tool.formatters = {"@date": "datetime"}

will cause format specifications for the “date” column to be interpreted according to the “datetime” formatting scheme. The following schemes are available:

“numeral”: Provides a wide variety of formats for numbers, currency, bytes, times, and percentages. The full set of formats can be found in the NumeralTickFormatter reference documentation.
“datetime”: Provides formats for date and time values. The full set of formats is listed in the DatetimeTickFormatter reference documentation.
“printf”: Provides formats similar to C-style “printf” type specifiers. See the PrintfTickFormatter reference documentation for complete details.

If no formatter is specified for a column name, the default "numeral" formatter is assumed.

line_policy = 'nearest'¶

Type: Enum(Enumeration(prev, next, nearest, interp, none))

When showing tooltips for lines, designates whether the tooltip position should be the “previous” or “next” points on the line, the “nearest” point to the current mouse position, or “interpolate” along the line to the current mouse position.

mode = 'mouse'¶

Type: Enum(Enumeration(mouse, hline, vline))

Whether to consider hover pointer as a point (x/y values), or a span on h or v directions.

muted_policy = 'show'¶

Type: Enum(Enumeration(show, ignore))

Whether to avoid showing tooltips on muted glyphs.

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.

names = []¶

Type: List

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

point_policy = 'snap_to_data'¶

Type: Enum(Enumeration(snap_to_data, follow_mouse, none))

Whether the tooltip position should snap to the “center” (or other anchor) position of the associated glyph, or always follow the current mouse cursor position.

renderers = 'auto'¶

Type: Either(Auto, List)

An explicit list of renderers to hit test against. If unset, defaults to all renderers on a plot.

show_arrow = True¶

Type: Bool

Whether tooltip’s arrow should be shown.

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.

toggleable = True¶

Type: Bool

Whether an on/off toggle button should appear in the toolbar for this inspection tool. If False, the viewers of a plot will not be able to toggle the inspector on or off using the toolbar.

tooltips = [('index', '$index'), ('data (x, y)', '($x, $y)'), ('screen (x, y)', '($sx, $sy)')]¶

Type: Either(Null, Instance(Template), String, List)

The (name, field) pairs describing what the hover tool should display when there is a hit.

Field names starting with “@” are interpreted as columns on the data source. For instance, “@temp” would look up values to display from the “temp” column of the data source.

Field names starting with “$” are special, known fields:

$index: index of hovered point in the data source
$name: value of the name property of the hovered glyph renderer
$x: x-coordinate under the cursor in data space
$y: y-coordinate under the cursor in data space
$sx: x-coordinate under the cursor in screen (canvas) space
$sy: y-coordinate under the cursor in screen (canvas) space
$color: color data from data source, with the syntax: $color[options]:field_name. The available options are: hex (to display the color as a hex value), swatch (color data from data source displayed as a small color box)
$swatch: color data from data source displayed as a small color box

Field names that begin with @ are associated with columns in a ColumnDataSource. For instance the field name "@price" will display values from the "price" column whenever a hover is triggered. If the hover is for the 17th glyph, then the hover tooltip will correspondingly display the 17th price value.

Note that if a column name contains spaces, the it must be supplied by surrounding it in curly braces, e.g. @{adjusted close} will display values from a column named "adjusted close".

Sometimes (especially with stacked charts) it is desirable to allow the name of the column be specified indirectly. The field name @$name is distinguished in that it will look up the name field on the hovered glyph renderer, and use that value as the column name. For instance, if a user hovers with the name "US East", then @$name is equivalent to @{US East}.

By default, values for fields (e.g. @foo) are displayed in a basic numeric format. However it is possible to control the formatting of values more precisely. Fields can be modified by appending a format specified to the end in curly braces. Some examples are below.

"@foo{0,0.000}"    # formats 10000.1234 as: 10,000.123

"@foo{(.00)}"      # formats -10000.1234 as: (10000.123)

"@foo{($ 0.00 a)}" # formats 1230974 as: $ 1.23 m

Specifying a format {safe} after a field name will override automatic escaping of the tooltip data source. Any HTML tags in the data tags will be rendered as HTML in the resulting HoverTool output. See Custom tooltip for a more detailed example.

None is also a valid value for tooltips. This turns off the rendering of tooltips. This is mostly useful when supplying other actions on hover via the callback property.

Note

The tooltips attribute can also be configured with a mapping type, e.g. dict or OrderedDict.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

InspectTool¶

class InspectTool(*args, **kwargs)[source]¶

A base class for tools that perform “inspections”, e.g. HoverTool.

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

{
  "description": null,
  "id": "19727",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "toggleable": true
}

Public Data Attributes:

toggleable

Whether an on/off toggle button should appear in the toolbar for this inspection tool.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

toggleable = True¶

Type: Bool

Whether an on/off toggle button should appear in the toolbar for this inspection tool. If False, the viewers of a plot will not be able to toggle the inspector on or off using the toolbar.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

LassoSelectTool¶

class LassoSelectTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Drag, bokeh.models.tools.SelectTool

toolbar icon:

The lasso selection tool allows users to make selections on a Plot by indicating a free-drawn “lasso” region by dragging the mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

JSON Prototype

{
  "description": null,
  "id": "19733",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "overlay": {
    "id": "19734"
  },
  "renderers": "auto",
  "select_every_mousemove": true,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`select_every_mousemove`	Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed.
`overlay`	A shaded annotation drawn to indicate the selection region.

Inherited from SelectTool

`names`	A list of names to query for.
`renderers`	An explicit list of renderers to hit test against.
`mode`	Defines what should happen when a new selection is made.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

mode = 'replace'¶

Type: Enum(SelectionMode)

Defines what should happen when a new selection is made. The default is to replace the existing selection. Other options are to append to the selection, intersect with it or subtract from it.

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.

names = []¶

Type: List

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

overlay = PolyAnnotation(id='19740', ...)¶

Type: Instance(PolyAnnotation)

A shaded annotation drawn to indicate the selection region.

renderers = 'auto'¶

Type: Either(Auto, List)

An explicit list of renderers to hit test against. If unset, defaults to all renderers on a plot.

select_every_mousemove = True¶

Type: Bool

Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

LineEditTool¶

class LineEditTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

toolbar icon:

The LineEditTool allows editing the intersection points of one or more Line glyphs. Glyphs to be edited are defined via the renderers property and a renderer for the intersections is set via the intersection_renderer property (must render a point-like Glyph (a subclass of XYGlyph).

The tool will modify the columns on the data source corresponding to the x and y values of the glyph. Any additional columns in the data source will be padded with the declared``empty_value``, when adding a new point.

The supported actions include:

Show intersections: Double tap an existing line
Move point: Drag an existing point and let go of the mouse button to release it.

JSON Prototype

{
  "custom_icon": null,
  "description": null,
  "dimensions": "both",
  "id": "19745",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`intersection_renderer`	The renderer used to render the intersections of a selected line
`dimensions`	Which dimensions this edit tool is constrained to act in.

Inherited from EditTool

`custom_tooltip`
`empty_value`	Defines the value to insert on non-coordinate columns when a new glyph is inserted into the `ColumnDataSource` columns, e.g.
`custom_icon`	An icon to display in the toolbar.
`renderers`	An explicit list of renderers corresponding to scatter glyphs that may be edited.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from EditTool

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

custom_icon = None¶

Type: Nullable(Image)

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions this edit tool is constrained to act in. By default the line edit tool allows moving points in any dimension, but can be configured to only allow horizontal movement across the width of the plot, or vertical across the height of the plot.

empty_value = Undefined¶

Type: NonNullable(Either(Bool, Int, Float, Date, Datetime, Color, String))

Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.

intersection_renderer = Undefined¶

Type: Instance(GlyphRenderer)

The renderer used to render the intersections of a selected line

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.

renderers = []¶

Type: List

An explicit list of renderers corresponding to scatter glyphs that may be edited.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

PanTool¶

class PanTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Drag

toolbar icon:

The pan tool allows the user to pan a Plot by left-dragging a mouse, or on touch devices by dragging a finger or stylus, across the plot region.

The pan tool also activates the border regions of a Plot for “single axis” panning. For instance, dragging in the vertical border or axis will effect a pan in the vertical direction only, with horizontal dimension kept fixed.

JSON Prototype

{
  "description": null,
  "dimensions": "both",
  "id": "19755",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

dimensions

Which dimensions the pan tool is constrained to act in.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the pan tool is constrained to act in. By default the pan tool will pan in any dimension, but can be configured to only pan horizontally across the width of the plot, or vertically across the height of the plot.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

PointDrawTool¶

class PointDrawTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

toolbar icon:

The PointDrawTool allows adding, dragging and deleting point-like glyphs (i.e subclasses of``XYGlyph``) on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. Any newly added points will be inserted on the ColumnDataSource of the first supplied renderer.

The tool will modify the columns on the data source corresponding to the x and y values of the glyph. Any additional columns in the data source will be padded with the given empty_value when adding a new point.

Note

The data source updates will trigger data change events continuously throughout the edit operations on the BokehJS side. In Bokeh server apps, the data source will only be synced once, when the edit operation finishes.

The supported actions include:

Add point: Tap anywhere on the plot
Move point: Tap and drag an existing point, the point will be dropped once you let go of the mouse button.
Delete point: Tap a point to select it then press <<backspace>> key while the mouse is within the plot area.

JSON Prototype

{
  "add": true,
  "custom_icon": null,
  "description": null,
  "drag": true,
  "id": "19761",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`add`	Enables adding of new points on tap events.
`drag`	Enables dragging of existing points on pan events.
`num_objects`	Defines a limit on the number of points that can be drawn.

Inherited from EditTool

`custom_tooltip`
`empty_value`	Defines the value to insert on non-coordinate columns when a new glyph is inserted into the `ColumnDataSource` columns, e.g.
`custom_icon`	An icon to display in the toolbar.
`renderers`	An explicit list of renderers corresponding to scatter glyphs that may be edited.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from EditTool

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

add = True¶

Type: Bool

Enables adding of new points on tap events.

custom_icon = None¶

Type: Nullable(Image)

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

drag = True¶

Type: Bool

Enables dragging of existing points on pan events.

empty_value = Undefined¶

Type: NonNullable(Either(Bool, Int, Float, Date, Datetime, Color, String))

Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.

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.

num_objects = 0¶

Type: Int

Defines a limit on the number of points that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn point will be dropped to make space for the new point.

renderers = []¶

Type: List

An explicit list of renderers corresponding to scatter glyphs that may be edited.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

PolyDrawTool¶

class PolyDrawTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.PolyTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

toolbar icon:

The PolyDrawTool allows drawing, selecting and deleting Patches and MultiLine glyphs on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly.

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

If a vertex_renderer with an point-like glyph is supplied then the PolyDrawTool will use it to display the vertices of the multi-lines or patches on all supplied renderers. This also enables the ability to snap to existing vertices while drawing.

The supported actions include:

Add patch or multi-line: Double tap to add the first vertex, then use tap to add each subsequent vertex, to finalize the draw action double tap to insert the final vertex or press the <<esc> key.
Move patch or ulti-line: Tap and drag an existing patch/multi-line, the point will be dropped once you let go of the mouse button.
Delete patch or multi-line: Tap a patch/multi-line to select it then press <<backspace>> key while the mouse is within the plot area.

JSON Prototype

{
  "custom_icon": null,
  "description": null,
  "drag": true,
  "id": "19772",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "vertex_renderer": null
}

Public Data Attributes:

`drag`	Enables dragging of existing patches and multi-lines on pan events.
`num_objects`	Defines a limit on the number of patches or multi-lines that can be drawn.

Inherited from PolyTool

vertex_renderer

The renderer used to render the vertices of a selected line or polygon.

Inherited from EditTool

`custom_tooltip`
`empty_value`	Defines the value to insert on non-coordinate columns when a new glyph is inserted into the `ColumnDataSource` columns, e.g.
`custom_icon`	An icon to display in the toolbar.
`renderers`	An explicit list of renderers corresponding to scatter glyphs that may be edited.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from EditTool

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

custom_icon = None¶

Type: Nullable(Image)

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

drag = True¶

Type: Bool

Enables dragging of existing patches and multi-lines on pan events.

empty_value = Undefined¶

Type: NonNullable(Either(Bool, Int, Float, Date, Datetime, Color, String))

Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.

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.

num_objects = 0¶

Type: Int

Defines a limit on the number of patches or multi-lines that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn patch or multi-line will be dropped to make space for the new patch or multi-line.

renderers = []¶

Type: List

An explicit list of renderers corresponding to scatter glyphs that may be edited.

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.

vertex_renderer = None¶

Type: Nullable(Instance(GlyphRenderer))

The renderer used to render the vertices of a selected line or polygon.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

PolyEditTool¶

class PolyEditTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.PolyTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

toolbar icon:

The PolyEditTool allows editing the vertices of one or more Patches or MultiLine glyphs. Glyphs to be edited are defined via the renderers property and a renderer for the vertices is set via the vertex_renderer property (must render a point-like Glyph (a subclass of XYGlyph).

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared``empty_value``, when adding a new point.

The supported actions include:

Show vertices: Double tap an existing patch or multi-line
Add vertex: Double tap an existing vertex to select it, the tool will draw the next point, to add it tap in a new location. To finish editing and add a point double tap otherwise press the <<esc> key to cancel.
Move vertex: Drag an existing vertex and let go of the mouse button to release it.
Delete vertex: After selecting one or more vertices press <<backspace>> while the mouse cursor is within the plot area.

JSON Prototype

{
  "custom_icon": null,
  "description": null,
  "id": "19783",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "vertex_renderer": null
}

Public Data Attributes:

Inherited from PolyTool

vertex_renderer

The renderer used to render the vertices of a selected line or polygon.

Inherited from EditTool

`custom_tooltip`
`empty_value`	Defines the value to insert on non-coordinate columns when a new glyph is inserted into the `ColumnDataSource` columns, e.g.
`custom_icon`	An icon to display in the toolbar.
`renderers`	An explicit list of renderers corresponding to scatter glyphs that may be edited.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from EditTool

__init__(*args, **kwargs)

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(args, *kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(args, *kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(*args, **kwargs)

Inherited from PropertyCallbackManager

`__init__`(args, *kwargs)
`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 EventCallbackManager

`__init__`(args, *kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

custom_icon = None¶

Type: Nullable(Image)

An icon to display in the toolbar.

The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

empty_value = Undefined¶

Type: NonNullable(Either(Bool, Int, Float, Date, Datetime, Color, String))

Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.

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.

renderers = []¶

Type: List

An explicit list of renderers corresponding to scatter glyphs that may be edited.

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.

vertex_renderer = None¶

Type: Nullable(Instance(GlyphRenderer))

The renderer used to render the vertices of a selected line or polygon.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

PolySelectTool¶

class PolySelectTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Tap, bokeh.models.tools.SelectTool

toolbar icon:

The polygon selection tool allows users to make selections on a Plot by indicating a polygonal region with mouse clicks. single clicks (or taps) add successive points to the definition of the polygon, and a double click (or tap) indicates the selection region is ready.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

JSON Prototype

{
  "description": null,
  "id": "19792",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "overlay": {
    "id": "19793"
  },
  "renderers": "auto",
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

overlay

A shaded annotation drawn to indicate the selection region.

Inherited from SelectTool

`names`	A list of names to query for.
`renderers`	An explicit list of renderers to hit test against.
`mode`	Defines what should happen when a new selection is made.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

mode = 'replace'¶

Type: Enum(SelectionMode)

Defines what should happen when a new selection is made. The default is to replace the existing selection. Other options are to append to the selection, intersect with it or subtract from it.

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.

names = []¶

Type: List

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

overlay = PolyAnnotation(id='19799', ...)¶

Type: Instance(PolyAnnotation)

A shaded annotation drawn to indicate the selection region.

renderers = 'auto'¶

Type: Either(Auto, List)

An explicit list of renderers to hit test against. If unset, defaults to all renderers on a plot.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ProxyToolbar¶

class ProxyToolbar(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.ToolbarBase

A toolbar that allow to merge and proxy tools of toolbars in multiple plots.

JSON Prototype

{
  "autohide": false,
  "id": "19803",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "logo": "normal",
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "toolbars": [],
  "tools": []
}

Public Data Attributes:

toolbars

Inherited from ToolbarBase

`logo`	What version of the Bokeh logo to display on the toolbar.
`autohide`	Whether the toolbar will be hidden by default.
`tools`	A list of tools to add to the plot.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

autohide = False¶

Type: Bool

Whether the toolbar will be hidden by default. Default: False. If True, hides toolbar when cursor is not in canvas.

logo = 'normal'¶

Type: Nullable(Enum(Enumeration(normal, grey)))

What version of the Bokeh logo to display on the toolbar. If set to None, no logo will be displayed.

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.

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.

toolbars = []¶

Type: List

tools = []¶

Type: List

A list of tools to add to the plot.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

RangeTool¶

class RangeTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Drag

toolbar icon:

The range tool allows the user to update range objects for either or both of the x- or y-dimensions by dragging a corresponding shaded annotation to move it or change its boundaries.

A common use case is to add this tool to a plot with a large fixed range, but to configure the tool range from a different plot. When the user manipulates the overlay, the range of the second plot will be updated automatically.

JSON Prototype

{
  "description": null,
  "id": "19811",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "overlay": {
    "id": "19812"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "x_interaction": true,
  "x_range": null,
  "y_interaction": true,
  "y_range": null
}

Public Data Attributes:

`x_range`	A range synchronized to the x-dimension of the overlay.
`x_interaction`	Whether to respond to horizontal pan motions when an `x_range` is present.
`y_range`	A range synchronized to the y-dimension of the overlay.
`y_interaction`	Whether to respond to vertical pan motions when a `y_range` is present.
`overlay`	A shaded annotation drawn to indicate the configured ranges.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

overlay = BoxAnnotation(id='19816', ...)¶

Type: Instance(BoxAnnotation)

A shaded annotation drawn to indicate the configured ranges.

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.

x_interaction = True¶

Type: Bool

Whether to respond to horizontal pan motions when an x_range is present.

By default, when an x_range is specified, it is possible to adjust the horizontal position of the range box by panning horizontally inside the box, or along the top or bottom edge of the box. To disable this, and fix the range box in place horizontally, set to False. (The box will still update if the x_range is updated programmatically.)

x_range = None¶

Type: Nullable(Instance(Range1d))

A range synchronized to the x-dimension of the overlay. If None, the overlay will span the entire x-dimension.

y_interaction = True¶

Type: Bool

Whether to respond to vertical pan motions when a y_range is present.

By default, when a y_range is specified, it is possible to adjust the vertical position of the range box by panning vertically inside the box, or along the top or bottom edge of the box. To disable this, and fix the range box in place vertically, set to False. (The box will still update if the y_range is updated programmatically.)

y_range = None¶

Type: Nullable(Instance(Range1d))

A range synchronized to the y-dimension of the overlay. If None, the overlay will span the entire y-dimension.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

RedoTool¶

class RedoTool(*args, **kwargs)[source]¶

toolbar icon:

Redo tool reverses the last action performed by undo tool.

JSON Prototype

{
  "description": null,
  "id": "19823",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ResetTool¶

class ResetTool(*args, **kwargs)[source]¶

toolbar icon:

The reset tool is an action. When activated in the toolbar, the tool resets the data bounds of the plot to their values when the plot was initially created.

JSON Prototype

{
  "description": null,
  "id": "19828",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

SaveTool¶

class SaveTool(*args, **kwargs)[source]¶

toolbar icon:

The save tool is an action. When activated, the tool opens a download dialog which allows to save an image reproduction of the plot in PNG format. If automatic download is not support by a web browser, the tool falls back to opening the generated image in a new tab or window. User then can manually save it by right clicking on the image and choosing “Save As” (or similar) menu item.

JSON Prototype

{
  "description": null,
  "id": "19833",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Scroll¶

class Scroll(*args, **kwargs)[source]¶

A base class for tools that respond to scroll events.

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

{
  "description": null,
  "id": "19838",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Tap¶

class Tap(*args, **kwargs)[source]¶

A base class for tools that respond to tap/click events.

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

{
  "description": null,
  "id": "19843",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

TapTool¶

class TapTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Tap, bokeh.models.tools.SelectTool

toolbar icon:

The tap selection tool allows the user to select at single points by left-clicking a mouse, or tapping with a finger.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

JSON Prototype

{
  "behavior": "select",
  "callback": null,
  "description": null,
  "gesture": "tap",
  "id": "19848",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "renderers": "auto",
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`behavior`	This tool can be configured to either make selections or inspections on associated data sources.
`gesture`	Specifies which kind of gesture will be used to trigger the tool, either a single or double tap.
`callback`	A callback to execute whenever a glyph is "hit" by a mouse click or tap.

Inherited from SelectTool

`names`	A list of names to query for.
`renderers`	An explicit list of renderers to hit test against.
`mode`	Defines what should happen when a new selection is made.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

behavior = 'select'¶

Type: Enum(Enumeration(select, inspect))

This tool can be configured to either make selections or inspections on associated data sources. The difference is that selection changes propagate across bokeh and other components (e.g. selection glyph) will be notified. Inspections don’t act like this, so it’s useful to configure callback when setting behavior=’inspect’.

callback = None¶

Type: Nullable(Instance(Callback))

A callback to execute whenever a glyph is “hit” by a mouse click or tap.

This is often useful with the OpenURL model to open URLs based on a user clicking or tapping a specific glyph.

However, it may also be a CustomJS which can execute arbitrary JavaScript code in response to clicking or tapping glyphs. The callback will be executed for each individual glyph that is it hit by a click or tap, and will receive the TapTool model as cb_obj. The optional cb_data will have the data source as its .source attribute and the selection geometry as its .geometries attribute.

The .geometries attribute has 5 members. .type is the geometry type, which always a .point for a tap event. .sx and .sy are the screen X and Y coordinates where the tap occurred. .x and .y are the converted data coordinates for the item that has been selected. The .x and .y values are based on the axis assigned to that glyph.

Note

This callback does not execute on every tap, only when a glyph is “hit”. If you would like to execute a callback on every mouse tap, please see CustomJS for user interaction events.

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

gesture = 'tap'¶

Type: Enum(Enumeration(tap, doubletap))

Specifies which kind of gesture will be used to trigger the tool, either a single or double tap.

mode = 'replace'¶

Type: Enum(SelectionMode)

Defines what should happen when a new selection is made. The default is to replace the existing selection. Other options are to append to the selection, intersect with it or subtract from it.

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.

names = []¶

Type: List

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

renderers = 'auto'¶

Type: Either(Auto, List)

An explicit list of renderers to hit test against. If unset, defaults to all renderers on a plot.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Tool¶

class Tool(*args, **kwargs)[source]¶

Bases: bokeh.model.model.Model

A base class for all interactive tool types.

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

{
  "description": null,
  "id": "19859",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool[source]¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Toolbar¶

class Toolbar(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.ToolbarBase

Collect tools to display for a single plot.

JSON Prototype

{
  "active_drag": "auto",
  "active_inspect": "auto",
  "active_multi": "auto",
  "active_scroll": "auto",
  "active_tap": "auto",
  "autohide": false,
  "id": "19864",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "logo": "normal",
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "tools": []
}

Public Data Attributes:

`active_drag`	Specify a drag tool to be active when the plot is displayed.
`active_inspect`	Specify an inspection tool or sequence of inspection tools to be active when the plot is displayed.
`active_scroll`	Specify a scroll/pinch tool to be active when the plot is displayed.
`active_tap`	Specify a tap/click tool to be active when the plot is displayed.
`active_multi`	Specify an active multi-gesture tool, for instance an edit tool or a range tool.

Inherited from ToolbarBase

`logo`	What version of the Bokeh logo to display on the toolbar.
`autohide`	Whether the toolbar will be hidden by default.
`tools`	A list of tools to add to the plot.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

active_drag = 'auto'¶

Type: Either(Null, Auto, Instance(Drag))

Specify a drag tool to be active when the plot is displayed.

active_inspect = 'auto'¶

Type: Either(Null, Auto, Instance(InspectTool), Seq(Instance(InspectTool)))

Specify an inspection tool or sequence of inspection tools to be active when the plot is displayed.

active_multi = 'auto'¶

Type: Either(Null, Auto, Instance(GestureTool))

Specify an active multi-gesture tool, for instance an edit tool or a range tool.

Note that activating a multi-gesture tool will deactivate any other gesture tools as appropriate. For example, if a pan tool is set as the active drag, and this property is set to a BoxEditTool instance, the pan tool will be deactivated (i.e. the multi-gesture tool will take precedence).

active_scroll = 'auto'¶

Type: Either(Null, Auto, Instance(Scroll))

Specify a scroll/pinch tool to be active when the plot is displayed.

active_tap = 'auto'¶

Type: Either(Null, Auto, Instance(Tap))

Specify a tap/click tool to be active when the plot is displayed.

autohide = False¶

Type: Bool

Whether the toolbar will be hidden by default. Default: False. If True, hides toolbar when cursor is not in canvas.

logo = 'normal'¶

Type: Nullable(Enum(Enumeration(normal, grey)))

What version of the Bokeh logo to display on the toolbar. If set to None, no logo will be displayed.

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.

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.

tools = []¶

Type: List

A list of tools to add to the plot.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ToolbarBase¶

class ToolbarBase(*args, **kwargs)[source]¶

Bases: bokeh.model.model.Model

A base class for different toolbars.

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

{
  "autohide": false,
  "id": "19876",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "logo": "normal",
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "tools": []
}

Public Data Attributes:

`logo`	What version of the Bokeh logo to display on the toolbar.
`autohide`	Whether the toolbar will be hidden by default.
`tools`	A list of tools to add to the plot.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

autohide = False¶

Type: Bool

Whether the toolbar will be hidden by default. Default: False. If True, hides toolbar when cursor is not in canvas.

logo = 'normal'¶

Type: Nullable(Enum(Enumeration(normal, grey)))

What version of the Bokeh logo to display on the toolbar. If set to None, no logo will be displayed.

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.

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.

tools = []¶

Type: List

A list of tools to add to the plot.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ToolbarBox¶

class ToolbarBox(*args, **kwargs)[source]¶

Bases: bokeh.models.layouts.LayoutDOM

A layoutable toolbar that can accept the tools of multiple plots, and can merge the tools into a single button for convenience.

JSON Prototype

{
  "align": "start",
  "aspect_ratio": null,
  "background": null,
  "css_classes": [],
  "disabled": false,
  "height": null,
  "height_policy": "auto",
  "id": "19883",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    0,
    0,
    0,
    0
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "sizing_mode": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "toolbar_location": "right",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

`toolbar`	A toolbar associated with a plot which holds all its tools.
`toolbar_location`

Inherited from LayoutDOM

`disabled`	Whether the widget will be disabled when rendered.
`visible`	Whether the component will be visible and a part of a layout.
`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.
`sizing_mode`	How the component should size itself.
`align`	The alignment point within the parent container.
`background`	Background color of the component.
`css_classes`	A list of CSS class names to add to this DOM element.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

align = 'start'¶

Type: Either(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).

background = None¶

Type: Nullable(Color)

Background color of the component.

css_classes = []¶

Type: List

A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.

It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.

disabled = False¶

Type: Bool

Whether the widget will be disabled when rendered.

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

height = None¶

Type: Nullable(NonNegativeInt)

The height of the component (in pixels).

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

height_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit": Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min": Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

margin = (0, 0, 0, 0)¶

Type: Nullable(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(NonNegativeInt)

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

max_width = None¶

Type: Nullable(NonNegativeInt)

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

min_height = None¶

Type: Nullable(NonNegativeInt)

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

min_width = None¶

Type: Nullable(NonNegativeInt)

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.

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:

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

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.

toolbar = Undefined¶

Type: Instance(ToolbarBase)

A toolbar associated with a plot which holds all its tools.

visible = True¶

Type: Bool

Whether the component will be visible and a part of a layout.

width = None¶

Type: Nullable(NonNegativeInt)

The width of the component (in pixels).

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

width_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
"fit": Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
"min": Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

UndoTool¶

class UndoTool(*args, **kwargs)[source]¶

toolbar icon:

Undo tool allows to restore previous state of the plot.

JSON Prototype

{
  "description": null,
  "id": "19904",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

WheelPanTool¶

class WheelPanTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Scroll

toolbar icon:

The wheel pan tool allows the user to pan the plot along the configured dimension using the scroll wheel.

JSON Prototype

{
  "description": null,
  "dimension": "width",
  "id": "19909",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

dimension

Which dimension the wheel pan tool is constrained to act in.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimension = 'width'¶

Type: Enum(Dimension)

Which dimension the wheel pan tool is constrained to act in. By default the wheel pan tool will pan the plot along the x-axis.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

WheelZoomTool¶

class WheelZoomTool(*args, **kwargs)[source]¶

Bases: bokeh.models.tools.Scroll

toolbar icon:

The wheel zoom tool will zoom the plot in and out, centered on the current mouse location.

The wheel zoom tool also activates the border regions of a Plot for “single axis” zooming. For instance, zooming in the vertical border or axis will effect a zoom in the vertical direction only, with the horizontal dimension kept fixed.

JSON Prototype

{
  "description": null,
  "dimensions": "both",
  "id": "19915",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "maintain_focus": true,
  "name": null,
  "speed": 0.0016666666666666668,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "zoom_on_axis": true
}

Public Data Attributes:

`dimensions`	Which dimensions the wheel zoom tool is constrained to act in.
`maintain_focus`	If True, then hitting a range bound in any one dimension will prevent all further zooming all dimensions.
`zoom_on_axis`	Whether scrolling on an axis (outside the central plot area) should zoom that dimension.
`speed`	Speed at which the wheel zooms.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the wheel zoom tool is constrained to act in. By default the wheel zoom tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.

maintain_focus = True¶

Type: Bool

If True, then hitting a range bound in any one dimension will prevent all further zooming all dimensions. If False, zooming can continue independently in any dimension that has not yet reached its bounds, even if that causes overall focus or aspect ratio to change.

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.

speed = 0.0016666666666666668¶

Type: Float

Speed at which the wheel zooms. Default is 1/600. Optimal range is between 0.001 and 0.09. High values will be clipped. Speed may very between browsers.

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.

zoom_on_axis = True¶

Type: Bool

Whether scrolling on an axis (outside the central plot area) should zoom that dimension.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ZoomInTool¶

class ZoomInTool(*args, **kwargs)[source]¶

toolbar icon:

The zoom-in tool allows users to click a button to zoom in by a fixed amount.

JSON Prototype

{
  "description": null,
  "dimensions": "both",
  "factor": 0.1,
  "id": "19924",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`dimensions`	Which dimensions the zoom-in tool is constrained to act in.
`factor`	Percentage to zoom for each click of the zoom-in tool.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the zoom-in tool is constrained to act in. By default the zoom-in zoom tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.

factor = 0.1¶

Type: Percent

Percentage to zoom for each click of the zoom-in tool.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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

references() → Set[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, 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, Unknown]) → 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, Unknown] | 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_json(include_defaults: bool) → JSON¶

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) → str¶

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters: include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)

update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) → None¶

Updates the object’s properties from a JSON attributes dictionary.

Parameters

json_attributes – (JSON-dict) : attributes and values to update
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

property document: Document | None¶: The Document this model is attached to (can be None)

property struct: bokeh.core.types.ReferenceJson¶

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ZoomOutTool¶

class ZoomOutTool(*args, **kwargs)[source]¶

toolbar icon:

The zoom-out tool allows users to click a button to zoom out by a fixed amount.

JSON Prototype

{
  "description": null,
  "dimensions": "both",
  "factor": 0.1,
  "id": "19931",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "maintain_focus": true,
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`dimensions`	Which dimensions the zoom-out tool is constrained to act in.
`factor`	Percentage to zoom for each click of the zoom-in tool.
`maintain_focus`	If True, then hitting a range bound in any one dimension will prevent all further zooming all dimensions.

Inherited from Tool

A string describing the purpose of this tool.

Inherited from Model

`model_class_reverse_map`
`id`
`ref`
`struct`	A Bokeh protocol "structure" of this model, i.e. a dict of the form:.
`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.
`subscribed_events`	List of events that are subscribed to by Python 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.
`syncable`	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

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

Public Methods:

Inherited from Tool

`from_string`(name)	Takes a string and returns a corresponding Tool instance.
`register_alias`(name, constructor)

Inherited from Model

`__init_subclass__`()
`__new__`(cls, args, *kwargs)
`__init__`(**kwargs)
`__str__`()	Return str(self).
`__repr__`()	Return repr(self).
`destroy`()	Clean up references to the document and property
`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_json`(include_defaults)	Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).
`to_json_string`(include_defaults)	Returns a JSON string encoding the attributes of this object.
`trigger`(attr, old, new[, hint, setter])

Inherited from HasProps

`__init__`(**kwargs)
`__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.
`static_to_serializable`(serializer)
`to_serializable`(serializer)
`set_from_json`(name, json, *[, models, setter])	Set a property value on this object from JSON.
`update`(**kwargs)	Updates the object's properties from the given keyword arguments.
`update_from_json`(json_attributes, *[, ...])	Updates the object's properties from a JSON attributes dictionary.
`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.
`properties_with_refs`()	Collect the names of all properties on this class that also have references.
`dataspecs`()	Collect the names of all `DataSpec` properties on this class.
`properties_with_values`(*[, ...])	Collect a dict mapping property names to their values.
`query_properties_with_values`(query, *[, ...])	Query the properties values of `HasProps` instances with a predicate.
`themed_values`()	Get any theme-provided overrides.
`apply_theme`(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
`unapply_theme`()	Remove any themed values and restore defaults.

Inherited from HasDocumentRef

__init__(**kwargs)

Inherited from PropertyCallbackManager

`__init__`(**kwargs)
`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 EventCallbackManager

`__init__`(**kwargs)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

description = None¶

Type: Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'¶

Type: Enum(Dimensions)

Which dimensions the zoom-out tool is constrained to act in. By default the zoom-out tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.

factor = 0.1¶

Type: Percent

Percentage to zoom for each click of the zoom-in tool.

maintain_focus = True¶

Type: Bool

If True, then hitting a range bound in any one dimension will prevent all further zooming all dimensions. If False, zooming can continue independently in any dimension that has not yet reached its bounds, even if that causes overall focus or aspect ratio to change.

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.

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.

apply_theme(property_values: Dict[str, Any]) → None¶

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

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod dataspecs() → Dict[str, DataSpec]¶

Collect the names of all DataSpec properties on this class.

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

Returns: names of DataSpec properties
Return type: set[str]

destroy() → None¶: Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) → bool¶

Structural equality of models.

Parameters: other (HasProps) – the other instance to compare to
Returns: True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool¶: Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None¶

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

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 properties(*, _with_props: bool = False) → Union[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[[bokeh.core.property.descriptors.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