Make tools active state updateable

[birdsarah]

#4522 offers the ability to set tools that you want active on initialization.

Would be nice to have the ability to programmatically continue changing the active state of tools

[hensh2ss]

@bryevdv @birdsarah, I was wondering what the status was on implementing this ticket? I am trying to implement a brushing actions using the bokeh.events module but need to be able to programmatically turn on/off the active drag tool in the toolbar. Any help you can provide would be much appreciated!!

Here is an example of what I am trying to do

import time
from bokeh.events import Pan
from bokeh.io import curdoc
from bokeh.layouts import row
from bokeh.models import ColumnDataSource, BoxAnnotation, CheckboxGroup, WidgetBox, PanTool
import numpy as np
from datetime import datetime
from bokeh.plotting import figure

# Setting up the initial Data Source
N = 200
st = time.time()
t = [datetime.utcfromtimestamp(st+i) for i in xrange(N)]
x = np.linspace(0, 4*np.pi, N)
y = np.sin(x)
source = ColumnDataSource(data=dict(t=t, x=x, y=y))

# Setting up the controls
brushEnable = CheckboxGroup(labels=["Spectral Brush"])
brush = BoxAnnotation(fill_alpha=0.3, fill_color='red')
controlLayout = WidgetBox(brushEnable)

# Set up plot
panTool = PanTool()
plot = figure(plot_height=400, plot_width=400, title="my sine wave",
              tools="crosshair,reset,save,wheel_zoom",
              y_range=[-2.5, 2.5], x_axis_type="datetime"
              )
plot.add_tools(panTool)
plot.line('t', 'y', source=source, line_width=3, line_alpha=0.6)

# Connecting controls to plot
plot.add_layout(brush)

#Adding Event Handlers
def brushEnableChange(events):
    print("Brush enable changed",events)
    if events[1] == 1:
        plot.toolbar.active_drag = None
    else:
        plot.toolbar.active_drag = panTool


brushEnable.on_click(brushEnableChange)

# TODO Implement this method to change the BoxAnnotation
def panOngoing(events):
    print("\tPan ongoing", events)

plot.on_event(Pan, panOngoing)

curdoc().add_root(row(controlLayout, plot))
curdoc().title = "Event Brush Example"

And here is the error I am getting:

[bryevdv]

noting that the correct code for the callback is

def brushEnableChange(events):
    print("Brush enable changed", events)
    if events == [0]:
        plot.toolbar.active_drag = None
    else:
        plot.toolbar.active_drag = panTool

Tho still appears the plumbing is not hooked up

[cvdelannoy]

Indeed Python-side changes to active_scroll (or active_drag etc.) attribute didn't work for me either. Then I tried changing what I assumed was the corresponding JS attribute, but nothing happens:

window.Bokeh.documents[0]._all_models_by_name._dict['ts'][0].toolbar.attributes.active_scroll = window.Bokeh.documents[0]._all_models_by_name._dict['ts'][0].toolbar.attributes.tools[2]

Are there any other workarounds I could try for now?

[bryevdv]

No the issue is missing event plumbing, there is not going to be any obvious or simple way to work around

[p-himik]

That's what I use in one of my projects:

def set_tools(plot, tools, active_scroll=None, active_drag=None):
    # Bokeh processes only the `tools` change, so
    # `active_scroll` *has* to be set first.
    plot.toolbar.active_scroll = active_scroll
    plot.toolbar.active_drag = active_drag
    plot.toolbar.tools = tools

[chrisbarber]

I was using this to change tools on the javascript side, and it was working

var bokeh_box_select_tool_button = document.getElementsByClassName("bk-tool-icon-box-select")[0];
bokeh_box_select_tool_button.click();

But now I am on bokeh master and it no longer works; haven't figured out why.

[chrisbarber]

I don't know how we've gotten to the point in web front-end where we can't just .click() an element. I guess this more a comment on hammerjs.

I'm tempted to do this:

diff --git a/bokehjs/src/lib/models/tools/button_tool.ts b/bokehjs/src/lib/models/tools/button_tool.ts
index 84ae26044..0f81d5fcd 100644
--- a/bokehjs/src/lib/models/tools/button_tool.ts
+++ b/bokehjs/src/lib/models/tools/button_tool.ts
@@ -42,6 +42,7 @@ export abstract class ButtonToolButtonView extends DOMView {
       inputClass: Hammer.TouchMouseInput, // https://github.com/bokeh/bokeh/issues/9187
     })
     this.connect(this.model.change, () => this.render())
+    this.model.tools.forEach((t) => t.click = () => this._clicked());
     this._hammer.on("tap", (e) => {
       if (this._menu?.is_open) {
         this._menu.hide()

Then I can do this:

var bokeh_box_select_tool_button = Bokeh.documents[0].get_model_by_name('box_select_tool');
bokeh_box_select_tool_button.click()

Would it be unreasonable to provide a click method on the various *Tool models in bokehjs like this? Sure, maybe there is a better place to register this method on to the tool than my diff above, but it any case it should be just a one-liner like this. Whereas the "missing event plumbing" sounds a bit more involved.

[p-himik]

click does not belong on a model. And tool models already have the active property.
This works just fine:

from bokeh.io import show
from bokeh.layouts import column, row
from bokeh.models import Button, CustomJS, WheelZoomTool, BoxZoomTool
from bokeh.plotting import figure

p = figure(tools='wheel_zoom,box_zoom')
p.x(0, 0)

bb = Button(label='box')
bb.js_on_click(CustomJS(args=dict(t=p.select_one(BoxZoomTool)),
                        code="t.active = !t.active;"))
bw = Button(label='wheel')
bw.js_on_click(CustomJS(args=dict(t=p.select_one(WheelZoomTool)),
                        code="t.active = !t.active;"))

show(column(p, row(bb, bw)))

Given this example, I'm now wondering if the ability to change toolbar.active_* properties is even that useful.

[mattpap]

Given this example, I'm now wondering if the ability to change toolbar.active_* properties is even that useful.

At least for the sake of consistency it is, but realistically the code you proposed is the way to go. I went ahead and hooked up appropriate signals in PR #10095.