bokeh.models.tiles

class TileSource(**kwargs)

Bases: bokeh.model.Model

A base class for all tile source types.

In general, tile sources are used as a required input for TileRenderer.

attribution

property type: String

Data provider attribution content. This can include HTML content.

extra_url_vars

property type: Dict ( String , 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

Resolution (plot_units / pixels) of minimum zoom level of tileset projection. None to auto-compute.

max_zoom

property type: Int

A maximum zoom level for the tile layer. This is the most zoomed-in level.

min_zoom

property type: Int

A minimum zoom level for the tile layer. This is the most zoomed-out level.

tile_size

property type: Int

Tile size in pixels (e.g. 256)

url

property type: String

Tile service url e.g., http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png

x_origin_offset

property type: Float

An x-offset in plot coordinates

y_origin_offset

property type: Float

A y-offset in plot coordinates

JSON Prototype

{
  "attribution": "",
  "extra_url_vars": {},
  "id": "14445",
  "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
}

class MercatorTileSource(**kwargs)

Bases: bokeh.models.tiles.TileSource

A base class for Mercator tile services (e.g. WMTSTileSource).

snap_to_zoom

property type: Bool

Forces initial extents to snap to the closest larger zoom level.

wrap_around

property type: Bool

Enables continuous horizontal panning by wrapping the x-axis based on bounds of map.

..note::

Axis coordinates are not wrapped. To toggle axis label visibility, use plot.axis.visible = False.

JSON Prototype

{
  "attribution": "",
  "extra_url_vars": {},
  "id": "14455",
  "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
}

class TMSTileSource(**kwargs)

Bases: 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.

TMSTileSource can also be helpful in implementing tile renderers for custom tile sets, including non-spatial datasets.

JSON Prototype

{
  "attribution": "",
  "extra_url_vars": {},
  "id": "14458",
  "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
}

class WMTSTileSource(**kwargs)

Bases: bokeh.models.tiles.MercatorTileSource

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.

JSON Prototype

{
  "attribution": "",
  "extra_url_vars": {},
  "id": "14459",
  "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
}

class QUADKEYTileSource(**kwargs)

Bases: bokeh.models.tiles.MercatorTileSource

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

JSON Prototype

{
  "attribution": "",
  "extra_url_vars": {},
  "id": "14460",
  "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
}

class BBoxTileSource(**kwargs)

Bases: bokeh.models.tiles.MercatorTileSource

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}.

use_latlon

property type: Bool

Flag which indicates option to output {XMIN}, {YMIN}, {XMAX}, {YMAX} in meters or latitude and longitude.

JSON Prototype

{
  "attribution": "",
  "extra_url_vars": {},
  "id": "14461",
  "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
}