transforms

Represent transformations of data to happen on the client (browser) side.

class CustomJSTransform(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Transform

Apply a custom defined transform to data.

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": {
    "type": "map"
  },
  "func": "",
  "id": "p126357",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "name": null,
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "v_func": ""
}

Public Data Attributes:

args	A mapping of names to Python objects.
func	A snippet of JavaScript code to transform a single value.
v_func	A snippet of JavaScript code to transform an array of values.

Inherited from Model

id
ref
name	An arbitrary, user-supplied name for this model.
tags	An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks	A mapping of event names to lists of CustomJS callbacks.
js_property_callbacks	A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
subscribed_events	Collection of events that are subscribed to by Python callbacks.
syncable	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

document

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

Public Methods:

__init__(*[, func, name, syncable, tags, v_func])

Inherited from Transform

__init__(*[, syncable, tags])

Inherited from Model

__init_subclass__()	This method is called when a class is subclassed.
__new__(cls, *args[, id])
__init__(*args, **kwargs)
__str__()	Return str(self).
__str__()	Return str(self).
destroy()	Clean up references to the document and property
parameters()	Generate Python Parameter values suitable for functions that are derived from the glyph.
js_on_event(event, *callbacks)
js_link(attr, other, other_attr[, attr_selector])	Link two Bokeh model properties using JavaScript.
js_on_change(event, *callbacks)	Attach a CustomJS callback to an arbitrary BokehJS model event.
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
references()	Returns all Models that this object has references to.
select(selector)	Query this object and all of its references for objects that match the given selector.
select_one(selector)	Query this object and all of its references for objects that match the given selector.
set_select(selector, updates)	Update objects that match a given selector with the specified attribute/value updates.
to_serializable(serializer)	Converts this object to a serializable representation.
trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()	This method is called when a class is subclassed.
__init__(**properties)
__setattr__(name, value)	Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__(name)	Intercept attribute setting on HasProps in order to special case a few situations:
__str__()	Return str(self).
__str__()	Return str(self).
equals(other)	Structural equality of models.
to_serializable(serializer)	Converts this object to a serializable representation.
set_from_json(name, value, *[, setter])	Set a property value on this object from JSON.
update(**kwargs)	Updates the object's properties from the given keyword arguments.
lookup(name, *[, raises])	Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
properties(*[, _with_props])	Collect the names of properties on this class.
descriptors()	List of property descriptors in the order of definition.
properties_with_refs()	Collect the names of all properties on this class that also have references.
dataspecs()	Collect the names of all DataSpec properties on this class.
properties_with_values(*[, ...])	Collect a dict mapping property names to their values.
query_properties_with_values(query, *[, ...])	Query the properties values of HasProps instances with a predicate.
themed_values()	Get any theme-provided overrides.
apply_theme(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
unapply_theme()	Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
remove_on_change(attr, *callbacks)	Remove a callback from this object
trigger(attr, old, new[, hint, setter])	Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

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

---

args = {}

Type:

Dict(String, AnyRef)

A mapping of names to Python objects. In particular those can be bokeh’s models. These objects are made available to the transform’ code snippet as the values of named parameters to the callback.

func = ''

Type:

String

A snippet of JavaScript code to transform a single value. The variable x will contain the untransformed value and can be expected to be present in the function namespace at render time. The snippet will be into the body of a function and therefore requires a return statement.

Example:

func = '''
return Math.floor(x) + 0.5
'''

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.

v_func = ''

Type:

String

A snippet of JavaScript code to transform an array of values. The variable xs will contain the untransformed array and can be expected to be present in the function namespace at render time. The snippet will be into the body of a function and therefore requires a return statement.

Example:

v_func = '''
const new_xs = new Array(xs.length)
for(let i = 0; i < xs.length; i++) {
    new_xs[i] = xs[i] + 0.5
}
return new_xs
'''

Warning

The vectorized function, v_func, must return an array of the same length as the input xs array.

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

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

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

Parameters:

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

Returns:

None

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

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

Returns:

names of DataSpec properties

Return type:

set[str]

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

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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:

PropertyDescriptor

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

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

Parameters:

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

• *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | Type[Event], *callbacks: EventCallback) → None

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]

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

