bokeh.models.tools

Bokeh comes with a number of interactive tools.

There are five types of tool interactions:

  • Pan/Drag
  • Click/Tap
  • Scroll/Pinch
  • Actions
  • Inspectors

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

class BoxSelectTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: box_select_icon

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

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

callback

property type: callback:Instance(Callback)

A callback to run in the browser on completion of drawing a selection box. The cb_data parameter that is available to the Callback code will contain one BoxSelectTool-specific field:

Geometry:object containing the coordinates of the selection box
dimensions

property type: dimensions:List(Enum(‘width’, ‘height’, ‘x’, ‘y’))

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

names

property type: names:List(String)

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

overlay

property type: overlay:Instance(BoxAnnotation)

A shaded annotation drawn to indicate the selection region.

renderers

property type: renderers:List(Instance(Renderer))

An explicit list of renderers to hit test again. If unset, defaults to all renderers on a plot.

select_every_mousemove

property type: select_every_mousemove:Bool

Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed. Default: False

JSON Prototype
{
  "callback": null,
  "dimensions": [
    "width",
    "height"
  ],
  "id": "ffaddb5d-d74b-4fff-8d37-609a1056babf",
  "name": null,
  "names": [],
  "overlay": {
    "id": "bd409b81-6afa-418b-863b-ebaad96da189",
    "type": "BoxAnnotation"
  },
  "plot": null,
  "renderers": [],
  "select_every_mousemove": false,
  "tags": []
}
class BoxZoomTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: box_zoom_icon

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

dimensions

property type: dimensions:List(Enum(‘width’, ‘height’, ‘x’, ‘y’))

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.

overlay

property type: overlay:Instance(BoxAnnotation)

A shaded annotation drawn to indicate the selection region.

JSON Prototype
{
  "dimensions": [
    "width",
    "height"
  ],
  "id": "88f4e86c-cb0e-4870-bc9d-a25467a6b8ba",
  "name": null,
  "overlay": {
    "id": "33363f49-b88a-48ba-9f7b-1d9954bc2407",
    "type": "BoxAnnotation"
  },
  "plot": null,
  "tags": []
}
class CrosshairTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: inspector_icon

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

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

dimensions

property type: dimensions:List(Enum(‘width’, ‘height’, ‘x’, ‘y’))

Which dimensions the crosshair tool is to track. By default, both a vertical and horizontal line 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: line_alpha: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: line_color:Color

A color to use to stroke paths with.

Acceptable values are:

  • any of the 147 named CSS colors, e.g 'green', 'indigo'
  • an RGB(A) hex value, e.g., '#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

property type: line_width:Float

Stroke width in units of pixels.

JSON Prototype
{
  "dimensions": [
    "width",
    "height"
  ],
  "id": "e2fcce1c-1364-4ac0-9f6d-a0c9b95ba4f7",
  "line_alpha": 1.0,
  "line_color": "black",
  "line_width": 1,
  "name": null,
  "plot": null,
  "tags": []
}
class HelpTool(**kwargs)

Bases: bokeh.models.tools.Tool

The help tool is a widget designed to replace the hardcoded ‘Help’ link. The hover text can be customized through the help_tooltip attribute and the redirect site overridden as well.

help_tooltip

property type: help_tooltip:String

Tooltip displayed when hovering over the help icon.

redirect

property type: redirect:String

Site to be redirected through upon click.

JSON Prototype
{
  "help_tooltip": "Click the question mark to learn more about Bokeh plot tools.",
  "id": "6a1390ba-3251-4051-8907-32187bdead1b",
  "name": null,
  "plot": null,
  "redirect": "http://bokeh.pydata.org/en/latest/docs/user_guide/tools.html",
  "tags": []
}
class HoverTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: inspector_icon

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

By default, the hover tool displays informational tooltips whenever the cursor is directly over a glyph. The data to show comes from the glyph’s data source, and what is to be displayed is configurable with the tooltips attribute that maps display names to columns in the data source, or to special known variables.

Here is an example of how to configure and use the hover tool:

# Add tooltip (name, field) pairs to the tool. See below for a
# description of possible field values.
hover.tooltips = [
    ("index", "$index"),
    ("(x,y)", "($x, $y)"),
    ("radius", "@radius"),
    ("fill color", "$color[hex, swatch]:fill_color"),
    ("foo", "@foo"),
    ("bar", "@bar"),
]

You can also supply a Callback to the HoverTool, to build custom interactions on hover. In this case you may want to turn the tooltips off by setting tooltips=None.

Warning

