Bokeh comes with a number of interactive tools.
There are five types of tool interactions:
Pan/Drag
Click/Tap
Scroll/Pinch
Actions
Inspectors
For the first three comprise the category of gesture tools, and only one tool for each gesture can be active at any given time. The active tool is indicated on the toolbar by a highlight next to the tool. Actions are immediate or modal operations that are only activated when their button in the toolbar is pressed. Inspectors are passive tools that merely report information or annotate the plot in some way, and may always be active regardless of what other tools are currently active.
Action
Bases: bokeh.models.tools.Tool
bokeh.models.tools.Tool
A base class for tools that are buttons in the toolbar.
Note
This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.
js_event_callbacks
property type: Dict ( String , List ( Instance ( CustomJS ) ) )
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:
Model.js_on_event
callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
js_property_callbacks
A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:
Model.js_on_change
callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
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', ...)]
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.
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.
tags
property type: List ( Any )
Any
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.
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
apply_theme
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).
HasProps
property_values (dict) – theme values to use in place of defaults
None
dataspecs
Collect the names of all DataSpec properties on this class.
DataSpec
This method always traverses the class hierarchy and includes properties defined on any parent classes.
names of DataSpec properties
set[str]
dataspecs_with_props
Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.
mapping of names and DataSpec properties
dict[str, DataSpec]
equals
Structural equality of models.
other (HasProps) – the other instance to compare to
True, if properties are structurally equal, otherwise False
js_link
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.
attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
other
attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr
attr
Added in version 1.1
ValueError –
Examples
This code with js_link:
select.js_link('value', plot, 'sizing_mode')
is equivalent to the following:
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
which is equivalent to:
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
js_on_change
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:
"change:property_name"
"change:"
# 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:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
PropertyDescriptor
name (str) – name of the property to search for
descriptor for property named name
on_change
Add a callback on this object to trigger when attr changes.
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
properties
Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
property names
properties_containers
Collect the names of all container properties on this class.
names of container properties
properties_with_refs
Collect the names of all properties on this class that also have references.
names of properties that have references
properties_with_values
Collect a dict mapping property names to their values.
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.
include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
mapping from property names to their values
dict
query_properties_with_values
Query the properties values of HasProps instances with a predicate.
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)
mapping of property names and values for matching properties
references
Returns all Models that this object has references to.
Models
remove_on_change
Remove a callback from this object
select
Query this object and all of its references for objects that match the given selector.
selector (JSON-like) –
seq[Model]
select_one
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
Model
set_from_json
Set a property value on this object from JSON.
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.
set_select
Update objects that match a given selector with the specified attribute/value updates.
updates (dict) –
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.
dict or None
to_json
Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json()
For most purposes it’s best to serialize and deserialize entire documents.
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
to_json_string
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).
from_json_string()
trigger
unapply_theme
Remove any themed values and restore defaults.
update
Updates the object’s properties from the given keyword arguments.
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
Updates the object’s properties from a JSON attributes dictionary.
json_attributes – (JSON-dict) : attributes and values to update
document
The Document this model is attached to (can be None)
Document
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.
{ "id": "16005", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
BoxEditTool
Bases: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap
bokeh.models.tools.EditTool
bokeh.models.tools.Drag
bokeh.models.tools.Tap
toolbar icon:
Allows drawing, dragging and deleting Rect glyphs on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. When drawing a new box the data will always be added to the ColumnDataSource on the first supplied renderer.
Rect
The tool will modify the columns on the data source corresponding to the x, y, width and height values of the glyph. Any additional columns in the data source will be padded with empty_value, when adding a new box.
x
y
width
height
empty_value
The supported actions include:
Add box: Hold shift then click and drag anywhere on the plot or double tap once to start drawing, move the mouse and double tap again to finish drawing.
Move box: Click and drag an existing box, the box will be dropped once you let go of the mouse button.
Delete box: Tap a box to select it then press <<backspace>> key while the mouse is within the plot area.
To Move or Delete multiple boxes at once:
Move selection: Select box(es) with <<shift>>+tap (or another selection tool) then drag anywhere on the plot. Selecting and then dragging on a specific box will move both.
Delete selection: Select box(es) with <<shift>>+tap (or another selection tool) then press <<backspace>> while the mouse is within the plot area.
custom_icon
property type: Image
Image
An icon to display in the toolbar.
The icon can provided as a string filename for an image, a PIL Image object, or an RGB(A) NumPy array.
custom_tooltip
A custom tooltip label to override the default name.
dimensions
property type: Enum ( Dimensions )
Enum
Dimensions
Which dimensions the box drawing is to be free in. By default, users may freely draw boxes with any dimensions. If only “width” is set, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is set, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.
property type: Either ( Bool , Int , Float , Date , Datetime , Color )
Either
Bool
Int
Float
Date
Datetime
Color
Defines the value to insert on non-coordinate columns when a new glyph is inserted into the ColumnDataSource columns, e.g. when a circle glyph defines ‘x’, ‘y’ and ‘color’ columns, adding a new point will add the x and y-coordinates to ‘x’ and ‘y’ columns and the color column will be filled with the defined empty value.
num_objects
property type: Int
Defines a limit on the number of boxes that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn box will be dropped to make space for the new box being added.
renderers
property type: List ( Instance ( Renderer ) )
Renderer
An explicit list of renderers corresponding to scatter glyphs that may be edited.
{ "custom_icon": null, "custom_tooltip": null, "dimensions": "both", "empty_value": null, "id": "16011", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "num_objects": 0, "renderers": [], "subscribed_events": [], "tags": [] }
BoxSelectTool
Bases: bokeh.models.tools.Drag
The box selection tool allows users to make selections on a Plot by showing a rectangular region by dragging the mouse or a finger over the plot area. The end of the drag event indicates the selection region is ready.
See Selected and Unselected Glyphs for information on styling selected and unselected glyphs.
Which dimensions the box selection is to be free in. By default, users may freely draw selections boxes with any dimensions. If only “width” is set, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is set, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.
names
A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.
origin
property type: Enum ( Enumeration(corner, center) )
Indicates whether the rectangular selection area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.
overlay
property type: Instance ( BoxAnnotation )
BoxAnnotation
A shaded annotation drawn to indicate the selection region.
property type: Either ( Auto , List ( Instance ( Renderer ) ) )
Auto
An explicit list of renderers to hit test against. If unset, defaults to all renderers on a plot.
select_every_mousemove
property type: Bool
Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed. Default: False
{ "dimensions": "both", "id": "16023", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "names": [], "origin": "corner", "overlay": { "id": "16024" }, "renderers": "auto", "select_every_mousemove": false, "subscribed_events": [], "tags": [] }
BoxZoomTool
The box zoom tool allows users to define a rectangular egion of a Plot to zoom to by dragging he mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.
BoxZoomTool is incompatible with GMapPlot due to the manner in which Google Maps exert explicit control over aspect ratios. Adding this tool to a GMapPlot will have no effect.
GMapPlot
Which dimensions the zoom box is to be free in. By default, users may freely draw zoom boxes with any dimensions. If only “width” is supplied, the box will be constrained to span the entire vertical space of the plot, only the horizontal dimension can be controlled. If only “height” is supplied, the box will be constrained to span the entire horizontal space of the plot, and the vertical dimension can be controlled.
match_aspect
Whether the box zoom region should be restricted to have the same aspect ratio as the plot region.
If the tool is restricted to one dimension, this value has no effect.
Indicates whether the rectangular zoom area should originate from a corner (top-left or bottom-right depending on direction) or the center of the box.
{ "dimensions": "both", "id": "16036", "js_event_callbacks": {}, "js_property_callbacks": {}, "match_aspect": false, "name": null, "origin": "corner", "overlay": { "id": "16037" }, "subscribed_events": [], "tags": [] }
CrosshairTool
Bases: bokeh.models.tools.Inspection
bokeh.models.tools.Inspection
The crosshair tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector’s menu associated with the toolbar icon shown above.
The crosshair tool draws a crosshair annotation over the plot, centered on the current mouse position. The crosshair tool may be configured to draw across only one dimension by setting the dimension property to only width or height.
dimension
Which dimensions the crosshair tool is to track. By default, both vertical and horizontal lines will be drawn. If only “width” is supplied, only a horizontal line will be drawn. If only “height” is supplied, only a vertical line will be drawn.
line_alpha
property type: Float
An alpha value to use to stroke paths with.
Acceptable values are floating point numbers between 0 (transparent) and 1 (opaque).
line_color
property type: Color
A color to use to stroke paths with.
Acceptable values are:
any of the 147 named CSS colors, e.g 'green', 'indigo'
'green'
'indigo'
an RGB(A) hex value, e.g., '#FF0000', '#44444444'
'#FF0000'
'#44444444'
a 3-tuple of integers (r,g,b) between 0 and 255
a 4-tuple of (r,g,b,a) where r,g,b are integers between 0..255 and a is between 0..1
line_width
Stroke width in units of pixels.
toggleable
Whether an on/off toggle button should appear in the toolbar for this inspection tool. If False, the viewers of a plot will not be able to toggle the inspector on or off using the toolbar.
False
{ "dimensions": "both", "id": "16047", "js_event_callbacks": {}, "js_property_callbacks": {}, "line_alpha": 1.0, "line_color": "black", "line_width": 1, "name": null, "subscribed_events": [], "tags": [], "toggleable": true }
CustomAction
Bases: bokeh.models.tools.Action
bokeh.models.tools.Action
Execute a custom action, e.g. CustomJS callback when a toolbar icon is activated.
Example
tool = CustomAction(icon="icon.png", callback=CustomJS(code='alert("foo")')) plot.add_tools(tool)
action_tooltip
Tooltip displayed when hovering over the custom action icon.
callback
property type: Instance ( Callback )
Callback
A Bokeh callback to execute when the custom action icon is activated.
icon
{ "action_tooltip": "Perform a Custom Action", "callback": null, "icon": null, "id": "16058", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
CustomJSHover
Bases: bokeh.model.Model
bokeh.model.Model
Define a custom formatter to apply to a hover tool field.
This model can be configured with JavaScript code to format hover tooltips. The JavaScript code has access to the current value to format, some special variables, and any format configured on the tooltip. The variable value will contain the untransformed value. The variable special_vars will provide a dict with the following contents:
value
special_vars
x data-space x-coordinate of the mouse
y data-space y-coordinate of the mouse
sx screen-space x-coordinate of the mouse
sx
sy screen-space y-coordinate of the mouse
sy
data_x data-space x-coordinate of the hovered glyph
data_x
data_y data-space y-coordinate of the hovered glyph
data_y
indices column indices of all currently hovered glyphs
indices
name value of the name property of the hovered glyph renderer
If the hover is over a “multi” glyph such as Patches or MultiLine then a segment_index key will also be present.
Patches
MultiLine
segment_index
Finally, the value of the format passed in the tooltip specification is available as the format variable.
format
As an example, the following code adds a custom formatter to format WebMercator northing coordinates (in meters) as a latitude:
lat_custom = CustomJSHover(code=""" var projections = Bokeh.require("core/util/projections"); var x = special_vars.x var y = special_vars.y var coords = projections.wgs84_mercator.inverse([x, y]) return "" + coords[1] """) p.add_tools(HoverTool( tooltips=[( 'lat','@y{custom}' )], formatters=dict(y=lat_custom) ))
Warning
The explicit purpose of this Bokeh Model is to embed raw JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.
args
property type: Dict ( String , Instance ( Model ) )
A mapping of names to Bokeh plot objects. These objects are made available to the callback code snippet as the values of named parameters to the callback.
code
A snippet of JavaScript code to transform a single value. The variable value will contain the untransformed value and can be expected to be present in the function namespace at render time. Additionally, the variable special_vars will be available, and will provide a dict with the following contents:
The snippet will be made into the body of a function and therefore requires a return statement.
code = ''' return value + " total" '''
{ "args": {}, "code": "", "id": "16067", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
Drag
Bases: bokeh.models.tools.Gesture
bokeh.models.tools.Gesture
A base class for tools that respond to drag events.
{ "id": "16075", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
EditTool
A base class for all interactive draw tool types.
{ "custom_icon": null, "custom_tooltip": null, "empty_value": null, "id": "16081", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "renderers": [], "subscribed_events": [], "tags": [] }
FreehandDrawTool
Allows freehand drawing of Patches and MultiLine glyphs. The glyph to draw may be defined via the renderers property.
The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared empty_value, when adding a new point.
xs
ys
Draw vertices: Click and drag to draw a line
Delete patch/multi-line: Tap a patch/multi-line to select it then press <<backspace>> key while the mouse is within the plot area.
Defines a limit on the number of patches or multi-lines that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn patch or multi-line will be overwritten when the limit is reached.
{ "custom_icon": null, "custom_tooltip": null, "empty_value": null, "id": "16091", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "num_objects": 0, "renderers": [], "subscribed_events": [], "tags": [] }
HelpTool
A button tool to provide a “help” link to users.
The hover text can be customized through the help_tooltip attribute and the redirect site overridden as well.
help_tooltip
Tooltip displayed when hovering over the help icon.
redirect
Site to be redirected through upon click.
{ "help_tooltip": "Click the question mark to learn more about Bokeh plot tools.", "id": "16102", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "redirect": "https://docs.bokeh.org/en/latest/docs/user_guide/tools.html", "subscribed_events": [], "tags": [] }
HoverTool
The hover tool is a passive inspector tool. It is generally on at all times, but can be configured in the inspector’s menu associated with the toolbar icon shown above.
By default, the hover tool displays informational tooltips whenever the cursor is directly over a glyph. The data to show comes from the glyph’s data source, and what to display is configurable with the tooltips property that maps display names to columns in the data source, or to special known variables.
tooltips
Here is an example of how to configure and use the hover tool:
# Add tooltip (name, field) pairs to the tool. See below for a # description of possible field values. hover.tooltips = [ ("index", "$index"), ("(x,y)", "($x, $y)"), ("radius", "@radius"), ("fill color", "$color[hex, swatch]:fill_color"), ("foo", "@foo"), ("bar", "@bar"), ("baz", "@baz{safe}"), ("total", "@total{$0,0.00}" ]
You can also supply a Callback to the HoverTool, to build custom interactions on hover. In this case you may want to turn the tooltips off by setting tooltips=None.
tooltips=None
When supplying a callback or custom template, the explicit intent of this Bokeh Model is to embed raw HTML and JavaScript code for a browser to execute. If any part of the code is derived from untrusted user inputs, then you must take appropriate care to sanitize the user input prior to passing to Bokeh.
Hover tool does not currently work with the following glyphs:
annulus arc bezier image image_rgba image_url oval patch quadratic ray step text
annulus
arc
bezier
image
image_rgba
image_url
oval
patch
quadratic
ray
step
text
anchor
property type: Enum ( LegendLocation )
LegendLocation
If point policy is set to “snap_to_data”, anchor defines the attachment point of a tooltip. The default is to attach to the center of a glyph.
attachment
property type: Enum ( TooltipAttachment )
TooltipAttachment
Whether the tooltip should be displayed to the left or right of the cursor position or above or below it, or if it should be automatically placed in the horizontal or vertical dimension.
A callback to run in the browser whenever the input’s value changes. The cb_data parameter that is available to the Callback code will contain two HoverTool specific fields:
cb_data
object containing the indices of the hovered points in the data source
object containing the coordinates of the hover cursor
formatters
property type: Dict ( String , Either ( Enum ( TooltipFieldFormatter ), Instance ( CustomJSHover ) ) )
TooltipFieldFormatter
Specify the formatting scheme for data source columns, e.g.
tool.formatters = {"@date": "datetime"}
will cause format specifications for the “date” column to be interpreted according to the “datetime” formatting scheme. The following schemes are available:
Provides a wide variety of formats for numbers, currency, bytes, times, and percentages. The full set of formats can be found in the NumeralTickFormatter reference documentation.
NumeralTickFormatter
Provides formats for date and time values. The full set of formats is listed in the DatetimeTickFormatter reference documentation.
DatetimeTickFormatter
Provides formats similar to C-style “printf” type specifiers. See the PrintfTickFormatter reference documentation for complete details.
PrintfTickFormatter
If no formatter is specified for a column name, the default "numeral" formatter is assumed.
"numeral"
line_policy
property type: Enum ( Enumeration(prev, next, nearest, interp, none) )
When showing tooltips for lines, designates whether the tooltip position should be the “previous” or “next” points on the line, the “nearest” point to the current mouse position, or “interpolate” along the line to the current mouse position.
mode
property type: Enum ( Enumeration(mouse, hline, vline) )
Whether to consider hover pointer as a point (x/y values), or a span on h or v directions.
point_policy
property type: Enum ( Enumeration(snap_to_data, follow_mouse, none) )
Whether the tooltip position should snap to the “center” (or other anchor) position of the associated glyph, or always follow the current mouse cursor position.
show_arrow
Whether tooltip’s arrow should be shown.
property type: Either ( String , List ( Tuple ( String , String ) ) )
Tuple
The (name, field) pairs describing what the hover tool should display when there is a hit.
Field names starting with “@” are interpreted as columns on the data source. For instance, “@temp” would look up values to display from the “temp” column of the data source.
Field names starting with “$” are special, known fields:
index of hovered point in the data source
value of the name property of the hovered glyph renderer
x-coordinate under the cursor in data space
y-coordinate under the cursor in data space
x-coordinate under the cursor in screen (canvas) space
y-coordinate under the cursor in screen (canvas) space
color data from data source, with the syntax: $color[options]:field_name. The available options are: ‘hex’ (to display the color as a hex value), and ‘swatch’ to also display a small color swatch.
$color[options]:field_name
Field names that begin with @ are associated with columns in a ColumnDataSource. For instance the field name "@price" will display values from the "price" column whenever a hover is triggered. If the hover is for the 17th glyph, then the hover tooltip will correspondingly display the 17th price value.
@
"@price"
"price"
Note that if a column name contains spaces, the it must be supplied by surrounding it in curly braces, e.g. @{adjusted close} will display values from a column named "adjusted close".
@{adjusted close}
"adjusted close"
Sometimes (especially with stacked charts) it is desirable to allow the name of the column be specified indirectly. The field name @$name is distinguished in that it will look up the name field on the hovered glyph renderer, and use that value as the column name. For instance, if a user hovers with the name "US East", then @$name is equivalent to @{US East}.
@$name
"US East"
@{US East}
By default, values for fields (e.g. @foo) are displayed in a basic numeric format. However it is possible to control the formatting of values more precisely. Fields can be modified by appending a format specified to the end in curly braces. Some examples are below.
@foo
"@foo{0,0.000}" # formats 10000.1234 as: 10,000.123 "@foo{(.00)}" # formats -10000.1234 as: (10000.123) "@foo{($ 0.00 a)}" # formats 1230974 as: $ 1.23 m
Specifying a format {safe} after a field name will override automatic escaping of the tooltip data source. Any HTML tags in the data tags will be rendered as HTML in the resulting HoverTool output. See Custom Tooltip for a more detailed example.
{safe}
None is also a valid value for tooltips. This turns off the rendering of tooltips. This is mostly useful when supplying other actions on hover via the callback property.
The tooltips attribute can also be configured with a mapping type, e.g. dict or OrderedDict. However, if a dict is used, the visual presentation order is unspecified.
OrderedDict
{ "anchor": "center", "attachment": "horizontal", "callback": null, "formatters": {}, "id": "16110", "js_event_callbacks": {}, "js_property_callbacks": {}, "line_policy": "nearest", "mode": "mouse", "name": null, "names": [], "point_policy": "snap_to_data", "renderers": "auto", "show_arrow": true, "subscribed_events": [], "tags": [], "toggleable": true, "tooltips": [ [ "index", "$index" ], [ "data (x, y)", "($x, $y)" ], [ "screen (x, y)", "($sx, $sy)" ] ] }
Inspection
A base class for tools that perform “inspections”, e.g. HoverTool.
{ "id": "16128", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "toggleable": true }
Gesture
{ "id": "16135", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
LassoSelectTool
The lasso selection tool allows users to make selections on a Plot by indicating a free-drawn “lasso” region by dragging the mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.
Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.
property type: Instance ( PolyAnnotation )
PolyAnnotation
Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed.
{ "id": "16141", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "names": [], "overlay": { "id": "16142" }, "renderers": "auto", "select_every_mousemove": true, "subscribed_events": [], "tags": [] }
PanTool
The pan tool allows the user to pan a Plot by left-dragging a mouse, or on touch devices by dragging a finger or stylus, across the plot region.
The pan tool also activates the border regions of a Plot for “single axis” panning. For instance, dragging in the vertical border or axis will effect a pan in the vertical direction only, with horizontal dimension kept fixed.
Which dimensions the pan tool is constrained to act in. By default the pan tool will pan in any dimension, but can be configured to only pan horizontally across the width of the plot, or vertically across the height of the plot.
{ "dimensions": "both", "id": "16152", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
PointDrawTool
The PointDrawTool allows adding, dragging and deleting point-like glyphs (i.e subclasses of``XYGlyph``) on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly as a list. Any newly added points will be inserted on the ColumnDataSource of the first supplied renderer.
The tool will modify the columns on the data source corresponding to the x and y values of the glyph. Any additional columns in the data source will be padded with the given empty_value when adding a new point.
The data source updates will trigger data change events continuously throughout the edit operations on the BokehJS side. In Bokeh server apps, the data source will only be synced once, when the edit operation finishes.
Add point: Tap anywhere on the plot
Move point: Tap and drag an existing point, the point will be dropped once you let go of the mouse button.
Delete point: Tap a point to select it then press <<backspace>> key while the mouse is within the plot area.
add
Enables adding of new points on tap events.
drag
Enables dragging of existing points on pan events.
Defines a limit on the number of points that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn point will be dropped to make space for the new point.
{ "add": true, "custom_icon": null, "custom_tooltip": null, "drag": true, "empty_value": null, "id": "16159", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "num_objects": 0, "renderers": [], "subscribed_events": [], "tags": [] }
PolyDrawTool
The PolyDrawTool allows drawing, selecting and deleting Patches and MultiLine glyphs on one or more renderers by editing the underlying ColumnDataSource data. Like other drawing tools, the renderers that are to be edited must be supplied explicitly.
If a vertex_renderer with an point-like glyph is supplied then the PolyDrawTool will use it to display the vertices of the multi-lines or patches on all supplied renderers. This also enables the ability to snap to existing vertices while drawing.
vertex_renderer
Add patch or multi-line: Double tap to add the first vertex, then use tap to add each subsequent vertex, to finalize the draw action double tap to insert the final vertex or press the <<esc> key.
Move patch or ulti-line: Tap and drag an existing patch/multi-line, the point will be dropped once you let go of the mouse button.
Delete patch or multi-line: Tap a patch/multi-line to select it then press <<backspace>> key while the mouse is within the plot area.
Enables dragging of existing patches and multi-lines on pan events.
Defines a limit on the number of patches or multi-lines that can be drawn. By default there is no limit on the number of objects, but if enabled the oldest drawn patch or multi-line will be dropped to make space for the new patch or multi-line.
property type: Instance ( GlyphRenderer )
GlyphRenderer
The renderer used to render the vertices of a selected line or polygon.
{ "custom_icon": null, "custom_tooltip": null, "drag": true, "empty_value": null, "id": "16172", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "num_objects": 0, "renderers": [], "subscribed_events": [], "tags": [], "vertex_renderer": null }
PolyEditTool
The PolyEditTool allows editing the vertices of one or more Patches or MultiLine glyphs. Glyphs to be edited are defined via the renderers property and a renderer for the vertices is set via the vertex_renderer property (must render a point-like Glyph (a subclass of XYGlyph).
XYGlyph
The tool will modify the columns on the data source corresponding to the xs and ys values of the glyph. Any additional columns in the data source will be padded with the declared``empty_value``, when adding a new point.
Show vertices: Double tap an existing patch or multi-line
Add vertex: Double tap an existing vertex to select it, the tool will draw the next point, to add it tap in a new location. To finish editing and add a point double tap otherwise press the <<esc> key to cancel.
Move vertex: Drag an existing vertex and let go of the mouse button to release it.
Delete vertex: After selecting one or more vertices press <<backspace>> while the mouse cursor is within the plot area.
{ "custom_icon": null, "custom_tooltip": null, "empty_value": null, "id": "16185", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "renderers": [], "subscribed_events": [], "tags": [], "vertex_renderer": null }
PolySelectTool
Bases: bokeh.models.tools.Tap
The polygon selection tool allows users to make selections on a Plot by indicating a polygonal region with mouse clicks. single clicks (or taps) add successive points to the definition of the polygon, and a double click (or tap) indicates the selection region is ready.
{ "id": "16196", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "names": [], "overlay": { "id": "16197" }, "renderers": "auto", "subscribed_events": [], "tags": [] }
ProxyToolbar
Bases: bokeh.models.tools.ToolbarBase
bokeh.models.tools.ToolbarBase
A toolbar that allow to merge and proxy tools of toolbars in multiple plots.
autohide
Whether the toolbar will be hidden by default. Default: False. If True, hides toolbar when cursor is not in canvas.
logo
property type: Enum ( Enumeration(normal, grey) )
What version of the Bokeh logo to display on the toolbar. If set to None, no logo will be displayed.
toolbars
property type: List ( Instance ( Toolbar ) )
Toolbar
tools
property type: List ( Instance ( Tool ) )
Tool
A list of tools to add to the plot.
{ "autohide": false, "id": "16206", "js_event_callbacks": {}, "js_property_callbacks": {}, "logo": "normal", "name": null, "subscribed_events": [], "tags": [], "toolbars": [], "tools": [] }
RangeTool
The range tool allows the user to update range objects for either or both of the x- or y-dimensions by dragging a corresponding shaded annotation to move it or change its boundaries.
A common use case is to add this tool to a plot with a large fixed range, but to configure the tool range from a different plot. When the user manipulates the overlay, the range of the second plot will be updated automatically.
A shaded annotation drawn to indicate the configured ranges.
x_interaction
Whether to respond to horizontal pan motions when an x_range is present.
x_range
By default, when an x_range is specified, it is possible to adjust the horizontal position of the range box by panning horizontally inside the box, or along the top or bottom edge of the box. To disable this, and fix the range box in place horizontally, set to False. (The box will still update if the x_range is updated programmatically.)
property type: Instance ( Range1d )
Range1d
A range synchronized to the x-dimension of the overlay. If None, the overlay will span the entire x-dimension.
y_interaction
Whether to respond to vertical pan motions when a y_range is present.
y_range
By default, when a y_range is specified, it is possible to adjust the vertical position of the range box by panning vertically inside the box, or along the top or bottom edge of the box. To disable this, and fix the range box in place vertically, set to False. (The box will still update if the y_range is updated programmatically.)
A range synchronized to the y-dimension of the overlay. If None, the overlay will span the entire y-dimension.
{ "id": "16216", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "overlay": { "id": "16217" }, "subscribed_events": [], "tags": [], "x_interaction": true, "x_range": null, "y_interaction": true, "y_range": null }
RedoTool
Redo tool reverses the last action performed by undo tool.
{ "id": "16228", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
ResetTool
The reset tool is an action. When activated in the toolbar, the tool resets the data bounds of the plot to their values when the plot was initially created.
{ "id": "16234", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
SaveTool
The save tool is an action. When activated, the tool opens a download dialog which allows to save an image reproduction of the plot in PNG format. If automatic download is not support by a web browser, the tool falls back to opening the generated image in a new tab or window. User then can manually save it by right clicking on the image and choosing “Save As” (or similar) menu item.
{ "id": "16240", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
Scroll
A base class for tools that respond to scroll events.
{ "id": "16246", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
Tap
A base class for tools that respond to tap/click events.
{ "id": "16252", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
TapTool
The tap selection tool allows the user to select at single points by left-clicking a mouse, or tapping with a finger.
behavior
property type: Enum ( Enumeration(select, inspect) )
This tool can be configured to either make selections or inspections on associated data sources. The difference is that selection changes propagate across bokeh and other components (e.g. selection glyph) will be notified. Inspections don’t act like this, so it’s useful to configure callback when setting behavior=’inspect’.
A callback to execute whenever a glyph is “hit” by a mouse click or tap.
This is often useful with the OpenURL model to open URLs based on a user clicking or tapping a specific glyph.
OpenURL
However, it may also be a CustomJS which can execute arbitrary JavaScript code in response to clicking or tapping glyphs. The callback will be executed for each individual glyph that is it hit by a click or tap, and will receive the TapTool model as cb_obj. The optional cb_data will have the data source as its .source attribute and the selection geometry as its .geometries attribute.
cb_obj
.source
.geometries
The .geometries attribute has 5 members. .type is the geometry type, which always a .point for a tap event. .sx and .sy are the screen X and Y coordinates where the tap occurred. .x and .y are the converted data coordinates for the item that has been selected. The .x and .y values are based on the axis assigned to that glyph.
.type
.point
.sx
.sy
.x
.y
This callback does not execute on every tap, only when a glyph is “hit”. If you would like to execute a callback on every mouse tap, please see CustomJS for User Interaction Events.
{ "behavior": "select", "callback": null, "id": "16258", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "names": [], "renderers": "auto", "subscribed_events": [], "tags": [] }
A base class for all interactive tool types.
{ "id": "16268", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
Collect tools to display for a single plot.
active_drag
property type: Either ( Auto , Instance ( Drag ) )
Specify a drag tool to be active when the plot is displayed.
active_inspect
property type: Either ( Auto , Instance ( Inspection ), Seq ( Instance ( Inspection ) ) )
Seq
Specify an inspection tool or sequence of inspection tools to be active when the plot is displayed.
active_multi
property type: Instance ( Gesture )
Specify an active multi-gesture tool, for instance an edit tool or a range tool.
Note that activating a multi-gesture tool will deactivate any other gesture tools as appropriate. For example, if a pan tool is set as the active drag, and this property is set to a BoxEditTool instance, the pan tool will be deactivated (i.e. the multi-gesture tool will take precedence).
active_scroll
property type: Either ( Auto , Instance ( Scroll ) )
Specify a scroll/pinch tool to be active when the plot is displayed.
active_tap
property type: Either ( Auto , Instance ( Tap ) )
Specify a tap/click tool to be active when the plot is displayed.
{ "active_drag": "auto", "active_inspect": "auto", "active_multi": null, "active_scroll": "auto", "active_tap": "auto", "autohide": false, "id": "16274", "js_event_callbacks": {}, "js_property_callbacks": {}, "logo": "normal", "name": null, "subscribed_events": [], "tags": [], "tools": [] }
ToolbarBase
A base class for different toolbars.
{ "autohide": false, "id": "16288", "js_event_callbacks": {}, "js_property_callbacks": {}, "logo": "normal", "name": null, "subscribed_events": [], "tags": [], "tools": [] }
ToolbarBox
Bases: bokeh.models.layouts.LayoutDOM
bokeh.models.layouts.LayoutDOM
A layoutable toolbar that can accept the tools of multiple plots, and can merge the tools into a single button for convenience.
align
property type: Either ( Enum ( Align ), Tuple ( Enum ( Align ), Enum ( Align ) ) )
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).
width / height = aspect_ratio
"auto"
background
Background color of the component.
css_classes
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.
disabled
Whether the widget will be disabled when rendered.
If True, the widget will be greyed-out and not responsive to UI events.
True
property type: NonNegativeInt
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 ) )
SizingPolicy
Describes how the component should maintain its height.
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.
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.
sizing_mode
margin
property type: Tuple ( Int , Int , Int , Int )
Allows to create additional space around the component.
max_height
Minimal height of the component (in pixels) if height is adjustable.
max_width
Minimal width of the component (in pixels) if width is adjustable.
min_height
min_width
property type: Enum ( SizingMode )
SizingMode
How the component should size itself.
This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode).
width_policy
Possible scenarios:
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.
toolbar
property type: Instance ( ToolbarBase )
A toolbar associated with a plot which holds all its tools.
visible
Whether the component will be visible and a part of a layout.
The width of the component (in pixels).
This can be either fixed or preferred width, depending on width sizing policy.
Describes how the component should maintain its width.
Use exactly width pixels. Component will overflow if it can’t fit in the available horizontal space.
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.
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.
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.
{ "align": "start", "aspect_ratio": null, "background": null, "css_classes": [], "disabled": false, "height": null, "height_policy": "auto", "id": "16297", "js_event_callbacks": {}, "js_property_callbacks": {}, "margin": [ 0, 0, 0, 0 ], "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "sizing_mode": null, "subscribed_events": [], "tags": [], "toolbar": null, "toolbar_location": "right", "visible": true, "width": null, "width_policy": "auto" }
UndoTool
Undo tool allows to restore previous state of the plot.
{ "id": "16320", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
WheelPanTool
Bases: bokeh.models.tools.Scroll
bokeh.models.tools.Scroll
The wheel pan tool allows the user to pan the plot along the configured dimension using the scroll wheel.
property type: Enum ( Dimension )
Dimension
Which dimension the wheel pan tool is constrained to act in. By default the wheel pan tool will pan the plot along the x-axis.
{ "dimension": "width", "id": "16326", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
WheelZoomTool
The wheel zoom tool will zoom the plot in and out, centered on the current mouse location.
The wheel zoom tool also activates the border regions of a Plot for “single axis” zooming. For instance, zooming in the vertical border or axis will effect a zoom in the vertical direction only, with the horizontal dimension kept fixed.
Which dimensions the wheel zoom tool is constrained to act in. By default the wheel zoom tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.
maintain_focus
Whether or not zooming tool maintains its focus position. Setting to False results in a more “gliding” behavior, allowing one to zoom out more smoothly, at the cost of losing the focus position.
speed
Speed at which the wheel zooms. Default is 1/600. Optimal range is between 0.001 and 0.09. High values will be clipped. Speed may very between browsers.
zoom_on_axis
Whether scrolling on an axis (outside the central plot area) should zoom that dimension.
{ "dimensions": "both", "id": "16333", "js_event_callbacks": {}, "js_property_callbacks": {}, "maintain_focus": true, "name": null, "speed": 0.0016666666666666668, "subscribed_events": [], "tags": [], "zoom_on_axis": true }
ZoomInTool
The zoom-in tool allows users to click a button to zoom in by a fixed amount.
Which dimensions the zoom-in tool is constrained to act in. By default the zoom-in zoom tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.
factor
property type: Percent
Percent
Percentage to zoom for each click of the zoom-in tool.
{ "dimensions": "both", "factor": 0.1, "id": "16343", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }
ZoomOutTool
The zoom-out tool allows users to click a button to zoom out by a fixed amount.
Which dimensions the zoom-out tool is constrained to act in. By default the zoom-out tool will zoom in any dimension, but can be configured to only zoom horizontally across the width of the plot, or vertically across the height of the plot.
{ "dimensions": "both", "factor": 0.1, "id": "16351", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }