highcharts-rails 5.0.12 → 5.0.13

data/app/assets/javascripts/highcharts/highcharts-3d.js

@@ -1,5 +1,5 @@
 /**
- * @license Highcharts JS v5.0.12 (2017-05-24)
+ * @license Highcharts JS v5.0.13 (2017-07-27)
  *
  * 3D features for Highcharts JS
  *
@@ -410,8 +410,11 @@
                 this.side.attr({
                     fill: color(fill).brighten(-0.1).get()
                 });
-
                 this.color = fill;
+
+                // for animation getter (#6776)
+                result.fill = fill;
+
                 return this;
             };
 
@@ -429,7 +432,7 @@
                 return this;
             };
 
-            result.attr = function(args, val) {
+            result.attr = function(args, val, complete, continueAnimation) {
 
                 // Resolve setting attributes by string name
                 if (typeof args === 'string' && typeof val !== 'undefined') {
@@ -451,7 +454,10 @@
                         d: paths[2]
                     });
                 } else {
-                    return H.SVGElement.prototype.attr.call(this, args); // getter returns value
+                    // getter returns value
+                    return SVGElement.prototype.attr.call(
+                        this, args, undefined, complete, continueAnimation
+                    );
                 }
 
                 return this;
@@ -703,11 +709,23 @@
                 // relates to neighbour elements as well
                 each(['out', 'inn', 'side1', 'side2'], function(face) {
                     wrapper[face]
-                        .addClass(className + ' highcharts-3d-side')
+                        .attr({
+                            'class': className + ' highcharts-3d-side'
+                        })
                         .add(parent);
                 });
             };
 
+            // Cascade to faces
+            each(['addClass', 'removeClass'], function(fn) {
+                wrapper[fn] = function() {
+                    var args = arguments;
+                    each(['top', 'out', 'inn', 'side1', 'side2'], function(face) {
+                        wrapper[face][fn].apply(wrapper[face], args);
+                    });
+                };
+            });
+
             /**
              * Compute the transformed paths and set them to the composite shapes
              */
@@ -1183,29 +1201,168 @@
         });
 
         var defaultOptions = H.getOptions();
-        merge(true, defaultOptions, {
+
+        /**
+         * Options to render charts in 3 dimensions. 
+         * This feature requires highcharts-3d.js, found in the download package, 
+         * or online at code.highcharts.com/highcharts-3d.js.
+         * @optionparent
+         */
+        var extendedOptions = {
+
+            /**
+             * Options regarding the chart area and plot area as well as general
+             * chart options.
+             * 
+             * @product highcharts highstock highmaps
+             */
             chart: {
+
+                /**
+                 * Options to render charts in 3 dimensions. This feature requires
+                 * `highcharts-3d.js`, found in the download package or online at
+                 * [code.highcharts.com/highcharts-3d.js](http://code.highcharts.com/highcharts-
+                 * 3d.js).
+                 * 
+                 * @since 4.0
+                 * @product highcharts
+                 */
                 options3d: {
+
+                    /**
+                     * Wether to render the chart using the 3D functionality.
+                     * 
+                     * @type {Boolean}
+                     * @default false
+                     * @since 4.0
+                     * @product highcharts
+                     */
                     enabled: false,
+
+                    /**
+                     * One of the two rotation angles for the chart.
+                     * 
+                     * @type {Number}
+                     * @default 0
+                     * @since 4.0
+                     * @product highcharts
+                     */
                     alpha: 0,
+
+                    /**
+                     * One of the two rotation angles for the chart.
+                     * 
+                     * @type {Number}
+                     * @default 0
+                     * @since 4.0
+                     * @product highcharts
+                     */
                     beta: 0,
+
+                    /**
+                     * The total depth of the chart.
+                     * 
+                     * @type {Number}
+                     * @default 100
+                     * @since 4.0
+                     * @product highcharts
+                     */
                     depth: 100,
+
+                    /**
+                     * Whether the 3d box should automatically adjust to the chart plot
+                     * area.
+                     * 
+                     * @type {Boolean}
+                     * @default true
+                     * @since 4.2.4
+                     * @product highcharts
+                     */
                     fitToPlot: true,
+
+                    /**
+                     * Defines the distance the viewer is standing in front of the chart,
+                     * this setting is important to calculate the perspective effect
+                     * in column and scatter charts. It is not used for 3D pie charts.
+                     * 
+                     * @type {Number}
+                     * @default 100
+                     * @since 4.0
+                     * @product highcharts
+                     */
                     viewDistance: 25,
+
+                    /**
+                     * Set it to `"auto"` to automatically move the labels to the best
+                     * edge.
+                     * 
+                     * @validvalue [null, "auto"]
+                     * @type {String}
+                     * @default null
+                     * @since 5.0.12
+                     * @product highcharts
+                     */
                     axisLabelPosition: 'default',
+
+                    /**
+                     * Provides the option to draw a frame around the charts by defining
+                     * a bottom, front and back panel.
+                     * 
+                     * @since 4.0
+                     * @product highcharts
+                     */
                     frame: {
+
+                        /**
+                         */
                         visible: 'default',
+
+                        /**
+                         */
                         size: 1,
+
+                        /**
+                         * The bottom of the frame around a 3D chart.
+                         * 
+                         * @since 4.0
+                         * @product highcharts
+                         */
                         bottom: {},
+
+                        /**
+                         * The top of the frame around a 3D chart.
+                         * 
+                         * @type {Object}
+                         * @since 5.0.12
+                         * @product highcharts
+                         */
                         top: {},
+
+                        /**
+                         */
                         left: {},
+
+                        /**
+                         */
                         right: {},
+
+                        /**
+                         * Defines the back panel of the frame around 3D charts.
+                         * 
+                         * @since 4.0
+                         * @product highcharts
+                         */
                         back: {},
+
+                        /**
+                         */
                         front: {}
                     }
                 }
             }
-        });
+        };
+
+        merge(true, defaultOptions, extendedOptions);
 
 
 
