Anaconda Enterprise: Documentation

# bokeh.models.renderers

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

class `bokeh.models.renderers.``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.

JSON Prototype

    {
      "id": "c12d5c6c-1e40-4a9c-8bc0-d52f04138909",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "level": "image",
      "name": null,
      "subscribed_events": [],
      "tags": [],
      "visible": true
    }

class `bokeh.models.renderers.``DynamicImageRenderer`(*args, **kw)

  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": "a59dbad9-a0e3-46b4-b3a3-7a506eadef8a",
      "image_source": null,
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "level": "underlay",
      "name": null,
      "render_parents": true,
      "subscribed_events": [],
      "tags": [],
      "visible": true
    }

class `bokeh.models.renderers.``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.

  `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": "da47cbc9-7b05-493f-b45e-cf1c542fb8f8",
      "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": "f085c5ff-a8da-4dcf-97cb-2dcf99eeee5d",
        "type": "CDSView"
      },
      "visible": true,
      "x_range_name": "default",
      "y_range_name": "default"
    }

class `bokeh.models.renderers.``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.

  `x_range_name`

    property type: `String`

    A particular (named) x-range to use for computing screen locations when rendering graphs 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 graphs on the plot. If unset, use the default -range.

JSON Prototype

    {
      "edge_renderer": {
        "id": "d6d2b798-1e1f-4fcc-b0a1-592d84bf9b1a",
        "type": "GlyphRenderer"
      },
      "id": "cf651ef4-4abb-44b7-9496-fa17683fc59d",
      "inspection_policy": {
        "id": "e319b055-4554-49b8-b5af-22edd36b80e4",
        "type": "NodesOnly"
      },
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "layout_provider": null,
      "level": "glyph",
      "name": null,
      "node_renderer": {
        "id": "87036920-dda0-49ce-9d26-6d30097a2664",
        "type": "GlyphRenderer"
      },
      "selection_policy": {
        "id": "c20539d4-e48c-4263-8485-34cd7ccd760b",
        "type": "NodesOnly"
      },
      "subscribed_events": [],
      "tags": [],
      "visible": true,
      "x_range_name": "default",
      "y_range_name": "default"
    }

class `bokeh.models.renderers.``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.

  `plot`

    property type: `Instance` ( `Plot` )

    The plot to which this guide renderer is attached.

JSON Prototype

    {
      "id": "9b38235f-419f-435e-8176-b08fd3d08b0c",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "level": "overlay",
      "name": null,
      "plot": null,
      "subscribed_events": [],
      "tags": [],
      "visible": true
    }

class `bokeh.models.renderers.``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": "926d0eb5-51dd-45d0-a02e-cd4dc293e953",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "level": "image",
      "name": null,
      "subscribed_events": [],
      "tags": [],
      "visible": true
    }

class `bokeh.models.renderers.``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.

  `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": "ce0301bb-d586-4f0c-b0b2-dc8f0b4c9733",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "level": "underlay",
      "name": null,
      "render_parents": true,
      "subscribed_events": [],
      "tags": [],
      "tile_source": {
        "id": "ecace77c-0e40-4b9c-b7e0-566459ccc0b6",
        "type": "WMTSTileSource"
      },
      "visible": true,
      "x_range_name": "default",
      "y_range_name": "default"
    }