bokeh.models.selections¶

class IntersectRenderers(**kwargs)[source]¶

Bases: bokeh.models.selections.SelectionPolicy

When a data source is shared between multiple renderers, a row in the data source will only be selected if that point for each renderer is selected. The selection is made from the intersection of hit test results from all renderers.

JSON Prototype

{
  "id": "14353",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class Selection(**kwargs)[source]¶

Bases: bokeh.model.Model

A Selection represents a portion of the data in a DataSource, which can be visually manipulated in a plot.

Selections are typically created by selecting points in a plot with a SelectTool, but can also be programmatically specified.

For most glyphs, the indices property is the relevant value to use.

indices¶

property type: Seq ( Int )

The “scatter” level indices included in a selection. For example, for a selection on a Circle glyph, this list records the indices of whicn individual circles are selected.

For “multi” glyphs such as Patches, MultiLine, MultiPolygons, etc, this list records the indices of which entire sub-items are selected. For example, which indidual polygons of a MultiPolygon are selected.

line_indices¶

property type: Seq ( Int )

The point indices included in a selection on a Line glyph.

This value records the indices of the individual points on a Line that were selected by a selection tool.

multiline_indices¶

property type: Dict ( String , Seq ( Int ) )

The detailed point indices included in a selection on a MultiLine.

This value records which points, on which lines, are part of a seletion on a MulitLine. The keys are the top level indices (i.e., which line) which map to lists of indices (i.e. which points on that line).

If you only need to know which lines are selected, without knowing what individual points on those lines are selected, then you can look at the keys of this dictionary (converted to ints).

JSON Prototype

{
  "id": "14354",
  "indices": [],
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "line_indices": [],
  "multiline_indices": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class SelectionPolicy(**kwargs)[source]¶: Bases: bokeh.model.Model

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": "14358",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class UnionRenderers(**kwargs)[source]¶

Bases: bokeh.models.selections.SelectionPolicy

When a data source is shared between multiple renderers, selecting a point on from any renderer will cause that row in the data source to be selected. The selection is made from the union of hit test results from all renderers.

JSON Prototype

{
  "id": "14359",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}