highcharts 6.1.1 → 6.2.0

package/es-modules/parts/Responsive.js

@@ -1,12 +1,25 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
+
+/**
+ * A callback function to gain complete control on when the responsive rule
+ * applies.
+ *
+ * @callback Highcharts.ResponsiveCallbackFunction
+ *
+ * @return {boolean}
+ *         Return `true` if it applies.
+ */
+
 'use strict';
+
 import H from './Globals.js';
 import './Chart.js';
 import './Utilities.js';
+
 var Chart = H.Chart,
     each = H.each,
     inArray = H.inArray,
@@ -15,16 +28,20 @@ var Chart = H.Chart,
     pick = H.pick,
     splat = H.splat;
 
-
 /**
  * Allows setting a set of rules to apply for different screen or chart
  * sizes. Each rule specifies additional chart options.
  *
- * @sample {highstock} stock/demo/responsive/ Stock chart
- * @sample highcharts/responsive/axis/ Axis
- * @sample highcharts/responsive/legend/ Legend
- * @sample highcharts/responsive/classname/ Class name
- * @since 5.0.0
+ * @sample {highstock} stock/demo/responsive/
+ *         Stock chart
+ * @sample highcharts/responsive/axis/
+ *         Axis
+ * @sample highcharts/responsive/legend/
+ *         Legend
+ * @sample highcharts/responsive/classname/
+ *         Class name
+ *
+ * @since     5.0.0
  * @apioption responsive
  */
 
@@ -32,11 +49,15 @@ var Chart = H.Chart,
  * A set of rules for responsive settings. The rules are executed from
  * the top down.
  *
- * @type {Array<Object>}
- * @sample {highcharts} highcharts/responsive/axis/ Axis changes
- * @sample {highstock} highcharts/responsive/axis/ Axis changes
- * @sample {highmaps} highcharts/responsive/axis/ Axis changes
- * @since 5.0.0
+ * @sample {highcharts} highcharts/responsive/axis/
+ *         Axis changes
+ * @sample {highstock} highcharts/responsive/axis/
+ *         Axis changes
+ * @sample {highmaps} highcharts/responsive/axis/
+ *         Axis changes
+ *
+ * @type      {Array<*>}
+ * @since     5.0.0
  * @apioption responsive.rules
  */
 
@@ -53,20 +74,24 @@ var Chart = H.Chart,
  * with two series items without an `id`, will cause the existing chart's
  * two series to be updated with respective options.
  *
- * @type {Object}
- * @sample {highstock} stock/demo/responsive/ Stock chart
- * @sample highcharts/responsive/axis/ Axis
- * @sample highcharts/responsive/legend/ Legend
- * @sample highcharts/responsive/classname/ Class name
- * @since 5.0.0
+ * @sample {highstock} stock/demo/responsive/
+ *         Stock chart
+ * @sample highcharts/responsive/axis/
+ *         Axis
+ * @sample highcharts/responsive/legend/
+ *         Legend
+ * @sample highcharts/responsive/classname/
+ *         Class name
+ *
+ * @type      {Highcharts.Options}
+ * @since     5.0.0
  * @apioption responsive.rules.chartOptions
  */
 
 /**
  * Under which conditions the rule applies.
  *
- * @type {Object}
- * @since 5.0.0
+ * @since     5.0.0
  * @apioption responsive.rules.condition
  */
 
@@ -76,50 +101,57 @@ var Chart = H.Chart,
  * against other metrics than the chart size, or example the document
  * size or other elements.
  *