Returns:

list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:

property names

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

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

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

Returns:

names of properties that have references

Return type:

set[str]

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

Collect a dict mapping property names to their values.

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

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

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

Returns:

mapping from property names to their values

Return type:

dict

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

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

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

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

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

Set a property value on this object from JSON.

Parameters:

• name – (str) : name of the attribute to set

• json – (JSON-value) : value to set to the attribute to

• models (dict or None, optional) –

  Mapping of model ids to models (default: None)

  This is needed in cases where the attributes to update also have values that have references.

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

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

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

Parameters:

• selector (JSON-like) –

• updates (dict) –

Returns:

None

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

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

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

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

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

class Dodge(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Transform

Apply either fixed dodge amount to data.

JSON Prototype

{
  "id": "p126364",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "name": null,
  "range": null,
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "value": 0
}

Public Data Attributes:

value	The amount to dodge the input data.
range	When applying Dodge to categorical data values, the corresponding FactorRange must be supplied as the range property.

Inherited from Model

id
ref
name	An arbitrary, user-supplied name for this model.
tags	An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks	A mapping of event names to lists of CustomJS callbacks.
js_property_callbacks	A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
subscribed_events	Collection of events that are subscribed to by Python callbacks.
syncable	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

document

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

Public Methods:

__init__(*[, range, syncable, tags, value])

Inherited from Transform

__init__(*[, syncable, tags])

Inherited from Model

__init_subclass__()	This method is called when a class is subclassed.
__new__(cls, *args[, id])
__init__(*args, **kwargs)
__str__()	Return str(self).
__str__()	Return str(self).
destroy()	Clean up references to the document and property
parameters()	Generate Python Parameter values suitable for functions that are derived from the glyph.
js_on_event(event, *callbacks)
js_link(attr, other, other_attr[, attr_selector])	Link two Bokeh model properties using JavaScript.
js_on_change(event, *callbacks)	Attach a CustomJS callback to an arbitrary BokehJS model event.
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
references()	Returns all Models that this object has references to.
select(selector)	Query this object and all of its references for objects that match the given selector.
select_one(selector)	Query this object and all of its references for objects that match the given selector.
set_select(selector, updates)	Update objects that match a given selector with the specified attribute/value updates.
to_serializable(serializer)	Converts this object to a serializable representation.
trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()	This method is called when a class is subclassed.
__init__(**properties)
__setattr__(name, value)	Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__(name)	Intercept attribute setting on HasProps in order to special case a few situations:
__str__()	Return str(self).
__str__()	Return str(self).
equals(other)	Structural equality of models.
to_serializable(serializer)	Converts this object to a serializable representation.
set_from_json(name, value, *[, setter])	Set a property value on this object from JSON.
update(**kwargs)	Updates the object's properties from the given keyword arguments.
lookup(name, *[, raises])	Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
properties(*[, _with_props])	Collect the names of properties on this class.
descriptors()	List of property descriptors in the order of definition.
properties_with_refs()	Collect the names of all properties on this class that also have references.
dataspecs()	Collect the names of all DataSpec properties on this class.
properties_with_values(*[, ...])	Collect a dict mapping property names to their values.
query_properties_with_values(query, *[, ...])	Query the properties values of HasProps instances with a predicate.
themed_values()	Get any theme-provided overrides.
apply_theme(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
unapply_theme()	Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
remove_on_change(attr, *callbacks)	Remove a callback from this object
trigger(attr, old, new[, hint, setter])	Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

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

---

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.

range = None

Type:

Nullable(Instance(Range))

When applying Dodge to categorical data values, the corresponding FactorRange must be supplied as the range property.

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.

value = 0

Type:

Float

The amount to dodge the input data.

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

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

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

Parameters:

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

Returns:

None

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

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

Returns:

names of DataSpec properties

Return type:

set[str]

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

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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:

PropertyDescriptor

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

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

Parameters:

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

• *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | Type[Event], *callbacks: EventCallback) → None

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]

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

