Action functions

API reference for all built-in action functions.

vizro.actions

export_data

Exports visible data of target charts/components.

Parameters:

• targets (list[ModelID]) –

  List of target component ids to download data from. If none are given then download from all components on the page.

• file_format (Literal['csv', 'xlsx']) –

  Format of downloaded files. Defaults to csv.

filter_interaction

Filters targeted charts/components on page by clicking on data points or table cells of the source chart.

To set up filtering on specific columns of the target graph(s), include these columns in the 'custom_data' parameter of the source graph e.g. px.bar(..., custom_data=["species", "sepal_length"]). If the filter interaction source is a table e.g. vm.Table(..., actions=[filter_interaction]), then the table doesn't need to have a 'custom_data' parameter set up.

Parameters:

• targets (list[ModelID]) –

  Target component to be affected by filter. If none are given then target all valid components on the page.