This commit is contained in:
2025-09-07 22:09:54 +02:00
parent e1b817252c
commit 2fc0d000b6
7796 changed files with 2159515 additions and 933 deletions

View File

@ -0,0 +1,179 @@
# 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
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 Checklist(Component):
"""A Checklist component.
Checklist is a component that encapsulates several checkboxes.
The values and labels of the checklist are specified in the `options`
property and the checked items are specified with the `value` property.
Each checkbox is rendered as an input with a surrounding label.
Keyword arguments:
- options (list of dicts; optional):
An array of options.
`options` is a list of string | number | booleans | dict | list of
dicts with keys:
- label (a list of or a singular dash component, string or number; required):
The option's label.
- value (string | number | boolean; required):
The value of the option. This value corresponds to the items
specified in the `value` property.
- disabled (boolean; optional):
If True, this option is disabled and cannot be selected.
- title (string; optional):
The HTML 'title' attribute for the option. Allows for
information on hover. For more information on this attribute,
see
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title.
- value (list of string | number | booleans; optional):
The currently selected value.
- inline (boolean; default False):
Indicates whether the options labels should be displayed inline
(True=horizontal) or in a block (False=vertical).
- className (string; optional):
The class of the container (div).
- inputStyle (dict; optional):
The style of the <input> checkbox element.
- inputClassName (string; default ''):
The class of the <input> checkbox element.
- labelStyle (dict; optional):
The style of the <label> that wraps the checkbox input and the
option's label.
- labelClassName (string; default ''):
The class of the <label> that wraps the checkbox input and the
option's label.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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 = ["options[].label"]
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Checklist"
Options = TypedDict(
"Options",
{
"label": ComponentType,
"value": typing.Union[str, NumberType, bool],
"disabled": NotRequired[bool],
"title": NotRequired[str],
},
)
def __init__(
self,
options: typing.Optional[
typing.Union[
typing.Sequence[typing.Union[str, NumberType, bool]],
dict,
typing.Sequence["Options"],
]
] = None,
value: typing.Optional[
typing.Sequence[typing.Union[str, NumberType, bool]]
] = None,
inline: typing.Optional[bool] = None,
className: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
inputStyle: typing.Optional[dict] = None,
inputClassName: typing.Optional[str] = None,
labelStyle: typing.Optional[dict] = None,
labelClassName: 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["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"options",
"value",
"inline",
"className",
"style",
"inputStyle",
"inputClassName",
"labelStyle",
"labelClassName",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"options",
"value",
"inline",
"className",
"style",
"inputStyle",
"inputClassName",
"labelStyle",
"labelClassName",
"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(Checklist, self).__init__(**args)
setattr(Checklist, "__init__", _explicitize_args(Checklist.__init__))

View File

@ -0,0 +1,99 @@
# 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
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 Clipboard(Component):
"""A Clipboard component.
The Clipboard component copies text to the clipboard
Keyword arguments:
- id (string; optional):
The ID used to identify this component.
- className (string; optional):
The class name of the icon element.
- content (string; optional):
The text to be copied to the clipboard if the `target_id` is None.
- html_content (string; optional):
The clipboard html text be copied to the clipboard if the
`target_id` is None.
- n_clicks (number; default 0):
The number of times copy button was clicked.
- target_id (string | dict; optional):
The id of target component containing text to copy to the
clipboard. The inner text of the `children` prop will be copied to
the clipboard. If none, then the text from the `value` prop will
be copied.
- title (string; optional):
The text shown as a tooltip when hovering over the copy icon."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Clipboard"
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
target_id: typing.Optional[typing.Union[str, dict]] = None,
content: typing.Optional[str] = None,
n_clicks: typing.Optional[NumberType] = None,
html_content: typing.Optional[str] = None,
title: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
className: typing.Optional[str] = None,
**kwargs
):
self._prop_names = [
"id",
"className",
"content",
"html_content",
"n_clicks",
"style",
"target_id",
"title",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"className",
"content",
"html_content",
"n_clicks",
"style",
"target_id",
"title",
]
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(Clipboard, self).__init__(**args)
setattr(Clipboard, "__init__", _explicitize_args(Clipboard.__init__))

View File

@ -0,0 +1,97 @@
# 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
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 ConfirmDialog(Component):
"""A ConfirmDialog component.
ConfirmDialog is used to display the browser's native "confirm" modal,
with an optional message and two buttons ("OK" and "Cancel").
This ConfirmDialog can be used in conjunction with buttons when the user
is performing an action that should require an extra step of verification.
Keyword arguments:
- 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.
- cancel_n_clicks (number; default 0):
Number of times the popup was canceled.
- cancel_n_clicks_timestamp (number; default -1):
Last time the cancel button was clicked.
- displayed (boolean; optional):
Set to True to send the ConfirmDialog.
- message (string; optional):
Message to show in the popup.
- submit_n_clicks (number; default 0):
Number of times the submit button was clicked.
- submit_n_clicks_timestamp (number; default -1):
Last time the submit button was clicked."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "ConfirmDialog"
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
message: typing.Optional[str] = None,
submit_n_clicks: typing.Optional[NumberType] = None,
submit_n_clicks_timestamp: typing.Optional[NumberType] = None,
cancel_n_clicks: typing.Optional[NumberType] = None,
cancel_n_clicks_timestamp: typing.Optional[NumberType] = None,
displayed: typing.Optional[bool] = None,
**kwargs
):
self._prop_names = [
"id",
"cancel_n_clicks",
"cancel_n_clicks_timestamp",
"displayed",
"message",
"submit_n_clicks",
"submit_n_clicks_timestamp",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"cancel_n_clicks",
"cancel_n_clicks_timestamp",
"displayed",
"message",
"submit_n_clicks",
"submit_n_clicks_timestamp",
]
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(ConfirmDialog, self).__init__(**args)
setattr(ConfirmDialog, "__init__", _explicitize_args(ConfirmDialog.__init__))

View File

@ -0,0 +1,111 @@
# 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
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 ConfirmDialogProvider(Component):
"""A ConfirmDialogProvider component.
A wrapper component that will display a confirmation dialog
when its child component has been clicked on.
For example:
```
dcc.ConfirmDialogProvider(
html.Button('click me', id='btn'),
message='Danger - Are you sure you want to continue.'
id='confirm')
```
Keyword arguments:
- children (boolean | number | string | dict | list; optional):
The children to hijack clicks from and display the popup.
- 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.
- cancel_n_clicks (number; default 0):
Number of times the popup was canceled.
- cancel_n_clicks_timestamp (number; default -1):
Last time the cancel button was clicked.
- displayed (boolean; optional):
Is the modal currently displayed.
- message (string; optional):
Message to show in the popup.
- submit_n_clicks (number; default 0):
Number of times the submit was clicked.
- submit_n_clicks_timestamp (number; default -1):
Last time the submit button was clicked."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "ConfirmDialogProvider"
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
message: typing.Optional[str] = None,
submit_n_clicks: typing.Optional[NumberType] = None,
submit_n_clicks_timestamp: typing.Optional[NumberType] = None,
cancel_n_clicks: typing.Optional[NumberType] = None,
cancel_n_clicks_timestamp: typing.Optional[NumberType] = None,
displayed: typing.Optional[bool] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"cancel_n_clicks",
"cancel_n_clicks_timestamp",
"displayed",
"message",
"submit_n_clicks",
"submit_n_clicks_timestamp",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"cancel_n_clicks",
"cancel_n_clicks_timestamp",
"displayed",
"message",
"submit_n_clicks",
"submit_n_clicks_timestamp",
]
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 if k != "children"}
super(ConfirmDialogProvider, self).__init__(children=children, **args)
setattr(
ConfirmDialogProvider, "__init__", _explicitize_args(ConfirmDialogProvider.__init__)
)

View File

@ -0,0 +1,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__))

View File