- * @type {Function}
- * @context Chart
- * @since 5.0.0
+ * @type      {Highcharts.ResponsiveCallbackFunction}
+ * @since     5.0.0
+ * @context   Highcharts.Chart
  * @apioption responsive.rules.condition.callback
  */
 
 /**
  * The responsive rule applies if the chart height is less than this.
  *
- * @type {Number}
- * @since 5.0.0
+ * @type      {number}
+ * @since     5.0.0
  * @apioption responsive.rules.condition.maxHeight
  */
 
 /**
  * The responsive rule applies if the chart width is less than this.
  *
- * @type {Number}
- * @sample highcharts/responsive/axis/ Max width is 500
- * @since 5.0.0
+ * @sample highcharts/responsive/axis/
+ *         Max width is 500
+ *
+ * @type      {number}
+ * @since     5.0.0
  * @apioption responsive.rules.condition.maxWidth
  */
 
 /**
  * The responsive rule applies if the chart height is greater than this.
  *
- * @type {Number}
- * @default 0
- * @since 5.0.0
+ * @type      {number}
+ * @default   0
+ * @since     5.0.0
  * @apioption responsive.rules.condition.minHeight
  */
 
 /**
  * The responsive rule applies if the chart width is greater than this.
  *
- * @type {Number}
- * @default 0
- * @since 5.0.0
+ * @type      {number}
+ * @default   0
+ * @since     5.0.0
  * @apioption responsive.rules.condition.minWidth
  */
 
 /**
  * Update the chart based on the current chart/document size and options for
  * responsiveness.
+ *
+ * @private
+ * @function Highcharts.Chart#setResponsive
+ *
+ * @param {boolean} [redraw=true]
  */
 Chart.prototype.setResponsive = function (redraw) {
     var options = this.options.responsive,
@@ -175,9 +207,17 @@ Chart.prototype.setResponsive = function (redraw) {
 };
 
 /**
- * Handle a single responsiveness rule
+ * Handle a single responsiveness rule.
+ *
+ * @private
+ * @function Highcharts.Chart#matchResponsiveRule
+ *
+ * @param {Highcharts.ResponsiveRulesConditionOptions} rule
+ *
+ * @param {Array<number>} matches
  */
 Chart.prototype.matchResponsiveRule = function (rule, matches) {
+
     var condition = rule.condition,
         fn = condition.callback || function () {
             return (
@@ -192,13 +232,19 @@ Chart.prototype.matchResponsiveRule = function (rule, matches) {
     if (fn.call(this)) {
         matches.push(rule._id);
     }
-
 };
 
 /**
  * Get the current values for a given set of options. Used before we update
  * the chart with a new responsiveness rule.
  * TODO: Restore axis options (by id?)
+ *
+ * @private
+ * @function Highcharts.Chart#currentOptions
+ *
+ * @param {Highcharts.Options} options
+ *
+ * @return {Highcharts.Options}
  */
 Chart.prototype.currentOptions = function (options) {
 

package/es-modules/parts/ScatterSeries.js

@@ -1,42 +1,60 @@
 /**
- * (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 './Options.js';
 import './Series.js';
+
 var Series = H.Series,
     seriesType = H.seriesType;
 
 /**
- * A scatter plot uses cartesian coordinates to display values for two variables
- * for a set of data.
+ * Scatter series type.
+ *
+ * @private
+ * @class
+ * @name Highcharts.seriesTypes.scatter
+ *
+ * @augments Highcharts.Series
+ */
+seriesType('scatter', 'line'
+
+/**
+ * A scatter plot uses cartesian coordinates to display values for two
+ * variables for a set of data.
  *
- * @sample       {highcharts} highcharts/demo/scatter/
- *               Scatter plot
- * @extends      {plotOptions.line}
+ * @sample {highcharts} highcharts/demo/scatter/
+ *         Scatter plot
+ *
+ * @extends      plotOptions.line
  * @excluding    pointPlacement, shadow
  * @product      highcharts highstock
  * @optionparent plotOptions.scatter
  */
-seriesType('scatter', 'line', {
+, {
 
     /**
      * The width of the line connecting the data points.
      *
-     * @sample  {highcharts} highcharts/plotoptions/scatter-linewidth-none/
-     *          0 by default
-     * @sample  {highcharts} highcharts/plotoptions/scatter-linewidth-1/
-     *          1px
+     * @sample {highcharts} highcharts/plotoptions/scatter-linewidth-none/
+     *         0 by default
+     * @sample {highcharts} highcharts/plotoptions/scatter-linewidth-1/
+     *         1px
+     *
      * @product highcharts highstock
      */
     lineWidth: 0,
 
     findNearestPointBy: 'xy',
+
     marker: {
+
         enabled: true // Overrides auto-enabling in line series (#3647)
     },
 
@@ -49,7 +67,7 @@ seriesType('scatter', 'line', {
      * is false and `tooltip.shared` is false, the tooltip will be hidden
      * when moving the mouse between series.
      *
-     * @type      {Boolean}
+     * @type      {boolean}
      * @default   false
      * @product   highcharts highstock
      * @apioption plotOptions.scatter.stickyTracking
@@ -66,12 +84,21 @@ seriesType('scatter', 'line', {
      * @product highcharts highstock
      */
     tooltip: {
+
         
+
+        /**
+         * @default ● {series.name}
+         */
         headerFormat:
             '<span style="color:{point.color}">\u25CF</span> ' +
             '<span style="font-size: 0.85em"> {series.name}</span><br/>',
+
         
 
+        /**
+         * @default x: {point.x} y: {point.y}
+         */
         pointFormat: 'x: <b>{point.x}</b><br/>y: <b>{point.y}</b><br/>'
     }
 
@@ -82,6 +109,11 @@ seriesType('scatter', 'line', {
     noSharedTooltip: true,
     trackerGroups: ['group', 'markerGroup', 'dataLabelsGroup'],
     takeOrdinalPosition: false, // #2342
+
+    /**
+     * @private
+     * @function Highcharts.seriesTypes.scatter#drawGraph
+     */
     drawGraph: function () {
         if (this.options.lineWidth) {
             Series.prototype.drawGraph.call(this);
@@ -93,9 +125,8 @@ seriesType('scatter', 'line', {
  * A `scatter` series. If the [type](#series.scatter.type) option is
  * not specified, it is inherited from [chart.type](#chart.type).
  *
- * @type      {Object}
  * @extends   series,plotOptions.scatter
- * @excluding dataParser,dataURL
+ * @excluding dataParser, dataURL
  * @product   highcharts highstock
  * @apioption series.scatter
  */
@@ -126,8 +157,8 @@ seriesType('scatter', 'line', {
  *     ]
  *  ```
  *
- * 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.scatter.turboThreshold),
  * this option is not available.
  *
@@ -145,18 +176,19 @@ seriesType('scatter', 'line', {
  *     }]
  *  ```
  *
- * @type      {Array<Object|Array|Number>}
+ * @sample {highcharts} highcharts/chart/reflow-true/
+ *         Numerical values
+ * @sample {highcharts} highcharts/series/data-array-of-arrays/
+ *         Arrays of numeric x and y
+ * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
+ *         Arrays of datetime x and y
+ * @sample {highcharts} highcharts/series/data-array-of-name-value/
+ *         Arrays of point.name and y
+ * @sample {highcharts} highcharts/series/data-array-of-objects/
+ *         Config objects
+ *
+ * @type      {Array<number|Array<number>|*>}
  * @extends   series.line.data
- * @sample    {highcharts} highcharts/chart/reflow-true/
- *            Numerical values
- * @sample    {highcharts} highcharts/series/data-array-of-arrays/
- *            Arrays of numeric x and y
- * @sample    {highcharts} highcharts/series/data-array-of-arrays-datetime/
- *            Arrays of datetime x and y
- * @sample    {highcharts} highcharts/series/data-array-of-name-value/
- *            Arrays of point.name and y
- * @sample    {highcharts} highcharts/series/data-array-of-objects/
- *            Config objects
  * @product   highcharts highstock
  * @apioption series.scatter.data
  */

package/es-modules/parts/ScrollablePlotArea.js

@@ -6,7 +6,9 @@
  * Highcharts feature to make the Y axis stay fixed when scrolling the chart
  * horizontally on mobile devices. Supports left and right side axes.
  */
+
 'use strict';
+
 import H from './Globals.js';
 
 var addEvent = H.addEvent,
@@ -20,11 +22,11 @@ var addEvent = H.addEvent,
  * This scrollbar provides smooth scrolling for the contents of the plot area,
  * whereas the title, legend and axes are fixed.
  *
- * @type    {Object}
- * @sample  {highcharts} highcharts/chart/scrollable-plotarea
- *          Scrollable plot area
- * @since   6.1.0
- * @product highcharts
+ * @sample {highcharts} highcharts/chart/scrollable-plotarea
+ *         Scrollable plot area
+ *
+ * @since     6.1.0
+ * @product   highcharts gantt
  * @apioption chart.scrollablePlotArea
  */
 
@@ -32,7 +34,7 @@ var addEvent = H.addEvent,
  * The minimum width for the plot area. If it gets smaller than this, the plot
  * area will become scrollable.
  *
- * @type    {Number}
+ * @type      {number}
  * @apioption chart.scrollablePlotArea.minWidth
  */
 
@@ -41,7 +43,7 @@ var addEvent = H.addEvent,
  * 1, where 0 aligns the plot area to the left and 1 aligns it to the right.
  * Typically we would use 1 if the chart has right aligned Y axes.
  *
- * @type    {Number}
+ * @type      {number}
  * @apioption chart.scrollablePlotArea.scrollPositionX
  */
 
@@ -105,6 +107,10 @@ addEvent(Chart, 'render', function () {
     }
 });
 
+/**
+ * @private
+ * @function Highcharts.Chart#setUpScrolling
+ */
 Chart.prototype.setUpScrolling = function () {
 
     // Add the necessary divs to provide scrolling
@@ -126,6 +132,10 @@ Chart.prototype.setUpScrolling = function () {
     this.setUpScrolling = null;
 };
 
+/**
+ * @private
+ * @function Highcharts.Chart#applyFixed
+ */
 Chart.prototype.applyFixed = function () {
     var container = this.container,
         fixedRenderer,
@@ -171,6 +181,8 @@ Chart.prototype.applyFixed = function () {
             .addClass('highcharts-scrollable-mask')
             .add();
 
+        // These elements are moved over to the fixed renderer and stay fixed
+        // when the user scrolls the chart.
         H.each([
             this.inverted ?
                 '.highcharts-xaxis' :
@@ -182,27 +194,36 @@ Chart.prototype.applyFixed = function () {
             '.highcharts-credits',
             '.highcharts-legend',
             '.highcharts-subtitle',
-            '.highcharts-title'
+            '.highcharts-title',
+            '.highcharts-legend-checkbox'
         ], function (className) {
             H.each(container.querySelectorAll(className), function (elem) {
-                fixedRenderer.box.appendChild(elem);
+                (
+                    elem.namespaceURI === fixedRenderer.SVG_NS ?
+                        fixedRenderer.box :
+                        fixedRenderer.box.parentNode
+                ).appendChild(elem);
                 elem.style.pointerEvents = 'auto';
             });
         });
     }
 
+    // Set the size of the fixed renderer to the visible width
     this.fixedRenderer.setSize(
         this.chartWidth,
         this.chartHeight
     );
 
+    // Increase the size of the scrollable renderer and background
     scrollableWidth = this.chartWidth + this.scrollablePixels;
+    H.stop(this.container);
     this.container.style.width = scrollableWidth + 'px';
     this.renderer.boxWrapper.attr({
         width: scrollableWidth,
         height: this.chartHeight,
         viewBox: [0, 0, scrollableWidth, this.chartHeight].join(' ')
     });
+    this.chartBackground.attr({ width: scrollableWidth });
 
     // Set scroll position
     if (firstTime) {