Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Docs/dashboard events additions (#84254)

Robert Kosarad403f5d22006
diff --git a/docs/dashboards/introduction.md b/docs/dashboards/introduction.md
index 567fafe72eb..7473b05afbc 100644
--- a/docs/dashboards/introduction.md
+++ b/docs/dashboards/introduction.md
@@ -254,6 +254,16 @@ To edit a card's:
- **Underlying query**: click on the card's title while _not_ in dashboard editing mode. If the card displays multiple questions, pick the question you want to edit from the dropdown.
- **Visualization settings**, see [changing a card's visualization settings](#changing-a-cards-visualization-settings).
+## Showing events on dashboard cards
+
+Time series cards can show [events](../exploration-and-organization/events-and-timelines.md) saved to the question.
+
+**To toggle events for a card**, click on the card's **three-dot menu** (**...**) and select **Events**.
+
+**To toggle events for all time series cards on the current tab**, click on the **three-dot menu** (**...**) in the dashboard header and select **Events**.
+
+Toggling events on a dashboard only applies to your session. To change what everyone sees, edit the question's events and save the question. See [Events on dashboards](../exploration-and-organization/events-and-timelines.md#events-on-dashboards).
+
## Changing a card's visualization settings
You can change a card's visualization settings (to add a goal line, for example). Changing a card's visualization settings will only affect how the question appears on that dashboard card; these changes won't affect the original question's visualization settings.
diff --git a/docs/embedding/public-links.md b/docs/embedding/public-links.md
index 1efec96d222..b8e6d8f98fb 100644
--- a/docs/embedding/public-links.md
+++ b/docs/embedding/public-links.md
@@ -37,6 +37,8 @@ To share a dashboard via a public link, admins can click on the **Share** button
![Sharing a dashboard](./images/dashboard-sharing.png)
+Public dashboards show the [events](../exploration-and-organization/events-and-timelines.md#events-in-public-links-and-embeds) each question was saved with to anyone who has the link, even people who can't access the timeline's collection.
+
To embed a dashboard, see [guest embedding](./guest-embedding.md).
## Create a public link for a document
diff --git a/docs/exploration-and-organization/events-and-timelines.md b/docs/exploration-and-organization/events-and-timelines.md
index 63c54909d33..da5ddf62699 100644
--- a/docs/exploration-and-organization/events-and-timelines.md
+++ b/docs/exploration-and-organization/events-and-timelines.md
@@ -16,9 +16,7 @@ Events and timelines are a way to capture that chronological knowledge and make
An event is basically a date + a title + a description + an icon. You can add events to Metabase to show important milestones, launches, or anything else, right alongside your data.
-Metabase displays events on time series charts when viewing an individual question, and on dashboards for questions that were saved with events turned on.
-
-Dashboards shared via a public link, static embed, interactive embedding, or the embedded analytics SDK show the events each question was saved with. Public and statically embedded questions, SDK questions, and dashboard subscriptions don't show events. Public links and static embeds show a question's saved events to anyone viewing the dashboard, even people who can't access the timeline's collection. Only people who can view a timeline can add a question that uses it to a shared dashboard. In interactive embedding and the SDK, people only see events from timelines they have access to.
+Metabase displays events on time series charts when viewing an individual question, and on [dashboards](#events-on-dashboards) for questions that were saved with events turned on.
## Timelines
@@ -55,17 +53,32 @@ You can't add a timeline with events to the [Library](../data-modeling/semantic-
## Adding events when viewing a question
-If your question is a time series, you can click on the **Calendar** in the bottom right of the question, and Metabase will open the timeline sidebar. Metabase will list any timelines and their events that fall in the range of your time series. You can:
+If your question is a time series, you can click on the **Calendar** in the bottom right of the question, and Metabase will open the timeline sidebar. Metabase will list any timelines and their events that fall in the range of your time series, including timelines from other collections. You can:
-- Toggle timeline visibility (including timelines from other collections)
+- Toggle timeline visibility.
- Add a new event (even if you haven't saved the question yet).
- Edit, move, or archive an event.
When you save a new question or change a question's event selection and save it, Metabase records which timelines and events are turned on, and shows those same events wherever the question appears, including on dashboards. Toggling events on a saved question counts as a change, so save the question to keep your selection.
+### Hide events on a question
+
+To hide events on a question:
+
+1. Click on the **calendar** icon in the bottom right.
+2. Uncheck the timeline or event.
+3. To keep the event hidden on reloads, save the question.
+
+To hide a timeline and its events everywhere, [archive the timeline](#archiving-timelines).
+
## Events on dashboards
-A time series chart on a dashboard shows the events its question was saved with. Questions saved with events turned off (or saved before Metabase started recording events) don't show any events on dashboards. Very small cards don't have room for events, so they won't show them even when a timeline is on, and their **three-dot menu** (**...**) leaves out the **Events** item.
+Line, bar, area, combo, scatter, and waterfall charts on a dashboard show the events their question was saved with. Questions saved with events turned off (or saved before Metabase started recording events) don't show any events on dashboards. Very small cards don't have room for events, so they won't show them even when a timeline is on, and their **three-dot menu** (**...**) leaves out the **Events** item.
+
+Some cards never show events, whatever their question was saved with:
+
+- Cards whose visualization you edited on the dashboard with the **pencil** icon, including cards that [combine multiple questions](../dashboards/multiple-series.md#combining-multiple-questions-on-one-dashboard-card).
+- Action buttons, as well as text, heading, link, and iframe cards.
To change which events a chart shows while viewing a dashboard, click on the **three-dot menu** (**...**) on the card and select **Events**. Metabase will open the same events sidebar you get on a question, listing every timeline you can view that has an event in the range of that chart, whatever collection the timeline lives in. You can:
@@ -79,22 +92,16 @@ These selections only last for your session; if you reload the dashboard or ente
Exporting a dashboard to PDF captures the page as you're viewing it, so the PDF includes whatever events are showing at the time, session toggles and all. Results downloaded as .csv or .xlsx contain data only, and the chart images in dashboard subscriptions don't show events.
-## Viewing events and timelines on a chart from a different collection
-
-If you're viewing a question with a time series chart from a _different_ collection, you can temporarily apply a timeline to the chart by clicking on the **calendar** icon in the bottom right of the question and selecting the timeline and events you want to display.
-
-If you save the question, Metabase keeps the timelines and events you turned on and shows them wherever the question appears.
+## Events in public links and embeds
-### To hide the timeline and its events on a chart
+_Dashboards_ shared via a [public link or embed](../embedding/public-links.md), a [guest embed](../embedding/guest-embedding.md), a [modular embed](../embedding/modular-embedding.md), or [full app embedding](../embedding/full-app-embedding.md) show the events each question was saved with. People viewing an embedded or public dashboard can't toggle, add, or edit events; the cards' **Events** menu items and the events sidebar are only available in Metabase itself.
-To temporarily hide the events from a chart:
-
-1. Click on the **calendar** icon in the bottom right.
-2. Uncheck the timeline or event.
+_Questions_ shared on their own through a public link, a guest embed, or a modular embed don't show events, and neither do dashboard subscriptions.
-Your selections reset on reload unless you save the question.
+Who sees which events depends on how the dashboard is shared:
-To keep events hidden on this question, save the question after unchecking them. To hide a timeline and its events everywhere, [archive the timeline](#archiving-timelines).
+- **Public links, public embeds, and guest embeds** show a question's saved events to anyone viewing the dashboard, even people who can't access the timeline's collection. Only people who can view a timeline can add a question that uses the timeline to a shared dashboard.
+- **Modular embeds with SSO and full app embedding** only show events from timelines the viewer has access to.
## Edit an event
diff --git a/docs/questions/introduction.md b/docs/questions/introduction.md
index 3540add3676..472652588b3 100644
--- a/docs/questions/introduction.md
+++ b/docs/questions/introduction.md
@@ -102,7 +102,7 @@ You can set up questions to run periodically and notify you if the results are i
## Viewing events on your chart
-If your results are a time series, you can display events along the x-axis. See [events and timelines](../exploration-and-organization/events-and-timelines.md).
+If your results are a time series, you can [display events along the x-axis](../exploration-and-organization/events-and-timelines.md).
## Deleting a question