mirror of https://github.com/grafana/grafana
[release-11.4.4] Docs: candlestick visualization refactor (#103421)
Docs: candlestick visualization refactor (#103310)
* Added config options heading and bumped other heading levels
* Reordered headings and added missing ones
* Nested candlestick options under heading
* Added graph styles and axis content
* Added candlestick options to table
* Refactored and edited candlestick options section
* Replaced shared file with manual tooltip section
* Added missing intro sentences to candlestick options section
* Added a graph styles shared file
* Replaced body text with graph styles shared file in candlestick and time series files
* Added content from time series file to shared axis options file
* replaced shared file in candlestick file with axis content
* Updated option descriptions in axis options shared file
* Updated axis options section of candlestick
* Fixed typos
* Ran prettier
* Replaced some screenshots with higher res, up to date versions
* Wording edits
* Added contributor notes and a missing command
* Fixed typo
* Fixed typo
* Ran prettier
* Removed note from axis options all file
* Renamed axis options file
* Renamed shared file adn updated link in time series page
* Added axix options file and renamed another one, updated links in other files
* Ran prettier
(cherry picked from commit 31ecb5d0b5)
pull/103527/head
Isabel Matwawana
3 months ago
committed by
GitHub
parent
52c2214a01
commit
ac5703b7fc
@ -0,0 +1,54 @@ |
||||
--- |
||||
title: Axis options |
||||
comments: | |
||||
There are three axis options shared files, axis-options-1.md and axis-options-2.md to cover the most common combinations of options. |
||||
Using shared files ensures that content remains consistent across visualizations that share the same options and users don't have to figure out which options apply to a specific visualization when reading that content. |
||||
This file is used in the following visualizations: time series. |
||||
--- |
||||
|
||||
Options under the **Axis** section control how the x- and y-axes are rendered. Some options don't take effect until you click outside of the field option box you're editing. You can also press `Enter`. |
||||
|
||||
<!-- prettier-ignore-start --> |
||||
|
||||
| Option | Description | |
||||
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------ | |
||||
| Time zone | Set the desired time zones to display along the x-axis. | |
||||
| [Placement](#placement) | Select the placement of the y-axis. | |
||||
| Label | Set a y-axis text label. If you have more than one y-axis, then you can assign different labels using an override. | |
||||
| Width | Set a fixed width for the axis. By default, Grafana dynamically calculates the width of an axis. | |
||||
| Show grid lines | Set the axis grid line visibility. Choose from: **Auto**, **On**, and **Off**. | |
||||
| Color | Set the color of the axis. Choose from:<ul><li>**Text** - Uses panel text color.</li><li>**Series** - Uses the colors of the series.</li></ul> | |
||||
| Show border | Set the axis border visibility. | |
||||
| [Scale](#scale) | Set the y-axis values scale. Choose from: **Linear**, **Logarithmic**, and **Symlog**. | |
||||
| Centered zero | Set the y-axis so it's centered on zero. | |
||||
| [Soft min](#soft-min-and-soft-max) | Set a soft min to better control the y-axis limits. | |
||||
| [Soft max](#soft-min-and-soft-max) | Set a soft max to better control the y-axis limits. | |
||||
|
||||
<!-- prettier-ignore-end --> |
||||
|
||||
#### Placement |
||||
|
||||
Select the placement of the y-axis. Choose from the following: |
||||
|
||||
- **Auto** - Automatically assigns the y-axis to the series. When there are two or more series with different units, Grafana assigns the left axis to the first unit and the right axis to the units that follow. |
||||
- **Left** - Display all y-axes on the left side. |
||||
- **Right** - Display all y-axes on the right side. |
||||
- **Hidden** - Hide all axes. To selectively hide axes, [Add a field override](ref:add-a-field-override) that targets specific fields. |
||||
|
||||
#### Scale |
||||
|
||||
Set the y-axis values scale. Choose from: |
||||
|
||||
- **Linear** - Divides the scale into equal parts. |
||||
- **Logarithmic** - Use a logarithmic scale. When you select this option, a list appears for you to choose a binary (base 2) or common (base 10) logarithmic scale. |
||||
- **Symlog** - Use a symmetrical logarithmic scale. When you select this option, a list appears for you to choose a binary (base 2) or common (base 10) logarithmic scale. The linear threshold option allows you to set the threshold at which the scale changes from linear to logarithmic. |
||||
|
||||
#### Soft min and soft max |
||||
|
||||
Set a **Soft min** or **soft max** option for better control of y-axis limits. By default, Grafana sets the range for the y-axis automatically based on the dataset. |
||||
|
||||
**Soft min** and **soft max** settings can prevent small variations in the data from being magnified when it's mostly flat. In contrast, hard min and max values help prevent obscuring useful detail in the data by clipping intermittent spikes past a specific point. |
||||
|
||||
To define hard limits of the y-axis, set standard min/max options. For more information, refer to [Configure standard options](ref:configure-standard-options). |
||||
|
||||
 |
||||
@ -0,0 +1,53 @@ |
||||
--- |
||||
title: Axis options |
||||
comments: | |
||||
There are three axis options shared files, axis-options-1.md and axis-options-2.md to cover the most common combinations of options. |
||||
Using shared files ensures that content remains consistent across visualizations that share the same options and users don't have to figure out which options apply to a specific visualization when reading that content. |
||||
This file is used in the following visualizations: candlestick |
||||
--- |
||||
|
||||
Options under the **Axis** section control how the x- and y-axes are rendered. Some options don't take effect until you click outside of the field option box you're editing. You can also press `Enter`. |
||||
|
||||
<!-- prettier-ignore-start --> |
||||
|
||||
| Option | Description | |
||||
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| [Placement](#placement) | Select the placement of the y-axis. | |
||||
| Label | Set a y-axis text label. If you have more than one y-axis, then you can assign different labels using an override. | |
||||
| Width | Set a fixed width for the axis. By default, Grafana dynamically calculates the width of an axis. | |
||||
| Show grid lines | Set the axis grid line visibility. Choose from: **Auto**, **On**, and **Off**. | |
||||
| Color | Set the color of the axis. Choose from:<ul><li>**Text** - Uses panel text color.</li><li>**Series** - Uses the colors of the series.</li></ul> | |
||||
| Show border | Set the axis border visibility. | |
||||
| [Scale](#scale) | Set the y-axis values scale. Choose from: **Linear**, **Logarithmic**, and **Symlog**. | |
||||
| Centered zero | Set the y-axis so it's centered on zero. | |
||||
| [Soft min](#soft-min-and-soft-max) | Set a soft min to better control the y-axis limits. | |
||||
| [Soft max](#soft-min-and-soft-max) | Set a soft max to better control the y-axis limits. | |
||||
|
||||
<!-- prettier-ignore-end --> |
||||
|
||||
#### Placement |
||||
|
||||
Select the placement of the y-axis. Choose from the following: |
||||
|
||||
- **Auto** - Automatically assigns the y-axis to the series. When there are two or more series with different units, Grafana assigns the left axis to the first unit and the right axis to the units that follow. |
||||
- **Left** - Display all y-axes on the left side. |
||||
- **Right** - Display all y-axes on the right side. |
||||
- **Hidden** - Hide all axes. To selectively hide axes, [Add a field override](ref:add-a-field-override) that targets specific fields. |
||||
|
||||
#### Scale |
||||
|
||||
Set the y-axis values scale. Choose from: |
||||
|
||||
- **Linear** - Divides the scale into equal parts. |
||||
- **Logarithmic** - Use a logarithmic scale. When you select this option, a list appears for you to choose a binary (base 2) or common (base 10) logarithmic scale. |
||||
- **Symlog** - Use a symmetrical logarithmic scale. When you select this option, a list appears for you to choose a binary (base 2) or common (base 10) logarithmic scale. The linear threshold option allows you to set the threshold at which the scale changes from linear to logarithmic. |
||||
|
||||
#### Soft min and soft max |
||||
|
||||
Set a **Soft min** or **soft max** option for better control of y-axis limits. By default, Grafana sets the range for the y-axis automatically based on the dataset. |
||||
|
||||
**Soft min** and **soft max** settings can prevent small variations in the data from being magnified when it's mostly flat. In contrast, hard min and max values help prevent obscuring useful detail in the data by clipping intermittent spikes past a specific point. |
||||
|
||||
To define hard limits of the y-axis, set standard min/max options. For more information, refer to [Configure standard options](ref:configure-standard-options). |
||||
|
||||
 |
||||
@ -0,0 +1,133 @@ |
||||
--- |
||||
title: Graph styles options |
||||
comments: | |
||||
This file is used in the following visualizations: candlestick, time series. |
||||
--- |
||||
|
||||
<!-- prettier-start-ignore --> |
||||
|
||||
| Option | Description | |
||||
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| [Style](#style) | Choose whether to display your time-series data as **Lines**, **Bars**, or **Points**. | |
||||
| [Line interpolation](#line-interpolation) | Choose how the graph interpolates the series line. | |
||||
| Line width | Set the thickness of the series lines or the outline for bars using the **Line width** slider. | |
||||
| [Fill opacity](#fill-opacity) | Set the series area fill color using the **Fill opacity** slider. | |
||||
| [Gradient mode](#gradient-mode) | Choose a gradient mode to control the gradient fill, which is based on the series color. | |
||||
| [Line style](#line-style) | Choose a solid, dashed, or dotted line style. | |
||||
| [Connect null values](#connect-null-values) | Choose how null values, which are gaps in the data, appear on the graph. | |
||||
| [Disconnect values](#disconnect-values) | Choose whether to set a threshold above which values in the data should be disconnected. | |
||||
| [Show points](#show-points) | Set whether to show data points to lines or bars. | |
||||
| Point size | Set the size of the points, from 1 to 40 pixels in diameter. | |
||||
| [Stack series](#stack-series) | Set whether Grafana displays series on top of each other. | |
||||
| [Bar alignment](#bar-alignment) | Set the position of the bar relative to a data point. | |
||||
| Bar width factor | Set the width of the bar relative to minimum space between data points. A factor of 0.5 means that the bars take up half of the available space between data points. A factor of 1.0 means that the bars take up all available space. | |
||||
|
||||
<!-- prettier-end-ignore --> |
||||
|
||||
#### Style |
||||
|
||||
Choose whether to display your time-series data as **Lines**, **Bars**, or **Points**. You can use overrides to combine multiple styles in the same graph. Choose from the following: |
||||
|
||||
 |
||||
|
||||
#### Line interpolation |
||||
|
||||
Choose how the graph interpolates the series line: |
||||
|
||||
- **Linear** - Points are joined by straight lines. |
||||
- **Smooth** - Points are joined by curved lines that smooths transitions between points. |
||||
- **Step before** - The line is displayed as steps between points. Points are rendered at the end of the step. |
||||
- **Step after** - The line is displayed as steps between points. Points are rendered at the beginning of the step. |
||||
|
||||
#### Line width |
||||
|
||||
Set the thickness of the series lines or the outline for bars using the **Line width** slider. |
||||
|
||||
#### Fill opacity |
||||
|
||||
Set the series area fill color using the **Fill opacity** slider. |
||||
|
||||
 |
||||
|
||||
#### Gradient mode |
||||
|
||||
Choose a gradient mode to control the gradient fill, which is based on the series color. To change the color, use the standard color scheme field option. For more information, refer to [Color scheme](ref:color-scheme). |
||||
|
||||
- **None** - No gradient fill. This is the default setting. |
||||
- **Opacity** - An opacity gradient where the opacity of the fill increases as y-axis values increase. |
||||
- **Hue** - A subtle gradient that's based on the hue of the series color. |
||||
- **Scheme** - A color gradient defined by your [Color scheme](ref:color-scheme). This setting is used for the fill area and line. For more information about scheme, refer to [Scheme gradient mode](#scheme-gradient-mode). |
||||
|
||||
Gradient appearance is influenced by the **Fill opacity** setting. The following image shows the **Fill opacity** set to 50. |
||||
|
||||
 |
||||
|
||||
##### Scheme gradient mode |
||||
|
||||
The **Gradient mode** option located under the **Graph styles** section has a mode called **Scheme**. When you enable **Scheme**, the line or bar receives a gradient color defined from the selected **Color scheme**. |
||||
|
||||
###### From thresholds |
||||
|
||||
If the **Color scheme** is set to **From thresholds (by value)** and **Gradient mode** is set to **Scheme**, then the line or bar color changes as it crosses the defined thresholds. |
||||
|
||||
{{< figure src="/static/img/docs/time-series-panel/gradient_mode_scheme_thresholds_line.png" max-width="1200px" alt="Colors scheme: From thresholds" >}} |
||||
|
||||
###### Gradient color schemes |
||||
|
||||
The following image shows a line chart with the **Green-Yellow-Red (by value)** color scheme option selected. |
||||
|
||||
{{< figure src="/static/img/docs/time-series-panel/gradient_mode_scheme_line.png" max-width="1200px" alt="Color scheme: Green-Yellow-Red" >}} |
||||
|
||||
#### Line style |
||||
|
||||
Choose a solid, dashed, or dotted line style: |
||||
|
||||
- **Solid** - Display a solid line. This is the default setting. |
||||
- **Dash** - Display a dashed line. When you choose this option, a list appears for you to select the length and gap (length, gap) for the line dashes. Dash spacing is 10, 10 by default. |
||||
- **Dots** - Display dotted lines. When you choose this option, a list appears for you to select the gap (length = 0, gap) for the dot spacing. Dot spacing is 0, 10 by default. |
||||
|
||||
 |
||||
|
||||
{{< docs/shared lookup="visualizations/connect-null-values.md" source="grafana" version="<GRAFANA_VERSION>" leveloffset="+1" >}} |
||||
|
||||
{{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="<GRAFANA_VERSION>" leveloffset="+1" >}} |
||||
|
||||
To change the color, use the standard [color scheme](ref:color-scheme) field option. |
||||
|
||||
#### Show points |
||||
|
||||
Set whether to show data points as lines or bars. Choose from the following: |
||||
|
||||
- **Auto** - Grafana determines a point's visibility based on the density of the data. If the density is low, then points appear. |
||||
- **Always** - Show the points regardless of how dense the dataset is. |
||||
- **Never** - Don't show points. |
||||
|
||||
#### Stack series |
||||
|
||||
Set whether Grafana stacks or displays series on top of each other. Be cautious when using stacking because it can create misleading graphs. To read more about why stacking might not be the best approach, refer to [The issue with stacking](https://www.data-to-viz.com/caveat/stacking.html). Choose from the following: |
||||
|
||||
- **Off** - Turns off series stacking. When **Off**, all series share the same space in the visualization. |
||||
- **Normal** - Stacks series on top of each other. |
||||
- **100%** - Stack by percentage where all series add up to 100%. |
||||
|
||||
##### Stack series in groups |
||||
|
||||
The stacking group option is only available as an override. For more information about creating an override, refer to [Configure field overrides](ref:configure-field-overrides). |
||||
|
||||
1. Edit the panel and click **Overrides**. |
||||
1. Create a field override for the **Stack series** option. |
||||
1. In stacking mode, click **Normal**. |
||||
1. Name the stacking group in which you want the series to appear. |
||||
|
||||
The stacking group name option is only available when you create an override. |
||||
|
||||
#### Bar alignment |
||||
|
||||
Set the position of the bar relative to a data point. In the examples below, **Show points** is set to **Always** which makes it easier to see the difference this setting makes. The points don't change, but the bars change in relationship to the points. Choose from the following: |
||||
|
||||
- **Before**  |
||||
The bar is drawn before the point. The point is placed on the trailing corner of the bar. |
||||
- **Center**  |
||||
The bar is drawn around the point. The point is placed in the center of the bar. This is the default. |
||||
- **After**  |
||||
The bar is drawn after the point. The point is placed on the leading corner of the bar. |
||||
Loading…
Reference in new issue