text: """ Bokeh comes with a number of interactive tools.
  
  There are five types of tool interactions:
  
  .. hlist::
      :columns: 5
  
      * 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.
  
  """
  from __future__ import absolute_import
  
  from ..plot_object import PlotObject
  from ..properties import Any, Bool, String, Enum, Instance, Either, List, Dict, Tuple
  from ..enums import Dimension
  
  from .renderers import Renderer
  from .callbacks import Callback
  
  
  
  class ToolEvents(PlotObject):
      """
  
      """
  
      geometries = List(Dict(String, Any))
  
  
  class Tool(PlotObject):
      """ A base class for all interactive tool types. ``Tool`` is
      not generally useful to instantiate on its own.
  
      """
  
      plot = Instance(".models.plots.Plot", help="""
      The Plot that this tool will act on.
      """)
  
  
  class PanTool(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.
  
      .. |pan_icon| image:: /_images/icons/Pan.png
          :height: 18pt
  
      """
  
      dimensions = List(Enum(Dimension), default=["width", "height"], help="""
      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.
      """)
  
  
  class WheelZoomTool(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.
  
      .. |wheel_zoom_icon| image:: /_images/icons/WheelZoom.png
          :height: 18pt
  
      """
  
      dimensions = List(Enum(Dimension), default=["width", "height"], help="""
      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.
      """)
  
  
  class PreviewSaveTool(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
          requireing user interaction. See  :bokeh-issue:`538` to track progress
          or contribute.
  
      .. |save_icon| image:: /_images/icons/Save.png
          :height: 18pt
  
      """
  
  
  class ResetTool(Tool):
      """ *toolbar icon*: |reset_icon|
  
      The reset tool is an action. When activated in teh 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.
  
      .. |reset_icon| image:: /_images/icons/Reset.png
          :height: 18pt
      """
  
  
  class ResizeTool(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.
  
      .. |resize_icon| image:: /_images/icons/Resize.png
          :height: 18pt
  
      """
  
  
  class TapTool(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 :ref:`userguide_styling_selected_unselected_glyphs` for information
      on styling selected and unselected glyphs.
  
      .. |tap_select_icon| image:: /_images/icons/TapSelect.png
          :height: 18pt
  
      .. 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 seletion that might exist.
      """
  
      names = List(String, help="""
      A list of names to query for. If set, only renderers that
      have a matching value for their ``name`` attribute will be used.
      """)
  
      renderers = List(Instance(Renderer), help="""
      An explicit list of renderers to hit test again. If unset,
      defaults to all renderers on a plot.
      """)
  
      callback = Instance(Callback, help="""
      A client-side action specification, like opening a URL, showing
      a dialog box, etc. See :class:`~bokeh.models.actions.Action` for details.
      """)
  
      always_active = Bool(True, help="""
      Whether the hover tool must be explicitly activated.
      """)
  
  
  class CrosshairTool(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``.
  
      .. |inspector_icon| image:: /_images/icons/Inspector.png
          :height: 18pt
  
      """
  
      dimensions = List(Enum(Dimension), default=["width", "height"], help="""
      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.
      """)
  
  
  class BoxZoomTool(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.
  
      .. |box_zoom_icon| image:: /_images/icons/BoxZoom.png
          :height: 18pt
  
      """
  
      dimensions = List(Enum(Dimension), default=["width", "height"], help="""
      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.
      """)
  
  
  class BoxSelectTool(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 :ref:`userguide_styling_selected_unselected_glyphs` for information
      on styling selected and unselected glyphs.
  
  
      .. |box_select_icon| image:: /_images/icons/BoxSelect.png
          :height: 18pt
  
      """
  
      names = List(String, help="""
      A list of names to query for. If set, only renderers that
      have a matching value for their ``name`` attribute will be used.
      """)
  
      renderers = List(Instance(Renderer), help="""
      An explicit list of renderers to hit test again. If unset,
      defaults to all renderers on a plot.
      """)
  
      select_every_mousemove = Bool(True, help="""
      An explicit list of renderers to hit test again. If unset,
      defaults to all renderers on a plot.
      """)
  
      dimensions = List(Enum(Dimension), default=["width", "height"], help="""
      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.
      """)
  
      callback = Instance(Callback, help="""
      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
      """)
  
  
  class BoxSelectionOverlay(Renderer):
      """ An overlay renderer that Tool objects can use to render a
      'rubber band' selection box on a Plot.
  
      """
  
      __view_model__ = 'BoxSelection'
  
      tool = Instance(Tool, help="""
      The tool that this overlay should respond to.
      """)
  
  
  class LassoSelectTool(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 :ref:`userguide_styling_selected_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 seletion that might exist.
  
      .. |lasso_select_icon| image:: /_images/icons/LassoSelect.png
          :height: 18pt
      """
  
      names = List(String, help="""
      A list of names to query for. If set, only renderers that
      have a matching value for their ``name`` attribute will be used.
      """)
  
      renderers = List(Instance(Renderer), help="""
      An explicit list of renderers to hit test again. If unset,
      defaults to all renderers on a plot.
      """)
  
      select_every_mousemove = Bool(True, help="""
      Whether a selection computation should happen on every mouse
      event, or only once, when the selection region is completed.
      """)
  
  
  class PolySelectTool(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 :ref:`userguide_styling_selected_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 seletion that might exist.
  
      .. |poly_select_icon| image:: /_images/icons/PolygonSelect.png
          :height: 18pt
      """
  
      names = List(String, help="""
      A list of names to query for. If set, only renderers that
      have a matching value for their ``name`` attribute will be used.
      """)
  
      renderers = List(Instance(Renderer), help="""
      An explicit list of renderers to hit test again. If unset,
      defaults to all renderers on a plot.
      """)
  
  
  class HoverTool(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:
  
          .. hlist::
              :columns: 3
  
              * annulus
              * arc
              * bezier
              * gear
              * image
              * image_rgba
              * image_url
              * multi_line
              * oval
              * patch
              * quadratic
              * ray
              * segment
              * text
  
      .. |hover_icon| image:: /_images/icons/Inspector.png
          :height: 18pt
      """
  
      names = List(String, help="""
      A list of names to query for. If set, only renderers that
      have a matching value for their ``name`` attribute will be used.
      """)
  
      renderers = List(Instance(Renderer), help="""
      An explicit list of renderers to hit test again. If unset,
      defaults to all renderers on a plot.
      """)
  
      callback = Instance(Callback, help="""
      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
      """)
  
      tooltips = Either(String, List(Tuple(String, String)), help="""
      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 unpecified.
  
      """).accepts(Dict(String, String), lambda d: list(d.items()))
  
      always_active = Bool(True, help="""
      Whether the hover tool must be explicitly activated.
      """)
  
      mode = Enum("mouse", "hline", "vline", help="""
      Whether to consider hover pointer as a point (x/y values), or a
      span on h or v directions.
      """)
  
      point_policy = Enum("snap_to_data", "follow_mouse", "none", help="""
      Whether the tooltip position should snap to the "center" position of
      the associated glyph, or always follow the current mouse cursor
      position.
      """)
  
      line_policy = Enum("prev", "next", "nearest", "interp", "none", help="""
      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.
      """)
  
  
  class HelpTool(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 = String(help="""
      Tooltip displayed when hovering over the help icon.
      """)
  
      redirect = String(help="""
      Site to be redirected through upon click.
      """)
  