Search code examples
pythontooltipbokeh

Displaying only one tooltip when using the HoverTool() tool


I am plotting very many points in Bokeh, and I have added the HoverTool to the list of tools of the figure, so that the mouse shows the x,y coordinates of the mouse when close to a glyph.

When the mouse gets close to a set of glyphs closely packed together, I get as many tooltips as glyphs. I want instead only one tooltip, the one of the closest glyph. This isn't just a presentation detail, because for very many points this results:

  • in slow interaction with the plot, with the browser getting stuck while all tooltips are generated
  • in a very long tooltip, where the same information is repeated as many times as many glyphs are close to the cursor

An example follows, with the code to replicate the behaviour: enter image description here

import numpy.random
from bokeh.plotting import figure, output_notebook, show
from bokeh.models import HoverTool
output_notebook()

hover = HoverTool()
hover.tooltips = [("(x,y)", "($x, $y)")]

x = numpy.random.randn(500)
y = numpy.random.randn(500)

p = figure(tools=[hover])
p.circle(x,y, color='red', size=14, alpha=0.4)

show(p)

Solution

  • I was having a similar problem and came up with a solution using a custom tooltip. I insert a style tag at the top that only displays the first child div under the .bk-tooltip class, which is the first tooltip.

    Here's a working example:

    from bokeh.plotting import figure, show
    from bokeh.models import HoverTool, Range1d
    
    custom_hover = HoverTool()
    
    custom_hover.tooltips = """
        <style>
            .bk-tooltip>div:not(:first-child) {display:none;}
        </style>
    
        <b>X: </b> @x <br>
        <b>Y: </b> @y
    """
    
    p = figure(tools=[custom_hover]) #Custom behavior
    #p = figure(tools=['hover'])  #Default behavior 
    
    p.circle(x=[0.75,0.75,1.25,1.25], y=[0.75,1.25,0.75,1.25], size=230, color='red', fill_alpha=0.2)
    p.y_range = Range1d(0,2)
    p.x_range = Range1d(0,2)
    
    show(p)
    

    This is kind of a hacky solution, but it works in Safari, Firefox and Chrome. I think they'll be coming out with a more long-term solution soon.