Skip to content
Snippets Groups Projects
Unverified Commit cf0a84de authored by metabase-bot[bot]'s avatar metabase-bot[bot] Committed by GitHub
Browse files

docs - formatting exports (#40921) (#40944)

parent 9d01c722
Branches
Tags
No related merge requests found
......@@ -91,6 +91,7 @@ Metabase's reference documentation.
- [Sharing answers](./questions/sharing/answers.md)
- [Alerts](./questions/sharing/alerts.md)
- [Public sharing](./questions/sharing/public-links.md)
- [Exporting data](./questions/sharing/exporting-results.md)
### Dashboards
......
......@@ -29,14 +29,57 @@ Let's say we want to email a dashboard. We'll click on the **Email it** option i
For emails, we can:
- **Add subscribers**. Add email addresses to register subscribers. On Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise), admins can limit email recipients to [approved domains for notifications](../configuring-metabase/email.md#approved-domains-for-notifications) and [configure which recipients Metabase suggests](../configuring-metabase/email.md#suggest-recipients-on-dashboard-subscriptions-and-alerts).
- **Determine frequency and timing**. Tell Metabase how often it should send the dashboard (daily, weekly, or monthly), and what time of day to send the dashboard.
- **Send email now** sends an email to all subscribers.
- **Skip updates without results**. If there are no results, we can tell Metabase to skip sending the email.
- **Attach results**. Tell Metabase if it should attach results to the email as a file, in addition to displaying the table in the email body. You can choose between CSV and XLSX file formats. The attached file will include up to 2000 rows by default. If you're self-hosting Metabase, you can adjust this row limit by setting the environment variable [MB_UNAGGREGATED_QUERY_ROW_LIMIT](../configuring-metabase/environment-variables.md#mb_unaggregated_query_row_limit).
### Add subscribers
Add email addresses to register subscribers. On Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise), admins can limit email recipients to [approved domains for notifications](../configuring-metabase/email.md#approved-domains-for-notifications) and [configure which recipients Metabase suggests](../configuring-metabase/email.md#suggest-recipients-on-dashboard-subscriptions-and-alerts).
### Determine frequency and timing
Tell Metabase how often it should send the dashboard:
- Hourly
- Daily
- Weekly
- Monthly
And what time of day to send the dashboard.
### Send email now
A button that sends an email to all subscribers each time you touch it.
### Don't send if there aren't results
If there are no results, you can tell Metabase to skip sending the email.
### Set filter values for when this gets sent
Here you can set filters to apply when Metabase sends the subscription.
### Attach results
Tell Metabase if it should attach results to the email as a file, in addition to displaying the table in the email body.
If you've added filters to your dashboard and set default values for those filters, Metabase will apply those default values to your subscriptions, filtering the results of all questions that are connected to those filters when the subscriptions are sent. To learn more, check out [dashboard filters](./filters.md).
#### File format
You can choose between the following file formats:
- .csv
- .xlsx
- .json
#### Use unformatted values in attachments
If you check this box, Metabase will drop any visualization settings applied to the questions' results (e.g., date formatting) and send only the raw, unformatted results.
#### Questions to attach
Here you can specify which questions Metabase should attach results for.
The attached files will include up to 2000 rows by default. If you're self-hosting Metabase, you can adjust this row limit by setting the environment variable [MB_UNAGGREGATED_QUERY_ROW_LIMIT](../configuring-metabase/environment-variables.md#mb_unaggregated_query_row_limit).
## Slack subscription options
For Slack subscriptions, you can set up a subscription for a channel (like #general), or for a single person via their Slack username.
......
......@@ -4,7 +4,7 @@ redirect_from:
- /docs/latest/administration-guide/19-formatting-settings
---
# Formatting defaults
# Formatting defaults
There are Metabase users around the world, each with different preferences for how dates, times, numbers, and currencies should be formatted and displayed. Metabase allows you to customize these formatting options at three different levels:
......@@ -38,3 +38,20 @@ Currency field formatting settings include all the same options as in the global
## Question-level formatting
Lastly, you can override all formatting settings in any specific saved question or dashboard card by clicking on the gear to open up the visualization options. To reset any overridden setting to the default, just click on the rotating arrow icon next to the setting's label. This will reset the setting to the field-level setting if there is one; otherwise it will be reset to the global default.
Formatting options vary depending on the type of visualization:
- [Combo chart](../questions/sharing/visualizations/combo-chart.md)
- [Detail](../questions/sharing/visualizations/detail.md)
- [Funnel](../questions/sharing/visualizations/funnel.md)
- [Gauge](../questions/sharing/visualizations/gauge.md)
- [Line, Bar, and area charts](../questions/sharing/visualizations/line-bar-and-area-charts.md)
- [Maps](../questions/sharing/visualizations/map.md)
- [Numbers](../questions/sharing/visualizations/numbers.md)
- [Pie or donut chart](../questions/sharing/visualizations/pie-or-donut-chart.md)
- [Pivot table](../questions/sharing/visualizations/pivot-table.md)
- [Progress bar](../questions/sharing/visualizations/progress-bar.md)
- [Scatter plot or bubble chart](../questions/sharing/visualizations/scatterplot-or-bubble-chart.md)
- [Tables](../questions/sharing/visualizations/table.md)
- [Trend](../questions/sharing/visualizations/trend.md)
- [Waterfall chart](../questions/sharing/visualizations/waterfall-chart.md)
\ No newline at end of file
docs/questions/images/export-dashboard-as-pdf.png

178 KiB

docs/questions/images/exporting-the-results-of-a-question.png

259 KiB

---
title: Exporting results
---
# Exporting results
You can export the results of a question or dashboard.
## Exporting results of a question
To export the results of a questions, click on the **Download** button in the lower right of a question.
![Exporting results of a question](../images/exporting-the-results-of-a-question.png)
You can export the results of a question as:
- .csv
- .json
- .xlsx
### Maximum number of rows you can download
You can download up to 1 million rows.
### Exporting unformatted results
You can export the unformatted results of a question by holding the `option` key on a Mac or the `Alt` key on PC when selecting the file format for your download.
Metabase will export the raw results of a question without applying any of the [formatting you applied](../../data-modeling/formatting.md) to the columns in the question. For example, if you formatted a floating point number to display only the first two decimal digits in the table results, exporting the unformatted results would include additional decimal digits (if any) found in the raw results.
## Exporting data via a public link
You can also create a [public link](../sharing/public-links.md) that people can use to download data in a specific format.
## Exporting question data via alerts
You can also export data by setting up an [alert](../sharing/alerts.md).
## Exporting results of a dashboard
You can export a dashboard as a PDF. Click on the three dot menu (**...**) and select **Export as PDF**.
![Exporting a dashboard as a PDF](../images/export-dashboard-as-pdf.png).
The PDF will only include screenshots of the charts as they are visible on the dashboard.
## Exporting results of a dashboard via dashboard subscriptions
You can use [dashboard subscriptions](../../dashboards/subscriptions.md) to regularly export data from all questions on a dashboard, and include those results as an attachment.
## Further reading
- [Alerts](../sharing/alerts.md)
- [Dashboard subscriptions](../../dashboards/subscriptions.md)
- [Tables](../sharing/visualizations/table.md)
......@@ -22,29 +22,126 @@ To format the display of any column in a table, click on the column heading and
The options you see will differ depending on the type of column you're viewing:
### Dates
## Text formatting options
- **Date style** gives you a bunch of different choices for how to display the date.
- **Abbreviate names of days and months**, when turned on, will turn things like `January` to `Jan`, and `Monday` to `Mon`.
- **Show the time** lets you decide whether or not to display the time, and if so, how. You can include hours and minutes, and additionally seconds and milliseconds.
### Title
### Numbers
You can rename the column.
- **Show a mini bar chart** will display a small horizontal bar next to each number in this column to show its size relative to the other values in the column.
- **Style** lets you choose to display the number as a plain number, a percent, in scientific notation, or as a currency.
- **Separator style** gives you various options for how commas and periods are used to separate the number.
- **Minimum number of decimal places** forces the number to be displayed with exactly this many decimal places.
- **Multiply by a number** multiplies each number in this column by whatever you type here. Just don't type an emoji here; it almost always causes a temporal vortex to manifest.
- **Add a prefix/suffix** lets you put a symbol, word, or whatever before or after each cell's value.
### Display as
### Currency
Currency columns have all the same options as numbers, plus the following:
You can display the text as is, or you can display the text as a link. If you select link, you can also change the text displayed, and use parameters for both the link text and the link's URL.
- **Unit of Currency** lets you change the unit of currency from whatever the system default is.
- **Currency label style** allows you to switch between displaying the currency label as a symbol, a code like (USD), or the full name of the currency.
- **Where to display the unit of currency** lets you toggle between showing the currency label in the column heading or in every cell in the column.
For example, you could create a dynamic URL using a parameter from another column in the results:
### Conditional table formatting
```html
{% raw %}
https://www.example.com/{{category}}
{% endraw %}
```
In the above example, Metabase would take the value for the `category` column for that row (in this case `widget`), and insert it into the URL:
```
https://www.example.com/widget
```
## Date formatting options
Date formatting options include the same options as [Text formatting](#text-formatting-options), as well as:
### Date style
Styles include:
- April 1, 2024
- 1 April 2024
- Monday, April 1, 2024
- 4/1/2024
- 1/4/2024
- 2024/4/1
### Abbreviate days and months
If you select a date style that includes words, this toggle will abbreviate them. For example:
- Unabbreviated: Monday, April 1, 2024
- Abbreviated: Mon, Apr 1, 2024
### Show the time
This option determines whether Metabase includes the time along with the date.
- Off
- HH:MM
- HH:MM:SS
- HH:MM:SS:MS
### Time style
You can choose either 12-hour clock style, or 24-hour clock style.
- 5:24 PM (12-hour clock)
- 17:24 (24-hour clock)
## Number formatting options
### Show a mini bar chart
This option displays a small horizontal bar next to each number in this column to show its size relative to the other values in the column.
### Style
Number styles include:
- Number
- Percent
- Scientific
- Currency
### Separator style
Gives you various options for how commas and periods are used to separate the number.
- 100,000.00
- 100 000,00
- 100.000,00
- 100000.00
- 100'000.00
### Minimum number of decimal places
Forces the number to be displayed with exactly this many decimal places.
### Multiply by a number
Multiplies each number in this column by whatever you type here. Just don't type an emoji here; there is a nontrivial chance that it will manifest a temporal vortex.
### Add a prefix/suffix
Lets you put a symbol, word, or whatever before or after each cell's value.
## Currency formatting options
Currency columns have all the same options as [numbers](#number-formatting-options), plus the following:
### Unit of Currency
Lets you change the unit of currency from whatever the system default is.
### Currency label style
Allows you to switch between displaying the currency label as:
- a symbol (like $)
- a code (like USD)
- the full name of the currency (like "US dollars")
### Where to display the unit of currency
Lets you toggle between showing the currency label in the column heading or in every cell in the column.
## Conditional table formatting
Sometimes it's helpful to highlight certain rows or columns in your tables when they meet a specific condition. You can set up conditional formatting rules by going to the visualization settings while looking at any table, then clicking on the **Conditional Formatting** tab.
......
......@@ -59,3 +59,7 @@ Get results via email or Slack, either on a schedule, or only when something int
### [Public sharing](./sharing/public-links.md)
Create links or embeds for the good people of the internet.
### [Exporting](./sharing/exporting-results.md)
The different ways you can export the results of questions and dashboards.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment