2016-10-21 04:01:34 -05:00
+++
title = "Playlist"
keywords = ["grafana", "dashboard", "documentation", "playlist"]
2020-06-30 16:18:38 -05:00
aliases = ["/docs/grafana/latest/reference/playlist/"]
2016-10-21 04:01:34 -05:00
weight = 4
+++
2015-03-10 02:55:42 -05:00
2015-08-12 09:30:48 -05:00
# Playlist
2015-03-10 02:55:42 -05:00
2019-10-10 05:33:56 -05:00
A playlist is a list of dashboards that are displayed in a sequence. You might use a playlist to build situational awareness or to present your metrics to your team or visitors.
2015-08-11 12:43:36 -05:00
2019-10-10 04:44:18 -05:00
Grafana automatically scales dashboards to any resolution, which makes them perfect for big screens.
You can access the Playlist feature from Grafana's side menu, in the Dashboards submenu.
2015-03-10 02:55:42 -05:00
2019-10-10 05:33:56 -05:00
{{< docs-imagebox img = "/img/docs/v50/playlist.png" max-width = "25rem" > }}
2015-04-19 20:37:34 -05:00
2019-10-10 05:33:56 -05:00
## Create a playlist
2015-04-19 20:37:34 -05:00
2020-11-09 14:26:49 -06:00
You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards.
2015-04-19 20:37:34 -05:00
2019-10-10 04:44:18 -05:00
1. To access the Playlist feature, hover your cursor over Grafana's side menu.
1. Click **Playlists** .
1. Click **New playlist** .
1. In the **Name** text box, enter a name for your playlist.
1. In the **Interval** text box, enter a time interval.
2015-04-19 20:37:34 -05:00
2019-10-10 05:33:56 -05:00
The time interval is the amount of time for Grafana to stay on a particular dashboard before advancing to the next one on the playlist.
2020-11-09 14:26:49 -06:00
1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist** .
2019-10-10 04:44:18 -05:00
1. Click **Create** .
2015-04-19 20:37:34 -05:00
2019-10-10 04:44:18 -05:00
## Edit a playlist
2015-04-19 20:37:34 -05:00
2019-10-10 04:44:18 -05:00
You can edit playlists while creating them or after saving them.
2015-04-19 20:37:34 -05:00
2019-10-10 04:44:18 -05:00
1. To access the Playlist feature, hover your cursor over Grafana's side menu.
1. Click **Playlists** .
1. Click on the Playlist that you want to edit.
2015-04-19 20:37:34 -05:00
2019-10-10 04:44:18 -05:00
### Edit the Name of a playlist
2016-01-09 01:52:51 -06:00
2019-10-10 04:44:18 -05:00
1. Double-click within the **Name** text box.
2020-11-09 14:26:49 -06:00
1. Enter a name.
2019-10-10 04:44:18 -05:00
1. Click **Save** to save your changes.
2016-01-09 01:52:51 -06:00
2019-10-10 04:44:18 -05:00
### Edit the Interval of a playlist
2016-01-09 01:52:51 -06:00
2019-10-10 04:44:18 -05:00
1. Double-click within the **Interval** text box.
1. Enter a time interval.
1. Click **Save** to save your changes.
### Add a dashboard to a playlist
1. Next to the dashboard you want to add, click **Add to playlist** .
1. Click **Save** to save your changes.
### Search for a dashboard to add
2020-11-09 14:26:49 -06:00
1. Click the **Search dashboards by name** text box.
1. Search for the playlist by name or regular expression.
1. If needed, filter your results by starred status or tags.
2019-10-10 04:44:18 -05:00
By default, your starred dashboards will appear as options to add to the Playlist.
1. Click **Save** to save your changes.
### Rearrange dashboard order
1. Next to the dashboard you want to move, click the up or down arrow.
1. Click **Save** to save your changes.
2015-04-19 20:46:22 -05:00
2019-10-10 04:44:18 -05:00
### Remove a dashboard
2015-04-19 20:46:22 -05:00
2019-10-10 04:44:18 -05:00
1. Click **Remove[x]** to remove a dashboard from the playlist.
1. Click **Save** to save your changes.
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
### Delete a playlist
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
1. Click **Playlists** .
1. Next to the Playlist you want to delete, click **Remove[x]** .
## Save a playlist
2020-11-09 14:26:49 -06:00
You can save a playlist to add it to your **Playlists** page, where you can start it. Be sure that all the dashboards you want to appear in your playlist are added when creating or editing the playlist before saving it.
2019-10-10 04:44:18 -05:00
1. To access the Playlist feature, hover your cursor over Grafana's side menu.
1. Click **Playlists** .
1. Click on the playlist.
1. Edit the playlist.
* Ensure that your playlist has a **Name** , **Interval** , and at least one **Dashboard** added to it.
2020-11-09 14:26:49 -06:00
1. Click **Save** .
2019-10-10 04:44:18 -05:00
## Start a playlist
2020-11-09 14:26:49 -06:00
You can start a playlist in five different view modes, which determine how the menus and navigation bar are displayed on the dashboards.
2019-10-10 04:44:18 -05:00
By default, each dashboard is displayed for the amount of time entered in the Interval field, which can be set while creating or editing a playlist. Once a playlist is started, it can be controlled using the navbar at the top of your screen.
1. From the Dashboards submenu, click **Playlists** .
1. Next to the playlist you want to start, click **Start playlist** .
1. In the dropdown, select the mode you want the playlist to display in.
- **Normal mode:**
2020-11-09 14:26:49 -06:00
- The side menu remains visible.
2019-10-10 04:44:18 -05:00
- The navbar, row and panel controls appear at the top of the screen.
- **TV mode:**
2020-11-09 14:26:49 -06:00
- The side menu is hidden/removed.
2019-10-10 04:44:18 -05:00
- The navbar, row and panel controls appear at the top of the screen.
- Enabled automatically after one minute of user inactivity.
2020-11-09 14:26:49 -06:00
- You can enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL.
- You can disable it with any mouse movement or keyboard action.
- **TV mode (with auto fit panels):**
- The side menu is hidden/removed.
2019-10-10 04:44:18 -05:00
- The navbar, row and panel controls appear at the top of the screen.
- Dashboard panels automatically adjust to optimize space on screen.
2020-11-09 14:26:49 -06:00
- **Kiosk mode:**
- The side menu, navbar, row and panel controls are completely hidden/removed from view.
2019-10-10 04:44:18 -05:00
- You can enable it manually using the `d v` sequence shortcut after the playlist has started.
- You can disable it manually with the same shortcut.
2020-11-09 14:26:49 -06:00
- **Kiosk mode (with auto fit panels):**
- The side menu, navbar, row and panel controls are completely hidden/removed from view.
2019-10-10 04:44:18 -05:00
- Dashboard panels automatically adjust to optimize space on screen.
## Control a playlist
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
You can control a playlist in **Normal** or **TV** mode after it's started, using the navigation bar at the top of your screen.
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
| Button | Result |
| --- | --- |
| Next (double-right arrow) | Advances to the next dashboard. |
| Back (left arrow) | Returns to the previous dashboard. |
2020-05-01 03:02:28 -05:00
| Stop (square) | Ends the playlist, and exits to the current dashboard. |
2019-10-10 04:44:18 -05:00
| Cycle view mode (monitor icon) | Rotates the display of the dashboards in different view modes. |
| Time range | Displays data within a time range. It can be set to display the last 5 minutes up to 5 years ago, or a custom time range, using the down arrow. |
| Refresh (circle arrow) | Reloads the dashboard, to display the current data. It can be set to reload automatically every 5 seconds to 1 day, using the drop down arrow. |
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
> Shortcut: Press the Esc key to stop the playlist from your keyboard.
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
## Share a playlist in a view mode
2017-09-12 03:31:13 -05:00
2020-11-09 14:26:49 -06:00
You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination.
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
1. From the Dashboards submenu, click **Playlists** .
1. Next to the playlist you want to share, click **Start playlist** .
1. In the dropdown, right click the view mode you prefer.
2020-11-09 14:26:49 -06:00
1. Click **Copy Link Address** to copy the URL to your clipboard.
2017-09-12 03:31:13 -05:00
2019-10-10 04:44:18 -05:00
Example: The URL for the first playlist on the Grafana Play site in Kiosk mode will look like this:
2020-01-06 10:25:13 -06:00
[https://play.grafana.org/playlists/play/1?kiosk ](https://play.grafana.org/playlists/play/1?kiosk ).
2019-10-10 05:33:56 -05:00
1. Paste the URL to your destination.