Anaconda Enterprise: Documentation

# 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 `bokeh.models.tools.``Action`(**kwargs)

  Bases: `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.

JSON Prototype

    {
      "id": "d3387ff0-10ac-4991-8411-853ed692a5c5",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``BoxSelectTool`(**kwargs)

  Bases: `bokeh.models.tools.Drag`

  toolbar 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: `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: `Enum` ( `Dimensions` )

    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: `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: `Instance` ( `BoxAnnotation` )

    A shaded annotation drawn to indicate the selection region.

  `renderers`

    property type: `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: `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": "both",
      "id": "87d33432-4165-4c90-b42c-d36751ba7ee4",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "names": [],
      "overlay": {
        "id": "b685342e-fd97-4b06-b6e7-82a2dc6fd257",
        "type": "BoxAnnotation"
      },
      "renderers": [],
      "select_every_mousemove": false,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``BoxZoomTool`(**kwargs)

  Bases: `bokeh.models.tools.Drag`

  toolbar 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: `Enum` ( `Dimensions` )

    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`

    property type: `Bool`

    Whether the box zoom region should be restricted to have the same aspect ratio as the plot region.

    Note

    If the tool is restricted to one dimension, this value has no effect.

  `overlay`

    property type: `Instance` ( `BoxAnnotation` )

    A shaded annotation drawn to indicate the selection region.