@@ -2928,18 +3085,16 @@
                 chart = series.chart,
                 seriesOptions = series.options,
                 depth = seriesOptions.depth || 25,
+                stack = seriesOptions.stacking ?
+                (seriesOptions.stack || 0) :
+                series.index, // #4743
+                z = stack * (depth + (seriesOptions.groupZPadding || 1)),
                 borderCrisp = series.borderWidth % 2 ? 0.5 : 0;
 
-            if (
-                (chart.inverted && !series.yAxis.reversed) ||
-                (!chart.inverted && series.yAxis.reversed)
-            ) {
+            if (chart.inverted && !series.yAxis.reversed) {
                 borderCrisp *= -1;
             }
 
-            var stack = seriesOptions.stacking ? (seriesOptions.stack || 0) : series.index; // #4743
-            var z = stack * (depth + (seriesOptions.groupZPadding || 1));
-
             if (seriesOptions.grouping !== false) {
                 z = 0;
             }
@@ -2955,26 +3110,37 @@
                             ['x', 'width'],
                             ['y', 'height']
                         ],
-                        borderlessBase; // crisped rects can have +/- 0.5 pixels offset
+                        borderlessBase; // Crisped rects can have +/- 0.5 pixels offset.
 
-                    // #3131 We need to check if column shape arguments are inside plotArea.
+                    // #3131 We need to check if column is inside plotArea.
                     each(dimensions, function(d) {
                         borderlessBase = shapeArgs[d[0]] - borderCrisp;
+                        if (borderlessBase < 0) {
+                            // If borderLessBase is smaller than 0, it is needed to set
+                            // its value to 0 or 0.5 depending on borderWidth
+                            // borderWidth may be even or odd.
+                            shapeArgs[d[1]] += shapeArgs[d[0]] + borderCrisp;
+                            shapeArgs[d[0]] = -borderCrisp;
+                            borderlessBase = 0;
+                        }
+                        if (
+                            borderlessBase + shapeArgs[d[1]] > series[d[0] + 'Axis'].len &&
+                            shapeArgs[d[1]] !== 0 // Do not change height/width of column if 0.
+                            // #6708
+                        ) {
+                            shapeArgs[d[1]] = series[d[0] + 'Axis'].len - shapeArgs[d[0]];
+                        }
                         if (
-                            borderlessBase + shapeArgs[d[1]] < 0 || // End column position is smaller than axis start.
-                            borderlessBase > series[d[0] + 'Axis'].len // Start column position is bigger than axis end.
+                            (shapeArgs[d[1]] !== 0) && // Do not remove columns with zero height/width.
+                            (
+                                shapeArgs[d[0]] >= series[d[0] + 'Axis'].len ||
+                                shapeArgs[d[0]] + shapeArgs[d[1]] <= borderCrisp
+                            )
                         ) {
                             for (var key in shapeArgs) { // Set args to 0 if column is outside the chart.
                                 shapeArgs[key] = 0;
                             }
                         }
-                        if (borderlessBase < 0) {
-                            shapeArgs[d[1]] += shapeArgs[d[0]];
-                            shapeArgs[d[0]] = 0;
-                        }
-                        if (borderlessBase + shapeArgs[d[1]] > series[d[0] + 'Axis'].len) {
-                            shapeArgs[d[1]] = series[d[0] + 'Axis'].len - shapeArgs[d[0]];
-                        }
                     });
 
                     point.shapeType = 'cuboid';
@@ -3157,6 +3323,25 @@
             proceed.apply(this, [].slice.call(arguments, 1));
         });
 
