.Stat Suite documentation

Filters

Table of Content

General note: All content related to the filter area is localised. For more information, go to the general documentation about Languages.


Filter area

The left-hand side (right-hand in rtl mode) of the visualisation page shows a set of dimension filters that allow dynamically filtering the dimension values to be displayed in the preview table or chart, to be extracted through the download feature ‘Filtered data in tabular text (CSV)’ or to be applied in the auto-generated data query in ‘Developer API’ menu.

The current filter selections are displayed as a summary in the ‘Used filters’ panel, which is always the top-first panel in the filter area.

Other filter panels are created for each of the dimensions of the currently displayed dataflow based on data availability (see documentation), except if the dimension contains only one possible item, in which case the corresponding filter is hidden, and except for ‘Frequency’ and ‘Time Period’ dimensions, which are combined in a common ‘Frequency & Time Period’ filter (see the related documentation).

The order of the filter panels respects the order of the dimensions as defined in the underlying data structure definition (DSD), except the ‘Frequency & Time Period’ filter panel, which is displayed second after the ‘Used filters’ panel.

Next to each filter name is an indication of the number of currently selected items against the number of available items (selected/available).

Multi selection filters

If the user has made selection(s) in the previous search result page, if a default selection is applied from an SDMX annotation (see documentation), or if the URL contains dimension selections, then these selections are automatically pre-applied in the filters.

Any filter selection change will automatically trigger the update of the data view (table/chart/API query), and these changes will also be reflected in the ‘Used filters’ panel.

Whenever there is no filter item selection, then it is indicated in the filter title by “all”, e.g. "all/39". When all filter items are selected, the number of selected items is displayed instead "39/39".
Because making no selections and complete selections return the same data, the usage of “all” should help to clarify this effect, while there remains a visual distinction for the fact that a saved selection is static while the items concerned by no selection may evolve over time. Indeed, as a generic behavior, when no element of a filter is selected, then it acts as if all items were selected. However, if a corresponding query is saved (e.g. bookmarked page, saved API query or shared dynamic table/chart), then the results may defer later in case the available dimension items evolve.
Therefore, while a full selection would always correspond to 39 items, for no filter selection the number of actually considered dimension items might increase, e.g. 40, 41 etc.


Multi-selection filters

All filters are standardised multi-selection filters, except the ‘Frequency & Time Period’ filter, and the ‘Used filters’ panel. It means that the user can select multiple items per filter.

Multi selection filters

When a filter contains 8 items or more, it triggers a bulk selection option displayed on the right of the spotlight, allowing to select all the items of the current list at once, or any level of the list if it is hierarchical.
If the filter list is hierarchical, then the bulk selection menu becomes contextual and displays options to select any “entire hierarchy level” according to the number of levels in the hierarchy (e.g. entire hierarchy level 1, level 2, etc.).

Hierarchical contents

Keyboard selection options

Released in (January 21, 2021 Release .Stat Suite JS 7.0.0)

The keyboard’s Ctrl and Shift keys, as well as holding mouse click, can be used to ease multiple selections.

  • Using the Shift key:
    If you first press Shift and select an item of a list, then selecting another item while still holding Shift will result in selecting all intermediate items (between those 2 selections) of the list. The same principle will apply in de-selection mode. As long as the ctrl key is held, the data table is not updated.

  • Using the Ctrl key:
    If you first press Ctrl and select an item of a list, then selecting another item while still holding Ctrl will result in selecting this second item too. You can keep on selecting new items as long as Ctrl is held.
    As long as the ctrl key is held, the data table is not updated.
    Remark: The combination of ctrl and shift keys is not possible.

  • Holding mouse click:
    If you click on one item and hold the mouse button without releasing it, then moving the mouse cursor down/up to another item of the same list will select both items and all intermediate ones.
    As long as the mouse button is held, the data table is not updated.

Note that these keyboard selection options are not compatible with the web content accessibility support.


Frequency & time period filter

See here for details.


Data availability

The filters show by default only those items for which data exists anywhere in the Dataflow. There is only one exception to this rule for parent items without data (See Hierarchical contents for more information). In order to allow the filters taking into account the current data availability, the filters apply the Actual ContentConstraints related to the underlying Dataflow.

An additional filter for the ‘Data availability’ selection can be displayed by adding dataAvailability=on to the URL. This will apply the data availability information on the other filters, as is done by default. This URL parameter is added automatically by the DLM, when the DE is used for previewing data.

Hierarchical contents

With dataAvailability=off in the URL, the additional ‘Data availability’ filter is shown. This filter is switched off and data availability is not applied.

Hierarchical contents

When the user switches the filter check box, the URL automatically updates accordingly.


Hierarchical content

In case of a hierarchy in the dimension items, they are shown as ‘scope list’, which means that the filter will display at first only the root parents' list. A blue arrow next to an item indicates that this item is a parent of sub-item(s).

Hierarchical contents Hierarchical contents

By clicking on the arrow, which doesn’t require the parent to be selected first, the child items of that parent item will be displayed instead. Above the children list, the parent appears (with a blue background if previously selected, or without background if not selected) in a distinct zone separated by a thick light grey line, named ‘children breadcrumb’.

The same behaviour is applied if some of the child items have themselves child items. The ‘children breadcrumb’ is progressively extended with each new parent (which is clickable and has the tooltip “Back to this level”) while descending in the hierarchy. This allows the user going back to a previous parent at any level.

Hierarchical contents Hierarchical contents

If for a parent (at any level) there are no data available (according to the Actual ContentConstraint related to the Dataflow), then the parent item is not selectable (and marked in light grey). Still, the user can navigate to the children and back to the parent again.

Parents without data Children of parents without data
Hierarchical contents Hierarchical contents

Selected root items are displayed ordinarily in the ‘Used filters’ panel. Selected children items are displayed prefixed with ...> in the ‘Used filters’ panel and the details of the parent hierarchy are shown in a tooltip.

Hierarchical contents


The local search (spotlight filter) box appears only when the list of items exceeds a configurable number (e.g. more than 7 that represents the limit, in default layout, before a scrollbar option is introduced in the filter area). The local search dynamically reduces the returned number items when the user types some text in it.

Local search example

For hierarchical contents, if used from the root level, then it dynamically searches on all filter content at once, and displays the list of results in one single and flat list, regardless the position of the results in the hierarchy, with the information of the root(s) in light grey:

Local search example with hierarchy

But for hierarchical contents, if used from a sub-level, then it will ONLY act on the currently visible level.


Used filters panel

The ‘Used filters’ panel displays all currently selected items per dimension.

This panel provides an overview of the current selection and an easy mean to unselect individual dimension items or whole dimension selections:

  • one single item by clicking on the x next to the item label, or
  • all items for a given dimension by clicking on the x next to the dimension label, or finally
  • all selections by clicking on Clear all filters.

To ease the readibility of the used filters when 15 or more items are selected in a facet, the display of the individual selected items is replaced by a number being the number of selected items for the specific facet.

Used filters
Used filters