Hover tool does not currently work with the following glyphs:

  • annulus
  • arc
  • bezier
  • gear
  • image
  • image_rgba
  • image_url
  • multi_line
  • oval
  • patch
  • quadratic
  • ray
  • segment
  • text
always_active

property type: always_active:Bool

Whether the hover tool must be explicitly activated.

callback

property type: callback:Instance(Callback)

A callback to run in the browser whenever the input’s value changes. The cb_data parameter that is available to the Callback code will contain two HoverTool specific fields:

Index:object containing the indices of the hovered points in the data source
Geometry:object containing the coordinates of the hover cursor
line_policy

property type: line_policy:Enum(‘prev’, ‘next’, ‘nearest’, ‘interp’, ‘none’)

When showing tooltips for lines, 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: mode:Enum(‘mouse’, ‘hline’, ‘vline’)

Whether to consider hover pointer as a point (x/y values), or a span on h or v directions.

names

property type: names:List(String)

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

point_policy

property type: point_policy:Enum(‘snap_to_data’, ‘follow_mouse’, ‘none’)

Whether the tooltip position should snap to the “center” position of the associated glyph, or always follow the current mouse cursor position.

renderers

property type: renderers:List(Instance(Renderer))

An explicit list of renderers to hit test again. If unset, defaults to all renderers on a plot.

tooltips

property type: tooltips:Either(String, List(Tuple(String, String)))

The (name, field) pairs describing what the hover tool should display when there is a hit.

Field names starting with “@” are interpreted as columns on the data source. For instance, “@temp” would look up values to display from the “temp” column of the data source.

Field names starting with “$” are special, known fields:

$index:index of selected point in the data source
$x:x-coordinate under the cursor in data space
$y:y-coordinate under the cursor in data space
$sx:x-coordinate under the cursor in screen (canvas) space
$sy:y-coordinate under the cursor in screen (canvas) space
$color:color data from data source, with the syntax: $color[options]:field_name. The available options are: ‘hex’ (to display the color as a hex value), and ‘swatch’ to also display a small color swatch.

None is also a valid value for tooltips. This turns off the rendering of tooltips. This is mostly useful when supplying other actions on hover via the callback property.

Note

The tooltips attribute can also be configured with a mapping type, e.g. dict or OrderedDict. However, if a dict is used, the visual presentation order is unspecified.

JSON Prototype
{
  "always_active": true,
  "callback": null,
  "id": "0e21bc6e-b8b2-4909-99ed-9eb02147cc36",
  "line_policy": "prev",
  "mode": "mouse",
  "name": null,
  "names": [],
  "plot": null,
  "point_policy": "snap_to_data",
  "renderers": [],
  "tags": [],
  "tooltips": [
    [
      "index",
      "$index"
    ],
    [
      "data (x, y)",
      "($x, $y)"
    ],
    [
      "canvas (x, y)",
      "($sx, $sy)"
    ]
  ]
}
class LassoSelectTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: lasso_select_icon

The lasso selection tool allows users to make selections on a Plot by indicating a free-drawn “lasso” region by dragging the mouse or a finger over the plot region. The end of the drag event indicates the selection region is ready.

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

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

names

property type: names:List(String)

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

overlay

property type: overlay:Instance(PolyAnnotation)

A shaded annotation drawn to indicate the selection region.

renderers

property type: renderers:List(Instance(Renderer))

An explicit list of renderers to hit test again. If unset, defaults to all renderers on a plot.

select_every_mousemove

property type: select_every_mousemove:Bool

Whether a selection computation should happen on every mouse event, or only once, when the selection region is completed. Default: True

JSON Prototype
{
  "id": "f356f8dd-ff96-40d2-8c04-1ab3272efba5",
  "name": null,
  "names": [],
  "overlay": {
    "id": "eeca84aa-6bf7-4007-8c69-7ea935270565",
    "type": "PolyAnnotation"
  },
  "plot": null,
  "renderers": [],
  "select_every_mousemove": true,
  "tags": []
}
class PanTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: pan_icon

The pan tool allows the user to pan a Plot by left-dragging a mouse, or on touch devices by dragging a finger or stylus, across the plot region.

The pan tool also activates the border regions of a Plot for “single axis” panning. For instance, dragging in the vertical border or axis will effect a pan in the vertical direction only, with the horizontal dimension kept fixed.

dimensions

property type: dimensions:List(Enum(‘width’, ‘height’, ‘x’, ‘y’))

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.

JSON Prototype
{
  "dimensions": [
    "width",
    "height"
  ],
  "id": "3d034597-07b7-4e7b-b1c2-c5cc16f4bcbf",
  "name": null,
  "plot": null,
  "tags": []
}
class PolySelectTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: poly_select_icon