+        // Added stackLabels position calculation for 3D charts.
+        wrap(H.StackItem.prototype, 'getStackBox', function(proceed, chart) { // #3946
+            var stackBox = proceed.apply(this, [].slice.call(arguments, 1));
+
+            // Only do this for 3D chart.
+            if (chart.is3d()) {
+                var pos = ({
+                    x: stackBox.x,
+                    y: stackBox.y,
+                    z: 0
+                });
+                pos = H.perspective([pos], chart, true)[0];
+                stackBox.x = pos.x;
+                stackBox.y = pos.y;
+            }
+
+            return stackBox;
+        });
+
         /***
         	EXTENSION FOR 3D CYLINDRICAL COLUMNS
         	Not supported

data/app/assets/javascripts/highcharts/highcharts-more.js

@@ -1,5 +1,5 @@
 /**
- * @license Highcharts JS v5.0.12 (2017-05-24)
+ * @license Highcharts JS v5.0.13 (2017-07-27)
  *
  * (c) 2009-2016 Torstein Honsi
  *
@@ -143,40 +143,156 @@
 
             /**
              * The default options object
+             * @optionparent pane
              */
             defaultOptions: {
                 // background: {conditional},
+
+                /**
+                 * The center of a polar chart or angular gauge, given as an array
+                 * of [x, y] positions. Positions can be given as integers that transform
+                 * to pixels, or as percentages of the plot area size.
+                 * 
+                 * @type {Array<String|Number>}
+                 * @sample {highcharts} highcharts/demo/gauge-vu-meter/ Two gauges with different center
+                 * @default ["50%", "50%"]
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 center: ['50%', '50%'],
+
+                /**
+                 * The size of the pane, either as a number defining pixels, or a
+                 * percentage defining a percentage of the plot are.
+                 * 
+                 * @type {Number|String}
+                 * @sample {highcharts} highcharts/demo/gauge-vu-meter/ Smaller size
+                 * @default 85%
+                 * @product highcharts
+                 */
                 size: '85%',
+
+                /**
+                 * The start angle of the polar X axis or gauge axis, given in degrees
+                 * where 0 is north. Defaults to 0.
+                 * 
+                 * @type {Number}
+                 * @sample {highcharts} highcharts/demo/gauge-vu-meter/ VU-meter with custom start and end angle
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 startAngle: 0
                 //endAngle: startAngle + 360
             },
 
             /**
              * The default background options
+             * @optionparent pane.background
              */
             defaultBackgroundOptions: {
                 //className: 'highcharts-pane',
+
+                /**
+                 * Tha shape of the pane background. When `solid`, the background
+                 * is circular. When `arc`, the background extends only from the min
+                 * to the max of the value axis.
+                 * 
+                 * @validvalue ["solid", "arc"]
+                 * @type {String}
+                 * @default solid
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 shape: 'circle',
 
+
+                /**
+                 * The pixel border width of the pane background.
+                 * 
+                 * @type {Number}
+                 * @default 1
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 borderWidth: 1,
+
+                /**
+                 * The pane background border color.
+                 * 
+                 * @type {Color}
+                 * @default #cccccc
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 borderColor: '#cccccc',
+
+                /**
+                 * The background color or gradient for the pane.
+                 * 
+                 * @type {Color}
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 backgroundColor: {
+
+                    /**
+                     */
+
+                    /**
+                     */
+
+                    /**
+                     */
+
+                    /**
+                     */
+
+                    /**
+                     */
                     linearGradient: {
                         x1: 0,
                         y1: 0,
                         x2: 0,
                         y2: 1
                     },
+
+                    /**
+                     */
                     stops: [
                         [0, '#ffffff'],
                         [1, '#e6e6e6']
                     ]
                 },
 
+
+                /**
+                 */
                 from: -Number.MAX_VALUE, // corrected to axis min
+
+                /**
+                 * The inner radius of the pane background. Can be either numeric
+                 * (pixels) or a percentage string.
+                 * 
+                 * @type {Number|String}
+                 * @default 0
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 innerRadius: 0,
+
+                /**
+                 */
                 to: Number.MAX_VALUE, // corrected to axis max
+
+                /**
+                 * The outer radius of the circular pane background. Can be either
+                 * numeric (pixels) or a percentage string.
+                 * 
+                 * @type {Number|String}
+                 * @default 105%
+                 * @since 2.3.0
+                 * @product highcharts
+                 */
                 outerRadius: '105%'
             },
 
@@ -804,36 +920,129 @@
         var each = H.each,
             noop = H.noop,
             pick = H.pick,
+            defined = H.defined,
             Series = H.Series,
             seriesType = H.seriesType,
