tools

Bokeh comes with a number of interactive tools.

There are five types of tool interactions:

Pan/Drag

Click/Tap

Scroll/Pinch

Actions

Inspectors

For the first three comprise the category of gesture tools, and only one tool for each gesture can be active at any given time. The active tool is indicated on the toolbar by a highlight next to the tool. Actions are immediate or modal operations that are only activated when their button in the toolbar is pressed. Inspectors are passive tools that merely report information or annotate the plot in some way, and may always be active regardless of what other tools are currently active.

class ActionTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Tool

A base class for tools that are buttons in the toolbar.

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

{
  "description": null, 
  "icon": null, 
  "id": "p63915", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class BoxEditTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: EditTool, Drag, Tap

toolbar icon:

Allows drawing, dragging and deleting box-like glyphs (e.g. Block, Rect, HStrip) on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. When drawing a new box the data will always be added to the ColumnDataSource on the first supplied renderer.

The tool will modify the columns on the data source corresponding to the x, y, width and height values of the glyph. Any additional columns in the data source will be padded with empty_value, when adding a new box.

The supported actions include:

• Add box: Hold shift then click and drag anywhere on the plot or press once to start drawing, move the mouse and press again to finish drawing.

• Move box: Click and drag an existing box, the box will be dropped once you let go of the mouse button.

• Delete box: Tap a box to select it then press BACKSPACE key while the mouse is within the plot area.

To Move or Delete multiple boxes at once:

• Move selection: Select box(es) with SHIFT+tap (or another selection tool) then drag anywhere on the plot. Selecting and then dragging on a specific box will move both.

• Delete selection: Select box(es) with SHIFT+tap (or another selection tool) then press BACKSPACE while the mouse is within the plot area.

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "dimensions": "both", 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63922", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

Padding values overriding ColumnarDataSource.default_values.

Defines values to insert into non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines "x", "y" and "color" columns, adding a new point will add the x and y-coordinates to "x" and "y" columns and the color column will be filled with the defined default value.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions the box drawing is to be free in. By default, users may freely draw boxes with any dimensions. If only “width” is set, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is set, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

The “last resort” padding value.

This is used the same as default_values, when the tool was unable to figure out a default value otherwise. The tool will try the following alternatives in order:

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource’s inferred default values

4. EditTool.empty_value

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

num_objects = 0

Type:

Int

Defines a limit on the number of boxes that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn box will be dropped to make space for the new box being added.

renderers = []

Type:

List

A list of renderers corresponding to glyphs that may be edited.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class BoxSelectTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Drag, RegionSelectTool

toolbar icon:

The box selection tool allows users to make selections on a Plot by showing a rectangular region by dragging the mouse or a finger over the plot area. The end of the drag event indicates the selection region is ready.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

JSON Prototype

{
  "continuous": false, 
  "description": null, 
  "dimensions": "both", 
  "greedy": false, 
  "icon": null, 
  "id": "p63934", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "replace", 
  "name": null, 
  "origin": "corner", 
  "overlay": {
    "attributes": {
      "bottom": {
        "type": "number", 
        "value": "nan"
      }, 
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "handles": {
        "attributes": {
          "all": {
            "attributes": {
              "fill_color": "white", 
              "hover_fill_color": "lightgray"
            }, 
            "id": "p63940", 
            "name": "AreaVisuals", 
            "type": "object"
          }
        }, 
        "id": "p63941", 
        "name": "BoxInteractionHandles", 
        "type": "object"
      }, 
      "left": {
        "type": "number", 
        "value": "nan"
      }, 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "right": {
        "type": "number", 
        "value": "nan"
      }, 
      "syncable": false, 
      "top": {
        "type": "number", 
        "value": "nan"
      }, 
      "visible": false
    }, 
    "id": "p63935", 
    "name": "BoxAnnotation", 
    "type": "object"
  }, 
  "persistent": false, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

continuous = False

Type:

Bool

Whether a selection computation should happen continuously during selection gestures, or only once when the selection region is completed.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions the box selection is to be free in. By default, users may freely draw selections boxes with any dimensions. If only “width” is set, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is set, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.

greedy = False

Type:

Bool

Defines whether a hit against a glyph requires full enclosure within the selection region (non-greedy) or only an intersection (greedy) (i.e. at least one point within the region).

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

mode = 'replace'

Type:

Enum(RegionSelectionMode)

Defines what should happen when a new selection is made. The default is to replace the existing selection. Other options are to append to the selection, intersect with it or subtract from it.

Defines what should happen when a new selection is made.

The default is to replace the existing selection. Other options are to append to the selection, intersect with it, subtract from it or compute a symmetric difference with it.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

origin = 'corner'

Type:

Enum(Enumeration(corner, center))

Indicates whether the rectangular selection area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.

overlay = BoxAnnotation(id='p64014', ...)

Type:

Instance(BoxAnnotation)

A shaded annotation drawn to indicate the selection region.

persistent = False

Type:

Bool

Whether the selection overlay should persist after selection gesture is completed. This can be paired with setting editable = True on the annotation, to allow to modify the selection.

renderers = 'auto'

Type:

Either(Auto, List)

A list of renderers to hit test against. If unset, defaults to all renderers on a plot.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

select_every_mousemove

This is a backwards compatibility alias for the ‘continuous’ property.

Note

Property ‘select_every_mousemove’ was deprecated in Bokeh 3.1.0 and will be removed in the future. Update your code to use ‘continuous’ instead.

class BoxZoomTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Drag

toolbar icon:

The box zoom tool allows users to define a rectangular region of a Plot to zoom to by dragging he mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.

Note

BoxZoomTool is incompatible with GMapPlot due to the manner in which Google Maps exert explicit control over aspect ratios. Adding this tool to a GMapPlot will have no effect.

JSON Prototype

{
  "description": null, 
  "dimensions": "auto", 
  "icon": null, 
  "id": "p64061", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "match_aspect": false, 
  "name": null, 
  "origin": "corner", 
  "overlay": {
    "attributes": {
      "bottom": {
        "type": "number", 
        "value": "nan"
      }, 
      "bottom_units": "canvas", 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "handles": {
        "attributes": {
          "all": {
            "attributes": {
              "fill_color": "white", 
              "hover_fill_color": "lightgray"
            }, 
            "id": "p64067", 
            "name": "AreaVisuals", 
            "type": "object"
          }
        }, 
        "id": "p64068", 
        "name": "BoxInteractionHandles", 
        "type": "object"
      }, 
      "left": {
        "type": "number", 
        "value": "nan"
      }, 
      "left_units": "canvas", 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "right": {
        "type": "number", 
        "value": "nan"
      }, 
      "right_units": "canvas", 
      "syncable": false, 
      "top": {
        "type": "number", 
        "value": "nan"
      }, 
      "top_units": "canvas", 
      "visible": false
    }, 
    "id": "p64062", 
    "name": "BoxAnnotation", 
    "type": "object"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'auto'

Type:

Either(Enum(Dimensions), Auto)

Which dimensions the zoom box is to be free in. By default, users may freely draw zoom boxes with any dimensions. If only “width” is supplied, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is supplied, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

match_aspect = False

Type:

Bool

Whether the box zoom region should be restricted to have the same aspect ratio as the plot region.

Note

If the tool is restricted to one dimension, this value has no effect.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

origin = 'corner'

Type:

Enum(Enumeration(corner, center))

Indicates whether the rectangular zoom area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.

overlay = BoxAnnotation(id='p64125', ...)

Type:

Instance(BoxAnnotation)

A shaded annotation drawn to indicate the selection region.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class ClickPanTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: PlotActionTool

A tool that allows to pan a plot by a fixed amount by clicking a button.

JSON Prototype

{
  "description": null, 
  "direction": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "factor": 0.1, 
  "icon": null, 
  "id": "p64156", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

direction = Undefined

Type:

Required(Enum(PanDirection))

The direction in which to pan the plot.

Accepted values are "left", "right", "up" or "down", or their respective aliases "west", "east", "north", "south".

factor = 0.1

Type:

Percent

Percentage of the range to pan for each usage of the tool.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class CopyTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ActionTool

toolbar icon:

The copy tool is an action tool, that allows copying the rendered contents of a plot or a collection of plots to system’s clipboard. This tools is browser dependent and may not function in certain browsers, or require additional permissions to be granted to the web page.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64165", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class CrosshairTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: InspectTool

toolbar icon:

The crosshair tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector’s menu associated with the toolbar icon shown above.

The crosshair tool draws a crosshair annotation over the plot, centered on the current mouse position. The crosshair tool may be configured to draw across only one dimension by setting the dimension property to only width or height.

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "icon": null, 
  "id": "p64172", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "line_alpha": 1.0, 
  "line_color": "black", 
  "line_width": 1, 
  "name": null, 
  "overlay": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions the crosshair tool is to track. By default, both vertical and horizontal lines will be drawn. If only “width” is supplied, only a horizontal line will be drawn. If only “height” is supplied, only a vertical line will be drawn.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

line_alpha = 1.0

Type:

Alpha

An alpha value to use to stroke paths with.

Acceptable values are floating-point numbers between 0 and 1 (0 being transparent and 1 being opaque).

line_color = 'black'

Type:

Color

A color to use to stroke paths with.

Acceptable values are:

• any of the named CSS colors, e.g 'green', 'indigo'

• RGB(A) hex strings, e.g., '#FF0000', '#44444444'

• CSS4 color strings, e.g., 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', or 'hsl(60deg 100% 50% / 1.0)'

• a 3-tuple of integers (r, g, b) between 0 and 255

• a 4-tuple of (r, g, b, a) where r, g, b are integers between 0 and 255, and a is between 0 and 1

• a 32-bit unsigned integer using the 0xRRGGBBAA byte order pattern

line_width = 1

Type:

Float

Stroke width in units of pixels.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

overlay = 'auto'

Type:

Either(Auto, Instance(Span), Tuple(Instance(Span), Instance(Span)))

An annotation drawn to indicate the crosshair.

If "auto", this will create spans depending on the dimensions property, which based on its value, will result in either one span (horizontal or vertical) or two spans (horizontal and vertical).

Alternatively the user can provide one Span instance, where the dimension is indicated by the dimension property of the Span. Also two Span instances can be provided. Providing explicit Span instances allows for constructing linked crosshair, when those instances are shared between crosshair tools of different plots.

Note

This property is experimental and may change at any point. In particular in future this will allow using other annotations than Span and annotation groups.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

toggleable

This is a backwards compatibility alias for the ‘visible’ property.

Note

Property ‘toggleable’ was deprecated in Bokeh 3.4.0 and will be removed in the future. Update your code to use ‘visible’ instead.

class CustomAction(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ActionTool

Execute a custom action, e.g. CustomJS callback when a toolbar icon is activated.

Example

tool = CustomAction(icon="icon.png",
                    callback=CustomJS(code='alert("foo")'))

plot.add_tools(tool)

JSON Prototype

{
  "callback": null, 
  "description": "Perform a Custom Action", 
  "icon": null, 
  "id": "p64184", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

callback = None

Type:

Nullable(Instance(Callback))

A Bokeh callback to execute when the custom action icon is activated.

description = 'Perform a Custom Action'

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class CustomJSHover(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Model

Define a custom formatter to apply to a hover tool field.

This model can be configured with JavaScript code to format hover tooltips. The JavaScript code has access to the current value to format, some special variables, and any format configured on the tooltip. The variable value will contain the untransformed value. The variable special_vars will provide a dict with the following contents:

• x data-space x-coordinate of the mouse

• y data-space y-coordinate of the mouse

• sx screen-space x-coordinate of the mouse

• sy screen-space y-coordinate of the mouse

• data_x data-space x-coordinate of the hovered glyph

• data_y data-space y-coordinate of the hovered glyph

• indices column indices of all currently hovered glyphs

• name value of the name property of the hovered glyph renderer

If the hover is over a “multi” glyph such as Patches or MultiLine then a segment_index key will also be present.

Finally, the value of the format passed in the tooltip specification is available as the format variable.

Example

As an example, the following code adds a custom formatter to format WebMercator northing coordinates (in meters) as a latitude:

lat_custom = CustomJSHover(code="""
    const projections = Bokeh.require("core/util/projections");
    const x = special_vars.x
    const y = special_vars.y
    const coords = projections.wgs84_mercator.invert(x, y)
    return "" + coords[1]
""")

p.add_tools(HoverTool(
    tooltips=[( 'lat','@y{custom}' )],
    formatters={'@y':lat_custom}
))

Warning

The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

JSON Prototype

{
  "args": {
    "type": "map"
  }, 
  "code": "", 
  "id": "p64192", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

args = {}

Type:

Dict(String, AnyRef)

A mapping of names to Bokeh plot objects. These objects are made available to the callback code snippet as the values of named parameters to the callback.

code = ''

Type:

String

A snippet of JavaScript code to transform a single value. The variable value will contain the untransformed value and can be expected to be present in the function namespace at render time. Additionally, the variable special_vars will be available, and will provide a dict with the following contents:

• x data-space x-coordinate of the mouse

• y data-space y-coordinate of the mouse

• sx screen-space x-coordinate of the mouse

• sy screen-space y-coordinate of the mouse

• data_x data-space x-coordinate of the hovered glyph

• data_y data-space y-coordinate of the hovered glyph

• indices column indices of all currently hovered glyphs

If the hover is over a “multi” glyph such as Patches or MultiLine then a segment_index key will also be present.

Finally, the value of the format passed in the tooltip specification is available as the format variable.

The snippet will be made into the body of a function and therefore requires a return statement.

Example

code = '''
return value + " total"
'''

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class Drag(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: GestureTool

A base class for tools that respond to drag events.

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

{
  "description": null, 
  "icon": null, 
  "id": "p64198", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class EditTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: GestureTool

A base class for all interactive draw tool 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.

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p64205", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

Padding values overriding ColumnarDataSource.default_values.

Defines values to insert into non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines "x", "y" and "color" columns, adding a new point will add the x and y-coordinates to "x" and "y" columns and the color column will be filled with the defined default value.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

The “last resort” padding value.

This is used the same as default_values, when the tool was unable to figure out a default value otherwise. The tool will try the following alternatives in order:

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource’s inferred default values

4. EditTool.empty_value

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class ExamineTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ActionTool

A tool that allows to inspect and configure a model.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64214", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class FreehandDrawTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: EditTool, Drag, Tap

toolbar icon:

Allows freehand drawing of Patches and MultiLine glyphs. The glyph to draw may be defined via the renderers property.

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

The supported actions include:

• Draw vertices: Click and drag to draw a line

• Delete patch/multi-line: Tap a patch/multi-line to select it then press BACKSPACE key while the mouse is within the plot area.

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p64221", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

Padding values overriding ColumnarDataSource.default_values.

Defines values to insert into non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines "x", "y" and "color" columns, adding a new point will add the x and y-coordinates to "x" and "y" columns and the color column will be filled with the defined default value.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

The “last resort” padding value.

This is used the same as default_values, when the tool was unable to figure out a default value otherwise. The tool will try the following alternatives in order:

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource’s inferred default values

4. EditTool.empty_value

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

num_objects = 0

Type:

Int

Defines a limit on the number of patches or multi-lines that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn patch or multi-line will be overwritten when the limit is reached.

renderers = []

Type:

List

A list of renderers corresponding to glyphs that may be edited.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class FullscreenTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ActionTool

A tool that allows to enlarge a UI element to fullscreen.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64232", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class GestureTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Tool

A base class for tools that respond to drag events.

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

{
  "description": null, 
  "icon": null, 
  "id": "p64239", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class HelpTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ActionTool

A button tool to provide a “help” link to users.

The hover text can be customized through the help_tooltip attribute and the redirect site overridden as well.

JSON Prototype

{
  "description": "Click the question mark to learn more about Bokeh plot tools.", 
  "icon": null, 
  "id": "p64246", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "redirect": "https://docs.bokeh.org/en/latest/docs/user_guide/interaction/tools.html", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = 'Click the question mark to learn more about Bokeh plot tools.'

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

redirect = 'https://docs.bokeh.org/en/latest/docs/user_guide/interaction/tools.html'

Type:

String

Site to be redirected through upon click.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class HoverTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: InspectTool

toolbar icon:

The hover tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector’s menu associated with the toolbar icon shown above.

By default, the hover tool displays informational tooltips whenever the cursor is directly over a glyph. The data to show comes from the glyph’s data source, and what to display is configurable with the tooltips property that maps display names to columns in the data source, or to special known variables.

Here is an example of how to configure and use the hover tool:

# Add tooltip (name, field) pairs to the tool. See below for a
# description of possible field values.
hover.tooltips = [
    ("index", "$index"),
    ("(x,y)", "($x, $y)"),
    ("radius", "@radius"),
    ("fill color", "$color[hex, swatch]:fill_color"),
    ("fill color", "$color[hex]:fill_color"),
    ("fill color", "$color:fill_color"),
    ("fill color", "$swatch:fill_color"),
    ("foo", "@foo"),
    ("bar", "@bar"),
    ("baz", "@baz{safe}"),
    ("total", "@total{$0,0.00}"),
]

You can also supply a Callback to the HoverTool, to build custom interactions on hover. In this case you may want to turn the tooltips off by setting tooltips=None.

Warning

When supplying a callback or custom template, the explicit intent of this Bokeh Model is to embed raw HTML and JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.

Hover tool does not currently work with the following glyphs:

annulus arc bezier image_url

oval patch quadratic

ray step text

JSON Prototype

{
  "anchor": "center", 
  "attachment": "horizontal", 
  "callback": null, 
  "description": null, 
  "formatters": {
    "type": "map"
  }, 
  "icon": null, 
  "id": "p64254", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "line_policy": "nearest", 
  "mode": "mouse", 
  "muted_policy": "show", 
  "name": null, 
  "point_policy": "snap_to_data", 
  "renderers": "auto", 
  "show_arrow": true, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tooltips": [
    [
      "index", 
      "$index"
    ], 
    [
      "data (x, y)", 
      "($x, $y)"
    ], 
    [
      "screen (x, y)", 
      "($sx, $sy)"
    ]
  ], 
  "visible": true
}

anchor = 'center'

Type:

Enum(Anchor)

If point policy is set to “snap_to_data”, anchor defines the attachment point of a tooltip. The default is to attach to the center of a glyph.

attachment = 'horizontal'

Type:

Enum(TooltipAttachment)

Whether the tooltip should be displayed to the left or right of the cursor position or above or below it, or if it should be automatically placed in the horizontal or vertical dimension.

callback = None

Type:

Nullable(Instance(Callback))

A callback to run in the browser whenever the input’s value changes. The cb_data parameter that is available to the Callback code will contain two HoverTool specific fields:

Index:

object containing the indices of the hovered points in the data source

Geometry:

object containing the coordinates of the hover cursor

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

formatters = {}

Type:

Dict(String, Either(Enum(TooltipFieldFormatter), Instance(CustomJSHover)))

Specify the formatting scheme for data source columns, e.g.

tool.formatters = {"@date": "datetime"}

will cause format specifications for the “date” column to be interpreted according to the “datetime” formatting scheme. The following schemes are available:

“numeral”:

Provides a wide variety of formats for numbers, currency, bytes, times, and percentages. The full set of formats can be found in the NumeralTickFormatter reference documentation.

“datetime”:

Provides formats for date and time values. The full set of formats is listed in the DatetimeTickFormatter reference documentation.

“printf”:

Provides formats similar to C-style “printf” type specifiers. See the PrintfTickFormatter reference documentation for complete details.

If no formatter is specified for a column name, the default "numeral" formatter is assumed.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

line_policy = 'nearest'

Type:

Enum(Enumeration(prev, next, nearest, interp, none))

Specifies where the tooltip will be positioned when hovering over line glyphs:

“prev”:

between the nearest two adjacent line points, positions the tooltip at the point with the lower (“previous”) index

“next”:

between the nearest two adjacent line points, positions the tooltip at the point with the higher (“next”) index

“nearest”:

between the nearest two adjacent line points, positions the tooltip on the point that is nearest to the mouse cursor location

“interp”:

positions the tooltip at an interpolated point on the segment joining the two nearest adjacent line points.

“none”:

positions the tooltip directly under the mouse cursor location

mode = 'mouse'

Type:

Enum(Enumeration(mouse, hline, vline))

Whether to consider hover pointer as a point (x/y values), or a span on h or v directions.

muted_policy = 'show'

Type:

Enum(Enumeration(show, ignore))

Whether to avoid showing tooltips on muted glyphs.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

point_policy = 'snap_to_data'

Type:

Enum(Enumeration(snap_to_data, follow_mouse, none))

Whether the tooltip position should snap to the “center” (or other anchor) position of the associated glyph, or always follow the current mouse cursor position.

renderers = 'auto'

Type:

Either(Auto, List)

A list of renderers to hit test against. If unset, defaults to all renderers on a plot.

show_arrow = True

Type:

Bool

Whether tooltip’s arrow should be shown.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

tooltips = [('index', '$index'), ('data (x, y)', '($x, $y)'), ('screen (x, y)', '($sx, $sy)')]

Type:

Either(Null, Instance(DOMElement), String, List)

The (name, field) pairs describing what the hover tool should display when there is a hit.

Field names starting with “@” are interpreted as columns on the data source. For instance, “@temp” would look up values to display from the “temp” column of the data source.

Field names starting with “$” are special, known fields:

$index:

index of hovered point in the data source

$name:

value of the name property of the hovered glyph renderer

$x:

x-coordinate under the cursor in data space

$y:

y-coordinate under the cursor in data space

$sx:

x-coordinate under the cursor in screen (canvas) space

$sy:

y-coordinate under the cursor in screen (canvas) space

$color:

color data from data source, with the syntax: $color[options]:field_name. The available options are: hex (to display the color as a hex value), swatch (color data from data source displayed as a small color box)

$swatch:

color data from data source displayed as a small color box

Field names that begin with @ are associated with columns in a ColumnDataSource. For instance the field name "@price" will display values from the "price" column whenever a hover is triggered. If the hover is for the 17th glyph, then the hover tooltip will correspondingly display the 17th price value.

Note that if a column name contains spaces, the it must be supplied by surrounding it in curly braces, e.g. @{adjusted close} will display values from a column named "adjusted close".

Sometimes (especially with stacked charts) it is desirable to allow the name of the column be specified indirectly. The field name @$name is distinguished in that it will look up the name field on the hovered glyph renderer, and use that value as the column name. For instance, if a user hovers with the name "US East", then @$name is equivalent to @{US East}.

By default, values for fields (e.g. @foo) are displayed in a basic numeric format. However it is possible to control the formatting of values more precisely. Fields can be modified by appending a format specified to the end in curly braces. Some examples are below.

"@foo{0,0.000}"    # formats 10000.1234 as: 10,000.123

"@foo{(.00)}"      # formats -10000.1234 as: (10000.123)

"@foo{($ 0.00 a)}" # formats 1230974 as: $ 1.23 m

Specifying a format {safe} after a field name will override automatic escaping of the tooltip data source. Any HTML tags in the data tags will be rendered as HTML in the resulting HoverTool output. See Custom tooltip for a more detailed example.

None is also a valid value for tooltips. This turns off the rendering of tooltips. This is mostly useful when supplying other actions on hover via the callback property.

Note

The tooltips attribute can also be configured with a mapping type, e.g. dict or OrderedDict.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

toggleable

This is a backwards compatibility alias for the ‘visible’ property.

Note

Property ‘toggleable’ was deprecated in Bokeh 3.4.0 and will be removed in the future. Update your code to use ‘visible’ instead.

class InspectTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: GestureTool

A base class for tools that perform “inspections”, e.g. HoverTool.

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

{
  "description": null, 
  "icon": null, 
  "id": "p64272", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

toggleable

This is a backwards compatibility alias for the ‘visible’ property.

Note

Property ‘toggleable’ was deprecated in Bokeh 3.4.0 and will be removed in the future. Update your code to use ‘visible’ instead.

class LassoSelectTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Drag, RegionSelectTool

toolbar icon:

The lasso selection tool allows users to make selections on a Plot by indicating a free-drawn “lasso” region by dragging the mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the SHIFT key while making a selection to append the new selection to any previous selection that might exist.

JSON Prototype

{
  "continuous": true, 
  "description": null, 
  "greedy": false, 
  "icon": null, 
  "id": "p64279", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "replace", 
  "name": null, 
  "overlay": {
    "attributes": {
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "syncable": false, 
      "visible": false, 
      "xs": [], 
      "ys": []
    }, 
    "id": "p64280", 
    "name": "PolyAnnotation", 
    "type": "object"
  }, 
  "persistent": false, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

continuous = True

Type:

Bool

Whether a selection computation should happen continuously during selection gestures, or only once when the selection region is completed.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

greedy = False

Type:

Bool

Defines whether a hit against a glyph requires full enclosure within the selection region (non-greedy) or only an intersection (greedy) (i.e. at least one point within the region).

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

mode = 'replace'

Type:

Enum(RegionSelectionMode)

Defines what should happen when a new selection is made. The default is to replace the existing selection. Other options are to append to the selection, intersect with it or subtract from it.

Defines what should happen when a new selection is made.

The default is to replace the existing selection. Other options are to append to the selection, intersect with it, subtract from it or compute a symmetric difference with it.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

overlay = PolyAnnotation(id='p64295', ...)

Type:

Instance(PolyAnnotation)

A shaded annotation drawn to indicate the selection region.

persistent = False

Type:

Bool

Whether the selection overlay should persist after selection gesture is completed. This can be paired with setting editable = True on the annotation, to allow to modify the selection.

renderers = 'auto'

Type:

Either(Auto, List)

A list of renderers to hit test against. If unset, defaults to all renderers on a plot.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

select_every_mousemove

This is a backwards compatibility alias for the ‘continuous’ property.

Note

Property ‘select_every_mousemove’ was deprecated in Bokeh 3.1.0 and will be removed in the future. Update your code to use ‘continuous’ instead.

class LineEditTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: EditTool, Drag, Tap

toolbar icon:

The LineEditTool allows editing the intersection points of one or more Line glyphs. Glyphs to be edited are defined via the renderers property and a renderer for the intersections is set via the intersection_renderer property (must render a point-like Glyph (a subclass of XYGlyph).

The tool will modify the columns on the data source corresponding to the x and y values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

The supported actions include:

• Show intersections: press an existing line

• Move point: Drag an existing point and let go of the mouse button to release it.

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "dimensions": "both", 
  "empty_value": 0, 
  "icon": null, 
  "id": "p64306", 
  "intersection_renderer": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

Padding values overriding ColumnarDataSource.default_values.

Defines values to insert into non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines "x", "y" and "color" columns, adding a new point will add the x and y-coordinates to "x" and "y" columns and the color column will be filled with the defined default value.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions this edit tool is constrained to act in. By default the line edit tool allows moving points in any dimension, but can be configured to only allow horizontal movement across the width of the plot, or vertical across the height of the plot.

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

The “last resort” padding value.

This is used the same as default_values, when the tool was unable to figure out a default value otherwise. The tool will try the following alternatives in order:

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource’s inferred default values

4. EditTool.empty_value

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

intersection_renderer = Undefined

Type:

TypeOfAttr(Instance(GlyphRenderer))

The renderer used to render the intersections of a selected line

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

renderers = []

Type:

List

A list of renderers corresponding to glyphs that may be edited.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class PanTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Drag

toolbar icon:

The pan tool allows the user to pan a Plot by left-dragging a mouse, or on touch devices by dragging a finger or stylus, across the plot region.

The pan tool also activates the border regions of a Plot for “single axis” panning. For instance, dragging in the vertical border or axis will effect a pan in the vertical direction only, with horizontal dimension kept fixed.

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "icon": null, 
  "id": "p64318", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions the pan tool is constrained to act in. By default the pan tool will pan in any dimension, but can be configured to only pan horizontally across the width of the plot, or vertically across the height of the plot.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class PointDrawTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: EditTool, Drag, Tap

toolbar icon:

The PointDrawTool allows adding, dragging and deleting point-like glyphs (i.e subclasses of XYGlyph) on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. Any newly added points will be inserted on the ColumnDataSource of the first supplied renderer.

The tool will modify the columns on the data source corresponding to the x and y values of the glyph. Any additional columns in the data source will be padded with the given empty_value when adding a new point.

Note

The data source updates will trigger data change events continuously throughout the edit operations on the BokehJS side. In Bokeh server apps, the data source will only be synced once, when the edit operation finishes.

The supported actions include:

• Add point: Tap anywhere on the plot

• Move point: Tap and drag an existing point, the point will be dropped once you let go of the mouse button.

• Delete point: Tap a point to select it then press BACKSPACE key while the mouse is within the plot area.

JSON Prototype

{
  "add": true, 
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "drag": true, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p64326", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

add = True

Type:

Bool

Enables adding of new points on tap events.

default_overrides = {}

Type:

Dict(String, Any)

Padding values overriding ColumnarDataSource.default_values.

Defines values to insert into non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines "x", "y" and "color" columns, adding a new point will add the x and y-coordinates to "x" and "y" columns and the color column will be filled with the defined default value.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

drag = True

Type:

Bool

Enables dragging of existing points on pan events.

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

The “last resort” padding value.

This is used the same as default_values, when the tool was unable to figure out a default value otherwise. The tool will try the following alternatives in order:

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource’s inferred default values

4. EditTool.empty_value

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

num_objects = 0

Type:

Int

Defines a limit on the number of points that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn point will be dropped to make space for the new point.

renderers = []

Type:

List

A list of renderers corresponding to glyphs that may be edited.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class PolyDrawTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: PolyTool, Drag, Tap

toolbar icon:

The PolyDrawTool allows drawing, selecting and deleting Patches and MultiLine glyphs on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly.

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

If a vertex_renderer with an point-like glyph is supplied then the PolyDrawTool will use it to display the vertices of the multi-lines or patches on all supplied renderers. This also enables the ability to snap to existing vertices while drawing.

The supported actions include:

• Add patch or multi-line: press to add the first vertex, then use tap to add each subsequent vertex, to finalize the draw action press to insert the final vertex or press the ESC key.

• Move patch or multi-line: Tap and drag an existing patch/multi-line, the point will be dropped once you let go of the mouse button.

• Delete patch or multi-line: Tap a patch/multi-line to select it then press BACKSPACE key while the mouse is within the plot area.

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "drag": true, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p64339", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "vertex_renderer": null, 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

Padding values overriding ColumnarDataSource.default_values.

Defines values to insert into non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines "x", "y" and "color" columns, adding a new point will add the x and y-coordinates to "x" and "y" columns and the color column will be filled with the defined default value.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

drag = True

Type:

Bool

Enables dragging of existing patches and multi-lines on pan events.

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

The “last resort” padding value.

This is used the same as default_values, when the tool was unable to figure out a default value otherwise. The tool will try the following alternatives in order:

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource’s inferred default values

4. EditTool.empty_value

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

num_objects = 0

Type:

Int

Defines a limit on the number of patches or multi-lines that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn patch or multi-line will be dropped to make space for the new patch or multi-line.

renderers = []

Type:

List

A list of renderers corresponding to glyphs that may be edited.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

vertex_renderer = None

Type:

Nullable(TypeOfAttr(Instance(GlyphRenderer)))

The renderer used to render the vertices of a selected line or polygon.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class PolyEditTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: PolyTool, Drag, Tap

toolbar icon:

The PolyEditTool allows editing the vertices of one or more Patches or MultiLine glyphs. Glyphs to be edited are defined via the renderers property and a renderer for the vertices is set via the vertex_renderer property (must render a point-like Glyph (a subclass of XYGlyph).

The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.

The supported actions include:

• Show vertices: press an existing patch or multi-line

• Add vertex: press an existing vertex to select it, the tool will draw the next point, to add it tap in a new location. To finish editing and add a point press otherwise press the ESC key to cancel.

• Move vertex: Drag an existing vertex and let go of the mouse button to release it.

• Delete vertex: After selecting one or more vertices press BACKSPACE while the mouse cursor is within the plot area.

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p64352", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "vertex_renderer": null, 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

Padding values overriding ColumnarDataSource.default_values.

Defines values to insert into non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines "x", "y" and "color" columns, adding a new point will add the x and y-coordinates to "x" and "y" columns and the color column will be filled with the defined default value.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

The “last resort” padding value.

This is used the same as default_values, when the tool was unable to figure out a default value otherwise. The tool will try the following alternatives in order:

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource’s inferred default values

4. EditTool.empty_value

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

renderers = []

Type:

List

A list of renderers corresponding to glyphs that may be edited.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

vertex_renderer = None

Type:

Nullable(TypeOfAttr(Instance(GlyphRenderer)))

The renderer used to render the vertices of a selected line or polygon.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class PolySelectTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Tap, RegionSelectTool

toolbar icon:

The polygon selection tool allows users to make selections on a Plot by indicating a polygonal region with mouse clicks. single clicks (or taps) add successive points to the definition of the polygon, and a press click (or tap) indicates the selection region is ready.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the SHIFT key while making a selection to append the new selection to any previous selection that might exist.

JSON Prototype

{
  "continuous": false, 
  "description": null, 
  "greedy": false, 
  "icon": null, 
  "id": "p64363", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "replace", 
  "name": null, 
  "overlay": {
    "attributes": {
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "syncable": false, 
      "visible": false, 
      "xs": [], 
      "ys": []
    }, 
    "id": "p64364", 
    "name": "PolyAnnotation", 
    "type": "object"
  }, 
  "persistent": false, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

continuous = False

Type:

Bool

Whether a selection computation should happen continuously during selection gestures, or only once when the selection region is completed.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

greedy = False

Type:

Bool

Defines whether a hit against a glyph requires full enclosure within the selection region (non-greedy) or only an intersection (greedy) (i.e. at least one point within the region).

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

mode = 'replace'

Type:

Enum(RegionSelectionMode)

Defines what should happen when a new selection is made. The default is to replace the existing selection. Other options are to append to the selection, intersect with it or subtract from it.

Defines what should happen when a new selection is made.

The default is to replace the existing selection. Other options are to append to the selection, intersect with it, subtract from it or compute a symmetric difference with it.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

overlay = PolyAnnotation(id='p64379', ...)

Type:

Instance(PolyAnnotation)

A shaded annotation drawn to indicate the selection region.

persistent = False

Type:

Bool

Whether the selection overlay should persist after selection gesture is completed. This can be paired with setting editable = True on the annotation, to allow to modify the selection.

renderers = 'auto'

Type:

Either(Auto, List)

A list of renderers to hit test against. If unset, defaults to all renderers on a plot.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

select_every_mousemove

This is a backwards compatibility alias for the ‘continuous’ property.

Note

Property ‘select_every_mousemove’ was deprecated in Bokeh 3.1.0 and will be removed in the future. Update your code to use ‘continuous’ instead.

class RangeTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Tool

toolbar icon:

The range tool allows the user to update range objects for either or both of the x- or y-dimensions by dragging a corresponding shaded annotation to move it or change its boundaries.

A common use case is to add this tool to a plot with a large fixed range, but to configure the tool range from a different plot. When the user manipulates the overlay, the range of the second plot will be updated automatically.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64390", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "overlay": {
    "attributes": {
      "bottom": {
        "type": "number", 
        "value": "nan"
      }, 
      "bottom_limit": {
        "attributes": {
          "symbol": "bottom", 
          "target": "frame"
        }, 
        "id": "p64394", 
        "name": "Node", 
        "type": "object"
      }, 
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "handles": {
        "attributes": {
          "all": {
            "attributes": {
              "fill_color": "white", 
              "hover_fill_color": "lightgray"
            }, 
            "id": "p64400", 
            "name": "AreaVisuals", 
            "type": "object"
          }
        }, 
        "id": "p64401", 
        "name": "BoxInteractionHandles", 
        "type": "object"
      }, 
      "left": {
        "type": "number", 
        "value": "nan"
      }, 
      "left_limit": {
        "attributes": {
          "symbol": "left", 
          "target": "frame"
        }, 
        "id": "p64391", 
        "name": "Node", 
        "type": "object"
      }, 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        2, 
        2
      ], 
      "line_width": 0.5, 
      "propagate_hover": true, 
      "right": {
        "type": "number", 
        "value": "nan"
      }, 
      "right_limit": {
        "attributes": {
          "symbol": "right", 
          "target": "frame"
        }, 
        "id": "p64392", 
        "name": "Node", 
        "type": "object"
      }, 
      "syncable": false, 
      "top": {
        "type": "number", 
        "value": "nan"
      }, 
      "top_limit": {
        "attributes": {
          "symbol": "top", 
          "target": "frame"
        }, 
        "id": "p64393", 
        "name": "Node", 
        "type": "object"
      }
    }, 
    "id": "p64395", 
    "name": "BoxAnnotation", 
    "type": "object"
  }, 
  "start_gesture": "none", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "x_interaction": true, 
  "x_range": null, 
  "y_interaction": true, 
  "y_range": null
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

overlay = BoxAnnotation(id='p64454', ...)

Type:

Instance(BoxAnnotation)

A shaded annotation drawn to indicate the configured ranges.

start_gesture = 'none'

Type:

Enum(Enumeration(pan, tap, none))

Which gesture will start a range update interaction in a new location.

When the value is "pan", a new range starts at the location where a pointer drag operation begins. The range is updated continuously while the drag operation continues. Ending the drag operation sets the final value of the range.

When the value is "tap", a new range starts at the location where a single tap is made. The range is updated continuously while the pointer moves. Tapping at another location sets the final value of the range.

When the value is "none", only existing range definitions may be updated, by dragging their edges or interiors.

Configuring this property allows to make this tool simultaneously co-exist with another tool that would otherwise share a gesture.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

x_interaction = True

Type:

Bool

Whether to respond to horizontal pan motions when an x_range is present.

By default, when an x_range is specified, it is possible to adjust the horizontal position of the range box by panning horizontally inside the box, or along the top or bottom edge of the box. To disable this, and fix the range box in place horizontally, set to False. (The box will still update if the x_range is updated programmatically.)

x_range = None

Type:

Nullable(Instance(Range))

A range synchronized to the x-dimension of the overlay. If None, the overlay will span the entire x-dimension.

y_interaction = True

Type:

Bool

Whether to respond to vertical pan motions when a y_range is present.

By default, when a y_range is specified, it is possible to adjust the vertical position of the range box by panning vertically inside the box, or along the top or bottom edge of the box. To disable this, and fix the range box in place vertically, set to False. (The box will still update if the y_range is updated programmatically.)

y_range = None

Type:

Nullable(Instance(Range))

A range synchronized to the y-dimension of the overlay. If None, the overlay will span the entire y-dimension.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class RedoTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: PlotActionTool

toolbar icon:

Redo tool reverses the last action performed by undo tool.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64557", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class ResetTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: PlotActionTool

toolbar icon:

The reset tool is an action. When activated in the toolbar, the tool resets the data bounds of the plot to their values when the plot was initially created.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64564", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class SaveTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ActionTool

toolbar icon:

The save tool is an action. When activated, the tool opens a download dialog which allows to save an image reproduction of the plot in PNG format. If automatic download is not support by a web browser, the tool falls back to opening the generated image in a new tab or window. User then can manually save it by right clicking on the image and choosing “Save As” (or similar) menu item.

JSON Prototype

{
  "description": null, 
  "filename": null, 
  "icon": null, 
  "id": "p64571", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

filename = None

Type:

Nullable(String)

Optional string specifying the filename of the saved image (extension not needed). If a filename is not provided or set to None, the user is prompted for a filename at save time.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class Scroll(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: GestureTool

A base class for tools that respond to scroll events.

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

{
  "description": null, 
  "icon": null, 
  "id": "p64579", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class Tap(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: GestureTool

A base class for tools that respond to tap/click events.

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

{
  "description": null, 
  "icon": null, 
  "id": "p64586", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class TapTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Tap, SelectTool

toolbar icon:

The tap selection tool allows the user to select at single points by left-clicking a mouse, or tapping with a finger.

See Selected and unselected glyphs for information on styling selected and unselected glyphs.

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the SHIFT key while making a selection to append the new selection to any previous selection that might exist.

JSON Prototype

{
  "behavior": "select", 
  "callback": null, 
  "description": null, 
  "gesture": "tap", 
  "icon": null, 
  "id": "p64593", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "toggle", 
  "modifiers": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

behavior = 'select'

Type:

Enum(Enumeration(select, inspect))

This tool can be configured to either make selections or inspections on associated data sources. The difference is that selection changes propagate across bokeh and other components (e.g. selection glyph) will be notified. Inspections don’t act like this, so it’s useful to configure callback when setting behavior=’inspect’.

callback = None

Type:

Nullable(Instance(Callback))

A callback to execute whenever a glyph is “hit” by a mouse click or tap.

This is often useful with the OpenURL model to open URLs based on a user clicking or tapping a specific glyph.

However, it may also be a CustomJS which can execute arbitrary JavaScript code in response to clicking or tapping glyphs. The callback will be executed for each individual glyph that is it hit by a click or tap, and will receive the TapTool model as cb_obj. The optional cb_data will have the data source as its .source attribute and the selection geometry as its .geometries attribute.

The .geometries attribute has 5 members. .type is the geometry type, which always a .point for a tap event. .sx and .sy are the screen X and Y coordinates where the tap occurred. .x and .y are the converted data coordinates for the item that has been selected. The .x and .y values are based on the axis assigned to that glyph.

Note

This callback does not execute on every tap, only when a glyph is “hit”. If you would like to execute a callback on every mouse tap, please see js_on_event callback triggers.

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

gesture = 'tap'

Type:

Enum(Enumeration(tap, doubletap))

Specifies which kind of gesture will be used to trigger the tool, either a single or double tap.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

mode = 'toggle'

Type:

Enum(SelectionMode)

Defines what should happen when a new selection is made.

The default is to toggle the existing selection. Other options are to replace the selection, append to it, intersect with it, subtract from it or compute a symmetric difference with it.

modifiers = {}

Type:

Struct

Allows to configure a combination of modifier keys, which need to be pressed during the selected gesture for this tool to trigger.

For example, to accept tap events only when Ctrl and Shift keys are pressed, use:

tool = TapTool(modifiers=dict(ctrl=True, shift=True))
plot.add_tools(tool)

or alternatively using a concise syntax:

tool = TapTool(modifiers="ctrl+shift")
plot.add_tools(tool)

Warning

Configuring modifiers is a platform dependent feature and can make this tool unusable for example on mobile devices.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

renderers = 'auto'

Type:

Either(Auto, List)

A list of renderers to hit test against. If unset, defaults to all renderers on a plot.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class Tool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Model

A base class for all interactive tool 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.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64606", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class ToolProxy(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Model

JSON Prototype

{
  "active": false, 
  "disabled": false, 
  "id": "p64613", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tools": []
}

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class Toolbar(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: UIElement

Collect tools to display for a single plot.

JSON Prototype

{
  "active_drag": "auto", 
  "active_inspect": "auto", 
  "active_multi": "auto", 
  "active_scroll": "auto", 
  "active_tap": "auto", 
  "autohide": false, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "id": "p64617", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "logo": "normal", 
  "name": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tools": [], 
  "visible": true
}

active_drag = 'auto'

Type:

Either(Null, Auto, Instance(Drag), Instance(ToolProxy))

Specify a drag tool to be active when the plot is displayed.

active_inspect = 'auto'

Type:

Either(Null, Auto, Instance(InspectTool), Instance(ToolProxy), Seq(Instance(InspectTool)))

Specify an inspection tool or sequence of inspection tools to be active when the plot is displayed.

active_multi = 'auto'

Type:

Either(Null, Auto, Instance(GestureTool), Instance(ToolProxy))

Specify an active multi-gesture tool, for instance an edit tool or a range tool.

Note that activating a multi-gesture tool will deactivate any other gesture tools as appropriate. For example, if a pan tool is set as the active drag, and this property is set to a BoxEditTool instance, the pan tool will be deactivated (i.e. the multi-gesture tool will take precedence).

active_scroll = 'auto'

Type:

Either(Null, Auto, Instance(Scroll), Instance(ToolProxy))

Specify a scroll/pinch tool to be active when the plot is displayed.

active_tap = 'auto'

Type:

Either(Null, Auto, Instance(Tap), Instance(ToolProxy))

Specify a tap/click tool to be active when the plot is displayed.

autohide = False

Type:

Bool

Whether the toolbar will be hidden by default. Default: False. If True, hides toolbar when cursor is not in canvas.

context_menu = None

Type:

Nullable(Instance(‘.models.ui.Menu’))

A menu to display when user right clicks on the component.

Note

Use shift key when right clicking to display the native context menu.

css_classes = []

Type:

List

A list of additional CSS classes to add to the underlying DOM element.

css_variables = {}

Type:

Dict(String, Instance(Node))

Allows to define dynamically computed CSS variables.

This can be used, for example, to coordinate positioning and styling between canvas’ renderers and/or visuals and HTML-based UI elements.

Variables defined here are equivalent to setting the same variables under :host { ... } in a CSS stylesheet.

Note

This property is experimental and may change at any point.

logo = 'normal'

Type:

Nullable(Enum(Enumeration(normal, grey)))

What version of the Bokeh logo to display on the toolbar. If set to None, no logo will be displayed.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

Inline CSS styles applied to the underlying DOM element.

stylesheets = []

Type:

List

Additional style-sheets to use for the underlying DOM element.

Note that all bokeh’s components use shadow DOM, thus any included style sheets must reflect that, e.g. use :host CSS pseudo selector to access the root DOM element.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

tools = []

Type:

List

A list of tools to add to the plot.

visible = True

Type:

Bool

Whether the component should be displayed on screen.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class UndoTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: PlotActionTool

toolbar icon:

Undo tool allows to restore previous state of the plot.

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p64635", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class WheelPanTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Scroll

toolbar icon:

The wheel pan tool allows the user to pan the plot along the configured dimension using the scroll wheel.

JSON Prototype

{
  "description": null, 
  "dimension": "width", 
  "icon": null, 
  "id": "p64642", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "modifiers": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimension = 'width'

Type:

Enum(Dimension)

Which dimension the wheel pan tool is constrained to act in. By default the wheel pan tool will pan the plot along the x-axis.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

modifiers = {}

Type:

Struct

Allows to configure a combination of modifier keys, which need to be pressed during the selected gesture for this tool to trigger.

For example, to pan only when Ctrl and Shift keys are pressed, use:

tool = WheelPanTool(modifiers=dict(ctrl=True, shift=True))
plot.add_tools(tool)

or alternatively using a concise syntax:

tool = WheelPanTool(modifiers="ctrl+shift")
plot.add_tools(tool)

Note

Setting modifiers allows this tool to be automatically activated, if Toolbar.active_scroll is set to "auto".

Warning

Configuring modifiers is a platform dependent feature and can make this tool unusable for example on mobile devices.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class WheelZoomTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Scroll

toolbar icon:

The wheel zoom tool will zoom the plot in and out, centered on the current mouse location.

The wheel zoom tool also activates the border regions of a Plot for “single axis” zooming. For instance, zooming in the vertical border or axis will effect a zoom in the vertical direction only, with the horizontal dimension kept fixed.

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "hit_test": false, 
  "hit_test_behavior": "only_hit", 
  "hit_test_mode": "point", 
  "icon": null, 
  "id": "p64651", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": 0, 
  "maintain_focus": true, 
  "modifiers": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": "auto", 
  "speed": 0.0016666666666666668, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "zoom_on_axis": true, 
  "zoom_together": "all"
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions the wheel zoom tool is constrained to act in. By default the wheel zoom tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.

hit_test = False

Type:

Bool

Whether to zoom only those renderer that are being pointed at.

This setting only applies when zooming renderers that were configured with sub-coordinates, otherwise it has no effect.

If True, then hit_test_mode property defines how hit testing is performed and hit_test_behavior allows to configure other aspects of this setup. See respective properties for details.

Note

This property is experimental and may change at any point

hit_test_behavior = 'only_hit'

Type:

Either(Instance(GroupBy), Enum(Enumeration(only_hit)))

Allows to configure which renderers will be zoomed when hit_test is enabled.

By default (hit_only) only actually hit renderers will be zoomed. An instance of GroupBy model can be used to tell what other renderers should be zoomed when a given one is hit.

Note

This property is experimental and may change at any point

hit_test_mode = 'point'

Type:

Enum(Enumeration(point, hline, vline))

Allows to configure what geometry to use when hit_test is enabled.

Supported modes are "point" for single point hit testing, and hline and vline for either horizontal or vertical span hit testing.

Note

This property is experimental and may change at any point

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

level = 0

Type:

NonNegative

When working with composite scales (sub-coordinates), this property allows to configure which set of ranges to scale. The default is to scale top-level (frame) ranges.

maintain_focus = True

Type:

Bool

If True, then hitting a range bound in any one dimension will prevent all further zooming all dimensions. If False, zooming can continue independently in any dimension that has not yet reached its bounds, even if that causes overall focus or aspect ratio to change.

modifiers = {}

Type:

Struct

Allows to configure a combination of modifier keys, which need to be pressed during the selected gesture for this tool to trigger.

For example, to zoom only when Ctrl and Shift keys are pressed, use:

tool = WheelZoomTool(modifiers=dict(ctrl=True, shift=True))
plot.add_tools(tool)

or alternatively using a concise syntax:

tool = WheelZoomTool(modifiers="ctrl+shift")
plot.add_tools(tool)

Note

Setting modifiers allows this tool to be automatically activated, if Toolbar.active_scroll is set to "auto".

Warning

Configuring modifiers is a platform dependent feature and can make this tool unusable for example on mobile devices.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

renderers = 'auto'

Type:

Either(Auto, List)

Restrict zoom to ranges used by the provided data renderers. If "auto" then all ranges provided by the cartesian frame will be used.

speed = 0.0016666666666666668

Type:

Float

Speed at which the wheel zooms. Default is 1/600. Optimal range is between 0.001 and 0.09. High values will be clipped. Speed may very between browsers.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

zoom_on_axis = True

Type:

Bool

Whether scrolling on an axis (outside the central plot area) should zoom that dimension. If enabled, the behavior of this feature can be configured with zoom_together property.

zoom_together = 'all'

Type:

Enum(Enumeration(none, cross, all))

Defines the behavior of the tool when zooming on an axis:

• "none"

  zoom only the axis that’s being interacted with. Any cross axes nor any other axes in the dimension of this axis will be affected.

• "cross"

  zoom the axis that’s being interacted with and its cross axis, if configured. No other axes in this or cross dimension will be affected.

• "all"

  zoom all axes in the dimension of the axis that’s being interacted with. All cross axes will be unaffected.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class ZoomInTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ZoomBaseTool

toolbar icon:

The zoom-in tool allows users to click a button to zoom in by a fixed amount.

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "factor": 0.1, 
  "icon": null, 
  "id": "p64669", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": 0, 
  "name": null, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions the zoom tool is constrained to act in. By default the tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.

factor = 0.1

Type:

Percent

Percentage of the range to zoom for each usage of the tool.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

level = 0

Type:

NonNegative

When working with composite scales (sub-coordinates), this property allows to configure which set of ranges to scale. The default is to scale top-level (frame) ranges.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

renderers = 'auto'

Type:

Either(Auto, List)

Restrict zoom to ranges used by the provided data renderers. If "auto" then all ranges provided by the cartesian frame will be used.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)

class ZoomOutTool(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ZoomBaseTool

toolbar icon:

The zoom-out tool allows users to click a button to zoom out by a fixed amount.

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "factor": 0.1, 
  "icon": null, 
  "id": "p64680", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": 0, 
  "maintain_focus": true, 
  "name": null, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

A string describing the purpose of this tool. If not defined, an auto-generated description will be used. This description will be typically presented in the user interface as a tooltip.

dimensions = 'both'

Type:

Enum(Dimensions)

Which dimensions the zoom tool is constrained to act in. By default the tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.

factor = 0.1

Type:

Percent

Percentage of the range to zoom for each usage of the tool.

icon = None

Type:

Nullable(Either(Image, Enum(ToolIcon), Regex))

An icon to display in the toolbar.

The icon can provided as well known tool icon name, a CSS class selector, a data URI with an image/* MIME, a path to an image, a PIL Image object, or an RGB(A) NumPy array. If None, then the intrinsic icon will be used (may depend on tool’s configuration).

level = 0

Type:

NonNegative

When working with composite scales (sub-coordinates), this property allows to configure which set of ranges to scale. The default is to scale top-level (frame) ranges.

maintain_focus = True

Type:

Bool

If True, then hitting a range bound in any one dimension will prevent all further zooming in all dimensions. If False, zooming can continue independently in any dimension that has not yet reached its bounds, even if that causes overall focus or aspect ratio to change.

name = None

Type:

Nullable(String)

An arbitrary, user-supplied name for this model.

This name can be useful when querying the document to retrieve specific Bokeh models.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.

renderers = 'auto'

Type:

Either(Auto, List)

Restrict zoom to ranges used by the provided data renderers. If "auto" then all ranges provided by the cartesian frame will be used.

syncable = True

Type:

Bool

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser. Setting to False may be useful to reduce network traffic when dealing with frequently updated objects whose updated values we don’t need.

Note

Setting this property to False will prevent any on_change() callbacks on this object from triggering. However, any JS-side callbacks will still work.

tags = []

Type:

List

An optional list of arbitrary, user-supplied values to attach to this model.

This data can be useful when querying the document to retrieve specific Bokeh models:

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.

Note

No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.

visible = True

Type:

Bool

Whether a tool button associated with this tool should appear in the toolbar.

apply_theme(property_values: dict[str, Any]) → None

Apply a set of theme values which will be used rather than defaults, but will not override application-set values.

The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).

Parameters:

property_values (dict) – theme values to use in place of defaults

Returns:

None

classmethod clear_extensions() → None

Clear any currently defined custom extensions.

Serialization calls will result in any currently defined custom extensions being included with the generated Document, whether or not there are utilized. This method can be used to clear out all existing custom extension definitions.

clone(**overrides: Any) → Self

Duplicate a HasProps object.

This creates a shallow clone of the original model, i.e. any mutable containers or child models will not be duplicated. Allows to override particular properties while cloning.

classmethod dataspecs() → dict[str, DataSpec]

Collect the names of all DataSpec properties on this class.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of DataSpec properties

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

List of property descriptors in the order of definition.

destroy() → None

Clean up references to the document and property

equals(other: HasProps) → bool

Structural equality of models.

Parameters:

other (HasProps) – the other instance to compare to

Returns:

True, if properties are structurally equal, otherwise False

classmethod from_string(name: str) → Tool

Takes a string and returns a corresponding Tool instance.

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

Link two Bokeh model properties using JavaScript.

This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.

Parameters:

• attr (str) – The name of a Bokeh property on this model

• other (Model) – A Bokeh model to link to self.attr

• other_attr (str) – The property on other to link together

• attr_selector (int | str) – The index to link an item in a subscriptable attr

Added in version 1.1

Raises:

ValueError –

Examples

This code with js_link:

select.js_link('value', plot, 'sizing_mode')

is equivalent to the following:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

which is equivalent to:

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

Attach a CustomJS callback to an arbitrary BokehJS model event.

On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

Find the PropertyDescriptor for a Bokeh property on a class, given the property name.

Parameters:

• name (str) – name of the property to search for

• raises (bool) – whether to raise or return None if missing

Returns:

descriptor for property named name

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

Add a callback on this object to trigger when attr changes.

Parameters:

• attr (str) – an attribute name on this object

• *callbacks (callable) – callback functions to register

Returns:

None

Examples

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

Run callbacks when the specified event occurs on this Model

Not all Events are supported for all Models. See specific Events in bokeh.events for more information on which Models are able to trigger them.

classmethod parameters() → list[Parameter]

Generate Python Parameter values suitable for functions that are derived from the glyph.

Returns:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

Collect the names of properties on this class.

Warning

In a future version of Bokeh, this method will return a dictionary mapping property names to property objects. To future-proof this current usage of this method, wrap the return value in list.

Returns:

property names

classmethod properties_with_refs() → dict[str, Property[Any]]

Collect the names of all properties on this class that also have references.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Returns:

names of properties that have references

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Collect a dict mapping property names to their values.

This method always traverses the class hierarchy and includes properties defined on any parent classes.

Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.

Parameters:

include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)

Returns:

mapping from property names to their values

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

Query the properties values of HasProps instances with a predicate.

Parameters:

• query (callable) – A callable that accepts property descriptors and returns True or False

• include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)

Returns:

mapping of property names and values for matching properties

Return type:

dict

references() → set[Model]

Returns all Models that this object has references to.

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

Remove a callback from this object

select(selector: SelectorType) → Iterable[Model]

Query this object and all of its references for objects that match the given selector.

Parameters:

selector (JSON-like)

Returns:

seq[Model]

select_one(selector: SelectorType) → Model | None

Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like

Returns:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

Set a property value on this object from JSON.

Parameters:

• name (str) – name of the attribute to set

• value (JSON-value) – value to set to the attribute to

• setter (ClientSession or ServerSession or None, optional) –

  This is used to prevent “boomerang” updates to Bokeh apps.

  In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.

Returns:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

Update objects that match a given selector with the specified attribute/value updates.

Parameters:

• selector (JSON-like)

• updates (dict)

Returns:

None

themed_values() → dict[str, Any] | None

Get any theme-provided overrides.

Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.

Returns:

dict or None

to_serializable(serializer: Serializer) → ObjectRefRep

Converts this object to a serializable representation.

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

Remove any themed values and restore defaults.

Returns:

None

update(**kwargs: Any) → None

Updates the object’s properties from the given keyword arguments.

Returns:

None

Examples

The following are equivalent:

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

The Document this model is attached to (can be None)