bokeh.models.mappers¶
Models for mapping values from one range or space to another in the client.
Mappers (as opposed to scales) are not presumed to be invertible.
-
class
Mapper
(**kwargs)[source]¶ Bases:
bokeh.models.transforms.Transform
Base class for mappers.
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.
-
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
ColorMapper
(palette=None, **kwargs)[source]¶ Bases:
bokeh.models.mappers.Mapper
Base class for color mapper 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.
-
nan_color
¶ property type:
Color
Color to be used if data is NaN or otherwise not mappable. (Default: ‘gray’)
-
palette
¶ -
A sequence of colors to use as the target palette for mapping.
This property can also be set as a
String
, to the name of any of the palettes shown in bokeh.palettes.
-
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
CategoricalMapper
(**kwargs)[source]¶ Bases:
bokeh.models.mappers.Mapper
Base class for mappers that map categorical factors to other values.
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.
-
end
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2017", "marketing"]
, then settingend=1
will perform color mapping only based on the first sub-factor (i.e. in this case based on the year"2016"
or"2017"
)If
None
then all sub-factors fromstart
to the end of the factor will be used for color mapping.
-
factors
¶ property type:
Either
(Seq
(String
),Seq
(Tuple
(String
,String
) ),Seq
(Tuple
(String
,String
,String
) ) )A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor
"foo"
to red and the factor"bar"
to blue.
-
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.
-
start
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2016", "marketing"]
, then settingstart=1
will perform color mapping only based on the second sub-factor (i.e. in this case based on the department"sales"
or"marketing"
)
-
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
CategoricalColorMapper
(**kwargs)[source]¶ Bases:
bokeh.models.mappers.CategoricalMapper
,bokeh.models.mappers.ColorMapper
Map categorical factors to colors.
Values that are passed to this mapper that are not in the factors list will be mapped to
nan_color
.-
end
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2017", "marketing"]
, then settingend=1
will perform color mapping only based on the first sub-factor (i.e. in this case based on the year"2016"
or"2017"
)If
None
then all sub-factors fromstart
to the end of the factor will be used for color mapping.
-
factors
¶ property type:
Either
(Seq
(String
),Seq
(Tuple
(String
,String
) ),Seq
(Tuple
(String
,String
,String
) ) )A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor
"foo"
to red and the factor"bar"
to blue.
-
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.
-
nan_color
¶ property type:
Color
Color to be used if data is NaN or otherwise not mappable. (Default: ‘gray’)
-
palette
¶ -
A sequence of colors to use as the target palette for mapping.
This property can also be set as a
String
, to the name of any of the palettes shown in bokeh.palettes.
-
start
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2016", "marketing"]
, then settingstart=1
will perform color mapping only based on the second sub-factor (i.e. in this case based on the department"sales"
or"marketing"
)
-
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
CategoricalMarkerMapper
(**kwargs)[source]¶ Bases:
bokeh.models.mappers.CategoricalMapper
Map categorical factors to marker types.
Values that are passed to this mapper that are not in the factors list will be mapped to
default_value
.Note
This mappers is primarily only useful with the
Scatter
marker glyph that be parameterized by marker type.-
default_value
¶ property type:
MarkerType
(MarkerType
)A marker type to use in case an unrecognized factor is passed in to be mapped.
-
end
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2017", "marketing"]
, then settingend=1
will perform color mapping only based on the first sub-factor (i.e. in this case based on the year"2016"
or"2017"
)If
None
then all sub-factors fromstart
to the end of the factor will be used for color mapping.
-
factors
¶ property type:
Either
(Seq
(String
),Seq
(Tuple
(String
,String
) ),Seq
(Tuple
(String
,String
,String
) ) )A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor
"foo"
to red and the factor"bar"
to blue.
-
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)
-
markers
¶ property type:
Seq
(MarkerType
(MarkerType
) )A sequence of marker types to use as the target for mapping.
-
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.
-
start
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2016", "marketing"]
, then settingstart=1
will perform color mapping only based on the second sub-factor (i.e. in this case based on the department"sales"
or"marketing"
)
-
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
CategoricalPatternMapper
(**kwargs)[source]¶ Bases:
bokeh.models.mappers.CategoricalMapper
Map categorical factors to hatch fill patterns.
Values that are passed to this mapper that are not in the factors list will be mapped to
default_value
.Added in version 1.1.1
-
default_value
¶ property type:
HatchPatternType
A hatch pattern to use in case an unrecognized factor is passed in to be mapped.
-
end
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2017", "marketing"]
, then settingend=1
will perform color mapping only based on the first sub-factor (i.e. in this case based on the year"2016"
or"2017"
)If
None
then all sub-factors fromstart
to the end of the factor will be used for color mapping.
-
factors
¶ property type:
Either
(Seq
(String
),Seq
(Tuple
(String
,String
) ),Seq
(Tuple
(String
,String
,String
) ) )A sequence of factors / categories that map to the some target range. For example the following color mapper:
mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])
will map the factor
"foo"
to red and the factor"bar"
to blue.
-
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.
-
patterns
¶ property type:
Seq
(HatchPatternType
)A sequence of marker types to use as the target for mapping.
-
start
¶ property type:
Int
A start index to “slice” data factors with before mapping.
For example, if the data to color map consists of 2-level factors such as
["2016", "sales"]
and["2016", "marketing"]
, then settingstart=1
will perform color mapping only based on the second sub-factor (i.e. in this case based on the department"sales"
or"marketing"
)
-
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
ContinuousColorMapper
(palette=None, **kwargs)[source]¶ Bases:
bokeh.models.mappers.ColorMapper
Base class for continuous color mapper 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.
-
high
¶ property type:
Float
The maximum value of the range to map into the palette. Values above this are clamped to
high
.
-
high_color
¶ property type:
Color
Color to be used if data is higher than
high
value. If None, values higher thanhigh
are mapped to the last color in the palette.
-
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)
-
low
¶ property type:
Float
The minimum value of the range to map into the palette. Values below this are clamped to
low
.
-
low_color
¶ property type:
Color
Color to be used if data is lower than
low
value. If None, values lower thanlow
are mapped to the first color in the palette.
-
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.
-
nan_color
¶ property type:
Color
Color to be used if data is NaN or otherwise not mappable. (Default: ‘gray’)
-
palette
¶ -
A sequence of colors to use as the target palette for mapping.
This property can also be set as a
String
, to the name of any of the palettes shown in bokeh.palettes.
-
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
LinearColorMapper
(palette=None, **kwargs)[source]¶ Bases:
bokeh.models.mappers.ContinuousColorMapper
Map numbers in a range [low, high] linearly into a sequence of colors (a palette).
For example, if the range is [0, 99] and the palette is
['red', 'green', 'blue']
, the values would be mapped as follows:x < 0 : 'red' # values < low are clamped 0 >= x < 33 : 'red' 33 >= x < 66 : 'green' 66 >= x < 99 : 'blue' 99 >= x : 'blue' # values > high are clamped
-
high
¶ property type:
Float
The maximum value of the range to map into the palette. Values above this are clamped to
high
.
-
high_color
¶ property type:
Color
Color to be used if data is higher than
high
value. If None, values higher thanhigh
are mapped to the last color in the palette.
-
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)
-
low
¶ property type:
Float
The minimum value of the range to map into the palette. Values below this are clamped to
low
.
-
low_color
¶ property type:
Color
Color to be used if data is lower than
low
value. If None, values lower thanlow
are mapped to the first color in the palette.
-
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.
-
nan_color
¶ property type:
Color
Color to be used if data is NaN or otherwise not mappable. (Default: ‘gray’)
-
palette
¶ -
A sequence of colors to use as the target palette for mapping.
This property can also be set as a
String
, to the name of any of the palettes shown in bokeh.palettes.
-
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
LogColorMapper
(palette=None, **kwargs)[source]¶ Bases:
bokeh.models.mappers.ContinuousColorMapper
Map numbers in a range [low, high] into a sequence of colors (a palette) on a natural logarithm scale.
For example, if the range is [0, 25] and the palette is
['red', 'green', 'blue']
, the values would be mapped as follows:x < 0 : 'red' # values < low are clamped 0 >= x < 2.72 : 'red' # math.e ** 1 2.72 >= x < 7.39 : 'green' # math.e ** 2 7.39 >= x < 20.09 : 'blue' # math.e ** 3 20.09 >= x : 'blue' # values > high are clamped
Warning
The
LogColorMapper
only works for images with scalar values that are non-negative.-
high
¶ property type:
Float
The maximum value of the range to map into the palette. Values above this are clamped to
high
.
-
high_color
¶ property type:
Color
Color to be used if data is higher than
high
value. If None, values higher thanhigh
are mapped to the last color in the palette.
-
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)
-
low
¶ property type:
Float
The minimum value of the range to map into the palette. Values below this are clamped to
low
.
-
low_color
¶ property type:
Color
Color to be used if data is lower than
low
value. If None, values lower thanlow
are mapped to the first color in the palette.
-
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.
-
nan_color
¶ property type:
Color
Color to be used if data is NaN or otherwise not mappable. (Default: ‘gray’)
-
palette
¶ -
A sequence of colors to use as the target palette for mapping.
This property can also be set as a
String
, to the name of any of the palettes shown in bokeh.palettes.
-
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.
-