highcharts 6.1.4 → 6.2.0

package/js/es-modules/parts/Html.js

@@ -1,13 +1,15 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
 
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
 import './SvgRenderer.js';
+
 var attr = H.attr,
     createElement = H.createElement,
     css = H.css,
@@ -24,11 +26,19 @@ var attr = H.attr,
     win = H.win,
     wrap = H.wrap;
 
-// Extend SvgElement for useHTML option
+// Extend SvgElement for useHTML option.
 extend(SVGElement.prototype, /** @lends SVGElement.prototype */ {
+
     /**
      * Apply CSS to HTML elements. This is used in text within SVG rendering and
      * by the VML renderer
+     *
+     * @private
+     * @function Highcharts.SVGElement#htmlCss
+     *
+     * @param {Highcharts.CSSObject} styles
+     *
+     * @return {Highcharts.SVGElement}
      */
     htmlCss: function (styles) {
         var wrapper = this,
@@ -61,13 +71,18 @@ extend(SVGElement.prototype, /** @lends SVGElement.prototype */ {
     },
 
     /**
-     * VML and useHTML method for calculating the bounding box based on offsets
-     * @param {Boolean} refresh Whether to force a fresh value from the DOM or
-     * to use the cached value.
+     * VML and useHTML method for calculating the bounding box based on offsets.
+     *
+     * @private
+     * @function Highcharts.SVGElement#htmlGetBBox
      *
-     * @return {Object} A hash containing values for x, y, width and height
+     * @param {boolean} refresh
+     *        Whether to force a fresh value from the DOM or to use the cached
+     *        value.
+     *
+     * @return {Highcharts.BBoxObject}
+     *         A hash containing values for x, y, width and height.
      */
-
     htmlGetBBox: function () {
         var wrapper = this,
             element = wrapper.element;
@@ -82,7 +97,10 @@ extend(SVGElement.prototype, /** @lends SVGElement.prototype */ {
 
     /**
      * VML override private method to update elements based on internal
-     * properties based on SVG transform
+     * properties based on SVG transform.
+     *
+     * @private
+     * @function Highcharts.SVGElement#htmlUpdateTransform
      */
     htmlUpdateTransform: function () {
         // aligning non added elements is expensive
@@ -212,7 +230,16 @@ extend(SVGElement.prototype, /** @lends SVGElement.prototype */ {
     },
 
     /**
-     * Set the rotation of an individual HTML span
+     * Set the rotation of an individual HTML span.
+     *
+     * @private
+     * @function Highcharts.SVGElement#setSpanRotation
+     *
+     * @param {number} rotation
+     *
+     * @param {number} alignCorrection
+     *
+     * @param {number} baseline
      */
     setSpanRotation: function (rotation, alignCorrection, baseline) {
         var rotationStyle = {},
@@ -228,6 +255,15 @@ extend(SVGElement.prototype, /** @lends SVGElement.prototype */ {
 
     /**
      * Get the correction in X and Y positioning as the element is rotated.
+     *
+     * @private
+     * @function Highcharts.SVGElement#getSpanCorrection
+     *
+     * @param {number} width
+     *
+     * @param {number} baseline
+     *
+     * @param {number} alignCorrection
      */
     getSpanCorrection: function (width, baseline, alignCorrection) {
         this.xCorr = -width * alignCorrection;
@@ -238,6 +274,12 @@ extend(SVGElement.prototype, /** @lends SVGElement.prototype */ {
 // Extend SvgRenderer for useHTML option.
 extend(SVGRenderer.prototype, /** @lends SVGRenderer.prototype */ {
 
+    /**
+     * @private
+     * @function Highcharts.SVGRenderer#getTransformKey
+     *
+     * @return {string}
+     */
     getTransformKey: function () {
         return isMS && !/Edge/.test(win.navigator.userAgent) ?
             '-ms-transform' :
@@ -254,9 +296,19 @@ extend(SVGRenderer.prototype, /** @lends SVGRenderer.prototype */ {
      * Create HTML text node. This is used by the VML renderer as well as the
      * SVG renderer through the useHTML option.
      *
-     * @param {String} str
-     * @param {Number} x
-     * @param {Number} y
+     * @private
+     * @function Highcharts.SVGRenderer#html
+     *
+     * @param {string} str
+     *        The text of (subset) HTML to draw.
+     *
+     * @param {number} x
+     *        The x position of the text's lower left corner.
+     *
+     * @param {number} y
+     *        The y position of the text's lower left corner.
+     *
+     * @return {Highcharts.HTMLDOMElement}
      */
     html: function (str, x, y) {
         var wrapper = this.createElement('span'),

package/js/es-modules/parts/Interaction.js

@@ -1,9 +1,11 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
+
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
 import './Chart.js';
@@ -11,6 +13,7 @@ import './Options.js';
 import './Legend.js';
 import './Point.js';
 import './Series.js';
+
 var addEvent = H.addEvent,
     Chart = H.Chart,
     createElement = H.createElement,
@@ -35,12 +38,18 @@ var addEvent = H.addEvent,
 /**
  * TrackerMixin for points and graphs.
  *
- * @ignore
+ * @private
+ * @mixin Highcharts.TrackerMixin
  */
 TrackerMixin = H.TrackerMixin = {
 
     /**
      * Draw the tracker for a point.
+     *
+     * @private
+     * @function Highcharts.TrackerMixin.drawTrackerPoint
+     *
+     * @fires Highcharts.Series#event:afterDrawTracker
      */
     drawTrackerPoint: function () {
         var series = this,
@@ -97,6 +106,11 @@ TrackerMixin = H.TrackerMixin = {
      * track mouse events on the graph or points. For the line type charts
      * the tracker uses the same graphPath, but with a greater stroke width
      * for better control.
+     *
+     * @private
+     * @function Highcharts.TrackerMixin.drawTrackerGraph
+     *
+     * @fires Highcharts.Series#event:afterDrawTracker
      */
     drawTrackerGraph: function () {
         var series = this,
@@ -201,28 +215,53 @@ TrackerMixin = H.TrackerMixin = {
 /* End TrackerMixin */
 
 
-/**
+/*
  * Add tracking event listener to the series group, so the point graphics
  * themselves act as trackers
  */
 
 if (seriesTypes.column) {
+    /**
+     * @private
+     * @borrows Highcharts.TrackerMixin.drawTrackerPoint as Highcharts.seriesTypes.column#drawTracker
+     */
     seriesTypes.column.prototype.drawTracker = TrackerMixin.drawTrackerPoint;
 }
 
 if (seriesTypes.pie) {
+    /**
+     * @private
+     * @borrows Highcharts.TrackerMixin.drawTrackerPoint as Highcharts.seriesTypes.pie#drawTracker
+     */
     seriesTypes.pie.prototype.drawTracker = TrackerMixin.drawTrackerPoint;
 }
 
 if (seriesTypes.scatter) {
+    /**
+     * @private
+     * @borrows Highcharts.TrackerMixin.drawTrackerPoint as Highcharts.seriesTypes.scatter#drawTracker
+     */
     seriesTypes.scatter.prototype.drawTracker = TrackerMixin.drawTrackerPoint;
 }
 
-/*
- * Extend Legend for item events
- */
+
+
+// Extend Legend for item events.
 extend(Legend.prototype, {
 
+    /**
+     * @private
+     * @function Highcharts.Legend#setItemEvents
+     *
+     * @param {Highcharts.Point|Highcharts.Series} item
+     *
+     * @param {Highcharts.SVGElement} legendItem
+     *
+     * @param {boolean} [useHTML=false]
+     *
+     * @fires Highcharts.Point#event:legendItemClick
+     * @fires Highcharts.Series#event:legendItemClick
+     */
     setItemEvents: function (item, legendItem, useHTML) {
         var legend = this,
             boxWrapper = legend.chart.renderer.boxWrapper,
@@ -278,6 +317,14 @@ extend(Legend.prototype, {
         });
     },
 
+    /**
+     * @private
+     * @function Highcharts.Legend#createCheckboxForItem
+     *
+     * @param {Highcharts.Point|Highcharts.Series} item
+     *
+     * @fires Highcharts.Series#event:checkboxClick
+     */
     createCheckboxForItem: function (item) {
         var legend = this;
 
@@ -305,19 +352,16 @@ extend(Legend.prototype, {
     }
 });
 
-
-
-
-
-/*
- * Extend the Chart object with interaction
- */
-
+// Extend the Chart object with interaction.
 extend(Chart.prototype, /** @lends Chart.prototype */ {
+
     /**
      * Display the zoom button.
      *
      * @private
+     * @function Highcharts.Chart#showResetZoom
+     *
+     * @fires Highcharts.Chart#event:beforeShowResetZoom
      */
     showResetZoom: function () {
         var chart = this,
@@ -354,6 +398,10 @@ extend(Chart.prototype, /** @lends Chart.prototype */ {
     /**
      * Zoom the chart out after a user has zoomed in. See also
      * [Axis.setExtremes](/class-reference/Highcharts.Axis#setExtremes).
+     *
+     * @function Highcharts.Chart#zoomOut
+     *
+     * @fires Highcharts.Chart#event:selection
      */
     zoomOut: function () {
         fireEvent(this, 'selection', { resetSelection: true }, this.zoom);
@@ -361,9 +409,11 @@ extend(Chart.prototype, /** @lends Chart.prototype */ {
 
     /**
      * Zoom into a given portion of the chart given by axis coordinates.
-     * @param {Object} event
      *
      * @private
+     * @function Highcharts.Chart#zoom
+     *
+     * @param {Highcharts.SelectEventObject} event
      */
     zoom: function (event) {
         var chart = this,
@@ -421,6 +471,11 @@ extend(Chart.prototype, /** @lends Chart.prototype */ {
      * compared to the first chartX position in the dragging operation.
      *
      * @private
+     * @function Highcharts.Chart#pan
+     *
+     * @param {Highcharts.PointerEventObject} e
+     *
+     * @param {string} panning
      */
     pan: function (e, panning) {
 
@@ -513,24 +568,13 @@ extend(Chart.prototype, /** @lends Chart.prototype */ {
     }
 });
 
-/*
- * Extend the Point object with interaction
- */
+// Extend the Point object with interaction
 extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
+
     /**
      * Toggle the selection status of a point.
-     * @param  {Boolean} [selected]
-     *         When `true`, the point is selected. When `false`, the point is
-     *         unselected. When `null` or `undefined`, the selection state is
-     *         toggled.
-     * @param  {Boolean} [accumulate=false]
-     *         When `true`, the selection is added to other selected points.
-     *         When `false`, other selected points are deselected. Internally in
-     *         Highcharts, when {@link http://api.highcharts.com/highcharts/plotOptions.series.allowPointSelect|allowPointSelect}
-     *         is `true`, selected points are accumulated on Control, Shift or
-     *         Cmd clicking the point.
      *
-     * @see    Highcharts.Chart#getSelectedPoints
+     * @see Highcharts.Chart#getSelectedPoints
      *
      * @sample highcharts/members/point-select/
      *         Select a point from a button
@@ -538,6 +582,24 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
      *         Select a range of points through a drag selection
      * @sample maps/series/data-id/
      *         Select a point in Highmaps
+     *
+     * @function Highcharts.Point#select
+     *
+     * @param {boolean} [selected]
+     *        When `true`, the point is selected. When `false`, the point is
+     *        unselected. When `null` or `undefined`, the selection state is
+     *        toggled.
+     *
+     * @param {boolean} [accumulate=false]
+     *        When `true`, the selection is added to other selected points.
+     *        When `false`, other selected points are deselected. Internally in
+     *        Highcharts, when
+     *        {@link http://api.highcharts.com/highcharts/plotOptions.series.allowPointSelect|allowPointSelect}
+     *        is `true`, selected points are accumulated on Control, Shift or
+     *        Cmd clicking the point.
+     *
+     * @fires Highcharts.Point#event:select
+     * @fires Highcharts.Point#event:unselect
      */
     select: function (selected, accumulate) {
         var point = this,
@@ -554,11 +616,12 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
 
                 /**
                  * Whether the point is selected or not.
+                 *
                  * @see Point#select
                  * @see Chart#getSelectedPoints
-                 * @memberof Point
-                 * @name selected
-                 * @type {Boolean}
+                 *
+                 * @name Highcharts.Point#selected
+                 * @type {boolean}
                  */
                 point.selected = point.options.selected = selected;
                 series.options.data[inArray(point, series.data)] =
@@ -588,7 +651,10 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
      * Runs on mouse over the point. Called internally from mouse and touch
      * events.
      *
-     * @param {Object} e The event arguments
+     * @function Highcharts.Point#onMouseOver
+     *
+     * @param {Highcharts.PointerEventObject} e
+     *        The event arguments.
      */
     onMouseOver: function (e) {
         var point = this,
@@ -605,6 +671,10 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
     /**
      * Runs on mouse out from the point. Called internally from mouse and touch
      * events.
+     *
+     * @function Highcharts.Point#onMouseOut
+     *
+     * @fires Highcharts.Point#event:mouseOut
      */
     onMouseOut: function () {
         var point = this,
@@ -621,6 +691,7 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
      * demand, to save processing time on hovering.
      *
      * @private
+     * @function Highcharts.Point#importEvents
      */
     importEvents: function () {
         if (!this.hasImportedEvents) {
@@ -640,9 +711,17 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
 
     /**
      * Set the point's state.
-     * @param  {String} [state]
-     *         The new state, can be one of `''` (an empty string), `hover` or
-     *         `select`.
+     *
+     * @function Highcharts.Point#setState
+     *
+     * @param {string} [state]
+     *        The new state, can be one of `''` (an empty string), `hover` or
+     *        `select`.
+     *
+     * @param {boolean} [move]
+     *        State for animation.
+     *
+     * @fires Highcharts.Point#event:afterSetState
      */
     setState: function (state, move) {
         var point = this,
@@ -819,9 +898,14 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
     /**
      * Get the path definition for the halo, which is usually a shadow-like
      * circle around the currently hovered point.
-     * @param  {Number} size
-     *         The radius of the circular halo.
-     * @return {Array} The path definition
+     *
+     * @function Highcharts.Point#haloPath
+     *
+     * @param {number} size
+     *        The radius of the circular halo.
+     *
+     * @return {Highcharts.SVGPathArray}
+     *         The path definition.
      */
     haloPath: function (size) {
         var series = this.series,
@@ -836,13 +920,15 @@ extend(Point.prototype, /** @lends Highcharts.Point.prototype */ {
     }
 });
 
-/*
- * Extend the Series object with interaction
- */
-
+// Extend the Series object with interaction
 extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
+
     /**
      * Runs on mouse over the series graphical items.
+     *
+     * @function Highcharts.Series#onMouseOver
+     *
+     * @fires Highcharts.Series#event:mouseOver
      */
     onMouseOver: function () {
         var series = this,
@@ -867,6 +953,10 @@ extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
 
     /**
      * Runs on mouse out of the series graphical items.
+     *
+     * @function Highcharts.Series#onMouseOut
+     *
+     * @fires Highcharts.Series#event:mouseOut
      */
     onMouseOut: function () {
         // trigger the event only if listeners exist
@@ -908,9 +998,10 @@ extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
      * operations, but it can also be called directly to visually
      * highlight a series.
      *
-     * @param  {String} [state]
-     *         Can be either `hover` or undefined to set to normal
-     *         state.
+     * @function Highcharts.Series#setState
+     *
+     * @param {string} [state]
+     *        Can be either `hover` or undefined to set to normal state.
      */
     setState: function (state) {
         var series = this,
@@ -946,19 +1037,26 @@ extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
             series.state = state;
 
             
+
         }
     },
 
     /**
      * Show or hide the series.
      *
-     * @param  {Boolean} [visible]
-     *         True to show the series, false to hide. If undefined, the
-     *         visibility is toggled.
-     * @param  {Boolean} [redraw=true]
-     *         Whether to redraw the chart after the series is altered. If doing
-     *         more operations on the chart, it is a good idea to set redraw to
-     *         false and call {@link Chart#redraw|chart.redraw()} after.
+     * @function Highcharts.Series#setVisible
+     *
+     * @param {boolean} [visible]
+     *        True to show the series, false to hide. If undefined, the
+     *        visibility is toggled.
+     *
+     * @param {boolean} [redraw=true]
+     *        Whether to redraw the chart after the series is altered. If doing
+     *        more operations on the chart, it is a good idea to set redraw to
+     *        false and call {@link Chart#redraw|chart.redraw()} after.
+     *
+     * @fires Highcharts.Series#event:hide
+     * @fires Highcharts.Series#event:show
      */
     setVisible: function (vis, redraw) {
         var series = this,
@@ -1036,6 +1134,10 @@ extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
      *
      * @sample highcharts/members/series-hide/
      *         Toggle visibility from a button
+     *
+     * @function Highcharts.Series#show
+     *
+     * @fires Highcharts.Series#event:show
      */
     show: function () {
         this.setVisible(true);
@@ -1049,6 +1151,10 @@ extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
      *
      * @sample highcharts/members/series-hide/
      *         Toggle visibility from a button
+     *
+     * @function Highcharts.Series#hide
+     *
+     * @fires Highcharts.Series#event:hide
      */
     hide: function () {
         this.setVisible(false);
@@ -1056,17 +1162,24 @@ extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
 
 
     /**
-     * Select or unselect the series. This means its {@link
-     * Highcharts.Series.selected|selected} property is set, the checkbox in the
-     * legend is toggled and when selected, the series is returned by the
-     * {@link Highcharts.Chart#getSelectedSeries} function.
-     *
-     * @param  {Boolean} [selected]
-     *         True to select the series, false to unselect. If undefined, the
-     *         selection state is toggled.
+     * Select or unselect the series. This means its
+     * {@link Highcharts.Series.selected|selected}
+     * property is set, the checkbox in the legend is toggled and when selected,
+     * the series is returned by the
+     * {@link Highcharts.Chart#getSelectedSeries}
+     * function.
      *
      * @sample highcharts/members/series-select/
      *         Select a series from a button
+     *
+     * @function Highcharts.Series#select
+     *
+     * @param {boolean} [selected]
+     *        True to select the series, false to unselect. If undefined, the
+     *        selection state is toggled.
+     *
+     * @fires Highcharts.Series#event:select
+     * @fires Highcharts.Series#event:unselect
      */
     select: function (selected) {
         var series = this;
@@ -1082,5 +1195,9 @@ extend(Series.prototype, /** @lends Highcharts.Series.prototype */ {
         fireEvent(series, selected ? 'select' : 'unselect');
     },
 
+    /**
+     * @private
+     * @borrows Highcharts.TrackerMixin.drawTrackerGraph as Highcharts.Series#drawTracker
+     */
     drawTracker: TrackerMixin.drawTrackerGraph
 });

package/js/es-modules/parts/Legend.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -316,8 +316,12 @@ Highcharts.Legend.prototype = {
                         left: (alignAttr.translateX + item.checkboxOffset +
                             checkbox.x - 20) + 'px',
                         top: top + 'px',
-                        display: top > translateY - 6 && top < translateY +
-                            clipHeight - 6 ? '' : 'none'
+                        display: this.proximate || (
+                            top > translateY - 6 &&
+                            top < translateY + clipHeight - 6
+                        ) ?
+                            '' :
+                            'none'
                     });
                 }
             }, this);

package/js/es-modules/parts/LogarithmicAxis.js

@@ -1,24 +1,39 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
+
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
+
 var Axis = H.Axis,
     getMagnitude = H.getMagnitude,
     map = H.map,
     normalizeTickInterval = H.normalizeTickInterval,
     pick = H.pick;
-/**
+
+/*
  * Methods defined on the Axis prototype
  */
 
 /**
- * Set the tick positions of a logarithmic axis
+ * Set the tick positions of a logarithmic axis.
+ *
+ * @private
+ * @function Highcharts.Axis#getLogTickPositions
+ *
+ * @param {number} interval
+ *
+ * @param {number} min
+ *
+ * @param {number} max
  *
- * @ignore
+ * @param {number} minor
+ *
+ * @return {Array<number>}
  */
 Axis.prototype.getLogTickPositions = function (interval, min, max, minor) {
     var axis = this,
@@ -129,10 +144,26 @@ Axis.prototype.getLogTickPositions = function (interval, min, max, minor) {
     return positions;
 };
 
+/**
+ * @private
+ * @function Highcharts.Axis#log2lin
+ *
+ * @param {number} num
+ *
+ * @return {number}
+ */
 Axis.prototype.log2lin = function (num) {
     return Math.log(num) / Math.LN10;
 };
 
+/**
+ * @private
+ * @function Highcharts.Axis#lin2log
+ *
+ * @param {number} num
+ *
+ * @return {number}
+ */
 Axis.prototype.lin2log = function (num) {
     return Math.pow(10, num);
 };

package/js/es-modules/parts/MSPointer.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */