bokeh.models.renderers

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

class DataRenderer(**kwargs)

Bases: bokeh.models.renderers.Renderer

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

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.

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

{
  "id": "14302",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "glyph",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class GlyphRenderer(**kw)

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.

muted

property type: Bool

muted_glyph

property type: Instance ( Glyph )

nonselection_glyph

property type: Either ( Auto , 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.)

If set to “auto” then a glyph with a low alpha value (0.1) will be used for non-selected points.

selection_glyph

property type: Either ( Auto , Instance ( Glyph ) )

An optional glyph used for selected points.

If set to “auto” then the standard glyph will be used for selected points.

view

property type: Instance ( CDSView )

A view into the data source to use when rendering glyphs. A default view of the entire data source is created when a view is not passed in during initialization.

JSON Prototype

{
  "data_source": null,
  "glyph": null,
  "hover_glyph": null,
  "id": "14305",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "glyph",
  "muted": false,
  "muted_glyph": null,
  "name": null,
  "nonselection_glyph": "auto",
  "selection_glyph": "auto",
  "subscribed_events": [],
  "tags": [],
  "view": {
    "id": "14306",
    "type": "CDSView"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class GraphRenderer(**kwargs)

Bases: bokeh.models.renderers.DataRenderer

edge_renderer

property type: Instance ( GlyphRenderer )

Instance of a GlyphRenderer containing an MultiLine Glyph that will be rendered as the graph edges.

inspection_policy

property type: Instance ( GraphHitTestPolicy )

An instance of a GraphHitTestPolicy that provides the logic for inspection of graph components.

layout_provider

property type: Instance ( LayoutProvider )

An instance of a LayoutProvider that supplies the layout of the network graph in cartesian space.

node_renderer

property type: Instance ( GlyphRenderer )

Instance of a GlyphRenderer containing an XYGlyph that will be rendered as the graph nodes.

selection_policy

property type: Instance ( GraphHitTestPolicy )

An instance of a GraphHitTestPolicy that provides the logic for selection of graph components.

JSON Prototype

{
  "edge_renderer": {
    "id": "14326",
    "type": "GlyphRenderer"
  },
  "id": "14323",
  "inspection_policy": {
    "id": "14329",
    "type": "NodesOnly"
  },
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "layout_provider": null,
  "level": "glyph",
  "name": null,
  "node_renderer": {
    "id": "14332",
    "type": "GlyphRenderer"
  },
  "selection_policy": {
    "id": "14328",
    "type": "NodesOnly"
  },
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

class GuideRenderer(**kwargs)

Bases: bokeh.models.renderers.Renderer

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

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.

JSON Prototype

{
  "id": "14339",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "overlay",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "visible": true
}

class Renderer(**kwargs)

Bases: bokeh.model.Model

An abstract base class for renderer 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.

level

property type: Enum ( RenderLevel )

Specifies the level in which to paint this renderer.

visible

property type: Bool

Is the renderer visible.

JSON Prototype

{
  "id": "14340",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "image",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "visible": true
}

class TileRenderer(**kwargs)

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.

smoothing

property type: Bool

Enable image smoothing for the rendered tiles.

tile_source

property type: Instance ( TileSource )

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

JSON Prototype

{
  "alpha": 1.0,
  "id": "14343",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "glyph",
  "name": null,
  "render_parents": true,
  "smoothing": true,
  "subscribed_events": [],
  "tags": [],
  "tile_source": {
    "id": "14344",
    "type": "WMTSTileSource"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}