-            seriesTypes = H.seriesTypes;
-        /* 
-         * The arearangeseries series type
+            seriesTypes = H.seriesTypes,
+            seriesProto = Series.prototype,
+            pointProto = H.Point.prototype;
+
+        // The arearangeseries series type
+
+
+        /**
+         * @extends plotOptions.area
+         * @optionparent plotOptions.arearange
          */
         seriesType('arearange', 'area', {
 
+
+            /**
+             * Pixel width of the arearange graph line.
+             * 
+             * @type {Number}
+             * @default 1
+             * @since 2.3.0
+             * @product highcharts highstock
+             */
             lineWidth: 1,
 
-            marker: null,
+
+            /**
+             */
             threshold: null,
+
+            /**
+             */
             tooltip: {
 
+
+                /**
+                 */
                 pointFormat: '<span style="color:{series.color}">\u25CF</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>' // eslint-disable-line no-dupe-keys
 
             },
+
+            /**
+             * Whether the whole area or just the line should respond to mouseover
+             * tooltips and other mouse or touch events.
+             * 
+             * @type {Boolean}
+             * @default true
+             * @since 2.3.0
+             * @product highcharts highstock
+             */
             trackByArea: true,
+
+            /**
+             * Extended data labels for range series types. Range series data labels
+             * have no `x` and `y` options. Instead, they have `xLow`, `xHigh`,
+             * `yLow` and `yHigh` options to allow the higher and lower data label
+             * sets individually.
+             * 
+             * @type {Object}
+             * @extends plotOptions.series.dataLabels
+             * @excluding x,y
+             * @since 2.3.0
+             * @product highcharts highstock
+             */
             dataLabels: {
+
+                /**
+                 */
                 align: null,
+
+                /**
+                 */
                 verticalAlign: null,
+
+                /**
+                 * X offset of the lower data labels relative to the point value.
+                 * 
+                 * @type {Number}
+                 * @sample {highcharts} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @sample {highstock} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @default 0
+                 * @since 2.3.0
+                 * @product highcharts highstock
+                 */
                 xLow: 0,
+
+                /**
+                 * X offset of the higher data labels relative to the point value.
+                 * 
+                 * @type {Number}
+                 * @sample {highcharts} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @sample {highstock} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @default 0
+                 * @since 2.3.0
+                 * @product highcharts highstock
+                 */
                 xHigh: 0,
+
+                /**
+                 * Y offset of the lower data labels relative to the point value.
+                 * 
+                 * @type {Number}
+                 * @sample {highcharts} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @sample {highstock} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @default 16
+                 * @since 2.3.0
+                 * @product highcharts highstock
+                 */
                 yLow: 0,
+
+                /**
+                 * Y offset of the higher data labels relative to the point value.
+                 * 
+                 * @type {Number}
+                 * @sample {highcharts} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @sample {highstock} highcharts/plotoptions/arearange-datalabels/ Data labels on range series
+                 * @default -6
+                 * @since 2.3.0
+                 * @product highcharts highstock
+                 */
                 yHigh: 0
-            },
-            states: {
-                hover: {
-                    halo: false
-                }
             }
 
             // Prototype members
@@ -857,6 +1066,7 @@
                     xy = this.xAxis.postTranslate(point.rectPlotX, this.yAxis.len - point.plotHigh);
                 point.plotHighX = xy.x - chart.plotLeft;
                 point.plotHigh = xy.y - chart.plotTop;
+                point.plotLowX = point.plotX;
             },
 
             /**
@@ -878,6 +1088,7 @@
 
                     if (high === null || low === null) {
                         point.isNull = true;
+                        point.plotY = null;
                     } else {
                         point.plotLow = plotY;
                         point.plotHigh = yAxis.translate(
@@ -897,6 +1108,10 @@
                 if (this.chart.polar) {
                     each(this.points, function(point) {
                         series.highToXY(point);
+                        point.tooltipPos = [
+                            (point.plotHighX + point.plotLowX) / 2,
+                            (point.plotHigh + point.plotLow) / 2
+                        ];
                     });
                 }
             },
@@ -1015,7 +1230,6 @@
                     length = data.length,
                     i,
                     originalDataLabels = [],
-                    seriesProto = Series.prototype,
                     dataLabelOptions = this.options.dataLabels,
                     align = dataLabelOptions.align,
                     verticalAlign = dataLabelOptions.verticalAlign,
@@ -1109,11 +1323,123 @@
                 seriesTypes.column.prototype.alignDataLabel.apply(this, arguments);
             },
 
-            setStackedPoints: noop,
+            drawPoints: function() {
+                var series = this,
+                    pointLength = series.points.length,
+                    point,
+                    i;
+
+                // Draw bottom points
+                seriesProto.drawPoints.apply(series, arguments);
+
+                i = 0;
+                while (i < pointLength) {
+                    point = series.points[i];
+                    point.lowerGraphic = point.graphic;
+                    point.graphic = point.upperGraphic;
+                    point._plotY = point.plotY;
+                    point._plotX = point.plotX;
+                    point.plotY = point.plotHigh;
+                    if (defined(point.plotHighX)) {
+                        point.plotX = point.plotHighX;
+                    }
+                    i++;
+                }
+
+                // Draw top points
+                seriesProto.drawPoints.apply(series, arguments);
+
+                i = 0;
+                while (i < pointLength) {
+                    point = series.points[i];
+                    point.upperGraphic = point.graphic;
+                    point.graphic = point.lowerGraphic;
+                    point.plotY = point._plotY;
+                    point.plotX = point._plotX;
+                    i++;
+                }
+            },
+
+            setStackedPoints: noop
+        }, {
+            setState: function() {
+                var prevState = this.state,
+                    series = this.series,
+                    isPolar = series.chart.polar;
 
-            getSymbol: noop,
 
-            drawPoints: noop
+                if (!defined(this.plotHigh)) {
+                    // Boost doesn't calculate plotHigh
+                    this.plotHigh = series.yAxis.toPixels(this.high, true);
+                }
+
+                if (!defined(this.plotLow)) {
+                    // Boost doesn't calculate plotLow
+                    this.plotLow = this.plotY = series.yAxis.toPixels(this.low, true);
+                }
+
+                // Bottom state:
+                pointProto.setState.apply(this, arguments);
+
+                // Change state also for the top marker
+                this.graphic = this.upperGraphic;
+                this.plotY = this.plotHigh;
+
+                if (isPolar) {
+                    this.plotX = this.plotHighX;
+                }
+
+                this.state = prevState;
+
+                if (series.stateMarkerGraphic) {
+                    series.lowerStateMarkerGraphic = series.stateMarkerGraphic;
+                    series.stateMarkerGraphic = series.upperStateMarkerGraphic;
+                }
+
+                pointProto.setState.apply(this, arguments);
+
+                // Now restore defaults
+                this.plotY = this.plotLow;
+                this.graphic = this.lowerGraphic;
+
+                if (isPolar) {
+                    this.plotX = this.plotLowX;
+                }
+
+                if (series.stateMarkerGraphic) {
+                    series.upperStateMarkerGraphic = series.stateMarkerGraphic;
+                    series.stateMarkerGraphic = series.lowerStateMarkerGraphic;
+                }
+            },
+            haloPath: function() {
+                var isPolar = this.series.chart.polar,
+                    path = [];
+
+                // Bottom halo
+                this.plotY = this.plotLow;
+                if (isPolar) {
+                    this.plotX = this.plotLowX;
+                }
+
+                path = pointProto.haloPath.apply(this, arguments);
+
+                // Top halo
+                this.plotY = this.plotHigh;
+                if (isPolar) {
+                    this.plotX = this.plotHighX;
+                }
+                path = path.concat(
+                    pointProto.haloPath.apply(this, arguments)
+                );
+
+                return path;
+            },
+            destroy: function() {
+                if (this.upperGraphic) {
+                    this.upperGraphic = this.upperGraphic.destroy();
+                }
+                return pointProto.destroy.apply(this, arguments);
+            }
         });
 
     }(Highcharts));
@@ -1150,16 +1476,47 @@
             seriesTypes = H.seriesTypes;
 
         var colProto = seriesTypes.column.prototype;
+        /**
+         * @extends {plotOptions.arearange}
+         * @optionparent plotOptions.columrange
+         */
+        var columnRangeOptions = {
+
+            /**
+             */
+            lineWidth: 1,
+
+            /**
+             */
+            pointRange: null,
+
+            /**
+             */
+            marker: null,
+
+            /**
+             */
+            states: {
+
+                /**
+                 */
+                hover: {
 
+                    /**
+                     */
+                    halo: false
+                }
+            }
+        };
         /**
          * The ColumnRangeSeries class
          */
-        seriesType('columnrange', 'arearange', merge(defaultPlotOptions.column, defaultPlotOptions.arearange, {
-            lineWidth: 1,
-            pointRange: null
+        seriesType('columnrange', 'arearange', merge(
+            defaultPlotOptions.column,
+            defaultPlotOptions.arearange,
+            columnRangeOptions
 
-            // Prototype members
-        }), {
+        ), {
             /**
              * Translate data points from raw values x and y to plotX and plotY
              */
@@ -1171,8 +1528,17 @@
                     start,
                     chart = series.chart,
                     isRadial = series.xAxis.isRadial,
+                    safeDistance = Math.max(chart.chartWidth, chart.chartHeight) + 999,
                     plotHigh;
 
+                // Don't draw too far outside plot area (#6835)
+                function safeBounds(pixelPos) {
+                    return Math.min(Math.max(-safeDistance,
+                        pixelPos
+                    ), safeDistance);
+                }
+
+
                 colProto.translate.apply(series);
 
                 // Set plotLow and plotHigh
@@ -1183,8 +1549,10 @@
                         height,
                         y;
 
-                    point.plotHigh = plotHigh = yAxis.translate(point.high, 0, 1, 0, 1);
-                    point.plotLow = point.plotY;
+                    point.plotHigh = plotHigh = safeBounds(
+                        yAxis.translate(point.high, 0, 1, 0, 1)
+                    );
+                    point.plotLow = safeBounds(point.plotY);
 
                     // adjust shape
                     y = plotHigh;
@@ -1210,6 +1578,7 @@
                             d: series.polarArc(y + height, y, start, start + point.pointWidth)
                         };
                     } else {
+
                         shapeArgs.height = height;
                         shapeArgs.y = y;
 
@@ -1230,6 +1599,7 @@
             directTouch: true,
             trackerGroups: ['group', 'dataLabelsGroup'],
             drawGraph: noop,
+            getSymbol: noop,
             crispCol: colProto.crispCol,
             drawPoints: colProto.drawPoints,
             drawTracker: colProto.drawTracker,
@@ -1241,6 +1611,8 @@
                 return colProto.polarArc.apply(this, arguments);
             },
             pointAttribs: colProto.pointAttribs
+        }, {
+            setState: colProto.pointClass.prototype.setState
         });
 
     }(Highcharts));
