From 6883626834126fd916466bd7b21f6ea19ff66d56 Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Mon, 11 May 2020 12:12:15 -0700 Subject: [PATCH] Docs: Add dashboard list (#24452) * Create _index.md * Create dashboard-list-panel.md * Update dashboard-list-panel.md --- .../visualizations/dashboard-list-panel.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/sources/panels/visualizations/dashboard-list-panel.md diff --git a/docs/sources/panels/visualizations/dashboard-list-panel.md b/docs/sources/panels/visualizations/dashboard-list-panel.md new file mode 100644 index 00000000000..21cfd896914 --- /dev/null +++ b/docs/sources/panels/visualizations/dashboard-list-panel.md @@ -0,0 +1,41 @@ ++++ +title = "Dashboard list panel" +keywords = ["grafana", "dashboard list", "documentation", "panel", "dashlist"] +type = "docs" +aliases = ["/docs/grafana/latest/reference/dashlist/", "/docs/grafana/latest/features/panels/dashlist/"] +[menu.docs] +name = "Dashboard list" +parent = "visualizations" +weight = 800 +draft = "true" ++++ + +# Dashboard list panel + +The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, recently viewed dashboards, a search query, and dashboard tags. + +{{< docs-imagebox img="/img/docs/v45/dashboard-list-panels.png" max-width="850px">}} + +On each dashboard load, this panel queries the dashboard list, always providing the most up-to-date results. + +## Options + +Use these options to refine your visualization. + +### Options + +- **Starred -** Display starred dashboards in alphabetical order. +- **Recently viewed -** Display recently viewed dashboards in alphabetical order. +- **Search -** Display dashboards by search query or tags. Requires you to enter at least one value in **Query** or **Tags**. +- **Show headings -** The chosen list selection (Starred, Recently viewed, Search) is shown as a heading. +- **Max items -** Sets the maximum number of items to list per section. For example, if you left this at the default value of 10 and displayed Starred and Recently viewed dashboards, then the panel would display up to 20 total dashboards, ten in each section. + +### Search + +These options only apply if the **Search** option is selected. + +- **Query -** Enter the query you want to search by. Queries are case-insensitive, and partial values are accepted. +- **Folder -** Select the dashboard folders that you want to display. +- **Tags -** Here is where you enter your tags you want to search by. Note that existing tags will not appear as you type, and they *are* case sensitive. + +> **Note:** When multiple tags and strings appear, the dashboard list displays those matching _all_ conditions.