JSON Prototype

    {
      "dimensions": "both",
      "id": "742715d9-f106-4e38-b0d9-562ae2cfe14e",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "match_aspect": false,
      "name": null,
      "overlay": {
        "id": "2187961c-04b4-417c-8e94-cbdb5f07dfe4",
        "type": "BoxAnnotation"
      },
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``CrosshairTool`(**kwargs)

  Bases: `bokeh.models.tools.Inspection`

  toolbar 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: `Enum` ( `Dimensions` )

    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: `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'`
    - 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: `Float`

    Stroke width in units of pixels.

JSON Prototype

    {
      "dimensions": "both",
      "id": "a2aadc77-0992-44f6-8149-e4a32869a4c1",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "line_alpha": 1.0,
      "line_color": "black",
      "line_width": 1,
      "name": null,
      "subscribed_events": [],
      "tags": [],
      "toggleable": true
    }

class `bokeh.models.tools.``Drag`(**kwargs)

  Bases: `bokeh.models.tools.Tool`

  A base class for tools that respond to drag events.

  Note

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

JSON Prototype

    {
      "id": "2b2936af-e241-429c-b114-3a0a662b5c9a",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``HelpTool`(**kwargs)

  Bases: `bokeh.models.tools.Action`

  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`

    property type: `String`

    Tooltip displayed when hovering over the help icon.

  `redirect`

    property type: `String`

    Site to be redirected through upon click.

JSON Prototype

    {
      "help_tooltip": "Click the question mark to learn more about Bokeh plot tools.",
      "id": "cf1f5178-1a32-4c59-aadd-e6ca8a482ac0",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "redirect": "https://bokeh.pydata.org/en/latest/docs/user_guide/tools.html#built-in-tools",
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``HoverTool`(**kwargs)

  Bases: `bokeh.models.tools.Inspection`

  toolbar 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"),
          ("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`.

  Warning

  Hover tool does not currently work with the following glyphs:

  annulus arc bezier image | image_rgba image_url oval patch | quadratic ray text

  `anchor`

    property type: `Enum` ( `Anchor` )

    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` ( Enumeration(horizontal, vertical) )

    Whether tooltip’s arrow should appear in the horizontal or vertical dimension.

  `callback`

    property type: `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

  `formatters`

    property type: `Dict` ( `String` , `Enum` ( `TooltipFieldFormatter` ) )

    Specify the formatting scheme for data source columns, e.g.

        tool.formatters = dict(date="datetime")

    will cause format specifications for the “date” column to be interpreted according to the “datetime” formatting scheme. The following schemed are available:

    “numeral”: | 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.
    “datetime”: | Provides formats for date and time values. The full set of formats is listed in the `DatetimeTickFormatter` reference documentation.
    “printf”: | Provides formats similar to C-style “printf” type specifiers. See the `PrintfTickFormatter` reference documentation for complete details.

    If no formatter is specified for a column name, the default `"numeral"` formatter is assumed.

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

  `names`

    property type: `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: `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.

  `renderers`

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

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

  `show_arrow`

    property type: `Bool`

    Whether tooltip’s arrow should be showed.

  `tooltips`

    property type: `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.

    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.

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

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

    `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

    {
      "anchor": "center",
      "attachment": "horizontal",
      "callback": null,
      "formatters": {},
      "id": "84bdb13b-0b6f-4a9b-a05a-a28e1c1e6fcf",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "line_policy": "nearest",
      "mode": "mouse",
      "name": null,
      "names": [],
      "point_policy": "snap_to_data",
      "renderers": [],
      "show_arrow": true,
      "subscribed_events": [],
      "tags": [],
      "toggleable": true,
      "tooltips": [
        [
          "index",
          "$index"
        ],
        [
          "data (x, y)",
          "($x, $y)"
        ],
        [
          "canvas (x, y)",
          "($sx, $sy)"
        ]
      ]
    }

class `bokeh.models.tools.``Inspection`(**kwargs)

  Bases: `bokeh.models.tools.Tool`

  A base class for tools that perform “inspections”, e.g. `HoverTool`.

  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.

  `toggleable`

    property type: `Bool`

    Whether an on/off toggle button should appear in the toolbar for this inpection tool. If `False`, the viewers of a plot will not be able to toggle the inspector on or off using the toolbar.

JSON Prototype

    {
      "id": "f604f64c-d224-4f6b-8077-0d94271b9c48",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": [],
      "toggleable": true
    }

class `bokeh.models.tools.``LassoSelectTool`(**kwargs)

  Bases: `bokeh.models.tools.Drag`

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

  `callback`

    property type: `Instance` ( `Callback` )

    A callback to run in the browser on every selection of a lasso area. The cb_data parameter that is available to the Callback code will contain one LassoSelectTool-specific field:

    Geometry: | object containing the coordinates of the lasso area

  `names`

    property type: `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: `Instance` ( `PolyAnnotation` )

    A shaded annotation drawn to indicate the selection region.

  `renderers`

    property type: `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: `Bool`

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

JSON Prototype

    {
      "callback": null,
      "id": "85cb40ce-0b20-43bc-85b2-9eb2d227229d",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "names": [],
      "overlay": {
        "id": "d10267a1-b091-4836-a014-928a4220c2a3",
        "type": "PolyAnnotation"
      },
      "renderers": [],
      "select_every_mousemove": true,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``PanTool`(**kwargs)

  Bases: `bokeh.models.tools.Drag`

  toolbar 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: `Enum` ( `Dimensions` )

    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": "both",
      "id": "cb061306-27b1-4a0c-8f4b-5bf3dfcf5688",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``PolySelectTool`(**kwargs)

  Bases: `bokeh.models.tools.Tap`

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

  `callback`

    property type: `Instance` ( `Callback` )

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

    Geometry: | object containing the coordinates of the polygon

  `names`

    property type: `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: `Instance` ( `PolyAnnotation` )

    A shaded annotation drawn to indicate the selection region.

  `renderers`

    property type: `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": "ebefdee7-b75d-4ab2-b93c-2641be1b6863",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "names": [],
      "overlay": {
        "id": "9be47eae-de18-4918-9337-8de109ec7185",
        "type": "PolyAnnotation"
      },
      "renderers": [],
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``RedoTool`(**kwargs)

  Bases: `bokeh.models.tools.Action`

  toolbar icon:

  Redo tool reverses the last action performed by undo tool.

JSON Prototype

    {
      "id": "51def5fc-4d9a-438e-a4c1-d05ba25eb7dc",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``ResetTool`(**kwargs)

  Bases: `bokeh.models.tools.Action`

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

  Optionally, the reset tool also resets the plat canvas dimensions to their original size

  `reset_size`

    property type: `Bool`

    Whether activating the Reset tool should also reset the plot’s canvas dimensions to their original size.

JSON Prototype

    {
      "id": "d116bf24-86d3-4172-8fc4-38ac64aaf94a",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "reset_size": true,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``ResizeTool`

  DEPRECATED in 0.12.7, attempting to use will be a NO-OP

class `bokeh.models.tools.``SaveTool`(**kwargs)

  Bases: `bokeh.models.tools.Action`

  toolbar icon:

  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.

JSON Prototype

    {
      "id": "89623484-1ea4-450e-9baa-d8047a7fd299",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``Scroll`(**kwargs)

  Bases: `bokeh.models.tools.Tool`

  A base class for tools that respond to scroll events.

  Note

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

JSON Prototype

    {
      "id": "68e7ef4d-7627-433e-ba36-4a366cf376a7",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``Tap`(**kwargs)

  Bases: `bokeh.models.tools.Tool`

  A base class for tools that respond to tap/click events.

  Note

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

JSON Prototype

    {
      "id": "82ddfb0f-ba64-4a01-923a-7fb31afa0a5b",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``TapTool`(**kwargs)

  Bases: `bokeh.models.tools.Tap`

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

  `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. Inspecions don’t act like this, so it’s useful to configure callback when setting behavior=’inspect’.

  `callback`

    property type: `Instance` ( `Callback` )

    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.

    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.

    Note

    This callback does not execute on every tap, only when a glyphs is “hit”. If you would like to execute a callback on every mouse tap, please see CustomJS for User Interaction Events.

  `names`

    property type: `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: `List` ( `Instance` ( `Renderer` ) )

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

JSON Prototype

    {
      "behavior": "select",
      "callback": null,
      "id": "c946c3bb-f0e7-4584-93f3-03ac720c9977",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "names": [],
      "renderers": [],
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``Tool`(**kwargs)

  Bases: `bokeh.model.Model`

  A base class for all interactive tool types.

  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.

  `plot`

JSON Prototype

    {
      "id": "32d5179d-06ca-4cb8-ad54-09d32e5d40ab",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``Toolbar`(**kwargs)

  Bases: `bokeh.models.tools.ToolbarBase`

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

    Specify an inspection tool or sequence of inspection tools to be active when the plot is displayed.

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

JSON Prototype

    {
      "active_drag": "auto",
      "active_inspect": "auto",
      "active_scroll": "auto",
      "active_tap": "auto",
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "53fd6845-5cfd-429c-9edc-0cfbf2e78b94",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "logo": "normal",
      "name": null,
      "sizing_mode": null,
      "subscribed_events": [],
      "tags": [],
      "tools": [],
      "width": null
    }

class `bokeh.models.tools.``ToolbarBase`(**kwargs)

  Bases: `bokeh.models.layouts.LayoutDOM`

  A base class for different toolbars.

  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.

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

  `tools`

    property type: `List` ( `Instance` ( `Tool` ) )

    A list of tools to add to the plot.

JSON Prototype

    {
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "5a5836f6-7f8a-4a4c-9184-fe7ae8c5ae34",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "logo": "normal",
      "name": null,
      "sizing_mode": null,
      "subscribed_events": [],
      "tags": [],
      "tools": [],
      "width": null
    }

class `bokeh.models.tools.``ToolbarBox`(*args, **kwargs)

  Bases: `bokeh.models.layouts.Box`

  A layoutable toolbar that can accept the tools of multiple plots, and can merge the tools into a single button for convenience.

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

  `merge_tools`

    property type: `Bool`

    Merge all the tools together so there is one tool to control all the plots.

  `toolbar_location`

    property type: `Enum` ( `Location` )

    Should the toolbar be presented as if it was stuck to the above, right, left, below edge of a plot. Default is right.

  `tools`

    property type: `List` ( `Instance` ( `Tool` ) )

    A list of tools to add to the plot.

JSON Prototype

    {
      "children": [],
      "css_classes": null,
      "disabled": false,
      "height": null,
      "id": "e26ba328-2761-4915-8a24-667c77cbd321",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "logo": "normal",
      "merge_tools": true,
      "name": null,
      "sizing_mode": "fixed",
      "subscribed_events": [],
      "tags": [],
      "toolbar_location": "right",
      "tools": [],
      "width": null
    }

class `bokeh.models.tools.``UndoTool`(**kwargs)

  Bases: `bokeh.models.tools.Action`

  toolbar icon:

  Undo tool allows to restore previous state of the plot.

JSON Prototype

    {
      "id": "bebe9462-a46d-4724-9df9-11c4579c80b2",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``WheelPanTool`(**kwargs)

  Bases: `bokeh.models.tools.Scroll`

  toolbar icon:

  The wheel pan tool allows the user to pan the plot along the configured dimension using the scroll wheel.

  `dimension`

    property type: `Enum` ( `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.

JSON Prototype

    {
      "dimension": "width",
      "id": "e698dafa-85d0-4bb6-b22f-18be8ae76317",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``WheelZoomTool`(**kwargs)

  Bases: `bokeh.models.tools.Scroll`

  toolbar 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: `Enum` ( `Dimensions` )

    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": "both",
      "id": "2344fc43-a91e-4c96-9ac2-9ab36e253a28",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``ZoomInTool`(**kwargs)

  Bases: `bokeh.models.tools.Action`

  toolbar icon:

  The zoom-in tool allows users to click a button to zoom in by a fixed amount.

  `dimensions`

    property type: `Enum` ( `Dimensions` )

    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`

    Percentage to zoom for each click of the zoom-in tool.

JSON Prototype

    {
      "dimensions": "both",
      "factor": 0.1,
      "id": "8df6fd66-87c6-4415-aa2f-18f2f0a24151",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

class `bokeh.models.tools.``ZoomOutTool`(**kwargs)

  Bases: `bokeh.models.tools.Action`

  toolbar icon:

  The zoom-out tool allows users to click a button to zoom out by a fixed amount.

  `dimensions`

    property type: `Enum` ( `Dimensions` )

    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.

  `factor`

    property type: `Percent`

    Percentage to zoom for each click of the zoom-in tool.

JSON Prototype

    {
      "dimensions": "both",
      "factor": 0.1,
      "id": "f1b3cac8-e782-47e5-8668-fa85a7127271",
      "js_event_callbacks": {},
      "js_property_callbacks": {},
      "name": null,
      "subscribed_events": [],
      "tags": []
    }

`bokeh.models.tools.``DEFAULT_BOX_OVERLAY`()

`bokeh.models.tools.``DEFAULT_POLY_OVERLAY`()