Returns:

list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:

property names

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

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

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

Returns:

names of properties that have references

Return type:

set[str]

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

Collect a dict mapping property names to their values.

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

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

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

Returns:

mapping from property names to their values

Return type:

dict

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

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

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

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

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

Set a property value on this object from JSON.

Parameters:

• name – (str) : name of the attribute to set

• json – (JSON-value) : value to set to the attribute to

• models (dict or None, optional) –

  Mapping of model ids to models (default: None)

  This is needed in cases where the attributes to update also have values that have references.

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

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

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

Parameters:

• selector (JSON-like) –

• updates (dict) –

Returns:

None

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

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

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

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

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

class Interpolator(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Transform

Base class for interpolator transforms.

Interpolators return the value of a function which has been evaluated between specified (x, y) pairs of data. As an example, if two control point pairs were provided to the interpolator, a linear interpolaction at a specific value of ‘x’ would result in the value of ‘y’ which existed on the line connecting the two control points.

The control point pairs for the interpolators can be specified through either

• A literal sequence of values:

interp = Interpolator(x=[1, 2, 3, 4, 5], y=[2, 5, 10, 12, 16])

• or a pair of columns defined in a ColumnDataSource object:

interp = Interpolator(x="year", y="earnings", data=jewlery_prices))

This is the base class and is not intended to end use. Please see the documentation for the final derived classes (Jitter, LineraInterpolator, StepInterpolator) for more information on their specific methods of interpolation.

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

{
  "clip": true,
  "data": null,
  "id": "p126370",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "name": null,
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": []
}

Public Data Attributes:

x	Independent coordinate denoting the location of a point.
y	Dependant coordinate denoting the value of a point at a location.
data	Data which defines the source for the named columns if a string is passed to either the x or y parameters.
clip	Determine if the interpolation should clip the result to include only values inside its predefined range.

Inherited from Model

id
ref
name	An arbitrary, user-supplied name for this model.
tags	An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks	A mapping of event names to lists of CustomJS callbacks.
js_property_callbacks	A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
subscribed_events	Collection of events that are subscribed to by Python callbacks.
syncable	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

document

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

Public Methods:

__init__(*[, data, name, syncable, tags, x, y])

Inherited from Transform

__init__(*[, syncable, tags])

Inherited from Model

__init_subclass__()	This method is called when a class is subclassed.
__new__(cls, *args[, id])
__init__(*args, **kwargs)
__str__()	Return str(self).
__str__()	Return str(self).
destroy()	Clean up references to the document and property
parameters()	Generate Python Parameter values suitable for functions that are derived from the glyph.
js_on_event(event, *callbacks)
js_link(attr, other, other_attr[, attr_selector])	Link two Bokeh model properties using JavaScript.
js_on_change(event, *callbacks)	Attach a CustomJS callback to an arbitrary BokehJS model event.
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
references()	Returns all Models that this object has references to.
select(selector)	Query this object and all of its references for objects that match the given selector.
select_one(selector)	Query this object and all of its references for objects that match the given selector.
set_select(selector, updates)	Update objects that match a given selector with the specified attribute/value updates.
to_serializable(serializer)	Converts this object to a serializable representation.
trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()	This method is called when a class is subclassed.
__init__(**properties)
__setattr__(name, value)	Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__(name)	Intercept attribute setting on HasProps in order to special case a few situations:
__str__()	Return str(self).
__str__()	Return str(self).
equals(other)	Structural equality of models.
to_serializable(serializer)	Converts this object to a serializable representation.
set_from_json(name, value, *[, setter])	Set a property value on this object from JSON.
update(**kwargs)	Updates the object's properties from the given keyword arguments.
lookup(name, *[, raises])	Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
properties(*[, _with_props])	Collect the names of properties on this class.
descriptors()	List of property descriptors in the order of definition.
properties_with_refs()	Collect the names of all properties on this class that also have references.
dataspecs()	Collect the names of all DataSpec properties on this class.
properties_with_values(*[, ...])	Collect a dict mapping property names to their values.
query_properties_with_values(query, *[, ...])	Query the properties values of HasProps instances with a predicate.
themed_values()	Get any theme-provided overrides.
apply_theme(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
unapply_theme()	Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
remove_on_change(attr, *callbacks)	Remove a callback from this object
trigger(attr, old, new[, hint, setter])	Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

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

---

clip = True

Type:

Bool

Determine if the interpolation should clip the result to include only values inside its predefined range. If this is set to False, it will return the most value of the closest point.

data = None

Type:

Nullable(Instance(ColumnarDataSource))

Data which defines the source for the named columns if a string is passed to either the x or y parameters.

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.

x = Undefined

Type:

Required(Either(String, Seq(Float)))

Independent coordinate denoting the location of a point.

y = Undefined

Type:

Required(Either(String, Seq(Float)))

Dependant coordinate denoting the value of a point at a location.

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

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

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

Parameters:

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

Returns:

None

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

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

Returns:

names of DataSpec properties

Return type:

set[str]

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

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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:

PropertyDescriptor

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

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

Parameters:

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

• *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | Type[Event], *callbacks: EventCallback) → None

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]

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

