renderers#
Various kinds of renderers.
- class ContourRenderer(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
DataRenderer
Renderer for contour plots composed of filled polygons and/or lines.
Rather than create these manually it is usually better to use
contour()
instead.JSON Prototype
{ "coordinates": null, "group": null, "id": "p124963", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "glyph", "levels": [], "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
line_renderer
Glyph renderer used for contour lines.
fill_renderer
Glyph renderer used for filled contour polygons.
levels
Levels at which the contours are calculated.
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
DataRenderer
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Renderer
level
Specifies the level in which to paint this renderer.
visible
Is the renderer visible.
coordinates
x_range_name
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
y_range_name
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, fill_renderer, group, level, ...])set_data
(data)Set the contour line and filled polygon data to render.
construct_color_bar
(**kwargs)Construct and return a new
ContourColorBar
for thisContourRenderer
.Inherited from
DataRenderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Renderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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
- fill_renderer = Undefined#
- Type:
Glyph renderer used for filled contour polygons.
- level = 'glyph'#
- Type:
Specifies the level in which to paint this renderer.
- line_renderer = Undefined#
- Type:
Glyph renderer used for contour lines.
- name = None#
-
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:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
- 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
- construct_color_bar(**kwargs) ContourColorBar [source]#
Construct and return a new
ContourColorBar
for thisContourRenderer
.The color bar will use the same fill, hatch and line visual properties as the ContourRenderer. Extra keyword arguments may be passed in to control
BaseColorBar
properties such as title.
- 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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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_data(data: ContourData) None [source]#
Set the contour line and filled polygon data to render.
Accepts a
ContourData
object, such as is returned fromcontour_data()
.
- 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 #
- 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)
- class DataRenderer(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Renderer
An abstract base class for data renderer types (e.g.
GlyphRenderer
,GraphRenderer
).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
{ "coordinates": null, "group": null, "id": "p124974", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "glyph", "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Renderer
level
Specifies the level in which to paint this renderer.
visible
Is the renderer visible.
coordinates
x_range_name
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
y_range_name
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, group, level, name, syncable, ...])Inherited from
Renderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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
- level = 'glyph'#
- Type:
Specifies the level in which to paint this renderer.
- name = None#
-
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:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
- 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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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 #
- 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)
- class GlyphRenderer(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
DataRenderer
JSON Prototype
{ "coordinates": null, "group": null, "hover_glyph": null, "id": "p124982", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "glyph", "muted": false, "muted_glyph": "auto", "name": null, "nonselection_glyph": "auto", "selection_glyph": "auto", "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "view": { "attributes": { "filter": { "id": "p124984", "name": "AllIndices", "type": "object" } }, "id": "p124983", "name": "CDSView", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
data_source
Local data source to use when rendering glyphs on the plot.
view
A view into the data source to use when rendering glyphs.
glyph
The glyph to render, in conjunction with the supplied data source and ranges.
selection_glyph
"
nonselection_glyph
"
hover_glyph
An optional glyph used for inspected points, e.g., those that are being hovered over by a
HoverTool
.muted_glyph
"
muted
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
DataRenderer
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Renderer
level
Specifies the level in which to paint this renderer.
visible
Is the renderer visible.
coordinates
x_range_name
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
y_range_name
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, data_source, glyph, group, ...])add_decoration
(marking, node)Inherited from
DataRenderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Renderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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
- data_source = Undefined#
- Type:
Local data source to use when rendering glyphs on the plot.
- glyph = Undefined#
-
The glyph to render, in conjunction with the supplied data source and ranges.
- hover_glyph = None#
-
An optional glyph used for inspected points, e.g., those that are being hovered over by a
HoverTool
.
- level = 'glyph'#
- Type:
Specifies the level in which to paint this renderer.
- name = None#
-
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.
- nonselection_glyph = 'auto'#
-
- “
An optional glyph used for explicitly non-selected points (i.e., non-selected when there are other points that are selected, but not when no points at all are selected.)
If set to “auto” then a glyph with a low alpha value (0.1) will be used for non-selected points.
- selection_glyph = 'auto'#
-
- “
An optional glyph used for selected points.
If set to “auto” then the standard glyph will be used for selected points.
- syncable = True#
- Type:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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.
- view = CDSView(id='p125024', ...)#
-
A view into the data source to use when rendering glyphs. A default view of the entire data source is created when a view is not passed in during initialization.
- x_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
- 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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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 #
- 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)
- class GraphRenderer(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
DataRenderer
JSON Prototype
{ "coordinates": null, "edge_renderer": { "attributes": { "data_source": { "attributes": { "data": { "entries": [ [ "start", [] ], [ "end", [] ] ], "type": "map" }, "selected": { "attributes": { "indices": [], "line_indices": [] }, "id": "p125046", "name": "Selection", "type": "object" }, "selection_policy": { "id": "p125047", "name": "UnionRenderers", "type": "object" } }, "id": "p125045", "name": "ColumnDataSource", "type": "object" }, "glyph": { "id": "p125044", "name": "MultiLine", "type": "object" }, "view": { "attributes": { "filter": { "id": "p125050", "name": "AllIndices", "type": "object" } }, "id": "p125049", "name": "CDSView", "type": "object" } }, "id": "p125048", "name": "GlyphRenderer", "type": "object" }, "group": null, "id": "p125035", "inspection_policy": { "id": "p125036", "name": "NodesOnly", "type": "object" }, "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "glyph", "name": null, "node_renderer": { "attributes": { "data_source": { "attributes": { "data": { "entries": [ [ "index", [] ] ], "type": "map" }, "selected": { "attributes": { "indices": [], "line_indices": [] }, "id": "p125039", "name": "Selection", "type": "object" }, "selection_policy": { "id": "p125040", "name": "UnionRenderers", "type": "object" } }, "id": "p125038", "name": "ColumnDataSource", "type": "object" }, "glyph": { "id": "p125037", "name": "Circle", "type": "object" }, "view": { "attributes": { "filter": { "id": "p125043", "name": "AllIndices", "type": "object" } }, "id": "p125042", "name": "CDSView", "type": "object" } }, "id": "p125041", "name": "GlyphRenderer", "type": "object" }, "selection_policy": { "id": "p125051", "name": "NodesOnly", "type": "object" }, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
layout_provider
An instance of a
LayoutProvider
that supplies the layout of the network graph in cartesian space.node_renderer
Instance of a
GlyphRenderer
containing anXYGlyph
that will be rendered as the graph nodes.edge_renderer
Instance of a
GlyphRenderer
containing anMultiLine
Glyph that will be rendered as the graph edges.selection_policy
An instance of a
GraphHitTestPolicy
that provides the logic for selection of graph components.inspection_policy
An instance of a
GraphHitTestPolicy
that provides the logic for inspection of graph components.name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
DataRenderer
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Renderer
level
Specifies the level in which to paint this renderer.
visible
Is the renderer visible.
coordinates
x_range_name
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
y_range_name
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, edge_renderer, group, ...])Inherited from
DataRenderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Renderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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
- edge_renderer = GlyphRenderer(id='p125099', ...)#
- Type:
Instance of a
GlyphRenderer
containing anMultiLine
Glyph that will be rendered as the graph edges.
- inspection_policy = NodesOnly(id='p125119', ...)#
- Type:
An instance of a
GraphHitTestPolicy
that provides the logic for inspection of graph components.
- layout_provider = Undefined#
- Type:
An instance of a
LayoutProvider
that supplies the layout of the network graph in cartesian space.
- level = 'glyph'#
- Type:
Specifies the level in which to paint this renderer.
- name = None#
-
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.
- node_renderer = GlyphRenderer(id='p125192', ...)#
- Type:
Instance of a
GlyphRenderer
containing anXYGlyph
that will be rendered as the graph nodes.
- selection_policy = NodesOnly(id='p125212', ...)#
- Type:
An instance of a
GraphHitTestPolicy
that provides the logic for selection of graph components.
- syncable = True#
- Type:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
- 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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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 #
- 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)
- class GuideRenderer(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Renderer
A base class for all guide renderer types.
GuideRenderer
is not generally useful to instantiate on its own.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
{ "coordinates": null, "group": null, "id": "p125298", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "guide", "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Renderer
level
Specifies the level in which to paint this renderer.
visible
Is the renderer visible.
coordinates
x_range_name
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
y_range_name
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, group, level, name, syncable, ...])Inherited from
Renderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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
- level = 'guide'#
- Type:
Specifies the level in which to paint this renderer.
- name = None#
-
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:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
- 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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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 #
- 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)
- class Renderer(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Model
An abstract base class for renderer types.
Note
This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.
JSON Prototype
{ "coordinates": null, "group": null, "id": "p125306", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "image", "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
level
Specifies the level in which to paint this renderer.
visible
Is the renderer visible.
coordinates
x_range_name
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
y_range_name
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, group, level, name, syncable, ...])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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
- level = 'image'#
- Type:
Specifies the level in which to paint this renderer.
- name = None#
-
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:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
- 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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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 #
- 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)
- class RendererGroup(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Model
A collection of renderers.
JSON Prototype
{ "id": "p125314", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "visible": true }
Public Data Attributes:
visible
Makes all groupped renderers visible or not.
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, syncable, tags, visible])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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#
-
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:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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 #
- 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)
- class TileRenderer(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Renderer
JSON Prototype
{ "alpha": 1.0, "coordinates": null, "group": null, "id": "p125319", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "level": "image", "name": null, "render_parents": true, "smoothing": true, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "tile_source": { "id": "p125320", "name": "WMTSTileSource", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
Public Data Attributes:
tile_source
Local data source to use when rendering glyphs on the plot.
alpha
tile opacity 0.0 - 1.0
smoothing
Enable image smoothing for the rendered tiles.
render_parents
Flag enable/disable drawing of parent tiles while waiting for new tiles to arrive.
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Renderer
level
Specifies the level in which to paint this renderer.
visible
Is the renderer visible.
coordinates
x_range_name
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.
y_range_name
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.
group
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)id
subscribed_events
Collection of events that are subscribed to by Python callbacks.
Inherited from
Model
id
ref
name
An arbitrary, user-supplied name for this model.
tags
An optional list of arbitrary, user-supplied values to attach to this model.
js_event_callbacks
A mapping of event names to lists of
CustomJS
callbacks.js_property_callbacks
A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.subscribed_events
Collection of events that are subscribed to by Python callbacks.
syncable
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.
document
The
Document
this model is attached to (can beNone
)Inherited from
HasDocumentRef
document
The
Document
this model is attached to (can beNone
)Inherited from
PropertyCallbackManager
document
Inherited from
EventCallbackManager
document
id
subscribed_events
Public Methods:
__init__
(*[, coordinates, group, level, ...])Inherited from
Renderer
__init__
(*[, group, level, name, syncable, ...])Inherited from
Model
__init_subclass__
()This method is called when a class is subclassed.
__new__
(cls, *args[, id])__init__
(*args, **kwargs)__str__
()Return str(self).
__repr__
()Return repr(self).
destroy
()Clean up references to the document and property
parameters
()Generate Python
Parameter
values suitable for functions that are derived from the glyph.js_on_event
(event, *callbacks)js_link
(attr, other, other_attr[, attr_selector])Link two Bokeh model properties using JavaScript.
js_on_change
(event, *callbacks)Attach a
CustomJS
callback to an arbitrary BokehJS model event.on_change
(attr, *callbacks)Add a callback on this object to trigger when
attr
changes.references
()Returns all
Models
that this object has references to.select
(selector)Query this object and all of its references for objects that match the given selector.
select_one
(selector)Query this object and all of its references for objects that match the given selector.
set_select
(selector, updates)Update objects that match a given selector with the specified attribute/value updates.
to_serializable
(serializer)Converts this object to a serializable representation.
trigger
(attr, old, new[, hint, setter])Inherited from
HasProps
__init_subclass__
()This method is called when a class is subclassed.
__init__
(**properties)__setattr__
(name, value)Intercept attribute setting on HasProps in order to special case a few situations:
__getattr__
(name)Intercept attribute setting on HasProps in order to special case a few situations:
__str__
()Return str(self).
__repr__
()Return repr(self).
equals
(other)Structural equality of models.
to_serializable
(serializer)Converts this object to a serializable representation.
set_from_json
(name, value, *[, setter])Set a property value on this object from JSON.
update
(**kwargs)Updates the object's properties from the given keyword arguments.
lookup
()Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.Collect the names of properties on this class.
List of property descriptors in the order of definition.
Collect the names of all properties on this class that also have references.
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.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.
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
- level = 'image'#
- Type:
Specifies the level in which to paint this renderer.
- name = None#
-
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.
- render_parents = True#
- Type:
Flag enable/disable drawing of parent tiles while waiting for new tiles to arrive. Default value is True.
- syncable = True#
- Type:
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 anyon_change()
callbacks on this object from triggering. However, any JS-side callbacks will still work.
- tags = []#
- Type:
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.
- tile_source = WMTSTileSource(id='p125338', ...)#
- Type:
Local data source to use when rendering glyphs on the plot.
- x_range_name = 'default'#
- Type:
A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.
- y_range_name = 'default'#
- Type:
A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.
- 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.
- classmethod descriptors() list[PropertyDescriptor[Any]] #
List of property descriptors in the order of definition.
- 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:
Added in version 1.1
- Raises:
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:
- Returns:
descriptor for property named
name
- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None #
Add a callback on this object to trigger when
attr
changes.- Parameters:
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
- Returns:
None
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: EventCallback) None #
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
- classmethod 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.
- 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.
- 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:
- 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 #
- 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)