TileSource
Bases: bokeh.model.Model
bokeh.model.Model
A base class for all tile source types.
In general, tile sources are used as a required input for TileRenderer.
TileRenderer
attribution
property type: String
String
Data provider attribution content. This can include HTML content.
extra_url_vars
property type: Dict ( String , Any )
Dict
Any
A dictionary that maps url variable template keys to values.
These variables are useful for parts of tile urls which do not change from tile to tile (e.g. server host name, or layer name).
initial_resolution
property type: Float
Float
Resolution (plot_units / pixels) of minimum zoom level of tileset projection. None to auto-compute.
js_event_callbacks
property type: Dict ( String , List ( Instance ( CustomJS ) ) )
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)
max_zoom
property type: Int
Int
A maximum zoom level for the tile layer. This is the most zoomed-in level.
min_zoom
A minimum zoom level for the tile layer. This is the most zoomed-out level.
name
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.
tags
property type: List ( Any )
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
tile_size
Tile size in pixels (e.g. 256)
url
Tile service url e.g., http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png
x_origin_offset
An x-offset in plot coordinates
y_origin_offset
A y-offset in plot coordinates
apply_theme
Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).
HasProps
property_values (dict) – theme values to use in place of defaults
None
dataspecs
Collect the names of all DataSpec properties on this class.
DataSpec
This method always traverses the class hierarchy and includes properties defined on any parent classes.
names of DataSpec properties
set[str]
dataspecs_with_props
Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.
mapping of names and DataSpec properties
dict[str, DataSpec]
equals
Structural equality of models.
other (HasProps) – the other instance to compare to
True, if properties are structurally equal, otherwise False
js_link
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.
attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
other
attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr
attr
Added in version 1.1
ValueError –
Examples
This code with js_link:
select.js_link('value', plot, 'sizing_mode')
is equivalent to the following:
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
which is equivalent to:
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
js_on_change
Attach a CustomJS callback to an arbitrary BokehJS model event.
On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:
"change:property_name"
"change:"
# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
PropertyDescriptor
name (str) – name of the property to search for
descriptor for property named name
on_change
Add a callback on this object to trigger when attr changes.
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
properties
Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
property names
properties_containers
Collect the names of all container properties on this class.
names of container properties
properties_with_refs
Collect the names of all properties on this class that also have references.
names of properties that have references
properties_with_values
Collect a dict mapping property names to their values.
Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
mapping from property names to their values
dict
query_properties_with_values
Query the properties values of HasProps instances with a predicate.
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
mapping of property names and values for matching properties
references
Returns all Models that this object has references to.
Models
remove_on_change
Remove a callback from this object
select
Query this object and all of its references for objects that match the given selector.
selector (JSON-like) –
seq[Model]
select_one
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
Model
set_from_json
Set a property value on this object from JSON.
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
set_select
Update objects that match a given selector with the specified attribute/value updates.
updates (dict) –
themed_values
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
to_json
Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json()
For most purposes it’s best to serialize and deserialize entire documents.
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
to_json_string
Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json_string()
trigger
unapply_theme
Remove any themed values and restore defaults.
update
Updates the object’s properties from the given keyword arguments.
The following are equivalent:
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
update_from_json
Updates the object’s properties from a JSON attributes dictionary.
json_attributes – (JSON-dict) : attributes and values to update
document
The Document this model is attached to (can be None)
Document
struct
A Bokeh protocol “structure” of this model, i.e. a dict of the form:
{ 'type' : << view model name >> 'id' : << unique model id >> }
Additionally there may be a subtype field if this model is a subtype.
{ "attribution": "", "extra_url_vars": {}, "id": "17550", "initial_resolution": null, "js_event_callbacks": {}, "js_property_callbacks": {}, "max_zoom": 30, "min_zoom": 0, "name": null, "subscribed_events": [], "tags": [], "tile_size": 256, "url": "", "x_origin_offset": null, "y_origin_offset": null }
MercatorTileSource
Bases: bokeh.models.tiles.TileSource
bokeh.models.tiles.TileSource
A base class for Mercator tile services (e.g. WMTSTileSource).
WMTSTileSource
snap_to_zoom
property type: Bool
Bool
Forces initial extents to snap to the closest larger zoom level.
wrap_around
Enables continuous horizontal panning by wrapping the x-axis based on bounds of map.
Axis coordinates are not wrapped. To toggle axis label visibility, use plot.axis.visible = False.
plot.axis.visible = False
{ "attribution": "", "extra_url_vars": {}, "id": "17565", "initial_resolution": 156543.03392804097, "js_event_callbacks": {}, "js_property_callbacks": {}, "max_zoom": 30, "min_zoom": 0, "name": null, "snap_to_zoom": false, "subscribed_events": [], "tags": [], "tile_size": 256, "url": "", "wrap_around": true, "x_origin_offset": 20037508.34, "y_origin_offset": 20037508.34 }
TMSTileSource
Bases: bokeh.models.tiles.MercatorTileSource
bokeh.models.tiles.MercatorTileSource
Contains tile config info and provides urls for tiles based on a templated url e.g. http://your.tms.server.host/{Z}/{X}/{Y}.png. The defining feature of TMS is the tile-origin in located at the bottom-left.
http://your.tms.server.host/{Z}/{X}/{Y}.png
TMSTileSource can also be helpful in implementing tile renderers for custom tile sets, including non-spatial datasets.
{ "attribution": "", "extra_url_vars": {}, "id": "17582", "initial_resolution": 156543.03392804097, "js_event_callbacks": {}, "js_property_callbacks": {}, "max_zoom": 30, "min_zoom": 0, "name": null, "snap_to_zoom": false, "subscribed_events": [], "tags": [], "tile_size": 256, "url": "", "wrap_around": true, "x_origin_offset": 20037508.34, "y_origin_offset": 20037508.34 }
Behaves much like TMSTileSource but has its tile-origin in the top-left.
This is the most common used tile source for web mapping applications. Such companies as Google, MapQuest, Stamen, Esri, and OpenStreetMap provide service which use the WMTS specification e.g. http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png.
http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png
{ "attribution": "", "extra_url_vars": {}, "id": "17599", "initial_resolution": 156543.03392804097, "js_event_callbacks": {}, "js_property_callbacks": {}, "max_zoom": 30, "min_zoom": 0, "name": null, "snap_to_zoom": false, "subscribed_events": [], "tags": [], "tile_size": 256, "url": "", "wrap_around": true, "x_origin_offset": 20037508.34, "y_origin_offset": 20037508.34 }
QUADKEYTileSource
Has the same tile origin as the WMTSTileSource but requests tiles using a quadkey argument instead of X, Y, Z e.g. http://your.quadkey.tile.host/{Q}.png
http://your.quadkey.tile.host/{Q}.png
{ "attribution": "", "extra_url_vars": {}, "id": "17616", "initial_resolution": 156543.03392804097, "js_event_callbacks": {}, "js_property_callbacks": {}, "max_zoom": 30, "min_zoom": 0, "name": null, "snap_to_zoom": false, "subscribed_events": [], "tags": [], "tile_size": 256, "url": "", "wrap_around": true, "x_origin_offset": 20037508.34, "y_origin_offset": 20037508.34 }
BBoxTileSource
Has the same default tile origin as the WMTSTileSource but requested tiles use a {XMIN}, {YMIN}, {XMAX}, {YMAX} e.g. http://your.custom.tile.service?bbox={XMIN},{YMIN},{XMAX},{YMAX}.
{XMIN}
{YMIN}
{XMAX}
{YMAX}
http://your.custom.tile.service?bbox={XMIN},{YMIN},{XMAX},{YMAX}
use_latlon
Flag which indicates option to output {XMIN}, {YMIN}, {XMAX}, {YMAX} in meters or latitude and longitude.
{ "attribution": "", "extra_url_vars": {}, "id": "17633", "initial_resolution": 156543.03392804097, "js_event_callbacks": {}, "js_property_callbacks": {}, "max_zoom": 30, "min_zoom": 0, "name": null, "snap_to_zoom": false, "subscribed_events": [], "tags": [], "tile_size": 256, "url": "", "use_latlon": false, "wrap_around": true, "x_origin_offset": 20037508.34, "y_origin_offset": 20037508.34 }