Returns:

list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:

property names

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

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

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

Returns:

names of properties that have references

Return type:

set[str]

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

Collect a dict mapping property names to their values.

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

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

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

Returns:

mapping from property names to their values

Return type:

dict

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

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

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

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

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

Set a property value on this object from JSON.

Parameters:

• name – (str) : name of the attribute to set

• json – (JSON-value) : value to set to the attribute to

• models (dict or None, optional) –

  Mapping of model ids to models (default: None)

  This is needed in cases where the attributes to update also have values that have references.

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

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

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

Parameters:

• selector (JSON-like) –

• updates (dict) –

Returns:

None

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

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

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

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

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

class Jitter(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Transform

Apply either a uniform or normally sampled random jitter to data.

JSON Prototype

{
  "distribution": "uniform",
  "id": "p126378",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "mean": 0,
  "name": null,
  "range": null,
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": [],
  "width": 1
}

Public Data Attributes:

mean	The central value for the random sample
width	The width (absolute for uniform distribution and sigma for the normal distribution) of the random sample.
distribution	The random distribution upon which to pull the random scatter
range	When applying Jitter to Categorical data values, the corresponding FactorRange must be supplied as the range property.

Inherited from Model

id
ref
name	An arbitrary, user-supplied name for this model.
tags	An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks	A mapping of event names to lists of CustomJS callbacks.
js_property_callbacks	A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
subscribed_events	Collection of events that are subscribed to by Python callbacks.
syncable	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

document

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

Public Methods:

__init__(*[, mean, name, range, syncable, ...])

Inherited from Transform

__init__(*[, syncable, tags])

Inherited from Model

__init_subclass__()	This method is called when a class is subclassed.
__new__(cls, *args[, id])
__init__(*args, **kwargs)
__str__()	Return str(self).
__str__()	Return str(self).
destroy()	Clean up references to the document and property
parameters()	Generate Python Parameter values suitable for functions that are derived from the glyph.
js_on_event(event, *callbacks)
js_link(attr, other, other_attr[, attr_selector])	Link two Bokeh model properties using JavaScript.
js_on_change(event, *callbacks)	Attach a CustomJS callback to an arbitrary BokehJS model event.
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
references()	Returns all Models that this object has references to.
select(selector)	Query this object and all of its references for objects that match the given selector.
select_one(selector)	Query this object and all of its references for objects that match the given selector.
set_select(selector, updates)	Update objects that match a given selector with the specified attribute/value updates.
to_serializable(serializer)	Converts this object to a serializable representation.
trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()	This method is called when a class is subclassed.
__init__(**properties)
__setattr__(name, value)	Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__(name)	Intercept attribute setting on HasProps in order to special case a few situations:
__str__()	Return str(self).
__str__()	Return str(self).
equals(other)	Structural equality of models.
to_serializable(serializer)	Converts this object to a serializable representation.
set_from_json(name, value, *[, setter])	Set a property value on this object from JSON.
update(**kwargs)	Updates the object's properties from the given keyword arguments.
lookup(name, *[, raises])	Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
properties(*[, _with_props])	Collect the names of properties on this class.
descriptors()	List of property descriptors in the order of definition.
properties_with_refs()	Collect the names of all properties on this class that also have references.
dataspecs()	Collect the names of all DataSpec properties on this class.
properties_with_values(*[, ...])	Collect a dict mapping property names to their values.
query_properties_with_values(query, *[, ...])	Query the properties values of HasProps instances with a predicate.
themed_values()	Get any theme-provided overrides.
apply_theme(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
unapply_theme()	Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
remove_on_change(attr, *callbacks)	Remove a callback from this object
trigger(attr, old, new[, hint, setter])	Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

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

---

distribution = 'uniform'

Type:

Enum(JitterRandomDistribution)

The random distribution upon which to pull the random scatter

mean = 0

Type:

Float

The central value for the random sample

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.

range = None

Type:

Nullable(Instance(Range))

When applying Jitter to Categorical data values, the corresponding FactorRange must be supplied as the range property.

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.

width = 1

Type:

Float

The width (absolute for uniform distribution and sigma for the normal distribution) of the random sample.

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

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

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

Parameters:

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

Returns:

None

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

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

Returns:

names of DataSpec properties

Return type:

set[str]

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

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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:

PropertyDescriptor

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

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

Parameters:

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

• *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | Type[Event], *callbacks: EventCallback) → None

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]

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

