FileDashboardParameter
is a datatype for a dashboard parameter where suggestions are taken
from uploaded files.
Table: FileDashboardParameter
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
| Table last updated: Sep 25, 2024 | |||||
defaultMultiValues | [string] | Long-Term | The default value assigned to the multi-value parameter on dashboard load. This is a preview and still in development. | ||
defaultValueV2 | string | Long-Term | The default value assigned to the parameter on dashboard load. | ||
fileName | string | yes | Long-Term | The name of the file to use for look-ups. | |
id | string | yes | Long-Term | The unique identifier of the parameter. | |
isMultiParam | boolean | Long-Term | Whether the parameter supports having multiple values. This is a preview and still in development. | ||
invalidInputMessage | string | Long-Term | Message when parameter input is blocked. | ||
invalidInputPatterns | [string] | Long-Term | Regex patterns used to block parameter input. | ||
label | string | yes | Long-Term | The label or name displayed next to the input for the variable. | |
labelColumn | string | Long-Term | The column from where the label of suggestions are taken. | ||
order | integer | yes | A number that determines the order in which parameters are displayed on a dashboard. If null, the parameter is ordered after other parameters in alphanumerical order. | ||
valueColumn | string | yes | Long-Term | The column from where the value of suggestions are taken. | |
valueFilters | [FileParameterValueFilter] | yes | Long-Term | Fields and values, where an entry in a file must match one of the given values for each field. See FileParameterValueFilter. | |