Models (mostly base classes) for the various kinds of renderer types that Bokeh supports.
DataRenderer
Bases: bokeh.models.renderers.Renderer
bokeh.models.renderers.Renderer
An abstract base class for data renderer types (e.g. GlyphRenderer, TileRenderer, GraphRenderer).
GlyphRenderer
TileRenderer
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.
js_event_callbacks
property type: Dict ( String , List ( Instance ( CustomJS ) ) )
Dict
String
List
Instance
CustomJS
A mapping of event names to lists of CustomJS callbacks.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:
Model.js_on_event
callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
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.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:
Model.js_on_change
callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
level
property type: Enum ( RenderLevel )
Enum
RenderLevel
Specifies the level in which to paint this renderer.
name
property type: String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
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.
subscribed_events
property type: List ( String )
List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
tags
property type: List ( Any )
Any
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.
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
visible
property type: Bool
Bool
Is the renderer visible.
x_range_name
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
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
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).
HasProps
property_values (dict) – theme values to use in place of defaults
None
dataspecs
Collect the names of all DataSpec properties on this class.
DataSpec
This method always traverses the class hierarchy and includes properties defined on any parent classes.
names of DataSpec properties
set[str]
dataspecs_with_props
Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.
mapping of names and DataSpec properties
dict[str, DataSpec]
equals
Structural equality of models.
other (HasProps) – the other instance to compare to
True, if properties are structurally equal, otherwise False
js_link
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.
attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
other
attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr
attr
Added in version 1.1
ValueError –
Examples
This code with js_link:
select.js_link('value', plot, 'sizing_mode')
is equivalent to the following:
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
which is equivalent to:
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
js_on_change
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:
"change:property_name"
"change:"
# 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:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
PropertyDescriptor
name (str) – name of the property to search for
descriptor for property named name
on_change
Add a callback on this object to trigger when attr changes.
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
properties
Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
property names
properties_containers
Collect the names of all container properties on this class.
names of container properties
properties_with_refs
Collect the names of all properties on this class that also have references.
names of properties that have references
properties_with_values
Collect a dict mapping property names to their values.
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.
include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
mapping from property names to their values
dict
query_properties_with_values
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
references
Returns all Models that this object has references to.
Models
remove_on_change
Remove a callback from this object
select
Query this object and all of its references for objects that match the given selector.
selector (JSON-like) –
seq[Model]
select_one
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
Model
set_from_json
Set a property value on this object from JSON.
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.
set_select
Update objects that match a given selector with the specified attribute/value updates.
updates (dict) –
themed_values
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.
dict or None
to_json
Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json()
For most purposes it’s best to serialize and deserialize entire documents.
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
to_json_string
Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json_string()
trigger
unapply_theme
Remove any themed values and restore defaults.
update
Updates the object’s properties from the given keyword arguments.
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
update_from_json
Updates the object’s properties from a JSON attributes dictionary.
json_attributes – (JSON-dict) : attributes and values to update
document
The Document this model is attached to (can be None)
Document
struct
A Bokeh protocol “structure” of this model, i.e. a dict of the form:
{ 'type' : << view model name >> 'id' : << unique model id >> }
Additionally there may be a subtype field if this model is a subtype.
{ "id": "15483", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "glyph", "name": null, "subscribed_events": [], "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
Bases: bokeh.models.renderers.DataRenderer
bokeh.models.renderers.DataRenderer
data_source
property type: Instance ( DataSource )
DataSource
Local data source to use when rendering glyphs on the plot.
glyph
property type: Instance ( Glyph )
Glyph
The glyph to render, in conjunction with the supplied data source and ranges.
hover_glyph
An optional glyph used for inspected points, e.g., those that are being hovered over by a HoverTool.
HoverTool
muted
muted_glyph
nonselection_glyph
property type: Either ( Auto , Instance ( Glyph ) )
Either
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
An optional glyph used for selected points.
If set to “auto” then the standard glyph will be used for selected points.
view
property type: Instance ( CDSView )
CDSView
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.
{ "data_source": null, "glyph": null, "hover_glyph": null, "id": "15493", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "glyph", "muted": false, "muted_glyph": null, "name": null, "nonselection_glyph": "auto", "selection_glyph": "auto", "subscribed_events": [], "tags": [], "view": { "id": "15494" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
edge_renderer
property type: Instance ( GlyphRenderer )
Instance of a GlyphRenderer containing an MultiLine Glyph that will be rendered as the graph edges.
MultiLine
inspection_policy
property type: Instance ( GraphHitTestPolicy )
GraphHitTestPolicy
An instance of a GraphHitTestPolicy that provides the logic for inspection of graph components.
layout_provider
property type: Instance ( LayoutProvider )
LayoutProvider
An instance of a LayoutProvider that supplies the layout of the network graph in cartesian space.
node_renderer
Instance of a GlyphRenderer containing an XYGlyph that will be rendered as the graph nodes.
XYGlyph
selection_policy
An instance of a GraphHitTestPolicy that provides the logic for selection of graph components.
{ "edge_renderer": { "id": "15532" }, "id": "15529", "inspection_policy": { "id": "15539" }, "js_event_callbacks": {}, "js_property_callbacks": {}, "layout_provider": null, "level": "glyph", "name": null, "node_renderer": { "id": "15537" }, "selection_policy": { "id": "15534" }, "subscribed_events": [], "tags": [], "visible": true, "x_range_name": "default", "y_range_name": "default" }
GuideRenderer
A base class for all guide renderer types. GuideRenderer is not generally useful to instantiate on its own.
{ "id": "15554", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "overlay", "name": null, "subscribed_events": [], "tags": [], "visible": true }
Renderer
Bases: bokeh.model.Model
bokeh.model.Model
An abstract base class for renderer types.
{ "id": "15562", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "image", "name": null, "subscribed_events": [], "tags": [], "visible": true }
alpha
property type: Float
Float
tile opacity 0.0 - 1.0
render_parents
Flag enable/disable drawing of parent tiles while waiting for new tiles to arrive. Default value is True.
smoothing
Enable image smoothing for the rendered tiles.
tile_source
property type: Instance ( TileSource )
TileSource
{ "alpha": 1.0, "id": "15570", "js_event_callbacks": {}, "js_property_callbacks": {}, "level": "glyph", "name": null, "render_parents": true, "smoothing": true, "subscribed_events": [], "tags": [], "tile_source": { "id": "15571" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }