mirror of https://github.com/grafana/grafana
Docs: Initial docs for State timeline visualization (#35046)
* Docs: Initial docs for State timeline visualization * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/panels/visualizations/state-timeline.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Changed format for options from table to headings * Updated what's new * restore naming to Visualization options * Update docs/sources/whatsnew/whats-new-in-v8-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/whatsnew/whats-new-in-v8-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>pull/34727/merge
parent
d92a1f29ac
commit
ac9cbbc02b
@ -0,0 +1,60 @@ |
||||
+++ |
||||
title = "State timeline" |
||||
description = "Stat timeline visualization" |
||||
keywords = ["grafana", "docs", "state timeline", "panel"] |
||||
weight = 900 |
||||
+++ |
||||
|
||||
# State timeline visualization |
||||
|
||||
The state timeline visualization shows discrete state changes over time. Each field or series is rendered as its unique horizontal band. State regions can either be rendered with or without values. This panel works well with string or boolean states but can also be used with time series. When used with time series, the thresholds are used to turn the numerical values into discrete state regions. |
||||
|
||||
{{< figure src="/static/img/docs/v8/state_timeline_strings.png" max-width="1025px" caption="state timeline with string states" >}} |
||||
|
||||
## Shared options |
||||
|
||||
The following shared options are available: |
||||
|
||||
- [Standard options]({{< relref "../standard-options.md" >}}) (Unit, min, max, decimals, color) |
||||
- [Thresholds]({{< relref "../thresholds.md" >}}) |
||||
- [Value mappings]({{< relref "../value-mappings.md" >}}) |
||||
|
||||
You can also use [field overrides]({{< relref "../field-overrides.md" >}}) to specify options per field or series. |
||||
|
||||
## Display options |
||||
|
||||
### Show values |
||||
|
||||
Controls whether values are rendered inside the state regions. Auto will render values if there is room. |
||||
|
||||
### Align values |
||||
|
||||
Controls value alignment inside state regions. |
||||
|
||||
### Row height |
||||
|
||||
Controls how much space between rows there are. 1 = no space = 0.5 = 50% space. |
||||
|
||||
### Line width |
||||
|
||||
Controls line width of state regions. |
||||
|
||||
### Fill opacity |
||||
|
||||
Controls the opacity of state regions. |
||||
|
||||
## Value mappings |
||||
|
||||
To assign colors to boolean or string values, use the [Value mappings](< {{ refref "../value-mappings.md"}} >). |
||||
|
||||
{{< figure src="/static/img/docs/v8/value_mappings_side_editor.png" max-width="300px" caption="Value mappings side editor" >}} |
||||
|
||||
## Time series data with thresholds |
||||
|
||||
The panel can be with time series data as well. In this case, the thresholds are used to turn the time series into discrete colored state regions. |
||||
|
||||
{{< figure src="/static/img/docs/v8/state_timeline_time_series.png" max-width="1025px" caption="state timeline with time series" >}} |
||||
|
||||
## Legend options |
||||
|
||||
When the legend option is enabled it can show either the value mappings or the threshold brackets. To show the value mappings in the legend, it's important that the `Color scheme` option under [Standard options]({{< relref "../standard-options.md" >}}) is set to `Single color` or `Classic palette`. To see the threshold brackets in the legend set the `Color scheme` to `From thresholds`. |
Loading…
Reference in new issue