bokeh.models.renderers

Models (mostly base classes) for the various kinds of renderer types that Bokeh supports.

class DataRenderer(**kwargs)[source]

Bases: bokeh.models.renderers.Renderer

An abstract base class for data renderer types (e.g. GlyphRenderer, TileRenderer).

JSON Prototype
{
  "id": "0e0ca475-8beb-407b-849b-d58ea94bc656",
  "js_callbacks": {},
  "level": "image",
  "name": null,
  "tags": [],
  "visible": true
}
class DynamicImageRenderer(**kwargs)[source]

Bases: bokeh.models.renderers.DataRenderer

alpha

property type: Float

tile opacity 0.0 - 1.0

image_source

property type: Instance ( ImageSource )

Image source to use when rendering on the plot.

render_parents

property type: Bool

Flag enable/disable drawing of parent tiles while waiting for new tiles to arrive. Default value is True.

JSON Prototype
{
  "alpha": 1.0,
  "id": "6e20d8d0-63d3-45d0-8cbd-ebd8509d510a",
  "image_source": null,
  "js_callbacks": {},
  "level": "underlay",
  "name": null,
  "render_parents": true,
  "tags": [],
  "visible": true
}
class GlyphRenderer(**kwargs)[source]

Bases: bokeh.models.renderers.DataRenderer

data_source

property type: Instance ( DataSource )

Local data source to use when rendering glyphs on the plot.

glyph

property type: Instance ( Glyph )

The glyph to render, in conjunction with the supplied data source and ranges.

hover_glyph

property type: Instance ( Glyph )

An optional glyph used for inspected points, e.g., those that are being hovered over by a HoverTool.

nonselection_glyph

property type: Instance ( Glyph )

An optional glyph used for explicitly non-selected points (i.e., non-selected when there are other points that are selected, but not when no points at all are selected.)

selection_glyph

property type: Instance ( Glyph )

An optional glyph used for selected points.

x_range_name

property type: String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name

property type: String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default -range.

JSON Prototype
{
  "data_source": null,
  "glyph": null,
  "hover_glyph": null,
  "id": "666a21a6-f945-43cb-b30b-04c88b8330e2",
  "js_callbacks": {},
  "level": "glyph",
  "name": null,
  "nonselection_glyph": null,
  "selection_glyph": null,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}
class GuideRenderer(**kwargs)[source]

Bases: bokeh.models.renderers.Renderer

A base class for all guide renderer types. GuideRenderer is not generally useful to instantiate on its own.

plot

property type: Instance ( Plot )

The plot to which this guide renderer is attached.

JSON Prototype
{
  "id": "85eed8a9-e35c-49c2-9240-3048383ad8d2",
  "js_callbacks": {},
  "level": "overlay",
  "name": null,
  "plot": null,
  "tags": [],
  "visible": true
}
class Renderer(**kwargs)[source]

Bases: bokeh.model.Model

An abstract base class for renderer types.

level

property type: Enum ( RenderLevel )

Specifies the level in which to paint this renderer.

visible

property type: Bool

Is the renderer visible. Default: True

JSON Prototype
{
  "id": "b2e501cc-fa2c-4b6e-9ae6-595fcbf79466",
  "js_callbacks": {},
  "level": "image",
  "name": null,
  "tags": [],
  "visible": true
}
class TileRenderer(**kwargs)[source]

Bases: bokeh.models.renderers.DataRenderer

alpha

property type: Float

tile opacity 0.0 - 1.0

render_parents

property type: Bool

Flag enable/disable drawing of parent tiles while waiting for new tiles to arrive. Default value is True.

tile_source

property type: Instance ( TileSource )

Local data source to use when rendering glyphs on the plot.

x_range_name

property type: String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name

property type: String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

JSON Prototype
{
  "alpha": 1.0,
  "id": "2f58cead-c0ea-475f-8fde-598f4a79fd8e",
  "js_callbacks": {},
  "level": "underlay",
  "name": null,
  "render_parents": true,
  "tags": [],
  "tile_source": {
    "id": "1504638a-623d-4756-8209-3b8f1eea7549",
    "type": "WMTSTileSource"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}