This docs on this page refers to a PREVIOUS VERSION. For the latest stable release, go to https://docs.bokeh.org/

Archived docs for versions <= 1.0.4 have had to be modified from their original published configuration, and may be missing some features (e.g. source listing)

All users are encourage to update to version 1.1 or later, as soon as they are able.

Bokeh Docs

bokeh.models.widgets.groups

class AbstractGroup(**kwargs)

Bases: bokeh.models.widgets.widget.Widget

Abstract base class for all kinds of groups. AbstractGroup is not generally useful to instantiate on its own.

on_click(handler)

Set up a handler for button check/radio box clicks including the selected indices.

Parameters:handler (func) – handler function to call when button is clicked.
Returns:None
callback

property type: callback:Instance(Callback)

A callback to run in the browser whenever a button group is manipulated.

labels

property type: labels:List(String)

List of text labels contained in this group.

JSON Prototype
{
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "c8782f9c-041e-4991-8df1-3b9188af4093",
  "labels": [],
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}
class ButtonGroup(**kwargs)

Bases: bokeh.models.widgets.groups.AbstractGroup, bokeh.models.widgets.buttons.ButtonLike

Abstract base class for groups with items rendered as buttons. ButtonGroup is not generally useful to instantiate on its own.

JSON Prototype
{
  "button_type": "default",
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "1b195887-721e-4dba-ada5-551277bfc2ef",
  "labels": [],
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}
class CheckboxButtonGroup(**kwargs)

Bases: bokeh.models.widgets.groups.ButtonGroup

A group of check boxes rendered as toggle buttons.

active

property type: active:List(Int)

The list of indices of selected check boxes.

JSON Prototype
{
  "active": [],
  "button_type": "default",
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "24180541-3bec-410c-afa4-243ef1502e1e",
  "labels": [],
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}
class CheckboxGroup(**kwargs)

Bases: bokeh.models.widgets.groups.Group

A group of check boxes.

active

property type: active:List(Int)

The list of indices of selected check boxes.

JSON Prototype
{
  "active": [],
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "ff079639-19e1-4352-beeb-318172ffe822",
  "inline": false,
  "labels": [],
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}
class Group(**kwargs)

Bases: bokeh.models.widgets.groups.AbstractGroup

Abstract base class for groups with items rendered as check/radio boxes.

inline

property type: inline:Bool

Should items be arrange vertically (False) or horizontally in-line (True).

JSON Prototype
{
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "89c7b85c-cb46-41a9-b96a-03be8b32b813",
  "inline": false,
  "labels": [],
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}
class RadioButtonGroup(**kwargs)

Bases: bokeh.models.widgets.groups.ButtonGroup

A group of radio boxes rendered as toggle buttons.

active

property type: active:Int

The index of the selected radio box, or None if nothing is selected.

JSON Prototype
{
  "active": null,
  "button_type": "default",
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "0b1d2421-1a13-42be-beff-c2c87039fa93",
  "labels": [],
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}
class RadioGroup(**kwargs)

Bases: bokeh.models.widgets.groups.Group

A group of radio boxes.

active

property type: active:Int

The index of the selected radio box, or None if nothing is selected.

JSON Prototype
{
  "active": null,
  "callback": null,
  "disabled": false,
  "height": null,
  "id": "f74c194c-269e-4db0-bf8f-37753eadb2a0",
  "inline": false,
  "labels": [],
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}