bokeh.models.widgets.groups¶
-
class
AbstractGroup
(**kwargs)[source]¶ Bases:
bokeh.models.widgets.widget.Widget
Abstract base class for all kinds of groups.
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.
-
align
¶ property 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
¶ property type:
Either
(Enum
( Enumeration(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).
-
css_classes
¶ property type:
List
(String
)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
¶ property type:
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
-
disabled
¶ property 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
¶ property type:
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
-
height_policy
¶ property 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.
-
js_event_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of event names to lists of
CustomJS
callbacks.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_event
method:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_change
method:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
margin
¶ property type:
Tuple
(Int
,Int
,Int
,Int
)Allows to create additional space around the component.
-
max_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
max_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
min_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
min_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
name
¶ property type:
String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
-
orientation
¶ property type:
Enum
( Enumeration(horizontal, vertical) )Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
-
sizing_mode
¶ property type:
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
andaspect_ratio
instead (those take precedence oversizing_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.
-
subscribed_events
¶ property type:
List
(String
)List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
-
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.
-
width
¶ property type:
NonNegativeInt
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
-
width_policy
¶ property 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)¶ 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
()¶ 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.
-
classmethod
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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
Added in version 1.1
- Raises
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, *callbacks)¶ 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)
-
js_on_click
(handler)[source]¶ Set up a handler for button check/radio box clicks including the selected indices.
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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_click
(handler)[source]¶ Set up a handler for button check/radio box clicks including the selected indices.
- Parameters
handler (func) – handler function to call when button is clicked.
- Returns
None
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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.
-
properties_with_values
(include_defaults: bool = True) → 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.
-
query_properties_with_values
(query, include_defaults=True)¶ 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
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
themed_values
()¶ 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)¶ 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)¶ 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, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ 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, models=None, setter=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
¶ The
Document
this model is attached to (can beNone
)
-
property
struct
¶ 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.
-
-
class
ButtonGroup
(**kwargs)[source]¶ Bases:
bokeh.models.widgets.groups.AbstractGroup
,bokeh.models.widgets.buttons.ButtonLike
Abstract base class for groups with items rendered as buttons.
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.
-
align
¶ property 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
¶ property type:
Either
(Enum
( Enumeration(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).
property type:
Enum
(ButtonType
)A style for the button, signifying it’s role.
-
css_classes
¶ property type:
List
(String
)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
¶ property type:
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
-
disabled
¶ property 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
¶ property type:
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
-
height_policy
¶ property 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.
-
js_event_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of event names to lists of
CustomJS
callbacks.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_event
method:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_change
method:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
margin
¶ property type:
Tuple
(Int
,Int
,Int
,Int
)Allows to create additional space around the component.
-
max_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
max_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
min_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
min_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
name
¶ property type:
String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
-
orientation
¶ property type:
Enum
( Enumeration(horizontal, vertical) )Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
-
sizing_mode
¶ property type:
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
andaspect_ratio
instead (those take precedence oversizing_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.
-
subscribed_events
¶ property type:
List
(String
)List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
-
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.
-
width
¶ property type:
NonNegativeInt
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
-
width_policy
¶ property 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)¶ 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
()¶ 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.
-
classmethod
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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
Added in version 1.1
- Raises
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, *callbacks)¶ 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)
-
js_on_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
- Parameters
handler (func) – handler function to call when button is clicked.
- Returns
None
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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.
-
properties_with_values
(include_defaults: bool = True) → 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.
-
query_properties_with_values
(query, include_defaults=True)¶ 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
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
themed_values
()¶ 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)¶ 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)¶ 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, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ 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, models=None, setter=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
¶ The
Document
this model is attached to (can beNone
)
-
property
struct
¶ 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.
-
-
class
CheckboxButtonGroup
(**kwargs)[source]¶ Bases:
bokeh.models.widgets.groups.ButtonGroup
A group of check boxes rendered as toggle buttons.
-
align
¶ property 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
¶ property type:
Either
(Enum
( Enumeration(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).
property type:
Enum
(ButtonType
)A style for the button, signifying it’s role.
-
css_classes
¶ property type:
List
(String
)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
¶ property type:
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
-
disabled
¶ property 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
¶ property type:
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
-
height_policy
¶ property 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.
-
js_event_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of event names to lists of
CustomJS
callbacks.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_event
method:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_change
method:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
margin
¶ property type:
Tuple
(Int
,Int
,Int
,Int
)Allows to create additional space around the component.
-
max_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
max_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
min_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
min_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
name
¶ property type:
String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
-
orientation
¶ property type:
Enum
( Enumeration(horizontal, vertical) )Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
-
sizing_mode
¶ property type:
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
andaspect_ratio
instead (those take precedence oversizing_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.
-
subscribed_events
¶ property type:
List
(String
)List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
-
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.
-
width
¶ property type:
NonNegativeInt
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
-
width_policy
¶ property 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)¶ 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
()¶ 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.
-
classmethod
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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
Added in version 1.1
- Raises
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, *callbacks)¶ 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)
-
js_on_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
- Parameters
handler (func) – handler function to call when button is clicked.
- Returns
None
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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.
-
properties_with_values
(include_defaults: bool = True) → 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.
-
query_properties_with_values
(query, include_defaults=True)¶ 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
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
themed_values
()¶ 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)¶ 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)¶ 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, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ 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, models=None, setter=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
¶ The
Document
this model is attached to (can beNone
)
-
property
struct
¶ 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.
-
-
class
CheckboxGroup
(**kwargs)[source]¶ Bases:
bokeh.models.widgets.groups.Group
A group of check boxes.
-
align
¶ property 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
¶ property type:
Either
(Enum
( Enumeration(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).
-
css_classes
¶ property type:
List
(String
)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
¶ property type:
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
-
disabled
¶ property 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
¶ property type:
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
-
height_policy
¶ property 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.
-
inline
¶ property type:
Bool
Should items be arrange vertically (
False
) or horizontally in-line (True
).
-
js_event_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of event names to lists of
CustomJS
callbacks.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_event
method:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_change
method:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
margin
¶ property type:
Tuple
(Int
,Int
,Int
,Int
)Allows to create additional space around the component.
-
max_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
max_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
min_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
min_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
name
¶ property type:
String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
-
orientation
¶ property type:
Enum
( Enumeration(horizontal, vertical) )Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
-
sizing_mode
¶ property type:
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
andaspect_ratio
instead (those take precedence oversizing_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.
-
subscribed_events
¶ property type:
List
(String
)List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
-
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.
-
width
¶ property type:
NonNegativeInt
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
-
width_policy
¶ property 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)¶ 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
()¶ 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.
-
classmethod
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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
Added in version 1.1
- Raises
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, *callbacks)¶ 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)
-
js_on_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
- Parameters
handler (func) – handler function to call when button is clicked.
- Returns
None
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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.
-
properties_with_values
(include_defaults: bool = True) → 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.
-
query_properties_with_values
(query, include_defaults=True)¶ 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
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
themed_values
()¶ 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)¶ 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)¶ 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, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ 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, models=None, setter=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
¶ The
Document
this model is attached to (can beNone
)
-
property
struct
¶ 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.
-
-
class
Group
(**kwargs)[source]¶ Bases:
bokeh.models.widgets.groups.AbstractGroup
Abstract base class for groups with items rendered as check/radio boxes.
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.
-
align
¶ property 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
¶ property type:
Either
(Enum
( Enumeration(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).
-
css_classes
¶ property type:
List
(String
)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
¶ property type:
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
-
disabled
¶ property 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
¶ property type:
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
-
height_policy
¶ property 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.
-
inline
¶ property type:
Bool
Should items be arrange vertically (
False
) or horizontally in-line (True
).
-
js_event_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of event names to lists of
CustomJS
callbacks.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_event
method:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_change
method:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
margin
¶ property type:
Tuple
(Int
,Int
,Int
,Int
)Allows to create additional space around the component.
-
max_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
max_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
min_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
min_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
name
¶ property type:
String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
-
orientation
¶ property type:
Enum
( Enumeration(horizontal, vertical) )Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
-
sizing_mode
¶ property type:
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
andaspect_ratio
instead (those take precedence oversizing_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.
-
subscribed_events
¶ property type:
List
(String
)List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
-
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.
-
width
¶ property type:
NonNegativeInt
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
-
width_policy
¶ property 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)¶ 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
()¶ 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.
-
classmethod
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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
Added in version 1.1
- Raises
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, *callbacks)¶ 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)
-
js_on_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
- Parameters
handler (func) – handler function to call when button is clicked.
- Returns
None
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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.
-
properties_with_values
(include_defaults: bool = True) → 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.
-
query_properties_with_values
(query, include_defaults=True)¶ 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
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
themed_values
()¶ 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)¶ 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)¶ 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, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ 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, models=None, setter=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
¶ The
Document
this model is attached to (can beNone
)
-
property
struct
¶ 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.
-
-
class
RadioButtonGroup
(**kwargs)[source]¶ Bases:
bokeh.models.widgets.groups.ButtonGroup
A group of radio boxes rendered as toggle buttons.
-
align
¶ property 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
¶ property type:
Either
(Enum
( Enumeration(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).
property type:
Enum
(ButtonType
)A style for the button, signifying it’s role.
-
css_classes
¶ property type:
List
(String
)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
¶ property type:
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
-
disabled
¶ property 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
¶ property type:
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
-
height_policy
¶ property 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.
-
js_event_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of event names to lists of
CustomJS
callbacks.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_event
method:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_change
method:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
margin
¶ property type:
Tuple
(Int
,Int
,Int
,Int
)Allows to create additional space around the component.
-
max_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
max_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
min_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
min_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
name
¶ property type:
String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
-
orientation
¶ property type:
Enum
( Enumeration(horizontal, vertical) )Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
-
sizing_mode
¶ property type:
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
andaspect_ratio
instead (those take precedence oversizing_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.
-
subscribed_events
¶ property type:
List
(String
)List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
-
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.
-
width
¶ property type:
NonNegativeInt
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
-
width_policy
¶ property 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)¶ 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
()¶ 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.
-
classmethod
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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
Added in version 1.1
- Raises
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, *callbacks)¶ 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)
-
js_on_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
- Parameters
handler (func) – handler function to call when button is clicked.
- Returns
None
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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.
-
properties_with_values
(include_defaults: bool = True) → 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.
-
query_properties_with_values
(query, include_defaults=True)¶ 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
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
themed_values
()¶ 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)¶ 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)¶ 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, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ 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, models=None, setter=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
¶ The
Document
this model is attached to (can beNone
)
-
property
struct
¶ 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.
-
-
class
RadioGroup
(**kwargs)[source]¶ Bases:
bokeh.models.widgets.groups.Group
A group of radio boxes.
-
align
¶ property 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
¶ property type:
Either
(Enum
( Enumeration(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).
-
css_classes
¶ property type:
List
(String
)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
¶ property type:
Int
The default size (width or height) in the dominating dimension.
The dominating dimension is determined by widget orientation.
-
disabled
¶ property 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
¶ property type:
NonNegativeInt
The height of the component (in pixels).
This can be either fixed or preferred height, depending on height sizing policy.
-
height_policy
¶ property 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.
-
inline
¶ property type:
Bool
Should items be arrange vertically (
False
) or horizontally in-line (True
).
-
js_event_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of event names to lists of
CustomJS
callbacks.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_event
method:callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
-
js_property_callbacks
¶ property type:
Dict
(String
,List
(Instance
(CustomJS
) ) )A mapping of attribute names to lists of
CustomJS
callbacks, to be set up on BokehJS side when the document is created.Typically, rather then modifying this property directly, callbacks should be added using the
Model.js_on_change
method:callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
-
margin
¶ property type:
Tuple
(Int
,Int
,Int
,Int
)Allows to create additional space around the component.
-
max_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
max_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
min_height
¶ property type:
NonNegativeInt
Minimal height of the component (in pixels) if height is adjustable.
-
min_width
¶ property type:
NonNegativeInt
Minimal width of the component (in pixels) if width is adjustable.
-
name
¶ property type:
String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
-
orientation
¶ property type:
Enum
( Enumeration(horizontal, vertical) )Orient the widget either horizontally (default) or vertically.
Note that not all widgets support vertical orientation.
-
sizing_mode
¶ property type:
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
andaspect_ratio
instead (those take precedence oversizing_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.
-
subscribed_events
¶ property type:
List
(String
)List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
-
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.
-
width
¶ property type:
NonNegativeInt
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
-
width_policy
¶ property 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)¶ 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
()¶ 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.
-
classmethod
dataspecs_with_props
()¶ Collect a dict mapping the names of all
DataSpec
properties on this class to the associated properties.This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
equals
(other)¶ 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, other, other_attr, attr_selector=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
Added in version 1.1
- Raises
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, *callbacks)¶ 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)
-
js_on_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
-
layout
(side, plot)¶
-
classmethod
lookup
(name)¶ Find the
PropertyDescriptor
for a Bokeh property on a class, given the property name.- Parameters
name (str) – name of the property to search for
- Returns
descriptor for property named
name
- Return type
-
on_change
(attr, *callbacks)¶ 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_click
(handler)¶ Set up a handler for button check/radio box clicks including the selected indices.
- Parameters
handler (func) – handler function to call when button is clicked.
- Returns
None
-
classmethod
properties
(with_bases=True)¶ Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_containers
()¶ Collect the names of all container properties on this class.
This method always traverses the class hierarchy and includes properties defined on any parent classes.
-
classmethod
properties_with_refs
()¶ 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.
-
properties_with_values
(include_defaults: bool = True) → 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.
-
query_properties_with_values
(query, include_defaults=True)¶ 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
()¶ Returns all
Models
that this object has references to.
-
remove_on_change
(attr, *callbacks)¶ Remove a callback from this object
-
select
(selector)¶ 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)¶ 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, json, models=None, setter=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, updates)¶ Update objects that match a given selector with the specified attribute/value updates.
- Parameters
selector (JSON-like) –
updates (dict) –
- Returns
None
-
themed_values
()¶ 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)¶ 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)¶ 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, old, new, hint=None, setter=None)¶
-
unapply_theme
()¶ Remove any themed values and restore defaults.
- Returns
None
-
update
(**kwargs)¶ 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, models=None, setter=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
¶ The
Document
this model is attached to (can beNone
)
-
property
struct
¶ 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.
-