bokeh.models.sources¶
-
class
AjaxDataSource
(*args, **kw)[source]¶ Bases:
bokeh.models.sources.WebSource
A data source that can populate columns by making Ajax calls to REST endpoints.
The
AjaxDataSource
can be especially useful if you want to make a standalone document (i.e. not backed by the Bokeh server) that can still dynamically update using an existing REST API.The response from the REST API should match the
.data
property of a standardColumnDataSource
, i.e. a JSON dict that maps names to arrays of values:{ 'x' : [1, 2, 3, ...], 'y' : [9, 3, 2, ...] }
Alternatively, if the REST API returns a different format, a
CustomJS
callback can be provided to convert the REST response into Bokeh format, via theadapter
property of this data source.Initial data can be set by specifying the
data
property directly. This is necessary when used in conjunction with aFactorRange
, even if the columns in data` are empty.A full example can be seen at examples/howto/ajax_source.py
-
adapter
¶ property type:
Instance
(CustomJS
)A JavaScript callback to adapt raw JSON responses to Bokeh
ColumnDataSource
format.If provided, this callback is executes immediately after the JSON data is received, but before appending or replacing data in the data source. The
CustomJS
callback will receive theAjaxDataSource
ascb_obj
and will receive the raw JSON response ascb_data.response
. The callback code should return adata
object suitable for a BokehColumnDataSource
(i.e. a mapping of string column names to arrays of data).
-
data
¶ property type:
ColumnData
(String
,Seq
(Any
) )Mapping of column names to sequences of data. The columns can be, e.g, Python lists or tuples, NumPy arrays, etc.
The .data attribute can also be set from Pandas DataFrames or GroupBy objects. In these cases, the behaviour is identical to passing the objects to the
ColumnDataSource
initializer.
-
http_headers
¶ property type:
Dict
(String
,String
)Specify HTTP headers to set for the Ajax request.
Example:
ajax_source.headers = { 'x-my-custom-header': 'some value' }
-
if_modified
¶ property type:
Bool
Whether to include an
If-Modified-Since
header in Ajax requests to the server. If this header is supported by the server, then only new data since the last request will be returned.
-
js_event_callbacks
¶ property type:
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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
max_size
¶ property type:
Int
Maximum size of the data columns. If a new fetch would result in columns larger than
max_size
, then earlier data is dropped to make room.
-
method
¶ property type:
Enum
( Enumeration(POST, GET) )Specify the HTTP method to use for the Ajax request (GET or POST)
-
mode
¶ property type:
Enum
( Enumeration(replace, append) )Whether to append new data to existing data (up to
max_size
), or to replace existing data entirely.
-
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', ...)]
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.
-
selected
¶ property type:
Instance
(Selection
)An instance of a
Selection
that indicates selected indices on thisDataSource
. This is a read-only property. You may only change the attributes of this object to change the selection (e.g.,selected.indices
).
-
selection_policy
¶ property type:
Instance
(SelectionPolicy
)An instance of a
SelectionPolicy
that determines how selections are set.
-
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.
-
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.
-
__init__
(*args, **kw)¶ If called with a single argument that is a dict or
pandas.DataFrame
, treat that implicitly as the “data” attribute.
-
add
(data, name=None)¶ Appends a new column of data to the data source.
-
apply_theme
(property_values)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ Structural equality of models.
- Parameters
other (HasProps) – the other instance to compare to
- Returns
True, if properties are structurally equal, otherwise False
-
classmethod
from_df
(data)¶ Create a
dict
of columns from a PandasDataFrame
, suitable for creating aColumnDataSource
.- Parameters
data (DataFrame) – data to convert
- Returns
dict[str, np.array]
-
classmethod
from_groupby
(data)¶ Create a
dict
of columns from a PandasGroupBy
, suitable for creating aColumnDataSource
.The data generated is the result of running
describe
on the group.- Parameters
data (Groupby) – data to convert
- Returns
dict[str, np.array]
-
js_link
(attr, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
patch
(patches, setter=None)¶ Efficiently update data source columns at specific locations
If it is only necessary to update a small subset of data in a
ColumnDataSource
, this method can be used to efficiently update only the subset, instead of requiring the entire data set to be sent.This method should be passed a dictionary that maps column names to lists of tuples that describe a patch change to apply. To replace individual items in columns entirely, the tuples should be of the form:
(index, new_value) # replace a single column value # or (slice, new_values) # replace several column values
Values at an index or slice will be replaced with the corresponding new values.
In the case of columns whose values are other arrays or lists, (e.g. image or patches glyphs), it is also possible to patch “subregions”. In this case the first item of the tuple should be a whose first element is the index of the array item in the CDS patch, and whose subsequent elements are integer indices or slices into the array item:
# replace the entire 10th column of the 2nd array: +----------------- index of item in column data source | | +--------- row subindex into array item | | | | +- column subindex into array item V V V ([2, slice(None), 10], new_values)
Imagining a list of 2d NumPy arrays, the patch above is roughly equivalent to:
data = [arr1, arr2, ...] # list of 2d arrays data[2][:, 10] = new_data
There are some limitations to the kinds of slices and data that can be accepted.
Negative
start
,stop
, orstep
values for slices will result in aValueError
.In a slice,
start > stop
will result in aValueError
When patching 1d or 2d subitems, the subitems must be NumPy arrays.
New values must be supplied as a flattened one-dimensional array of the appropriate size.
Example:
The following example shows how to patch entire column elements. In this case,
source = ColumnDataSource(data=dict(foo=[10, 20, 30], bar=[100, 200, 300])) patches = { 'foo' : [ (slice(2), [11, 12]) ], 'bar' : [ (0, 101), (2, 301) ], } source.patch(patches)
After this operation, the value of the
source.data
will be:dict(foo=[11, 12, 30], bar=[101, 200, 301])
For a more comprehensive complete example, see examples/howto/patch_app.py.
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove
(name)¶ Remove a column of data.
- Parameters
name (str) – name of the column to remove
- Returns
None
Note
If the column name does not exist, a warning is issued.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
stream
(new_data, rollover=None)¶ Efficiently update data source columns with new append-only data.
In cases where it is necessary to update data columns in, this method can efficiently send only the new data, instead of requiring the entire data set to be re-sent.
- Parameters
a mapping of column names to sequences of new data to append to each column.
All columns of the data source must be present in
new_data
, with identical-length append data.rollover (int, optional) – A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded (default: None)
- Returns
None
- Raises
Example:
source = ColumnDataSource(data=dict(foo=[], bar=[])) # has new, identical-length updates for all columns in source new_data = { 'foo' : [10, 20], 'bar' : [100, 200], } source.stream(new_data)
-
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.- Returns
dict or None
-
to_df
()¶ Convert this data source to pandas
DataFrame
.- Returns
DataFrame
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
column_names
¶ A list of the column names in this data source.
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-
-
class
CDSView
(**kwargs)[source]¶ Bases:
bokeh.model.Model
A view into a
ColumnDataSource
that represents a row-wise subset.-
js_event_callbacks
¶ property type:
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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
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', ...)]
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.
-
source
¶ property type:
Instance
(ColumnarDataSource
)The
ColumnDataSource
associated with this view. Used to determine the length of the columns.
-
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.
-
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)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
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.- Returns
dict or None
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-
-
class
ColumnarDataSource
(**kwargs)[source]¶ Bases:
bokeh.models.sources.DataSource
A base class for data source types, which can be mapped onto a columnar format.
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
) ) )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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
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', ...)]
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.
-
selected
¶ property type:
Instance
(Selection
)An instance of a
Selection
that indicates selected indices on thisDataSource
. This is a read-only property. You may only change the attributes of this object to change the selection (e.g.,selected.indices
).
-
selection_policy
¶ property type:
Instance
(SelectionPolicy
)An instance of a
SelectionPolicy
that determines how selections are set.
-
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.
-
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)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
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.- Returns
dict or None
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-
-
class
ColumnDataSource
(*args, **kw)[source]¶ Bases:
bokeh.models.sources.ColumnarDataSource
Maps names of columns to sequences or arrays.
The
ColumnDataSource
is a fundamental data structure of Bokeh. Most plots, data tables, etc. will be driven by aColumnDataSource
.If the
ColumnDataSource
initializer is called with a single argument that can be any of the following:A Python
dict
that maps string names to sequences of values, e.g. lists, arrays, etc.data = {'x': [1,2,3,4], 'y': np.ndarray([10.0, 20.0, 30.0, 40.0])} source = ColumnDataSource(data)
Note
ColumnDataSource
only creates a shallow copy ofdata
. Use e.g.ColumnDataSource(copy.deepcopy(data))
if initializing from anotherColumnDataSource.data
object that you want to keep independent.A Pandas
DataFrame
objectsource = ColumnDataSource(df)
In this case the CDS will have columns corresponding to the columns of the
DataFrame
. If theDataFrame
columns have multiple levels, they will be flattened using an underscore (e.g. level_0_col_level_1_col). The index of theDataFrame
will be flattened to anIndex
of tuples if it’s aMultiIndex
, and then reset usingreset_index
. The result will be a column with the same name if the index was named, or level_0_name_level_1_name if it was a namedMultiIndex
. If theIndex
did not have a name or theMultiIndex
name could not be flattened/determined, thereset_index
function will name the index columnindex
, orlevel_0
if the nameindex
is not available.A Pandas
GroupBy
objectgroup = df.groupby(('colA', 'ColB'))
In this case the CDS will have columns corresponding to the result of calling
group.describe()
. Thedescribe
method generates columns for statistical measures such asmean
andcount
for all the non-grouped original columns. The CDS columns are formed by joining original column names with the computed measure. For example, if aDataFrame
has columns'year'
and'mpg'
. Then passingdf.groupby('year')
to a CDS will result in columns such as'mpg_mean'
If the
GroupBy.describe
result has a named index column, then CDS will also have a column with this name. However, if the index name (or any subname of aMultiIndex
) isNone
, then the CDS will have a column generically namedindex
for the index.Note this capability to adapt
GroupBy
objects may only work with Pandas>=0.20.0
.
Note
There is an implicit assumption that all the columns in a given
ColumnDataSource
all have the same length at all times. For this reason, it is usually preferable to update the.data
property of a data source “all at once”.-
data
¶ property type:
ColumnData
(String
,Seq
(Any
) )Mapping of column names to sequences of data. The columns can be, e.g, Python lists or tuples, NumPy arrays, etc.
The .data attribute can also be set from Pandas DataFrames or GroupBy objects. In these cases, the behaviour is identical to passing the objects to the
ColumnDataSource
initializer.
-
js_event_callbacks
¶ property type:
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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
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', ...)]
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.
-
selected
¶ property type:
Instance
(Selection
)An instance of a
Selection
that indicates selected indices on thisDataSource
. This is a read-only property. You may only change the attributes of this object to change the selection (e.g.,selected.indices
).
-
selection_policy
¶ property type:
Instance
(SelectionPolicy
)An instance of a
SelectionPolicy
that determines how selections are set.
-
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.
-
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.
-
__init__
(*args, **kw)[source]¶ If called with a single argument that is a dict or
pandas.DataFrame
, treat that implicitly as the “data” attribute.
-
apply_theme
(property_values)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ Structural equality of models.
- Parameters
other (HasProps) – the other instance to compare to
- Returns
True, if properties are structurally equal, otherwise False
-
classmethod
from_df
(data)[source]¶ Create a
dict
of columns from a PandasDataFrame
, suitable for creating aColumnDataSource
.- Parameters
data (DataFrame) – data to convert
- Returns
dict[str, np.array]
-
classmethod
from_groupby
(data)[source]¶ Create a
dict
of columns from a PandasGroupBy
, suitable for creating aColumnDataSource
.The data generated is the result of running
describe
on the group.- Parameters
data (Groupby) – data to convert
- Returns
dict[str, np.array]
-
js_link
(attr, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
patch
(patches, setter=None)[source]¶ Efficiently update data source columns at specific locations
If it is only necessary to update a small subset of data in a
ColumnDataSource
, this method can be used to efficiently update only the subset, instead of requiring the entire data set to be sent.This method should be passed a dictionary that maps column names to lists of tuples that describe a patch change to apply. To replace individual items in columns entirely, the tuples should be of the form:
(index, new_value) # replace a single column value # or (slice, new_values) # replace several column values
Values at an index or slice will be replaced with the corresponding new values.
In the case of columns whose values are other arrays or lists, (e.g. image or patches glyphs), it is also possible to patch “subregions”. In this case the first item of the tuple should be a whose first element is the index of the array item in the CDS patch, and whose subsequent elements are integer indices or slices into the array item:
# replace the entire 10th column of the 2nd array: +----------------- index of item in column data source | | +--------- row subindex into array item | | | | +- column subindex into array item V V V ([2, slice(None), 10], new_values)
Imagining a list of 2d NumPy arrays, the patch above is roughly equivalent to:
data = [arr1, arr2, ...] # list of 2d arrays data[2][:, 10] = new_data
There are some limitations to the kinds of slices and data that can be accepted.
Negative
start
,stop
, orstep
values for slices will result in aValueError
.In a slice,
start > stop
will result in aValueError
When patching 1d or 2d subitems, the subitems must be NumPy arrays.
New values must be supplied as a flattened one-dimensional array of the appropriate size.
Example:
The following example shows how to patch entire column elements. In this case,
source = ColumnDataSource(data=dict(foo=[10, 20, 30], bar=[100, 200, 300])) patches = { 'foo' : [ (slice(2), [11, 12]) ], 'bar' : [ (0, 101), (2, 301) ], } source.patch(patches)
After this operation, the value of the
source.data
will be:dict(foo=[11, 12, 30], bar=[101, 200, 301])
For a more comprehensive complete example, see examples/howto/patch_app.py.
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove
(name)[source]¶ Remove a column of data.
- Parameters
name (str) – name of the column to remove
- Returns
None
Note
If the column name does not exist, a warning is issued.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
stream
(new_data, rollover=None)[source]¶ Efficiently update data source columns with new append-only data.
In cases where it is necessary to update data columns in, this method can efficiently send only the new data, instead of requiring the entire data set to be re-sent.
- Parameters
a mapping of column names to sequences of new data to append to each column.
All columns of the data source must be present in
new_data
, with identical-length append data.rollover (int, optional) – A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded (default: None)
- Returns
None
- Raises
Example:
source = ColumnDataSource(data=dict(foo=[], bar=[])) # has new, identical-length updates for all columns in source new_data = { 'foo' : [10, 20], 'bar' : [100, 200], } source.stream(new_data)
-
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.- Returns
dict or None
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
column_names
¶ A list of the column names in this data source.
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-
class
DataSource
(**kwargs)[source]¶ Bases:
bokeh.model.Model
A base class for data source 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.
-
js_event_callbacks
¶ property type:
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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
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', ...)]
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.
-
selected
¶ property type:
Instance
(Selection
)An instance of a
Selection
that indicates selected indices on thisDataSource
. This is a read-only property. You may only change the attributes of this object to change the selection (e.g.,selected.indices
).
-
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.
-
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)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
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.- Returns
dict or None
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-
-
class
GeoJSONDataSource
(**kwargs)[source]¶ Bases:
bokeh.models.sources.ColumnarDataSource
-
geojson
¶ property type:
JSON
GeoJSON that contains features for plotting. Currently
GeoJSONDataSource
can only process aFeatureCollection
orGeometryCollection
.
-
js_event_callbacks
¶ property type:
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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
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', ...)]
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.
-
selected
¶ property type:
Instance
(Selection
)An instance of a
Selection
that indicates selected indices on thisDataSource
. This is a read-only property. You may only change the attributes of this object to change the selection (e.g.,selected.indices
).
-
selection_policy
¶ property type:
Instance
(SelectionPolicy
)An instance of a
SelectionPolicy
that determines how selections are set.
-
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.
-
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)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
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.- Returns
dict or None
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-
-
class
ServerSentDataSource
(*args, **kw)[source]¶ Bases:
bokeh.models.sources.WebSource
A data source that can populate columns by receiving server sent events endpoints.
-
adapter
¶ property type:
Instance
(CustomJS
)A JavaScript callback to adapt raw JSON responses to Bokeh
ColumnDataSource
format.If provided, this callback is executes immediately after the JSON data is received, but before appending or replacing data in the data source. The
CustomJS
callback will receive theAjaxDataSource
ascb_obj
and will receive the raw JSON response ascb_data.response
. The callback code should return adata
object suitable for a BokehColumnDataSource
(i.e. a mapping of string column names to arrays of data).
-
data
¶ property type:
ColumnData
(String
,Seq
(Any
) )Mapping of column names to sequences of data. The columns can be, e.g, Python lists or tuples, NumPy arrays, etc.
The .data attribute can also be set from Pandas DataFrames or GroupBy objects. In these cases, the behaviour is identical to passing the objects to the
ColumnDataSource
initializer.
-
js_event_callbacks
¶ property type:
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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
max_size
¶ property type:
Int
Maximum size of the data columns. If a new fetch would result in columns larger than
max_size
, then earlier data is dropped to make room.
-
mode
¶ property type:
Enum
( Enumeration(replace, append) )Whether to append new data to existing data (up to
max_size
), or to replace existing data entirely.
-
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', ...)]
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.
-
selected
¶ property type:
Instance
(Selection
)An instance of a
Selection
that indicates selected indices on thisDataSource
. This is a read-only property. You may only change the attributes of this object to change the selection (e.g.,selected.indices
).
-
selection_policy
¶ property type:
Instance
(SelectionPolicy
)An instance of a
SelectionPolicy
that determines how selections are set.
-
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.
-
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.
-
__init__
(*args, **kw)¶ If called with a single argument that is a dict or
pandas.DataFrame
, treat that implicitly as the “data” attribute.
-
add
(data, name=None)¶ Appends a new column of data to the data source.
-
apply_theme
(property_values)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ Structural equality of models.
- Parameters
other (HasProps) – the other instance to compare to
- Returns
True, if properties are structurally equal, otherwise False
-
classmethod
from_df
(data)¶ Create a
dict
of columns from a PandasDataFrame
, suitable for creating aColumnDataSource
.- Parameters
data (DataFrame) – data to convert
- Returns
dict[str, np.array]
-
classmethod
from_groupby
(data)¶ Create a
dict
of columns from a PandasGroupBy
, suitable for creating aColumnDataSource
.The data generated is the result of running
describe
on the group.- Parameters
data (Groupby) – data to convert
- Returns
dict[str, np.array]
-
js_link
(attr, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
patch
(patches, setter=None)¶ Efficiently update data source columns at specific locations
If it is only necessary to update a small subset of data in a
ColumnDataSource
, this method can be used to efficiently update only the subset, instead of requiring the entire data set to be sent.This method should be passed a dictionary that maps column names to lists of tuples that describe a patch change to apply. To replace individual items in columns entirely, the tuples should be of the form:
(index, new_value) # replace a single column value # or (slice, new_values) # replace several column values
Values at an index or slice will be replaced with the corresponding new values.
In the case of columns whose values are other arrays or lists, (e.g. image or patches glyphs), it is also possible to patch “subregions”. In this case the first item of the tuple should be a whose first element is the index of the array item in the CDS patch, and whose subsequent elements are integer indices or slices into the array item:
# replace the entire 10th column of the 2nd array: +----------------- index of item in column data source | | +--------- row subindex into array item | | | | +- column subindex into array item V V V ([2, slice(None), 10], new_values)
Imagining a list of 2d NumPy arrays, the patch above is roughly equivalent to:
data = [arr1, arr2, ...] # list of 2d arrays data[2][:, 10] = new_data
There are some limitations to the kinds of slices and data that can be accepted.
Negative
start
,stop
, orstep
values for slices will result in aValueError
.In a slice,
start > stop
will result in aValueError
When patching 1d or 2d subitems, the subitems must be NumPy arrays.
New values must be supplied as a flattened one-dimensional array of the appropriate size.
Example:
The following example shows how to patch entire column elements. In this case,
source = ColumnDataSource(data=dict(foo=[10, 20, 30], bar=[100, 200, 300])) patches = { 'foo' : [ (slice(2), [11, 12]) ], 'bar' : [ (0, 101), (2, 301) ], } source.patch(patches)
After this operation, the value of the
source.data
will be:dict(foo=[11, 12, 30], bar=[101, 200, 301])
For a more comprehensive complete example, see examples/howto/patch_app.py.
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove
(name)¶ Remove a column of data.
- Parameters
name (str) – name of the column to remove
- Returns
None
Note
If the column name does not exist, a warning is issued.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
stream
(new_data, rollover=None)¶ Efficiently update data source columns with new append-only data.
In cases where it is necessary to update data columns in, this method can efficiently send only the new data, instead of requiring the entire data set to be re-sent.
- Parameters
a mapping of column names to sequences of new data to append to each column.
All columns of the data source must be present in
new_data
, with identical-length append data.rollover (int, optional) – A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded (default: None)
- Returns
None
- Raises
Example:
source = ColumnDataSource(data=dict(foo=[], bar=[])) # has new, identical-length updates for all columns in source new_data = { 'foo' : [10, 20], 'bar' : [100, 200], } source.stream(new_data)
-
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.- Returns
dict or None
-
to_df
()¶ Convert this data source to pandas
DataFrame
.- Returns
DataFrame
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
column_names
¶ A list of the column names in this data source.
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-
-
class
WebSource
(*args, **kw)[source]¶ Bases:
bokeh.models.sources.ColumnDataSource
Base class for web column data sources that can update from data URLs.
Note
This base class is typically not 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.
-
adapter
¶ property type:
Instance
(CustomJS
)A JavaScript callback to adapt raw JSON responses to Bokeh
ColumnDataSource
format.If provided, this callback is executes immediately after the JSON data is received, but before appending or replacing data in the data source. The
CustomJS
callback will receive theAjaxDataSource
ascb_obj
and will receive the raw JSON response ascb_data.response
. The callback code should return adata
object suitable for a BokehColumnDataSource
(i.e. a mapping of string column names to arrays of data).
-
data
¶ property type:
ColumnData
(String
,Seq
(Any
) )Mapping of column names to sequences of data. The columns can be, e.g, Python lists or tuples, NumPy arrays, etc.
The .data attribute can also be set from Pandas DataFrames or GroupBy objects. In these cases, the behaviour is identical to passing the objects to the
ColumnDataSource
initializer.
-
js_event_callbacks
¶ property type:
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:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )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:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
max_size
¶ property type:
Int
Maximum size of the data columns. If a new fetch would result in columns larger than
max_size
, then earlier data is dropped to make room.
-
mode
¶ property type:
Enum
( Enumeration(replace, append) )Whether to append new data to existing data (up to
max_size
), or to replace existing data entirely.
-
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', ...)]
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.
-
selected
¶ property type:
Instance
(Selection
)An instance of a
Selection
that indicates selected indices on thisDataSource
. This is a read-only property. You may only change the attributes of this object to change the selection (e.g.,selected.indices
).
-
selection_policy
¶ property type:
Instance
(SelectionPolicy
)An instance of a
SelectionPolicy
that determines how selections are set.
-
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.
-
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.
-
__init__
(*args, **kw)¶ If called with a single argument that is a dict or
pandas.DataFrame
, treat that implicitly as the “data” attribute.
-
add
(data, name=None)¶ Appends a new column of data to the data source.
-
apply_theme
(property_values)¶ 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
()¶ 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
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ Structural equality of models.
- Parameters
other (HasProps) – the other instance to compare to
- Returns
True, if properties are structurally equal, otherwise False
-
classmethod
from_df
(data)¶ Create a
dict
of columns from a PandasDataFrame
, suitable for creating aColumnDataSource
.- Parameters
data (DataFrame) – data to convert
- Returns
dict[str, np.array]
-
classmethod
from_groupby
(data)¶ Create a
dict
of columns from a PandasGroupBy
, suitable for creating aColumnDataSource
.The data generated is the result of running
describe
on the group.- Parameters
data (Groupby) – data to convert
- Returns
dict[str, np.array]
-
js_link
(attr, other, other_attr, attr_selector=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, *callbacks)¶ 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)
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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)
-
patch
(patches, setter=None)¶ Efficiently update data source columns at specific locations
If it is only necessary to update a small subset of data in a
ColumnDataSource
, this method can be used to efficiently update only the subset, instead of requiring the entire data set to be sent.This method should be passed a dictionary that maps column names to lists of tuples that describe a patch change to apply. To replace individual items in columns entirely, the tuples should be of the form:
(index, new_value) # replace a single column value # or (slice, new_values) # replace several column values
Values at an index or slice will be replaced with the corresponding new values.
In the case of columns whose values are other arrays or lists, (e.g. image or patches glyphs), it is also possible to patch “subregions”. In this case the first item of the tuple should be a whose first element is the index of the array item in the CDS patch, and whose subsequent elements are integer indices or slices into the array item:
# replace the entire 10th column of the 2nd array: +----------------- index of item in column data source | | +--------- row subindex into array item | | | | +- column subindex into array item V V V ([2, slice(None), 10], new_values)
Imagining a list of 2d NumPy arrays, the patch above is roughly equivalent to:
data = [arr1, arr2, ...] # list of 2d arrays data[2][:, 10] = new_data
There are some limitations to the kinds of slices and data that can be accepted.
Negative
start
,stop
, orstep
values for slices will result in aValueError
.In a slice,
start > stop
will result in aValueError
When patching 1d or 2d subitems, the subitems must be NumPy arrays.
New values must be supplied as a flattened one-dimensional array of the appropriate size.
Example:
The following example shows how to patch entire column elements. In this case,
source = ColumnDataSource(data=dict(foo=[10, 20, 30], bar=[100, 200, 300])) patches = { 'foo' : [ (slice(2), [11, 12]) ], 'bar' : [ (0, 101), (2, 301) ], } source.patch(patches)
After this operation, the value of the
source.data
will be:dict(foo=[11, 12, 30], bar=[101, 200, 301])
For a more comprehensive complete example, see examples/howto/patch_app.py.
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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) → 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, include_defaults=True)¶ Query the properties values of
HasProps
instances with a predicate.- Parameters
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
- Returns
mapping of property names and values for matching properties
- Return type
-
references
()¶ Returns all
Models
that this object has references to.
-
remove
(name)¶ Remove a column of data.
- Parameters
name (str) – name of the column to remove
- Returns
None
Note
If the column name does not exist, a warning is issued.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
stream
(new_data, rollover=None)¶ Efficiently update data source columns with new append-only data.
In cases where it is necessary to update data columns in, this method can efficiently send only the new data, instead of requiring the entire data set to be re-sent.
- Parameters
a mapping of column names to sequences of new data to append to each column.
All columns of the data source must be present in
new_data
, with identical-length append data.rollover (int, optional) – A maximum column size, above which data from the start of the column begins to be discarded. If None, then columns will continue to grow unbounded (default: None)
- Returns
None
- Raises
Example:
source = ColumnDataSource(data=dict(foo=[], bar=[])) # has new, identical-length updates for all columns in source new_data = { 'foo' : [10, 20], 'bar' : [100, 200], } source.stream(new_data)
-
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.- Returns
dict or None
-
to_df
()¶ Convert this data source to pandas
DataFrame
.- Returns
DataFrame
-
to_json
(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
to_json_string
(include_defaults)¶ Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding
from_json_string()
because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).For most purposes it’s best to serialize and deserialize entire documents.
- Parameters
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
-
trigger
(attr, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ Updates the object’s properties from the given keyword arguments.
- Returns
None
Examples
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
-
update_from_json
(json_attributes, models=None, setter=None)¶ Updates the object’s properties from a JSON attributes dictionary.
- Parameters
json_attributes – (JSON-dict) : attributes and values to update
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
- Returns
None
-
property
column_names
¶ A list of the column names in this data source.
-
property
document
¶ The
Document
this model is attached to (can beNone
)
-
property
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.
-