@@ -1259,24 +1631,120 @@
             Series = H.Series,
             seriesType = H.seriesType,
             TrackerMixin = H.TrackerMixin;
-        /* 
+
+
+        /** 
          * The GaugeSeries class
+         * @extends {plotOptions.line}
+         * @optionparent plotOptions.gauge
          */
         seriesType('gauge', 'line', {
+
+            /**
+             * Data labels for the gauge. For gauges, the data labels are enabled
+             * by default and shown in a bordered box below the point.
+             * 
+             * @type {Object}
+             * @extends plotOptions.series.dataLabels
+             * @since 2.3.0
+             * @product highcharts
+             */
             dataLabels: {
+
+                /**
+                 * Enable or disable the data labels.
+                 * 
+                 * @type {Boolean}
+                 * @since 2.3.0
+                 * @product highcharts highmaps
+                 */
                 enabled: true,
+
+                /**
+                 */
                 defer: false,
+
+                /**
+                 * The y position offset of the label relative to the center of the
+                 * gauge.
+                 * 
+                 * @type {Number}
+                 * @default 15
+                 * @since 2.3.0
+                 * @product highcharts highmaps
+                 */
                 y: 15,
+
+                /**
+                 * The border radius in pixels for the gauge's data label.
+                 * 
+                 * @type {Number}
+                 * @default 3
+                 * @since 2.3.0
+                 * @product highcharts highmaps
+                 */
                 borderRadius: 3,
+
+                /**
+                 */
                 crop: false,
+
+                /**
+                 * The vertical alignment of the data label.
+                 * 
+                 * @type {String}
+                 * @default top
+                 * @product highcharts highmaps
+                 */
                 verticalAlign: 'top',
+
+                /**
+                 * The Z index of the data labels. A value of 2 display them behind
+                 * the dial.
+                 * 
+                 * @type {Number}
+                 * @default 2
+                 * @since 2.1.5
+                 * @product highcharts highmaps
+                 */
                 zIndex: 2,
 
                 // Presentational
+
+                /**
+                 * The border width in pixels for the gauge data label.
+                 * 
+                 * @type {Number}
+                 * @default 1
+                 * @since 2.3.0
+                 * @product highcharts highmaps
+                 */
                 borderWidth: 1,
+
+                /**
+                 * The border color for the data label.
+                 * 
+                 * @type {Color}
+                 * @default #cccccc
+                 * @since 2.3.0
+                 * @product highcharts highmaps
+                 */
                 borderColor: '#cccccc'
 
             },
+
+            /**
+             * Options for the dial or arrow pointer of the gauge.
+             * 
+             * In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the dial is styled with the `.highcharts-gauge-
+             * series .highcharts-dial` rule.
+             * 
+             * @type {Object}
+             * @sample {highcharts} highcharts/css/gauge/ Styled mode
+             * @since 2.3.0
+             * @product highcharts
+             */
             dial: {
                 // radius: '80%',
                 // baseWidth: 3,
@@ -1290,6 +1758,19 @@
 
 
             },
+
+            /**
+             * Options for the pivot or the center point of the gauge.
+             * 
+             * In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the pivot is styled with the `.highcharts-gauge-
+             * series .highcharts-pivot` rule.
+             * 
+             * @type {Object}
+             * @sample {highcharts} highcharts/css/gauge/ Styled mode
+             * @since 2.3.0
+             * @product highcharts
+             */
             pivot: {
                 //radius: 5,
 
@@ -1298,9 +1779,24 @@
                 //backgroundColor: '#000000'
 
             },
+
+            /**
+             */
             tooltip: {
+
+                /**
+                 */
                 headerFormat: ''
             },
+
+            /**
+             * Whether to display this particular series or series type in the
+             * legend. Defaults to false for gauge series.
+             * 
+             * @type {Boolean}
+             * @since 2.3.0
+             * @product highcharts
+             */
             showInLegend: false
 
             // Prototype members
@@ -1526,10 +2022,24 @@
          * @constructor seriesTypes.boxplot
          * @augments seriesTypes.column
          */
+
+        /**
+         * @extends {plotOptions.column}
+         * @optionparent plotOptions.boxplot
+         */
         seriesType('boxplot', 'column', {
+
+            /**
+             */
             threshold: null,
+
+            /**
+             */
             tooltip: {
 
+
+                /**
+                 */
                 pointFormat: '<span style="color:{point.color}">\u25CF</span> <b> {series.name}</b><br/>' + // eslint-disable-line no-dupe-keys
                     'Maximum: {point.high}<br/>' +
                     'Upper quartile: {point.q3}<br/>' +
@@ -1538,14 +2048,77 @@
                     'Minimum: {point.low}<br/>'
 
             },
+
+            /**
+             * The length of the whiskers, the horizontal lines marking low and
+             * high values. It can be a numerical pixel value, or a percentage
+             * value of the box width. Set `0` to disable whiskers.
+             * 
+             * @type {Number|String}
+             * @sample {highcharts} highcharts/plotoptions/box-plot-styling/ True by default
+             * @default 50%
+             * @since 3.0
+             * @product highcharts
+             */
             whiskerLength: '50%',
 
+
+            /**
+             * The fill color of the box.
+             * 
+             * @type {Color}
+             * @see In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the fill color can be set with the `.highcharts-
+             * boxplot-box` class.
+             * @sample {highcharts} highcharts/plotoptions/box-plot-styling/ Box plot styling
+             * @default #ffffff
+             * @since 3.0
+             * @product highcharts
+             */
             fillColor: '#ffffff',
+
+            /**
+             * The width of the line surrounding the box. If any of [stemWidth](#plotOptions.
+             * boxplot.stemWidth), [medianWidth](#plotOptions.boxplot.medianWidth)
+             * or [whiskerWidth](#plotOptions.boxplot.whiskerWidth) are `null`,
+             *  the lineWidth also applies to these lines.
+             * 
+             * @type {Number}
+             * @sample {highcharts} highcharts/plotoptions/box-plot-styling/ Box plot styling
+             * @sample {highcharts} highcharts/plotoptions/error-bar-styling/ Error bar styling
+             * @default 1
+             * @since 3.0
+             * @product highcharts
+             */
             lineWidth: 1,
             //medianColor: null,
+
+            /**
+             * The pixel width of the median line. If `null`, the [lineWidth](#plotOptions.
+             * boxplot.lineWidth) is used.
+             * 
+             * @type {Number}
+             * @see In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the median stroke width can be set with the
+             * `.highcharts-boxplot-median` class ([view live demo](http://jsfiddle.
+             * net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/css/boxplot/)).
+             * @sample {highcharts} highcharts/plotoptions/box-plot-styling/ Box plot styling
+             * @default 2
+             * @since 3.0
+             * @product highcharts
+             */
             medianWidth: 2,
+
+            /**
+             */
             states: {
+
+                /**
+                 */
                 hover: {
+
+                    /**
+                     */
                     brightness: -0.3
                 }
             },
@@ -1554,6 +2127,22 @@
             //stemWidth: null,
 
             //whiskerColor: null,
+
+            /**
+             * The line width of the whiskers, the horizontal lines marking low
+             * and high values. When `null`, the general [lineWidth](#plotOptions.
+             * boxplot.lineWidth) applies.
+             * 
+             * @type {Number}
+             * @see In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the whisker stroke width can be set with the
+             * `.highcharts-boxplot-whisker` class ([view live demo](http://jsfiddle.
+             * net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/css/boxplot/)).
+             * @sample {highcharts} highcharts/plotoptions/box-plot-styling/ Box plot styling
+             * @default 2
+             * @since 3.0
+             * @product highcharts
+             */
             whiskerWidth: 2
 
 
@@ -1828,15 +2417,63 @@
         /* ****************************************************************************
          * Start error bar series code                                                *
          *****************************************************************************/
+
+        /**  
+         * @extends {plotOptions.boxplot}
+         * @optionparent plotOptions.errorbar
+         */
         seriesType('errorbar', 'boxplot', {
 
+
+            /**
+             * The main color of the bars. This can be overridden by [stemColor](#plotOptions.
+             * errorbar.stemColor) and [whiskerColor](#plotOptions.errorbar.whiskerColor)
+             * individually.
+             * 
+             * @type {Color}
+             * @sample {highcharts} highcharts/plotoptions/error-bar-styling/ Error bar styling
+             * @default #000000
+             * @since 3.0
+             * @product highcharts
+             */
             color: '#000000',
 
+
+            /**
+             */
             grouping: false,
+
+            /**
+             * The parent series of the error bar. The default value links it to
+             * the previous series. Otherwise, use the id of the parent series.
+             * 
+             * @type {String}
+             * @default :previous
+             * @since 3.0
+             * @product highcharts
+             */
             linkedTo: ':previous',
+
+            /**
+             */
             tooltip: {
+
+                /**
+                 */
                 pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>'
             },
+
+            /**
+             * The line width of the whiskers, the horizontal lines marking low
+             * and high values. When `null`, the general [lineWidth](#plotOptions.
+             * errorbar.lineWidth) applies.
+             * 
+             * @type {Number}
+             * @sample {highcharts} highcharts/plotoptions/error-bar-styling/ Error bar styling
+             * @default null
+             * @since 3.0
+             * @product highcharts
+             */
             whiskerWidth: null
 
             // Prototype members
@@ -1889,17 +2526,97 @@
         /* ****************************************************************************
          * Start Waterfall series code                                                *
          *****************************************************************************/
+        /**
+         * @extends {plotOptions.column}
+         * @optionparent plotOptions.waterfall
+         */
         seriesType('waterfall', 'column', {
+
+            /**
+             */
             dataLabels: {
+
+                /**
+                 */
                 inside: true
             },
 
+
+            /**
+             * The width of the line connecting waterfall columns.
+             * 
+             * @type {Number}
+             * @default 1
+             * @product highcharts
+             */
             lineWidth: 1,
+
+            /**
+             * The color of the line that connects columns in a waterfall series.
+             * 
+             * 
+             * In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the stroke can be set with the `.highcharts-
+             * graph` class.
+             * 
+             * @type {Color}
+             * @default #333333
+             * @since 3.0
+             * @product highcharts
+             */
             lineColor: '#333333',
+
+            /**
+             * A name for the dash style to use for the line connecting the columns
+             * of the waterfall series. Possible values:
+             * 
+             * *   Solid
+             * *   ShortDash
+             * *   ShortDot
+             * *   ShortDashDot
+             * *   ShortDashDotDot
+             * *   Dot
+             * *   Dash
+             * *   LongDash
+             * *   DashDot
+             * *   LongDashDot
+             * *   LongDashDotDot
+             * 
+             * In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the stroke dash-array can be set with the `.
+             * highcharts-graph` class.
+             * 
+             * @type {String}
+             * @default Dot
+             * @since 3.0
+             * @product highcharts
+             */
             dashStyle: 'dot',
+
+            /**
+             * The color of the border of each waterfall column.
+             * 
+             * In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the border stroke can be set with the `.highcharts-
+             * point` class.
+             * 
+             * @type {Color}
+             * @default #333333
+             * @since 3.0
+             * @product highcharts
+             */
             borderColor: '#333333',
+
+            /**
+             */
             states: {
+
+                /**
+                 */
                 hover: {
+
+                    /**
+                     */
                     lineWidthPlus: 0 // #3126
                 }
             }
@@ -2242,6 +2959,11 @@
         /**
          * The polygon series prototype
          */
+
+        /**
+         * @extends {plotOptions.scatter}
+         * @optionsparent plotOptions.polygon
+         */
         seriesType('polygon', 'scatter', {
             marker: {
                 enabled: false,
@@ -2311,47 +3033,198 @@
          * Start Bubble series code											          *
          *****************************************************************************/
 
+
+        /**
+         * @extends plotOptions.scatter
+         * @optionparent plotOptions.bubble
+         */
         seriesType('bubble', 'scatter', {
+
+            /**
+             */
             dataLabels: {
+
+                /**
+                 */
                 formatter: function() { // #2945
                     return this.point.z;
                 },
+
+                /**
+                 */
                 inside: true,
+
+                /**
+                 */
                 verticalAlign: 'middle'
             },
             // displayNegative: true,
+
+            /**
+             * Options for the point markers of line-like series. Properties like
+             * `fillColor`, `lineColor` and `lineWidth` define the visual appearance
+             * of the markers. Other series types, like column series, don't have
+             * markers, but have visual options on the series level instead.
+             * 
+             * In [styled mode](http://www.highcharts.com/docs/chart-design-and-
+             * style/style-by-css), the markers can be styled with the `.highcharts-
+             * point`, `.highcharts-point-hover` and `.highcharts-point-select`
+             * class names.
+             * 
+             * @type {Object}
+             * @extends plotOptions.series.marker
+             * @excluding radius
+             * @product highcharts
+             */
             marker: {
 
                 // fillOpacity: 0.5,
+
+                /**
+                 */
                 lineColor: null, // inherit from series.color
+
+                /**
+                 */
                 lineWidth: 1,
 
                 // Avoid offset in Point.setState
+
+                /**
+                 */
                 radius: null,
+
+                /**
+                 */
                 states: {
+
+                    /**
+                     */
                     hover: {
+
+                        /**
+                         */
                         radiusPlus: 0
                     }
                 },
+
+                /**
+                 * A predefined shape or symbol for the marker. Possible values are
+                 * "circle", "square", "diamond", "triangle" and "triangle-down".
+                 * 
+                 * Additionally, the URL to a graphic can be given on the form `url(graphic.
+                 * png)`. Note that for the image to be applied to exported charts,
+                 * its URL needs to be accessible by the export server.
+                 * 
+                 * Custom callbacks for symbol path generation can also be added to
+                 * `Highcharts.SVGRenderer.prototype.symbols`. The callback is then
+                 * used by its method name, as shown in the demo.
+                 * 
+                 * @validvalue ["circle", "square", "diamond", "triangle", "triangle-down"]
+                 * @type {String}
+                 * @sample {highcharts} highcharts/plotoptions/bubble-symbol/ Bubble chart with various symbols
+                 * @sample {highcharts} highcharts/plotoptions/series-marker-symbol/ General chart with predefined, graphic and custom markers
+                 * @default circle
+                 * @since 5.0.11
+                 * @product highcharts
+                 */
                 symbol: 'circle'
             },
+
+            /**
+             * Minimum bubble size. Bubbles will automatically size between the
+             * `minSize` and `maxSize` to reflect the `z` value of each bubble.
+             * Can be either pixels (when no unit is given), or a percentage of
+             * the smallest one of the plot width and height.
+             * 
+             * @type {String}
+             * @sample {highcharts} highcharts/plotoptions/bubble-size/ Bubble size
+             * @default 8
+             * @since 3.0
+             * @product highcharts
+             */
             minSize: 8,
+
+            /**
+             * Maximum bubble size. Bubbles will automatically size between the
+             * `minSize` and `maxSize` to reflect the `z` value of each bubble.
+             * Can be either pixels (when no unit is given), or a percentage of
+             * the smallest one of the plot width and height.
+             * 
+             * @type {String}
+             * @sample {highcharts} highcharts/plotoptions/bubble-size/ Bubble size
+             * @default 20%
+             * @since 3.0
+             * @product highcharts
+             */
             maxSize: '20%',
             // negativeColor: null,
             // sizeBy: 'area'
+
+            /**
+             * When this is true, the series will not cause the Y axis to cross
+             * the zero plane (or [threshold](#plotOptions.series.threshold) option)
+             * unless the data actually crosses the plane.
+             * 
+             * For example, if `softThreshold` is `false`, a series of 0, 1, 2,
+             * 3 will make the Y axis show negative values according to the `minPadding`
+             * option. If `softThreshold` is `true`, the Y axis starts at 0.
+             * 
+             * @type {Boolean}
+             * @default false
+             * @since 4.1.9
+             * @product highcharts
+             */
             softThreshold: false,
+
+            /**
+             */
             states: {
+
+                /**
+                 */
                 hover: {
+
+                    /**
+                     */
                     halo: {
+
+                        /**
+                         */
                         size: 5
                     }
                 }
             },
+
+            /**
+             */
             tooltip: {
+
+                /**
+                 */
                 pointFormat: '({point.x}, {point.y}), Size: {point.z}'
             },
+
+            /**
+             */
             turboThreshold: 0,
+
+            /**
+             * When [displayNegative](#plotOptions.bubble.displayNegative) is `false`,
+             * bubbles with lower Z values are skipped. When `displayNegative`
+             * is `true` and a [negativeColor](#plotOptions.bubble.negativeColor)
+             * is given, points with lower Z is colored.
+             * 
+             * @type {Number}
+             * @sample {highcharts} highcharts/plotoptions/bubble-negative/ Negative bubbles
+             * @default 0
+             * @since 3.0
+             * @product highcharts
+             */
             zThreshold: 0,
+
+            /**
+             */
             zoneAxis: 'z'
 
             // Prototype members
@@ -2896,6 +3769,19 @@
                         break;
                     }
                 }
+
+
+                /**
+                 * Polar charts only. Whether to connect the ends of a line series plot
+                 * across the extremes.
+                 * 
+                 * @type {Boolean}
+                 * @sample {highcharts} highcharts/plotoptions/line-connectends-false/
+                 *         Do not connect
+                 * @since 2.3.0
+                 * @product highcharts
+                 * @apioption plotOptions.series.connectEnds
+                 */
                 if (this.options.connectEnds !== false && firstValid !== undefined) {
                     this.connectEnds = true; // re-used in splines
                     points.splice(points.length, 0, points[firstValid]);