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
|
# AUTO GENERATED FILE - DO NOT EDIT
import typing # noqa: F401
from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
from dash.development.base_component import Component, _explicitize_args
import datetime
ComponentType = typing.Union[
str,
int,
float,
Component,
None,
typing.Sequence[typing.Union[str, int, float, Component, None]],
]
NumberType = typing.Union[
typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
]
class DatePickerRange(Component):
"""A DatePickerRange component.
DatePickerRange is a tailor made component designed for selecting
timespan across multiple days off of a calendar.
The DatePicker integrates well with the Python datetime module with the
startDate and endDate being returned in a string format suitable for
creating datetime objects.
This component is based off of Airbnb's react-dates react component
which can be found here: https://github.com/airbnb/react-dates
Keyword arguments:
- start_date (string; optional):
Specifies the starting date for the component. Accepts
datetime.datetime objects or strings in the format 'YYYY-MM-DD'.
- end_date (string; optional):
Specifies the ending date for the component. Accepts
datetime.datetime objects or strings in the format 'YYYY-MM-DD'.
- min_date_allowed (string; optional):
Specifies the lowest selectable date for the component. Accepts
datetime.datetime objects or strings in the format 'YYYY-MM-DD'.
- max_date_allowed (string; optional):
Specifies the highest selectable date for the component. Accepts
datetime.datetime objects or strings in the format 'YYYY-MM-DD'.
- disabled_days (list of strings; optional):
Specifies additional days between min_date_allowed and
max_date_allowed that should be disabled. Accepted
datetime.datetime objects or strings in the format 'YYYY-MM-DD'.
- minimum_nights (number; optional):
Specifies a minimum number of nights that must be selected between
the startDate and the endDate.
- updatemode (a value equal to: 'singledate', 'bothdates'; default 'singledate'):
Determines when the component should update its value. If
`bothdates`, then the DatePicker will only trigger its value when
the user has finished picking both dates. If `singledate`, then
the DatePicker will update its value as one date is picked.
- start_date_placeholder_text (string; optional):
Text that will be displayed in the first input box of the date
picker when no date is selected. Default value is 'Start Date'.
- end_date_placeholder_text (string; optional):
Text that will be displayed in the second input box of the date
picker when no date is selected. Default value is 'End Date'.
- initial_visible_month (string; optional):
Specifies the month that is initially presented when the user
opens the calendar. Accepts datetime.datetime objects or strings
in the format 'YYYY-MM-DD'.
- clearable (boolean; default False):
Whether or not the dropdown is \"clearable\", that is, whether or
not a small \"x\" appears on the right of the dropdown that
removes the selected value.
- reopen_calendar_on_clear (boolean; default False):
If True, the calendar will automatically open when cleared.
- display_format (string; optional):
Specifies the format that the selected dates will be displayed
valid formats are variations of \"MM YY DD\". For example: \"MM YY
DD\" renders as '05 10 97' for May 10th 1997 \"MMMM, YY\" renders
as 'May, 1997' for May 10th 1997 \"M, D, YYYY\" renders as '07,
10, 1997' for September 10th 1997 \"MMMM\" renders as 'May' for
May 10 1997.
- month_format (string; optional):
Specifies the format that the month will be displayed in the
calendar, valid formats are variations of \"MM YY\". For example:
\"MM YY\" renders as '05 97' for May 1997 \"MMMM, YYYY\" renders
as 'May, 1997' for May 1997 \"MMM, YY\" renders as 'Sep, 97' for
September 1997.
- first_day_of_week (a value equal to: 0, 1, 2, 3, 4, 5, 6; default 0):
Specifies what day is the first day of the week, values must be
from [0, ..., 6] with 0 denoting Sunday and 6 denoting Saturday.
- show_outside_days (boolean; optional):
If True the calendar will display days that rollover into the next
month.
- stay_open_on_select (boolean; default False):
If True the calendar will not close when the user has selected a
value and will wait until the user clicks off the calendar.
- calendar_orientation (a value equal to: 'vertical', 'horizontal'; default 'horizontal'):
Orientation of calendar, either vertical or horizontal. Valid
options are 'vertical' or 'horizontal'.
- number_of_months_shown (number; default 1):
Number of calendar months that are shown when calendar is opened.
- with_portal (boolean; default False):
If True, calendar will open in a screen overlay portal, not
supported on vertical calendar.
- with_full_screen_portal (boolean; default False):
If True, calendar will open in a full screen overlay portal, will
take precedent over 'withPortal' if both are set to True, not
supported on vertical calendar.
- day_size (number; default 39):
Size of rendered calendar days, higher number means bigger day
size and larger calendar overall.
- is_RTL (boolean; default False):
Determines whether the calendar and days operate from left to
right or from right to left.
- disabled (boolean; default False):
If True, no dates can be selected.
- start_date_id (string; optional):
The HTML element ID of the start date input field. Not used by
Dash, only by CSS.
- end_date_id (string; optional):
The HTML element ID of the end date input field. Not used by Dash,
only by CSS.
- className (string; optional):
Appends a CSS class to the wrapper div component.
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks. The ID needs to be unique across all of the components
in an app.
- persistence (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, any
`persisted_props` that the user has changed while using the app
will keep those changes, as long as the new prop value also
matches what was given originally. Used in conjunction with
`persistence_type` and `persisted_props`.
- persisted_props (list of a value equal to: 'start_date', 'end_date's; default ['start_date', 'end_date']):
Properties whose user interactions will persist after refreshing
the component or the page.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "DatePickerRange"
def __init__(
self,
start_date: typing.Optional[typing.Union[str, datetime.datetime]] = None,
end_date: typing.Optional[typing.Union[str, datetime.datetime]] = None,
min_date_allowed: typing.Optional[typing.Union[str, datetime.datetime]] = None,
max_date_allowed: typing.Optional[typing.Union[str, datetime.datetime]] = None,
disabled_days: typing.Optional[
typing.Sequence[typing.Union[str, datetime.datetime]]
] = None,
minimum_nights: typing.Optional[NumberType] = None,
updatemode: typing.Optional[Literal["singledate", "bothdates"]] = None,
start_date_placeholder_text: typing.Optional[str] = None,
end_date_placeholder_text: typing.Optional[str] = None,
initial_visible_month: typing.Optional[str] = None,
clearable: typing.Optional[bool] = None,
reopen_calendar_on_clear: typing.Optional[bool] = None,
display_format: typing.Optional[str] = None,
month_format: typing.Optional[str] = None,
first_day_of_week: typing.Optional[Literal[0, 1, 2, 3, 4, 5, 6]] = None,
show_outside_days: typing.Optional[bool] = None,
stay_open_on_select: typing.Optional[bool] = None,
calendar_orientation: typing.Optional[Literal["vertical", "horizontal"]] = None,
number_of_months_shown: typing.Optional[NumberType] = None,
with_portal: typing.Optional[bool] = None,
with_full_screen_portal: typing.Optional[bool] = None,
day_size: typing.Optional[NumberType] = None,
is_RTL: typing.Optional[bool] = None,
disabled: typing.Optional[bool] = None,
start_date_id: typing.Optional[str] = None,
end_date_id: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
className: typing.Optional[str] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
persisted_props: typing.Optional[
typing.Sequence[Literal["start_date", "end_date"]]
] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"start_date",
"end_date",
"min_date_allowed",
"max_date_allowed",
"disabled_days",
"minimum_nights",
"updatemode",
"start_date_placeholder_text",
"end_date_placeholder_text",
"initial_visible_month",
"clearable",
"reopen_calendar_on_clear",
"display_format",
"month_format",
"first_day_of_week",
"show_outside_days",
"stay_open_on_select",
"calendar_orientation",
"number_of_months_shown",
"with_portal",
"with_full_screen_portal",
"day_size",
"is_RTL",
"disabled",
"start_date_id",
"end_date_id",
"style",
"className",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"start_date",
"end_date",
"min_date_allowed",
"max_date_allowed",
"disabled_days",
"minimum_nights",
"updatemode",
"start_date_placeholder_text",
"end_date_placeholder_text",
"initial_visible_month",
"clearable",
"reopen_calendar_on_clear",
"display_format",
"month_format",
"first_day_of_week",
"show_outside_days",
"stay_open_on_select",
"calendar_orientation",
"number_of_months_shown",
"with_portal",
"with_full_screen_portal",
"day_size",
"is_RTL",
"disabled",
"start_date_id",
"end_date_id",
"style",
"className",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self.available_wildcard_properties = []
_explicit_args = kwargs.pop("_explicit_args")
_locals = locals()
_locals.update(kwargs) # For wildcard attrs and excess named props
args = {k: _locals[k] for k in _explicit_args}
super(DatePickerRange, self).__init__(**args)
setattr(DatePickerRange, "__init__", _explicitize_args(DatePickerRange.__init__))
|
