highcharts 6.1.1 → 6.2.0

package/js/es-modules/parts-map/Map.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -40,10 +40,12 @@ defaultOptions.mapNavigation = {
      * can be given from the [mapNavigation.buttons](#mapNavigation.buttons)
      * option set.
      *
-     * @type {Object}
      * @sample {highmaps} maps/mapnavigation/button-theme/
      *         Theming the navigation buttons
-     * @product highmaps
+     *
+     * @type       {*}
+     * @product    highmaps
+     * @apioption  mapNavigation.buttonOptions
      */
     buttonOptions: {
 
@@ -51,20 +53,22 @@ defaultOptions.mapNavigation = {
          * What box to align the buttons to. Possible values are `plotBox`
          * and `spacingBox`.
          *
+         * @type       {string}
+         * @default    plotBox
+         * @product    highmaps
          * @validvalue ["plotBox", "spacingBox"]
-         * @type {String}
-         * @default plotBox
-         * @product highmaps
+         * @apioption  mapNavigation.buttonOptions.alignTo
          */
         alignTo: 'plotBox',
 
         /**
          * The alignment of the navigation buttons.
          *
+         * @type       {string}
+         * @default    left
+         * @product    highmaps
          * @validvalue ["left", "center", "right"]
-         * @type {String}
-         * @default left
-         * @product highmaps
+         * @apioption  mapNavigation.buttonOptions.align
          */
         align: 'left',
 
@@ -72,49 +76,55 @@ defaultOptions.mapNavigation = {
          * The vertical alignment of the buttons. Individual alignment can
          * be adjusted by each button's `y` offset.
          *
+         * @type       {string}
+         * @default    bottom
+         * @product    highmaps
          * @validvalue ["top", "middle", "bottom"]
-         * @type {String}
-         * @default bottom
-         * @product highmaps
+         * @apioption  mapNavigation.buttonOptions.verticalAlign
          */
         verticalAlign: 'top',
 
         /**
          * The X offset of the buttons relative to its `align` setting.
          *
-         * @type {Number}
-         * @default 0
-         * @product highmaps
+         * @type       {number}
+         * @default    0
+         * @product    highmaps
+         * @apioption  mapNavigation.buttonOptions.x
          */
         x: 0,
 
         /**
          * The width of the map navigation buttons.
          *
-         * @type {Number}
-         * @default 18
-         * @product highmaps
+         * @type       {number}
+         * @default    18
+         * @product    highmaps
+         * @apioption  mapNavigation.buttonOptions.width
          */
         width: 18,
 
         /**
          * The pixel height of the map navigation buttons.
          *
-         * @type {Number}
-         * @default 18
-         * @product highmaps
+         * @type       {number}
+         * @default    18
+         * @product    highmaps
+         * @apioption  mapNavigation.buttonOptions.height
          */
         height: 18,
 
         /**
          * Padding for the navigation buttons.
          *
-         * @type {Number}
-         * @default 5
-         * @since 5.0.0
-         * @product highmaps
+         * @type       {number}
+         * @default    5
+         * @since      5.0.0
+         * @product    highmaps
+         * @apioption  mapNavigation.buttonOptions.padding
          */
         padding: 5
+
         
     },
 
@@ -126,8 +136,9 @@ defaultOptions.mapNavigation = {
      * individual options can be overridden. But default, the `onclick`, `text`
      * and `y` options are individual.
      *
-     * @type {Object}
-     * @product highmaps
+     * @type        {*}
+     * @product     highmaps
+     * @apioptions  mapNavigation.buttons
      */
     buttons: {
 
@@ -138,9 +149,10 @@ defaultOptions.mapNavigation = {
          * individual options can be overridden. By default, the `onclick`,
          * `text` and `y` options are individual.
          *
-         * @type {Object}
-         * @extends mapNavigation.buttonOptions
-         * @product highmaps
+         * @type        {*}
+         * @extends     mapNavigation.buttonOptions
+         * @product     highmaps
+         * @apioptions  mapNavigation.buttons.zoomIn
          */
         zoomIn: {
 
@@ -186,9 +198,10 @@ defaultOptions.mapNavigation = {
          * individual options can be overridden. By default, the `onclick`,
          * `text` and `y` options are individual.
          *
-         * @type {Object}
-         * @extends mapNavigation.buttonOptions
-         * @product highmaps
+         * @type        {*}
+         * @extends     mapNavigation.buttonOptions
+         * @product     highmaps
+         * @apioptions  mapNavigation.buttons.zoomOut
          */
         zoomOut: {
 
@@ -228,14 +241,83 @@ defaultOptions.mapNavigation = {
         }
     },
 
+    /**
+     * Whether to enable navigation buttons. By default it inherits the
+     * [enabled](#mapNavigation.enabled) setting.
+     *
+     * @type       {boolean}
+     * @product    highmaps
+     * @apioption  mapNavigation.enableButtons
+     */
+
+    /**
+     * Whether to enable map navigation. The default is not to enable
+     * navigation, as many choropleth maps are simple and don't need it.
+     * Additionally, when touch zoom and mousewheel zoom is enabled, it breaks
+     * the default behaviour of these interactions in the website, and the
+     * implementer should be aware of this.
+     *
+     * Individual interactions can be enabled separately, namely buttons,
+     * multitouch zoom, double click zoom, double click zoom to element and
+     * mousewheel zoom.
+     *
+     * @type       {boolean}
+     * @default    false
+     * @product    highmaps
+     * @apioption  mapNavigation.enabled
+     */
+
+    /**
+     * Enables zooming in on an area on double clicking in the map. By default
+     * it inherits the [enabled](#mapNavigation.enabled) setting.
+     *
+     * @type       {boolean}
+     * @product    highmaps
+     * @apioption  mapNavigation.enableDoubleClickZoom
+     */
+
+    /**
+     * Whether to zoom in on an area when that area is double clicked.
+     *
+     * @sample {highmaps} maps/mapnavigation/doubleclickzoomto/
+     *         Enable double click zoom to
+     *
+     * @type       {boolean}
+     * @default    false
+     * @product    highmaps
+     * @apioption  mapNavigation.enableDoubleClickZoomTo
+     */
+
+    /**
+     * Enables zooming by mouse wheel. By default it inherits the [enabled](
+     * #mapNavigation.enabled) setting.
+     *
+     * @type       {boolean}
+     * @product    highmaps
+     * @apioption  mapNavigation.enableMouseWheelZoom
+     */
+
+    /**
+     * Whether to enable multitouch zooming. Note that if the chart covers the
+     * viewport, this prevents the user from using multitouch and touchdrag on
+     * the web page, so you should make sure the user is not trapped inside the
+     * chart. By default it inherits the [enabled](#mapNavigation.enabled)
+     * setting.
+     *
+     * @type       {boolean}
+     * @product    highmaps
+     * @apioption  mapNavigation.enableTouchZoom
+     */
+
     /**
      * Sensitivity of mouse wheel or trackpad scrolling. 1 is no sensitivity,
-     *  while with 2, one mousewheel delta will zoom in 50%.
+     * while with 2, one mousewheel delta will zoom in 50%.
      *
-     * @type {Number}
-     * @default 1.1
-     * @since 4.2.4
-     * @product highmaps
+     * @type       {number}
+     * @default    1.1
+     * @since      4.2.4
+     * @product    highmaps
+     * @apioption  mapNavigation.mouseWheelSensitivity
      */
     mouseWheelSensitivity: 1.1
     // enabled: false,
@@ -248,6 +330,12 @@ defaultOptions.mapNavigation = {
 
 /**
  * Utility for reading SVG paths directly.
+ *
+ * @function Highcharts.splitPath
+ *
+ * @param  {string} path
+ *
+ * @return {Array<number|string>}
  */
 H.splitPath = function (path) {
     var i;
@@ -334,17 +422,18 @@ if (Renderer === VMLRenderer) {
 
 
 /**
- * The factory function for creating new map charts. Creates a new {@link
- * Chart|Chart} object with different default options than the basic Chart.
+ * The factory function for creating new map charts. Creates a new {@link Chart|
+ * Chart} object with different default options than the basic Chart.
  *
- * @function #mapChart
- * @memberof Highcharts
+ * @function Highcharts.mapChart
  *
- * @param  {String|HTMLDOMElement} renderTo
+ * @param  {string|Highcharts.HTMLDOMElement} [renderTo]
  *         The DOM element to render to, or its id.
- * @param  {Options} options
+ *
+ * @param  {Highcharts.Options} options
  *         The chart options structure as described in the {@link
  *         https://api.highcharts.com/highstock|options reference}.
+ *
  * @param  {Function} callback
  *         A function to execute when the chart object is finished loading and
  *         rendering. In most cases the chart is built in one thread, but in
@@ -353,10 +442,10 @@ if (Renderer === VMLRenderer) {
  *         chart object will not be finished synchronously. As a consequence,
  *         code that relies on the newly built Chart object should always run in
  *         the callback. Defining a
- *         {@link https://api.highcharts.com/highstock/chart.events.load|chart.event.load}
- *         handler is equivalent.
+ *         {@link https://api.highcharts.com/highstock/chart.events.load|
+ *         chart.event.load} handler is equivalent.
  *
- * @return {Chart}
+ * @return {Highcharts.Chart}
  *         The chart object.
  */
 H.Map = H.mapChart = function (a, b, c) {

package/js/es-modules/parts-map/MapAxis.js

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

package/js/es-modules/parts-map/MapBubbleSeries.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -23,7 +23,7 @@ if (seriesTypes.bubble) {
      *
      * @sample maps/demo/map-bubble/ Map bubble chart
      *
-     * @extends {plotOptions.bubble}
+     * @extends plotOptions.bubble
      * @product highmaps
      * @optionparent plotOptions.mapbubble
      */
@@ -219,9 +219,10 @@ if (seriesTypes.bubble) {
  *  data: [0, 5, 3, 5]
  *  ```
  *
- * 2.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data points
- * exceeds the series' [turboThreshold](#series.mapbubble.turboThreshold),
+ * 2.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
+ * points exceeds the series' [turboThreshold](
+ * #series.mapbubble.turboThreshold),
  * this option is not available.
  *
  *  ```js

package/js/es-modules/parts-map/MapLineSeries.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -16,7 +16,7 @@ var seriesType = H.seriesType,
  * freeform drawing, like dividers, in the map.
  *
  * @sample maps/demo/mapline-mappoint/ Mapline and map-point chart
- * @extends {plotOptions.map}
+ * @extends plotOptions.map
  * @product highmaps
  * @optionparent plotOptions.mapline
  */
@@ -63,8 +63,8 @@ seriesType('mapline', 'map', {
  *     ]
  *  ```
  *
- * 3.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 3.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.map.turboThreshold),
  * this option is not available.
  *

package/js/es-modules/parts-map/MapNavigation.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -30,7 +30,11 @@ function stopEvent(e) {
 /**
  * The MapNavigation handles buttons for navigation in addition to mousewheel
  * and doubleclick handlers for chart zooming.
- * @param {Chart} chart The Chart instance.
+ *
+ * @class Highcharts.MapNavigation
+ *
+ * @param {Highcharts.Chart} chart
+ *        The Chart instance.
  */
 function MapNavigation(chart) {
     this.init(chart);
@@ -38,7 +42,13 @@ function MapNavigation(chart) {
 
 /**
  * Initiator function.
- * @param  {Chart} chart The Chart instance.
+ *
+ * @function Highcharts.MapNavigation#init
+ *
+ * @param  {Highcharts.Chart} chart
+ *         The Chart instance.
+ *
+ * @return {void}
  */
 MapNavigation.prototype.init = function (chart) {
     this.chart = chart;
@@ -48,7 +58,13 @@ MapNavigation.prototype.init = function (chart) {
 /**
  * Update the map navigation with new options. Calling this is the same as
  * calling `chart.update({ mapNavigation: {} })`.
- * @param  {Object} options New options for the map navigation.
+ *
+ * @function Highcharts.MapNavigation#update
+ *
+ * @param  {Highcharts.MapNavigationOptions} options
+ *         New options for the map navigation.
+ *
+ * @return {void}
  */
 MapNavigation.prototype.update = function (options) {
     var chart = this.chart,
@@ -126,7 +142,13 @@ MapNavigation.prototype.update = function (options) {
 /**
  * Update events, called internally from the update function. Add new event
  * handlers, or unbinds events if disabled.
- * @param  {Object} options Options for map navigation.
+ *
+ * @function Highcharts.MapNavigation#updateEvents
+ *
+ * @param  {Highcharts.MapNavigationOptions} options
+ *         Options for map navigation.
+ *
+ * @return {void}
  */
 MapNavigation.prototype.updateEvents = function (options) {
     var chart = this.chart;
@@ -177,7 +199,15 @@ extend(Chart.prototype, /** @lends Chart.prototype */ {
      * within the outer. This is a pattern that occurs more places in
      * Highcharts, perhaps it should be elevated to a common utility function.
      *
-     * @private
+     * @ignore
+     * @function Highcharts.Chart#fitToBox
+     *
+     * @param  {Highcharts.BBoxObject} inner
+     *
+     * @param  {Highcharts.BBoxObject} outer
+     *
+     * @return {Highcharts.BBoxObject}
+     *         The inner box
      */
     fitToBox: function (inner, outer) {
         each([['x', 'width'], ['y', 'height']], function (dim) {
@@ -210,20 +240,28 @@ extend(Chart.prototype, /** @lends Chart.prototype */ {
      * See {@link Chart#fromLatLonToPoint} for how to get the `centerX` and
      * `centerY` parameters for a geographic location.
      *
-     * @param  {Number} [howMuch]
+     * @function Highcharts.Chart#mapZoom
+     *
+     * @param  {number|undefined} [howMuch]
      *         How much to zoom the map. Values less than 1 zooms in. 0.5 zooms
      *         in to half the current view. 2 zooms to twice the current view.
      *         If omitted, the zoom is reset.
-     * @param  {Number} [centerX]
+     *
+     * @param  {number|undefined} [centerX]
      *         The X axis position to center around if available space.
-     * @param  {Number} [centerY]
+     *
+     * @param  {number|undefined} [centerY]
      *         The Y axis position to center around if available space.
-     * @param  {Number} [mouseX]
+     *
+     * @param  {number|undefined} [mouseX]
      *         Fix the zoom to this position if possible. This is used for
      *         example in mousewheel events, where the area under the mouse
      *         should be fixed as we zoom in.
-     * @param  {Number} [mouseY]
+     *
+     * @param  {number|undefined} [mouseY]
      *         Fix the zoom to this position if possible.
+     *
+     * @return {void}
      */
     mapZoom: function (howMuch, centerXArg, centerYArg, mouseX, mouseY) {
         var chart = this,
@@ -299,7 +337,7 @@ extend(Chart.prototype, /** @lends Chart.prototype */ {
     }
 });
 
-/**
+/*
  * Extend the Chart.render method to add zooming and panning
  */
 addEvent(Chart, 'beforeRender', function () {

package/js/es-modules/parts-map/MapPointSeries.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -97,8 +97,8 @@ seriesType('mappoint', 'scatter', {
  *     ]
  *  ```
  *
- * 3.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 3.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.mappoint.turboThreshold),
  * this option is not available.
  *

package/js/es-modules/parts-map/MapPointer.js

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

package/js/es-modules/parts-map/MapSeries.js

@@ -1,5 +1,5 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
@@ -33,8 +33,8 @@ var colorPointMixin = H.colorPointMixin,
  * The map series is used for basic choropleth maps, where each map area has a
  * color based on its value.
  *
- * @sample maps/demo/base/ Choropleth map
- * @extends {plotOptions.scatter}
+ * @sample maps/demo/all-maps/ Choropleth map
+ * @extends plotOptions.scatter
  * @excluding marker
  * @product highmaps
  * @optionparent plotOptions.map
@@ -1072,8 +1072,8 @@ seriesType('map', 'scatter', {
  *     ]
  *  ```
  *
- * 3.  An array of objects with named values. The objects are point
- * configuration objects as seen below. If the total number of data
+ * 3.  An array of objects with named values. The following snippet shows only a
+ * few settings, see the complete options set below. If the total number of data
  * points exceeds the series' [turboThreshold](#series.map.turboThreshold),
  * this option is not available.
  *