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.
CategoricalColorMapper
Bases: bokeh.models.mappers.CategoricalMapper, bokeh.models.mappers.ColorMapper
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.
nan_color
end
Nullable(Int)
Nullable
Int
None
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 setting end=1 will perform color mapping only based on the first sub-factor (i.e. in this case based on the year "2016" or "2017")
["2016", "sales"]
["2017", "marketing"]
end=1
"2016"
"2017"
If None then all sub-factors from start to the end of the factor will be used for color mapping.
start
factors
FactorSeq(Either(Seq(String), Seq(Tuple(String, String)), Seq(Tuple(String, String, String))))
FactorSeq
Either
Seq
String
Tuple
Undefined
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.
"foo"
"bar"
js_event_callbacks
Dict(String, List(Instance(CustomJS)))
Dict
List
Instance
CustomJS
{}
A mapping of event names to lists of CustomJS callbacks.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:
Model.js_on_event
callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
js_property_callbacks
A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:
Model.js_on_change
callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
name
Nullable(String)
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
Color
'gray'
Color to be used if data is NaN or otherwise not mappable.
Acceptable values are:
any of the named CSS colors, e.g 'green', 'indigo'
'green'
'indigo'
RGB(A) hex strings, e.g., '#FF0000', '#44444444'
'#FF0000'
'#44444444'
CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'
'rgba(255, 0, 127, 0.6)'
'rgb(0 127 0 / 1.0)'
'hsl(60deg 100% 50% / 1.0)'
a 3-tuple of integers (r, g, b) between 0 and 255
a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1
a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern
palette
Seq(Color)
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.
0
For example, if the data to color map consists of 2-level factors such as ["2016", "sales"] and ["2016", "marketing"], then setting start=1 will perform color mapping only based on the second sub-factor (i.e. in this case based on the department "sales" or "marketing")
["2016", "marketing"]
start=1
"sales"
"marketing"
subscribed_events
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.
syncable
Bool
True
Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.
False
Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.
on_change()
tags
List(AnyRef)
AnyRef
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
apply_theme
Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).
HasProps
property_values (dict) – theme values to use in place of defaults
dataspecs
Collect the names of all DataSpec properties on this class.
DataSpec
This method always traverses the class hierarchy and includes properties defined on any parent classes.
names of DataSpec properties
set[str]
dataspecs_with_props
Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.
mapping of names and DataSpec properties
dict[str, DataSpec]
equals
Structural equality of models.
other (HasProps) – the other instance to compare to
True, if properties are structurally equal, otherwise False
js_link
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.
attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
other
attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr
attr
Added in version 1.1
ValueError –
Examples
This code with js_link:
select.js_link('value', plot, 'sizing_mode')
is equivalent to the following:
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
which is equivalent to:
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
js_on_change
Attach a CustomJS callback to an arbitrary BokehJS model event.
On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:
"change:property_name"
"change:"
# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
PropertyDescriptor
name (str) – name of the property to search for
raises (bool) – whether to raise or return None if missing
descriptor for property named name
on_change
Add a callback on this object to trigger when attr changes.
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
on_event
Run callbacks when the specified event occurs on this Model
Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.
properties
Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
property names
properties_containers
Collect the names of all container properties on this class.
names of container properties
properties_with_refs
Collect the names of all properties on this class that also have references.
names of properties that have references
properties_with_values
Collect a dict mapping property names to their values.
Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
mapping from property names to their values
dict
query_properties_with_values
Query the properties values of HasProps instances with a predicate.
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
mapping of property names and values for matching properties
references
Returns all Models that this object has references to.
Models
remove_on_change
Remove a callback from this object
select
Query this object and all of its references for objects that match the given selector.
selector (JSON-like) –
seq[Model]
select_one
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
Model
set_from_json
Set a property value on this object from JSON.
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
set_select
Update objects that match a given selector with the specified attribute/value updates.
updates (dict) –
themed_values
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
to_json
Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json()
For most purposes it’s best to serialize and deserialize entire documents.
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
to_json_string
Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json_string()
trigger
unapply_theme
Remove any themed values and restore defaults.
update
Updates the object’s properties from the given keyword arguments.
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
update_from_json
Updates the object’s properties from a JSON attributes dictionary.
json_attributes – (JSON-dict) : attributes and values to update
document
The Document this model is attached to (can be None)
Document
struct
A Bokeh protocol “structure” of this model, i.e. a dict of the form:
{ 'type' : << view model name >> 'id' : << unique model id >> }
Additionally there may be a subtype field if this model is a subtype.
{ "end": null, "id": "18111", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "nan_color": "gray", "start": 0, "subscribed_events": [], "syncable": true, "tags": [] }
CategoricalMapper
Bases: bokeh.models.mappers.Mapper
bokeh.models.mappers.Mapper
Base class for mappers that map categorical factors to other values.
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": null, "id": "18123", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "start": 0, "subscribed_events": [], "syncable": true, "tags": [] }
CategoricalMarkerMapper
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.
default_value
This mappers is primarily only useful with the Scatter marker glyph that be parameterized by marker type.
Scatter
MarkerType(MarkerType)
MarkerType
'circle'
A marker type to use in case an unrecognized factor is passed in to be mapped.
markers
Seq(MarkerType(MarkerType))
A sequence of marker types to use as the target for mapping.
{ "default_value": "circle", "end": null, "id": "18133", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "start": 0, "subscribed_events": [], "syncable": true, "tags": [] }
CategoricalPatternMapper
Map categorical factors to hatch fill patterns.
Added in version 1.1.1
HatchPatternType
' '
A hatch pattern to use in case an unrecognized factor is passed in to be mapped.
patterns
Seq(HatchPatternType)
{ "default_value": " ", "end": null, "id": "18145", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "start": 0, "subscribed_events": [], "syncable": true, "tags": [] }
ColorMapper
Base class for color mapper types.
{ "id": "18157", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "nan_color": "gray", "subscribed_events": [], "syncable": true, "tags": [] }
ContinuousColorMapper
Bases: bokeh.models.mappers.ColorMapper
Base class for continuous color mapper types.
domain
List(Tuple(Instance(GlyphRenderer), Either(String, List(String))))
GlyphRenderer
A collection of glyph renderers to pool data from for establishing data metrics. If empty, mapped data will be used instead.
high
Nullable(Float)
Float
The maximum value of the range to map into the palette. Values above this are clamped to high. If None, the value is inferred from data.
high_color
Nullable(Color)
Color to be used if data is higher than high value. If None, values higher than high are mapped to the last color in the palette.
low
The minimum value of the range to map into the palette. Values below this are clamped to low. If None, the value is inferred from data.
low_color
Color to be used if data is lower than low value. If None, values lower than low are mapped to the first color in the palette.
{ "domain": [], "high": null, "high_color": null, "id": "18166", "js_event_callbacks": {}, "js_property_callbacks": {}, "low": null, "low_color": null, "name": null, "nan_color": "gray", "subscribed_events": [], "syncable": true, "tags": [] }
EqHistColorMapper
Bases: bokeh.models.mappers.ScanningColorMapper
bokeh.models.mappers.ScanningColorMapper
bins
65536
Number of histogram bins
{ "bins": 65536, "domain": [], "high": null, "high_color": null, "id": "18180", "js_event_callbacks": {}, "js_property_callbacks": {}, "low": null, "low_color": null, "name": null, "nan_color": "gray", "subscribed_events": [], "syncable": true, "tags": [] }
LinearColorMapper
Bases: bokeh.models.mappers.ContinuousColorMapper
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:
['red', 'green', 'blue']
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
{ "domain": [], "high": null, "high_color": null, "id": "18195", "js_event_callbacks": {}, "js_property_callbacks": {}, "low": null, "low_color": null, "name": null, "nan_color": "gray", "subscribed_events": [], "syncable": true, "tags": [] }
LogColorMapper
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.
{ "domain": [], "high": null, "high_color": null, "id": "18209", "js_event_callbacks": {}, "js_property_callbacks": {}, "low": null, "low_color": null, "name": null, "nan_color": "gray", "subscribed_events": [], "syncable": true, "tags": [] }
Mapper
Bases: bokeh.models.transforms.Transform
bokeh.models.transforms.Transform
Base class for mappers.
{ "id": "18223", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "syncable": true, "tags": [] }