The polygon selection tool allows users to make selections on a Plot by indicating a polygonal region with mouse clicks. single clicks (or taps) add successive points to the definition of the polygon, and a double click (or tap) indicates the selection region is ready.

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

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

names

property type: names:List(String)

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

overlay

property type: overlay:Instance(PolyAnnotation)

A shaded annotation drawn to indicate the selection region.

renderers

property type: renderers:List(Instance(Renderer))

An explicit list of renderers to hit test again. If unset, defaults to all renderers on a plot.

JSON Prototype
{
  "id": "30a18aa1-2263-4db7-83fb-0f17e77563e3",
  "name": null,
  "names": [],
  "overlay": {
    "id": "a559f5e7-4d54-4c99-939b-1dfb82065382",
    "type": "PolyAnnotation"
  },
  "plot": null,
  "renderers": [],
  "tags": []
}
class PreviewSaveTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: save_icon

The preview/save tool is an action. When activated in the toolbar, the tool presents a modal dialog with an image reproduction of the Plot, which may be saved as a png image by right clicking on the image.

Note

Work is ongoing to support headless (svg, png) image creation without requiring user interaction. See issue 538 to track progress or contribute.

JSON Prototype
{
  "id": "d6919318-41ff-4cc6-8a63-7897cf64b716",
  "name": null,
  "plot": null,
  "tags": []
}
class ResetTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: reset_icon

The reset tool is an action. When activated in the toolbar, the tool resets the data bounds of the plot to their values when the plot was initially created.

Note

This tool does not also reset the plot canvas size, if the plot has been resized using the ResizeTool. That feature may be added in a future release.

JSON Prototype
{
  "id": "f89c14b3-498d-4a7d-b0ec-31dd49c6c7d2",
  "name": null,
  "plot": null,
  "tags": []
}
class ResizeTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: resize_icon

The resize tool allows the user to left-drag a mouse or drag a finger to resize the entire plot area on the screen.

JSON Prototype
{
  "id": "08da2be1-2bba-4abd-9d04-077993e97155",
  "name": null,
  "plot": null,
  "tags": []
}
class TapTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: tap_select_icon

The tap selection tool allows the user to select at single points by left-clicking a mouse, or tapping with a finger.

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

Note

Selections can be comprised of multiple regions, even those made by different selection tools. Hold down the <<shift>> key while making a selection to append the new selection to any previous selection that might exist.

callback

property type: callback:Instance(Callback)

A client-side action specification, like opening a URL, showing a dialog box, etc. See Action for details.

names

property type: names:List(String)

A list of names to query for. If set, only renderers that have a matching value for their name attribute will be used.

renderers

property type: renderers:List(Instance(Renderer))

An explicit list of renderers to hit test again. If unset, defaults to all renderers on a plot.

JSON Prototype
{
  "callback": null,
  "id": "b28c2bee-4a26-4408-920a-5c00a2a5e8f2",
  "name": null,
  "names": [],
  "plot": null,
  "renderers": [],
  "tags": []
}
class Tool(**kwargs)

Bases: bokeh.model.Model

A base class for all interactive tool types. Tool is not generally useful to instantiate on its own.

plot

property type: plot:Instance(Plot)

The Plot that this tool will act on.

JSON Prototype
{
  "id": "556ed5a4-fbb8-49a3-9871-313d42572baa",
  "name": null,
  "plot": null,
  "tags": []
}
class ToolEvents(**kwargs)

Bases: bokeh.model.Model

geometries

property type: geometries:List(Dict(String, Any))

JSON Prototype
{
  "geometries": [],
  "id": "f015e481-9cc7-4406-a579-fdee57cb9574",
  "name": null,
  "tags": []
}
class WheelZoomTool(**kwargs)

Bases: bokeh.models.tools.Tool

toolbar icon: wheel_zoom_icon

The wheel zoom tool will zoom the plot in and out, centered on the current mouse location.

The wheel zoom tool also activates the border regions of a Plot for “single axis” zooming. For instance, zooming in the vertical border or axis will effect a zoom in the vertical direction only, with the horizontal dimension kept fixed.

dimensions

property type: dimensions:List(Enum(‘width’, ‘height’, ‘x’, ‘y’))

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.

JSON Prototype
{
  "dimensions": [
    "width",
    "height"
  ],
  "id": "0a9f63a8-95ec-4073-9983-b4cfe7ad3f1f",
  "name": null,
  "plot": null,
  "tags": []
}
DEFAULT_BOX_OVERLAY()
DEFAULT_POLY_OVERLAY()