Programming · free software · the open webSubscribe via RSS

What Should a Dashboard’s Download Button Include?

From the earlier reference collection. Read the current software blog.

A useful download preserves the dashboard’s filters and gives the exported records clear fields, units, times, and source context.

Export the view readers selected

A download should reflect the filters, date range, and location choices visible in the dashboard. If the screen shows only one region for the past week but the file contains every region for a year, readers may reasonably assume the export is broken. State whether the file contains the current filtered view or the complete dataset, and provide the covered period in the interface or filename.

For example, someone selecting Site East and March should receive records for that site and period, with the selection represented in the exported data or file description. If the dashboard cannot export a particular filter, explain that before the download rather than silently ignoring it.

Include interpretable fields

Use descriptive column names and include units where they are not obvious. A field named “value” is difficult to interpret after it is separated from the dashboard. “Temperature_C” or a separate unit field gives the number a useful meaning. Include timestamps in a consistent, unambiguous format, and state the time zone or use a clearly specified standard representation.

Preserve identifiers that connect a row to a location, route, sensor, or other entity. If a value is missing, provide a status or missing-value convention rather than making the row disappear without explanation. Readers should be able to distinguish a measured zero from no observation.

Keep provenance with the file

A downloaded file often travels without the web page that created it. Include the source name, retrieval or publication time when available, and a link or other attribution information appropriate to the source. A short README or metadata sheet can explain field definitions, filters, and any transformations applied during export.

If the dashboard rounds values for display but exports more precise records, describe that difference. If it exports summaries rather than raw observations, label the aggregation and period. These details help someone avoid treating a daily average as an individual sensor reading.

Make the action predictable

Give the button a direct label such as “Download filtered data” and indicate the file format. After the export, confirm what was included, especially when the result is empty or very large. A thoughtful download preserves enough context for the file to remain useful when it is opened later, shared with a colleague, or analyzed in another tool.

Suggest a correction · All posts