annotations

Renderers for various kinds of annotations that can be added to Bokeh plots

Annotation

class Annotation(*args, **kwargs)[source]

Bases: bokeh.models.renderers.Renderer

Base class for all annotation models.

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
{
  "coordinates": null,
  "group": null,
  "id": "1009",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Arrow

class Arrow(*args, **kwargs)[source]

Bases: bokeh.models.annotations.DataAnnotation

Render arrows as an annotation.

See Arrows for information on plotting arrows.

JSON Prototype
{
  "coordinates": null,
  "end": {
    "id": "1018"
  },
  "end_units": "data",
  "group": null,
  "id": "1017",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": {
    "value": 1.0
  },
  "line_cap": {
    "value": "butt"
  },
  "line_color": {
    "value": "black"
  },
  "line_dash": {
    "value": []
  },
  "line_dash_offset": {
    "value": 0
  },
  "line_join": {
    "value": "bevel"
  },
  "line_width": {
    "value": 1
  },
  "name": null,
  "source": {
    "id": "1019"
  },
  "start": null,
  "start_units": "data",
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_end": {
    "field": "x_end"
  },
  "x_range_name": "default",
  "x_start": {
    "field": "x_start"
  },
  "y_end": {
    "field": "y_end"
  },
  "y_range_name": "default",
  "y_start": {
    "field": "y_start"
  }
}

Public Data Attributes:

x_start

The x-coordinates to locate the start of the arrows.

y_start

The y-coordinates to locate the start of the arrows.

start_units

The unit type for the start_x and start_y attributes.

start

Instance of ArrowHead.

x_end

The x-coordinates to locate the end of the arrows.

y_end

The y-coordinates to locate the end of the arrows.

end_units

The unit type for the end_x and end_y attributes.

end

Instance of ArrowHead.

line_dash_offset

The line dash offset values for the arrow body.

line_cap

The line cap values for the arrow body.

line_dash

The line dash values for the arrow body.

line_alpha

The line alpha values for the arrow body.

line_join

The line join values for the arrow body.

line_color

The line color values for the arrow body.

line_width

The line width values for the arrow body.

Inherited from : py: class:DataAnnotation

source

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

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


end = OpenHead(id='1021', ...)
Type

Nullable(Instance(ArrowHead))

Instance of ArrowHead.

end_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the end_x and end_y attributes. Interpreted as “data space” units by default.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

line_alpha = 1.0
Type

AlphaSpec

The line alpha values for the arrow body.

line_cap = 'butt'
Type

LineCapSpec

The line cap values for the arrow body.

line_color = 'black'
Type

ColorSpec

The line color values for the arrow body.

line_dash = []
Type

DashPatternSpec

The line dash values for the arrow body.

line_dash_offset = 0
Type

IntSpec

The line dash offset values for the arrow body.

line_join = 'bevel'
Type

LineJoinSpec

The line join values for the arrow body.

line_width = 1
Type

NumberSpec

The line width values for the arrow body.

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.

source = ColumnDataSource(id='1033', ...)
Type

Instance(DataSource)

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

start = None
Type

Nullable(Instance(ArrowHead))

Instance of ArrowHead.

start_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the start_x and start_y attributes. Interpreted as “data space” units by default.

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

Is the renderer visible.

x_end = {'field': 'x_end'}
Type

NumberSpec

The x-coordinates to locate the end of the arrows.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

x_start = {'field': 'x_start'}
Type

NumberSpec

The x-coordinates to locate the start of the arrows.

y_end = {'field': 'y_end'}
Type

NumberSpec

The y-coordinates to locate the end of the arrows.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

y_start = {'field': 'y_start'}
Type

NumberSpec

The y-coordinates to locate the start of the arrows.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Band

class Band(*args, **kwargs)[source]

Bases: bokeh.models.annotations.DataAnnotation

Render a filled area band along a dimension.

See Bands for information on plotting bands.

