Syntax for Referencing Parameters
Use the syntax provided to reference parameters from a workbook visualization's properties, SQL expression, tooltips, or calculations.
To reference a parameter use:
@parameter("parameter name")('default value')
This table contains expression syntax examples:
Parameter Expression | Description |
---|---|
@parameter("Supplier")('Brembo') | References the Supplier parameter. The parameter value is 'Brembo' unless the Supplier parameter is passed into the workbook via data actions or URL parameters. |
@parameter("StartDate")(DATE'2021-10-08') | References a parameter named StartDate with a default date of October 8, 2021. |
@parameter("CurrentTime")(TIME'18:00:00') | References a parameter named CurrentTime with a default time of 18:00:00. |
@parameter("CurrentDateTime")(TIMESTAMP'2023-02-28T18:00:00') | References a parameter named CurrentDateTime with a default date of February 28, 2023 and a default time of 18:00:00. |
@parameter("NumOccurrences")(5) | References a parameter named NumOccurrences with a default of 5. |
@parameter("SelectedColumn")("A - Sample Sales"."Offices"."D2 Department"') | References a parameter named SelectedColumn, and defaults to "A - Sample Sales"."Offices"."D2 Department". |
@parameter("Supplier", style="delimited", separator="/")('Brembo','Bosch') | References a parameter named Supplier, and the value defaults to "Brembo/Bosch" when used. |
@parameter("Supplier", style="individual")('Brembo','Bosch') | References a parameter named
Supplier, and is used by data actions to separate
parameters:
&myParam=Brembo&myParam=Bosch |
@parameter("Supplier", type="alias")('Brembo','Bosch') | References a parameter named Supplier and uses any configured alias values, if they exist. Alias uses values if alias isn't configured. |
@parameter("Supplier", type="value")('Brembo','Bosch') | References a parameter named Supplier and uses any configured values, regardless of whether an alias is configured. |