Params
Allows users to create and manage various query parameters.
🔗 Explore Params: Use Cases
Function signature​
app.mosaic(
vg.params.crossfilter()
)
app.mosaic(
vg.params.union()
)
app.mosaic(
vg.params.intersect()
)
app.mosaic(
vg.params.single()
)
app.mosaic(
vg.params.value(val)
)
These are the kind of parameters that can be created using the vg.params() function:
- Single
- Union
- Intersect
- CrossFilter
- Value
Parameters​
| Parameter | Description |
|---|---|
| kind (ParamType) | Values are "single", "union", "intersect", "crossfilter", or "value". This determines the behavior of the parameter. |
| cross (bool) | Determines whether to allow cross-filtering when creating a Filter or CrossFilter parameter. |
| value (Sequence[Union[str, bool, int, float, Parameter]]) | A sequence of values (strings, booleans, integers, floats, or other Parameter instances) to define the ValueParameter or ValueDateParameter. If the value is a date or datetime, ValueDateParameter is created. |
| value (Union[dt.datetime, dt.date]) | A specific date or datetime value used for ValueDateParameter, converted into an ISO format string when serialized into a dictionary. |
| val (Union[str, int, float, bool, dt.datetime, dt.date, Parameter]) | A variable number of arguments representing the values of the value() function, which are used to create a ValueParameter or ValueDateParameter. |
| length (int) | Specifies the length of the random identifier generated for a parameter. Default is 10 characters. |