highcharts 6.1.1 → 6.2.0

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

@@ -1,28 +1,39 @@
 /**
- * (c) 2010-2017 Torstein Honsi
+ * (c) 2010-2018 Torstein Honsi
  *
  * License: www.highcharts.com/license
  */
+
+/**
+ * A valid color to be parsed and handled by Highcharts. Highcharts internally
+ * supports hex colors like `#ffffff`, rgb colors like `rgb(255,255,255)` and
+ * rgba colors like `rgba(255,255,255,1)`. Other colors may be supported by the
+ * browsers and displayed correctly, but Highcharts is not able to process them
+ * and apply concepts like opacity and brightening.
+ *
+ * @typedef {string} Highcharts.ColorString
+ */
+
 'use strict';
+
 import H from './Globals.js';
 import './Utilities.js';
+
 var each = H.each,
     isNumber = H.isNumber,
     map = H.map,
     merge = H.merge,
     pInt = H.pInt;
 
-/**
- * @typedef {string} ColorString
- * A valid color to be parsed and handled by Highcharts. Highcharts internally
- * supports hex colors like `#ffffff`, rgb colors like `rgb(255,255,255)` and
- * rgba colors like `rgba(255,255,255,1)`. Other colors may be supported by the
- * browsers and displayed correctly, but Highcharts is not able to process them
- * and apply concepts like opacity and brightening.
- */
 /**
  * Handle color operations. The object methods are chainable.
- * @param {String} input The input color in either rbga or hex format
+ *
+ * @private
+ * @class
+ * @name Highcharts.Color
+ *
+ * @param {Highcharts.ColorString} input
+ *        The input color in either rbga or hex format
  */
 H.Color = function (input) {
     // Backwards compatibility, allow instanciation without new
@@ -59,14 +70,18 @@ H.Color.prototype = {
     // Collection of named colors. Can be extended from the outside by adding
     // colors to Highcharts.Color.prototype.names.
     names: {
-        none: 'rgba(255,255,255,0)',
         white: '#ffffff',
         black: '#000000'
     },
 
     /**
      * Parse the input color to rgba array
-     * @param {String} input
+     *
+     * @private
+     * @function Highcharts.Color#init
+     *
+     * @param {Highcharts.ColorString} input
+     *        The input color in either rbga or hex format
      */
     init: function (input) {
         var result,
@@ -136,8 +151,15 @@ H.Color.prototype = {
     },
 
     /**
-     * Return the color a specified format
-     * @param {String} format
+     * Return the color in the specified format
+     *
+     * @function Highcharts.Color#get
+     *
+     * @param {string} format
+     *        Possible values are 'a', 'rgb', undefined
+     *
+     * @return {Highcharts.ColorString}
+     *         This color as a string.
      */
     get: function (format) {
         var input = this.input,
@@ -167,8 +189,15 @@ H.Color.prototype = {
     },
 
     /**
-     * Brighten the color
-     * @param {Number} alpha
+     * Brighten the color instance.
+     *
+     * @function Highcharts.Color#brighten
+     *
+     * @param {number} alpha
+     *        The alpha value.
+     *
+     * @return {Highcharts.ColorString}
+     *         This color with modifications.
      */
     brighten: function (alpha) {
         var i,
@@ -195,24 +224,34 @@ H.Color.prototype = {
     },
 
     /**
-     * Set the color's opacity to a given alpha value
-     * @param {Number} alpha
+     * Set the color's opacity to a given alpha value.
+     *
+     * @function Highcharts.Color#setOpacity
+     *
+     * @param {number} alpha
+     *        Opacity between 0 and 1.
+     *
+     * @return {Highcharts.ColorString}
+     *         Color with modifications.
      */
     setOpacity: function (alpha) {
         this.rgba[3] = alpha;
         return this;
     },
 
-    /*
+    /**
      * Return an intermediate color between two colors.
      *
-     * @param  {Highcharts.Color} to
-     *         The color object to tween to.
-     * @param  {Number} pos
-     *         The intermediate position, where 0 is the from color (current
-     *         color item), and 1 is the `to` color.
+     * @function Highcharts.Color#tweenTo
+     *
+     * @param {Highcharts.Color} to
+     *        The color object to tween to.
+     *
+     * @param {number} pos
+     *        The intermediate position, where 0 is the from color (current
+     *        color item), and 1 is the `to` color.
      *
-     * @return {String}
+     * @return {Highcharts.ColorString}
      *         The intermediate color in rgba notation.
      */
     tweenTo: function (to, pos) {
@@ -249,6 +288,16 @@ H.Color.prototype = {
         return ret;
     }
 };
+
+/**
+ * Creates a color instance out of a color string.
+ *
+ * @private
+ * @function Highcharts.color
+ *
+ * @param {Highcharts.ColorString} input
+ *        The input color in either rbga or hex format
+ */
 H.color = function (input) {
     return new H.Color(input);
 };