Syntax for using parameters

You can define a filter by specifying an expression that represents the filtering function.

You have the following syntax format options:

  • Adding the value of the output parameter variable to the visual:

    You can define it by URL parameters, clicked values within dashboards, or single value/textbox pick lists.

    Some examples:
    • By fields: (<<field-name:dimension-column>>)
    • By discrete single values: (<<state:'AL'>>)
    • By discrete multiple values: (<<‘NC’, ‘KY’>>)
  • User-defined pick lists also emit an alias parameter:
  • When dashboard filters function in multi-select mode, you must also specify the include-exclude operators:
  • For date-range functions, the filter expression that uses the timestamp variable ts has the following pattern:
    [ts] between <<ts.start:"2013-08-03">> and <<ts.end:"2014-04-28">>
  • When the dashboard filter is multi-select, you must use different parameters:

    • The selected values are available through the <<>> expression.
    • When implementing the include or exclude operator in a multi-select filter, use the <<variable.exclude:default-value>> expression.
  • To customize the title of any visual, you can change its name to include a parameter. For a practical example, see Creating visuals with variable dimensions.