How to use actions to handle data

Export data

To download data from your dashboard, you can use the export_data action. For example, you can attach the action to a button as follows. When a user clicks the "Export data" button, all data on the page is downloaded.

Export data action

app.pyapp.yamlResult

import vizro.actions as va
import vizro.models as vm
import vizro.plotly.express as px
from vizro import Vizro

df = px.data.iris()

page = vm.Page(
    title="Action triggered by a button",
    components=[
        vm.Graph(figure=px.histogram(df, x="sepal_length")),
        vm.Button(text="Export data", actions=va.export_data()),
    ],
    controls=[vm.Filter(column="species")],
)

dashboard = vm.Dashboard(pages=[page])
Vizro().build(dashboard).run()

Run and edit this code in Py.Cafe

# Still requires a .py to add data to the data manager and parse YAML configuration
# See yaml_version example
pages:
  - components:
      - type: graph
        figure:
          _target_: histogram
          x: sepal_length
      - type: button
        text: Export data
        actions:
          - type: export_data
  - controls:
      - type: filter
        column: species
    layout:
      type: flex
    title: Action triggered by a button

When you click the "Export data" button, the data for all graphs, tables and figures on the page is downloaded. In this example, this will produce a csv file for the graph's source data px.data.iris().

Exported data includes the effect of controls such as filters and dynamic data parameters. Modifications from the chart, table or figure itself are not included (for example, AG Grid filters, graph zoom and data transformations performed inside a custom chart functions).