Bokeh - Plot Tools



When a Bokeh plot is rendered, normally a tool bar appears on the right side of the figure. It contains a default set of tools. First of all, the position of toolbar can be configured by toolbar_location property in figure() function. This property can take one of the following values −

  • "above"
  • "below"
  • "left"
  • "right"
  • "None"

For example, following statement will cause toolbar to be displayed below the plot −

Fig = figure(toolbar_location = "below")

This toolbar can be configured according to the requirement by adding required from various tools defined in bokeh.models module. For example −

Fig.add_tools(WheelZoomTool())

The tools can be classified under following categories −

  • Pan/Drag Tools
  • Click/Tap Tools
  • Scroll/Pinch Tools
Tool Description Icon

BoxSelectTool

Name : 'box_select'

allows the user to define a rectangular selection region by left-dragging a mouse BoxSelectTool

LassoSelectTool

name: 'lasso_select

allows the user to define an arbitrary region for selection by left-dragging a mouse LassoSelectTool

PanTool

name: 'pan', 'xpan', 'ypan',

allows the user to pan the plot by left-dragging a mouse PanTool

TapTool

name: 'tap

allows the user to select at single points by clicking a left mouse button TapTool

WheelZoomTool

name: 'wheel_zoom', 'xwheel_zoom', 'ywheel_zoom'

zoom the plot in and out, centered on the current mouse location. WheelZoomTool

WheelPanTool

name: 'xwheel_pan', 'ywheel_pan'

translate the plot window along the specified dimension without changing the window’s aspect ratio. WheelPanTool

ResetTool

name: 'reset'

restores the plot ranges to their original values. ResetTool

SaveTool

name: 'save'

allows the user to save a PNG image of the plot. SaveTool

ZoomInTool

name: 'zoom_in', 'xzoom_in', 'yzoom_in'

The zoom-in tool will increase the zoom of the plot in x, y or both coordinates ZoomInTool

ZoomOutTool

name: 'zoom_out', 'xzoom_out', 'yzoom_out'

The zoom-out tool will decrease the zoom of the plot in x, y or both coordinates ZoomInTool

CrosshairTool

name: 'crosshair'

draws a crosshair annotation over the plot, centered on the current mouse position. ZoomInTool
Advertisements