[release-11.4.4] Docs: xy chart visualization refactor (#103631)
Docs: xy chart visualization refactor (#103558)
* Added config options heading and bumped other heading levels
* Restructured xy options section
* Fixed links
* Formatted xy chart options using tabs
* Finalized structure of xy chart options section
* Corrected and restructured tooltip options
* Made to do note
* Added to do note
* Replaced screenshots
* Replaced axis options with shared file
* moved transform section
* Moved non-config sections and fixed heading level
* Removed incorrect options from xy chart and commented out image in shared axis file
* Wording edits
* Updated axis options
* Fixed wording
* Added Value mappings and thresholds and other minor edits
* Fixed table
(cherry picked from commit 27e9422f24)
This commit is contained in:
Isabel Matwawana
GitHub
@@ -12,7 +12,7 @@ Options under the **Axis** section control how the x- and y-axes are rendered. S
|
||||
|
||||
| Option | Description |
|
||||
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| Time zone | Set the desired time zones to display along the x-axis. |
|
||||
| Time zone | Set the desired time zones to display along the x-axis. Choose from: **Auto**, **Left**, **Right**, and **Hidden**. |
|
||||
| [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. |
|
||||
|
||||
@@ -3,25 +3,25 @@ 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
|
||||
This file is used in the following visualizations: candlestick, xy chart
|
||||
---
|
||||
|
||||
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. |
|
||||
| Option | Description |
|
||||
| ---------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| [Placement](#placement) | Select the placement of the y-axis. Choose from: **Auto**, **Left**, **Right**, and **Hidden**. |
|
||||
| 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. Applies to the **Linear** or **Symlog** scale options. |
|
||||
| [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 -->
|
||||
|
||||
@@ -39,8 +39,10 @@ Select the placement of the y-axis. Choose from the following:
|
||||
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.
|
||||
- **Logarithmic** - Use a logarithmic scale. If you select this option, in the **Log base** list, choose a binary (base 2) or common (base 10) logarithmic scale.
|
||||
- **Symlog** - Use a symmetrical logarithmic scale. If you select this option, choose also:
|
||||
- **Log base** - Select a binary (base 2) or common (base 10) logarithmic scale.
|
||||
- **Linear threshold** - Set the threshold at which the scale changes from linear to logarithmic.
|
||||
|
||||
#### Soft min and soft max
|
||||
|
||||
@@ -50,4 +52,6 @@ Set a **Soft min** or **soft max** option for better control of y-axis limits. B
|
||||
|
||||
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).
|
||||
|
||||
|
||||
<!--
|
||||
|
||||
 -->
|
||||
|
||||
Reference in New Issue
Block a user