Returns:

list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:

property names

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

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

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

Returns:

names of properties that have references

Return type:

set[str]

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

Collect a dict mapping property names to their values.

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

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

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

Returns:

mapping from property names to their values

Return type:

dict

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

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

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

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

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

Set a property value on this object from JSON.

Parameters:

• name – (str) : name of the attribute to set

• json – (JSON-value) : value to set to the attribute to

• models (dict or None, optional) –

  Mapping of model ids to models (default: None)

  This is needed in cases where the attributes to update also have values that have references.

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

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

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

Parameters:

• selector (JSON-like) –

• updates (dict) –

Returns:

None

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

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

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

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

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

class LinearInterpolator(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Interpolator

Compute a linear interpolation between the control points provided through the x, y, and data parameters.

JSON Prototype

{
  "clip": true,
  "data": null,
  "id": "p126386",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "name": null,
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Interpolator

x	Independent coordinate denoting the location of a point.
y	Dependant coordinate denoting the value of a point at a location.
data	Data which defines the source for the named columns if a string is passed to either the x or y parameters.
clip	Determine if the interpolation should clip the result to include only values inside its predefined range.

Inherited from Model

id
ref
name	An arbitrary, user-supplied name for this model.
tags	An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks	A mapping of event names to lists of CustomJS callbacks.
js_property_callbacks	A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
subscribed_events	Collection of events that are subscribed to by Python callbacks.
syncable	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

document

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

Public Methods:

__init__(*[, data, name, syncable, tags, x, y])

Inherited from Interpolator

__init__(*[, data, name, syncable, tags, x, y])

Inherited from Transform

__init__(*[, syncable, tags])

Inherited from Model

__init_subclass__()	This method is called when a class is subclassed.
__new__(cls, *args[, id])
__init__(*args, **kwargs)
__str__()	Return str(self).
__str__()	Return str(self).
destroy()	Clean up references to the document and property
parameters()	Generate Python Parameter values suitable for functions that are derived from the glyph.
js_on_event(event, *callbacks)
js_link(attr, other, other_attr[, attr_selector])	Link two Bokeh model properties using JavaScript.
js_on_change(event, *callbacks)	Attach a CustomJS callback to an arbitrary BokehJS model event.
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
references()	Returns all Models that this object has references to.
select(selector)	Query this object and all of its references for objects that match the given selector.
select_one(selector)	Query this object and all of its references for objects that match the given selector.
set_select(selector, updates)	Update objects that match a given selector with the specified attribute/value updates.
to_serializable(serializer)	Converts this object to a serializable representation.
trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()	This method is called when a class is subclassed.
__init__(**properties)
__setattr__(name, value)	Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__(name)	Intercept attribute setting on HasProps in order to special case a few situations:
__str__()	Return str(self).
__str__()	Return str(self).
equals(other)	Structural equality of models.
to_serializable(serializer)	Converts this object to a serializable representation.
set_from_json(name, value, *[, setter])	Set a property value on this object from JSON.
update(**kwargs)	Updates the object's properties from the given keyword arguments.
lookup(name, *[, raises])	Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
properties(*[, _with_props])	Collect the names of properties on this class.
descriptors()	List of property descriptors in the order of definition.
properties_with_refs()	Collect the names of all properties on this class that also have references.
dataspecs()	Collect the names of all DataSpec properties on this class.
properties_with_values(*[, ...])	Collect a dict mapping property names to their values.
query_properties_with_values(query, *[, ...])	Query the properties values of HasProps instances with a predicate.
themed_values()	Get any theme-provided overrides.
apply_theme(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
unapply_theme()	Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
remove_on_change(attr, *callbacks)	Remove a callback from this object
trigger(attr, old, new[, hint, setter])	Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

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

---

clip = True

Type:

Bool

Determine if the interpolation should clip the result to include only values inside its predefined range. If this is set to False, it will return the most value of the closest point.

data = None

Type:

Nullable(Instance(ColumnarDataSource))

Data which defines the source for the named columns if a string is passed to either the x or y parameters.

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.

x = Undefined

Type:

Required(Either(String, Seq(Float)))

Independent coordinate denoting the location of a point.

y = Undefined

Type:

Required(Either(String, Seq(Float)))

Dependant coordinate denoting the value of a point at a location.

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

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

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

Parameters:

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

Returns:

None

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

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

Returns:

names of DataSpec properties

Return type:

set[str]

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

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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:

PropertyDescriptor

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

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

Parameters:

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

• *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | Type[Event], *callbacks: EventCallback) → None

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]

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

Returns:

list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:

property names

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

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

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

Returns:

names of properties that have references

Return type:

set[str]

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

Collect a dict mapping property names to their values.

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

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

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

Returns:

mapping from property names to their values

Return type:

dict

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

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

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

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

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

Set a property value on this object from JSON.

Parameters:

• name – (str) : name of the attribute to set

• json – (JSON-value) : value to set to the attribute to

• models (dict or None, optional) –

  Mapping of model ids to models (default: None)

  This is needed in cases where the attributes to update also have values that have references.

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

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

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

Parameters:

• selector (JSON-like) –

• updates (dict) –

Returns:

None

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

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

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

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

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

class StepInterpolator(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Interpolator

Compute a step-wise interpolation between the points provided through the x, y, and data parameters.

JSON Prototype

{
  "clip": true,
  "data": null,
  "id": "p126394",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "mode": "after",
  "name": null,
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": []
}

Public Data Attributes:

mode	Adjust the behavior of the returned value in relation to the control points.

Inherited from Interpolator

x	Independent coordinate denoting the location of a point.
y	Dependant coordinate denoting the value of a point at a location.
data	Data which defines the source for the named columns if a string is passed to either the x or y parameters.
clip	Determine if the interpolation should clip the result to include only values inside its predefined range.

Inherited from Model

id
ref
name	An arbitrary, user-supplied name for this model.
tags	An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks	A mapping of event names to lists of CustomJS callbacks.
js_property_callbacks	A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
subscribed_events	Collection of events that are subscribed to by Python callbacks.
syncable	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

document

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

Public Methods:

__init__(*[, data, mode, name, syncable, ...])

Inherited from Interpolator

__init__(*[, data, name, syncable, tags, x, y])

Inherited from Transform

__init__(*[, syncable, tags])

Inherited from Model

__init_subclass__()	This method is called when a class is subclassed.
__new__(cls, *args[, id])
__init__(*args, **kwargs)
__str__()	Return str(self).
__str__()	Return str(self).
destroy()	Clean up references to the document and property
parameters()	Generate Python Parameter values suitable for functions that are derived from the glyph.
js_on_event(event, *callbacks)
js_link(attr, other, other_attr[, attr_selector])	Link two Bokeh model properties using JavaScript.
js_on_change(event, *callbacks)	Attach a CustomJS callback to an arbitrary BokehJS model event.
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
references()	Returns all Models that this object has references to.
select(selector)	Query this object and all of its references for objects that match the given selector.
select_one(selector)	Query this object and all of its references for objects that match the given selector.
set_select(selector, updates)	Update objects that match a given selector with the specified attribute/value updates.
to_serializable(serializer)	Converts this object to a serializable representation.
trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()	This method is called when a class is subclassed.
__init__(**properties)
__setattr__(name, value)	Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__(name)	Intercept attribute setting on HasProps in order to special case a few situations:
__str__()	Return str(self).
__str__()	Return str(self).
equals(other)	Structural equality of models.
to_serializable(serializer)	Converts this object to a serializable representation.
set_from_json(name, value, *[, setter])	Set a property value on this object from JSON.
update(**kwargs)	Updates the object's properties from the given keyword arguments.
lookup(name, *[, raises])	Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
properties(*[, _with_props])	Collect the names of properties on this class.
descriptors()	List of property descriptors in the order of definition.
properties_with_refs()	Collect the names of all properties on this class that also have references.
dataspecs()	Collect the names of all DataSpec properties on this class.
properties_with_values(*[, ...])	Collect a dict mapping property names to their values.
query_properties_with_values(query, *[, ...])	Query the properties values of HasProps instances with a predicate.
themed_values()	Get any theme-provided overrides.
apply_theme(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
unapply_theme()	Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
remove_on_change(attr, *callbacks)	Remove a callback from this object
trigger(attr, old, new[, hint, setter])	Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

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

---

clip = True

Type:

Bool

Determine if the interpolation should clip the result to include only values inside its predefined range. If this is set to False, it will return the most value of the closest point.

data = None

Type:

Nullable(Instance(ColumnarDataSource))

Data which defines the source for the named columns if a string is passed to either the x or y parameters.

mode = 'after'

Type:

Enum(StepMode)

Adjust the behavior of the returned value in relation to the control points. The parameter can assume one of three values:

• after (default): Assume the y-value associated with the nearest x-value which is less than or equal to the point to transform.

• before: Assume the y-value associated with the nearest x-value which is greater than the point to transform.

• center: Assume the y-value associated with the nearest x-value to the point to transform.

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.

x = Undefined

Type:

Required(Either(String, Seq(Float)))

Independent coordinate denoting the location of a point.

y = Undefined

Type:

Required(Either(String, Seq(Float)))

Dependant coordinate denoting the value of a point at a location.

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

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

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

Parameters:

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

Returns:

None

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

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

Returns:

names of DataSpec properties

Return type:

set[str]

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

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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:

PropertyDescriptor

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

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

Parameters:

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

• *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | Type[Event], *callbacks: EventCallback) → None

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]

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

Returns:

list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:

property names

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

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

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

Returns:

names of properties that have references

Return type:

set[str]

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

Collect a dict mapping property names to their values.

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

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

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

Returns:

mapping from property names to their values

Return type:

dict

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

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

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

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

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

Set a property value on this object from JSON.

Parameters:

• name – (str) : name of the attribute to set

• json – (JSON-value) : value to set to the attribute to

• models (dict or None, optional) –

  Mapping of model ids to models (default: None)

  This is needed in cases where the attributes to update also have values that have references.

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

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

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

Parameters:

• selector (JSON-like) –

• updates (dict) –

Returns:

None

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

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

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

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

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

class Transform(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Model

Base class for Transform models that represent a computation to be carried out on the client-side.

JavaScript implementations should implement the following methods:

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

{
  "id": "p126403",
  "js_event_callbacks": {
    "type": "map"
  },
  "js_property_callbacks": {
    "type": "map"
  },
  "name": null,
  "subscribed_events": {
    "type": "set"
  },
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from Model

id
ref
name	An arbitrary, user-supplied name for this model.
tags	An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks	A mapping of event names to lists of CustomJS callbacks.
js_property_callbacks	A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
subscribed_events	Collection of events that are subscribed to by Python callbacks.
syncable	Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from HasDocumentRef

document

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

Public Methods:

__init__(*[, syncable, tags])

Inherited from Model

__init_subclass__()	This method is called when a class is subclassed.
__new__(cls, *args[, id])
__init__(*args, **kwargs)
__str__()	Return str(self).
__str__()	Return str(self).
destroy()	Clean up references to the document and property
parameters()	Generate Python Parameter values suitable for functions that are derived from the glyph.
js_on_event(event, *callbacks)
js_link(attr, other, other_attr[, attr_selector])	Link two Bokeh model properties using JavaScript.
js_on_change(event, *callbacks)	Attach a CustomJS callback to an arbitrary BokehJS model event.
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
references()	Returns all Models that this object has references to.
select(selector)	Query this object and all of its references for objects that match the given selector.
select_one(selector)	Query this object and all of its references for objects that match the given selector.
set_select(selector, updates)	Update objects that match a given selector with the specified attribute/value updates.
to_serializable(serializer)	Converts this object to a serializable representation.
trigger(attr, old, new[, hint, setter])

Inherited from HasProps

__init_subclass__()	This method is called when a class is subclassed.
__init__(**properties)
__setattr__(name, value)	Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__(name)	Intercept attribute setting on HasProps in order to special case a few situations:
__str__()	Return str(self).
__str__()	Return str(self).
equals(other)	Structural equality of models.
to_serializable(serializer)	Converts this object to a serializable representation.
set_from_json(name, value, *[, setter])	Set a property value on this object from JSON.
update(**kwargs)	Updates the object's properties from the given keyword arguments.
lookup(name, *[, raises])	Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
properties(*[, _with_props])	Collect the names of properties on this class.
descriptors()	List of property descriptors in the order of definition.
properties_with_refs()	Collect the names of all properties on this class that also have references.
dataspecs()	Collect the names of all DataSpec properties on this class.
properties_with_values(*[, ...])	Collect a dict mapping property names to their values.
query_properties_with_values(query, *[, ...])	Query the properties values of HasProps instances with a predicate.
themed_values()	Get any theme-provided overrides.
apply_theme(property_values)	Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
unapply_theme()	Remove any themed values and restore defaults.

Inherited from Serializable

to_serializable(serializer)

Converts this object to a serializable representation.

Inherited from HasDocumentRef

__init__(*args, **kw)

Inherited from PropertyCallbackManager

__init__(*args, **kw)
on_change(attr, *callbacks)	Add a callback on this object to trigger when attr changes.
remove_on_change(attr, *callbacks)	Remove a callback from this object
trigger(attr, old, new[, hint, setter])	Trigger callbacks for attr on this object.

Inherited from EventCallbackManager

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

---

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]

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

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

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:

PropertyDescriptor

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

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

Parameters:

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

• *callbacks (callable) – callback functions to register

Returns:

None

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | Type[Event], *callbacks: EventCallback) → None

Run callbacks when the specified event occurs on this Model

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

classmethod parameters() → list[Parameter]

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

Returns:

list(Parameter)

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

Collect the names of properties on this class.

Warning

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

Returns:

property names

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

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

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

Returns:

names of properties that have references

Return type:

set[str]

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

Collect a dict mapping property names to their values.

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

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

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

Returns:

mapping from property names to their values

Return type:

dict

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

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

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

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (JSON-like) –

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

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

Set a property value on this object from JSON.

Parameters:

• name – (str) : name of the attribute to set

• json – (JSON-value) : value to set to the attribute to

• models (dict or None, optional) –

  Mapping of model ids to models (default: None)

  This is needed in cases where the attributes to update also have values that have references.

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

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

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

Parameters:

• selector (JSON-like) –

• updates (dict) –

Returns:

None

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

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

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

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

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

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

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