tables<a class="headerlink" href="#module-bokeh.models.widgets.tables" title="Permalink to this headline">¶

Refers to the table column being aggregated

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

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

field_ = ''¶

Type: String

Refers to the table column being aggregated

name = None¶

Type: Nullable(String)

An arbitrary, user-supplied name for this model.

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

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

Note

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

syncable = True¶

Type: Bool

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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

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

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.

BooleanFormatter¶

class BooleanFormatter(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellFormatter

Boolean (check mark) cell formatter.

JSON Prototype

{
  "icon": "check",
  "id": "2262",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

icon

The icon visualizing the check mark.

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

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

icon = 'check'¶

Type: Enum(Enumeration(check, check-circle, check-circle-o, check-square, check-square-o))

The icon visualizing the check mark.

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

CellEditor¶

class CellEditor(*args, **kwargs)[source]¶

Abstract base class for data table’s cell editors.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

JSON Prototype

{
  "id": "2267",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

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

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

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

CellFormatter¶

class CellFormatter(*args, **kwargs)[source]¶

Abstract base class for data table’s cell formatters.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

JSON Prototype

{
  "id": "2271",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

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

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

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

CheckboxEditor¶

class CheckboxEditor(*args, **kwargs)[source]¶

Boolean value cell editor.

JSON Prototype

{
  "id": "2275",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

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

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

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

DataCube¶

class DataCube(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.DataTable

Specialized DataTable with collapsing groups, totals, and sub-totals.

JSON Prototype

{
  "align": "start",
  "aspect_ratio": null,
  "auto_edit": false,
  "autosize_mode": "force_fit",
  "background": null,
  "columns": [],
  "css_classes": [],
  "default_size": 300,
  "disabled": false,
  "editable": false,
  "fit_columns": null,
  "frozen_columns": null,
  "frozen_rows": null,
  "grouping": [],
  "header_row": true,
  "height": 400,
  "height_policy": "auto",
  "id": "2279",
  "index_header": "#",
  "index_position": 0,
  "index_width": 40,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    5,
    5,
    5,
    5
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "reorderable": true,
  "row_height": 25,
  "scroll_to_selection": true,
  "selectable": true,
  "sizing_mode": null,
  "sortable": true,
  "source": {
    "id": "2280"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "view": {
    "id": "2281"
  },
  "visible": true,
  "width": 600,
  "width_policy": "auto"
}

Public Data Attributes:

`grouping`	Describe what aggregation operations used to define sub-totals and totals
`target`	Two column datasource (row_indices & labels) describing which rows of the data cubes are expanded or collapsed

Inherited from : py: class:DataTable

`autosize_mode`	Describes the column autosizing mode with one of the following options:
`auto_edit`	When enabled editing mode is enabled after a single click on a table cell.
`columns`	The list of child column widgets.
`fit_columns`	This is a legacy parameter. For new development, use the `autosize_mode` parameter.
`frozen_columns`	Integer indicating the number of columns to freeze.
`frozen_rows`	Integer indicating the number of rows to freeze.
`sortable`	Allows to sort table's contents.
`reorderable`	Allows the reordering of a table's columns.
`editable`	Allows to edit table's contents.
`selectable`	Whether a table's rows can be selected or not.
`index_position`	Where among the list of columns to insert a column displaying the row index.
`index_header`	The column header to display for the index column, if it is present.
`index_width`	The width of the index column, if present.
`scroll_to_selection`	Whenever a selection is made on the data source, scroll the selected rows into the table's viewport if none of the selected rows are already in the viewport.
`header_row`	Whether to show a header row with column names at the top of the table.
`row_height`	The height of each row in pixels.

Inherited from : py: class:TableWidget

`source`	The source of data for the widget.
`view`	A view into the data source to use when rendering table rows.

Inherited from : py: class:Widget

default_size

The default size (width or height) in the dominating dimension.

Inherited from : py: class:LayoutDOM

`disabled`	Whether the widget will be disabled when rendered.
`visible`	Whether the component will be visible and a part of a layout.
`width`	The width of the component (in pixels).
`height`	The height of the component (in pixels).
`min_width`	Minimal width of the component (in pixels) if width is adjustable.
`min_height`	Minimal height of the component (in pixels) if height is adjustable.
`max_width`	Maximal width of the component (in pixels) if width is adjustable.
`max_height`	Maximal height of the component (in pixels) if height is adjustable.
`margin`	Allows to create additional space around the component.
`width_policy`	Describes how the component should maintain its width.
`height_policy`	Describes how the component should maintain its height.
`aspect_ratio`	Describes the proportional relationship between component's width and height.
`sizing_mode`	How the component should size itself.
`align`	The alignment point within the parent container.
`background`	Background color of the component.
`css_classes`	A list of CSS class names to add to this DOM element.

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

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

Public Methods:

Inherited from : py: class:TableWidget

__init__(**kw)

Inherited from : py: class:Model

`__init_subclass__`()	This method is called when a class is subclassed.
`__new__`(cls, args, *kwargs)
`__init__`(**kw)
`__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__`(**kw)
`__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__(**kw)

Inherited from : py: class:PropertyCallbackManager

`__init__`(**kw)
`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__`(**kw)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

align = 'start'¶

Type: Either(Enum(Align), Tuple(Enum(Align), Enum(Align)))

The alignment point within the parent container.

This property is useful only if this component is a child element of a layout (e.g. a grid). Self alignment can be overridden by the parent container (e.g. grid track align).

aspect_ratio = None¶

Type: Either(Null, Auto, Float)

Describes the proportional relationship between component’s width and height.

This works if any of component’s dimensions are flexible in size. If set to a number, width / height = aspect_ratio relationship will be maintained. Otherwise, if set to "auto", component’s preferred width and height will be used to determine the aspect (if not set, no aspect will be preserved).

auto_edit = False¶

Type: Bool

When enabled editing mode is enabled after a single click on a table cell.

autosize_mode = 'force_fit'¶

Type: Enum(AutosizeMode)

Describes the column autosizing mode with one of the following options:

"fit_columns": Compute column widths based on cell contents but ensure the table fits into the available viewport. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available.
"fit_viewport": Adjust the viewport size after computing columns widths based on cell contents.
"force_fit": Fit columns into available space dividing the table width across the columns equally (equivalent to fit_columns=True). This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available.
"none": Do not automatically compute column widths.

background = None¶

Type: Nullable(Color)

Background color of the component.

columns = []¶

Type: List

The list of child column widgets.

css_classes = []¶

Type: List

A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.

It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.

default_size = 300¶

Type: Int

The default size (width or height) in the dominating dimension.

The dominating dimension is determined by widget orientation.

disabled = False¶

Type: Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

editable = False¶

Type: Bool

Allows to edit table’s contents. Needs cell editors to be configured on columns that are required to be editable.

fit_columns = None¶

Type: Nullable(Bool)

This is a legacy parameter. For new development, use the autosize_mode parameter.

Whether columns should be fit to the available width. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available. If set to True, each column’s width is understood as maximum width.

frozen_columns = None¶

Type: Nullable(Int)

Integer indicating the number of columns to freeze. If set the first N columns will be frozen which prevents them from scrolling out of frame.

frozen_rows = None¶

Type: Nullable(Int)

Integer indicating the number of rows to freeze. If set the first N rows will be frozen which prevents them from scrolling out of frame, if set to a negative value last N rows will be frozen.

grouping = []¶

Type: List

Describe what aggregation operations used to define sub-totals and totals

header_row = True¶

Type: Bool

Whether to show a header row with column names at the top of the table.

height = 400¶

Type: Nullable(NonNegativeInt)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit": Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min": Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

index_header = '#'¶

Type: String

The column header to display for the index column, if it is present.

index_position = 0¶

Type: Nullable(Int)

Where among the list of columns to insert a column displaying the row index. Negative indices are supported, and specify an index position from the end of the list of columns (i.e. standard Python behaviour).

To prevent the index column from being added, set to None.

If the absolute value of index_position is larger than the length of the columns, then the index will appear at the beginning or end, depending on the sign.

index_width = 40¶

Type: Int

The width of the index column, if present.

margin = (5, 5, 5, 5)¶

Type: Nullable(Tuple(Int, Int, Int, Int))

Allows to create additional space around the component. The values in the tuple are ordered as follows - Margin-Top, Margin-Right, Margin-Bottom and Margin-Left, similar to CSS standards. Negative margin values may be used to shrink the space from any direction.

max_height = None¶

Type: Nullable(NonNegativeInt)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None¶

Type: Nullable(NonNegativeInt)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None¶

Type: Nullable(NonNegativeInt)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None¶

Type: Nullable(NonNegativeInt)

Minimal width of the component (in pixels) if width is adjustable.

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.

reorderable = True¶

Type: Bool

Allows the reordering of a table’s columns. To reorder a column, click and drag a table’s header to the desired location in the table. The columns on either side will remain in their previous order.

row_height = 25¶

Type: Int

The height of each row in pixels.

scroll_to_selection = True¶

Type: Bool

Whenever a selection is made on the data source, scroll the selected rows into the table’s viewport if none of the selected rows are already in the viewport.

selectable = True¶

Type: Either(Bool, Enum(Enumeration(checkbox)))

Whether a table’s rows can be selected or not. Using checkbox is equivalent to True, but makes selection visible through a checkbox for each row, instead of highlighting rows. Multiple selection is allowed and can be achieved by either clicking multiple checkboxes (if enabled) or using Shift + click on rows.

sizing_mode = None¶

Type: Nullable(Enum(SizingMode))

How the component should size itself.

This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode).

Possible scenarios:

"fixed": Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events.
"stretch_width": Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_height": Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_both": Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component.
"scale_width": Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio.
"scale_height": Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio.
"scale_both": Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

sortable = True¶

Type: Bool

Allows to sort table’s contents. By default natural order is preserved. To sort a column, click on it’s header. Clicking one more time changes sort direction. Use Ctrl + click to return to natural order. Use Shift + click to sort multiple columns simultaneously.

source = ColumnDataSource(id='2382', ...)¶

Type: Instance(DataSource)

The source of data for the widget.

syncable = True¶

Type: Bool

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.

target = Undefined¶

Type: Instance(DataSource)

Two column datasource (row_indices & labels) describing which rows of the data cubes are expanded or collapsed

view = Undefined¶

Type: Instance(CDSView)

A view into the data source to use when rendering table rows. A default view of the entire data source is created if a view is not passed in during initialization.

visible = True¶

Type: Bool

Whether the component will be visible and a part of a layout.

width = 600¶

Type: Nullable(NonNegativeInt)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
"fit": Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
"min": Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

DataTable¶

class DataTable(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.TableWidget

Two-dimensional grid for visualization and editing large amounts of data.

JSON Prototype

{
  "align": "start",
  "aspect_ratio": null,
  "auto_edit": false,
  "autosize_mode": "force_fit",
  "background": null,
  "columns": [],
  "css_classes": [],
  "default_size": 300,
  "disabled": false,
  "editable": false,
  "fit_columns": null,
  "frozen_columns": null,
  "frozen_rows": null,
  "header_row": true,
  "height": 400,
  "height_policy": "auto",
  "id": "2404",
  "index_header": "#",
  "index_position": 0,
  "index_width": 40,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    5,
    5,
    5,
    5
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "reorderable": true,
  "row_height": 25,
  "scroll_to_selection": true,
  "selectable": true,
  "sizing_mode": null,
  "sortable": true,
  "source": {
    "id": "2405"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "view": {
    "id": "2406"
  },
  "visible": true,
  "width": 600,
  "width_policy": "auto"
}

Public Data Attributes:

`autosize_mode`	Describes the column autosizing mode with one of the following options:
`auto_edit`	When enabled editing mode is enabled after a single click on a table cell.
`columns`	The list of child column widgets.
`fit_columns`	This is a legacy parameter. For new development, use the `autosize_mode` parameter.
`frozen_columns`	Integer indicating the number of columns to freeze.
`frozen_rows`	Integer indicating the number of rows to freeze.
`sortable`	Allows to sort table's contents.
`reorderable`	Allows the reordering of a table's columns.
`editable`	Allows to edit table's contents.
`selectable`	Whether a table's rows can be selected or not.
`index_position`	Where among the list of columns to insert a column displaying the row index.
`index_header`	The column header to display for the index column, if it is present.
`index_width`	The width of the index column, if present.
`scroll_to_selection`	Whenever a selection is made on the data source, scroll the selected rows into the table's viewport if none of the selected rows are already in the viewport.
`header_row`	Whether to show a header row with column names at the top of the table.
`row_height`	The height of each row in pixels.

Inherited from : py: class:TableWidget

`source`	The source of data for the widget.
`view`	A view into the data source to use when rendering table rows.

Inherited from : py: class:Widget

default_size

The default size (width or height) in the dominating dimension.

Inherited from : py: class:LayoutDOM

`disabled`	Whether the widget will be disabled when rendered.
`visible`	Whether the component will be visible and a part of a layout.
`width`	The width of the component (in pixels).
`height`	The height of the component (in pixels).
`min_width`	Minimal width of the component (in pixels) if width is adjustable.
`min_height`	Minimal height of the component (in pixels) if height is adjustable.
`max_width`	Maximal width of the component (in pixels) if width is adjustable.
`max_height`	Maximal height of the component (in pixels) if height is adjustable.
`margin`	Allows to create additional space around the component.
`width_policy`	Describes how the component should maintain its width.
`height_policy`	Describes how the component should maintain its height.
`aspect_ratio`	Describes the proportional relationship between component's width and height.
`sizing_mode`	How the component should size itself.
`align`	The alignment point within the parent container.
`background`	Background color of the component.
`css_classes`	A list of CSS class names to add to this DOM element.

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

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

Public Methods:

Inherited from : py: class:TableWidget

__init__(**kw)

Inherited from : py: class:Model

`__init_subclass__`()	This method is called when a class is subclassed.
`__new__`(cls, args, *kwargs)
`__init__`(**kw)
`__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__`(**kw)
`__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__(**kw)

Inherited from : py: class:PropertyCallbackManager

`__init__`(**kw)
`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__`(**kw)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

align = 'start'¶

Type: Either(Enum(Align), Tuple(Enum(Align), Enum(Align)))

The alignment point within the parent container.

This property is useful only if this component is a child element of a layout (e.g. a grid). Self alignment can be overridden by the parent container (e.g. grid track align).

aspect_ratio = None¶

Type: Either(Null, Auto, Float)

Describes the proportional relationship between component’s width and height.

auto_edit = False¶

Type: Bool

When enabled editing mode is enabled after a single click on a table cell.

autosize_mode = 'force_fit'¶

Type: Enum(AutosizeMode)

Describes the column autosizing mode with one of the following options:

"fit_columns": Compute column widths based on cell contents but ensure the table fits into the available viewport. This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available.
"fit_viewport": Adjust the viewport size after computing columns widths based on cell contents.
"force_fit": Fit columns into available space dividing the table width across the columns equally (equivalent to fit_columns=True). This results in no horizontal scrollbar showing up, but data can get unreadable if there is not enough space available.
"none": Do not automatically compute column widths.

background = None¶

Type: Nullable(Color)

Background color of the component.

columns = []¶

Type: List

The list of child column widgets.

css_classes = []¶

Type: List

A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.

It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.

default_size = 300¶

Type: Int

The default size (width or height) in the dominating dimension.

The dominating dimension is determined by widget orientation.

disabled = False¶

Type: Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

editable = False¶

Type: Bool

Allows to edit table’s contents. Needs cell editors to be configured on columns that are required to be editable.

fit_columns = None¶

Type: Nullable(Bool)

This is a legacy parameter. For new development, use the autosize_mode parameter.

frozen_columns = None¶

Type: Nullable(Int)

Integer indicating the number of columns to freeze. If set the first N columns will be frozen which prevents them from scrolling out of frame.

frozen_rows = None¶

Type: Nullable(Int)

Integer indicating the number of rows to freeze. If set the first N rows will be frozen which prevents them from scrolling out of frame, if set to a negative value last N rows will be frozen.

header_row = True¶

Type: Bool

Whether to show a header row with column names at the top of the table.

height = 400¶

Type: Nullable(NonNegativeInt)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit": Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min": Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

index_header = '#'¶

Type: String

The column header to display for the index column, if it is present.

index_position = 0¶

Type: Nullable(Int)

To prevent the index column from being added, set to None.

If the absolute value of index_position is larger than the length of the columns, then the index will appear at the beginning or end, depending on the sign.

index_width = 40¶

Type: Int

The width of the index column, if present.

margin = (5, 5, 5, 5)¶

Type: Nullable(Tuple(Int, Int, Int, Int))

max_height = None¶

Type: Nullable(NonNegativeInt)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None¶

Type: Nullable(NonNegativeInt)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None¶

Type: Nullable(NonNegativeInt)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None¶

Type: Nullable(NonNegativeInt)

Minimal width of the component (in pixels) if width is adjustable.

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.

reorderable = True¶

Type: Bool

row_height = 25¶

Type: Int

The height of each row in pixels.

scroll_to_selection = True¶

Type: Bool

Whenever a selection is made on the data source, scroll the selected rows into the table’s viewport if none of the selected rows are already in the viewport.

selectable = True¶

Type: Either(Bool, Enum(Enumeration(checkbox)))

sizing_mode = None¶

Type: Nullable(Enum(SizingMode))

How the component should size itself.

Possible scenarios:

"fixed": Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events.
"stretch_width": Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_height": Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_both": Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component.
"scale_width": Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio.
"scale_height": Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio.
"scale_both": Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

sortable = True¶

Type: Bool

source = ColumnDataSource(id='2504', ...)¶

Type: Instance(DataSource)

The source of data for the widget.

syncable = True¶

Type: Bool

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.

view = Undefined¶

Type: Instance(CDSView)

A view into the data source to use when rendering table rows. A default view of the entire data source is created if a view is not passed in during initialization.

visible = True¶

Type: Bool

Whether the component will be visible and a part of a layout.

width = 600¶

Type: Nullable(NonNegativeInt)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
"fit": Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
"min": Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

DateEditor¶

class DateEditor(*args, **kwargs)[source]¶

Calendar-based date cell editor.

JSON Prototype

{
  "id": "2523",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

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

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

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

DateFormatter¶

class DateFormatter(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.StringFormatter

Date cell formatter.

JSON Prototype

{
  "font_style": "normal",
  "format": "ISO-8601",
  "id": "2527",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "nan_format": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "text_align": "left",
  "text_color": null
}

Public Data Attributes:

`format`	The date format can be any standard strftime format string, as well as any of the following predefined format names:
`nan_format`	Formatting to apply to NaN and None values (falls back to regular date formatting if not set).

Inherited from : py: class:StringFormatter

`font_style`	An optional text font style, e.g.
`text_align`	An optional text align, i.e. left, center or right.
`text_color`	An optional text color.

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

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

font_style = 'normal'¶

Type: Enum(FontStyle)

An optional text font style, e.g. bold, italic.

format = 'ISO-8601'¶

Type: Either(Enum(DateFormat), String)

The date format can be any standard strftime format string, as well as any of the following predefined format names:

Format name(s)	Format string	Example Output
`ATOM` / `W3C` / `RFC-3339` / `ISO-8601`	`"%Y-%m-%d"`	2014-03-01
`COOKIE`	`"%a, %d %b %Y"`	Sat, 01 Mar 2014
`RFC-850`	`"%A, %d-%b-%y"`	Saturday, 01-Mar-14
`RFC-1123` / `RFC-2822`	`"%a, %e %b %Y"`	Sat, 1 Mar 2014
`RSS` / `RFC-822` / `RFC-1036`	`"%a, %e %b %y"`	Sat, 1 Mar 14
`TIMESTAMP`	(ms since epoch)	1393632000000

Note that in the table some of the format names are synonymous, with identical format names separated by slashes.

This list of supported strftime format codes is reproduced below.

%a: The abbreviated name of the day of the week according to the current locale.
%A: The full name of the day of the week according to the current locale.
%b: The abbreviated month name according to the current locale.
%B: The full month name according to the current locale.
%c: The preferred date and time representation for the current locale.
%C: The century number (year/100) as a 2-digit integer.
%d: The day of the month as a decimal number (range 01 to 31).
%D: Equivalent to %m/%d/%y. (Americans should note that in many other countries %d/%m/%y is rather common. This means that in international context this format is ambiguous and should not be used.)
%e: Like %d, the day of the month as a decimal number, but a leading zero is replaced by a space.
%f: Microsecond as a decimal number, zero-padded on the left (range 000000-999999). This is an extension to the set of directives available to timezone.
%F: Equivalent to %Y-%m-%d (the ISO 8601 date format).
%G: The ISO 8601 week-based year with century as a decimal number. The 4-digit year corresponding to the ISO week number (see %V). This has the same format and value as %Y, except that if the ISO week number belongs to the previous or next year, that year is used instead.
%g: Like %G, but without century, that is, with a 2-digit year (00-99).
%h: Equivalent to %b.
%H: The hour as a decimal number using a 24-hour clock (range 00 to 23).
%I: The hour as a decimal number using a 12-hour clock (range 01 to 12).
%j: The day of the year as a decimal number (range 001 to 366).
%k: The hour (24-hour clock) as a decimal number (range 0 to 23). Single digits are preceded by a blank. (See also %H.)
%l: The hour (12-hour clock) as a decimal number (range 1 to 12). Single digits are preceded by a blank. (See also %I.) (TZ)
%m: The month as a decimal number (range 01 to 12).
%M: The minute as a decimal number (range 00 to 59).
%n: A newline character. Bokeh text does not currently support newline characters.
%N: Nanosecond as a decimal number, zero-padded on the left (range 000000000-999999999). Supports a padding width specifier, i.e. %3N displays 3 leftmost digits. However, this is only accurate to the millisecond level of precision due to limitations of timezone.
%p: Either “AM” or “PM” according to the given time value, or the corresponding strings for the current locale. Noon is treated as “PM” and midnight as “AM”.
%P: Like %p but in lowercase: “am” or “pm” or a corresponding string for the current locale.
%r: The time in a.m. or p.m. notation. In the POSIX locale this is equivalent to %I:%M:%S %p.
%R: The time in 24-hour notation (%H:%M). For a version including the seconds, see %T below.
%s: The number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).
%S: The second as a decimal number (range 00 to 60). (The range is up to 60 to allow for occasional leap seconds.)
%t: A tab character. Bokeh text does not currently support tab characters.
%T: The time in 24-hour notation (%H:%M:%S).
%u: The day of the week as a decimal, range 1 to 7, Monday being 1. See also %w.
%U: The week number of the current year as a decimal number, range 00 to 53, starting with the first Sunday as the first day of week 01. See also %V and %W.
%V: The ISO 8601 week number (see NOTES) of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the new year. See also %U and %W.
%w: The day of the week as a decimal, range 0 to 6, Sunday being 0. See also %u.
%W: The week number of the current year as a decimal number, range 00 to 53, starting with the first Monday as the first day of week 01.
%x: The preferred date representation for the current locale without the time.
%X: The preferred time representation for the current locale without the date.
%y: The year as a decimal number without a century (range 00 to 99).
%Y: The year as a decimal number including the century.
%z: The +hhmm or -hhmm numeric timezone (that is, the hour and minute offset from UTC).
%Z: The timezone name or abbreviation.

%%: A literal ‘%’ character.

Warning

The client library BokehJS uses the timezone library to format datetimes. The inclusion of the list below is based on the claim that timezone makes to support “the full compliment of GNU date format specifiers.” However, this claim has not been tested exhaustively against this list. If you find formats that do not function as expected, please submit a github issue, so that the documentation can be updated appropriately.

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.

nan_format = None¶

Type: Nullable(String)

Formatting to apply to NaN and None values (falls back to regular date formatting if not set).

syncable = True¶

Type: Bool

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_align = 'left'¶

Type: Enum(TextAlign)

An optional text align, i.e. left, center or right.

text_color = None¶

Type: Nullable(Color)

An optional text color.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

GroupingInfo¶

class GroupingInfo(*args, **kwargs)[source]¶

Describes how to calculate totals and sub-totals

JSON Prototype

{
  "aggregators": [],
  "collapsed": false,
  "getter": "",
  "id": "2536",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

`getter`	References the column which generates the unique keys of this sub-total (groupby).
`aggregators`	Describes how to aggregate the columns which will populate this sub-total.
`collapsed`	Whether the corresponding sub-total is expanded or collapsed by default.

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

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

aggregators = []¶

Type: List

Describes how to aggregate the columns which will populate this sub-total.

collapsed = False¶

Type: Bool

Whether the corresponding sub-total is expanded or collapsed by default.

getter = ''¶

Type: String

References the column which generates the unique keys of this sub-total (groupby).

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

HTMLTemplateFormatter¶

class HTMLTemplateFormatter(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellFormatter

HTML formatter using a template. This uses Underscore’s template method and syntax. http://underscorejs.org/#template The formatter has access other items in the row via the dataContext object passed to the formatter. So, for example, if another column in the datasource was named url, the template could access it as:

<a href="<%= url %>"><%= value %></a>

To use a different set of template delimiters, pass the appropriate values for evaluate, interpolate’, or `escape. See the Underscore template documentation for more information. http://underscorejs.org/#template

Example: Simple HTML template to format the column value as code.

HTMLTemplateFormatter(template='<code><%= value %></code>')

Example: Use values from other columns (manufacturer and model) to build a hyperlink.

HTMLTemplateFormatter(template=
    '<a href="https:/www.google.com/search?q=<%= manufacturer %>+<%= model %>" target="_blank"><%= value %></a>'
)

JSON Prototype

{
  "id": "2543",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "template": "<%= value %>"
}

Public Data Attributes:

template

Template string to be used by Underscore's template method.

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

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

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

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.

template = '<%= value %>'¶

Type: String

Template string to be used by Underscore’s template method.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

IntEditor¶

class IntEditor(*args, **kwargs)[source]¶

Spinner-based integer cell editor.

JSON Prototype

{
  "id": "2548",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "step": 1,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

step

The major step value.

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

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

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.

step = 1¶

Type: Int

The major step value.

syncable = True¶

Type: Bool

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

MaxAggregator¶

class MaxAggregator(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.RowAggregator

Largest value across multiple rows.

JSON Prototype

{
  "field_": "",
  "id": "2553",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from : py: class:RowAggregator

Refers to the table column being aggregated

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

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

field_ = ''¶

Type: String

Refers to the table column being aggregated

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

MinAggregator¶

class MinAggregator(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.RowAggregator

Smallest value across multiple rows.

JSON Prototype

{
  "field_": "",
  "id": "2558",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from : py: class:RowAggregator

Refers to the table column being aggregated

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

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

field_ = ''¶

Type: String

Refers to the table column being aggregated

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

NumberEditor¶

class NumberEditor(*args, **kwargs)[source]¶

Spinner-based number cell editor.

JSON Prototype

{
  "id": "2563",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "step": 0.01,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

step

The major step value.

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

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

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.

step = 0.01¶

Type: Float

The major step value.

syncable = True¶

Type: Bool

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

NumberFormatter¶

class NumberFormatter(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.StringFormatter

Number cell formatter.

JSON Prototype

{
  "font_style": "normal",
  "format": "0,0",
  "id": "2568",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "language": "en",
  "name": null,
  "nan_format": null,
  "rounding": "round",
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "text_align": "left",
  "text_color": null
}

Public Data Attributes:

`format`	The number format, as defined in the following tables:
`language`	The language to use for formatting language-specific features (e.g.
`nan_format`	Formatting to apply to NaN and None values (falls back to Numbro formatting if not set).
`rounding`	Rounding functions (round, floor, ceil) and their synonyms (nearest, rounddown, roundup).

Inherited from : py: class:StringFormatter

`font_style`	An optional text font style, e.g.
`text_align`	An optional text align, i.e. left, center or right.
`text_color`	An optional text color.

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

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

font_style = 'normal'¶

Type: Enum(FontStyle)

An optional text font style, e.g. bold, italic.

format = '0,0'¶

Type: String

The number format, as defined in the following tables:

NUMBERS:

Number	Format	String
10000	‘0,0.0000’	10,000.0000
10000.23	‘0,0’	10,000
10000.23	‘+0,0’	+10,000
-10000	‘0,0.0’	-10,000.0
10000.1234	‘0.000’	10000.123
10000.1234	‘0[.]00000’	10000.12340
-10000	‘(0,0.0000)’	(10,000.0000)
-0.23	‘.00’	-.23
-0.23	‘(.00)’	(.23)
0.23	‘0.00000’	0.23000
0.23	‘0.0[0000]’	0.23
1230974	‘0.0a’	1.2m
1460	‘0 a’	1 k
-104000	‘0a’	-104k
1	‘0o’	1st
52	‘0o’	52nd
23	‘0o’	23rd
100	‘0o’	100th

CURRENCY:

Number	Format	String
1000.234	‘$0,0.00’	$1,000.23
1000.2	‘0,0[.]00 $’	1,000.20 $
1001	‘$ 0,0[.]00’	$ 1,001
-1000.234	‘($0,0)’	($1,000)
-1000.234	‘$0.00’	-$1000.23
1230974	‘($ 0.00 a)’	$ 1.23 m

BYTES:

Number	Format	String
100	‘0b’	100B
2048	‘0 b’	2 KB
7884486213	‘0.0b’	7.3GB
3467479682787	‘0.000 b’	3.154 TB

PERCENTAGES:

Number	Format	String
1	‘0%’	100%
0.974878234	‘0.000%’	97.488%
-0.43	‘0 %’	-43 %
0.43	‘(0.000 %)’	43.000 %

TIME:

Number	Format	String
25	‘00:00:00’	0:00:25
238	‘00:00:00’	0:03:58
63846	‘00:00:00’	17:44:06

For the complete specification, see http://numbrojs.com/format.html

language = 'en'¶

Type: Enum(NumeralLanguage)

The language to use for formatting language-specific features (e.g. thousands separator).

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.

nan_format = None¶

Type: Nullable(String)

Formatting to apply to NaN and None values (falls back to Numbro formatting if not set).

rounding = 'round'¶

Type: Enum(RoundingFunction)

Rounding functions (round, floor, ceil) and their synonyms (nearest, rounddown, roundup).

syncable = True¶

Type: Bool

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_align = 'left'¶

Type: Enum(TextAlign)

An optional text align, i.e. left, center or right.

text_color = None¶

Type: Nullable(Color)

An optional text color.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

PercentEditor¶

class PercentEditor(*args, **kwargs)[source]¶

IntEditor optimized for editing percentages.

JSON Prototype

{
  "id": "2579",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

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

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

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

ScientificFormatter¶

class ScientificFormatter(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.StringFormatter

Display numeric values from continuous ranges as “basic numbers”, using scientific notation when appropriate by default.

JSON Prototype

{
  "font_style": "normal",
  "id": "2583",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "nan_format": null,
  "power_limit_high": 5,
  "power_limit_low": -3,
  "precision": 10,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "text_align": "left",
  "text_color": null
}

Public Data Attributes:

`nan_format`	Formatting to apply to NaN and None values (falls back to scientific formatting if not set).
`precision`	How many digits of precision to display.
`power_limit_high`	Limit the use of scientific notation to when.
`power_limit_low`	Limit the use of scientific notation to when.

Inherited from : py: class:StringFormatter

`font_style`	An optional text font style, e.g.
`text_align`	An optional text align, i.e. left, center or right.
`text_color`	An optional text color.

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

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

font_style = 'normal'¶

Type: Enum(FontStyle)

An optional text font style, e.g. bold, italic.

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.

nan_format = None¶

Type: Nullable(String)

Formatting to apply to NaN and None values (falls back to scientific formatting if not set).

power_limit_high = 5¶

Type: Int

Limit the use of scientific notation to when::: log(x) >= power_limit_high

power_limit_low = -3¶

Type: Int

Limit the use of scientific notation to when::: log(x) <= power_limit_low

precision = 10¶

Type: Int

How many digits of precision to display.

syncable = True¶

Type: Bool

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_align = 'left'¶

Type: Enum(TextAlign)

An optional text align, i.e. left, center or right.

text_color = None¶

Type: Nullable(Color)

An optional text color.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

SelectEditor¶

class SelectEditor(*args, **kwargs)[source]¶

Select cell editor.

JSON Prototype

{
  "id": "2594",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "options": [],
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

options

The list of options to select from.

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

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

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.

options = []¶

Type: List

The list of options to select from.

syncable = True¶

Type: Bool

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

StringEditor¶

class StringEditor(*args, **kwargs)[source]¶

Basic string cell editor with auto-completion.

JSON Prototype

{
  "completions": [],
  "id": "2599",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

completions

An optional list of completion strings.

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

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

completions = []¶

Type: List

An optional list of completion strings.

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

StringFormatter¶

class StringFormatter(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.CellFormatter

Basic string cell formatter.

JSON Prototype

{
  "font_style": "normal",
  "id": "2604",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "text_align": "left",
  "text_color": null
}

Public Data Attributes:

`font_style`	An optional text font style, e.g.
`text_align`	An optional text align, i.e. left, center or right.
`text_color`	An optional text color.

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

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

font_style = 'normal'¶

Type: Enum(FontStyle)

An optional text font style, e.g. bold, italic.

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

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_align = 'left'¶

Type: Enum(TextAlign)

An optional text align, i.e. left, center or right.

text_color = None¶

Type: Nullable(Color)

An optional text color.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

SumAggregator¶

class SumAggregator(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.tables.RowAggregator

Simple sum across multiple rows.

JSON Prototype

{
  "field_": "",
  "id": "2611",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

Inherited from : py: class:RowAggregator

Refers to the table column being aggregated

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

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

field_ = ''¶

Type: String

Refers to the table column being aggregated

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

TableColumn¶

class TableColumn(*args, **kwargs)[source]¶

Table column widget.

JSON Prototype

{
  "default_sort": "ascending",
  "editor": {
    "id": "2618"
  },
  "formatter": {
    "id": "2617"
  },
  "id": "2616",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sortable": true,
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "title": null,
  "visible": true,
  "width": 300
}

Public Data Attributes:

`field`	The name of the field mapping to a column in the data source.
`title`	The title of this column.
`width`	The width or maximum width (depending on data table's configuration) in pixels of this column.
`formatter`	The cell formatter for this column.
`editor`	The cell editor for this column.
`sortable`	Whether this column is sortable or not.
`default_sort`	The default sorting order.
`visible`	Whether this column shold be displayed or not.

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

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

default_sort = 'ascending'¶

Type: Enum(Enumeration(ascending, descending))

The default sorting order. By default ascending order is used.

editor = StringEditor(id='2621', ...)¶

Type: Instance(CellEditor)

The cell editor for this column. By default, a simple string editor is used.

field = Undefined¶

Type: NonNullable(String)

The name of the field mapping to a column in the data source.

formatter = StringFormatter(id='2624', ...)¶

Type: Instance(CellFormatter)

The cell formatter for this column. By default, a simple string formatter is used.

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.

sortable = True¶

Type: Bool

Whether this column is sortable or not. Note that data table has to have sorting enabled to allow sorting in general.

syncable = True¶

Type: Bool

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 of this column. If not set, column’s data field is used instead.

visible = True¶

Type: Bool

Whether this column shold be displayed or not.

width = 300¶

Type: Int

The width or maximum width (depending on data table’s configuration) in pixels of this column.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

TableWidget¶

class TableWidget(*args, **kwargs)[source]¶

Bases: bokeh.models.widgets.widget.Widget

Abstract base class for data table (data grid) widgets.

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

{
  "align": "start",
  "aspect_ratio": null,
  "background": null,
  "css_classes": [],
  "default_size": 300,
  "disabled": false,
  "height": null,
  "height_policy": "auto",
  "id": "2632",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    5,
    5,
    5,
    5
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "sizing_mode": null,
  "source": {
    "id": "2633"
  },
  "subscribed_events": [],
  "syncable": true,
  "tags": [],
  "view": {
    "id": "2634"
  },
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

Public Data Attributes:

`source`	The source of data for the widget.
`view`	A view into the data source to use when rendering table rows.

Inherited from : py: class:Widget

default_size

The default size (width or height) in the dominating dimension.

Inherited from : py: class:LayoutDOM

`disabled`	Whether the widget will be disabled when rendered.
`visible`	Whether the component will be visible and a part of a layout.
`width`	The width of the component (in pixels).
`height`	The height of the component (in pixels).
`min_width`	Minimal width of the component (in pixels) if width is adjustable.
`min_height`	Minimal height of the component (in pixels) if height is adjustable.
`max_width`	Maximal width of the component (in pixels) if width is adjustable.
`max_height`	Maximal height of the component (in pixels) if height is adjustable.
`margin`	Allows to create additional space around the component.
`width_policy`	Describes how the component should maintain its width.
`height_policy`	Describes how the component should maintain its height.
`aspect_ratio`	Describes the proportional relationship between component's width and height.
`sizing_mode`	How the component should size itself.
`align`	The alignment point within the parent container.
`background`	Background color of the component.
`css_classes`	A list of CSS class names to add to this DOM element.

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

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

Public Methods:

__init__(**kw)

Inherited from : py: class:Model

`__init_subclass__`()	This method is called when a class is subclassed.
`__new__`(cls, args, *kwargs)
`__init__`(**kw)
`__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__`(**kw)
`__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__(**kw)

Inherited from : py: class:PropertyCallbackManager

`__init__`(**kw)
`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__`(**kw)
`on_event`(event, *callbacks)	Run callbacks when the specified event occurs on this Model

align = 'start'¶

Type: Either(Enum(Align), Tuple(Enum(Align), Enum(Align)))

The alignment point within the parent container.

This property is useful only if this component is a child element of a layout (e.g. a grid). Self alignment can be overridden by the parent container (e.g. grid track align).

aspect_ratio = None¶

Type: Either(Null, Auto, Float)

Describes the proportional relationship between component’s width and height.

background = None¶

Type: Nullable(Color)

Background color of the component.

css_classes = []¶

Type: List

A list of CSS class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.

It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.

default_size = 300¶

Type: Int

The default size (width or height) in the dominating dimension.

The dominating dimension is determined by widget orientation.

disabled = False¶

Type: Bool

Whether the widget will be disabled when rendered.

If True, the widget will be greyed-out and not responsive to UI events.

height = None¶

Type: Nullable(NonNegativeInt)

The height of the component (in pixels).

This can be either fixed or preferred height, depending on height sizing policy.

height_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its height.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly height pixels. Component will overflow if it can’t fit in the available vertical space.
"fit": Use component’s preferred height (if set) and allow to fit into the available vertical space within the minimum and maximum height bounds (if set). Component’s height neither will be aggressively minimized nor maximized.
"min": Use as little vertical space as possible, not less than the minimum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much vertical space as possible, not more than the maximum height (if set). The starting point is the preferred height (if set). The height of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

margin = (5, 5, 5, 5)¶

Type: Nullable(Tuple(Int, Int, Int, Int))

max_height = None¶

Type: Nullable(NonNegativeInt)

Maximal height of the component (in pixels) if height is adjustable.

max_width = None¶

Type: Nullable(NonNegativeInt)

Maximal width of the component (in pixels) if width is adjustable.

min_height = None¶

Type: Nullable(NonNegativeInt)

Minimal height of the component (in pixels) if height is adjustable.

min_width = None¶

Type: Nullable(NonNegativeInt)

Minimal width of the component (in pixels) if width is adjustable.

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.

sizing_mode = None¶

Type: Nullable(Enum(SizingMode))

How the component should size itself.

Possible scenarios:

"fixed": Component is not responsive. It will retain its original width and height regardless of any subsequent browser window resize events.
"stretch_width": Component will responsively resize to stretch to the available width, without maintaining any aspect ratio. The height of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_height": Component will responsively resize to stretch to the available height, without maintaining any aspect ratio. The width of the component depends on the type of the component and may be fixed or fit to component’s contents.
"stretch_both": Component is completely responsive, independently in width and height, and will occupy all the available horizontal and vertical space, even if this changes the aspect ratio of the component.
"scale_width": Component will responsively resize to stretch to the available width, while maintaining the original or provided aspect ratio.
"scale_height": Component will responsively resize to stretch to the available height, while maintaining the original or provided aspect ratio.
"scale_both": Component will responsively resize to both the available width and height, while maintaining the original or provided aspect ratio.

source = ColumnDataSource(id='2684', ...)¶

Type: Instance(DataSource)

The source of data for the widget.

syncable = True¶

Type: Bool

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.

view = Undefined¶

Type: Instance(CDSView)

A view into the data source to use when rendering table rows. A default view of the entire data source is created if a view is not passed in during initialization.

visible = True¶

Type: Bool

Whether the component will be visible and a part of a layout.

width = None¶

Type: Nullable(NonNegativeInt)

The width of the component (in pixels).

This can be either fixed or preferred width, depending on width sizing policy.

width_policy = 'auto'¶

Type: Either(Auto, Enum(SizingPolicy))

Describes how the component should maintain its width.

"auto": Use component’s preferred sizing policy.
"fixed": Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
"fit": Use component’s preferred width (if set) and allow it to fit into the available horizontal space within the minimum and maximum width bounds (if set). Component’s width neither will be aggressively minimized nor maximized.
"min": Use as little horizontal space as possible, not less than the minimum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.
"max": Use as much horizontal space as possible, not more than the maximum width (if set). The starting point is the preferred width (if set). The width of the component may shrink or grow depending on the parent layout, aspect management and other factors.

Note

This is an experimental feature and may change in future. Use it at your own discretion. Prefer using sizing_mode if this level of control isn’t strictly necessary.

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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

TextEditor¶

class TextEditor(*args, **kwargs)[source]¶

Multi-line string cell editor.

JSON Prototype

{
  "id": "2703",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

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

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

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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

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¶

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.

TimeEditor¶

class TimeEditor(*args, **kwargs)[source]¶

Spinner-based time cell editor.

JSON Prototype

{
  "id": "2707",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "syncable": true,
  "tags": []
}

Public Data Attributes:

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

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

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

Note

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

tags = []¶

Type: List

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

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

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

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

Note

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

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

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

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

Parameters: property_values (dict) – theme values to use in place of defaults
Returns: None

classmethod 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

js_link(attr: str, other: bokeh.model.model.Model, other_attr: str, attr_selector: Optional[Union[int, str]] = None) → None¶

Link two Bokeh model properties using JavaScript.

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

Parameters

attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
attr_selector (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.

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

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

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.

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