-
-
Notifications
You must be signed in to change notification settings - Fork 477
/
slider.py
1187 lines (949 loc) · 42.1 KB
/
slider.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
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Sliders allow you to select a value from a defined range of values by
moving one or more handle(s).
- The `value` will update when a handle is dragged.
- The `value_throttled`will update when a handle is released.
"""
from __future__ import annotations
import datetime as dt
from typing import (
TYPE_CHECKING, Any, ClassVar, Dict, List, Mapping, Optional, Type,
)
import numpy as np
import param
from bokeh.models import CustomJS
from bokeh.models.formatters import TickFormatter
from bokeh.models.widgets import (
DateRangeSlider as _BkDateRangeSlider, DateSlider as _BkDateSlider,
RangeSlider as _BkRangeSlider, Slider as _BkSlider,
)
from ..config import config
from ..io import state
from ..layout import Column, Panel, Row
from ..util import (
datetime_as_utctimestamp, edit_readonly, param_reprs, value_as_date,
value_as_datetime,
)
from ..viewable import Layoutable
from ..widgets import FloatInput, IntInput
from .base import CompositeWidget, Widget
from .input import StaticText
if TYPE_CHECKING:
from bokeh.document import Document
from bokeh.model import Model
from pyviz_comms import Comm
class _SliderBase(Widget):
bar_color = param.Color(default="#e6e6e6", doc="""""")
direction = param.ObjectSelector(default='ltr', objects=['ltr', 'rtl'], doc="""
Whether the slider should go from left-to-right ('ltr') or
right-to-left ('rtl').""")
name = param.String(default=None, doc="""
The name of the widget. Also used as the label of the widget. If not set,
the widget has no label.""")
orientation = param.ObjectSelector(default='horizontal', objects=['horizontal', 'vertical'],
doc="""
Whether the slider should be oriented horizontally or
vertically.""")
show_value = param.Boolean(default=True, doc="""
Whether to show the widget value as a label or not.""")
tooltips = param.Boolean(default=True, doc="""
Whether the slider handle should display tooltips.""")
_widget_type: ClassVar[Type[Model]] = _BkSlider
__abstract = True
def __init__(self, **params):
if 'value' in params and 'value_throttled' in self.param:
params['value_throttled'] = params['value']
super().__init__(**params)
def __repr__(self, depth=0):
return '{cls}({params})'.format(cls=type(self).__name__,
params=', '.join(param_reprs(self, ['value_throttled'])))
def _process_property_change(self, msg):
if config.throttled:
if "value" in msg:
del msg["value"]
if "value_throttled" in msg:
msg["value"] = msg["value_throttled"]
return super()._process_property_change(msg)
def _update_model(
self, events: Dict[str, param.parameterized.Event], msg: Dict[str, Any],
root: Model, model: Model, doc: Document, comm: Optional[Comm]
) -> None:
if 'value_throttled' in msg:
del msg['value_throttled']
return super()._update_model(events, msg, root, model, doc, comm)
class ContinuousSlider(_SliderBase):
format = param.ClassSelector(class_=(str, TickFormatter,), doc="""
A custom format string or Bokeh TickFormatter.""")
_supports_embed: ClassVar[bool] = True
__abstract = True
def __init__(self, **params):
if 'value' not in params:
params['value'] = params.get('start', self.start)
super().__init__(**params)
def _get_embed_state(self, root, values=None, max_opts=3):
ref = root.ref['id']
w_model, parent = self._models[ref]
_, _, doc, comm = state._views[ref]
# Compute sampling
start, end, step = w_model.start, w_model.end, w_model.step
if values is None:
span = end-start
dtype = int if isinstance(step, int) else float
if (span/step) > (max_opts-1):
step = dtype(span/(max_opts-1))
values = [dtype(v) for v in np.arange(start, end+step, step)]
elif any(v < start or v > end for v in values):
raise ValueError('Supplied embed states for %s widget outside '
'of valid range.' % type(self).__name__)
# Replace model
layout_opts = {k: v for k, v in self.param.values().items()
if k in Layoutable.param and k != 'name'}
value = values[np.argmin(np.abs(np.array(values)-self.value))]
dw = DiscreteSlider(options=values, value=value, name=self.name, **layout_opts)
dw.link(self, value='value')
self._models.pop(ref)
index = parent.children.index(w_model)
with config.set(embed=True):
w_model = dw._get_model(doc, root, parent, comm)
link = CustomJS(code=dw._jslink.code['value'], args={
'source': w_model.children[1], 'target': w_model.children[0]})
parent.children[index] = w_model
w_model = w_model.children[1]
w_model.js_on_change('value', link)
return (dw, w_model, values, lambda x: x.value, 'value', 'cb_obj.value')
class FloatSlider(ContinuousSlider):
"""
The FloatSlider widget allows selecting a floating-point value
within a set of bounds using a slider.
Reference: https://panel.holoviz.org/reference/widgets/FloatSlider.html
:Example:
>>> FloatSlider(value=0.5, start=0.0, end=1.0, step=0.1, name="Float value")
"""
start = param.Number(default=0.0, doc="The lower bound.")
end = param.Number(default=1.0, doc="The upper bound.")
step = param.Number(default=0.1, doc="The step size.")
value = param.Number(default=0.0, allow_None=True, doc="""
The selected floating-point value of the slider. Updated when
the handle is dragged."""
)
value_throttled = param.Number(default=None, constant=True, doc="""
The value of the slider. Updated when the handle is released.""")
_rename: ClassVar[Mapping[str, str | None]] = {'name': 'title'}
class IntSlider(ContinuousSlider):
"""
The IntSlider widget allows selecting an integer value within a
set of bounds using a slider.
Reference: https://panel.holoviz.org/reference/widgets/IntSlider.html
:Example:
>>> IntSlider(value=5, start=0, end=10, step=1, name="Integer Value")
"""
start = param.Integer(default=0, doc="""
The lower bound.""")
end = param.Integer(default=1, doc="""
The upper bound.""")
step = param.Integer(default=1, doc="""
The step size.""")
value = param.Integer(default=0, allow_None=True, doc="""
The selected integer value of the slider. Updated when the handle is dragged.""")
value_throttled = param.Integer(default=None, constant=True, doc="""
The value of the slider. Updated when the handle is released""")
_rename: ClassVar[Mapping[str, str | None]] = {'name': 'title'}
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
msg['value'] = msg['value'] if msg['value'] is None else int(msg['value'])
if 'value_throttled' in msg:
throttled = msg['value_throttled']
msg['value_throttled'] = throttled if throttled is None else int(throttled)
return msg
class DateSlider(_SliderBase):
"""
The DateSlider widget allows selecting a value within a set of
bounds using a slider. Supports datetime.datetime, datetime.date
and np.datetime64 values. The step size is fixed at 1 day.
Reference: https://panel.holoviz.org/reference/widgets/DateSlider.html
:Example:
>>> import datetime as dt
>>> DateSlider(
... value=dt.datetime(2025, 1, 1),
... start=dt.datetime(2025, 1, 1),
... end=dt.datetime(2025, 1, 7),
... name="A datetime value"
... )
"""
value = param.Date(default=None, doc="""
The selected date value of the slider. Updated when the slider
handle is dragged. Supports datetime.datetime, datetime.date
or np.datetime64 types.""")
value_throttled = param.Date(default=None, constant=True, doc="""
The value of the slider. Updated when the slider handle is released.""")
start = param.Date(default=None, doc="""
The lower bound.""")
end = param.Date(default=None, doc="""
The upper bound.""")
as_datetime = param.Boolean(default=False, doc="""
Whether to store the date as a datetime.""")
step = param.Number(default=None, doc="""
The step parameter in milliseconds.""")
format = param.String(default=None, doc="""
Datetime format used for parsing and formatting the date.""")
_rename: ClassVar[Mapping[str, str | None]] = {
'name': 'title', 'as_datetime': None
}
_source_transforms: ClassVar[Mapping[str, str | None]] = {
'value': None, 'value_throttled': None, 'start': None, 'end': None
}
_widget_type: ClassVar[Type[Model]] = _BkDateSlider
def __init__(self, **params):
if 'value' not in params:
params['value'] = params.get('start', self.start)
super().__init__(**params)
def _process_param_change(self, msg):
msg = super()._process_param_change(msg)
if 'value' in msg:
value = msg['value']
if isinstance(value, dt.datetime):
value = datetime_as_utctimestamp(value)
msg['value'] = value
return msg
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
transform = value_as_datetime if self.as_datetime else value_as_date
if 'value' in msg:
msg['value'] = transform(msg['value'])
if 'value_throttled' in msg:
msg['value_throttled'] = transform(msg['value_throttled'])
return msg
class DiscreteSlider(CompositeWidget, _SliderBase):
"""
The DiscreteSlider widget allows selecting a value from a discrete
list or dictionary of values using a slider.
Reference: https://panel.holoviz.org/reference/widgets/DiscreteSlider.html
:Example:
>>> DiscreteSlider(
... value=0,
... options=list([0, 1, 2, 4, 8, 16, 32, 64]),
... name="A discrete value",
... )
"""
value = param.Parameter(doc="""
The selected value of the slider. Updated when the handle is
dragged. Must be one of the options.""")
value_throttled = param.Parameter(constant=True, doc="""
The value of the slider. Updated when the handle is released.""")
options = param.ClassSelector(default=[], class_=(dict, list), doc="""
A list or dictionary of valid options.""")
formatter = param.String(default='%.3g', doc="""
A custom format string. Separate from format parameter since
formatting is applied in Python, not via the bokeh TickFormatter.""")
_rename: ClassVar[Mapping[str, str | None]] = {'formatter': None}
_source_transforms: ClassVar[Mapping[str, str | None]] = {
'value': None, 'value_throttled': None, 'options': None
}
_supports_embed: ClassVar[bool] = True
_style_params: ClassVar[List[str]] = [
p for p in list(Layoutable.param) if p != 'name'
] + ['orientation']
_slider_style_params: ClassVar[List[str]] = [
'bar_color', 'direction', 'disabled', 'orientation'
]
_text_link = """
var labels = {labels}
target.text = labels[source.value]
"""
def __init__(self, **params):
self._syncing = False
super().__init__(**params)
if 'formatter' not in params and all(isinstance(v, (int, np.int_)) for v in self.values):
self.formatter = '%d'
if self.value is None and None not in self.values and self.options:
self.value = self.values[0]
elif self.value not in self.values and not (self.value is None or self.options):
raise ValueError('Value %s not a valid option, '
'ensure that the supplied value '
'is one of the declared options.'
% self.value)
self._text = StaticText(margin=(5, 0, 0, 5), style={'white-space': 'nowrap'})
self._slider = None
self._composite = Column(self._text, self._slider)
self._update_options()
self.param.watch(self._update_options, ['options', 'formatter', 'name'])
self.param.watch(self._update_value, 'value')
self.param.watch(self._update_value, 'value_throttled')
self.param.watch(self._update_style, self._style_params)
def _update_options(self, *events):
values, labels = self.values, self.labels
if not self.options and self.value is None:
value = 0
label = (f'{self.name}: ' if self.name else '') + '<b>-</b>'
elif self.value not in values:
value = 0
self.value = values[0]
label = labels[value]
else:
value = values.index(self.value)
label = labels[value]
disabled = True if len(values) in (0, 1) else self.disabled
end = 1 if disabled else len(self.options)-1
self._slider = IntSlider(
start=0, end=end, value=value, tooltips=False,
show_value=False, margin=(0, 5, 5, 5),
_supports_embed=False, disabled=disabled,
**{p: getattr(self, p) for p in self._slider_style_params if p != 'disabled'}
)
self._update_style()
js_code = self._text_link.format(
labels='['+', '.join([repr(l) for l in labels])+']'
)
self._jslink = self._slider.jslink(self._text, code={'value': js_code})
self._slider.param.watch(self._sync_value, 'value')
self._slider.param.watch(self._sync_value, 'value_throttled')
self.param.watch(self._update_slider_params, self._slider_style_params)
self._text.value = label
self._composite[1] = self._slider
def _update_value(self, event):
"""
This will update the IntSlider (behind the scene)
based on changes to the DiscreteSlider (front).
_syncing options is to avoid infinite loop.
event.name is either value or value_throttled.
"""
values = self.values
if getattr(self, event.name) not in values:
with param.edit_constant(self):
setattr(self, event.name, values[0])
return
index = self.values.index(getattr(self, event.name))
if event.name == 'value':
self._text.value = self.labels[index]
if self._syncing:
return
try:
self._syncing = True
with param.edit_constant(self._slider):
setattr(self._slider, event.name, index)
finally:
self._syncing = False
def _update_style(self, *events):
style = {p: getattr(self, p) for p in self._style_params}
margin = style.pop('margin')
if isinstance(margin, tuple):
if len(margin) == 2:
t = b = margin[0]
r = l = margin[1]
else:
t, r, b, l = margin
else:
t = r = b = l = margin
text_margin = (t, 0, 0, l)
slider_margin = (0, r, b, l)
text_style = {k: v for k, v in style.items()
if k not in ('style', 'orientation')}
self._text.param.update(margin=text_margin, **text_style)
self._slider.param.update(margin=slider_margin, **style)
if self.width:
style['width'] = self.width + l + r
col_style = {k: v for k, v in style.items()
if k != 'orientation'}
self._composite.param.update(**col_style)
def _update_slider_params(self, *events):
style = {e.name: e.new for e in events}
disabled = style.get('disabled', None)
if disabled is False:
if len(self.values) in (0, 1):
self.param.warning(
'A DiscreteSlider can only be disabled if it has more than 1 option.'
)
end = 1
del style['disabled']
else:
end = len(self.options) - 1
style['end'] = end
self._slider.param.update(**style)
def _sync_value(self, event):
"""
This will update the DiscreteSlider (front)
based on changes to the IntSlider (behind the scene).
_syncing options is to avoid infinite loop.
event.name is either value or value_throttled.
"""
if self._syncing:
return
try:
self._syncing = True
with param.edit_constant(self):
setattr(self, event.name, self.values[event.new])
finally:
self._syncing = False
def _get_embed_state(self, root, values=None, max_opts=3):
model = self._composite[1]._models[root.ref['id']][0]
if values is None:
values = self.values
elif any(v not in self.values for v in values):
raise ValueError("Supplieed embed states were not found "
"in the %s widgets' values list." % type(self).__name__)
return self, model, values, lambda x: x.value, 'value', 'cb_obj.value'
@property
def labels(self):
"""The list of labels to display"""
title = (self.name + ': ' if self.name else '')
if isinstance(self.options, dict):
return [title + ('<b>%s</b>' % o) for o in self.options]
else:
return [title + ('<b>%s</b>' % (o if isinstance(o, str) else (self.formatter % o)))
for o in self.options]
@property
def values(self):
"""The list of option values"""
return list(self.options.values()) if isinstance(self.options, dict) else self.options
class _RangeSliderBase(_SliderBase):
value = param.Tuple(length=2, allow_None=False, doc="""
The selected range of the slider. Updated when a handle is dragged.""")
value_start = param.Parameter(readonly=True, doc="""The lower value of the selected range.""")
value_end = param.Parameter(readonly=True, doc="""The upper value of the selected range.""")
__abstract = True
def __init__(self, **params):
if 'value' not in params:
params['value'] = (
params.get('start', self.start), params.get('end', self.end)
)
if params['value'] is not None:
params['value_start'], params['value_end'] = params['value']
with edit_readonly(self):
super().__init__(**params)
@param.depends('value', watch=True)
def _sync_values(self):
vs, ve = self.value
with edit_readonly(self):
self.param.update(value_start=vs, value_end=ve)
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
msg['value'] = tuple(msg['value'])
if 'value_throttled' in msg:
msg['value_throttled'] = tuple(msg['value_throttled'])
return msg
class RangeSlider(_RangeSliderBase):
"""
The RangeSlider widget allows selecting a floating-point range
using a slider with two handles.
Reference: https://panel.holoviz.org/reference/widgets/RangeSlider.html
:Example:
>>> RangeSlider(
... value=(1.0, 1.5), start=0.0, end=2.0, step=0.25, name="A tuple of floats"
... )
"""
value = param.Range(default=(0, 1), allow_None=False, doc=
"""The selected range as a tuple of values. Updated when a handle is
dragged.""")
value_throttled = param.Range(default=None, constant=True, doc="""
The selected range as a tuple of floating point values. Updated when a handle is
released""")
value_start = param.Number(default=0, readonly=True, doc="""
The lower value of the selected range.""")
value_end = param.Number(default=1, readonly=True, doc="""
The upper value of the selected range.""")
start = param.Number(default=0, doc="""
The lower bound.""")
end = param.Number(default=1, doc="""
The upper bound.""")
step = param.Number(default=0.1, doc="""
The step size.""")
format = param.ClassSelector(class_=(str, TickFormatter,), doc="""
A format string or bokeh TickFormatter.""")
_rename: ClassVar[Mapping[str, str | None]] = {'name': 'title', 'value_start': None, 'value_end': None}
_widget_type: ClassVar[Type[Model]] = _BkRangeSlider
def __init__(self, **params):
super().__init__(**params)
values = [self.value[0], self.value[1], self.start, self.end]
if (all(v is None or isinstance(v, int) for v in values) and
'step' not in params):
self.step = 1
class IntRangeSlider(RangeSlider):
"""
The IntRangeSlider widget allows selecting an integer range using
a slider with two handles.
Reference: https://panel.holoviz.org/reference/widgets/IntRangeSlider.html
:Example:
>>> IntRangeSlider(
... value=(2, 4), start=0, end=10, step=2, name="A tuple of integers"
... )
"""
start = param.Integer(default=0, doc="""
The lower bound.""")
end = param.Integer(default=1, doc="""
The uppper bound.""")
step = param.Integer(default=1, doc="""
The step size""")
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
msg['value'] = tuple([v if v is None else int(v)
for v in msg['value']])
if 'value_throttled' in msg:
msg['value_throttled'] = tuple([v if v is None else int(v)
for v in msg['value_throttled']])
return msg
class DateRangeSlider(_SliderBase):
"""
The DateRangeSlider widget allows selecting a date range using a
slider with two handles. Supports datetime.datetime, datetime.date
and np.datetime64 ranges.
Reference: https://panel.holoviz.org/reference/widgets/DateRangeSlider.html
:Example:
>>> import datetime as dt
>>> DateRangeSlider(
... value=(dt.datetime(2025, 1, 9), dt.datetime(2025, 1, 16)),
... start=dt.datetime(2025, 1, 1),
... end=dt.datetime(2025, 1, 31),
... step=2,
... name="A tuple of datetimes"
... )
"""
value = param.DateRange(default=None, allow_None=False, doc="""
The selected range as a tuple of values. Updated when one of the handles is
dragged. Supports datetime.datetime, datetime.date, and np.datetime64 ranges.""")
value_start = param.Date(default=None, readonly=True, doc="""
The lower value of the selected range.""")
value_end = param.Date(default=None, readonly=True, doc="""
The upper value of the selected range.""")
value_throttled = param.DateRange(default=None, constant=True, doc="""
The selected range as a tuple of values. Updated one of the handles is released. Supports
datetime.datetime, datetime.date and np.datetime64 ranges""")
start = param.Date(default=None, doc="""
The lower bound.""")
end = param.Date(default=None, doc="""
The upper bound.""")
step = param.Number(default=1, doc="""
The step size. Default is 1 millisecond.""")
format = param.String(default=None, doc="""
Datetime format used for parsing and formatting the date.""")
_source_transforms: ClassVar[Mapping[str, str | None]] = {
'value': None, 'value_throttled': None, 'start': None, 'end': None,
'step': None
}
_rename: ClassVar[Mapping[str, str | None]] = {
'name': 'title', 'value_start': None, 'value_end': None
}
_widget_type: ClassVar[Type[Model]] = _BkDateRangeSlider
def __init__(self, **params):
if 'value' not in params:
value_to_None = False
for attr in ['start', 'end']:
if params.get(attr, getattr(self, attr)):
continue
self.param.warning(
f'Parameter {attr!r} must be set for the widget to be rendered.'
)
value_to_None = True
if value_to_None:
params['value'] = None
else:
params['value'] = (params.get('start', self.start),
params.get('end', self.end))
if params['value'] is not None:
params['value_start'], params['value_end'] = params['value']
with edit_readonly(self):
super().__init__(**params)
@param.depends('value', watch=True)
def _sync_values(self):
vs, ve = self.value
with edit_readonly(self):
self.param.update(value_start=vs, value_end=ve)
def _process_param_change(self, msg):
msg = super()._process_param_change(msg)
if msg.get('value', 'unchanged') is None:
del msg['value']
elif 'value' in msg:
v1, v2 = msg['value']
if isinstance(v1, dt.datetime):
v1 = datetime_as_utctimestamp(v1)
if isinstance(v2, dt.datetime):
v2 = datetime_as_utctimestamp(v2)
msg['value'] = (v1, v2)
if msg.get('value_throttled', 'unchanged') is None:
del msg['value_throttled']
return msg
def _process_property_change(self, msg):
msg = super()._process_property_change(msg)
if 'value' in msg:
v1, v2 = msg['value']
msg['value'] = (value_as_datetime(v1), value_as_datetime(v2))
if 'value_throttled' in msg:
v1, v2 = msg['value_throttled']
msg['value_throttled'] = (value_as_datetime(v1), value_as_datetime(v2))
return msg
class DatetimeRangeSlider(DateRangeSlider):
"""
The DatetimeRangeSlider widget allows selecting a datetime range
using a slider with two handles. Supports datetime.datetime and
np.datetime64 ranges.
Reference: https://panel.holoviz.org/reference/widgets/DatetimeRangeSlider.html
:Example:
>>> import datetime as dt
>>> DatetimeRangeSlider(
... value=(dt.datetime(2025, 1, 9), dt.datetime(2025, 1, 16)),
... start=dt.datetime(2025, 1, 1),
... end=dt.datetime(2025, 1, 31),
... step=10000,
... name="A tuple of datetimes"
... )
"""
@property
def _widget_type(self):
try:
from bokeh.models import DatetimeRangeSlider
except Exception:
raise ValueError("DatetimeRangeSlider requires bokeh >= 2.4.3")
return DatetimeRangeSlider
class _EditableContinuousSlider(CompositeWidget):
"""
The EditableFloatSlider extends the FloatSlider by adding a text
input field to manually edit the value and potentially override
the bounds.
"""
editable = param.Boolean(default=True, doc="""
Whether the value is editable via the text input.""")
show_value = param.Boolean(default=False, readonly=True, precedence=-1, doc="""
Whether to show the widget value.""")
_composite_type: ClassVar[Type[Panel]] = Column
_slider_widget: ClassVar[Type[Widget]]
_input_widget: ClassVar[Type[Widget]]
__abstract = True
def __init__(self, **params):
if 'width' not in params and 'sizing_mode' not in params:
params['width'] = 300
self._validate_init_bounds(params)
super().__init__(**params)
self._label = StaticText(margin=0, align='end')
self._slider = self._slider_widget(
value=self.value, margin=(0, 0, 5, 0), sizing_mode='stretch_width',
)
self._slider.param.watch(self._sync_value, 'value')
self._slider.param.watch(self._sync_value, 'value_throttled')
self._value_edit = self._input_widget(
margin=0, align='end', css_classes=['slider-edit']
)
self._value_edit.param.watch(self._sync_value, 'value')
self._value_edit.param.watch(self._sync_value, 'value_throttled')
self._value_edit.jscallback(args={'slider': self._slider}, value="""
if (cb_obj.value < slider.start)
slider.start = cb_obj.value
else if (cb_obj.value > slider.end)
slider.end = cb_obj.value
""")
label = Row(self._label, self._value_edit)
self._composite.extend([label, self._slider])
self._update_editable()
self._update_layout()
self._update_name()
self._update_slider()
self._update_value()
self._update_bounds()
def _validate_init_bounds(self, params):
"""
This updates the default value, start and end
if outside the fixed_start and fixed_end
"""
start, end = None, None
if "start" not in params:
if "fixed_start" in params:
start = params["fixed_start"]
elif "end" in params:
start = params.get("end") - params.get("step", 1)
elif "fixed_end" in params:
start = params.get("fixed_end") - params.get("step", 1)
if "end" not in params:
if "fixed_end" in params:
end = params["fixed_end"]
elif "start" in params:
end = params["start"] + params.get("step", 1)
elif "fixed_start" in params:
end = params["fixed_start"] + params.get("step", 1)
if start is not None:
params["start"] = start
if end is not None:
params["end"] = end
if "value" not in params and "start" in params:
params["value"] = params["start"]
if "value" not in params and "end" in params:
params["value"] = params["end"]
@param.depends('width', 'height', 'sizing_mode', watch=True)
def _update_layout(self):
self._value_edit.sizing_mode = self.sizing_mode
if self.sizing_mode not in ('stretch_width', 'stretch_both'):
w = (self.width or 300)//4
self._value_edit.width = w
@param.depends('editable', watch=True)
def _update_editable(self):
self._value_edit.disabled = not self.editable
@param.depends('name', watch=True)
def _update_name(self):
if self.name:
label = f'{self.name}:'
margin = (0, 10, 0, 0)
else:
label = ''
margin = (0, 0, 0, 0)
self._label.param.update(**{'margin': margin, 'value': label})
@param.depends('start', 'end', 'step', 'bar_color', 'direction',
'show_value', 'tooltips', 'format', watch=True)
def _update_slider(self):
self._slider.param.update(**{
'format': self.format,
'start': self.start,
'end': self.end,
'step': self.step,
'bar_color': self.bar_color,
'direction': self.direction,
'show_value': self.show_value,
'tooltips': self.tooltips
})
self._value_edit.step = self.step
@param.depends('value', watch=True)
def _update_value(self):
self._slider.value = self.value
self._value_edit.value = self.value
def _sync_value(self, event):
with param.edit_constant(self):
self.param.update(**{event.name: event.new})
@param.depends("start", "end", "fixed_start", "fixed_end", watch=True)
def _update_bounds(self):
self.param.value.softbounds = (self.start, self.end)
self.param.value_throttled.softbounds = (self.start, self.end)
self.param.value.bounds = (self.fixed_start, self.fixed_end)
self.param.value_throttled.bounds = (self.fixed_start, self.fixed_end)
# First changing _slider and then _value_edit,
# because else _value_edit will change the _slider
# with the jscallback.
if self.fixed_start is not None:
self._slider.start = max(self.fixed_start, self.start)
if self.fixed_end is not None:
self._slider.end = min(self.fixed_end, self.end)
self._value_edit.start = self.fixed_start
self._value_edit.end = self.fixed_end
class EditableFloatSlider(_EditableContinuousSlider, FloatSlider):
"""
The EditableFloatSlider widget allows selecting selecting a
numeric floating-point value within a set of bounds using a slider
and for more precise control offers an editable number input box.
Reference: https://panel.holoviz.org/reference/widgets/EditableFloatSlider.html
:Example:
>>> EditableFloatSlider(
... value=1.0, start=0.0, end=2.0, step=0.25, name="A float value"
... )
"""
fixed_start = param.Number(default=None, doc="""
A fixed lower bound for the slider and input.""")
fixed_end = param.Number(default=None, doc="""
A fixed upper bound for the slider and input.""")
_slider_widget: ClassVar[Type[Widget]] = FloatSlider
_input_widget: ClassVar[Type[Widget]] = FloatInput
class EditableIntSlider(_EditableContinuousSlider, IntSlider):
"""
The EditableIntSlider widget allows selecting selecting an integer
value within a set of bounds using a slider and for more precise
control offers an editable integer input box.
Reference: https://panel.holoviz.org/reference/widgets/EditableIntSlider.html
:Example:
>>> EditableIntSlider(
... value=2, start=0, end=5, step=1, name="An integer value"
... )
"""
fixed_start = param.Integer(default=None, doc="""
A fixed lower bound for the slider and input.""")
fixed_end = param.Integer(default=None, doc="""
A fixed upper bound for the slider and input.""")
_slider_widget: ClassVar[Type[Widget]] = IntSlider
_input_widget: ClassVar[Type[Widget]] = IntInput
class EditableRangeSlider(CompositeWidget, _SliderBase):
"""
The EditableRangeSlider widget allows selecting a floating-point
range using a slider with two handles and for more precise control
also offers a set of number input boxes.
Reference: https://panel.holoviz.org/reference/widgets/EditableRangeSlider.html
:Example:
>>> EditableRangeSlider(
... value=(1.0, 1.5), start=0.0, end=2.0, step=0.25, name="A tuple of floats"
... )
"""
value = param.Range(default=(0, 1), allow_None=False, doc="""
Current range value. Updated when a handle is dragged.""")
value_throttled = param.Range(default=None, constant=True, doc="""
The value of the slider. Updated when the handle is released.""")
start = param.Number(default=0., doc="Lower bound of the range.")
end = param.Number(default=1., doc="Upper bound of the range.")
fixed_start = param.Number(default=None, doc="""
A fixed lower bound for the slider and input.""")
fixed_end = param.Number(default=None, doc="""
A fixed upper bound for the slider and input.""")
step = param.Number(default=0.1, doc="Slider and number input step.")
editable = param.Tuple(default=(True, True), doc="""
Whether the lower and upper values are editable.""")