Highstock: Fixed #8212, improved API reference of dataLabel.y and add…

…ed API reference of pointValKey for ohlc series.

js/parts/OHLCSeries.js

@@ -95,6 +95,18 @@ seriesType('ohlc', 'column', {
         }
     },
 
+    /**
+     * Determines which one of `open`, `high`, `low`, `close` values should be
+     * represented as `point.y`, which is later used to set dataLabel position.
+     *
+     * @type       {String}
+     * @validvalue ["open", "high", "low", "close"]
+     * @product    highstock
+     * @sample     {highstock} stock/plotoptions/ohlc-pointvalkey/
+     *             Possible values
+     * @default    close
+     * @apioption  plotOptions.ohlc.pointValKey
+     */
 
     /**
      * Line color for up points.

js/parts/Series.js

@@ -1872,7 +1872,7 @@ H.Series = H.seriesType('line', null, { // base series options
 
 
         /**
-         * The x position offset of the label relative to the point.
+         * The x position offset of the label relative to the point in pixels.
          *
          * @type {Number}
          * @sample {highcharts}
@@ -1884,7 +1884,7 @@ H.Series = H.seriesType('line', null, { // base series options
 
 
         /**
-         * The y position offset of the label relative to the point.
+         * The y position offset of the label relative to the point in pixels.
          *
          * @type {Number}
          * @sample {highcharts}

samples/stock/plotoptions/ohlc-pointvalkey/demo.details

@@ -0,0 +1,6 @@
+---
+ name: Highcharts Stock Demo
+ authors:
+   - Torstein Hønsi
+ js_wrap: b
+...

samples/stock/plotoptions/ohlc-pointvalkey/demo.html

@@ -0,0 +1,4 @@
+<div id="container" style="height: 400px; min-width: 600px"></div>
+
+<script src="https://code.highcharts.com/stock/highstock.js"></script>
+<script src="https://code.highcharts.com/stock/modules/exporting.js"></script>

samples/stock/plotoptions/ohlc-pointvalkey/demo.js

@@ -0,0 +1,70 @@
+
+Highcharts.chart('container', {
+    chart: {
+        type: 'candlestick'
+    },
+
+    title: {
+        text: 'Possible values for pointValKey'
+    },
+
+    plotOptions: {
+        series: {
+            dataLabels: {
+                enabled: true,
+                borderRadius: 5,
+                backgroundColor: 'rgba(252, 255, 197, 0.7)',
+                borderWidth: 1,
+                borderColor: '#AAA',
+                format: '{point.series.name}'
+            },
+            grouping: false
+        }
+    },
+
+    xAxis: {
+        categories: ['on open', 'on high', 'on low', 'on close (default)']
+    },
+
+    series: [{
+        name: 'open',
+        pointValKey: 'open',
+        data: [{
+            x: 0,
+            high: 100,
+            low: 0,
+            open: 30,
+            close: 50
+        }]
+    }, {
+        name: 'high',
+        pointValKey: 'high',
+        data: [{
+            x: 1,
+            high: 100,
+            low: 0,
+            open: 30,
+            close: 50
+        }]
+    }, {
+        name: 'low',
+        pointValKey: 'low',
+        data: [{
+            x: 2,
+            high: 100,
+            low: 0,
+            open: 30,
+            close: 50
+        }]
+    }, {
+        name: 'close',
+        pointValKey: 'close', // default
+        data: [{
+            x: 3,
+            high: 100,
+            low: 0,
+            open: 30,
+            close: 50
+        }]
+    }]
+});