Docs: Sync latest master docs with 7.5.x (#33156)
* Docs: Sync latest master docs with 7.5.x * remove some remaining next aliases and links * Docs: Removed v8 doc changes * fixed merge issue
This commit is contained in:
Torkel Ödegaard
@@ -21,7 +21,7 @@ Use these options to refine your visualization.
|
||||
|
||||
- **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**.
|
||||
- **Search -** Display dashboards by search query or tags. You must enter at least one value in **Query** or **Tags**. For the **Query** and **Tags** fields. Variable interpolation is supported, for example,`$my_var` or `${my_var}`.
|
||||
- **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.
|
||||
|
||||
|
||||
@@ -120,7 +120,7 @@ Options are identical for both Y-axes.
|
||||
- **Value -** The aggregation type to use for the values. The default is total (summing the values together).
|
||||
- **Histogram -** Converts the graph into a histogram. A histogram is a kind of bar chart that groups numbers into ranges, often called buckets or bins. Taller bars show that more data falls in that range.
|
||||
|
||||
For more information about histograms, refer to [Introduction to histograms and heatmaps]({{< relref "../../getting-started/intro-histograms.md" >}}).
|
||||
For more information about histograms, refer to [Introduction to histograms and heatmaps]({{< relref "../../basics/intro-histograms.md" >}}).
|
||||
- **Buckets -** The number of buckets to group the values by. If left empty, then Grafana tries to calculate a suitable number of buckets.
|
||||
- **X-Min -** Filters out values from the histogram that are under this minimum limit.
|
||||
- **X-Max -** Filters out values that are greater than this maximum limit.
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
+++
|
||||
title = "Heatmap"
|
||||
title = "Heatmap panel"
|
||||
description = "Heatmap visualization documentation"
|
||||
keywords = ["grafana", "heatmap", "panel", "documentation"]
|
||||
aliases =["/docs/grafana/latest/features/panels/heatmap/"]
|
||||
weight = 600
|
||||
+++
|
||||
|
||||
# Heatmap
|
||||
# Heatmap panel
|
||||
|
||||
The Heatmap panel visualization allows you to view histograms over time. For more information about histograms, refer to [Introduction to histograms and heatmaps]({{< relref "../../getting-started/intro-histograms.md" >}}).
|
||||
The Heatmap panel visualization allows you to view histograms over time. For more information about histograms, refer to [Introduction to histograms and heatmaps]({{< relref "../../basics/intro-histograms.md" >}}).
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
+++
|
||||
title = "Panel legend options"
|
||||
weight = 50
|
||||
+++
|
||||
|
||||
# Legend
|
||||
|
||||
Use the legend to adjust how a visualization displays series. This legend functionality only applies to a few panels now, but it will eventually be common to all visualizations.
|
||||
|
||||
This topic currently applies to the following visualizations:
|
||||
|
||||
- [Pie chart panel]({{< relref "pie-chart-panel.md">}})
|
||||
- [Time series panel]({{< relref "time-series/_index.md" >}})
|
||||
|
||||
## Toggle series
|
||||
|
||||
To toggle a series:
|
||||
Click on the series label in the legend to isolate the series in the visualization.
|
||||
All other series are hidden in the visualization. The data of the hidden series is still accessible.
|
||||
|
||||
Use Cmd/Ctrl+click on the series label to hide the isolated series and remove the toggle.
|
||||
|
||||
> **Note:** This option is persistent when you save the dashboard.
|
||||
|
||||
|
||||
|
||||
This creates a system override that hides the other series. You can view this override in the Overrides tab. If you delete the override, then it removes the toggle.
|
||||
|
||||
|
||||
|
||||
## Change series color
|
||||
|
||||
Click on the series icon (colored line beside the series label) in the legend to change selected series color.
|
||||
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
+++
|
||||
title = "Pie chart panel"
|
||||
keywords = ["grafana", "pie chart"]
|
||||
weight = 850
|
||||
+++
|
||||
|
||||
# Pie chart v2 panel
|
||||
|
||||
> **Note:** This documentation refers to a beta feature.
|
||||
|
||||
The pie chart displays reduced series, or values in a series, from one or more queries, as they relate to each other, in the form of slices of a pie. The arc length, area and central angle of a slice are all proportional to the slices value, as it relates to the sum of all values. This type of chart is best used when you want a quick comparison of a small set of values in an aesthetically pleasing form.
|
||||
|
||||
|
||||
|
||||
## Data and field options
|
||||
|
||||
Pie chart visualizations allow you to apply:
|
||||
|
||||
- [Data transformations]({{< relref "../transformations/_index.md" >}})
|
||||
- [Field options and overrides]({{< relref "../field-options/_index.md" >}})
|
||||
- [Thresholds]({{< relref "../thresholds.md" >}})
|
||||
|
||||
## Display options
|
||||
|
||||
Use the following options to refine your visualization:
|
||||
|
||||
### Show
|
||||
|
||||
Choose how much information to show.
|
||||
|
||||
- **Calculate -** Reduces each value to a single value per series.
|
||||
- **All values -** Displays every value from a single series.
|
||||
|
||||
### Calculation
|
||||
|
||||
Select a calculation to reduce each series when Calculate has been selected. For information about available calculations, refer to the [Calculation list]({{< relref "../calculations-list.md" >}}).
|
||||
|
||||
### Limit
|
||||
|
||||
When displaying every value from a single series, this limits the number of values displayed.
|
||||
|
||||
### Fields
|
||||
|
||||
Select which field or fields to display in the visualization. Each field name is available on the list, or you can select one of the following options:
|
||||
|
||||
- **Numeric fields -** All fields with numerical values.
|
||||
- **All fields -** All fields that are not removed by transformations.
|
||||
- **Time -** All fields with time values.
|
||||
|
||||
### Pie chart type
|
||||
|
||||
Select the pie chart display style.
|
||||
|
||||
#### Pie
|
||||
|
||||
|
||||
|
||||
#### Donut
|
||||
|
||||
|
||||
|
||||
### Labels
|
||||
|
||||
Select labels to display on the pie chart. You can select more than one.
|
||||
|
||||
- **Name -** The series or field name.
|
||||
- **Percent -** The percentage of the whole.
|
||||
- **Value -** The raw numerical value.
|
||||
|
||||
Labels are displayed in white over the body of the chart. You might need to select darker chart colors to make them more visible. Long names or numbers might be clipped.
|
||||
|
||||
The following example shows a pie chart with **Name** and **Percent** labels displayed.
|
||||
|
||||
|
||||
|
||||
{{< docs/shared "visualizations/legend-mode.md" >}}
|
||||
|
||||
### Legend values
|
||||
|
||||
Select values to display in the legend. You can select more than one.
|
||||
|
||||
**Percent -** The percentage of the whole.
|
||||
**Value -** The raw numerical value.
|
||||
@@ -42,9 +42,9 @@ If thresholds are set, then the field text is displayed in the appropriate thres
|
||||
|
||||
{{< docs-imagebox img="/img/docs/tables/color-text.png" max-width="500px" caption="Color text" class="docs-image--no-shadow" >}}
|
||||
|
||||
### Color background
|
||||
### Color background (gradient or solid)
|
||||
|
||||
If thresholds are set, then the field background is displayed in the appropriate threshold color.
|
||||
If thresholds are set, then the field background is displayed in the appropriate threshold color.
|
||||
|
||||
{{< docs-imagebox img="/img/docs/tables/color-background.png" max-width="500px" caption="Color background" class="docs-image--no-shadow" >}}
|
||||
|
||||
|
||||
@@ -41,39 +41,8 @@ When you hover your cursor over the graph, Grafana can display tooltips. Choose
|
||||
|
||||
> **Note:** Use an override to hide individual series from the tooltip.
|
||||
|
||||
### Legend mode
|
||||
|
||||
Use these settings to refine how the legend appears in your visualization.
|
||||
|
||||
- **List -** Displays the legend as a list. This is a default display mode of the legend.
|
||||
- **Table -** Displays the legend as a table.
|
||||
- **Hidden -** Hides the legend.
|
||||
|
||||
### Legend placement
|
||||
|
||||
Choose where to display the legend.
|
||||
|
||||
- **Bottom -** Below the graph.
|
||||
- **Right -** To the right of the graph.
|
||||
{{< docs/shared "visualizations/legend-mode.md" >}}
|
||||
|
||||
### Legend calculations
|
||||
|
||||
Choose which of the [standard calculations]({{< relref "../../calculations-list.md">}}) to show in the legend. You can have more than one.
|
||||
|
||||
## Legend options
|
||||
|
||||
The Time series legend has additional features.
|
||||
|
||||
### Toggle series
|
||||
|
||||
Click on the series label in the legend to isolate the series in the visualization. All other series are hidden in the visualization. The data of the hidden series is still accessible.
|
||||
|
||||
Cmd/Ctrl+click on the series label to hide the clicked series and remove the toggle.
|
||||
|
||||
> **Note:** This option is persistent when you save the dashboard.
|
||||
|
||||
This creates a system override that hides the other series. You can view this override in the Overrides tab. If you delete the override, then it removes the toggle.
|
||||
|
||||
### Change series color
|
||||
|
||||
Click on the series icon (colored line beside the series label) in the legend to change selected series color.
|
||||
|
||||
Reference in New Issue
Block a user