-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
/
events.py
728 lines (560 loc) · 22.6 KB
/
events.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
#-----------------------------------------------------------------------------
# Copyright (c) 2012 - 2024, Anaconda, Inc., and Bokeh Contributors.
# All rights reserved.
#
# The full license is in the file LICENSE.txt, distributed with this software.
#-----------------------------------------------------------------------------
''' Represent granular events that can be used to trigger callbacks.
Bokeh documents and applications are capable of supporting various kinds of
interactions. These are often associated with events, such as mouse or touch
events, interactive downsampling mode activation, widget or tool events, and
others. The classes in this module represent these different events, so that
callbacks can be attached and executed when they occur.
It is possible to respond to events with ``CustomJS`` callbacks, which will
function with or without a Bokeh server. This can be accomplished by passing
and event class, and a ``CustomJS`` model to the
:func:`~bokeh.model.Model.js_on_event` method. When the ``CustomJS`` is
executed in the browser, its ``cb_obj`` argument will contain the concrete
event object that triggered the callback.
.. code-block:: python
from bokeh.events import ButtonClick
from bokeh.models import Button, CustomJS
button = Button()
button.js_on_event(ButtonClick, CustomJS(code='console.log("JS:Click")'))
Alternatively it is possible to trigger Python code to run when events
happen, in the context of a Bokeh application running on a Bokeh server.
This can accomplished by passing an event class, and a callback function
to the the :func:`~bokeh.model.Model.on_event` method. The callback should
accept a single argument ``event``, which will be passed the concrete
event object that triggered the callback.
.. code-block:: python
from bokeh.events import ButtonClick
from bokeh.models import Button
button = Button()
def callback(event):
print('Python:Click')
button.on_event(ButtonClick, callback)
.. note ::
There is no throttling of events. Some events such as ``MouseMove``
may trigger at a very high rate.
'''
#-----------------------------------------------------------------------------
# Boilerplate
#-----------------------------------------------------------------------------
from __future__ import annotations
import logging # isort:skip
log = logging.getLogger(__name__)
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
# Standard library imports
from datetime import datetime
from typing import (
TYPE_CHECKING,
Any,
ClassVar,
Literal,
TypedDict,
)
# Bokeh imports
from .core.serialization import Deserializer
if TYPE_CHECKING:
from .core.types import GeometryData
from .model import Model
from .models.plots import Plot
from .models.widgets.buttons import AbstractButton
from .models.widgets.inputs import TextInput
#-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
__all__ = (
'ButtonClick',
'ConnectionLost',
'DocumentEvent',
'DocumentReady',
'DoubleTap',
'Event',
'LODEnd',
'LODStart',
'MenuItemClick',
'ModelEvent',
'MouseEnter',
'MouseLeave',
'MouseMove',
'MouseWheel',
'Pan',
'PanEnd',
'PanStart',
'Pinch',
'PinchEnd',
'PinchStart',
'PlotEvent',
'PointEvent',
'Press',
'PressUp',
'RangesUpdate',
'Reset',
'Rotate',
'RotateEnd',
'RotateStart',
'SelectionGeometry',
'Tap',
'ValueSubmit',
)
#-----------------------------------------------------------------------------
# Private API
#-----------------------------------------------------------------------------
_CONCRETE_EVENT_CLASSES: dict[str, type[Event]] = {}
#-----------------------------------------------------------------------------
# General API
#-----------------------------------------------------------------------------
class KeyModifiers(TypedDict):
shift: bool
ctrl: bool
alt: bool
class EventRep(TypedDict):
type: Literal["event"]
name: str
values: dict[str, Any]
class Event:
''' Base class for all Bokeh events.
This base class is not typically useful to instantiate on its own.
'''
event_name: ClassVar[str]
@staticmethod
def cls_for(event_name: str) -> type[Event]:
event_cls = _CONCRETE_EVENT_CLASSES.get(event_name)
if event_cls is not None:
return event_cls
else:
raise ValueError(f"unknown event name '{event_name}'")
@classmethod
def __init_subclass__(cls):
super().__init_subclass__()
if hasattr(cls, "event_name"):
_CONCRETE_EVENT_CLASSES[cls.event_name] = cls
@classmethod
def from_serializable(cls, rep: EventRep, decoder: Deserializer) -> Event:
if not ("name" in rep and "values" in rep):
decoder.error("invalid representation")
name = rep.get("name")
if name is None:
decoder.error("'name' field is missing")
values = rep.get("values")
if values is None:
decoder.error("'values' field is missing")
cls = _CONCRETE_EVENT_CLASSES.get(name)
if cls is None:
decoder.error(f"can't resolve event '{name}'")
decoded_values = decoder.decode(values)
event = cls(**decoded_values)
return event
class DocumentEvent(Event):
''' Base class for all Bokeh Document events.
This base class is not typically useful to instantiate on its own.
'''
class DocumentReady(DocumentEvent):
'''
Announce when a Document is fully idle.
.. note::
To register a JS callback for this event in standalone embedding
mode, one has to either use ``curdoc()`` or an explicit ``Document``
instance, e.g.:
.. code-block:: python
from bokeh.io import curdoc
curdoc().js_on_event("document_ready", handler)
'''
event_name = 'document_ready'
class ConnectionEvent(DocumentEvent):
''' Base class for connection status related events.
'''
class ConnectionLost(ConnectionEvent):
'''
Announce when a connection to the server/client was lost.
.. note::
To register a JS callback for this event in standalone embedding
mode, one has to either use ``curdoc()`` or an explicit ``Document``
instance, e.g.:
.. code-block:: python
from bokeh.io import curdoc
curdoc().js_on_event("document_ready", handler)
'''
event_name = 'connection_lost'
timestamp: datetime
def __init__(self) -> None:
super().__init__()
self.timestamp = datetime.now()
class ModelEvent(Event):
''' Base class for all Bokeh Model events.
This base class is not typically useful to instantiate on its own.
'''
model: Model | None
def __init__(self, model: Model | None) -> None:
''' Create a new base event.
Args:
model (Model) : a Bokeh model to register event callbacks on
'''
self.model = model
class ButtonClick(ModelEvent):
''' Announce a button click event on a Bokeh button widget.
'''
event_name = 'button_click'
def __init__(self, model: AbstractButton | None) -> None:
from .models.widgets import AbstractButton, ToggleButtonGroup
if model is not None and not isinstance(model, (AbstractButton, ToggleButtonGroup)):
clsname = self.__class__.__name__
raise ValueError(f"{clsname} event only applies to button and button group models")
super().__init__(model=model)
class MenuItemClick(ModelEvent):
''' Announce a button click event on a Bokeh menu item.
'''
event_name = 'menu_item_click'
def __init__(self, model: Model, item: str | None = None) -> None:
self.item = item
super().__init__(model=model)
class ValueSubmit(ModelEvent):
''' Announce a value being submitted on a text input widget.
'''
event_name = 'value_submit'
value: str
def __init__(self, model: TextInput | None, value: str) -> None:
from .models.widgets import TextInput
if model is not None and not isinstance(model, TextInput):
clsname = self.__class__.__name__
raise ValueError(f"{clsname} event only applies to text input models")
super().__init__(model=model)
self.value = value
class PlotEvent(ModelEvent):
''' The base class for all events applicable to Plot models.
'''
def __init__(self, model: Plot | None) -> None:
from .models import Plot
if model is not None and not isinstance(model, Plot):
raise ValueError(f"{self.__class__.__name__} event only applies to Plot models")
super().__init__(model)
class LODStart(PlotEvent):
''' Announce the start of "interactive level-of-detail" mode on a plot.
During interactive actions such as panning or zooming, Bokeh can
optionally, temporarily draw a reduced set of the data, in order to
maintain high interactive rates. This is referred to as interactive
Level-of-Detail (LOD) mode. This event fires whenever a LOD mode
has just begun.
'''
event_name = 'lodstart'
class LODEnd(PlotEvent):
''' Announce the end of "interactive level-of-detail" mode on a plot.
During interactive actions such as panning or zooming, Bokeh can
optionally, temporarily draw a reduced set of the data, in order to
maintain high interactive rates. This is referred to as interactive
Level-of-Detail (LOD) mode. This event fires whenever a LOD mode
has just ended.
'''
event_name = 'lodend'
class RangesUpdate(PlotEvent):
''' Announce combined range updates in a single event.
Attributes:
x0 (float) : start x-coordinate for the default x-range
x1 (float) : end x-coordinate for the default x-range
y0 (float) : start x-coordinate for the default y-range
y1 (float) : end y-coordinate for the default x-range
Callbacks may be added to range ``start`` and ``end`` properties to respond
to range changes, but this can result in multiple callbacks being invoked
for a single logical operation (e.g. a pan or zoom). This event is emitted
by supported tools when the entire range update is complete, in order to
afford a *single* event that can be responded to.
'''
event_name = 'rangesupdate'
def __init__(self, model: Plot | None, *,
x0: float | None = None,
x1: float | None = None,
y0: float | None = None,
y1: float | None = None):
self.x0 = x0
self.x1 = x1
self.y0 = y0
self.y1 = y1
super().__init__(model=model)
class SelectionGeometry(PlotEvent):
''' Announce the coordinates of a selection event on a plot.
Attributes:
geometry (dict) : a dictionary containing the coordinates of the
selection event.
final (bool) : whether the selection event is the last selection event
in the case of selections on every mousemove.
'''
event_name = "selectiongeometry"
def __init__(self, model: Plot | None, geometry: GeometryData | None = None, final: bool = True) -> None:
self.geometry = geometry
self.final = final
super().__init__(model=model)
class Reset(PlotEvent):
''' Announce a button click event on a plot ``ResetTool``.
'''
event_name = "reset"
def __init__(self, model: Plot | None) -> None:
super().__init__(model=model)
class PointEvent(PlotEvent):
''' Base class for UI events associated with a specific (x,y) point.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
Note that data space coordinates are relative to the default range, not
any extra ranges, and the the screen space origin is at the top left of
the HTML canvas.
'''
def __init__(
self,
model: Plot | None,
sx: float | None = None,
sy: float | None = None,
x: float | None = None,
y: float | None = None,
modifiers: KeyModifiers | None = None,
):
self.sx = sx
self.sy = sy
self.x = x
self.y = y
self.modifiers = modifiers
super().__init__(model=model)
class Tap(PointEvent):
''' Announce a tap or click event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
'''
event_name = 'tap'
class DoubleTap(PointEvent):
''' Announce a double-tap or double-click event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
'''
event_name = 'doubletap'
class Press(PointEvent):
''' Announce a press event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
'''
event_name = 'press'
class PressUp(PointEvent):
''' Announce a pressup event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
'''
event_name = 'pressup'
class MouseEnter(PointEvent):
''' Announce a mouse enter event onto a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
The enter event is generated when the mouse leaves the entire Plot
canvas, including any border padding and space for axes or legends.
'''
event_name = 'mouseenter'
class MouseLeave(PointEvent):
''' Announce a mouse leave event from a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
The leave event is generated when the mouse leaves the entire Plot
canvas, including any border padding and space for axes or legends.
'''
event_name = 'mouseleave'
class MouseMove(PointEvent):
''' Announce a mouse movement event over a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
This event can fire at a very high rate, potentially increasing network
traffic or CPU load.
'''
event_name = 'mousemove'
class MouseWheel(PointEvent):
''' Announce a mouse wheel event on a Bokeh plot.
Attributes:
delta (float) : the (signed) scroll speed
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
By default, Bokeh plots do not prevent default scroll events unless a
``WheelZoomTool`` or ``WheelPanTool`` is active. This may change in
future releases.
'''
event_name = 'wheel'
def __init__(self,
model: Plot | None,
*,
delta: float | None = None,
sx: float | None = None,
sy: float | None = None,
x: float | None = None,
y: float | None = None,
modifiers: KeyModifiers | None = None):
self.delta = delta
super().__init__(model, sx=sx, sy=sy, x=x, y=y, modifiers=modifiers)
class Pan(PointEvent):
''' Announce a pan event on a Bokeh plot.
Attributes:
delta_x (float) : the amount of scroll in the x direction
delta_y (float) : the amount of scroll in the y direction
direction (float) : the direction of scroll (1 or -1)
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
'''
event_name = 'pan'
def __init__(self,
model: Plot | None,
*,
delta_x: float | None = None,
delta_y: float | None = None,
direction: Literal[-1, -1] | None = None,
sx: float | None = None,
sy: float | None = None,
x: float | None = None,
y: float | None = None,
modifiers: KeyModifiers | None = None):
self.delta_x = delta_x
self.delta_y = delta_y
self.direction = direction
super().__init__(model, sx=sx, sy=sy, x=x, y=y, modifiers=modifiers)
class PanEnd(PointEvent):
''' Announce the end of a pan event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
'''
event_name = 'panend'
class PanStart(PointEvent):
''' Announce the start of a pan event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
'''
event_name = 'panstart'
class Pinch(PointEvent):
''' Announce a pinch event on a Bokeh plot.
Attributes:
scale (float) : the (signed) amount of scaling
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
This event is only applicable for touch-enabled devices.
'''
event_name = 'pinch'
def __init__(self,
model: Plot | None,
*,
scale: float | None = None,
sx: float | None = None,
sy: float | None = None,
x: float | None = None,
y: float | None = None,
modifiers: KeyModifiers | None = None):
self.scale = scale
super().__init__(model, sx=sx, sy=sy, x=x, y=y, modifiers=modifiers)
class PinchEnd(PointEvent):
''' Announce the end of a pinch event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
This event is only applicable for touch-enabled devices.
'''
event_name = 'pinchend'
class PinchStart(PointEvent):
''' Announce the start of a pinch event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
This event is only applicable for touch-enabled devices.
'''
event_name = 'pinchstart'
class Rotate(PointEvent):
''' Announce a rotate event on a Bokeh plot.
Attributes:
rotation (float) : the rotation that has been done (in deg)
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
This event is only applicable for touch-enabled devices.
'''
event_name = 'rotate'
def __init__(self,
model: Plot | None,
*,
rotation: float | None = None,
sx: float | None = None,
sy: float | None = None,
x: float | None = None,
y: float | None = None,
modifiers: KeyModifiers | None = None):
self.rotation = rotation
super().__init__(model, sx=sx, sy=sy, x=x, y=y, modifiers=modifiers)
class RotateEnd(PointEvent):
''' Announce the end of a rotate event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
This event is only applicable for touch-enabled devices.
'''
event_name = 'rotateend'
class RotateStart(PointEvent):
''' Announce the start of a rotate event on a Bokeh plot.
Attributes:
sx (float) : x-coordinate of the event in *screen* space
sy (float) : y-coordinate of the event in *screen* space
x (float) : x-coordinate of the event in *data* space
y (float) : y-coordinate of the event in *data* space
.. note::
This event is only applicable for touch-enabled devices.
'''
event_name = 'rotatestart'
#-----------------------------------------------------------------------------
# Dev API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------
Deserializer.register("event", Event.from_serializable)