Parameters

Using URL parameters in Viewer tiles

Viewer tiles support the use of URL parameters. More information can be found in the manual. You can enter these parameters in the Parameters field to control how the presentation is displayed.

Viewer tiles automatically inherit the user’s current selection. For example, a Viewer presentation that normally shows bars per province may look different when used in Mosaic or Stories. In that case, a selected area and a comparison area are often displayed instead.

If you want to override the user selection, you can add the parameter:

geolevel=province

This ignores the user selection and ensures that all provinces are shown.

Passing the user selection to URL parameters

The user’s selection can also be passed directly to URL parameters. This allows a Viewer tile to dynamically display the selected geographic level.

Instead of hard-coding a value such as geolevel=province, you can use a dynamic placeholder like {regionlevel}. The parameter will then look like this:

geolevel={regionlevel}

If province is selected, the system automatically generates geolevel=province in the background. This tells Mosaic or a Story that the Viewer tile should be displayed at the provincial level.

Available placeholders

The following placeholders can be used. They must always be placed between curly brackets { }:

• regionlevel – the selected base geographic level
• regioncode – the selected base geographic item
• referencelevel – the selected comparison geographic level
• referencecode – the selected comparison geographic item

Periods and cube dimensions

Periods and cube dimension items can also be passed as part of the selection. An additional license may be required for this functionality.

The following placeholders are available:

• dimensionlevel – the selected base dimension level
• dimensioncode – the selected base dimension item
• referencedimensionlevel – the selected comparison dimension level
• referencedimensioncode – the selected comparison dimension item
• periodlevel – the selected base period level
• period – the selected base period
• referenceperiodlevel – the selected comparison period level
• referenceperiod – the selected comparison period

Examples

geolevel={regionlevel}&favorite={regionlevel}_{regioncode}

Displays the presentation at the selected base geographic level and marks the selected area as a favorite.

geolevel={referencelevel}&geoitem={referencecode}

Applies the selected comparison area to the presentation.

geolevel={referencelevel}&geoitem={referencecode}&geosplit={regionlevel}

Applies the selected comparison area and splits the presentation by the selected base geographic level.