Docs: New documentation for the Grafana 8.3 Candlestick panel (#42491)

* Initial scaffolding * intro sentence * Option scaffolding * More complete candlestick documentation * Add candlestick to visualization list * Clarifying the opening sentence. * Prettier fix for Candlestick * Update docs/sources/visualizations/candlestick.md Co-authored-by: Leon Sorokin <leeoniya@gmail.com> * Update docs/sources/visualizations/candlestick.md Co-authored-by: Leon Sorokin <leeoniya@gmail.com> * Updated to clarify hollow candlestick behaviour * Prettier run manually * Update docs/sources/visualizations/candlestick.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/visualizations/candlestick.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/visualizations/candlestick.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Update docs/sources/visualizations/candlestick.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Leon Sorokin <leeoniya@gmail.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
4 years ago · 7b1aee5220
parent d993b12415
commit 7b1aee5220
2 changed files with 52 additions and 0 deletions
--- a/docs/sources/visualizations/_index.md
+++ b/docs/sources/visualizations/_index.md
@ -18,6 +18,7 @@ Grafana offers a variety of visualizations to support different use cases. This
  - [Histogram]({{< relref "./histogram.md" >}}) calculates and shows value distribution in a bar chart.
  - [Heatmap]({{< relref "./heatmap.md" >}}).
  - [Pie chart]({{< relref "./pie-chart-panel.md" >}}).
+  - [Candlestick]({{< relref "./candlestick.md" >}}).
 - Stats & numbers
  - [Stat]({{< relref "./stat-panel.md" >}}) for big stats and optional sparkline.
  - [Gauge]({{< relref "./gauge-panel.md" >}}) is a normal radial gauge.
--- a/docs/sources/visualizations/candlestick.md
+++ b/docs/sources/visualizations/candlestick.md
@ -0,0 +1,51 @@
+++
+title = "Candlestick"
+description = "Candlestick visualization documentation"
+keywords = ["grafana", "Candlestick", "OHLC", "panel", "documentation"]
+aliases = ["/docs/grafana/latest/features/panels/candlestick/", "/docs/grafana/latest/panels/visualizations/candlestick/"]
+weight = 600
+++
+
+# Candlestick
+
+The Candlestick panel allows you to visualize data that includes a number of consistent dimensions focused on price movement. The Candlestick panel includes an Open-High-Low-Close (OHLC) mode, as well as support for additional dimensions based on time series data.
+
+{{< figure src="/static/img/docs/candlestick-panel/candlestick-panel-8-3.png" max-width="1200px" caption="Candlestick panel" >}}
+
+The Candlestick panel builds upon the foundation of the [time series]({{< relref "./time-series/_index.md" >}}) panel and includes many common configuration settings.
+
+## Mode
+
+The mode options allow you to toggle which dimensions are used for the visualization.
+
+- **Candles** limits the panel dimensions to the open, high, low, and close dimensions used by candlestick visualizations.
+- **Volume** limits the panel dimension to the volume dimension.
+- **Both** is the default behavior for the candlestick panel. It includes both candlestick and volume visualizations.
+
+## Candle style
+
+- **Candles** is the default display style and creates candle-style visualizations between the open and close dimensions.
+- **OHLC Bars** displays the four core dimensions open, high, low, and close values.
+
+## Color strategy
+
+- **Since Open** is the default behavior. This mode will utilize the _Up_ color (below) if the intra-period price movement is positive. In other words, if the value on close is greater or equal to the value on open, the _Up_ color is used.
+- **Since Prior Close** is an alternative display method based where the color of the candle is based on the inter-period price movement or change in value. In other words, if the value on open is greater than the previous value on close, the _Up_ color is used. If the value on open is lower than the previous value on close, the _Down_ color is used. _This option also triggers the hollow candlestick visualization mode_. Hollow candlesticks indicate that the intra-period movement is positive (value is higher on close than on open), filled candlesticks indicate the intra-period change is negative (value is lower on close than on open). To learn more, see the [explanation of the differences](https://thetradingbible.com/how-to-read-hollow-candlesticks).
+
+## Up & Down Colors
+
+The **Up color** and **Down color** options select which colors are used when the price movement is up or down. Please note that the _Color strategy_ above will determine if intra-period or inter-period price movement is used to select the candle or OHLC bar color.
+
+## Open, High, Low, Close
+
+The candlestick panel will attempt to map fields to the appropriate dimension. The **Open**, **High**, **Low**, and **Close** options allow you to map your data to these dimensions if the panel is unable to do so.
+
+- **Open** corresponds to the starting value of the given period.
+- **High** corresponds to the highest value of the given period.
+- **Low** corresponds to the lowest value of the given period.
+- **Close** corresponds to the final (end) value of the given period.
+- **Volume** corresponds to the sample count in the given period. (e.g. number of trades)
+
+## Additional fields
+
+The candlestick panel is based on the time series panel. It can visualization additional data dimensions beyond open, high, low, close, and volume The **Include** and **Ignore** options allow the panel to visualize other included data such as simple moving averages, Bollinger bands and more, using the same styles and configurations available in the [time series]({{< relref "./time-series/_index.md" >}}) panel.