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

docs - notes on events and timelines (#41102) (#41142)

parent 47719fae
No related branches found
No related tags found
No related merge requests found
......@@ -12,19 +12,26 @@ Events and timelines are a way to capture that chronological knowledge and make
## Events
![An event on a time series](./images/event-on-a-time-series.png)
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 will only display events on time series charts when viewing an individual question. Metabase won't display events on charts in dashboard cards.
## Timelines
You can group events into timelines, and associate those timelines with [collections](collections.md). For example, you may want to have a timeline that contains important email or sales dates, or an outages timeline that tracks downtime. You can move events between timelines, and move timelines from collection to collection.
Timelines are groups of events associated with a [collection](collections.md).
Collections can have timelines, and timelines can contain events. In practice what this means is that events you've added to a timeline will show up on time series questions stored in the same collection as that timeline. Events are invisible on dashboards
![Timeline sidebar](./images/timeline-sidebar.png)
## Event and timeline permissions
For example, you may want to have a timeline that contains important email or sales dates, or an outages timeline that tracks downtime. You can move events between timelines, and move timelines from collection to collection.
Anyone with [view access](../permissions/collections.md) to a collection can view the collection's events and timelines.
Collections can have timelines, and timelines can contain events. In practice what this means is that events you've added to a timeline will show up on time series questions stored in the same collection as that timeline.
- If you don't explicitly create a timeline yet, but you do create events, Metabase will automatically create a timeline for you (which acts as the default timeline for the collection).
- You can have multiple timelines for the same collection.
- Timelines associated with collection do not apply to that collection's sub-collections.
Anyone with curate access to a collection can add events and timelines to that collection.
### Adding events when viewing a collection
......@@ -34,14 +41,14 @@ When viewing a [collection](collections.md), you can view, add, or edit events b
Once you create an event, the event will show up in charts in the collection, provided:
- the date of the event falls within the chart's time range, and
- the timeline is visible (more on that [below](#adding-events-when-viewing-a-question))
- The date of the event falls within the chart's time range, and
- The timeline is visible (more on that [below](#adding-events-when-viewing-a-question))
You'll see an icon along the x-axis that plots the event. A vertical line will extend from the event to show when the data plotted on the chart intersects with the event.
![An event on a chart](./images/example-event.png)
### Adding events when viewing a question
## 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:
......@@ -49,24 +56,73 @@ If your question is a time series, you can click on the **Calendar** in the bott
- Add a new event (even if you haven't saved the question yet).
- Edit, move, or archive an event.
## Archiving and deleting
## 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.
These selections are temporary; if you reload the question, Metabase will drop the events from the chart.
### To hide the timeline and its events on a chart
To temporarily hide the events from a chart:
1. Click on the **calendar** icon in the bottom right.
2. Uncheck the timeline or event.
Your selections will reset on reload.
To permanently hide the timeline and its events, you'll need to [archive the timeline](#archiving-timelines). Alternatively, you could move the question to a different collection.
## Edit an event
### Archiving events
![Edit an event](./images/edit-an-event.png)
You can archive both events and timelines to get them out of the way, or unarchive them to resurrect them.
To edit an event:
To archive an event, click on the **...** next to the event and select **Archive event**.
1. Click the calendar icon in the top right of a collection.
2. Go to the timeline that contains the event, click on the event's three-dot menu (**...**).
3. Select:
- **Edit event**: its title, description, and icon.
- **Move event**: to another timeline.
- **Archive event**: to hide the event from charts.
## Archiving timelines
To archive a timeline:
1. Go to the timeline's collection and click on the **calendar** icon in the top right.
2. Select the timeline, then click on the three-dot menu (**...**). If the collection only has one timeline, click on the three-dot menu (**...**).
3. Select **Edit timeline details**.
4. Click on the red **Archive timeline and all events**.
### View archived events and timelines
> Archived events and timelines can only be viewed from the collection. The don't show up in the [main archive](../exploration-and-organization/history.md).
To view (and resurrect) archived timelines and events:
1. Click on the **Calendar** icon in the relevant collection.
2. Click on the three-dot menu **...** menu.
3. Select **View archived timelines**. Metabase will display archived events or timelines.
4. If you want to unarchive an item, click on the three-dot menu **...** next to the event or timeline and select the **Unarchive** option.
To permanently delete an archived event or timeline, click on the three-dot menu (**...**) and select **Delete**.
Then you can delete the archived events from the **View archived events** modal, or timelines from the **View archived timelines** modal.
## Event and timeline permissions
To view archived events, navigate to the relevant collection and click on the **Calendar** icon, then the **...** menu to **View archived events**.
Event and timeline permissions depend on your [collection permissions](../permissions/collections.md).
### Archiving timelines
- **View access**: you can view the collection's events and timelines. You can also temporarily apply timelines and events to time series in other collections.
- **Curate access**. Anyone with curate access to a collection can add events and timelines to that collection.
To archive a timeline, click on the **...** next to the timeline and select **Edit timeline details**. Metabase will pop up an edit modal; click on **Archive timeline and all events**.
### Make a timeline and its events available for everyone
To resurrect an archived timeline, click on the **Calendar** icon in the relevant collection, then click on the **...** menu. Next to the timeline you want to unarchive, click on the **...** menu and select **Unarchive timeline**.
If you want the event and timeline to be available to everyone, create the timeline in a collection that the [All Users group](../people-and-groups/managing.md#all-users) has access to, as by default everyone is in the All Users group.
To permanently delete an event or timeline, you must first archive the event or timeline. Then you can delete the archived events from the **View archived events** modal, or timelines from the **View archived timelines** modal.
Note that for questions outside of that collection, you can only temporarily apply those timelines to charts. The timelines won't appear automatically when you reload the chart.
## Disabling events for a question
## Further reading
If a collection includes timelines, those events will show up for any time series in that collection (provided the timeline and the question's date range overlap). If you want to disable the visibility of events by default for a particular question, you'll need to move that question to a collection that lacks timelines and events.
\ No newline at end of file
- [Keeping your Metabase organized](https://www.metabase.com/learn/administration/same-page)
......@@ -4,7 +4,7 @@ title: History
# History
For questions, dashboards, and models, Metabase keeps a version history for the previous fifteen versions of that item. You can view changes, and revert to previous versions.
For questions, dashboards, and models, Metabase keeps a version history for the previous fifteen versions of that item. You can view changes, and revert to previous versions.
You can also archive, unarchive, and permanently delete outdated items.
......@@ -52,6 +52,8 @@ Archiving a collection archives all of the collection's contents as well. You ca
2. Click the `...` beside the "Collections" header in the sidebar.
3. Click **View archive**.
To view archived [events and timelines](./events-and-timelines.md), go to relevant unarchived collection, click on the collection's **Calendar** icon, then the three-dot menu (**...**) and select the option to view the archived events or timelines.
## Unarchiving items
1. Open the main Metabase sidebar.
......
docs/exploration-and-organization/images/edit-an-event.png

148 KiB

docs/exploration-and-organization/images/event-on-a-time-series.png

137 KiB

docs/exploration-and-organization/images/timeline-sidebar.png

180 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment