1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
# 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__))
|