@ -0,0 +1,258 @@
# 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 DatePickerSingle(Component):
"""A DatePickerSingle component.
DatePickerSingle is a tailor made component designed for selecting
a single day 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:
- date (string; optional):
Specifies the starting date for the component, best practice is to
pass value via datetime object.
- 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'.
- placeholder (string; optional):
Text that will be displayed in the input box of the date picker
when no date is selected. Default value is 'Start 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; default True):
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.
- 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, a `date` that
the user has changed while using the app will keep that change, as
long as the new `date` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persisted_props (list of a value equal to: 'date's; default ['date']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `date` is allowed this prop
can normally be ignored.
- 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 = "DatePickerSingle"
def __init__(
self,
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,
placeholder: typing.Optional[str] = None,
initial_visible_month: typing.Optional[
typing.Union[str, datetime.datetime]
] = 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,
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["date"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"date",
"min_date_allowed",
"max_date_allowed",
"disabled_days",
"placeholder",
"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",
"style",
"className",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"date",
"min_date_allowed",
"max_date_allowed",
"disabled_days",
"placeholder",
"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",
"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(DatePickerSingle, self).__init__(**args)
setattr(DatePickerSingle, "__init__", _explicitize_args(DatePickerSingle.__init__))

View File

@ -0,0 +1,90 @@
# 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
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 Download(Component):
"""A Download component.
The Download component opens a download dialog when the data property changes.
Keyword arguments:
- id (string; optional):
The ID of this component, used to identify dash components in
callbacks.
- base64 (boolean; default False):
Default value for base64, used when not set as part of the data
property.
- data (dict; optional):
On change, a download is invoked.
`data` is a dict with keys:
- filename (string; required):
Suggested filename in the download dialogue.
- content (string; required):
File content.
- base64 (boolean; optional):
Set to True, when data is base64 encoded.
- type (string; optional):
Blob type, usually a MIME-type.
- type (string; default 'text/plain'):
Default value for type, used when not set as part of the data
property."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Download"
Data = TypedDict(
"Data",
{
"filename": str,
"content": str,
"base64": NotRequired[bool],
"type": NotRequired[str],
},
)
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
data: typing.Optional["Data"] = None,
base64: typing.Optional[bool] = None,
type: typing.Optional[str] = None,
**kwargs
):
self._prop_names = ["id", "base64", "data", "type"]
self._valid_wildcard_attributes = []
self.available_properties = ["id", "base64", "data", "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(Download, self).__init__(**args)
setattr(Download, "__init__", _explicitize_args(Download.__init__))

View File

@ -0,0 +1,227 @@
# 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
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 Dropdown(Component):
"""A Dropdown component.
Dropdown is an interactive dropdown element for selecting one or more
items.
The values and labels of the dropdown items are specified in the `options`
property and the selected item(s) are specified with the `value` property.
Use a dropdown when you have many options (more than 5) or when you are
constrained for space. Otherwise, you can use RadioItems or a Checklist,
which have the benefit of showing the users all of the items at once.
Keyword arguments:
- options (list of dicts; optional):
An array of options {label: [string|number], value:
[string|number]}, an optional disabled field can be used for each
option.
`options` is a list of string | number | booleans | dict | list of
dicts with keys:
- label (a list of or a singular dash component, string or number; required):
The option's label.
- value (string | number | boolean; required):
The value of the option. This value corresponds to the items
specified in the `value` property.
- disabled (boolean; optional):
If True, this option is disabled and cannot be selected.
- title (string; optional):
The HTML 'title' attribute for the option. Allows for
information on hover. For more information on this attribute,
see
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title.
- search (string; optional):
Optional search value for the option, to use if the label is a
component or provide a custom search value different from the
label. If no search value and the label is a component, the
`value` will be used for search.
- value (string | number | boolean | list of string | number | booleans; optional):
The value of the input. If `multi` is False (the default) then
value is just a string that corresponds to the values provided in
the `options` property. If `multi` is True, then multiple values
can be selected at once, and `value` is an array of items with
values corresponding to those in the `options` prop.
- multi (boolean; default False):
If True, the user can select multiple values.
- clearable (boolean; default True):
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.
- searchable (boolean; default True):
Whether to enable the searching feature or not.
- search_value (string; optional):
The value typed in the DropDown for searching.
- placeholder (string; optional):
The grey, default text shown when no option is selected.
- disabled (boolean; default False):
If True, this dropdown is disabled and the selection cannot be
changed.
- closeOnSelect (boolean; default True):
If False, the menu of the dropdown will not close once a value is
selected.
- optionHeight (number; default 35):
height of each option. Can be increased when label lengths would
wrap around.
- maxHeight (number; default 200):
height of the options dropdown.
- className (string; optional):
className of the dropdown element.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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 = ["options[].label"]
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Dropdown"
Options = TypedDict(
"Options",
{
"label": ComponentType,
"value": typing.Union[str, NumberType, bool],
"disabled": NotRequired[bool],
"title": NotRequired[str],
"search": NotRequired[str],
},
)
def __init__(
self,
options: typing.Optional[
typing.Union[
typing.Sequence[typing.Union[str, NumberType, bool]],
dict,
typing.Sequence["Options"],
]
] = None,
value: typing.Optional[
typing.Union[
str,
NumberType,
bool,
typing.Sequence[typing.Union[str, NumberType, bool]],
]
] = None,
multi: typing.Optional[bool] = None,
clearable: typing.Optional[bool] = None,
searchable: typing.Optional[bool] = None,
search_value: typing.Optional[str] = None,
placeholder: typing.Optional[str] = None,
disabled: typing.Optional[bool] = None,
closeOnSelect: typing.Optional[bool] = None,
optionHeight: typing.Optional[NumberType] = None,
maxHeight: typing.Optional[NumberType] = 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["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"options",
"value",
"multi",
"clearable",
"searchable",
"search_value",
"placeholder",
"disabled",
"closeOnSelect",
"optionHeight",
"maxHeight",
"style",
"className",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"options",
"value",
"multi",
"clearable",
"searchable",
"search_value",
"placeholder",
"disabled",
"closeOnSelect",
"optionHeight",
"maxHeight",
"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(Dropdown, self).__init__(**args)
setattr(Dropdown, "__init__", _explicitize_args(Dropdown.__init__))

View File

@ -0,0 +1,173 @@
# 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
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 Geolocation(Component):
"""A Geolocation component.
The CurrentLocation component gets geolocation of the device from the web browser. See more info here:
https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API
Keyword arguments:
- id (string; optional):
The ID used to identify this component in Dash callbacks.
- high_accuracy (boolean; default False):
If True and if the device is able to provide a more accurate
position, it will do so. Note that this can result in slower
response times or increased power consumption (with a GPS chip on
a mobile device for example). If False (the default value), the
device can save resources by responding more quickly and/or using
less power.
- local_date (string; optional):
The local date and time when the device position was updated.
Format: MM/DD/YYYY, hh:mm:ss p where p is AM or PM.
- maximum_age (number; default 0):
The maximum age in milliseconds of a possible cached position that
is acceptable to return. If set to 0, it means that the device
cannot use a cached position and must attempt to retrieve the real
current position. If set to Infinity the device must return a
cached position regardless of its age. Default: 0.
- position (dict; optional):
The position of the device. `lat`, `lon`, and `accuracy` will
always be returned. The other data will be included when
available, otherwise it will be NaN. `lat` is latitude in
degrees. `lon` is longitude in degrees. `accuracy` is
the accuracy of the lat/lon in meters. * `alt` is
altitude above mean sea level in meters. `alt_accuracy` is
the accuracy of the altitude in meters. `heading` is the
compass heading in degrees. `speed` is the speed in meters
per second.
`position` is a dict with keys:
- lat (number; optional)
- lon (number; optional)
- accuracy (number; optional)
- alt (number; optional)
- alt_accuracy (number; optional)
- heading (number; optional)
- speed (number; optional)
- position_error (dict; optional):
Position error.
`position_error` is a dict with keys:
- code (number; optional)
- message (string; optional)
- show_alert (boolean; default False):
If True, error messages will be displayed as an alert.
- timeout (number; default Infinity):
The maximum length of time (in milliseconds) the device is allowed
to take in order to return a position. The default value is
Infinity, meaning that data will not be return until the position
is available.
- timestamp (number; optional):
The Unix timestamp from when the position was updated.
- update_now (boolean; default False):
Forces a one-time update of the position data. If set to True in
a callback, the browser will update the position data and reset
update_now back to False. This can, for example, be used to
update the position with a button or an interval timer."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Geolocation"
Position = TypedDict(
"Position",
{
"lat": NotRequired[NumberType],
"lon": NotRequired[NumberType],
"accuracy": NotRequired[NumberType],
"alt": NotRequired[NumberType],
"alt_accuracy": NotRequired[NumberType],
"heading": NotRequired[NumberType],
"speed": NotRequired[NumberType],
},
)
PositionError = TypedDict(
"PositionError", {"code": NotRequired[NumberType], "message": NotRequired[str]}
)
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
local_date: typing.Optional[str] = None,
timestamp: typing.Optional[NumberType] = None,
position: typing.Optional["Position"] = None,
position_error: typing.Optional["PositionError"] = None,
show_alert: typing.Optional[bool] = None,
update_now: typing.Optional[bool] = None,
high_accuracy: typing.Optional[bool] = None,
maximum_age: typing.Optional[NumberType] = None,
timeout: typing.Optional[NumberType] = None,
**kwargs
):
self._prop_names = [
"id",
"high_accuracy",
"local_date",
"maximum_age",
"position",
"position_error",
"show_alert",
"timeout",
"timestamp",
"update_now",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"high_accuracy",
"local_date",
"maximum_age",
"position",
"position_error",
"show_alert",
"timeout",
"timestamp",
"update_now",
]
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(Geolocation, self).__init__(**args)
setattr(Geolocation, "__init__", _explicitize_args(Geolocation.__init__))

View File

