|
@@ -8,24 +8,25 @@ page_keywords: grafana, dashlist, panel, documentation
|
|
|
|
|
|
|
|
## Overview
|
|
## Overview
|
|
|
|
|
|
|
|
-The dashboard list panel allows you to show a list of links to other dashboards. The list can be based on a search query or dashboard tag query. You can also configure it to show your starred
|
|
|
|
|
-dashboards.
|
|
|
|
|
|
|
+The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashbaords, a search query and/or dashboard tags.
|
|
|
|
|
|
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_panels.png">
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_panels.png">
|
|
|
|
|
|
|
|
|
|
+> On each dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
|
|
|
|
|
|
|
|
## Mode: Starred Dashboards
|
|
## Mode: Starred Dashboards
|
|
|
|
|
|
|
|
-The `starred` dashboard selection will display starred dashboards in alphabetical order, up to the number selected in the `Limit Number to` field. As new starred dashboards are added, the Dashlist Panel will automatically update.
|
|
|
|
|
|
|
+The `starred` dashboard selection displays starred dashboards, up to the number specified in the `Limit Number to` field, in alphabetical order. On dashboard load, the dashlist panel will re-query the favorites to appear in dashboard list panel, always providing the most up to date results.
|
|
|
|
|
|
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_config_starred.png">
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_config_starred.png">
|
|
|
|
|
|
|
|
|
|
|
|
|
## Mode: Search Dashboards
|
|
## Mode: Search Dashboards
|
|
|
|
|
|
|
|
-Dashboard lists may be configured by either a string search query or tag. On each dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
|
|
|
|
|
|
|
+The panel may be configured to search by either string query or tag(s). On dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
|
|
|
|
|
+
|
|
|
|
|
+To configure dashboard list in this manner, select `search` from the Mode select box. When selected, the Search Options section will appear.
|
|
|
|
|
|
|
|
-To configure dashboard list in this manner, select `search` from the Mode select box. When properly selected, the Search Options section will appear.
|
|
|
|
|
|
|
|
|
|
Name | Description
|
|
Name | Description
|
|
|
------------ | -------------
|
|
------------ | -------------
|
|
@@ -37,11 +38,11 @@ Limit number to | Specify the maximum number of dashboards
|
|
|
|
|
|
|
|
### Search by string
|
|
### Search by string
|
|
|
|
|
|
|
|
-To search by a string, enter a search query in the `Search Options: Query:` field. Queries are non-case sensitive, and partial values are accepted. On each dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results of the search string.
|
|
|
|
|
|
|
+To search by a string, enter a search query in the `Search Options: Query` field. Queries are case-insensitive, and partial values are accepted.
|
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_config_string.png">
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_config_string.png">
|
|
|
|
|
|
|
|
### Search by tag
|
|
### Search by tag
|
|
|
-To search by a string, enter a search query in the `Search Options: Query:` field. Queries are non-case sensitive, and partial values are accepted.
|
|
|
|
|
|
|
+To search by one or more tags, enter your selection in the `Search Options: Tags:` field. Note that existing tags will not appear as you type, and *are* case sensitive. To see a list of existing tags, you can always return to the dashboard, open the Dashboard Picker at the top and click `tags` link in the search bar.
|
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_config_tags.png">
|
|
<img class="no-shadow" src="/img/v2/dashboard_list_config_tags.png">
|
|
|
|
|
|
|
|
> When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.
|
|
> When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.
|