Parameters in Perspectives Story Pages

Definitions

Parameter Types Available in Stories

Add Parameters to a Story

Add Defaults to Parameters in Stories

Using Parameters

Parameters in the Global Filter Bar

Current Limitations of Parameters in Stories

Definitions

What is a Parameter?

Parameters allow you to change a variable, such as a number, date, string, or Boolean, in the definition of a query, which can change the values in the data powering the Story.

How is it different than a filter in the Global Filter Bar?

Filters allow you to see and use a subset of the existing rows of the data powering the Story. Parameters allow you to change the underlying query logic of a view based on the current value of the parameter

Parameter Types Available in Stories

Parameters are built into derived views, meaning any parameters configured in the data can be available in a Story!

Types of Parameters:

  • Text

  • Number

  • Date

  • Checkbox (Boolean)

For information on how to configure parameters in the Exploration Canvas, click here.

Add parameters to a Story

Parameters are available through the Global Filter Bar. This means that you must add a Global Filter Bar to your Story and connect it to the parameterized view you’ve created.

Once you’ve connected your parameterized view, you will automatically see the parameters made available in the filter bar.

addgfbparameter.gif

Note: Parameters do not currently have any visibility options, so any parameters added through the Global Filter Bar will be available for all users who have access to the Story.

Add defaults for parameters 

Each parameter comes with a default value at the derived view level, however, you can change that default to be Story page-specific – meaning you can tailor the parameters to the audience of the Story!

To change the default of any parameter:

  1. Navigate to the Story draft

  2. Set another value for a given parameter

  3. Update the Story

defaults.gif
These defaults can be changed when a user is interacting with the Story, but once they refresh, it will revert to the Story-specific default.

 

Using parameters

Parameters are single-select input, meaning, unlike filters, you cannot select multiple values to input.

For Text Parameters

text2.giftext.gif

You will need to enter the text value, these are case and space sensitive.

For Number Parameters

number.gif

You will need to enter the number value, you will not be able to entire any text in a number parameter.

For Date Parameters

date.gif
You will need to select either a specific date or a relative date or “today” or “yesterday”.

For Checkbox Parameters

checkbox2.gifcheckbox.gif

You will need to select whether to set it to True or False by unchecking or checking the box.

 

Parameters in the Global Filter Bar


Parameters will appear in the global filter from any data source added to it. Users will see the parameters from the data sources automatically added to the horizontal global filter in their Story draft. Users can change the parameter values and see visualizations, based on that data source, update.
parameters in the GFB.gif

Important Notes

  • Users cannot link parameters together like filters. Parameters will query the assets their source is tied to.
  • We plan to iterate on this so that users can see parameters for any of the data sources added to the global filter.

 

Current Limitations of Parameters in Stories

  • Currently, you cannot set the visibility of a parameter, like you can with filters in Stories, parameters will automatically appear in the Global Filter Bar.
  • You cannot reset a parameter in Edit or View mode, you must remove and re-add the Global Filter Bar and connect it to a parameterized view.

  • Visually, parameters look similar to filters.
  • Parameters require single select and exact match input. You cannot add multiple values, like you can with filters in Stories.
  • Exported data from table visualizations in Stories will not include any parameter variable.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.