JSON Prototype
{
  "base": {
    "field": "base"
  },
  "coordinates": null,
  "dimension": "height",
  "fill_alpha": 0.4,
  "fill_color": "#fff9ba",
  "group": null,
  "id": "1045",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 0.3,
  "line_cap": "butt",
  "line_color": "#cccccc",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "lower": {
    "field": "lower"
  },
  "name": null,
  "source": {
    "id": "1046"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "upper": {
    "field": "upper"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

lower_units

Units to use for the associated property: screen or data

lower

The coordinates of the lower portion of the filled area band.

upper_units

Units to use for the associated property: screen or data

upper

The coordinates of the upper portion of the filled area band.

base_units

Units to use for the associated property: screen or data

base

The orthogonal coordinates of the upper and lower values.

dimension

The direction of the band can be specified by setting this property to "height" (y direction) or "width" (x direction).

line_dash_offset

The line dash offset values for the band.

line_cap

The line cap values for the band.

line_dash

The line dash values for the band.

line_alpha

The line alpha values for the band.

line_join

The line join values for the band.

line_color

The line color values for the band.

line_width

The line width values for the band.

fill_color

The fill color values for the band.

fill_alpha

The fill alpha values for the band.

Inherited from : py: class:DataAnnotation

source

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

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


base = {'field': 'base'}
Type

PropertyUnitsSpec

The orthogonal coordinates of the upper and lower values.

base_units = 'data'
Type

Enum(SpatialUnits)

Units to use for the associated property: screen or data

dimension = 'height'
Type

Enum(Dimension)

The direction of the band can be specified by setting this property to “height” (y direction) or “width” (x direction).

fill_alpha = 0.4
Type

Alpha

The fill alpha values for the band.

fill_color = '#fff9ba'
Type

Nullable(Color)

The fill color values for the band.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

line_alpha = 0.3
Type

Alpha

The line alpha values for the band.

line_cap = 'butt'
Type

Enum(LineCap)

The line cap values for the band.

line_color = '#cccccc'
Type

Nullable(Color)

The line color values for the band.

line_dash = []
Type

DashPattern

The line dash values for the band.

line_dash_offset = 0
Type

Int

The line dash offset values for the band.

line_join = 'bevel'
Type

Enum(LineJoin)

The line join values for the band.

line_width = 1
Type

Float

The line width values for the band.

lower = {'field': 'lower'}
Type

PropertyUnitsSpec

The coordinates of the lower portion of the filled area band.

lower_units = 'data'
Type

Enum(SpatialUnits)

Units to use for the associated property: screen or data

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.

source = ColumnDataSource(id='1064', ...)
Type

Instance(DataSource)

Local data source to use when rendering annotations on the 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.

upper = {'field': 'upper'}
Type

PropertyUnitsSpec

The coordinates of the upper portion of the filled area band.

upper_units = 'data'
Type

Enum(SpatialUnits)

Units to use for the associated property: screen or data

visible = True
Type

Bool

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

BoxAnnotation

class BoxAnnotation(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation, bokeh.models.annotations._HasRenderMode

Render a shaded rectangular region as an annotation.

See Box annotations for information on plotting box annotations.

JSON Prototype
{
  "bottom": null,
  "bottom_units": "data",
  "coordinates": null,
  "fill_alpha": 0.4,
  "fill_color": "#fff9ba",
  "group": null,
  "hatch_alpha": 1.0,
  "hatch_color": "black",
  "hatch_extra": {},
  "hatch_pattern": null,
  "hatch_scale": 12.0,
  "hatch_weight": 1.0,
  "id": "1072",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "left": null,
  "left_units": "data",
  "level": "annotation",
  "line_alpha": 0.3,
  "line_cap": "butt",
  "line_color": "#cccccc",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "name": null,
  "render_mode": "canvas",
  "right": null,
  "right_units": "data",
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "top": null,
  "top_units": "data",
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

left

The x-coordinates of the left edge of the box annotation.

left_units

The unit type for the left attribute.

right

The x-coordinates of the right edge of the box annotation.

right_units

The unit type for the right attribute.

bottom

The y-coordinates of the bottom edge of the box annotation.

bottom_units

The unit type for the bottom attribute.

top

The y-coordinates of the top edge of the box annotation.

top_units

The unit type for the top attribute.

line_dash_offset

The line dash offset values for the box.

line_cap

The line cap values for the box.

line_dash

The line dash values for the box.

line_alpha

The line alpha values for the box.

line_join

The line join values for the box.

line_color

The line color values for the box.

line_width

The line width values for the box.

fill_color

The fill color values for the box.

fill_alpha

The fill alpha values for the box.

hatch_color

The hatch color values for the box.

hatch_weight

The hatch weight values for the box.

hatch_extra

The hatch extra values for the box.

hatch_pattern

The hatch pattern values for the box.

hatch_alpha

The hatch alpha values for the box.

hatch_scale

The hatch scale values for the box.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:_HasRenderMode

render_mode

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


bottom = None
Type

Either(Null, Auto, NumberSpec)

The y-coordinates of the bottom edge of the box annotation.

Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch.

bottom_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the bottom attribute. Interpreted as data units by default.

fill_alpha = 0.4
Type

Alpha

The fill alpha values for the box.

fill_color = '#fff9ba'
Type

Nullable(Color)

The fill color values for the box.

hatch_alpha = 1.0
Type

Alpha

The hatch alpha values for the box.

hatch_color = 'black'
Type

Nullable(Color)

The hatch color values for the box.

hatch_extra = {}
Type

Dict(String, Instance(Texture))

The hatch extra values for the box.

hatch_pattern = None
Type

Nullable(String)

The hatch pattern values for the box.

hatch_scale = 12.0
Type

Size

The hatch scale values for the box.

hatch_weight = 1.0
Type

Size

The hatch weight values for the box.

left = None
Type

Either(Null, Auto, NumberSpec)

The x-coordinates of the left edge of the box annotation.

Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch.

left_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the left attribute. Interpreted as data units by default.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

line_alpha = 0.3
Type

Alpha

The line alpha values for the box.

line_cap = 'butt'
Type

Enum(LineCap)

The line cap values for the box.

line_color = '#cccccc'
Type

Nullable(Color)

The line color values for the box.

line_dash = []
Type

DashPattern

The line dash values for the box.

line_dash_offset = 0
Type

Int

The line dash offset values for the box.

line_join = 'bevel'
Type

Enum(LineJoin)

The line join values for the box.

line_width = 1
Type

Float

The line width values for the box.

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.

render_mode = 'canvas'
Type

Enum(RenderMode)

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas. The default mode is “canvas”.

Note

This property is deprecated and will be removed in bokeh 3.0.

Note

The HTML labels won’t be present in the output using the “save” tool.

Warning

Not all visual styling properties are supported if the render_mode is set to “css”. The border_line_dash property isn’t fully supported and border_line_dash_offset isn’t supported at all. Setting text_alpha will modify the opacity of the entire background box and border in addition to the text. Finally, clipping Label annotations inside of the plot area isn’t supported in “css” mode.

right = None
Type

Either(Null, Auto, NumberSpec)

The x-coordinates of the right edge of the box annotation.

Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch.

right_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the right attribute. Interpreted as data units by default.

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.

top = None
Type

Either(Null, Auto, NumberSpec)

The y-coordinates of the top edge of the box annotation.

Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch.

top_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the top attribute. Interpreted as data units by default.

visible = True
Type

Bool

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ColorBar

class ColorBar(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation

Render a color bar based on a color mapper.

See Color bars for information on plotting color bars.

JSON Prototype
{
  "background_fill_alpha": 0.95,
  "background_fill_color": "#ffffff",
  "bar_line_alpha": 1.0,
  "bar_line_cap": "butt",
  "bar_line_color": null,
  "bar_line_dash": [],
  "bar_line_dash_offset": 0,
  "bar_line_join": "bevel",
  "bar_line_width": 1,
  "border_line_alpha": 1.0,
  "border_line_cap": "butt",
  "border_line_color": null,
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "coordinates": null,
  "formatter": "auto",
  "group": null,
  "height": "auto",
  "id": "1104",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "label_standoff": 5,
  "level": "annotation",
  "location": "top_right",
  "major_label_overrides": {},
  "major_label_policy": {
    "id": "1105"
  },
  "major_label_text_align": "left",
  "major_label_text_alpha": 1.0,
  "major_label_text_baseline": "bottom",
  "major_label_text_color": "#444444",
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": "11px",
  "major_label_text_font_style": "normal",
  "major_label_text_line_height": 1.2,
  "major_tick_in": 5,
  "major_tick_line_alpha": 1.0,
  "major_tick_line_cap": "butt",
  "major_tick_line_color": "#ffffff",
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "bevel",
  "major_tick_line_width": 1,
  "major_tick_out": 0,
  "margin": 30,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": 1.0,
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": null,
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "bevel",
  "minor_tick_line_width": 1,
  "minor_tick_out": 0,
  "name": null,
  "orientation": "auto",
  "padding": 10,
  "scale_alpha": 1.0,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "ticker": "auto",
  "title": null,
  "title_standoff": 2,
  "title_text_align": "left",
  "title_text_alpha": 1.0,
  "title_text_baseline": "bottom",
  "title_text_color": "#444444",
  "title_text_font": "helvetica",
  "title_text_font_size": "13px",
  "title_text_font_style": "italic",
  "title_text_line_height": 1.2,
  "visible": true,
  "width": "auto",
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

location

The location where the color bar should draw itself.

orientation

Whether the color bar should be oriented vertically or horizontally.

height

The height (in pixels) that the color scale should occupy.

width

The width (in pixels) that the color scale should occupy.

scale_alpha

The alpha with which to render the color scale.

title

The title text to render.

title_text_font

The text font values for the title text.

title_text_line_height

The text line height values for the title text.

title_text_align

The text align values for the title text.

title_text_baseline

The text baseline values for the title text.

title_text_color

The text color values for the title text.

title_text_alpha

The text alpha values for the title text.

title_text_font_size

The text font size values for the title text.

title_text_font_style

The text font style values for the title text.

title_standoff

The distance (in pixels) to separate the title from the color bar.

ticker

A Ticker to use for computing locations of axis components.

formatter

A TickFormatter to use for formatting the visual appearance of ticks.

major_label_overrides

Provide explicit tick label values for specific tick locations that override normal formatting.

major_label_policy

Allows to filter out labels, e.g.

color_mapper

A color mapper containing a color palette to render.

margin

Amount of margin (in pixels) around the outside of the color bar.

padding

Amount of padding (in pixels) between the color scale and color bar border.

major_label_text_font

The text font of the major tick labels.

major_label_text_line_height

The text line height of the major tick labels.

major_label_text_align

The text align of the major tick labels.

major_label_text_baseline

The text baseline of the major tick labels.

major_label_text_color

The text color of the major tick labels.

major_label_text_alpha

The text alpha of the major tick labels.

major_label_text_font_size

The text font size of the major tick labels.

major_label_text_font_style

The text font style of the major tick labels.

label_standoff

The distance (in pixels) to separate the tick labels from the color bar.

major_tick_line_dash_offset

The line dash offset of the major ticks.

major_tick_line_cap

The line cap of the major ticks.

major_tick_line_dash

The line dash of the major ticks.

major_tick_line_alpha

The line alpha of the major ticks.

major_tick_line_join

The line join of the major ticks.

major_tick_line_color

The line color of the major ticks.

major_tick_line_width

The line width of the major ticks.

major_tick_in

The distance (in pixels) that major ticks should extend into the main plot area.

major_tick_out

The distance (in pixels) that major ticks should extend out of the main plot area.

minor_tick_line_dash_offset

The line dash offset of the minor ticks.

minor_tick_line_cap

The line cap of the minor ticks.

minor_tick_line_dash

The line dash of the minor ticks.

minor_tick_line_alpha

The line alpha of the minor ticks.

minor_tick_line_join

The line join of the minor ticks.

minor_tick_line_color

The line color of the minor ticks.

minor_tick_line_width

The line width of the minor ticks.

minor_tick_in

The distance (in pixels) that minor ticks should extend into the main plot area.

minor_tick_out

The distance (in pixels) that major ticks should extend out of the main plot area.

bar_line_dash_offset

The line dash offset for the color scale bar outline.

bar_line_cap

The line cap for the color scale bar outline.

bar_line_dash

The line dash for the color scale bar outline.

bar_line_alpha

The line alpha for the color scale bar outline.

bar_line_join

The line join for the color scale bar outline.

bar_line_color

The line color for the color scale bar outline.

bar_line_width

The line width for the color scale bar outline.

border_line_dash_offset

The line dash offset for the color bar border outline.

border_line_cap

The line cap for the color bar border outline.

border_line_dash

The line dash for the color bar border outline.

border_line_alpha

The line alpha for the color bar border outline.

border_line_join

The line join for the color bar border outline.

border_line_color

The line color for the color bar border outline.

border_line_width

The line width for the color bar border outline.

background_fill_color

The fill color for the color bar background style.

background_fill_alpha

The fill alpha for the color bar background style.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


background_fill_alpha = 0.95
Type

Alpha

The fill alpha for the color bar background style.

background_fill_color = '#ffffff'
Type

Nullable(Color)

The fill color for the color bar background style.

bar_line_alpha = 1.0
Type

Alpha

The line alpha for the color scale bar outline.

bar_line_cap = 'butt'
Type

Enum(LineCap)

The line cap for the color scale bar outline.

bar_line_color = None
Type

Nullable(Color)

The line color for the color scale bar outline.

bar_line_dash = []
Type

DashPattern

The line dash for the color scale bar outline.

bar_line_dash_offset = 0
Type

Int

The line dash offset for the color scale bar outline.

bar_line_join = 'bevel'
Type

Enum(LineJoin)

The line join for the color scale bar outline.

bar_line_width = 1
Type

Float

The line width for the color scale bar outline.

border_line_alpha = 1.0
Type

Alpha

The line alpha for the color bar border outline.

border_line_cap = 'butt'
Type

Enum(LineCap)

The line cap for the color bar border outline.

border_line_color = None
Type

Nullable(Color)

The line color for the color bar border outline.

border_line_dash = []
Type

DashPattern

The line dash for the color bar border outline.

border_line_dash_offset = 0
Type

Int

The line dash offset for the color bar border outline.

border_line_join = 'bevel'
Type

Enum(LineJoin)

The line join for the color bar border outline.

border_line_width = 1
Type

Float

The line width for the color bar border outline.

color_mapper = Undefined
Type

Instance(ColorMapper)

A color mapper containing a color palette to render.

Warning

If the low and high attributes of the ColorMapper aren’t set, ticks and tick labels won’t be rendered. Additionally, if a LogTicker is passed to the ticker argument and either or both of the logarithms of low and high values of the color_mapper are non-numeric (i.e. low=0), the tick and tick labels won’t be rendered.

formatter = 'auto'
Type

Either(Instance(TickFormatter), Auto)

A TickFormatter to use for formatting the visual appearance of ticks.

height = 'auto'
Type

Either(Auto, Int)

The height (in pixels) that the color scale should occupy.

label_standoff = 5
Type

Int

The distance (in pixels) to separate the tick labels from the color bar.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

location = 'top_right'
Type

Either(Enum(Anchor), Tuple(Float, Float))

The location where the color bar should draw itself. It’s either one of bokeh.core.enums.Anchor’s enumerated values, or a (x, y) tuple indicating an absolute location absolute location in screen coordinates (pixels from the bottom-left corner).

Warning

If the color bar is placed in a side panel, the location will likely have to be set to (0,0).

major_label_overrides = {}
Type

Dict(Either(Float, String), Either(MathString, Instance(BaseText)))

Provide explicit tick label values for specific tick locations that override normal formatting.

major_label_policy = NoOverlap(id='1130', ...)
Type

Instance(LabelingPolicy)

Allows to filter out labels, e.g. declutter labels to avoid overlap.

major_label_text_align = 'left'
Type

Enum(TextAlign)

The text align of the major tick labels.

major_label_text_alpha = 1.0
Type

Alpha

The text alpha of the major tick labels.

major_label_text_baseline = 'bottom'
Type

Enum(TextBaseline)

The text baseline of the major tick labels.

major_label_text_color = '#444444'
Type

Nullable(Color)

The text color of the major tick labels.

major_label_text_font = 'helvetica'
Type

String

The text font of the major tick labels.

major_label_text_font_size = '11px'
Type

FontSize

The text font size of the major tick labels.

major_label_text_font_style = 'normal'
Type

Enum(FontStyle)

The text font style of the major tick labels.

major_label_text_line_height = 1.2
Type

Float

The text line height of the major tick labels.

major_tick_in = 5
Type

Int

The distance (in pixels) that major ticks should extend into the main plot area.

major_tick_line_alpha = 1.0
Type

Alpha

The line alpha of the major ticks.

major_tick_line_cap = 'butt'
Type

Enum(LineCap)

The line cap of the major ticks.

major_tick_line_color = '#ffffff'
Type

Nullable(Color)

The line color of the major ticks.

major_tick_line_dash = []
Type

DashPattern

The line dash of the major ticks.

major_tick_line_dash_offset = 0
Type

Int

The line dash offset of the major ticks.

major_tick_line_join = 'bevel'
Type

Enum(LineJoin)

The line join of the major ticks.

major_tick_line_width = 1
Type

Float

The line width of the major ticks.

major_tick_out = 0
Type

Int

The distance (in pixels) that major ticks should extend out of the main plot area.

margin = 30
Type

Int

Amount of margin (in pixels) around the outside of the color bar.

minor_tick_in = 0
Type

Int

The distance (in pixels) that minor ticks should extend into the main plot area.

minor_tick_line_alpha = 1.0
Type

Alpha

The line alpha of the minor ticks.

minor_tick_line_cap = 'butt'
Type

Enum(LineCap)

The line cap of the minor ticks.

minor_tick_line_color = None
Type

Nullable(Color)

The line color of the minor ticks.

minor_tick_line_dash = []
Type

DashPattern

The line dash of the minor ticks.

minor_tick_line_dash_offset = 0
Type

Int

The line dash offset of the minor ticks.

minor_tick_line_join = 'bevel'
Type

Enum(LineJoin)

The line join of the minor ticks.

minor_tick_line_width = 1
Type

Float

The line width of the minor ticks.

minor_tick_out = 0
Type

Int

The distance (in pixels) that major ticks should extend out of the main plot area.

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.

orientation = 'auto'
Type

Either(Enum(Orientation), Auto)

Whether the color bar should be oriented vertically or horizontally.

padding = 10
Type

Int

Amount of padding (in pixels) between the color scale and color bar border.

scale_alpha = 1.0
Type

Float

The alpha with which to render the color scale.

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.

ticker = 'auto'
Type

Either(Instance(Ticker), Auto)

A Ticker to use for computing locations of axis components.

title = None
Type

Nullable(String)

The title text to render.

title_standoff = 2
Type

Int

The distance (in pixels) to separate the title from the color bar.

title_text_align = 'left'
Type

Enum(TextAlign)

The text align values for the title text.

title_text_alpha = 1.0
Type

Alpha

The text alpha values for the title text.

title_text_baseline = 'bottom'
Type

Enum(TextBaseline)

The text baseline values for the title text.

title_text_color = '#444444'
Type

Nullable(Color)

The text color values for the title text.

title_text_font = 'helvetica'
Type

String

The text font values for the title text.

title_text_font_size = '13px'
Type

FontSize

The text font size values for the title text.

title_text_font_style = 'italic'
Type

Enum(FontStyle)

The text font style values for the title text.

title_text_line_height = 1.2
Type

Float

The text line height values for the title text.

visible = True
Type

Bool

Is the renderer visible.

width = 'auto'
Type

Either(Auto, Int)

The width (in pixels) that the color scale should occupy.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

DataAnnotation

class DataAnnotation(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation

Base class for annotations that utilize a data source.

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
{
  "coordinates": null,
  "group": null,
  "id": "1179",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "source": {
    "id": "1180"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

source

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

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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.

source = ColumnDataSource(id='1184', ...)
Type

Instance(DataSource)

Local data source to use when rendering annotations on the 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

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Label

class Label(*args, **kwargs)[source]

Bases: bokeh.models.annotations.TextAnnotation

Render a single text label as an annotation.

Label will render a single text label at given x and y coordinates, which can be in either screen (pixel) space, or data (axis range) space.

The label can also be configured with a screen space offset from x and y, by using the x_offset and y_offset properties.

Additionally, the label can be rotated with the angle property.

There are also standard text, fill, and line properties to control the appearance of the text, its background, as well as the rectangular bounding box border.

See Labels for information on plotting labels.

JSON Prototype
{
  "angle": 0,
  "angle_units": "rad",
  "background_fill_alpha": 1.0,
  "background_fill_color": null,
  "border_line_alpha": 1.0,
  "border_line_cap": "butt",
  "border_line_color": null,
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "coordinates": null,
  "group": null,
  "id": "1190",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "render_mode": "canvas",
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "text": "",
  "text_align": "left",
  "text_alpha": 1.0,
  "text_baseline": "bottom",
  "text_color": "#444444",
  "text_font": "helvetica",
  "text_font_size": "16px",
  "text_font_style": "normal",
  "text_line_height": 1.2,
  "visible": true,
  "x_offset": 0,
  "x_range_name": "default",
  "x_units": "data",
  "y_offset": 0,
  "y_range_name": "default",
  "y_units": "data"
}

Public Data Attributes:

x

The x-coordinate in screen coordinates to locate the text anchors.

x_units

The unit type for the x attribute.

y

The y-coordinate in screen coordinates to locate the text anchors.

y_units

The unit type for the y attribute.

text

The text value to render.

angle

The angle to rotate the text, as measured from the horizontal.

angle_units

Acceptable values for units are "rad" and "deg"

x_offset

Offset value to apply to the x-coordinate.

y_offset

Offset value to apply to the y-coordinate.

text_font

The text font values for the text.

text_line_height

The text line height values for the text.

text_align

The text align values for the text.

text_baseline

The text baseline values for the text.

text_color

The text color values for the text.

text_alpha

The text alpha values for the text.

text_font_size

The text font size values for the text.

text_font_style

The text font style values for the text.

background_fill_color

The fill color values for the text bounding box.

background_fill_alpha

The fill alpha values for the text bounding box.

border_line_dash_offset

The line dash offset values for the text bounding box.

border_line_cap

The line cap values for the text bounding box.

border_line_dash

The line dash values for the text bounding box.

border_line_alpha

The line alpha values for the text bounding box.

border_line_join

The line join values for the text bounding box.

border_line_color

The line color values for the text bounding box.

border_line_width

The line width values for the text bounding box.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:_HasRenderMode

render_mode

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


angle = 0
Type

Angle

The angle to rotate the text, as measured from the horizontal.

angle_units = 'rad'
Type

Enum(AngleUnits)

Acceptable values for units are "rad" and "deg"

background_fill_alpha = 1.0
Type

Alpha

The fill alpha values for the text bounding box.

background_fill_color = None
Type

Nullable(Color)

The fill color values for the text bounding box.

border_line_alpha = 1.0
Type

Alpha

The line alpha values for the text bounding box.

border_line_cap = 'butt'
Type

Enum(LineCap)

The line cap values for the text bounding box.

border_line_color = None
Type

Nullable(Color)

The line color values for the text bounding box.

border_line_dash = []
Type

DashPattern

The line dash values for the text bounding box.

border_line_dash_offset = 0
Type

Int

The line dash offset values for the text bounding box.

border_line_join = 'bevel'
Type

Enum(LineJoin)

The line join values for the text bounding box.

border_line_width = 1
Type

Float

The line width values for the text bounding box.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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.

render_mode = 'canvas'
Type

Enum(RenderMode)

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas. The default mode is “canvas”.

Note

This property is deprecated and will be removed in bokeh 3.0.

Note

The HTML labels won’t be present in the output using the “save” tool.

Warning

Not all visual styling properties are supported if the render_mode is set to “css”. The border_line_dash property isn’t fully supported and border_line_dash_offset isn’t supported at all. Setting text_alpha will modify the opacity of the entire background box and border in addition to the text. Finally, clipping Label annotations inside of the plot area isn’t supported in “css” mode.

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.

text = ''
Type

String

The text value to render.

text_align = 'left'
Type

Enum(TextAlign)

The text align values for the text.

text_alpha = 1.0
Type

Alpha

The text alpha values for the text.

text_baseline = 'bottom'
Type

Enum(TextBaseline)

The text baseline values for the text.

text_color = '#444444'
Type

Nullable(Color)

The text color values for the text.

text_font = 'helvetica'
Type

String

The text font values for the text.

text_font_size = '16px'
Type

FontSize

The text font size values for the text.

text_font_style = 'normal'
Type

Enum(FontStyle)

The text font style values for the text.

text_line_height = 1.2
Type

Float

The text line height values for the text.

visible = True
Type

Bool

Is the renderer visible.

x = Undefined
Type

NonNullable(Float)

The x-coordinate in screen coordinates to locate the text anchors.

Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch.

x_offset = 0
Type

Float

Offset value to apply to the x-coordinate.

This is useful, for instance, if it is desired to “float” text a fixed distance in screen units from a given data position.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

x_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the x attribute. Interpreted as data units by default.

y = Undefined
Type

NonNullable(Float)

The y-coordinate in screen coordinates to locate the text anchors.

Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch.

y_offset = 0
Type

Float

Offset value to apply to the y-coordinate.

This is useful, for instance, if it is desired to “float” text a fixed distance in screen units from a given data position.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

y_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the y attribute. Interpreted as data units by default.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

LabelSet

class LabelSet(*args, **kwargs)[source]

Bases: bokeh.models.annotations.DataAnnotation, bokeh.models.annotations._HasRenderMode

Render multiple text labels as annotations.

LabelSet will render multiple text labels at given x and y coordinates, which can be in either screen (pixel) space, or data (axis range) space. In this case (as opposed to the single Label model), x and y can also be the name of a column from a ColumnDataSource, in which case the labels will be “vectorized” using coordinate values from the specified columns.

The label can also be configured with a screen space offset from x and y, by using the x_offset and y_offset properties. These offsets may be vectorized by giving the name of a data source column.

Additionally, the label can be rotated with the angle property (which may also be a column name.)

There are also standard text, fill, and line properties to control the appearance of the text, its background, as well as the rectangular bounding box border.

The data source is provided by setting the source property.

JSON Prototype
{
  "angle": {
    "value": 0
  },
  "background_fill_alpha": {
    "value": 1.0
  },
  "background_fill_color": {
    "value": null
  },
  "border_line_alpha": {
    "value": 1.0
  },
  "border_line_cap": {
    "value": "butt"
  },
  "border_line_color": {
    "value": null
  },
  "border_line_dash": {
    "value": []
  },
  "border_line_dash_offset": {
    "value": 0
  },
  "border_line_join": {
    "value": "bevel"
  },
  "border_line_width": {
    "value": 1
  },
  "coordinates": null,
  "group": null,
  "id": "1225",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "render_mode": "canvas",
  "source": {
    "id": "1226"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "text": {
    "field": "text"
  },
  "text_align": {
    "value": "left"
  },
  "text_alpha": {
    "value": 1.0
  },
  "text_baseline": {
    "value": "bottom"
  },
  "text_color": {
    "value": "#444444"
  },
  "text_font": {
    "value": "helvetica"
  },
  "text_font_size": {
    "value": "16px"
  },
  "text_font_style": {
    "value": "normal"
  },
  "text_line_height": {
    "value": 1.2
  },
  "visible": true,
  "x": {
    "field": "x"
  },
  "x_offset": {
    "value": 0
  },
  "x_range_name": "default",
  "x_units": "data",
  "y": {
    "field": "y"
  },
  "y_offset": {
    "value": 0
  },
  "y_range_name": "default",
  "y_units": "data"
}

Public Data Attributes:

x

The x-coordinates to locate the text anchors.

x_units

The unit type for the xs attribute.

y

The y-coordinates to locate the text anchors.

y_units

The unit type for the ys attribute.

text

The text values to render.

angle_units

Units to use for the associated property: deg, rad, grad or turn

angle

The angles to rotate the text, as measured from the horizontal.

x_offset

Offset values to apply to the x-coordinates.

y_offset

Offset values to apply to the y-coordinates.

text_font

The text font values for the text.

text_line_height

The text line height values for the text.

text_align

The text align values for the text.

text_baseline

The text baseline values for the text.

text_color

The text color values for the text.

text_alpha

The text alpha values for the text.

text_font_size

The text font size values for the text.

text_font_style

The text font style values for the text.

background_fill_color

The fill color values for the text bounding box.

background_fill_alpha

The fill alpha values for the text bounding box.

border_line_dash_offset

The line dash offset values for the text bounding box.

border_line_cap

The line cap values for the text bounding box.

border_line_dash

The line dash values for the text bounding box.

border_line_alpha

The line alpha values for the text bounding box.

border_line_join

The line join values for the text bounding box.

border_line_color

The line color values for the text bounding box.

border_line_width

The line width values for the text bounding box.

Inherited from : py: class:DataAnnotation

source

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

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:_HasRenderMode

render_mode

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


angle = 0
Type

AngleSpec

The angles to rotate the text, as measured from the horizontal.

angle_units = 'rad'
Type

Enum(AngleUnits)

Units to use for the associated property: deg, rad, grad or turn

background_fill_alpha = 1.0
Type

AlphaSpec

The fill alpha values for the text bounding box.

background_fill_color = None
Type

ColorSpec

The fill color values for the text bounding box.

border_line_alpha = 1.0
Type

AlphaSpec

The line alpha values for the text bounding box.

border_line_cap = 'butt'
Type

LineCapSpec

The line cap values for the text bounding box.

border_line_color = None
Type

ColorSpec

The line color values for the text bounding box.

border_line_dash = []
Type

DashPatternSpec

The line dash values for the text bounding box.

border_line_dash_offset = 0
Type

IntSpec

The line dash offset values for the text bounding box.

border_line_join = 'bevel'
Type

LineJoinSpec

The line join values for the text bounding box.

border_line_width = 1
Type

NumberSpec

The line width values for the text bounding box.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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.

render_mode = 'canvas'
Type

Enum(RenderMode)

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas. The default mode is “canvas”.

Note

This property is deprecated and will be removed in bokeh 3.0.

Note

The HTML labels won’t be present in the output using the “save” tool.

Warning

Not all visual styling properties are supported if the render_mode is set to “css”. The border_line_dash property isn’t fully supported and border_line_dash_offset isn’t supported at all. Setting text_alpha will modify the opacity of the entire background box and border in addition to the text. Finally, clipping Label annotations inside of the plot area isn’t supported in “css” mode.

source = ColumnDataSource(id='1242', ...)
Type

Instance(DataSource)

Local data source to use when rendering annotations on the 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.

text = {'field': 'text'}
Type

StringSpec

The text values to render.

text_align = 'left'
Type

TextAlignSpec

The text align values for the text.

text_alpha = 1.0
Type

AlphaSpec

The text alpha values for the text.

text_baseline = 'bottom'
Type

TextBaselineSpec

The text baseline values for the text.

text_color = '#444444'
Type

ColorSpec

The text color values for the text.

text_font = {'value': 'helvetica'}
Type

StringSpec

The text font values for the text.

text_font_size = {'value': '16px'}
Type

FontSizeSpec

The text font size values for the text.

text_font_style = 'normal'
Type

FontStyleSpec

The text font style values for the text.

text_line_height = 1.2
Type

NumberSpec

The text line height values for the text.

visible = True
Type

Bool

Is the renderer visible.

x = {'field': 'x'}
Type

NumberSpec

The x-coordinates to locate the text anchors.

x_offset = 0
Type

NumberSpec

Offset values to apply to the x-coordinates.

This is useful, for instance, if it is desired to “float” text a fixed distance in screen units from a given data position.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

x_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the xs attribute. Interpreted as data units by default.

y = {'field': 'y'}
Type

NumberSpec

The y-coordinates to locate the text anchors.

y_offset = 0
Type

NumberSpec

Offset values to apply to the y-coordinates.

This is useful, for instance, if it is desired to “float” text a fixed distance in screen units from a given data position.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

y_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the ys attribute. Interpreted as data units by default.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Legend

class Legend(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation

Render informational legends for a plot.

See Legends for information on plotting legends.

JSON Prototype
{
  "background_fill_alpha": 0.95,
  "background_fill_color": "#ffffff",
  "border_line_alpha": 0.5,
  "border_line_cap": "butt",
  "border_line_color": "#e5e5e5",
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "click_policy": "none",
  "coordinates": null,
  "glyph_height": 20,
  "glyph_width": 20,
  "group": null,
  "id": "1263",
  "inactive_fill_alpha": 0.7,
  "inactive_fill_color": "white",
  "items": [],
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "label_height": 20,
  "label_standoff": 5,
  "label_text_align": "left",
  "label_text_alpha": 1.0,
  "label_text_baseline": "middle",
  "label_text_color": "#444444",
  "label_text_font": "helvetica",
  "label_text_font_size": "13px",
  "label_text_font_style": "normal",
  "label_text_line_height": 1.2,
  "label_width": 20,
  "level": "annotation",
  "location": "top_right",
  "margin": 10,
  "name": null,
  "orientation": "vertical",
  "padding": 10,
  "spacing": 3,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "title": null,
  "title_standoff": 5,
  "title_text_align": "left",
  "title_text_alpha": 1.0,
  "title_text_baseline": "bottom",
  "title_text_color": "#444444",
  "title_text_font": "helvetica",
  "title_text_font_size": "13px",
  "title_text_font_style": "italic",
  "title_text_line_height": 1.2,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

location

The location where the legend should draw itself.

orientation

Whether the legend entries should be placed vertically or horizontally when they are drawn.

title

The title text to render.

title_text_font

The text font values for the title text.

title_text_line_height

The text line height values for the title text.

title_text_align

The text align values for the title text.

title_text_baseline

The text baseline values for the title text.

title_text_color

The text color values for the title text.

title_text_alpha

The text alpha values for the title text.

title_text_font_size

The text font size values for the title text.

title_text_font_style

The text font style values for the title text.

title_standoff

The distance (in pixels) to separate the title from the legend.

border_line_dash_offset

The line dash offset for the legend border outline.

border_line_cap

The line cap for the legend border outline.

border_line_dash

The line dash for the legend border outline.

border_line_alpha

The line alpha for the legend border outline.

border_line_join

The line join for the legend border outline.

border_line_color

The line color for the legend border outline.

border_line_width

The line width for the legend border outline.

background_fill_color

The fill color for the legend background style.

background_fill_alpha

The fill alpha for the legend background style.

inactive_fill_color

The fill color for the legend item style when inactive.

inactive_fill_alpha

The fill alpha for the legend item style when inactive.

click_policy

Defines what happens when a lengend's item is clicked.

label_text_font

The text font for the legend labels.

label_text_line_height

The text line height for the legend labels.

label_text_align

The text align for the legend labels.

label_text_baseline

The text baseline for the legend labels.

label_text_color

The text color for the legend labels.

label_text_alpha

The text alpha for the legend labels.

label_text_font_size

The text font size for the legend labels.

label_text_font_style

The text font style for the legend labels.

label_standoff

The distance (in pixels) to separate the label from its associated glyph.

label_height

The minimum height (in pixels) of the area that legend labels should occupy.

label_width

The minimum width (in pixels) of the area that legend labels should occupy.

glyph_height

The height (in pixels) that the rendered legend glyph should occupy.

glyph_width

The width (in pixels) that the rendered legend glyph should occupy.

margin

Amount of margin around the legend.

padding

Amount of padding around the contents of the legend.

spacing

Amount of spacing (in pixels) between legend entries.

items

A list of LegendItem instances to be rendered in the legend.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


background_fill_alpha = 0.95
Type

Alpha

The fill alpha for the legend background style.

background_fill_color = '#ffffff'
Type

Nullable(Color)

The fill color for the legend background style.

border_line_alpha = 0.5
Type

Alpha

The line alpha for the legend border outline.

border_line_cap = 'butt'
Type

Enum(LineCap)

The line cap for the legend border outline.

border_line_color = '#e5e5e5'
Type

Nullable(Color)

The line color for the legend border outline.

border_line_dash = []
Type

DashPattern

The line dash for the legend border outline.

border_line_dash_offset = 0
Type

Int

The line dash offset for the legend border outline.

border_line_join = 'bevel'
Type

Enum(LineJoin)

The line join for the legend border outline.

border_line_width = 1
Type

Float

The line width for the legend border outline.

click_policy = 'none'
Type

Enum(LegendClickPolicy)

Defines what happens when a lengend’s item is clicked.

glyph_height = 20
Type

Int

The height (in pixels) that the rendered legend glyph should occupy.

glyph_width = 20
Type

Int

The width (in pixels) that the rendered legend glyph should occupy.

inactive_fill_alpha = 0.7
Type

Alpha

The fill alpha for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).

inactive_fill_color = 'white'
Type

Nullable(Color)

The fill color for the legend item style when inactive. These control an overlay on the item that can be used to obscure it when the corresponding glyph is inactive (e.g. by making it semi-transparent).

items = []
Type

List

A list of LegendItem instances to be rendered in the legend.

This can be specified explicitly, for instance:

legend = Legend(items=[
    LegendItem(label="sin(x)"   , renderers=[r0, r1]),
    LegendItem(label="2*sin(x)" , renderers=[r2]),
    LegendItem(label="3*sin(x)" , renderers=[r3, r4])
])

But as a convenience, can also be given more compactly as a list of tuples:

legend = Legend(items=[
    ("sin(x)"   , [r0, r1]),
    ("2*sin(x)" , [r2]),
    ("3*sin(x)" , [r3, r4])
])

where each tuple is of the form: (label, renderers).

label_height = 20
Type

Int

The minimum height (in pixels) of the area that legend labels should occupy.

label_standoff = 5
Type

Int

The distance (in pixels) to separate the label from its associated glyph.

label_text_align = 'left'
Type

Enum(TextAlign)

The text align for the legend labels.

label_text_alpha = 1.0
Type

Alpha

The text alpha for the legend labels.

label_text_baseline = 'middle'
Type

Enum(TextBaseline)

The text baseline for the legend labels.

label_text_color = '#444444'
Type

Nullable(Color)

The text color for the legend labels.

label_text_font = 'helvetica'
Type

String

The text font for the legend labels.

label_text_font_size = '13px'
Type

FontSize

The text font size for the legend labels.

label_text_font_style = 'normal'
Type

Enum(FontStyle)

The text font style for the legend labels.

label_text_line_height = 1.2
Type

Float

The text line height for the legend labels.

label_width = 20
Type

Int

The minimum width (in pixels) of the area that legend labels should occupy.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

location = 'top_right'
Type

Either(Enum(Anchor), Tuple(Float, Float))

The location where the legend should draw itself. It’s either one of bokeh.core.enums.LegendLocation’s enumerated values, or a (x, y) tuple indicating an absolute location absolute location in screen coordinates (pixels from the bottom-left corner).

margin = 10
Type

Int

Amount of margin around the legend.

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.

orientation = 'vertical'
Type

Enum(Orientation)

Whether the legend entries should be placed vertically or horizontally when they are drawn.

padding = 10
Type

Int

Amount of padding around the contents of the legend. Only applicable when border is visible, otherwise collapses to 0.

spacing = 3
Type

Int

Amount of spacing (in pixels) between legend entries.

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.

title = None
Type

Nullable(String)

The title text to render.

title_standoff = 5
Type

Int

The distance (in pixels) to separate the title from the legend.

title_text_align = 'left'
Type

Enum(TextAlign)

The text align values for the title text.

title_text_alpha = 1.0
Type

Alpha

The text alpha values for the title text.

title_text_baseline = 'bottom'
Type

Enum(TextBaseline)

The text baseline values for the title text.

title_text_color = '#444444'
Type

Nullable(Color)

The text color values for the title text.

title_text_font = 'helvetica'
Type

String

The text font values for the title text.

title_text_font_size = '13px'
Type

FontSize

The text font size values for the title text.

title_text_font_style = 'italic'
Type

Enum(FontStyle)

The text font style values for the title text.

title_text_line_height = 1.2
Type

Float

The text line height values for the title text.

visible = True
Type

Bool

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

LegendItem

class LegendItem(*args, **kwargs)[source]

Bases: bokeh.model.model.Model

JSON Prototype
{
  "id": "1312",
  "index": null,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "label": {
    "value": null
  },
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true
}

Public Data Attributes:

label

A label for this legend.

renderers

A list of the glyph renderers to draw in the legend.

index

The column data index to use for drawing the representative items.

visible

Whether the legend item should be displayed.

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

__init__(*args, **kwargs)

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(*args, **kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(*args, **kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(*args, **kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(*args, **kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(*args, **kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


index = None
Type

Nullable(Int)

The column data index to use for drawing the representative items.

If None (the default), then Bokeh will automatically choose an index to use. If the label does not refer to a data column name, this is typically the first data point in the data source. Otherwise, if the label does refer to a column name, the legend will have “groupby” behavior, and will choose and display representative points from every “group” in the column.

If set to a number, Bokeh will use that number as the index in all cases.

label = None
Type

NullStringSpec

A label for this legend. Can be a string, or a column of a ColumnDataSource. If label is a field, then it must be in the renderers’ data_source.

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 the glyph renderers to draw in the legend. If label is a field, then all data_sources of renderers must be the same.

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 the legend item should be displayed. See Hiding legend items in the user guide.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

PolyAnnotation

class PolyAnnotation(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation

Render a shaded polygonal region as an annotation.

See Polygon annotations for information on plotting polygon annotations.

JSON Prototype
{
  "coordinates": null,
  "fill_alpha": 0.4,
  "fill_color": "#fff9ba",
  "group": null,
  "hatch_alpha": 1.0,
  "hatch_color": "black",
  "hatch_extra": {},
  "hatch_pattern": null,
  "hatch_scale": 12.0,
  "hatch_weight": 1.0,
  "id": "1320",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 0.3,
  "line_cap": "butt",
  "line_color": "#cccccc",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "xs": [],
  "xs_units": "data",
  "y_range_name": "default",
  "ys": [],
  "ys_units": "data"
}

Public Data Attributes:

xs

The x-coordinates of the region to draw.

xs_units

The unit type for the xs attribute.

ys

The y-coordinates of the region to draw.

ys_units

The unit type for the ys attribute.

line_dash_offset

The line dash offset values for the polygon.

line_cap

The line cap values for the polygon.

line_dash

The line dash values for the polygon.

line_alpha

The line alpha values for the polygon.

line_join

The line join values for the polygon.

line_color

The line color values for the polygon.

line_width

The line width values for the polygon.

fill_color

The fill color values for the polygon.

fill_alpha

The fill alpha values for the polygon.

hatch_color

The hatch color values for the polygon.

hatch_weight

The hatch weight values for the polygon.

hatch_extra

The hatch extra values for the polygon.

hatch_pattern

The hatch pattern values for the polygon.

hatch_alpha

The hatch alpha values for the polygon.

hatch_scale

The hatch scale values for the polygon.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


fill_alpha = 0.4
Type

Alpha

The fill alpha values for the polygon.

fill_color = '#fff9ba'
Type

Nullable(Color)

The fill color values for the polygon.

hatch_alpha = 1.0
Type

Alpha

The hatch alpha values for the polygon.

hatch_color = 'black'
Type

Nullable(Color)

The hatch color values for the polygon.

hatch_extra = {}
Type

Dict(String, Instance(Texture))

The hatch extra values for the polygon.

hatch_pattern = None
Type

Nullable(String)

The hatch pattern values for the polygon.

hatch_scale = 12.0
Type

Size

The hatch scale values for the polygon.

hatch_weight = 1.0
Type

Size

The hatch weight values for the polygon.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

line_alpha = 0.3
Type

Alpha

The line alpha values for the polygon.

line_cap = 'butt'
Type

Enum(LineCap)

The line cap values for the polygon.

line_color = '#cccccc'
Type

Nullable(Color)

The line color values for the polygon.

line_dash = []
Type

DashPattern

The line dash values for the polygon.

line_dash_offset = 0
Type

Int

The line dash offset values for the polygon.

line_join = 'bevel'
Type

Enum(LineJoin)

The line join values for the polygon.

line_width = 1
Type

Float

The line width values for the polygon.

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

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

xs = []
Type

Seq(Float)

The x-coordinates of the region to draw.

xs_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the xs attribute. Interpreted as data units by default.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

ys = []
Type

Seq(Float)

The y-coordinates of the region to draw.

ys_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the ys attribute. Interpreted as data units by default.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Slope

class Slope(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation

Render a sloped line as an annotation.

See Slopes for information on plotting slopes.

JSON Prototype
{
  "coordinates": null,
  "gradient": null,
  "group": null,
  "id": "1347",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 1.0,
  "line_cap": "butt",
  "line_color": "black",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_intercept": null,
  "y_range_name": "default"
}

Public Data Attributes:

gradient

The gradient of the line, in data units

y_intercept

The y intercept of the line, in data units

line_dash_offset

The line dash offset values for the line.

line_cap

The line cap values for the line.

line_dash

The line dash values for the line.

line_alpha

The line alpha values for the line.

line_join

The line join values for the line.

line_color

The line color values for the line.

line_width

The line width values for the line.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


gradient = None
Type

Nullable(Float)

The gradient of the line, in data units

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

line_alpha = 1.0
Type

Alpha

The line alpha values for the line.

line_cap = 'butt'
Type

Enum(LineCap)

The line cap values for the line.

line_color = 'black'
Type

Nullable(Color)

The line color values for the line.

line_dash = []
Type

DashPattern

The line dash values for the line.

line_dash_offset = 0
Type

Int

The line dash offset values for the line.

line_join = 'bevel'
Type

Enum(LineJoin)

The line join values for the line.

line_width = 1
Type

Float

The line width values for the 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.

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

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_intercept = None
Type

Nullable(Float)

The y intercept of the line, in data units

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Span

class Span(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation, bokeh.models.annotations._HasRenderMode

Render a horizontal or vertical line span.

See Spans for information on plotting spans.

JSON Prototype
{
  "coordinates": null,
  "dimension": "width",
  "group": null,
  "id": "1364",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 1.0,
  "line_cap": "butt",
  "line_color": "black",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "location": null,
  "location_units": "data",
  "name": null,
  "render_mode": "canvas",
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

location

The location of the span, along dimension.

location_units

The unit type for the location attribute.

dimension

The direction of the span can be specified by setting this property to "height" (y direction) or "width" (x direction).

line_dash_offset

The line dash offset values for the span.

line_cap

The line cap values for the span.

line_dash

The line dash values for the span.

line_alpha

The line alpha values for the span.

line_join

The line join values for the span.

line_color

The line color values for the span.

line_width

The line width values for the span.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:_HasRenderMode

render_mode

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


dimension = 'width'
Type

Enum(Dimension)

The direction of the span can be specified by setting this property to “height” (y direction) or “width” (x direction).

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

line_alpha = 1.0
Type

Alpha

The line alpha values for the span.

line_cap = 'butt'
Type

Enum(LineCap)

The line cap values for the span.

line_color = 'black'
Type

Nullable(Color)

The line color values for the span.

line_dash = []
Type

DashPattern

The line dash values for the span.

line_dash_offset = 0
Type

Int

The line dash offset values for the span.

line_join = 'bevel'
Type

Enum(LineJoin)

The line join values for the span.

line_width = 1
Type

Float

The line width values for the span.

location = None
Type

Nullable(Float)

The location of the span, along dimension.

Datetime values are also accepted, but note that they are immediately converted to milliseconds-since-epoch.

location_units = 'data'
Type

Enum(SpatialUnits)

The unit type for the location attribute. Interpreted as “data space” units by default.

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.

render_mode = 'canvas'
Type

Enum(RenderMode)

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas. The default mode is “canvas”.

Note

This property is deprecated and will be removed in bokeh 3.0.

Note

The HTML labels won’t be present in the output using the “save” tool.

Warning

Not all visual styling properties are supported if the render_mode is set to “css”. The border_line_dash property isn’t fully supported and border_line_dash_offset isn’t supported at all. Setting text_alpha will modify the opacity of the entire background box and border in addition to the text. Finally, clipping Label annotations inside of the plot area isn’t supported in “css” mode.

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

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

TextAnnotation

class TextAnnotation(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation, bokeh.models.annotations._HasRenderMode

Base class for text annotation models such as labels and titles.

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
{
  "coordinates": null,
  "group": null,
  "id": "1383",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "render_mode": "canvas",
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:_HasRenderMode

render_mode

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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.

render_mode = 'canvas'
Type

Enum(RenderMode)

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas. The default mode is “canvas”.

Note

This property is deprecated and will be removed in bokeh 3.0.

Note

The HTML labels won’t be present in the output using the “save” tool.

Warning

Not all visual styling properties are supported if the render_mode is set to “css”. The border_line_dash property isn’t fully supported and border_line_dash_offset isn’t supported at all. Setting text_alpha will modify the opacity of the entire background box and border in addition to the text. Finally, clipping Label annotations inside of the plot area isn’t supported in “css” mode.

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

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Title

class Title(*args, **kwargs)[source]

Bases: bokeh.models.annotations.TextAnnotation

Render a single title box as an annotation.

See Titles for information on plotting titles.

JSON Prototype
{
  "align": "left",
  "background_fill_alpha": 1.0,
  "background_fill_color": null,
  "border_line_alpha": 1.0,
  "border_line_cap": "butt",
  "border_line_color": null,
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "coordinates": null,
  "group": null,
  "id": "1392",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "offset": 0,
  "render_mode": "canvas",
  "standoff": 10,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "text": "",
  "text_alpha": 1.0,
  "text_color": "#444444",
  "text_font": "helvetica",
  "text_font_size": "13px",
  "text_font_style": "bold",
  "text_line_height": 1.0,
  "vertical_align": "bottom",
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

text

The text value to render.

vertical_align

Alignment of the text in its enclosing space, across the direction of the text.

align

Alignment of the text in its enclosing space, along the direction of the text.

text_line_height

How much additional space should be allocated for the title.

offset

Offset the text by a number of pixels (can be positive or negative).

standoff

text_font

Name of a font to use for rendering text, e.g., 'times', 'helvetica'.

text_font_size

text_font_style

A style to use for rendering text.

text_color

A color to use to fill text with.

text_alpha

An alpha value to use to fill text with.

background_fill_color

The fill color values for the text bounding box.

background_fill_alpha

The fill alpha values for the text bounding box.

border_line_dash_offset

The line dash offset values for the text bounding box.

border_line_cap

The line cap values for the text bounding box.

border_line_dash

The line dash values for the text bounding box.

border_line_alpha

The line alpha values for the text bounding box.

border_line_join

The line join values for the text bounding box.

border_line_color

The line color values for the text bounding box.

border_line_width

The line width values for the text bounding box.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:_HasRenderMode

render_mode

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


align = 'left'
Type

Enum(TextAlign)

Alignment of the text in its enclosing space, along the direction of the text.

background_fill_alpha = 1.0
Type

Alpha

The fill alpha values for the text bounding box.

background_fill_color = None
Type

Nullable(Color)

The fill color values for the text bounding box.

border_line_alpha = 1.0
Type

Alpha

The line alpha values for the text bounding box.

border_line_cap = 'butt'
Type

Enum(LineCap)

The line cap values for the text bounding box.

border_line_color = None
Type

Nullable(Color)

The line color values for the text bounding box.

border_line_dash = []
Type

DashPattern

The line dash values for the text bounding box.

border_line_dash_offset = 0
Type

Int

The line dash offset values for the text bounding box.

border_line_join = 'bevel'
Type

Enum(LineJoin)

The line join values for the text bounding box.

border_line_width = 1
Type

Float

The line width values for the text bounding box.

level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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.

offset = 0
Type

Float

Offset the text by a number of pixels (can be positive or negative). Shifts the text in different directions based on the location of the title:

  • above: shifts title right

  • right: shifts title down

  • below: shifts title right

  • left: shifts title up

render_mode = 'canvas'
Type

Enum(RenderMode)

Specifies whether the contents are rendered to a canvas or as a HTML element overlaid on the canvas. The default mode is “canvas”.

Note

This property is deprecated and will be removed in bokeh 3.0.

Note

The HTML labels won’t be present in the output using the “save” tool.

Warning

Not all visual styling properties are supported if the render_mode is set to “css”. The border_line_dash property isn’t fully supported and border_line_dash_offset isn’t supported at all. Setting text_alpha will modify the opacity of the entire background box and border in addition to the text. Finally, clipping Label annotations inside of the plot area isn’t supported in “css” mode.

standoff = 10
Type

Float

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.

text = ''
Type

String

The text value to render.

text_alpha = 1.0
Type

Alpha

An alpha value to use to fill text with.

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

text_color = '#444444'
Type

Color

A color to use to fill text 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

text_font = 'helvetica'
Type

String

Name of a font to use for rendering text, e.g., 'times', 'helvetica'.

text_font_style = 'bold'
Type

Enum(FontStyle)

A style to use for rendering text.

Acceptable values are:

  • 'normal' normal text

  • 'italic' italic text

  • 'bold' bold text

text_line_height = 1.0
Type

Float

How much additional space should be allocated for the title. The value is provided as a number, but should be treated as a percentage of font size. The default is 100%, which means no additional space will be used.

vertical_align = 'bottom'
Type

Enum(VerticalAlign)

Alignment of the text in its enclosing space, across the direction of the text.

visible = True
Type

Bool

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

ToolbarPanel

class ToolbarPanel(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation

JSON Prototype
{
  "coordinates": null,
  "group": null,
  "id": "1420",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

toolbar

A toolbar to display.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


level = 'annotation'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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.

toolbar = Undefined
Type

Instance(Toolbar)

A toolbar to display.

visible = True
Type

Bool

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Tooltip

class Tooltip(*args, **kwargs)[source]

Bases: bokeh.models.annotations.Annotation

Render a tooltip.

Note

This model is currently managed by BokehJS and is not useful directly from python.

JSON Prototype
{
  "attachment": "horizontal",
  "coordinates": null,
  "group": null,
  "id": "1429",
  "inner_only": true,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "overlay",
  "name": null,
  "show_arrow": true,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

attachment

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.

inner_only

Whether to display outside a central plot frame area.

show_arrow

Whether tooltip's arrow should be shown.

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


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.

inner_only = True
Type

Bool

Whether to display outside a central plot frame area.

level = 'overlay'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

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.

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.

visible = True
Type

Bool

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.

Whisker

class Whisker(*args, **kwargs)[source]

Bases: bokeh.models.annotations.DataAnnotation

Render a whisker along a dimension.

See Whiskers for information on plotting whiskers.

JSON Prototype
{
  "base": {
    "field": "base"
  },
  "coordinates": null,
  "dimension": "height",
  "group": null,
  "id": "1440",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "underlay",
  "line_alpha": {
    "value": 1.0
  },
  "line_cap": {
    "value": "butt"
  },
  "line_color": {
    "value": "black"
  },
  "line_dash": {
    "value": []
  },
  "line_dash_offset": {
    "value": 0
  },
  "line_join": {
    "value": "bevel"
  },
  "line_width": {
    "value": 1
  },
  "lower": {
    "field": "lower"
  },
  "lower_head": {
    "id": "1441"
  },
  "name": null,
  "source": {
    "id": "1443"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "upper": {
    "field": "upper"
  },
  "upper_head": {
    "id": "1442"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

Public Data Attributes:

lower_units

Units to use for the associated property: screen or data

lower

The coordinates of the lower end of the whiskers.

lower_head

Instance of ArrowHead.

upper_units

Units to use for the associated property: screen or data

upper

The coordinates of the upper end of the whiskers.

upper_head

Instance of ArrowHead.

base_units

Units to use for the associated property: screen or data

base

The orthogonal coordinates of the upper and lower values.

dimension

The direction of the whisker can be specified by setting this property to "height" (y direction) or "width" (x direction).

line_dash_offset

The line dash offset values for the whisker body.

line_cap

The line cap values for the whisker body.

line_dash

The line dash values for the whisker body.

line_alpha

The line alpha values for the whisker body.

line_join

The line join values for the whisker body.

line_color

The line color values for the whisker body.

line_width

The line width values for the whisker body.

Inherited from : py: class:DataAnnotation

source

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

Inherited from : py: class:Renderer

level

Specifies the level in which to paint this renderer.

visible

Is the renderer visible.

coordinates

x_range_name

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot.

y_range_name

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot.

group

Inherited from : py: class:Model

model_class_reverse_map

id

ref

struct

A Bokeh protocol "structure" of this model, i.e. a dict of the form:.

name

An arbitrary, user-supplied name for this model.

tags

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

js_event_callbacks

A mapping of event names to lists of CustomJS callbacks.

subscribed_events

List of events that are subscribed to by Python callbacks.

js_property_callbacks

A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.

syncable

Indicates whether this model should be synchronized back to a Bokeh server when updated in a web browser.

Inherited from : py: class:HasDocumentRef

document

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

Public Methods:

Inherited from : py: class:Model

__init_subclass__()

This method is called when a class is subclassed.

__new__(cls, *args, **kwargs)

__init__(**kwargs)

__str__()

Return str(self).

__repr__()

Return repr(self).

destroy()

Clean up references to the document and property

js_on_event(event, *callbacks)

js_link(attr, other, other_attr[, attr_selector])

Link two Bokeh model properties using JavaScript.

js_on_change(event, *callbacks)

Attach a CustomJS callback to an arbitrary BokehJS model event.

on_change(attr, *callbacks)

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

references()

Returns all Models that this object has references to.

select(selector)

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

select_one(selector)

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

set_select(selector, updates)

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

to_json(include_defaults)

Returns a dictionary of the attributes of this object, containing only "JSON types" (string, number, boolean, none, dict, list).

to_json_string(include_defaults)

Returns a JSON string encoding the attributes of this object.

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:HasProps

__init__(**kwargs)

__setattr__(name, value)

Intercept attribute setting on HasProps in order to special case a few situations:

__getattr__(name)

Intercept attribute setting on HasProps in order to special case a few situations:

__str__()

Return str(self).

__repr__()

Return repr(self).

equals(other)

Structural equality of models.

static_to_serializable(serializer)

to_serializable(serializer)

set_from_json(name, json, *[, models, setter])

Set a property value on this object from JSON.

update(**kwargs)

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

update_from_json(json_attributes, *[, ...])

Updates the object's properties from a JSON attributes dictionary.

lookup(name, *[, raises])

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

properties(*[, _with_props])

Collect the names of properties on this class.

properties_with_refs()

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

dataspecs()

Collect the names of all DataSpec properties on this class.

properties_with_values(*[, ...])

Collect a dict mapping property names to their values.

query_properties_with_values(query, *[, ...])

Query the properties values of HasProps instances with a predicate.

themed_values()

Get any theme-provided overrides.

apply_theme(property_values)

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

unapply_theme()

Remove any themed values and restore defaults.

Inherited from : py: class:HasDocumentRef

__init__(**kwargs)

Inherited from : py: class:PropertyCallbackManager

__init__(**kwargs)

on_change(attr, *callbacks)

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

remove_on_change(attr, *callbacks)

Remove a callback from this object

trigger(attr, old, new[, hint, setter])

Inherited from : py: class:EventCallbackManager

__init__(**kwargs)

on_event(event, *callbacks)

Run callbacks when the specified event occurs on this Model


base = {'field': 'base'}
Type

PropertyUnitsSpec

The orthogonal coordinates of the upper and lower values.

base_units = 'data'
Type

Enum(SpatialUnits)

Units to use for the associated property: screen or data

dimension = 'height'
Type

Enum(Dimension)

The direction of the whisker can be specified by setting this property to “height” (y direction) or “width” (x direction).

level = 'underlay'
Type

Enum(RenderLevel)

Specifies the level in which to paint this renderer.

line_alpha = 1.0
Type

AlphaSpec

The line alpha values for the whisker body.

line_cap = 'butt'
Type

LineCapSpec

The line cap values for the whisker body.

line_color = 'black'
Type

ColorSpec

The line color values for the whisker body.

line_dash = []
Type

DashPatternSpec

The line dash values for the whisker body.

line_dash_offset = 0
Type

IntSpec

The line dash offset values for the whisker body.

line_join = 'bevel'
Type

LineJoinSpec

The line join values for the whisker body.

line_width = 1
Type

NumberSpec

The line width values for the whisker body.

lower = {'field': 'lower'}
Type

PropertyUnitsSpec

The coordinates of the lower end of the whiskers.

lower_head = TeeHead(id='1457', ...)
Type

Nullable(Instance(ArrowHead))

Instance of ArrowHead.

lower_units = 'data'
Type

Enum(SpatialUnits)

Units to use for the associated property: screen or data

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.

source = ColumnDataSource(id='1461', ...)
Type

Instance(DataSource)

Local data source to use when rendering annotations on the 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.

upper = {'field': 'upper'}
Type

PropertyUnitsSpec

The coordinates of the upper end of the whiskers.

upper_head = TeeHead(id='1466', ...)
Type

Nullable(Instance(ArrowHead))

Instance of ArrowHead.

upper_units = 'data'
Type

Enum(SpatialUnits)

Units to use for the associated property: screen or data

visible = True
Type

Bool

Is the renderer visible.

x_range_name = 'default'
Type

String

A particular (named) x-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default x-range.

y_range_name = 'default'
Type

String

A particular (named) y-range to use for computing screen locations when rendering glyphs on the plot. If unset, use the default y-range.

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 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]

destroy() None

Clean up references to the document and property

equals(other: bokeh.core.has_props.HasProps) bool

Structural equality of models.

Parameters

other (HasProps) – the other instance to compare to

Returns

True, if properties are structurally equal, otherwise False

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 (Union[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: JSEventCallback) 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) Optional[bokeh.core.property.descriptors.PropertyDescriptor[Any]]

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

Example:

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: Union[str, Type[bokeh.events.Event]], *callbacks: Union[Callable[[bokeh.events.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 properties(*, _with_props: bool = False) Union[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[[bokeh.core.property.descriptors.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[bokeh.model.model.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, json: JSON, *, models: Dict[ID, HasProps] | None = None, setter: Setter | None = None) None

Set a property value on this object from JSON.

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

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

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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, Unknown]) None

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

Parameters
  • selector (JSON-like) –

  • updates (dict) –

Returns

None

themed_values() Optional[Dict[str, Any]]

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_json(include_defaults: bool) JSON

Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).

References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

to_json_string(include_defaults: bool) str

Returns a JSON string encoding the attributes of this object.

References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.

There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).

For most purposes it’s best to serialize and deserialize entire documents.

Parameters

include_defaults (bool) – whether to include attributes that haven’t been changed from the default

trigger(attr: str, old: Unknown, new: Unknown, 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)
update_from_json(json_attributes: Dict[str, JSON], *, models: Mapping[ID, HasProps] | None = None, setter: Setter | None = None) None

Updates the object’s properties from a JSON attributes dictionary.

Parameters
  • json_attributes – (JSON-dict) : attributes and values to update

  • models (dict or None, optional) –

    Mapping of model ids to models (default: None)

    This is needed in cases where the attributes to update also have values that have references.

  • 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

property document: Document | None

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

property struct: bokeh.core.types.ReferenceJson

A Bokeh protocol “structure” of this model, i.e. a dict of the form:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

Additionally there may be a subtype field if this model is a subtype.