@ -0,0 +1,463 @@
# 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
from plotly.graph_objects import Figure
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 Graph(Component):
"""A Graph component.
Graph can be used to render any plotly.js-powered data visualization.
You can define callbacks based on user interaction with Graphs such as
hovering, clicking or selecting
Keyword arguments:
- 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.
- animate (boolean; default False):
Beta: If True, animate between updates using plotly.js's `animate`
function.
- animation_options (dict; default { frame: { redraw: False, }, transition: { duration: 750, ease: 'cubic-in-out', },}):
Beta: Object containing animation settings. Only applies if
`animate` is `True`.
- className (string; optional):
className of the parent div.
- clear_on_unhover (boolean; default False):
If True, `clear_on_unhover` will clear the `hoverData` property
when the user \"unhovers\" from a point. If False, then the
`hoverData` property will be equal to the data from the last point
that was hovered over.
- clickAnnotationData (dict; optional):
Data from latest click annotation event. Read-only.
- clickData (dict; optional):
Data from latest click event. Read-only.
- config (dict; optional):
Plotly.js config options. See
https://plotly.com/javascript/configuration-options/ for more
info.
`config` is a dict with keys:
- staticPlot (boolean; optional):
No interactivity, for export or image generation.
- plotlyServerURL (string; optional):
Base URL for a Plotly cloud instance, if `showSendToCloud` is
enabled.
- editable (boolean; optional):
We can edit titles, move annotations, etc - sets all pieces of
`edits` unless a separate `edits` config item overrides
individual parts.
- editSelection (boolean; optional):
Enables moving selections.
- edits (dict; optional):
A set of editable properties.
`edits` is a dict with keys:
- annotationPosition (boolean; optional):
The main anchor of the annotation, which is the text (if
no arrow) or the arrow (which drags the whole thing
leaving the arrow length & direction unchanged).
- annotationTail (boolean; optional):
Just for annotations with arrows, change the length and
direction of the arrow.
- annotationText (boolean; optional)
- axisTitleText (boolean; optional)
- colorbarPosition (boolean; optional)
- colorbarTitleText (boolean; optional)
- legendPosition (boolean; optional)
- legendText (boolean; optional):
Edit the trace name fields from the legend.
- shapePosition (boolean; optional)
- titleText (boolean; optional):
The global `layout.title`.
- autosizable (boolean; optional):
DO autosize once regardless of layout.autosize (use default
width or height values otherwise).
- responsive (boolean; optional):
Whether to change layout size when the window size changes.
- queueLength (number; optional):
Set the length of the undo/redo queue.
- fillFrame (boolean; optional):
If we DO autosize, do we fill the container or the screen?.
- frameMargins (number; optional):
If we DO autosize, set the frame margins in percents of plot
size.
- scrollZoom (boolean; optional):
Mousewheel or two-finger scroll zooms the plot.
- doubleClick (a value equal to: false, 'reset', 'autosize', 'reset+autosize'; optional):
Double click interaction (False, 'reset', 'autosize' or
'reset+autosize').
- doubleClickDelay (number; optional):
Delay for registering a double-click event in ms. The minimum
value is 100 and the maximum value is 1000. By default this is
300.
- showTips (boolean; optional):
New users see some hints about interactivity.
- showAxisDragHandles (boolean; optional):
Enable axis pan/zoom drag handles.
- showAxisRangeEntryBoxes (boolean; optional):
Enable direct range entry at the pan/zoom drag points (drag
handles must be enabled above).
- showLink (boolean; optional):
Link to open this plot in plotly.
- sendData (boolean; optional):
If we show a link, does it contain data or just link to a
plotly file?.
- linkText (string; optional):
Text appearing in the sendData link.
- displayModeBar (a value equal to: true, false, 'hover'; optional):
Display the mode bar (True, False, or 'hover').
- showSendToCloud (boolean; optional):
Should we include a modebar button to send this data to a
Plotly Cloud instance, linked by `plotlyServerURL`. By default
this is False.
- showEditInChartStudio (boolean; optional):
Should we show a modebar button to send this data to a Plotly
Chart Studio plot. If both this and showSendToCloud are
selected, only showEditInChartStudio will be honored. By
default this is False.
- modeBarButtonsToRemove (list; optional):
Remove mode bar button by name. All modebar button names at
https://github.com/plotly/plotly.js/blob/master/src/components/modebar/buttons.js
Common names include: sendDataToCloud; (2D) zoom2d, pan2d,
select2d, lasso2d, zoomIn2d, zoomOut2d, autoScale2d,
resetScale2d; (Cartesian) hoverClosestCartesian,
hoverCompareCartesian; (3D) zoom3d, pan3d, orbitRotation,
tableRotation, handleDrag3d, resetCameraDefault3d,
resetCameraLastSave3d, hoverClosest3d; (Geo) zoomInGeo,
zoomOutGeo, resetGeo, hoverClosestGeo; hoverClosestGl2d,
hoverClosestPie, toggleHover, resetViews.
- modeBarButtonsToAdd (list; optional):
Add mode bar button using config objects.
- modeBarButtons (boolean | number | string | dict | list; optional):
Fully custom mode bar buttons as nested array, where the outer
arrays represents button groups, and the inner arrays have
buttons config objects or names of default buttons.
- toImageButtonOptions (dict; optional):
Modifications to how the toImage modebar button works.
`toImageButtonOptions` is a dict with keys:
- format (a value equal to: 'jpeg', 'png', 'webp', 'svg'; optional):
The file format to create.
- filename (string; optional):
The name given to the downloaded file.
- width (number; optional):
Width of the downloaded file, in px.
- height (number; optional):
Height of the downloaded file, in px.
- scale (number; optional):
Extra resolution to give the file after rendering it with
the given width and height.
- displaylogo (boolean; optional):
Add the plotly logo on the end of the mode bar.
- watermark (boolean; optional):
Add the plotly logo even with no modebar.
- plotGlPixelRatio (number; optional):
Increase the pixel ratio for Gl plot images.
- topojsonURL (string; optional):
URL to topojson files used in geo charts.
- mapboxAccessToken (boolean | number | string | dict | list; optional):
Mapbox access token (required to plot mapbox trace types) If
using an Mapbox Atlas server, set this option to '', so that
plotly.js won't attempt to authenticate to the public Mapbox
server.
- locale (string; optional):
The locale to use. Locales may be provided with the plot
(`locales` below) or by loading them on the page, see:
https://github.com/plotly/plotly.js/blob/master/dist/README.md#to-include-localization.
- locales (dict; optional):
Localization definitions, if you choose to provide them with
the plot rather than registering them globally.
- extendData (list | dict; optional):
Data that should be appended to existing traces. Has the form
`[updateData, traceIndices, maxPoints]`, where `updateData` is an
object containing the data to extend, `traceIndices` (optional) is
an array of trace indices that should be extended, and `maxPoints`
(optional) is either an integer defining the maximum number of
points allowed or an object with key:value pairs matching
`updateData` Reference the Plotly.extendTraces API for full usage:
https://plotly.com/javascript/plotlyjs-function-reference/#plotlyextendtraces.
- figure (dict; default { data: [], layout: {}, frames: [],}):
Plotly `figure` object. See schema:
https://plotly.com/javascript/reference `config` is set
separately by the `config` property.
`figure` is a dict with keys:
- data (list of dicts; optional)
- layout (dict; optional)
- frames (list of dicts; optional)
- hoverData (dict; optional):
Data from latest hover event. Read-only.
- mathjax (boolean; default False):
If True, loads mathjax v3 (tex-svg) into the page and use it in
the graph.
- prependData (list | dict; optional):
Data that should be prepended to existing traces. Has the form
`[updateData, traceIndices, maxPoints]`, where `updateData` is an
object containing the data to prepend, `traceIndices` (optional)
is an array of trace indices that should be prepended, and
`maxPoints` (optional) is either an integer defining the maximum
number of points allowed or an object with key:value pairs
matching `updateData` Reference the Plotly.prependTraces API for
full usage:
https://plotly.com/javascript/plotlyjs-function-reference/#plotlyprependtraces.
- relayoutData (dict; optional):
Data from latest relayout event which occurs when the user zooms
or pans on the plot or other layout-level edits. Has the form
`{<attr string>: <value>}` describing the changes made. Read-only.
- responsive (a value equal to: true, false, 'auto'; default 'auto'):
If True, the Plotly.js plot will be fully responsive to window
resize and parent element resize event. This is achieved by
overriding `config.responsive` to True, `figure.layout.autosize`
to True and unsetting `figure.layout.height` and
`figure.layout.width`. If False, the Plotly.js plot not be
responsive to window resize and parent element resize event. This
is achieved by overriding `config.responsive` to False and
`figure.layout.autosize` to False. If 'auto' (default), the Graph
will determine if the Plotly.js plot can be made fully responsive
(True) or not (False) based on the values in `config.responsive`,
`figure.layout.autosize`, `figure.layout.height`,
`figure.layout.width`. This is the legacy behavior of the Graph
component. Needs to be combined with appropriate dimension /
styling through the `style` prop to fully take effect.
- restyleData (list; optional):
Data from latest restyle event which occurs when the user toggles
a legend item, changes parcoords selections, or other trace-level
edits. Has the form `[edits, indices]`, where `edits` is an object
`{<attr string>: <value>}` describing the changes made, and
`indices` is an array of trace indices that were edited.
Read-only.
- selectedData (dict; optional):
Data from latest select event. Read-only."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Graph"
ConfigEdits = TypedDict(
"ConfigEdits",
{
"annotationPosition": NotRequired[bool],
"annotationTail": NotRequired[bool],
"annotationText": NotRequired[bool],
"axisTitleText": NotRequired[bool],
"colorbarPosition": NotRequired[bool],
"colorbarTitleText": NotRequired[bool],
"legendPosition": NotRequired[bool],
"legendText": NotRequired[bool],
"shapePosition": NotRequired[bool],
"titleText": NotRequired[bool],
},
)
ConfigToImageButtonOptions = TypedDict(
"ConfigToImageButtonOptions",
{
"format": NotRequired[Literal["jpeg", "png", "webp", "svg"]],
"filename": NotRequired[str],
"width": NotRequired[NumberType],
"height": NotRequired[NumberType],
"scale": NotRequired[NumberType],
},
)
Config = TypedDict(
"Config",
{
"staticPlot": NotRequired[bool],
"plotlyServerURL": NotRequired[str],
"editable": NotRequired[bool],
"editSelection": NotRequired[bool],
"edits": NotRequired["ConfigEdits"],
"autosizable": NotRequired[bool],
"responsive": NotRequired[bool],
"queueLength": NotRequired[NumberType],
"fillFrame": NotRequired[bool],
"frameMargins": NotRequired[NumberType],
"scrollZoom": NotRequired[bool],
"doubleClick": NotRequired[
Literal[False, "reset", "autosize", "reset+autosize"]
],
"doubleClickDelay": NotRequired[NumberType],
"showTips": NotRequired[bool],
"showAxisDragHandles": NotRequired[bool],
"showAxisRangeEntryBoxes": NotRequired[bool],
"showLink": NotRequired[bool],
"sendData": NotRequired[bool],
"linkText": NotRequired[str],
"displayModeBar": NotRequired[Literal[True, False, "hover"]],
"showSendToCloud": NotRequired[bool],
"showEditInChartStudio": NotRequired[bool],
"modeBarButtonsToRemove": NotRequired[typing.Sequence],
"modeBarButtonsToAdd": NotRequired[typing.Sequence],
"modeBarButtons": NotRequired[typing.Any],
"toImageButtonOptions": NotRequired["ConfigToImageButtonOptions"],
"displaylogo": NotRequired[bool],
"watermark": NotRequired[bool],
"plotGlPixelRatio": NotRequired[NumberType],
"topojsonURL": NotRequired[str],
"mapboxAccessToken": NotRequired[typing.Any],
"locale": NotRequired[str],
"locales": NotRequired[dict],
},
)
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
responsive: typing.Optional[Literal[True, False, "auto"]] = None,
clickData: typing.Optional[dict] = None,
clickAnnotationData: typing.Optional[dict] = None,
hoverData: typing.Optional[dict] = None,
clear_on_unhover: typing.Optional[bool] = None,
selectedData: typing.Optional[dict] = None,
relayoutData: typing.Optional[dict] = None,
extendData: typing.Optional[typing.Union[typing.Sequence, dict]] = None,
prependData: typing.Optional[typing.Union[typing.Sequence, dict]] = None,
restyleData: typing.Optional[typing.Sequence] = None,
figure: typing.Optional[typing.Union[Figure, dict]] = None,
style: typing.Optional[typing.Any] = None,
className: typing.Optional[str] = None,
mathjax: typing.Optional[bool] = None,
animate: typing.Optional[bool] = None,
animation_options: typing.Optional[dict] = None,
config: typing.Optional["Config"] = None,
**kwargs
):
self._prop_names = [
"id",
"animate",
"animation_options",
"className",
"clear_on_unhover",
"clickAnnotationData",
"clickData",
"config",
"extendData",
"figure",
"hoverData",
"mathjax",
"prependData",
"relayoutData",
"responsive",
"restyleData",
"selectedData",
"style",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"animate",
"animation_options",
"className",
"clear_on_unhover",
"clickAnnotationData",
"clickData",
"config",
"extendData",
"figure",
"hoverData",
"mathjax",
"prependData",
"relayoutData",
"responsive",
"restyleData",
"selectedData",
"style",
]
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(Graph, self).__init__(**args)
setattr(Graph, "__init__", _explicitize_args(Graph.__init__))

View File

@ -0,0 +1,399 @@
# 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
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 Input(Component):
"""An Input component.
A basic HTML input control for entering text, numbers, or passwords.
Note that checkbox and radio types are supported through
the Checklist and RadioItems component. Dates, times, and file uploads
are also supported through separate components.
Keyword arguments:
- value (string | number; optional):
The value of the input.
- type (a value equal to: 'text', 'number', 'password', 'email', 'range', 'search', 'tel', 'url', 'hidden'; default 'text'):
The type of control to render.
- debounce (boolean | number; default False):
If True, changes to input will be sent back to the Dash server
only on enter or when losing focus. If it's False, it will send
the value back on every change. If a number, it will not send
anything back to the Dash server until the user has stopped typing
for that number of seconds.
- placeholder (string | number; optional):
A hint to the user of what can be entered in the control . The
placeholder text must not contain carriage returns or line-feeds.
Note: Do not use the placeholder attribute instead of a <label>
element, their purposes are different. The <label> attribute
describes the role of the form element (i.e. it indicates what
kind of information is expected), and the placeholder attribute is
a hint about the format that the content should take. There are
cases in which the placeholder attribute is never displayed to the
user, so the form must be understandable without it.
- n_submit (number; default 0):
Number of times the `Enter` key was pressed while the input had
focus.
- n_submit_timestamp (number; default -1):
Last time that `Enter` was pressed.
- inputMode (a value equal to: 'verbatim', 'latin', 'latin-name', 'latin-prose', 'full-width-latin', 'kana', 'katakana', 'numeric', 'tel', 'email', 'url'; optional):
Provides a hint to the browser as to the type of data that might
be entered by the user while editing the element or its contents.
- autoComplete (string; optional):
This attribute indicates whether the value of the control can be
automatically completed by the browser.
- readOnly (boolean | a value equal to: 'readOnly', 'readonly', 'READONLY'; optional):
This attribute indicates that the user cannot modify the value of
the control. The value of the attribute is irrelevant. If you need
read-write access to the input value, do not add the \"readonly\"
attribute. It is ignored if the value of the type attribute is
hidden, range, color, checkbox, radio, file, or a button type
(such as button or submit). readOnly is an HTML boolean attribute
- it is enabled by a boolean or 'readOnly'. Alternative
capitalizations `readonly` & `READONLY` are also acccepted.
- required (a value equal to: 'required', 'REQUIRED' | boolean; optional):
This attribute specifies that the user must fill in a value before
submitting a form. It cannot be used when the type attribute is
hidden, image, or a button type (submit, reset, or button). The
:optional and :required CSS pseudo-classes will be applied to the
field as appropriate. required is an HTML boolean attribute - it
is enabled by a boolean or 'required'. Alternative capitalizations
`REQUIRED` are also acccepted.
- autoFocus (a value equal to: 'autoFocus', 'autofocus', 'AUTOFOCUS' | boolean; optional):
The element should be automatically focused after the page loaded.
autoFocus is an HTML boolean attribute - it is enabled by a
boolean or 'autoFocus'. Alternative capitalizations `autofocus` &
`AUTOFOCUS` are also acccepted.
- disabled (a value equal to: 'disabled', 'DISABLED' | boolean; optional):
If True, the input is disabled and can't be clicked on. disabled
is an HTML boolean attribute - it is enabled by a boolean or
'disabled'. Alternative capitalizations `DISABLED`.
- list (string; optional):
Identifies a list of pre-defined options to suggest to the user.
The value must be the id of a <datalist> element in the same
document. The browser displays only options that are valid values
for this input element. This attribute is ignored when the type
attribute's value is hidden, checkbox, radio, file, or a button
type.
- multiple (boolean; optional):
This Boolean attribute indicates whether the user can enter more
than one value. This attribute applies when the type attribute is
set to email or file, otherwise it is ignored.
- spellCheck (a value equal to: 'true', 'false' | boolean; optional):
Setting the value of this attribute to True indicates that the
element needs to have its spelling and grammar checked. The value
default indicates that the element is to act according to a
default behavior, possibly based on the parent element's own
spellcheck value. The value False indicates that the element
should not be checked.
- name (string; optional):
The name of the control, which is submitted with the form data.
- min (string | number; optional):
The minimum (numeric or date-time) value for this item, which must
not be greater than its maximum (max attribute) value.
- max (string | number; optional):
The maximum (numeric or date-time) value for this item, which must
not be less than its minimum (min attribute) value.
- step (string | number; default 'any'):
Works with the min and max attributes to limit the increments at
which a numeric or date-time value can be set. It can be the
string any or a positive floating point number. If this attribute
is not set to any, the control accepts only values at multiples of
the step value greater than the minimum.
- minLength (string | number; optional):
If the value of the type attribute is text, email, search,
password, tel, or url, this attribute specifies the minimum number
of characters (in Unicode code points) that the user can enter.
For other control types, it is ignored.
- maxLength (string | number; optional):
If the value of the type attribute is text, email, search,
password, tel, or url, this attribute specifies the maximum number
of characters (in UTF-16 code units) that the user can enter. For
other control types, it is ignored. It can exceed the value of the
size attribute. If it is not specified, the user can enter an
unlimited number of characters. Specifying a negative number
results in the default behavior (i.e. the user can enter an
unlimited number of characters). The constraint is evaluated only
when the value of the attribute has been changed.
- pattern (string; optional):
A regular expression that the control's value is checked against.
The pattern must match the entire value, not just some subset. Use
the title attribute to describe the pattern to help the user. This
attribute applies when the value of the type attribute is text,
search, tel, url, email, or password, otherwise it is ignored. The
regular expression language is the same as JavaScript RegExp
algorithm, with the 'u' parameter that makes it treat the pattern
as a sequence of unicode code points. The pattern is not
surrounded by forward slashes.
- selectionStart (string; optional):
The offset into the element's text content of the first selected
character. If there's no selection, this value indicates the
offset to the character following the current text input cursor
position (that is, the position the next character typed would
occupy).
- selectionEnd (string; optional):
The offset into the element's text content of the last selected
character. If there's no selection, this value indicates the
offset to the character following the current text input cursor
position (that is, the position the next character typed would
occupy).
- selectionDirection (string; optional):
The direction in which selection occurred. This is \"forward\" if
the selection was made from left-to-right in an LTR locale or
right-to-left in an RTL locale, or \"backward\" if the selection
was made in the opposite direction. On platforms on which it's
possible this value isn't known, the value can be \"none\"; for
example, on macOS, the default direction is \"none\", then as the
user begins to modify the selection using the keyboard, this will
change to reflect the direction in which the selection is
expanding.
- n_blur (number; default 0):
Number of times the input lost focus.
- n_blur_timestamp (number; default -1):
Last time the input lost focus.
- size (string; optional):
The initial size of the control. This value is in pixels unless
the value of the type attribute is text or password, in which case
it is an integer number of characters. Starting in, this attribute
applies only when the type attribute is set to text, search, tel,
url, email, or password, otherwise it is ignored. In addition, the
size must be greater than zero. If you do not specify a size, a
default value of 20 is used.' simply states \"the user agent
should ensure that at least that many characters are visible\",
but different characters can have different widths in certain
fonts. In some browsers, a certain string with x characters will
not be entirely visible even if size is defined to at least x.
- className (string; optional):
The class of the input element.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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 = "Input"
def __init__(
self,
value: typing.Optional[typing.Union[str, NumberType]] = None,
type: typing.Optional[
Literal[
"text",
"number",
"password",
"email",
"range",
"search",
"tel",
"url",
"hidden",
]
] = None,
debounce: typing.Optional[typing.Union[bool, NumberType]] = None,
placeholder: typing.Optional[typing.Union[str, NumberType]] = None,
n_submit: typing.Optional[NumberType] = None,
n_submit_timestamp: typing.Optional[NumberType] = None,
inputMode: typing.Optional[
Literal[
"verbatim",
"latin",
"latin-name",
"latin-prose",
"full-width-latin",
"kana",
"katakana",
"numeric",
"tel",
"email",
"url",
]
] = None,
autoComplete: typing.Optional[str] = None,
readOnly: typing.Optional[
typing.Union[bool, Literal["readOnly", "readonly", "READONLY"]]
] = None,
required: typing.Optional[
typing.Union[Literal["required", "REQUIRED"], bool]
] = None,
autoFocus: typing.Optional[
typing.Union[Literal["autoFocus", "autofocus", "AUTOFOCUS"], bool]
] = None,
disabled: typing.Optional[
typing.Union[Literal["disabled", "DISABLED"], bool]
] = None,
list: typing.Optional[str] = None,
multiple: typing.Optional[bool] = None,
spellCheck: typing.Optional[
typing.Union[Literal["true", "false"], bool]
] = None,
name: typing.Optional[str] = None,
min: typing.Optional[typing.Union[str, NumberType]] = None,
max: typing.Optional[typing.Union[str, NumberType]] = None,
step: typing.Optional[typing.Union[str, NumberType]] = None,
minLength: typing.Optional[typing.Union[str, NumberType]] = None,
maxLength: typing.Optional[typing.Union[str, NumberType]] = None,
pattern: typing.Optional[str] = None,
selectionStart: typing.Optional[str] = None,
selectionEnd: typing.Optional[str] = None,
selectionDirection: typing.Optional[str] = None,
n_blur: typing.Optional[NumberType] = None,
n_blur_timestamp: typing.Optional[NumberType] = None,
size: 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["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"value",
"type",
"debounce",
"placeholder",
"n_submit",
"n_submit_timestamp",
"inputMode",
"autoComplete",
"readOnly",
"required",
"autoFocus",
"disabled",
"list",
"multiple",
"spellCheck",
"name",
"min",
"max",
"step",
"minLength",
"maxLength",
"pattern",
"selectionStart",
"selectionEnd",
"selectionDirection",
"n_blur",
"n_blur_timestamp",
"size",
"style",
"className",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"value",
"type",
"debounce",
"placeholder",
"n_submit",
"n_submit_timestamp",
"inputMode",
"autoComplete",
"readOnly",
"required",
"autoFocus",
"disabled",
"list",
"multiple",
"spellCheck",
"name",
"min",
"max",
"step",
"minLength",
"maxLength",
"pattern",
"selectionStart",
"selectionEnd",
"selectionDirection",
"n_blur",
"n_blur_timestamp",
"size",
"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(Input, self).__init__(**args)
setattr(Input, "__init__", _explicitize_args(Input.__init__))

View File

@ -0,0 +1,88 @@
# 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
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 Interval(Component):
"""An Interval component.
A component that repeatedly increments a counter `n_intervals`
with a fixed time delay between each increment.
Interval is good for triggering a component on a recurring basis.
The time delay is set with the property "interval" in milliseconds.
Keyword arguments:
- 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.
- disabled (boolean; optional):
If True, the counter will no longer update.
- interval (number; default 1000):
This component will increment the counter `n_intervals` every
`interval` milliseconds.
- max_intervals (number; default -1):
Number of times the interval will be fired. If -1, then the
interval has no limit (the default) and if 0 then the interval
stops running.
- n_intervals (number; default 0):
Number of times the interval has passed."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Interval"
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
interval: typing.Optional[NumberType] = None,
disabled: typing.Optional[bool] = None,
n_intervals: typing.Optional[NumberType] = None,
max_intervals: typing.Optional[NumberType] = None,
**kwargs
):
self._prop_names = [
"id",
"disabled",
"interval",
"max_intervals",
"n_intervals",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"disabled",
"interval",
"max_intervals",
"n_intervals",
]
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(Interval, self).__init__(**args)
setattr(Interval, "__init__", _explicitize_args(Interval.__init__))

View File

@ -0,0 +1,132 @@
# 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
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 Link(Component):
"""A Link component.
Link allows you to create a clickable link within a multi-page app.
For links with destinations outside the current app, `html.A` is a better
component to use.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The children of this component.
- href (string; required):
The URL of a linked resource.
- target (string; optional):
Specifies where to open the link reference.
- refresh (boolean; default False):
Controls whether or not the page will refresh when the link is
clicked.
- title (string; optional):
Adds the title attribute to your link, which can contain
supplementary information.
- className (string; optional):
Often used with CSS to style elements with common properties.
- 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.
- loading_state (dict; optional):
Object that holds the loading state object coming from
dash-renderer.
`loading_state` is a dict with keys:
- is_loading (boolean; optional):
Determines if the component is loading or not.
- prop_name (string; optional):
Holds which property is loading.
- component_name (string; optional):
Holds the name of the component that is loading."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Link"
LoadingState = TypedDict(
"LoadingState",
{
"is_loading": NotRequired[bool],
"prop_name": NotRequired[str],
"component_name": NotRequired[str],
},
)
def __init__(
self,
children: typing.Optional[ComponentType] = None,
href: typing.Optional[str] = None,
target: typing.Optional[str] = None,
refresh: typing.Optional[bool] = None,
title: typing.Optional[str] = None,
className: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
loading_state: typing.Optional["LoadingState"] = None,
**kwargs
):
self._prop_names = [
"children",
"href",
"target",
"refresh",
"title",
"className",
"style",
"id",
"loading_state",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"href",
"target",
"refresh",
"title",
"className",
"style",
"id",
"loading_state",
]
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 if k != "children"}
for k in ["href"]:
if k not in args:
raise TypeError("Required argument `" + k + "` was not specified.")
super(Link, self).__init__(children=children, **args)
setattr(Link, "__init__", _explicitize_args(Link.__init__))

View File

@ -0,0 +1,171 @@
# 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
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 Loading(Component):
"""A Loading component.
Keyword arguments:
- children (list of a list of or a singular dash component, string or numbers | a list of or a singular dash component, string or number; optional):
Array that holds components to render.
- 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.
- className (string; optional):
Additional CSS class for the built-in spinner root DOM node.
- color (string; default '#119DFF'):
Primary color used for the built-in loading spinners.
- custom_spinner (a list of or a singular dash component, string or number; optional):
Component to use rather than the built-in spinner specified in the
`type` prop.
- debug (boolean; optional):
If True, the built-in spinner will display the component_name and
prop_name while loading.
- delay_hide (number; default 0):
Add a time delay (in ms) to the spinner being removed to prevent
flickering.
- delay_show (number; default 0):
Add a time delay (in ms) to the spinner being shown after the
loading_state is set to True.
- display (a value equal to: 'auto', 'show', 'hide'; default 'auto'):
Setting display to \"show\" or \"hide\" will override the
loading state coming from dash-renderer.
- fullscreen (boolean; optional):
Boolean that makes the built-in spinner display full-screen.
- overlay_style (dict; optional):
Additional CSS styling for the spinner overlay. This is applied to
the dcc.Loading children while the spinner is active. The default
is `{'visibility': 'hidden'}`.
- parent_className (string; optional):
Additional CSS class for the outermost dcc.Loading parent div DOM
node.
- parent_style (dict; optional):
Additional CSS styling for the outermost dcc.Loading parent div
DOM node.
- show_initially (boolean; default True):
Whether the Spinner should show on app start-up before the loading
state has been determined. Default True. Use when also setting
`delay_show`.
- target_components (dict with strings as keys and values of type string | list of strings; optional):
Specify component and prop to trigger showing the loading spinner
example: `{\"output-container\": \"children\", \"grid\":
[\"rowData\", \"columnDefs]}`.
- type (a value equal to: 'graph', 'cube', 'circle', 'dot', 'default'; optional):
Property that determines which built-in spinner to show one of
'graph', 'cube', 'circle', 'dot', or 'default'."""
_children_props = ["custom_spinner"]
_base_nodes = ["custom_spinner", "children"]
_namespace = "dash_core_components"
_type = "Loading"
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
type: typing.Optional[
Literal["graph", "cube", "circle", "dot", "default"]
] = None,
fullscreen: typing.Optional[bool] = None,
debug: typing.Optional[bool] = None,
className: typing.Optional[str] = None,
parent_className: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
parent_style: typing.Optional[dict] = None,
overlay_style: typing.Optional[dict] = None,
color: typing.Optional[str] = None,
display: typing.Optional[Literal["auto", "show", "hide"]] = None,
delay_hide: typing.Optional[NumberType] = None,
delay_show: typing.Optional[NumberType] = None,
show_initially: typing.Optional[bool] = None,
target_components: typing.Optional[
typing.Dict[
typing.Union[str, float, int], typing.Union[str, typing.Sequence[str]]
]
] = None,
custom_spinner: typing.Optional[ComponentType] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"className",
"color",
"custom_spinner",
"debug",
"delay_hide",
"delay_show",
"display",
"fullscreen",
"overlay_style",
"parent_className",
"parent_style",
"show_initially",
"style",
"target_components",
"type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"className",
"color",
"custom_spinner",
"debug",
"delay_hide",
"delay_show",
"display",
"fullscreen",
"overlay_style",
"parent_className",
"parent_style",
"show_initially",
"style",
"target_components",
"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 if k != "children"}
super(Loading, self).__init__(children=children, **args)
setattr(Loading, "__init__", _explicitize_args(Loading.__init__))

View File

@ -0,0 +1,94 @@
# 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
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 Location(Component):
"""A Location component.
Update and track the current window.location object through the window.history state.
Use in conjunction with the `dash_core_components.Link` component to make apps with multiple pages.
Keyword arguments:
- id (string; required):
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.
- hash (string; optional):
hash in window.location - e.g., \"#myhash\".
- href (string; optional):
href in window.location - e.g.,
\"/my/full/pathname?myargument=1#myhash\".
- pathname (string; optional):
pathname in window.location - e.g., \"/my/full/pathname\".
- refresh (a value equal to: 'callback-nav' | boolean; default True):
Use `True` to navigate outside the Dash app or to manually refresh
a page. Use `False` if the same callback that updates the Location
component is also updating the page content - typically used in
multi-page apps that do not use Pages. Use 'callback-nav' if you
are updating the URL in a callback, or a different callback will
respond to the new Location with updated content. This is typical
with multi-page apps that use Pages. This will allow for
navigating to a new page without refreshing the page.
- search (string; optional):
search in window.location - e.g., \"?myargument=1\"."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Location"
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
pathname: typing.Optional[str] = None,
search: typing.Optional[str] = None,
hash: typing.Optional[str] = None,
href: typing.Optional[str] = None,
refresh: typing.Optional[typing.Union[Literal["callback-nav"], bool]] = None,
**kwargs
):
self._prop_names = ["id", "hash", "href", "pathname", "refresh", "search"]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"hash",
"href",
"pathname",
"refresh",
"search",
]
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}
for k in ["id"]:
if k not in args:
raise TypeError("Required argument `" + k + "` was not specified.")
super(Location, self).__init__(**args)
setattr(Location, "__init__", _explicitize_args(Location.__init__))

View File

@ -0,0 +1,122 @@
# 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
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 Markdown(Component):
"""A Markdown component.
A component that renders Markdown text as specified by the
GitHub Markdown spec. These component uses
[react-markdown](https://rexxars.github.io/react-markdown/) under the hood.
Keyword arguments:
- children (string | list of strings; optional):
A markdown string (or array of strings) that adheres to the
CommonMark spec.
- 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.
- className (string; optional):
Class name of the container element.
- dangerously_allow_html (boolean; default False):
A boolean to control raw HTML escaping. Setting HTML from code is
risky because it's easy to inadvertently expose your users to a
cross-site scripting (XSS)
(https://en.wikipedia.org/wiki/Cross-site_scripting) attack.
- dedent (boolean; default True):
Remove matching leading whitespace from all lines. Lines that are
empty, or contain *only* whitespace, are ignored. Both spaces and
tab characters are removed, but only if they match; we will not
convert tabs to spaces or vice versa.
- highlight_config (dict; optional):
Config options for syntax highlighting.
`highlight_config` is a dict with keys:
- theme (a value equal to: 'dark', 'light'; optional):
Color scheme; default 'light'.
- link_target (string; optional):
A string for the target attribute to use on links (such as
\"_blank\").
- mathjax (boolean; default False):
If True, loads mathjax v3 (tex-svg) into the page and use it in
the markdown."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Markdown"
HighlightConfig = TypedDict(
"HighlightConfig", {"theme": NotRequired[Literal["dark", "light"]]}
)
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
className: typing.Optional[str] = None,
mathjax: typing.Optional[bool] = None,
dangerously_allow_html: typing.Optional[bool] = None,
link_target: typing.Optional[str] = None,
dedent: typing.Optional[bool] = None,
highlight_config: typing.Optional["HighlightConfig"] = None,
style: typing.Optional[typing.Any] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"className",
"dangerously_allow_html",
"dedent",
"highlight_config",
"link_target",
"mathjax",
"style",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"className",
"dangerously_allow_html",
"dedent",
"highlight_config",
"link_target",
"mathjax",
"style",
]
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 if k != "children"}
super(Markdown, self).__init__(children=children, **args)
setattr(Markdown, "__init__", _explicitize_args(Markdown.__init__))

View File

@ -0,0 +1,177 @@
# 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
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 RadioItems(Component):
"""A RadioItems component.
RadioItems is a component that encapsulates several radio item inputs.
The values and labels of the RadioItems is specified in the `options`
property and the seleced item is specified with the `value` property.
Each radio item is rendered as an input with a surrounding label.
Keyword arguments:
- options (list of dicts; optional):
An array of options, or inline dictionary of options.
`options` is a list of string | number | booleans | dict | list of
dicts with keys:
- label (a list of or a singular dash component, string or number; required):
The option's label.
- value (string | number | boolean; required):
The value of the option. This value corresponds to the items
specified in the `value` property.
- disabled (boolean; optional):
If True, this option is disabled and cannot be selected.
- title (string; optional):
The HTML 'title' attribute for the option. Allows for
information on hover. For more information on this attribute,
see
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title.
- value (string | number | boolean; optional):
The currently selected value.
- inline (boolean; default False):
Indicates whether the options labels should be displayed inline
(True=horizontal) or in a block (False=vertical).
- className (string; optional):
The class of the container (div).
- inputStyle (dict; optional):
The style of the <input> radio element.
- inputClassName (string; default ''):
The class of the <input> radio element.
- labelStyle (dict; optional):
The style of the <label> that wraps the radio input and the
option's label.
- labelClassName (string; default ''):
The class of the <label> that wraps the radio input and the
option's label.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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 = ["options[].label"]
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "RadioItems"
Options = TypedDict(
"Options",
{
"label": ComponentType,
"value": typing.Union[str, NumberType, bool],
"disabled": NotRequired[bool],
"title": NotRequired[str],
},
)
def __init__(
self,
options: typing.Optional[
typing.Union[
typing.Sequence[typing.Union[str, NumberType, bool]],
dict,
typing.Sequence["Options"],
]
] = None,
value: typing.Optional[typing.Union[str, NumberType, bool]] = None,
inline: typing.Optional[bool] = None,
style: typing.Optional[typing.Any] = None,
className: typing.Optional[str] = None,
inputStyle: typing.Optional[dict] = None,
inputClassName: typing.Optional[str] = None,
labelStyle: typing.Optional[dict] = None,
labelClassName: 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["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"options",
"value",
"inline",
"style",
"className",
"inputStyle",
"inputClassName",
"labelStyle",
"labelClassName",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"options",
"value",
"inline",
"style",
"className",
"inputStyle",
"inputClassName",
"labelStyle",
"labelClassName",
"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(RadioItems, self).__init__(**args)
setattr(RadioItems, "__init__", _explicitize_args(RadioItems.__init__))

View File

@ -0,0 +1,263 @@
# 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
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 RangeSlider(Component):
"""A RangeSlider component.
A double slider with two handles.
Used for specifying a range of numerical values.
Keyword arguments:
- min (number; optional):
Minimum allowed value of the slider.
- max (number; optional):
Maximum allowed value of the slider.
- step (number; optional):
Value by which increments or decrements are made.
- marks (dict; optional):
Marks on the slider. The key determines the position (a number),
and the value determines what will show. If you want to set the
style of a specific mark point, the value should be an object
which contains style and label properties.
`marks` is a dict with strings as keys and values of type string |
dict with keys:
- label (string; optional)
- style (dict; optional)
- value (list of numbers; optional):
The value of the input.
- drag_value (list of numbers; optional):
The value of the input during a drag.
- allowCross (boolean; optional):
allowCross could be set as True to allow those handles to cross.
- pushable (boolean | number; optional):
pushable could be set as True to allow pushing of surrounding
handles when moving an handle. When set to a number, the number
will be the minimum ensured distance between handles.
- disabled (boolean; optional):
If True, the handles can't be moved.
- count (number; optional):
Determine how many ranges to render, and multiple handles will be
rendered (number + 1).
- dots (boolean; optional):
When the step value is greater than 1, you can set the dots to
True if you want to render the slider with dots.
- included (boolean; optional):
If the value is True, it means a continuous value is included.
Otherwise, it is an independent value.
- tooltip (dict; optional):
Configuration for tooltips describing the current slider values.
`tooltip` is a dict with keys:
- always_visible (boolean; optional):
Determines whether tooltips should always be visible (as
opposed to the default, visible on hover).
- placement (a value equal to: 'left', 'right', 'top', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'; optional):
Determines the placement of tooltips See
https://github.com/react-component/tooltip#api top/bottom{*}
sets the _origin_ of the tooltip, so e.g. `topLeft` will in
reality appear to be on the top right of the handle.
- template (string; optional):
Template string to display the tooltip in. Must contain
`{value}`, which will be replaced with either the default
string representation of the value or the result of the
transform function if there is one.
- style (dict; optional):
Custom style for the tooltip.
- transform (string; optional):
Reference to a function in the `window.dccFunctions`
namespace. This can be added in a script in the asset folder.
For example, in `assets/tooltip.js`: ``` window.dccFunctions =
window.dccFunctions || {}; window.dccFunctions.multByTen =
function(value) { return value * 10; } ``` Then in the
component `tooltip={'transform': 'multByTen'}`.
- updatemode (a value equal to: 'mouseup', 'drag'; default 'mouseup'):
Determines when the component should update its `value` property.
If `mouseup` (the default) then the slider will only trigger its
value when the user has finished dragging the slider. If `drag`,
then the slider will update its value continuously as it is being
dragged. Note that for the latter case, the `drag_value` property
could be used instead.
- vertical (boolean; optional):
If True, the slider will be vertical.
- verticalHeight (number; default 400):
The height, in px, of the slider if it is vertical.
- className (string; optional):
Additional CSS class for the root DOM node.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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 = "RangeSlider"
Marks = TypedDict("Marks", {"label": NotRequired[str], "style": NotRequired[dict]})
Tooltip = TypedDict(
"Tooltip",
{
"always_visible": NotRequired[bool],
"placement": NotRequired[
Literal[
"left",
"right",
"top",
"bottom",
"topLeft",
"topRight",
"bottomLeft",
"bottomRight",
]
],
"template": NotRequired[str],
"style": NotRequired[dict],
"transform": NotRequired[str],
},
)
def __init__(
self,
min: typing.Optional[NumberType] = None,
max: typing.Optional[NumberType] = None,
step: typing.Optional[NumberType] = None,
marks: typing.Optional[
typing.Dict[typing.Union[str, float, int], typing.Union[str, "Marks"]]
] = None,
value: typing.Optional[typing.Sequence[NumberType]] = None,
drag_value: typing.Optional[typing.Sequence[NumberType]] = None,
allowCross: typing.Optional[bool] = None,
pushable: typing.Optional[typing.Union[bool, NumberType]] = None,
disabled: typing.Optional[bool] = None,
count: typing.Optional[NumberType] = None,
dots: typing.Optional[bool] = None,
included: typing.Optional[bool] = None,
tooltip: typing.Optional["Tooltip"] = None,
updatemode: typing.Optional[Literal["mouseup", "drag"]] = None,
vertical: typing.Optional[bool] = None,
verticalHeight: typing.Optional[NumberType] = 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["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"min",
"max",
"step",
"marks",
"value",
"drag_value",
"allowCross",
"pushable",
"disabled",
"count",
"dots",
"included",
"tooltip",
"updatemode",
"vertical",
"verticalHeight",
"className",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"min",
"max",
"step",
"marks",
"value",
"drag_value",
"allowCross",
"pushable",
"disabled",
"count",
"dots",
"included",
"tooltip",
"updatemode",
"vertical",
"verticalHeight",
"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(RangeSlider, self).__init__(**args)
setattr(RangeSlider, "__init__", _explicitize_args(RangeSlider.__init__))

View File

@ -0,0 +1,242 @@
# 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
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 Slider(Component):
"""A Slider component.
A slider component with a single handle.
Keyword arguments:
- min (number; optional):
Minimum allowed value of the slider.
- max (number; optional):
Maximum allowed value of the slider.
- step (number; optional):
Value by which increments or decrements are made.
- marks (dict; optional):
Marks on the slider. The key determines the position (a number),
and the value determines what will show. If you want to set the
style of a specific mark point, the value should be an object
which contains style and label properties.
`marks` is a dict with strings as keys and values of type string |
dict with keys:
- label (string; optional)
- style (dict; optional)
- value (number; optional):
The value of the input.
- drag_value (number; optional):
The value of the input during a drag.
- disabled (boolean; optional):
If True, the handles can't be moved.
- dots (boolean; optional):
When the step value is greater than 1, you can set the dots to
True if you want to render the slider with dots.
- included (boolean; optional):
If the value is True, it means a continuous value is included.
Otherwise, it is an independent value.
- tooltip (dict; optional):
Configuration for tooltips describing the current slider value.
`tooltip` is a dict with keys:
- always_visible (boolean; optional):
Determines whether tooltips should always be visible (as
opposed to the default, visible on hover).
- placement (a value equal to: 'left', 'right', 'top', 'bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'; optional):
Determines the placement of tooltips See
https://github.com/react-component/tooltip#api top/bottom{*}
sets the _origin_ of the tooltip, so e.g. `topLeft` will in
reality appear to be on the top right of the handle.
- template (string; optional):
Template string to display the tooltip in. Must contain
`{value}`, which will be replaced with either the default
string representation of the value or the result of the
transform function if there is one.
- style (dict; optional):
Custom style for the tooltip.
- transform (string; optional):
Reference to a function in the `window.dccFunctions`
namespace. This can be added in a script in the asset folder.
For example, in `assets/tooltip.js`: ``` window.dccFunctions =
window.dccFunctions || {}; window.dccFunctions.multByTen =
function(value) { return value * 10; } ``` Then in the
component `tooltip={'transform': 'multByTen'}`.
- updatemode (a value equal to: 'mouseup', 'drag'; default 'mouseup'):
Determines when the component should update its `value` property.
If `mouseup` (the default) then the slider will only trigger its
value when the user has finished dragging the slider. If `drag`,
then the slider will update its value continuously as it is being
dragged. If you want different actions during and after drag,
leave `updatemode` as `mouseup` and use `drag_value` for the
continuously updating value.
- vertical (boolean; optional):
If True, the slider will be vertical.
- verticalHeight (number; default 400):
The height, in px, of the slider if it is vertical.
- className (string; optional):
Additional CSS class for the root DOM node.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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 = "Slider"
Marks = TypedDict("Marks", {"label": NotRequired[str], "style": NotRequired[dict]})
Tooltip = TypedDict(
"Tooltip",
{
"always_visible": NotRequired[bool],
"placement": NotRequired[
Literal[
"left",
"right",
"top",
"bottom",
"topLeft",
"topRight",
"bottomLeft",
"bottomRight",
]
],
"template": NotRequired[str],
"style": NotRequired[dict],
"transform": NotRequired[str],
},
)
def __init__(
self,
min: typing.Optional[NumberType] = None,
max: typing.Optional[NumberType] = None,
step: typing.Optional[NumberType] = None,
marks: typing.Optional[
typing.Dict[typing.Union[str, float, int], typing.Union[str, "Marks"]]
] = None,
value: typing.Optional[NumberType] = None,
drag_value: typing.Optional[NumberType] = None,
disabled: typing.Optional[bool] = None,
dots: typing.Optional[bool] = None,
included: typing.Optional[bool] = None,
tooltip: typing.Optional["Tooltip"] = None,
updatemode: typing.Optional[Literal["mouseup", "drag"]] = None,
vertical: typing.Optional[bool] = None,
verticalHeight: typing.Optional[NumberType] = 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["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"min",
"max",
"step",
"marks",
"value",
"drag_value",
"disabled",
"dots",
"included",
"tooltip",
"updatemode",
"vertical",
"verticalHeight",
"className",
"id",
"persistence",
"persisted_props",
"persistence_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"min",
"max",
"step",
"marks",
"value",
"drag_value",
"disabled",
"dots",
"included",
"tooltip",
"updatemode",
"vertical",
"verticalHeight",
"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(Slider, self).__init__(**args)
setattr(Slider, "__init__", _explicitize_args(Slider.__init__))

View File

@ -0,0 +1,94 @@
# 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
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 Store(Component):
"""A Store component.
Easily keep data on the client side with this component.
The data is not inserted in the DOM.
Data can be in memory, localStorage or sessionStorage.
The data will be kept with the id as key.
Keyword arguments:
- id (string; required):
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.
- clear_data (boolean; default False):
Set to True to remove the data contained in `data_key`.
- data (dict | list | number | string | boolean; optional):
The stored data for the id.
- modified_timestamp (number; default -1):
The last time the storage was modified.
- storage_type (a value equal to: 'local', 'session', 'memory'; default 'memory'):
The type of the web storage. 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 = "Store"
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
storage_type: typing.Optional[Literal["local", "session", "memory"]] = None,
data: typing.Optional[
typing.Union[dict, typing.Sequence, NumberType, str, bool]
] = None,
clear_data: typing.Optional[bool] = None,
modified_timestamp: typing.Optional[NumberType] = None,
**kwargs
):
self._prop_names = [
"id",
"clear_data",
"data",
"modified_timestamp",
"storage_type",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"clear_data",
"data",
"modified_timestamp",
"storage_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}
for k in ["id"]:
if k not in args:
raise TypeError("Required argument `" + k + "` was not specified.")
super(Store, self).__init__(**args)
setattr(Store, "__init__", _explicitize_args(Store.__init__))

View File

@ -0,0 +1,118 @@
# 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
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 Tab(Component):
"""A Tab component.
Part of dcc.Tabs - this is the child Tab component used to render a tabbed page.
Its children will be set as the content of that tab, which if clicked will become visible.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The content of the tab - will only be displayed if this tab is
selected.
- 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.
- className (string; optional):
Appends a class to the Tab component.
- disabled (boolean; default False):
Determines if tab is disabled or not - defaults to False.
- disabled_className (string; optional):
Appends a class to the Tab component when it is disabled.
- disabled_style (dict; default {color: '#d6d6d6'}):
Overrides the default (inline) styles when disabled.
- label (string; optional):
The tab's label.
- selected_className (string; optional):
Appends a class to the Tab component when it is selected.
- selected_style (dict; optional):
Overrides the default (inline) styles for the Tab component when
it is selected.
- value (string; optional):
Value for determining which Tab is currently selected."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Tab"
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
label: typing.Optional[str] = None,
value: typing.Optional[str] = None,
disabled: typing.Optional[bool] = None,
disabled_style: typing.Optional[dict] = None,
disabled_className: typing.Optional[str] = None,
className: typing.Optional[str] = None,
selected_className: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
selected_style: typing.Optional[dict] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"className",
"disabled",
"disabled_className",
"disabled_style",
"label",
"selected_className",
"selected_style",
"style",
"value",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"className",
"disabled",
"disabled_className",
"disabled_style",
"label",
"selected_className",
"selected_style",
"style",
"value",
]
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 if k != "children"}
super(Tab, self).__init__(children=children, **args)
setattr(Tab, "__init__", _explicitize_args(Tab.__init__))

View File

@ -0,0 +1,176 @@
# 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
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 Tabs(Component):
"""A Tabs component.
A Dash component that lets you render pages with tabs - the Tabs component's children
can be dcc.Tab components, which can hold a label that will be displayed as a tab, and can in turn hold
children components that will be that tab's content.
Keyword arguments:
- children (list of a list of or a singular dash component, string or numbers | a list of or a singular dash component, string or number; optional):
Array that holds Tab components.
- 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.
- className (string; optional):
Appends a class to the Tabs container holding the individual Tab
components.
- colors (dict; default { border: '#d6d6d6', primary: '#1975FA', background: '#f9f9f9',}):
Holds the colors used by the Tabs and Tab components. If you set
these, you should specify colors for all properties, so: colors: {
border: '#d6d6d6', primary: '#1975FA', background: '#f9f9f9'
}.
`colors` is a dict with keys:
- border (string; optional)
- primary (string; optional)
- background (string; optional)
- content_className (string; optional):
Appends a class to the Tab content container holding the children
of the Tab that is selected.
- content_style (dict; optional):
Appends (inline) styles to the tab content container holding the
children of the Tab that is selected.
- mobile_breakpoint (number; default 800):
Breakpoint at which tabs are rendered full width (can be 0 if you
don't want full width tabs on mobile).
- parent_className (string; optional):
Appends a class to the top-level parent container holding both the
Tabs container and the content container.
- parent_style (dict; optional):
Appends (inline) styles to the top-level parent container holding
both the Tabs container and the content container.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- 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.
- value (string; optional):
The value of the currently selected Tab.
- vertical (boolean; default False):
Renders the tabs vertically (on the side)."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Tabs"
Colors = TypedDict(
"Colors",
{
"border": NotRequired[str],
"primary": NotRequired[str],
"background": NotRequired[str],
},
)
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
value: typing.Optional[str] = None,
className: typing.Optional[str] = None,
content_className: typing.Optional[str] = None,
parent_className: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
parent_style: typing.Optional[dict] = None,
content_style: typing.Optional[dict] = None,
vertical: typing.Optional[bool] = None,
mobile_breakpoint: typing.Optional[NumberType] = None,
colors: typing.Optional["Colors"] = None,
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
persisted_props: typing.Optional[typing.Sequence[Literal["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"className",
"colors",
"content_className",
"content_style",
"mobile_breakpoint",
"parent_className",
"parent_style",
"persisted_props",
"persistence",
"persistence_type",
"style",
"value",
"vertical",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"className",
"colors",
"content_className",
"content_style",
"mobile_breakpoint",
"parent_className",
"parent_style",
"persisted_props",
"persistence",
"persistence_type",
"style",
"value",
"vertical",
]
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 if k != "children"}
super(Tabs, self).__init__(children=children, **args)
setattr(Tabs, "__init__", _explicitize_args(Tabs.__init__))

View File

@ -0,0 +1,275 @@
# 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
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 Textarea(Component):
"""A Textarea component.
A basic HTML textarea for entering multiline text.
Keyword arguments:
- 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.
- accessKey (string; optional):
Defines a keyboard shortcut to activate or add focus to the
element.
- autoFocus (string; optional):
The element should be automatically focused after the page loaded.
- className (string; optional):
Often used with CSS to style elements with common properties.
- cols (string | number; optional):
Defines the number of columns in a textarea.
- contentEditable (string | boolean; optional):
Indicates whether the element's content is editable.
- contextMenu (string; optional):
Defines the ID of a <menu> element which will serve as the
element's context menu.
- dir (string; optional):
Defines the text direction. Allowed values are ltr (Left-To-Right)
or rtl (Right-To-Left).
- disabled (string | boolean; optional):
Indicates whether the user can interact with the element.
- draggable (a value equal to: 'true', 'false' | boolean; optional):
Defines whether the element can be dragged.
- form (string; optional):
Indicates the form that is the owner of the element.
- hidden (string; optional):
Prevents rendering of given element, while keeping child elements,
e.g. script elements, active.
- lang (string; optional):
Defines the language used in the element.
- maxLength (string | number; optional):
Defines the maximum number of characters allowed in the element.
- minLength (string | number; optional):
Defines the minimum number of characters allowed in the element.
- n_blur (number; default 0):
Number of times the textarea lost focus.
- n_blur_timestamp (number; default -1):
Last time the textarea lost focus.
- n_clicks (number; optional):
Number of times the textarea has been clicked.
- n_clicks_timestamp (number; default -1):
Last time the textarea was clicked.
- name (string; optional):
Name of the element. For example used by the server to identify
the fields in form submits.
- persisted_props (list of a value equal to: 'value's; optional):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- 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, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; optional):
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.
- placeholder (string; optional):
Provides a hint to the user of what can be entered in the field.
- readOnly (boolean | a value equal to: 'readOnly', 'readonly', 'READONLY'; optional):
Indicates whether the element can be edited. readOnly is an HTML
boolean attribute - it is enabled by a boolean or 'readOnly'.
Alternative capitalizations `readonly` & `READONLY` are also
acccepted.
- required (a value equal to: 'required', 'REQUIRED' | boolean; optional):
Indicates whether this element is required to fill out or not.
required is an HTML boolean attribute - it is enabled by a boolean
or 'required'. Alternative capitalizations `REQUIRED` are also
acccepted.
- rows (string | number; optional):
Defines the number of rows in a text area.
- spellCheck (a value equal to: 'true', 'false' | boolean; optional):
Indicates whether spell checking is allowed for the element.
- tabIndex (string | number; optional):
Overrides the browser's default tab order and follows the one
specified instead.
- title (string; optional):
Text to be displayed in a tooltip when hovering over the element.
- value (string; optional):
The value of the textarea.
- wrap (string; optional):
Indicates whether the text should be wrapped."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Textarea"
def __init__(
self,
id: typing.Optional[typing.Union[str, dict]] = None,
value: typing.Optional[str] = None,
autoFocus: typing.Optional[str] = None,
cols: typing.Optional[typing.Union[str, NumberType]] = None,
disabled: typing.Optional[typing.Union[str, bool]] = None,
form: typing.Optional[str] = None,
maxLength: typing.Optional[typing.Union[str, NumberType]] = None,
minLength: typing.Optional[typing.Union[str, NumberType]] = None,
name: typing.Optional[str] = None,
placeholder: typing.Optional[str] = None,
readOnly: typing.Optional[
typing.Union[bool, Literal["readOnly", "readonly", "READONLY"]]
] = None,
required: typing.Optional[
typing.Union[Literal["required", "REQUIRED"], bool]
] = None,
rows: typing.Optional[typing.Union[str, NumberType]] = None,
wrap: typing.Optional[str] = None,
accessKey: typing.Optional[str] = None,
className: typing.Optional[str] = None,
contentEditable: typing.Optional[typing.Union[str, bool]] = None,
contextMenu: typing.Optional[str] = None,
dir: typing.Optional[str] = None,
draggable: typing.Optional[typing.Union[Literal["true", "false"], bool]] = None,
hidden: typing.Optional[str] = None,
lang: typing.Optional[str] = None,
spellCheck: typing.Optional[
typing.Union[Literal["true", "false"], bool]
] = None,
style: typing.Optional[typing.Any] = None,
tabIndex: typing.Optional[typing.Union[str, NumberType]] = None,
title: typing.Optional[str] = None,
n_blur: typing.Optional[NumberType] = None,
n_blur_timestamp: typing.Optional[NumberType] = None,
n_clicks: typing.Optional[NumberType] = None,
n_clicks_timestamp: typing.Optional[NumberType] = None,
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
persisted_props: typing.Optional[typing.Sequence[Literal["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"id",
"accessKey",
"autoFocus",
"className",
"cols",
"contentEditable",
"contextMenu",
"dir",
"disabled",
"draggable",
"form",
"hidden",
"lang",
"maxLength",
"minLength",
"n_blur",
"n_blur_timestamp",
"n_clicks",
"n_clicks_timestamp",
"name",
"persisted_props",
"persistence",
"persistence_type",
"placeholder",
"readOnly",
"required",
"rows",
"spellCheck",
"style",
"tabIndex",
"title",
"value",
"wrap",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"id",
"accessKey",
"autoFocus",
"className",
"cols",
"contentEditable",
"contextMenu",
"dir",
"disabled",
"draggable",
"form",
"hidden",
"lang",
"maxLength",
"minLength",
"n_blur",
"n_blur_timestamp",
"n_clicks",
"n_clicks_timestamp",
"name",
"persisted_props",
"persistence",
"persistence_type",
"placeholder",
"readOnly",
"required",
"rows",
"spellCheck",
"style",
"tabIndex",
"title",
"value",
"wrap",
]
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(Textarea, self).__init__(**args)
setattr(Textarea, "__init__", _explicitize_args(Textarea.__init__))

View File

@ -0,0 +1,145 @@
# 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
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 Tooltip(Component):
"""A Tooltip component.
A tooltip with an absolute position.
Keyword arguments:
- children (a list of or a singular dash component, string or number; optional):
The contents of the tooltip.
- 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.
- background_color (string; default 'white'):
Color of the tooltip background, as a CSS color string.
- bbox (dict; optional):
The bounding box coordinates of the item to label, in px relative
to the positioning parent of the Tooltip component.
`bbox` is a dict with keys:
- x0 (number; optional)
- y0 (number; optional)
- x1 (number; optional)
- y1 (number; optional)
- border_color (string; default '#d6d6d6'):
Color of the tooltip border, as a CSS color string.
- className (string; default ''):
The class of the tooltip.
- direction (a value equal to: 'top', 'right', 'bottom', 'left'; default 'right'):
The side of the `bbox` on which the tooltip should open.
- loading_text (string; default 'Loading...'):
The text displayed in the tooltip while loading.
- show (boolean; default True):
Whether to show the tooltip.
- targetable (boolean; default False):
Whether the tooltip itself can be targeted by pointer events. For
tooltips triggered by hover events, typically this should be left
`False` to avoid the tooltip interfering with those same events.
- zindex (number; default 1):
The `z-index` CSS property to assign to the tooltip. Components
with higher values will be displayed on top of components with
lower values."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Tooltip"
Bbox = TypedDict(
"Bbox",
{
"x0": NotRequired[NumberType],
"y0": NotRequired[NumberType],
"x1": NotRequired[NumberType],
"y1": NotRequired[NumberType],
},
)
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
className: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
bbox: typing.Optional["Bbox"] = None,
show: typing.Optional[bool] = None,
direction: typing.Optional[Literal["top", "right", "bottom", "left"]] = None,
border_color: typing.Optional[str] = None,
background_color: typing.Optional[str] = None,
loading_text: typing.Optional[str] = None,
zindex: typing.Optional[NumberType] = None,
targetable: typing.Optional[bool] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"background_color",
"bbox",
"border_color",
"className",
"direction",
"loading_text",
"show",
"style",
"targetable",
"zindex",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"background_color",
"bbox",
"border_color",
"className",
"direction",
"loading_text",
"show",
"style",
"targetable",
"zindex",
]
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 if k != "children"}
super(Tooltip, self).__init__(children=children, **args)
setattr(Tooltip, "__init__", _explicitize_args(Tooltip.__init__))

View File

@ -0,0 +1,173 @@
# 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
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 Upload(Component):
"""An Upload component.
Upload components allow your app to accept user-uploaded files via drag'n'drop
Keyword arguments:
- children (a list of or a singular dash component, string or number | string; optional):
Contents of the upload 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.
- accept (string; optional):
Allow specific types of files. See
https://github.com/okonet/attr-accept for more information. Keep
in mind that mime type determination is not reliable across
platforms. CSV files, for example, are reported as text/plain
under macOS but as application/vnd.ms-excel under Windows. In some
cases there might not be a mime type set at all. See:
https://github.com/react-dropzone/react-dropzone/issues/276.
- className (string; optional):
HTML class name of the component.
- className_active (string; optional):
HTML class name of the component while active.
- className_disabled (string; optional):
HTML class name of the component if disabled.
- className_reject (string; optional):
HTML class name of the component if rejected.
- contents (string | list of strings; optional):
The contents of the uploaded file as a binary string.
- disable_click (boolean; default False):
Disallow clicking on the component to open the file dialog.
- disabled (boolean; default False):
Enable/disable the upload component entirely.
- filename (string | list of strings; optional):
The name of the file(s) that was(were) uploaded. Note that this
does not include the path of the file (for security reasons).
- last_modified (number | list of numbers; optional):
The last modified date of the file that was uploaded in unix time
(seconds since 1970).
- max_size (number; default -1):
Maximum file size in bytes. If `-1`, then infinite.
- min_size (number; default 0):
Minimum file size in bytes.
- multiple (boolean; default False):
Allow dropping multiple files.
- style_active (dict; default { borderStyle: 'solid', borderColor: '#6c6', backgroundColor: '#eee',}):
CSS styles to apply while active.
- style_disabled (dict; default { opacity: 0.5,}):
CSS styles if disabled.
- style_reject (dict; default { borderStyle: 'solid', borderColor: '#c66', backgroundColor: '#eee',}):
CSS styles if rejected."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Upload"
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
contents: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
filename: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
last_modified: typing.Optional[
typing.Union[NumberType, typing.Sequence[NumberType]]
] = None,
accept: typing.Optional[str] = None,
disabled: typing.Optional[bool] = None,
disable_click: typing.Optional[bool] = None,
max_size: typing.Optional[NumberType] = None,
min_size: typing.Optional[NumberType] = None,
multiple: typing.Optional[bool] = None,
className: typing.Optional[str] = None,
className_active: typing.Optional[str] = None,
className_reject: typing.Optional[str] = None,
className_disabled: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
style_active: typing.Optional[dict] = None,
style_reject: typing.Optional[dict] = None,
style_disabled: typing.Optional[dict] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"accept",
"className",
"className_active",
"className_disabled",
"className_reject",
"contents",
"disable_click",
"disabled",
"filename",
"last_modified",
"max_size",
"min_size",
"multiple",
"style",
"style_active",
"style_disabled",
"style_reject",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"accept",
"className",
"className_active",
"className_disabled",
"className_reject",
"contents",
"disable_click",
"disabled",
"filename",
"last_modified",
"max_size",
"min_size",
"multiple",
"style",
"style_active",
"style_disabled",
"style_reject",
]
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 if k != "children"}
super(Upload, self).__init__(children=children, **args)
setattr(Upload, "__init__", _explicitize_args(Upload.__init__))

View File

@ -0,0 +1,129 @@
import json
import os as _os
import sys as _sys
import dash as _dash
from ._imports_ import * # noqa: F401, F403, E402
from ._imports_ import __all__ as _components
from .express import ( # noqa: F401, E402
send_bytes,
send_data_frame,
send_file,
send_string,
)
__all__ = _components + [ # type: ignore[reportUnsupportedDunderAll]
"send_bytes",
"send_data_frame",
"send_file",
"send_string",
]
_basepath = _os.path.dirname(__file__)
_filepath = _os.path.abspath(_os.path.join(_basepath, "package-info.json"))
with open(_filepath) as f:
package = json.load(f)
package_name = package["name"].replace(" ", "_").replace("-", "_")
__version__ = package["version"]
# Module imports trigger a dash.development import, need to check this first
if not hasattr(_dash, "__plotly_dash") and not hasattr(_dash, "development"):
print(
"Dash was not successfully imported. Make sure you don't have a file "
"named \n'dash.py' in your current directory.",
file=_sys.stderr,
)
_sys.exit(1)
_current_path = _os.path.dirname(_os.path.abspath(__file__))
_this_module = "dash_core_components"
async_resources = [
"datepicker",
"dropdown",
"graph",
"highlight",
"markdown",
"mathjax",
"slider",
"upload",
]
_js_dist = []
_js_dist.extend(
[
{
"relative_package_path": "dcc/async-{}.js".format(async_resource),
"external_url": (
"https://unpkg.com/dash-core-components@{}"
"/dash_core_components/async-{}.js"
).format(__version__, async_resource),
"namespace": "dash",
"async": True,
}
for async_resource in async_resources
]
)
_js_dist.extend(
[
{
"relative_package_path": "dcc/async-{}.js.map".format(async_resource),
"external_url": (
"https://unpkg.com/dash-core-components@{}"
"/dash_core_components/async-{}.js.map"
).format(__version__, async_resource),
"namespace": "dash",
"dynamic": True,
}
for async_resource in async_resources
]
)
_js_dist.extend(
[
{
"relative_package_path": "dcc/{}.js".format(_this_module),
"external_url": (
"https://unpkg.com/dash-core-components@{}"
"/dash_core_components/dash_core_components.js"
).format(__version__),
"namespace": "dash",
},
{
"relative_package_path": "dcc/{}.js.map".format(_this_module),
"external_url": (
"https://unpkg.com/dash-core-components@{}"
"/dash_core_components/dash_core_components.js.map"
).format(__version__),
"namespace": "dash",
"dynamic": True,
},
{
"relative_package_path": "dcc/{}-shared.js".format(_this_module),
"external_url": (
"https://unpkg.com/dash-core-components@{}"
"/dash_core_components/dash_core_components-shared.js"
).format(__version__),
"namespace": "dash",
},
{
"relative_package_path": "dcc/{}-shared.js.map".format(_this_module),
"external_url": (
"https://unpkg.com/dash-core-components@{}"
"/dash_core_components/dash_core_components-shared.js.map"
).format(__version__),
"namespace": "dash",
"dynamic": True,
},
]
)
for _component in __all__:
setattr(locals()[_component], "_js_dist", _js_dist)

View File

@ -0,0 +1,53 @@
from .Checklist import Checklist
from .Clipboard import Clipboard
from .ConfirmDialog import ConfirmDialog
from .ConfirmDialogProvider import ConfirmDialogProvider
from .DatePickerRange import DatePickerRange
from .DatePickerSingle import DatePickerSingle
from .Download import Download
from .Dropdown import Dropdown
from .Geolocation import Geolocation
from .Graph import Graph
from .Input import Input
from .Interval import Interval
from .Link import Link
from .Loading import Loading
from .Location import Location
from .Markdown import Markdown
from .RadioItems import RadioItems
from .RangeSlider import RangeSlider
from .Slider import Slider
from .Store import Store
from .Tab import Tab
from .Tabs import Tabs
from .Textarea import Textarea
from .Tooltip import Tooltip
from .Upload import Upload
__all__ = [
"Checklist",
"Clipboard",
"ConfirmDialog",
"ConfirmDialogProvider",
"DatePickerRange",
"DatePickerSingle",
"Download",
"Dropdown",
"Geolocation",
"Graph",
"Input",
"Interval",
"Link",
"Loading",
"Location",
"Markdown",
"RadioItems",
"RangeSlider",
"Slider",
"Store",
"Tab",
"Tabs",
"Textarea",
"Tooltip",
"Upload",
]

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,8 @@
/** @license React v16.13.1
* react-is.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,5 @@
/*!
Copyright (c) 2018 Jed Watson.
Licensed under the MIT License (MIT), see
http://jedwatson.github.io/react-select
*/

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,13 @@
/*!
* Determine if an object is a Buffer
*
* @author Feross Aboukhadijeh <https://feross.org>
* @license MIT
*/
/*!
* repeat-string <https://github.com/jonschlinkert/repeat-string>
*
* Copyright (c) 2014-2015, Jon Schlinkert.
* Licensed under the MIT License.
*/

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,11 @@
/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
/**
* @license React
* react-is.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,14 @@
/*!
Copyright (c) 2018 Jed Watson.
Licensed under the MIT License (MIT), see
http://jedwatson.github.io/classnames
*/
/** @license React v16.13.1
* react-is.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,25 @@
/*!
* Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com
* License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
*/
/*!
* The buffer module from node.js, for the browser.
*
* @author Feross Aboukhadijeh <feross@feross.org> <http://feross.org>
* @license MIT
*/
/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */
//! authors : Tim Wood, Iskren Chernev, Moment.js contributors
//! license : MIT
//! moment.js
//! moment.js locale configuration
//! momentjs.com
//! version : 2.30.1

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,106 @@
import io
import ntpath
import base64
# region Utils for Download component
def send_file(path, filename=None, type=None):
"""
Convert a file into the format expected by the Download component.
:param path: path to the file to be sent
:param filename: name of the file, if not provided the original filename is used
:param type: type of the file (optional, passed to Blob in the javascript layer)
:return: dict of file content (base64 encoded) and meta data used by the Download component
"""
# If filename is not set, read it from the path.
if filename is None:
filename = ntpath.basename(path)
# Read the file contents and send it.
with open(path, "rb") as f:
return send_bytes(f.read(), filename, type)
def send_bytes(src, filename, type=None, **kwargs):
"""
Convert data written to BytesIO into the format expected by the Download component.
:param src: array of bytes or a writer that can write to BytesIO
:param filename: the name of the file
:param type: type of the file (optional, passed to Blob in the javascript layer)
:return: dict of data frame content (base64 encoded) and meta data used by the Download component
"""
content = src if isinstance(src, bytes) else _io_to_str(io.BytesIO(), src, **kwargs)
return dict(
content=base64.b64encode(content).decode(),
filename=filename,
type=type,
base64=True,
)
def send_string(src, filename, type=None, **kwargs):
"""
Convert data written to StringIO into the format expected by the Download component.
:param src: a string or a writer that can write to StringIO
:param filename: the name of the file
:param type: type of the file (optional, passed to Blob in the javascript layer)
:return: dict of data frame content (NOT base64 encoded) and meta data used by the Download component
"""
content = src if isinstance(src, str) else _io_to_str(io.StringIO(), src, **kwargs)
return dict(content=content, filename=filename, type=type, base64=False)
def _io_to_str(data_io, writer, **kwargs):
# Some pandas writers try to close the IO, we do not want that.
data_io_close = data_io.close
data_io.close = lambda: None
# Write data content.
writer(data_io, **kwargs)
data_value = data_io.getvalue()
data_io_close()
return data_value
def send_data_frame(writer, filename, type=None, **kwargs):
"""
Convert data frame into the format expected by the Download component.
:param writer: a data frame writer
:param filename: the name of the file
:param type: type of the file (optional, passed to Blob in the javascript layer)
:return: dict of data frame content (base64 encoded) and meta data used by the Download component
Examples
--------
>>> df = pd.DataFrame({'a': [1, 2, 3, 4], 'b': [2, 1, 5, 6], 'c': ['x', 'x', 'y', 'y']})
...
>>> send_data_frame(df.to_csv, "mydf.csv") # download as csv
>>> send_data_frame(df.to_json, "mydf.json") # download as json
>>> send_data_frame(df.to_excel, "mydf.xls", index=False) # download as excel
>>> send_data_frame(df.to_pickle, "mydf.pkl") # download as pickle
"""
name = writer.__name__
# Check if the provided writer is known.
if name not in _data_frame_senders.keys():
raise ValueError(
"The provided writer ({}) is not supported, "
"try calling send_string or send_bytes directly.".format(name)
)
# Send data frame using the appropriate send function.
return _data_frame_senders[name](writer, filename, type, **kwargs)
_data_frame_senders = {
"to_csv": send_string,
"to_json": send_string,
"to_html": send_string,
"to_excel": send_bytes,
"to_feather": send_bytes,
"to_parquet": send_bytes,
"to_msgpack": send_bytes,
"to_stata": send_bytes,
"to_pickle": send_bytes,
}
# endregion

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,106 @@
{
"name": "dash-core-components",
"version": "3.2.0",
"description": "Core component suite for Dash",
"repository": {
"type": "git",
"url": "git://github.com/plotly/dash.git"
},
"bugs": {
"url": "https://github.com/plotly/dash/issues"
},
"homepage": "https://github.com/plotly/dash",
"main": "dash_core_components/dash_core_components.js",
"scripts": {
"private::format.black": "black dash_core_components_base/ tests/ setup.py",
"private::format.eslint": "eslint src --fix",
"private::format.prettier": "prettier --config .prettierrc --write src/**/*.js",
"private::lint.black": "black --check dash_core_components_base/ tests/ setup.py",
"private::lint.eslint": "eslint src",
"private::lint.flake8": "flake8 --exclude=dash_core_components,node_modules,venv",
"private::lint.prettier": "prettier --config .prettierrc src/**/*.js --list-different",
"prepublishOnly": "rimraf lib && babel src --out-dir lib --copy-files --config-file ./.lib.babelrc && rimraf --glob lib/jl/ lib/*.jl",
"test": "run-s -c lint test:intg test:pyimport",
"test:intg": "pytest --nopercyfinalize --headless tests/integration ",
"test:pyimport": "python -m unittest tests/test_dash_import.py",
"build:js": "webpack --mode production",
"build:backends": "dash-generate-components ./src/components dash_core_components -p package-info.json && cp dash_core_components_base/** dash_core_components/ && dash-generate-components ./src/components dash_core_components -p package-info.json -k RangeSlider,Slider,Dropdown,RadioItems,Checklist,DatePickerSingle,DatePickerRange,Input,Link --r-prefix 'dcc' --r-suggests 'dash,dashHtmlComponents,jsonlite,plotly' --jl-prefix 'dcc' && black dash_core_components",
"build": "run-s prepublishOnly build:js build:backends",
"postbuild": "es-check es2015 dash_core_components/*.js",
"build:watch": "watch 'npm run build' src",
"format": "run-s private::format.*",
"lint": "run-s private::lint.*"
},
"author": "Chris Parmer <chris@plotly.com>",
"maintainer": "Alex Johnson <alex@plotly.com>",
"license": "MIT",
"dependencies": {
"@fortawesome/fontawesome-svg-core": "1.2.36",
"@fortawesome/free-regular-svg-icons": "^5.15.4",
"@fortawesome/free-solid-svg-icons": "^5.15.4",
"@fortawesome/react-fontawesome": "^0.1.17",
"base64-js": "^1.5.1",
"color": "^4.2.3",
"d3-format": "^1.4.5",
"fast-isnumeric": "^1.1.4",
"file-saver": "^2.0.5",
"highlight.js": "^11.8.0",
"mathjax": "^3.2.2",
"moment": "^2.29.4",
"node-polyfill-webpack-plugin": "^2.0.1",
"prop-types": "^15.8.1",
"ramda": "^0.30.1",
"rc-slider": "^9.7.5",
"react-addons-shallow-compare": "^15.6.3",
"react-dates": "^21.8.0",
"react-docgen": "^5.4.3",
"react-dropzone": "^4.1.2",
"react-fast-compare": "^3.2.2",
"react-markdown": "^4.3.1",
"react-select-fast-filter-options": "^0.2.3",
"react-virtualized-select": "^3.1.3",
"remark-math": "^3.0.1",
"uniqid": "^5.4.0"
},
"devDependencies": {
"@babel/cli": "^7.28.0",
"@babel/core": "^7.28.0",
"@babel/eslint-parser": "^7.28.0",
"@babel/plugin-syntax-dynamic-import": "^7.8.3",
"@babel/preset-env": "^7.28.0",
"@babel/preset-react": "^7.27.1",
"@plotly/dash-component-plugins": "^1.2.3",
"@plotly/webpack-dash-dynamic-import": "^1.3.0",
"babel-loader": "^9.2.1",
"copyfiles": "^2.4.1",
"css-loader": "^6.8.1",
"es-check": "^7.1.1",
"eslint": "^8.41.0",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-react": "^7.32.2",
"identity-obj-proxy": "^3.0.0",
"npm-run-all": "^4.1.5",
"prettier": "^2.8.8",
"react-jsx-parser": "1.21.0",
"rimraf": "^5.0.5",
"style-loader": "^3.3.3",
"styled-jsx": "^5.1.7",
"webpack": "^5.101.0",
"webpack-cli": "^5.1.4"
},
"optionalDependencies": {
"fsevents": "*"
},
"files": [
"/dash_core_components/*{.js,.map}",
"/lib/"
],
"peerDependencies": {
"react": "16 - 19",
"react-dom": "16 - 19"
},
"browserslist": [
"last 9 years and not dead"
]
}