@@ -118,12 +118,14 @@ def callback(
118
118
the app layout. The second element is the value that the property
119
119
should be set to while the callback is running, and the third element
120
120
is the value the property should be set to when the callback completes.
121
+ This parameter only applies to background callbacks (`background=True`).
121
122
:param cancel:
122
123
A list of `Input` dependency objects that reference a property of a
123
124
component in the app's layout. When the value of this property changes
124
125
while a callback is running, the callback is canceled.
125
126
Note that the value of the property is not significant, any change in
126
127
value will result in the cancellation of the running job (if any).
128
+ This parameter only applies to background callbacks (`background=True`).
127
129
:param progress:
128
130
An `Output` dependency grouping that references properties of
129
131
components in the app's layout. When provided, the decorated function
@@ -132,21 +134,25 @@ def callback(
132
134
function should call in order to provide updates to the app on its
133
135
current progress. This function accepts a single argument, which
134
136
correspond to the grouping of properties specified in the provided
135
- `Output` dependency grouping
137
+ `Output` dependency grouping. This parameter only applies to background
138
+ callbacks (`background=True`).
136
139
:param progress_default:
137
140
A grouping of values that should be assigned to the components
138
141
specified by the `progress` argument when the callback is not in
139
142
progress. If `progress_default` is not provided, all the dependency
140
143
properties specified in `progress` will be set to `None` when the
141
- callback is not running.
144
+ callback is not running. This parameter only applies to background
145
+ callbacks (`background=True`).
142
146
:param cache_args_to_ignore:
143
147
Arguments to ignore when caching is enabled. If callback is configured
144
148
with keyword arguments (Input/State provided in a dict),
145
149
this should be a list of argument names as strings. Otherwise,
146
150
this should be a list of argument indices as integers.
151
+ This parameter only applies to background callbacks (`background=True`).
147
152
:param cache_ignore_triggered:
148
153
Whether to ignore which inputs triggered the callback when creating
149
- the cache.
154
+ the cache. This parameter only applies to background callbacks
155
+ (`background=True`).
150
156
:param interval:
151
157
Time to wait between the background callback update requests.
152
158
:param on_error:
0 commit comments