funnel.js in highcharts-rails-5.0.13

- old
+ new

@@ -1,7 +1,7 @@
 /**
- * @license Highcharts JS v5.0.12 (2017-05-24)
+ * @license Highcharts JS v5.0.13 (2017-07-27)
  * Highcharts funnel module
  *
  * (c) 2010-2017 Torstein Honsi
  *
  * License: www.highcharts.com/license
@@ -30,31 +30,131 @@
             noop = Highcharts.noop,
             pick = Highcharts.pick,
             each = Highcharts.each;
 
 
-        seriesType('funnel', 'pie', {
+        seriesType('funnel', 'pie',
+            /**
+             * Funnel charts are a type of chart often used to visualize stages in a sales 
+             * project, where the top are the initial stages with the most clients. 
+             * It requires that the modules/funnel.js file is loaded.
+             *
+             * @sample highcharts/demo/funnel/ Funnel demo
+             * @extends {plotOptions.pie}
+             * @optionparent plotOptions.funnel
+             */
+            {
+
+                /**
+                 */
                 animation: false,
+
+                /**
+                 * The center of the series. By default, it is centered in the middle
+                 * of the plot area, so it fills the plot area height.
+                 * 
+                 * @type {Array<String|Number>}
+                 * @default ["50%", "50%"]
+                 * @since 3.0
+                 * @product highcharts
+                 */
                 center: ['50%', '50%'],
+
+                /**
+                 * The width of the funnel compared to the width of the plot area,
+                 * or the pixel width if it is a number.
+                 * 
+                 * @type {Number|String}
+                 * @default 90%
+                 * @since 3.0
+                 * @product highcharts
+                 */
                 width: '90%',
+
+                /**
+                 * The width of the neck, the lower part of the funnel. A number defines
+                 * pixel width, a percentage string defines a percentage of the plot
+                 * area width.
+                 * 
+                 * @type {Number|String}
+                 * @sample {highcharts} highcharts/demo/funnel/ Funnel demo
+                 * @default 30%
+                 * @since 3.0
+                 * @product highcharts
+                 */
                 neckWidth: '30%',
+
+                /**
+                 * The height of the funnel or pyramid. If it is a number it defines
+                 * the pixel height, if it is a percentage string it is the percentage
+                 * of the plot area height.
+                 * 
+                 * @type {Number|String}
+                 * @sample {highcharts} highcharts/demo/funnel/ Funnel demo
+                 * @since 3.0
+                 * @product highcharts
+                 */
                 height: '100%',
+
+                /**
+                 * The height of the neck, the lower part of the funnel. A number defines
+                 * pixel width, a percentage string defines a percentage of the plot
+                 * area height.
+                 * 
+                 * @type {Number|String}
+                 * @default 25%
+                 * @product highcharts
+                 */
                 neckHeight: '25%',
+
+                /**
+                 * A reversed funnel has the widest area down. A reversed funnel with
+                 * no neck width and neck height is a pyramid.
+                 * 
+                 * @type {Boolean}
+                 * @default false
+                 * @since 3.0.10
+                 * @product highcharts
+                 */
                 reversed: false,
+
+                /**
+                 */
                 size: true, // to avoid adapting to data label size in Pie.drawDataLabels
 
 
                 // Presentational
+
+                /**
+                 */
                 dataLabels: {
                     //position: 'right',
+
+                    /**
+                     */
                     connectorWidth: 1
                     //connectorColor: null
                 },
+
+                /**
+                 */
                 states: {
+
+                    /**
+                     */
                     select: {
+
+                        /**
+                         */
                         color: '#cccccc',
+
+                        /**
+                         */
                         borderColor: '#000000',
+
+                        /**
+                         */
                         shadow: false
                     }
                 }
 
             },
@@ -291,15 +391,36 @@
 
             });
 
         /** 
          * Pyramid series type.
-         * A pyramid series is a special type of funnel, without neck and reversed by default.
          */
-        seriesType('pyramid', 'funnel', {
-            neckWidth: '0%',
-            neckHeight: '0%',
-            reversed: true
-        });
+        seriesType('pyramid', 'funnel',
+            /** 
+             * A pyramid series is a special type of funnel, without neck and reversed by default.
+             * @extends funnel
+             * @optionparent plotOptions.pyramid
+             */
+            {
+
+                /**
+                 */
+                neckWidth: '0%',
+
+                /**
+                 */
+                neckHeight: '0%',
+
+                /**
+                 * The pyramid is reversed by default, as opposed to the funnel, which
+                 * shares the layout engine, and is not reversed.
+                 * 
+                 * @type {Boolean}
+                 * @default true
+                 * @since 3.0.10
+                 * @product highcharts
+                 */
+                reversed: true
+            });
 
     }(Highcharts));
 }));