highcharts 6.1.1 → 6.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (871) hide show
  1. package/bower.json +1 -1
  2. package/css/highcharts.css +29 -0
  3. package/css/highcharts.scss +25 -1
  4. package/css/themes/dark-unica.css +29 -0
  5. package/css/themes/grid-light.css +29 -0
  6. package/css/themes/sand-signika.css +29 -0
  7. package/es-modules/indicators/accumulation-distribution.src.js +1 -1
  8. package/es-modules/indicators/atr.src.js +1 -1
  9. package/es-modules/indicators/bollinger-bands.src.js +2 -2
  10. package/es-modules/indicators/cci.src.js +1 -1
  11. package/es-modules/indicators/cmf.src.js +1 -1
  12. package/es-modules/indicators/ema.src.js +1 -1
  13. package/es-modules/indicators/ichimoku-kinko-hyo.src.js +1 -1
  14. package/es-modules/indicators/indicators.src.js +29 -14
  15. package/es-modules/indicators/macd.src.js +4 -4
  16. package/es-modules/indicators/mfi.src.js +1 -1
  17. package/es-modules/indicators/momentum.src.js +2 -2
  18. package/es-modules/indicators/pivot-points.src.js +7 -2
  19. package/es-modules/indicators/price-envelopes.src.js +2 -2
  20. package/es-modules/indicators/psar.src.js +1 -1
  21. package/es-modules/indicators/roc.src.js +1 -1
  22. package/es-modules/indicators/rsi.src.js +1 -1
  23. package/es-modules/indicators/stochastic.src.js +9 -7
  24. package/es-modules/indicators/volume-by-price.src.js +1 -1
  25. package/es-modules/indicators/vwap.src.js +1 -1
  26. package/es-modules/indicators/wma.src.js +1 -1
  27. package/es-modules/indicators/zigzag.src.js +1 -1
  28. package/es-modules/masters/highcharts-gantt.src.js +11 -0
  29. package/es-modules/masters/modules/annotations.src.js +1 -1
  30. package/es-modules/masters/modules/arrow-symbols.src.js +12 -0
  31. package/es-modules/masters/modules/broken-axis.src.js +1 -1
  32. package/es-modules/masters/modules/current-date-indicator.src.js +12 -0
  33. package/es-modules/masters/modules/data.src.js +1 -1
  34. package/es-modules/masters/modules/draggable-points.src.js +9 -0
  35. package/es-modules/masters/modules/export-data.src.js +1 -1
  36. package/es-modules/masters/modules/exporting.src.js +1 -1
  37. package/es-modules/masters/modules/funnel.src.js +1 -1
  38. package/es-modules/masters/modules/gantt.src.js +2 -1
  39. package/es-modules/masters/modules/grid-axis.src.js +1 -1
  40. package/es-modules/masters/modules/heatmap.src.js +1 -1
  41. package/es-modules/masters/modules/item-series.src.js +1 -1
  42. package/es-modules/masters/modules/map.src.js +1 -1
  43. package/es-modules/masters/modules/overlapping-datalabels.src.js +1 -1
  44. package/es-modules/masters/modules/pathfinder.src.js +12 -0
  45. package/es-modules/masters/modules/sankey.src.js +1 -1
  46. package/es-modules/masters/modules/series-label.src.js +1 -1
  47. package/es-modules/masters/modules/solid-gauge.src.js +1 -1
  48. package/es-modules/masters/modules/stock.src.js +1 -1
  49. package/es-modules/masters/modules/streamgraph.src.js +1 -1
  50. package/es-modules/masters/modules/treegrid.src.js +12 -0
  51. package/es-modules/masters/modules/variwide.src.js +1 -1
  52. package/es-modules/masters/modules/vector.src.js +1 -1
  53. package/es-modules/masters/modules/windbarb.src.js +1 -1
  54. package/es-modules/masters/modules/xrange.src.js +1 -1
  55. package/es-modules/masters/themes/dark-blue.src.js +1 -1
  56. package/es-modules/masters/themes/dark-green.src.js +1 -1
  57. package/es-modules/masters/themes/dark-unica.src.js +1 -1
  58. package/es-modules/masters/themes/gray.src.js +1 -1
  59. package/es-modules/masters/themes/grid-light.src.js +1 -1
  60. package/es-modules/masters/themes/grid.src.js +1 -1
  61. package/es-modules/masters/themes/sand-signika.src.js +1 -1
  62. package/es-modules/masters/themes/skies.src.js +1 -1
  63. package/es-modules/mixins/centered-series.js +36 -5
  64. package/es-modules/mixins/on-series.js +1 -1
  65. package/es-modules/mixins/polygon.js +4 -4
  66. package/es-modules/modules/annotations.src.js +2 -2
  67. package/es-modules/modules/boost-canvas.src.js +19 -8
  68. package/es-modules/modules/boost.src.js +300 -137
  69. package/es-modules/modules/broken-axis.src.js +169 -134
  70. package/es-modules/modules/bullet.src.js +2 -2
  71. package/es-modules/modules/data.src.js +8 -6
  72. package/es-modules/modules/draggable-points.src.js +2257 -0
  73. package/es-modules/modules/drilldown.src.js +4 -2
  74. package/es-modules/modules/export-data.src.js +11 -1
  75. package/es-modules/modules/exporting.src.js +62 -36
  76. package/es-modules/modules/funnel.src.js +5 -5
  77. package/es-modules/modules/histogram.src.js +30 -28
  78. package/es-modules/modules/item-series.src.js +36 -11
  79. package/es-modules/modules/keyboard-navigation.src.js +81 -44
  80. package/es-modules/modules/no-data-to-display.src.js +5 -5
  81. package/es-modules/modules/oldie.src.js +14 -9
  82. package/es-modules/modules/overlapping-datalabels.src.js +45 -21
  83. package/es-modules/modules/parallel-coordinates.src.js +4 -3
  84. package/es-modules/modules/pareto.src.js +1 -1
  85. package/es-modules/modules/sankey.src.js +28 -10
  86. package/es-modules/modules/series-label.src.js +6 -6
  87. package/es-modules/modules/solid-gauge.src.js +10 -7
  88. package/es-modules/modules/static-scale.src.js +67 -28
  89. package/es-modules/modules/streamgraph.src.js +4 -4
  90. package/es-modules/modules/sunburst.src.js +4 -4
  91. package/es-modules/modules/tilemap.src.js +231 -134
  92. package/es-modules/modules/treemap.src.js +30 -27
  93. package/es-modules/modules/variable-pie.src.js +3 -3
  94. package/es-modules/modules/variwide.src.js +36 -24
  95. package/es-modules/modules/vector.src.js +98 -28
  96. package/es-modules/modules/windbarb.src.js +4 -4
  97. package/es-modules/modules/wordcloud.src.js +133 -48
  98. package/es-modules/modules/xrange.src.js +258 -78
  99. package/es-modules/parts/AreaSeries.js +83 -50
  100. package/es-modules/parts/AreaSplineSeries.js +66 -29
  101. package/es-modules/parts/Axis.js +2184 -745
  102. package/es-modules/parts/BarSeries.js +70 -53
  103. package/es-modules/parts/CandlestickSeries.js +20 -10
  104. package/es-modules/parts/Chart.js +349 -157
  105. package/es-modules/parts/Color.js +74 -25
  106. package/es-modules/parts/ColumnSeries.js +274 -147
  107. package/es-modules/parts/DataGrouping.js +36 -3
  108. package/es-modules/parts/DataLabels.js +318 -144
  109. package/es-modules/parts/DateTimeAxis.js +27 -5
  110. package/es-modules/parts/Dynamics.js +236 -144
  111. package/es-modules/parts/FlagsSeries.js +49 -7
  112. package/es-modules/parts/Globals.js +4 -3
  113. package/es-modules/parts/Html.js +82 -16
  114. package/es-modules/parts/Interaction.js +198 -65
  115. package/es-modules/parts/Legend.js +181 -31
  116. package/es-modules/parts/LogarithmicAxis.js +36 -3
  117. package/es-modules/parts/MSPointer.js +31 -4
  118. package/es-modules/parts/Navigator.js +479 -187
  119. package/es-modules/parts/OHLCSeries.js +11 -5
  120. package/es-modules/parts/Options.js +1052 -686
  121. package/es-modules/parts/OrdinalAxis.js +20 -6
  122. package/es-modules/parts/PieSeries.js +258 -142
  123. package/es-modules/parts/PlotBandSeries.experimental.js +2 -2
  124. package/es-modules/parts/PlotLineOrBand.js +671 -35
  125. package/es-modules/parts/Point.js +189 -73
  126. package/es-modules/parts/Pointer.js +263 -62
  127. package/es-modules/parts/RangeSelector.js +601 -91
  128. package/es-modules/parts/Responsive.js +82 -36
  129. package/es-modules/parts/ScatterSeries.js +59 -27
  130. package/es-modules/parts/ScrollablePlotArea.js +30 -9
  131. package/es-modules/parts/Scrollbar.js +284 -113
  132. package/es-modules/parts/Series.js +1105 -836
  133. package/es-modules/parts/SplineSeries.js +53 -31
  134. package/es-modules/parts/Stacking.js +108 -7
  135. package/es-modules/parts/StockChart.js +26 -8
  136. package/es-modules/parts/SvgRenderer.js +1251 -613
  137. package/es-modules/parts/Tick.js +164 -30
  138. package/es-modules/parts/Time.js +171 -71
  139. package/es-modules/parts/Tooltip.js +271 -49
  140. package/es-modules/parts/TouchPointer.js +70 -3
  141. package/es-modules/parts/Utilities.js +1024 -429
  142. package/es-modules/parts-3d/Axis.js +4 -3
  143. package/es-modules/parts-3d/Chart.js +8 -9
  144. package/es-modules/parts-3d/Column.js +1 -1
  145. package/es-modules/parts-3d/Math.js +1 -1
  146. package/es-modules/parts-3d/Pie.js +1 -1
  147. package/es-modules/parts-3d/SVGRenderer.js +13 -10
  148. package/es-modules/parts-3d/Scatter.js +4 -4
  149. package/es-modules/parts-3d/Series.js +1 -1
  150. package/es-modules/parts-3d/VMLRenderer.js +1 -1
  151. package/es-modules/parts-gantt/ArrowSymbols.js +110 -0
  152. package/es-modules/parts-gantt/CurrentDateIndicator.js +92 -0
  153. package/es-modules/parts-gantt/GanttChart.js +111 -0
  154. package/es-modules/parts-gantt/GanttSeries.js +376 -0
  155. package/es-modules/parts-gantt/GridAxis.js +965 -0
  156. package/es-modules/parts-gantt/Pathfinder.js +1247 -0
  157. package/es-modules/parts-gantt/PathfinderAlgorithms.js +746 -0
  158. package/es-modules/parts-gantt/Tree.js +146 -0
  159. package/es-modules/parts-gantt/TreeGrid.js +917 -0
  160. package/es-modules/parts-map/ColorAxis.js +4 -5
  161. package/es-modules/parts-map/ColorSeriesMixin.js +3 -1
  162. package/es-modules/parts-map/GeoJSON.js +1 -1
  163. package/es-modules/parts-map/HeatmapSeries.js +126 -55
  164. package/es-modules/parts-map/Map.js +144 -51
  165. package/es-modules/parts-map/MapAxis.js +1 -1
  166. package/es-modules/parts-map/MapBubbleSeries.js +6 -5
  167. package/es-modules/parts-map/MapLineSeries.js +4 -4
  168. package/es-modules/parts-map/MapNavigation.js +50 -12
  169. package/es-modules/parts-map/MapPointSeries.js +3 -3
  170. package/es-modules/parts-map/MapPointer.js +1 -1
  171. package/es-modules/parts-map/MapSeries.js +7 -7
  172. package/es-modules/parts-more/AreaRangeSeries.js +82 -40
  173. package/es-modules/parts-more/AreaSplineRangeSeries.js +3 -3
  174. package/es-modules/parts-more/BoxPlotSeries.js +3 -3
  175. package/es-modules/parts-more/BubbleSeries.js +9 -4
  176. package/es-modules/parts-more/ColumnRangeSeries.js +3 -3
  177. package/es-modules/parts-more/ErrorBarSeries.js +6 -4
  178. package/es-modules/parts-more/GaugeSeries.js +3 -3
  179. package/es-modules/parts-more/Pane.js +3 -2
  180. package/es-modules/parts-more/Polar.js +1 -1
  181. package/es-modules/parts-more/PolygonSeries.js +3 -3
  182. package/es-modules/parts-more/RadialAxis.js +5 -4
  183. package/es-modules/parts-more/WaterfallSeries.js +9 -4
  184. package/es-modules/supplemental.docs.js +0 -1955
  185. package/es-modules/themes/dark-blue.js +1 -1
  186. package/es-modules/themes/dark-green.js +1 -1
  187. package/es-modules/themes/dark-unica.js +1 -1
  188. package/es-modules/themes/gray.js +1 -1
  189. package/es-modules/themes/grid-light.js +1 -1
  190. package/es-modules/themes/grid.js +1 -1
  191. package/es-modules/themes/sand-signika.js +1 -1
  192. package/es-modules/themes/skies.js +1 -1
  193. package/highcharts-3d.js +77 -75
  194. package/highcharts-3d.js.map +1 -8
  195. package/highcharts-3d.src.js +39 -32
  196. package/highcharts-gantt.js +503 -0
  197. package/highcharts-gantt.js.map +1 -0
  198. package/highcharts-gantt.src.js +49289 -0
  199. package/highcharts-more.js +66 -64
  200. package/highcharts-more.js.map +1 -8
  201. package/highcharts-more.src.js +135 -75
  202. package/highcharts.js +413 -403
  203. package/highcharts.js.map +1 -8
  204. package/highcharts.src.js +11114 -4781
  205. package/highmaps.js +442 -433
  206. package/highmaps.js.map +1 -8
  207. package/highmaps.src.js +10740 -4598
  208. package/highstock.js +553 -540
  209. package/highstock.js.map +1 -8
  210. package/highstock.src.js +12807 -5343
  211. package/indicators/accumulation-distribution.js +4 -3
  212. package/indicators/accumulation-distribution.js.map +1 -8
  213. package/indicators/accumulation-distribution.src.js +6 -2
  214. package/indicators/atr.js +4 -3
  215. package/indicators/atr.js.map +1 -8
  216. package/indicators/atr.src.js +6 -2
  217. package/indicators/bollinger-bands.js +7 -6
  218. package/indicators/bollinger-bands.js.map +1 -8
  219. package/indicators/bollinger-bands.src.js +7 -3
  220. package/indicators/cci.js +4 -3
  221. package/indicators/cci.js.map +1 -8
  222. package/indicators/cci.src.js +6 -2
  223. package/indicators/cmf.js +5 -4
  224. package/indicators/cmf.js.map +1 -8
  225. package/indicators/cmf.src.js +6 -2
  226. package/indicators/ema.js +4 -3
  227. package/indicators/ema.js.map +1 -8
  228. package/indicators/ema.src.js +6 -2
  229. package/indicators/ichimoku-kinko-hyo.js +10 -9
  230. package/indicators/ichimoku-kinko-hyo.js.map +1 -8
  231. package/indicators/ichimoku-kinko-hyo.src.js +6 -2
  232. package/indicators/indicators.js +6 -5
  233. package/indicators/indicators.js.map +1 -8
  234. package/indicators/indicators.src.js +34 -15
  235. package/indicators/macd.js +11 -10
  236. package/indicators/macd.js.map +1 -8
  237. package/indicators/macd.src.js +10 -6
  238. package/indicators/mfi.js +5 -3
  239. package/indicators/mfi.js.map +1 -8
  240. package/indicators/mfi.src.js +6 -2
  241. package/indicators/momentum.js +4 -3
  242. package/indicators/momentum.js.map +1 -8
  243. package/indicators/momentum.src.js +7 -3
  244. package/indicators/pivot-points.js +8 -7
  245. package/indicators/pivot-points.js.map +1 -8
  246. package/indicators/pivot-points.src.js +12 -3
  247. package/indicators/price-envelopes.js +7 -6
  248. package/indicators/price-envelopes.js.map +1 -8
  249. package/indicators/price-envelopes.src.js +7 -3
  250. package/indicators/psar.js +5 -4
  251. package/indicators/psar.js.map +1 -8
  252. package/indicators/psar.src.js +6 -2
  253. package/indicators/roc.js +4 -3
  254. package/indicators/roc.js.map +1 -8
  255. package/indicators/roc.src.js +6 -2
  256. package/indicators/rsi.js +4 -3
  257. package/indicators/rsi.js.map +1 -8
  258. package/indicators/rsi.src.js +6 -2
  259. package/indicators/stochastic.js +7 -5
  260. package/indicators/stochastic.js.map +1 -8
  261. package/indicators/stochastic.src.js +14 -8
  262. package/indicators/volume-by-price.js +13 -12
  263. package/indicators/volume-by-price.js.map +1 -8
  264. package/indicators/volume-by-price.src.js +6 -2
  265. package/indicators/vwap.js +4 -3
  266. package/indicators/vwap.js.map +1 -8
  267. package/indicators/vwap.src.js +6 -2
  268. package/indicators/wma.js +4 -3
  269. package/indicators/wma.js.map +1 -8
  270. package/indicators/wma.src.js +6 -2
  271. package/indicators/zigzag.js +5 -3
  272. package/indicators/zigzag.js.map +1 -8
  273. package/indicators/zigzag.src.js +6 -2
  274. package/js/es-modules/indicators/accumulation-distribution.src.js +1 -1
  275. package/js/es-modules/indicators/atr.src.js +1 -1
  276. package/js/es-modules/indicators/bollinger-bands.src.js +2 -2
  277. package/js/es-modules/indicators/cci.src.js +1 -1
  278. package/js/es-modules/indicators/cmf.src.js +1 -1
  279. package/js/es-modules/indicators/ema.src.js +1 -1
  280. package/js/es-modules/indicators/ichimoku-kinko-hyo.src.js +1 -1
  281. package/js/es-modules/indicators/indicators.src.js +29 -14
  282. package/js/es-modules/indicators/macd.src.js +4 -4
  283. package/js/es-modules/indicators/mfi.src.js +1 -1
  284. package/js/es-modules/indicators/momentum.src.js +2 -2
  285. package/js/es-modules/indicators/pivot-points.src.js +7 -2
  286. package/js/es-modules/indicators/price-envelopes.src.js +2 -2
  287. package/js/es-modules/indicators/psar.src.js +1 -1
  288. package/js/es-modules/indicators/roc.src.js +1 -1
  289. package/js/es-modules/indicators/rsi.src.js +1 -1
  290. package/js/es-modules/indicators/stochastic.src.js +9 -7
  291. package/js/es-modules/indicators/volume-by-price.src.js +1 -1
  292. package/js/es-modules/indicators/vwap.src.js +1 -1
  293. package/js/es-modules/indicators/wma.src.js +1 -1
  294. package/js/es-modules/indicators/zigzag.src.js +1 -1
  295. package/js/es-modules/masters/highcharts-gantt.src.js +11 -0
  296. package/js/es-modules/masters/modules/annotations.src.js +1 -1
  297. package/js/es-modules/masters/modules/arrow-symbols.src.js +12 -0
  298. package/js/es-modules/masters/modules/broken-axis.src.js +1 -1
  299. package/js/es-modules/masters/modules/current-date-indicator.src.js +12 -0
  300. package/js/es-modules/masters/modules/data.src.js +1 -1
  301. package/js/es-modules/masters/modules/draggable-points.src.js +9 -0
  302. package/js/es-modules/masters/modules/export-data.src.js +1 -1
  303. package/js/es-modules/masters/modules/exporting.src.js +1 -1
  304. package/js/es-modules/masters/modules/funnel.src.js +1 -1
  305. package/js/es-modules/masters/modules/gantt.src.js +2 -1
  306. package/js/es-modules/masters/modules/grid-axis.src.js +1 -1
  307. package/js/es-modules/masters/modules/heatmap.src.js +1 -1
  308. package/js/es-modules/masters/modules/item-series.src.js +1 -1
  309. package/js/es-modules/masters/modules/map.src.js +1 -1
  310. package/js/es-modules/masters/modules/overlapping-datalabels.src.js +1 -1
  311. package/js/es-modules/masters/modules/pathfinder.src.js +12 -0
  312. package/js/es-modules/masters/modules/sankey.src.js +1 -1
  313. package/js/es-modules/masters/modules/series-label.src.js +1 -1
  314. package/js/es-modules/masters/modules/solid-gauge.src.js +1 -1
  315. package/js/es-modules/masters/modules/stock.src.js +1 -1
  316. package/js/es-modules/masters/modules/streamgraph.src.js +1 -1
  317. package/js/es-modules/masters/modules/treegrid.src.js +12 -0
  318. package/js/es-modules/masters/modules/variwide.src.js +1 -1
  319. package/js/es-modules/masters/modules/vector.src.js +1 -1
  320. package/js/es-modules/masters/modules/windbarb.src.js +1 -1
  321. package/js/es-modules/masters/modules/xrange.src.js +1 -1
  322. package/js/es-modules/masters/themes/dark-blue.src.js +1 -1
  323. package/js/es-modules/masters/themes/dark-green.src.js +1 -1
  324. package/js/es-modules/masters/themes/dark-unica.src.js +1 -1
  325. package/js/es-modules/masters/themes/gray.src.js +1 -1
  326. package/js/es-modules/masters/themes/grid-light.src.js +1 -1
  327. package/js/es-modules/masters/themes/grid.src.js +1 -1
  328. package/js/es-modules/masters/themes/sand-signika.src.js +1 -1
  329. package/js/es-modules/masters/themes/skies.src.js +1 -1
  330. package/js/es-modules/mixins/centered-series.js +36 -5
  331. package/js/es-modules/mixins/on-series.js +1 -1
  332. package/js/es-modules/mixins/polygon.js +4 -4
  333. package/js/es-modules/modules/annotations.src.js +2 -2
  334. package/js/es-modules/modules/boost-canvas.src.js +19 -8
  335. package/js/es-modules/modules/boost.src.js +300 -137
  336. package/js/es-modules/modules/broken-axis.src.js +169 -134
  337. package/js/es-modules/modules/bullet.src.js +2 -2
  338. package/js/es-modules/modules/data.src.js +8 -6
  339. package/js/es-modules/modules/draggable-points.src.js +2257 -0
  340. package/js/es-modules/modules/drilldown.src.js +4 -2
  341. package/js/es-modules/modules/export-data.src.js +11 -1
  342. package/js/es-modules/modules/exporting.src.js +62 -36
  343. package/js/es-modules/modules/funnel.src.js +5 -5
  344. package/js/es-modules/modules/histogram.src.js +30 -28
  345. package/js/es-modules/modules/item-series.src.js +36 -11
  346. package/js/es-modules/modules/keyboard-navigation.src.js +81 -44
  347. package/js/es-modules/modules/no-data-to-display.src.js +5 -5
  348. package/js/es-modules/modules/oldie.src.js +14 -9
  349. package/js/es-modules/modules/overlapping-datalabels.src.js +45 -21
  350. package/js/es-modules/modules/parallel-coordinates.src.js +4 -3
  351. package/js/es-modules/modules/pareto.src.js +1 -1
  352. package/js/es-modules/modules/sankey.src.js +23 -7
  353. package/js/es-modules/modules/series-label.src.js +6 -6
  354. package/js/es-modules/modules/solid-gauge.src.js +8 -5
  355. package/js/es-modules/modules/static-scale.src.js +67 -28
  356. package/js/es-modules/modules/streamgraph.src.js +4 -4
  357. package/js/es-modules/modules/sunburst.src.js +4 -4
  358. package/js/es-modules/modules/tilemap.src.js +231 -134
  359. package/js/es-modules/modules/treemap.src.js +29 -26
  360. package/js/es-modules/modules/variable-pie.src.js +3 -3
  361. package/js/es-modules/modules/variwide.src.js +36 -24
  362. package/js/es-modules/modules/vector.src.js +98 -28
  363. package/js/es-modules/modules/windbarb.src.js +4 -4
  364. package/js/es-modules/modules/wordcloud.src.js +133 -48
  365. package/js/es-modules/modules/xrange.src.js +256 -69
  366. package/js/es-modules/parts/AreaSeries.js +83 -50
  367. package/js/es-modules/parts/AreaSplineSeries.js +66 -29
  368. package/js/es-modules/parts/Axis.js +2089 -694
  369. package/js/es-modules/parts/BarSeries.js +70 -53
  370. package/js/es-modules/parts/CandlestickSeries.js +20 -10
  371. package/js/es-modules/parts/Chart.js +349 -157
  372. package/js/es-modules/parts/Color.js +74 -25
  373. package/js/es-modules/parts/ColumnSeries.js +241 -128
  374. package/js/es-modules/parts/DataGrouping.js +36 -3
  375. package/js/es-modules/parts/DataLabels.js +287 -116
  376. package/js/es-modules/parts/DateTimeAxis.js +27 -5
  377. package/js/es-modules/parts/Dynamics.js +236 -144
  378. package/js/es-modules/parts/FlagsSeries.js +49 -7
  379. package/js/es-modules/parts/Globals.js +4 -3
  380. package/js/es-modules/parts/Html.js +82 -16
  381. package/js/es-modules/parts/Interaction.js +187 -67
  382. package/js/es-modules/parts/Legend.js +181 -31
  383. package/js/es-modules/parts/LogarithmicAxis.js +36 -3
  384. package/js/es-modules/parts/MSPointer.js +31 -4
  385. package/js/es-modules/parts/Navigator.js +432 -162
  386. package/js/es-modules/parts/OHLCSeries.js +5 -5
  387. package/js/es-modules/parts/Options.js +855 -592
  388. package/js/es-modules/parts/OrdinalAxis.js +20 -6
  389. package/js/es-modules/parts/PieSeries.js +247 -134
  390. package/js/es-modules/parts/PlotBandSeries.experimental.js +2 -2
  391. package/js/es-modules/parts/PlotLineOrBand.js +671 -35
  392. package/js/es-modules/parts/Point.js +182 -70
  393. package/js/es-modules/parts/Pointer.js +263 -62
  394. package/js/es-modules/parts/RangeSelector.js +579 -91
  395. package/js/es-modules/parts/Responsive.js +82 -36
  396. package/js/es-modules/parts/ScatterSeries.js +58 -27
  397. package/js/es-modules/parts/ScrollablePlotArea.js +30 -9
  398. package/js/es-modules/parts/Scrollbar.js +201 -71
  399. package/js/es-modules/parts/Series.js +995 -745
  400. package/js/es-modules/parts/SplineSeries.js +53 -31
  401. package/js/es-modules/parts/Stacking.js +108 -7
  402. package/js/es-modules/parts/StockChart.js +26 -8
  403. package/js/es-modules/parts/SvgRenderer.js +1208 -598
  404. package/js/es-modules/parts/Tick.js +164 -30
  405. package/js/es-modules/parts/Time.js +171 -71
  406. package/js/es-modules/parts/Tooltip.js +276 -49
  407. package/js/es-modules/parts/TouchPointer.js +70 -3
  408. package/js/es-modules/parts/Utilities.js +1024 -429
  409. package/js/es-modules/parts-3d/Axis.js +4 -3
  410. package/js/es-modules/parts-3d/Chart.js +8 -9
  411. package/js/es-modules/parts-3d/Column.js +1 -1
  412. package/js/es-modules/parts-3d/Math.js +1 -1
  413. package/js/es-modules/parts-3d/Pie.js +1 -1
  414. package/js/es-modules/parts-3d/SVGRenderer.js +13 -10
  415. package/js/es-modules/parts-3d/Scatter.js +4 -4
  416. package/js/es-modules/parts-3d/Series.js +1 -1
  417. package/js/es-modules/parts-3d/VMLRenderer.js +1 -1
  418. package/js/es-modules/parts-gantt/ArrowSymbols.js +110 -0
  419. package/js/es-modules/parts-gantt/CurrentDateIndicator.js +92 -0
  420. package/js/es-modules/parts-gantt/GanttChart.js +111 -0
  421. package/js/es-modules/parts-gantt/GanttSeries.js +371 -0
  422. package/js/es-modules/parts-gantt/GridAxis.js +962 -0
  423. package/js/es-modules/parts-gantt/Pathfinder.js +1225 -0
  424. package/js/es-modules/parts-gantt/PathfinderAlgorithms.js +746 -0
  425. package/js/es-modules/parts-gantt/Tree.js +146 -0
  426. package/js/es-modules/parts-gantt/TreeGrid.js +891 -0
  427. package/js/es-modules/parts-map/ColorAxis.js +4 -5
  428. package/js/es-modules/parts-map/ColorSeriesMixin.js +3 -1
  429. package/js/es-modules/parts-map/GeoJSON.js +1 -1
  430. package/js/es-modules/parts-map/HeatmapSeries.js +124 -54
  431. package/js/es-modules/parts-map/Map.js +136 -47
  432. package/js/es-modules/parts-map/MapAxis.js +1 -1
  433. package/js/es-modules/parts-map/MapBubbleSeries.js +6 -5
  434. package/js/es-modules/parts-map/MapLineSeries.js +4 -4
  435. package/js/es-modules/parts-map/MapNavigation.js +50 -12
  436. package/js/es-modules/parts-map/MapPointSeries.js +3 -3
  437. package/js/es-modules/parts-map/MapPointer.js +1 -1
  438. package/js/es-modules/parts-map/MapSeries.js +5 -5
  439. package/js/es-modules/parts-more/AreaRangeSeries.js +82 -40
  440. package/js/es-modules/parts-more/AreaSplineRangeSeries.js +3 -3
  441. package/js/es-modules/parts-more/BoxPlotSeries.js +3 -3
  442. package/js/es-modules/parts-more/BubbleSeries.js +9 -4
  443. package/js/es-modules/parts-more/ColumnRangeSeries.js +3 -3
  444. package/js/es-modules/parts-more/ErrorBarSeries.js +6 -4
  445. package/js/es-modules/parts-more/GaugeSeries.js +3 -3
  446. package/js/es-modules/parts-more/Pane.js +3 -2
  447. package/js/es-modules/parts-more/Polar.js +1 -1
  448. package/js/es-modules/parts-more/PolygonSeries.js +3 -3
  449. package/js/es-modules/parts-more/RadialAxis.js +5 -4
  450. package/js/es-modules/parts-more/WaterfallSeries.js +9 -4
  451. package/js/es-modules/supplemental.docs.js +0 -1955
  452. package/js/es-modules/themes/dark-blue.js +1 -1
  453. package/js/es-modules/themes/dark-green.js +1 -1
  454. package/js/es-modules/themes/dark-unica.js +1 -1
  455. package/js/es-modules/themes/gray.js +1 -1
  456. package/js/es-modules/themes/grid-light.js +1 -1
  457. package/js/es-modules/themes/grid.js +1 -1
  458. package/js/es-modules/themes/sand-signika.js +1 -1
  459. package/js/es-modules/themes/skies.js +1 -1
  460. package/js/highcharts-3d.js +75 -74
  461. package/js/highcharts-3d.js.map +1 -8
  462. package/js/highcharts-3d.src.js +39 -32
  463. package/js/highcharts-gantt.js +480 -0
  464. package/js/highcharts-gantt.js.map +1 -0
  465. package/js/highcharts-gantt.src.js +47011 -0
  466. package/js/highcharts-more.js +63 -61
  467. package/js/highcharts-more.js.map +1 -8
  468. package/js/highcharts-more.src.js +135 -75
  469. package/js/highcharts.js +396 -387
  470. package/js/highcharts.js.map +1 -8
  471. package/js/highcharts.src.js +10765 -4659
  472. package/js/highmaps.js +419 -411
  473. package/js/highmaps.js.map +1 -8
  474. package/js/highmaps.src.js +10198 -4285
  475. package/js/highstock.js +529 -516
  476. package/js/highstock.js.map +1 -8
  477. package/js/highstock.src.js +12108 -4962
  478. package/js/indicators/accumulation-distribution.js +4 -3
  479. package/js/indicators/accumulation-distribution.js.map +1 -8
  480. package/js/indicators/accumulation-distribution.src.js +6 -2
  481. package/js/indicators/atr.js +4 -3
  482. package/js/indicators/atr.js.map +1 -8
  483. package/js/indicators/atr.src.js +6 -2
  484. package/js/indicators/bollinger-bands.js +7 -6
  485. package/js/indicators/bollinger-bands.js.map +1 -8
  486. package/js/indicators/bollinger-bands.src.js +7 -3
  487. package/js/indicators/cci.js +4 -3
  488. package/js/indicators/cci.js.map +1 -8
  489. package/js/indicators/cci.src.js +6 -2
  490. package/js/indicators/cmf.js +5 -4
  491. package/js/indicators/cmf.js.map +1 -8
  492. package/js/indicators/cmf.src.js +6 -2
  493. package/js/indicators/ema.js +4 -3
  494. package/js/indicators/ema.js.map +1 -8
  495. package/js/indicators/ema.src.js +6 -2
  496. package/js/indicators/ichimoku-kinko-hyo.js +10 -9
  497. package/js/indicators/ichimoku-kinko-hyo.js.map +1 -8
  498. package/js/indicators/ichimoku-kinko-hyo.src.js +6 -2
  499. package/js/indicators/indicators.js +6 -5
  500. package/js/indicators/indicators.js.map +1 -8
  501. package/js/indicators/indicators.src.js +34 -15
  502. package/js/indicators/macd.js +11 -10
  503. package/js/indicators/macd.js.map +1 -8
  504. package/js/indicators/macd.src.js +10 -6
  505. package/js/indicators/mfi.js +5 -3
  506. package/js/indicators/mfi.js.map +1 -8
  507. package/js/indicators/mfi.src.js +6 -2
  508. package/js/indicators/momentum.js +4 -3
  509. package/js/indicators/momentum.js.map +1 -8
  510. package/js/indicators/momentum.src.js +7 -3
  511. package/js/indicators/pivot-points.js +8 -7
  512. package/js/indicators/pivot-points.js.map +1 -8
  513. package/js/indicators/pivot-points.src.js +12 -3
  514. package/js/indicators/price-envelopes.js +7 -6
  515. package/js/indicators/price-envelopes.js.map +1 -8
  516. package/js/indicators/price-envelopes.src.js +7 -3
  517. package/js/indicators/psar.js +5 -4
  518. package/js/indicators/psar.js.map +1 -8
  519. package/js/indicators/psar.src.js +6 -2
  520. package/js/indicators/roc.js +4 -3
  521. package/js/indicators/roc.js.map +1 -8
  522. package/js/indicators/roc.src.js +6 -2
  523. package/js/indicators/rsi.js +4 -3
  524. package/js/indicators/rsi.js.map +1 -8
  525. package/js/indicators/rsi.src.js +6 -2
  526. package/js/indicators/stochastic.js +7 -5
  527. package/js/indicators/stochastic.js.map +1 -8
  528. package/js/indicators/stochastic.src.js +14 -8
  529. package/js/indicators/volume-by-price.js +13 -12
  530. package/js/indicators/volume-by-price.js.map +1 -8
  531. package/js/indicators/volume-by-price.src.js +6 -2
  532. package/js/indicators/vwap.js +4 -3
  533. package/js/indicators/vwap.js.map +1 -8
  534. package/js/indicators/vwap.src.js +6 -2
  535. package/js/indicators/wma.js +4 -3
  536. package/js/indicators/wma.js.map +1 -8
  537. package/js/indicators/wma.src.js +6 -2
  538. package/js/indicators/zigzag.js +5 -3
  539. package/js/indicators/zigzag.js.map +1 -8
  540. package/js/indicators/zigzag.src.js +6 -2
  541. package/js/modules/accessibility.js +52 -51
  542. package/js/modules/accessibility.js.map +1 -8
  543. package/js/modules/accessibility.src.js +86 -45
  544. package/js/modules/annotations.js +22 -21
  545. package/js/modules/annotations.js.map +1 -8
  546. package/js/modules/annotations.src.js +8 -4
  547. package/js/modules/arrow-symbols.js +13 -0
  548. package/js/modules/arrow-symbols.js.map +1 -0
  549. package/js/modules/arrow-symbols.src.js +138 -0
  550. package/js/modules/boost-canvas.js +15 -13
  551. package/js/modules/boost-canvas.js.map +1 -8
  552. package/js/modules/boost-canvas.src.js +24 -9
  553. package/js/modules/boost.js +57 -52
  554. package/js/modules/boost.js.map +1 -8
  555. package/js/modules/boost.src.js +305 -138
  556. package/js/modules/broken-axis.js +12 -10
  557. package/js/modules/broken-axis.js.map +1 -8
  558. package/js/modules/broken-axis.src.js +175 -136
  559. package/js/modules/bullet.js +3 -2
  560. package/js/modules/bullet.js.map +1 -8
  561. package/js/modules/bullet.src.js +7 -3
  562. package/js/modules/current-date-indicator.js +13 -0
  563. package/js/modules/current-date-indicator.js.map +1 -0
  564. package/js/modules/current-date-indicator.src.js +120 -0
  565. package/js/modules/data.js +25 -24
  566. package/js/modules/data.js.map +1 -8
  567. package/js/modules/data.src.js +14 -8
  568. package/js/modules/drag-panes.js +9 -8
  569. package/js/modules/drag-panes.js.map +1 -8
  570. package/js/modules/drag-panes.src.js +5 -1
  571. package/js/modules/draggable-points.js +38 -0
  572. package/js/modules/draggable-points.js.map +1 -0
  573. package/js/modules/draggable-points.src.js +2281 -0
  574. package/js/modules/drilldown.js +20 -19
  575. package/js/modules/drilldown.js.map +1 -8
  576. package/js/modules/drilldown.src.js +9 -3
  577. package/js/modules/export-data.js +20 -19
  578. package/js/modules/export-data.js.map +1 -8
  579. package/js/modules/export-data.src.js +17 -3
  580. package/js/modules/exporting.js +24 -23
  581. package/js/modules/exporting.js.map +1 -8
  582. package/js/modules/exporting.src.js +68 -38
  583. package/js/modules/funnel.js +8 -6
  584. package/js/modules/funnel.js.map +1 -8
  585. package/js/modules/funnel.src.js +11 -7
  586. package/js/modules/gantt.js +81 -18
  587. package/js/modules/gantt.js.map +1 -8
  588. package/js/modules/gantt.src.js +5494 -372
  589. package/js/modules/grid-axis.js +16 -10
  590. package/js/modules/grid-axis.js.map +1 -8
  591. package/js/modules/grid-axis.src.js +735 -293
  592. package/js/modules/heatmap.js +22 -21
  593. package/js/modules/heatmap.js.map +1 -8
  594. package/js/modules/heatmap.src.js +137 -62
  595. package/js/modules/histogram-bellcurve.js +9 -8
  596. package/js/modules/histogram-bellcurve.js.map +1 -8
  597. package/js/modules/histogram-bellcurve.src.js +35 -29
  598. package/js/modules/item-series.js +6 -4
  599. package/js/modules/item-series.js.map +1 -8
  600. package/js/modules/item-series.src.js +42 -13
  601. package/js/modules/map.js +63 -62
  602. package/js/modules/map.js.map +1 -8
  603. package/js/modules/map.src.js +353 -145
  604. package/js/modules/no-data-to-display.js +5 -4
  605. package/js/modules/no-data-to-display.js.map +1 -8
  606. package/js/modules/no-data-to-display.src.js +10 -6
  607. package/js/modules/offline-exporting.js +14 -13
  608. package/js/modules/offline-exporting.js.map +1 -8
  609. package/js/modules/offline-exporting.src.js +6 -2
  610. package/js/modules/oldie.js +29 -27
  611. package/js/modules/oldie.js.map +1 -8
  612. package/js/modules/oldie.src.js +20 -11
  613. package/js/modules/overlapping-datalabels.js +4 -3
  614. package/js/modules/overlapping-datalabels.js.map +1 -8
  615. package/js/modules/overlapping-datalabels.src.js +6 -2
  616. package/js/modules/parallel-coordinates.js +10 -9
  617. package/js/modules/parallel-coordinates.js.map +1 -8
  618. package/js/modules/parallel-coordinates.src.js +9 -4
  619. package/js/modules/pareto.js +5 -4
  620. package/js/modules/pareto.js.map +1 -8
  621. package/js/modules/pareto.src.js +6 -2
  622. package/js/modules/pathfinder.js +34 -0
  623. package/js/modules/pathfinder.js.map +1 -0
  624. package/js/modules/pathfinder.src.js +2106 -0
  625. package/js/modules/pattern-fill.js +13 -12
  626. package/js/modules/pattern-fill.js.map +1 -8
  627. package/js/modules/pattern-fill.src.js +5 -1
  628. package/js/modules/sankey.js +13 -12
  629. package/js/modules/sankey.js.map +1 -8
  630. package/js/modules/sankey.src.js +29 -9
  631. package/js/modules/series-label.js +17 -15
  632. package/js/modules/series-label.js.map +1 -8
  633. package/js/modules/series-label.src.js +12 -8
  634. package/js/modules/solid-gauge.js +9 -8
  635. package/js/modules/solid-gauge.js.map +1 -8
  636. package/js/modules/solid-gauge.src.js +14 -7
  637. package/js/modules/static-scale.js +4 -3
  638. package/js/modules/static-scale.js.map +1 -8
  639. package/js/modules/static-scale.src.js +69 -26
  640. package/js/modules/stock.js +136 -132
  641. package/js/modules/stock.js.map +1 -8
  642. package/js/modules/stock.src.js +1543 -499
  643. package/js/modules/streamgraph.js +4 -3
  644. package/js/modules/streamgraph.js.map +1 -8
  645. package/js/modules/streamgraph.src.js +10 -6
  646. package/js/modules/sunburst.js +40 -39
  647. package/js/modules/sunburst.js.map +1 -8
  648. package/js/modules/sunburst.src.js +38 -31
  649. package/js/modules/tilemap.js +19 -18
  650. package/js/modules/tilemap.js.map +1 -8
  651. package/js/modules/tilemap.src.js +363 -190
  652. package/js/modules/treegrid.js +51 -0
  653. package/js/modules/treegrid.js.map +1 -0
  654. package/js/modules/treegrid.src.js +2759 -0
  655. package/js/modules/treemap.js +27 -26
  656. package/js/modules/treemap.js.map +1 -8
  657. package/js/modules/treemap.src.js +34 -27
  658. package/js/modules/variable-pie.js +8 -7
  659. package/js/modules/variable-pie.js.map +1 -8
  660. package/js/modules/variable-pie.src.js +8 -4
  661. package/js/modules/variwide.js +8 -7
  662. package/js/modules/variwide.js.map +1 -8
  663. package/js/modules/variwide.src.js +42 -26
  664. package/js/modules/vector.js +7 -6
  665. package/js/modules/vector.js.map +1 -8
  666. package/js/modules/vector.src.js +104 -30
  667. package/js/modules/windbarb.js +11 -10
  668. package/js/modules/windbarb.js.map +1 -8
  669. package/js/modules/windbarb.src.js +11 -7
  670. package/js/modules/wordcloud.js +18 -15
  671. package/js/modules/wordcloud.js.map +1 -8
  672. package/js/modules/wordcloud.src.js +142 -53
  673. package/js/modules/xrange.js +12 -10
  674. package/js/modules/xrange.js.map +1 -8
  675. package/js/modules/xrange.src.js +262 -71
  676. package/js/themes/avocado.js +3 -2
  677. package/js/themes/avocado.js.map +1 -8
  678. package/js/themes/avocado.src.js +5 -1
  679. package/js/themes/dark-blue.js +9 -8
  680. package/js/themes/dark-blue.js.map +1 -8
  681. package/js/themes/dark-blue.src.js +7 -3
  682. package/js/themes/dark-green.js +9 -8
  683. package/js/themes/dark-green.js.map +1 -8
  684. package/js/themes/dark-green.src.js +7 -3
  685. package/js/themes/dark-unica.js +9 -7
  686. package/js/themes/dark-unica.js.map +1 -8
  687. package/js/themes/dark-unica.src.js +7 -3
  688. package/js/themes/gray.js +10 -8
  689. package/js/themes/gray.js.map +1 -8
  690. package/js/themes/gray.src.js +7 -3
  691. package/js/themes/grid-light.js +5 -4
  692. package/js/themes/grid-light.js.map +1 -8
  693. package/js/themes/grid-light.src.js +7 -3
  694. package/js/themes/grid.js +6 -5
  695. package/js/themes/grid.js.map +1 -8
  696. package/js/themes/grid.src.js +7 -3
  697. package/js/themes/sand-signika.js +6 -5
  698. package/js/themes/sand-signika.js.map +1 -8
  699. package/js/themes/sand-signika.src.js +7 -3
  700. package/js/themes/skies.js +6 -5
  701. package/js/themes/skies.js.map +1 -8
  702. package/js/themes/skies.src.js +7 -3
  703. package/js/themes/sunset.js +3 -2
  704. package/js/themes/sunset.js.map +1 -8
  705. package/js/themes/sunset.src.js +5 -1
  706. package/modules/accessibility.js +53 -51
  707. package/modules/accessibility.js.map +1 -8
  708. package/modules/accessibility.src.js +86 -45
  709. package/modules/annotations.js +24 -22
  710. package/modules/annotations.js.map +1 -8
  711. package/modules/annotations.src.js +8 -4
  712. package/modules/arrow-symbols.js +13 -0
  713. package/modules/arrow-symbols.js.map +1 -0
  714. package/modules/arrow-symbols.src.js +138 -0
  715. package/modules/boost-canvas.js +15 -13
  716. package/modules/boost-canvas.js.map +1 -8
  717. package/modules/boost-canvas.src.js +24 -9
  718. package/modules/boost.js +57 -52
  719. package/modules/boost.js.map +1 -8
  720. package/modules/boost.src.js +305 -138
  721. package/modules/broken-axis.js +12 -10
  722. package/modules/broken-axis.js.map +1 -8
  723. package/modules/broken-axis.src.js +175 -136
  724. package/modules/bullet.js +6 -5
  725. package/modules/bullet.js.map +1 -8
  726. package/modules/bullet.src.js +7 -3
  727. package/modules/current-date-indicator.js +13 -0
  728. package/modules/current-date-indicator.js.map +1 -0
  729. package/modules/current-date-indicator.src.js +120 -0
  730. package/modules/data.js +25 -24
  731. package/modules/data.js.map +1 -8
  732. package/modules/data.src.js +14 -8
  733. package/modules/drag-panes.js +9 -8
  734. package/modules/drag-panes.js.map +1 -8
  735. package/modules/drag-panes.src.js +5 -1
  736. package/modules/draggable-points.js +38 -0
  737. package/modules/draggable-points.js.map +1 -0
  738. package/modules/draggable-points.src.js +2281 -0
  739. package/modules/drilldown.js +16 -15
  740. package/modules/drilldown.js.map +1 -8
  741. package/modules/drilldown.src.js +9 -3
  742. package/modules/export-data.js +20 -19
  743. package/modules/export-data.js.map +1 -8
  744. package/modules/export-data.src.js +17 -3
  745. package/modules/exporting.js +23 -21
  746. package/modules/exporting.js.map +1 -8
  747. package/modules/exporting.src.js +68 -38
  748. package/modules/funnel.js +8 -7
  749. package/modules/funnel.js.map +1 -8
  750. package/modules/funnel.src.js +11 -7
  751. package/modules/gantt.js +84 -19
  752. package/modules/gantt.js.map +1 -8
  753. package/modules/gantt.src.js +5557 -379
  754. package/modules/grid-axis.js +17 -10
  755. package/modules/grid-axis.js.map +1 -8
  756. package/modules/grid-axis.src.js +736 -293
  757. package/modules/heatmap.js +22 -21
  758. package/modules/heatmap.js.map +1 -8
  759. package/modules/heatmap.src.js +139 -63
  760. package/modules/histogram-bellcurve.js +9 -8
  761. package/modules/histogram-bellcurve.js.map +1 -8
  762. package/modules/histogram-bellcurve.src.js +35 -29
  763. package/modules/item-series.js +6 -4
  764. package/modules/item-series.js.map +1 -8
  765. package/modules/item-series.src.js +42 -13
  766. package/modules/map.js +65 -64
  767. package/modules/map.js.map +1 -8
  768. package/modules/map.src.js +365 -152
  769. package/modules/no-data-to-display.js +5 -4
  770. package/modules/no-data-to-display.js.map +1 -8
  771. package/modules/no-data-to-display.src.js +10 -6
  772. package/modules/offline-exporting.js +14 -12
  773. package/modules/offline-exporting.js.map +1 -8
  774. package/modules/offline-exporting.src.js +6 -2
  775. package/modules/oldie.js +29 -27
  776. package/modules/oldie.js.map +1 -8
  777. package/modules/oldie.src.js +20 -11
  778. package/modules/overlapping-datalabels.js +4 -3
  779. package/modules/overlapping-datalabels.js.map +1 -8
  780. package/modules/overlapping-datalabels.src.js +6 -2
  781. package/modules/parallel-coordinates.js +10 -9
  782. package/modules/parallel-coordinates.js.map +1 -8
  783. package/modules/parallel-coordinates.src.js +9 -4
  784. package/modules/pareto.js +5 -4
  785. package/modules/pareto.js.map +1 -8
  786. package/modules/pareto.src.js +6 -2
  787. package/modules/pathfinder.js +35 -0
  788. package/modules/pathfinder.js.map +1 -0
  789. package/modules/pathfinder.src.js +2128 -0
  790. package/modules/pattern-fill.js +13 -12
  791. package/modules/pattern-fill.js.map +1 -8
  792. package/modules/pattern-fill.src.js +5 -1
  793. package/modules/sankey.js +13 -12
  794. package/modules/sankey.js.map +1 -8
  795. package/modules/sankey.src.js +34 -12
  796. package/modules/series-label.js +17 -15
  797. package/modules/series-label.js.map +1 -8
  798. package/modules/series-label.src.js +12 -8
  799. package/modules/solid-gauge.js +9 -8
  800. package/modules/solid-gauge.js.map +1 -8
  801. package/modules/solid-gauge.src.js +16 -9
  802. package/modules/static-scale.js +4 -3
  803. package/modules/static-scale.js.map +1 -8
  804. package/modules/static-scale.src.js +69 -26
  805. package/modules/stock.js +143 -139
  806. package/modules/stock.js.map +1 -8
  807. package/modules/stock.src.js +1701 -566
  808. package/modules/streamgraph.js +4 -3
  809. package/modules/streamgraph.js.map +1 -8
  810. package/modules/streamgraph.src.js +10 -6
  811. package/modules/sunburst.js +42 -41
  812. package/modules/sunburst.js.map +1 -8
  813. package/modules/sunburst.src.js +39 -32
  814. package/modules/tilemap.js +18 -17
  815. package/modules/tilemap.js.map +1 -8
  816. package/modules/tilemap.src.js +365 -191
  817. package/modules/treegrid.js +52 -0
  818. package/modules/treegrid.js.map +1 -0
  819. package/modules/treegrid.src.js +2797 -0
  820. package/modules/treemap.js +29 -28
  821. package/modules/treemap.js.map +1 -8
  822. package/modules/treemap.src.js +35 -28
  823. package/modules/variable-pie.js +8 -7
  824. package/modules/variable-pie.js.map +1 -8
  825. package/modules/variable-pie.src.js +8 -4
  826. package/modules/variwide.js +8 -7
  827. package/modules/variwide.js.map +1 -8
  828. package/modules/variwide.src.js +42 -26
  829. package/modules/vector.js +7 -6
  830. package/modules/vector.js.map +1 -8
  831. package/modules/vector.src.js +104 -30
  832. package/modules/windbarb.js +11 -10
  833. package/modules/windbarb.js.map +1 -8
  834. package/modules/windbarb.src.js +11 -7
  835. package/modules/wordcloud.js +18 -15
  836. package/modules/wordcloud.js.map +1 -8
  837. package/modules/wordcloud.src.js +142 -53
  838. package/modules/xrange.js +13 -11
  839. package/modules/xrange.js.map +1 -8
  840. package/modules/xrange.src.js +264 -80
  841. package/package.json +1 -1
  842. package/themes/avocado.js +3 -2
  843. package/themes/avocado.js.map +1 -8
  844. package/themes/avocado.src.js +5 -1
  845. package/themes/dark-blue.js +9 -8
  846. package/themes/dark-blue.js.map +1 -8
  847. package/themes/dark-blue.src.js +7 -3
  848. package/themes/dark-green.js +9 -8
  849. package/themes/dark-green.js.map +1 -8
  850. package/themes/dark-green.src.js +7 -3
  851. package/themes/dark-unica.js +9 -7
  852. package/themes/dark-unica.js.map +1 -8
  853. package/themes/dark-unica.src.js +7 -3
  854. package/themes/gray.js +10 -8
  855. package/themes/gray.js.map +1 -8
  856. package/themes/gray.src.js +7 -3
  857. package/themes/grid-light.js +5 -4
  858. package/themes/grid-light.js.map +1 -8
  859. package/themes/grid-light.src.js +7 -3
  860. package/themes/grid.js +6 -5
  861. package/themes/grid.js.map +1 -8
  862. package/themes/grid.src.js +7 -3
  863. package/themes/sand-signika.js +6 -5
  864. package/themes/sand-signika.js.map +1 -8
  865. package/themes/sand-signika.src.js +7 -3
  866. package/themes/skies.js +6 -5
  867. package/themes/skies.js.map +1 -8
  868. package/themes/skies.src.js +7 -3
  869. package/themes/sunset.js +3 -2
  870. package/themes/sunset.js.map +1 -8
  871. package/themes/sunset.src.js +5 -1
@@ -1,5 +1,5 @@
1
1
  /**
2
- * (c) 2010-2017 Torstein Honsi
2
+ * (c) 2010-2018 Torstein Honsi
3
3
  *
4
4
  * License: www.highcharts.com/license
5
5
  */
@@ -18,6 +18,11 @@ var color = H.color,
18
18
  * Handle the options *
19
19
  *****************************************************************************/
20
20
  /**
21
+ * Global default settings.
22
+ *
23
+ * @name Highcharts.defaultOptions
24
+ * @type {Highcharts.Options}
25
+ *//**
21
26
  * @optionparent
22
27
  */
23
28
  H.defaultOptions = {
@@ -48,8 +53,10 @@ H.defaultOptions = {
48
53
  * <pre>colors: ['#4572A7', '#AA4643', '#89A54E', '#80699B', '#3D96AE',
49
54
  * '#DB843D', '#92A8CD', '#A47D7C', '#B5CA92']</pre>
50
55
  *
51
- * @type {Array<Color>}
52
- * @sample {highcharts} highcharts/chart/colors/ Assign a global color theme
56
+ * @sample {highcharts} highcharts/chart/colors/
57
+ * Assign a global color theme
58
+ *
59
+ * @type {Array<Highcharts.ColorString>}
53
60
  * @default ["#7cb5ec", "#434348", "#90ed7d", "#f7a35c", "#8085e9",
54
61
  * "#f15c80", "#e4d354", "#2b908f", "#f45b5b", "#91e8e1"]
55
62
  */
@@ -59,12 +66,12 @@ H.defaultOptions = {
59
66
 
60
67
  /**
61
68
  * Styled mode only. Configuration object for adding SVG definitions for
62
- * reusable elements. See [gradients, shadows and patterns](http://www.
63
- * highcharts.com/docs/chart-design-and-style/gradients-shadows-and-
64
- * patterns) for more information and code examples.
69
+ * reusable elements. See [gradients, shadows and
70
+ * patterns](https://www.highcharts.com/docs/chart-design-and-style/gradients-shadows-and-patterns)
71
+ * for more information and code examples.
65
72
  *
66
- * @type {Object}
67
- * @since 5.0.0
73
+ * @type {*}
74
+ * @since 5.0.0
68
75
  * @apioption defs
69
76
  */
70
77
 
@@ -72,14 +79,31 @@ H.defaultOptions = {
72
79
  * @ignore-option
73
80
  */
74
81
  symbols: ['circle', 'diamond', 'square', 'triangle', 'triangle-down'],
82
+
83
+ /**
84
+ * The language object is global and it can't be set on each chart
85
+ * initiation. Instead, use `Highcharts.setOptions` to set it before any
86
+ * chart is initialized.
87
+ *
88
+ * <pre>Highcharts.setOptions({
89
+ * lang: {
90
+ * months: [
91
+ * 'Janvier', 'Février', 'Mars', 'Avril',
92
+ * 'Mai', 'Juin', 'Juillet', 'Août',
93
+ * 'Septembre', 'Octobre', 'Novembre', 'Décembre'
94
+ * ],
95
+ * weekdays: [
96
+ * 'Dimanche', 'Lundi', 'Mardi', 'Mercredi',
97
+ * 'Jeudi', 'Vendredi', 'Samedi'
98
+ * ]
99
+ * }
100
+ * });</pre>
101
+ */
75
102
  lang: {
76
103
 
77
104
  /**
78
105
  * The loading text that appears when the chart is set into the loading
79
106
  * state following a call to `chart.showLoading`.
80
- *
81
- * @type {String}
82
- * @default Loading...
83
107
  */
84
108
  loading: 'Loading...',
85
109
 
@@ -87,10 +111,10 @@ H.defaultOptions = {
87
111
  * An array containing the months names. Corresponds to the `%B` format
88
112
  * in `Highcharts.dateFormat()`.
89
113
  *
90
- * @type {Array<String>}
91
- * @default [ "January" , "February" , "March" , "April" , "May" ,
92
- * "June" , "July" , "August" , "September" , "October" ,
93
- * "November" , "December"]
114
+ * @type {Array<string>}
115
+ * @default ["January", "February", "March", "April", "May", "June",
116
+ * "July", "August", "September", "October", "November",
117
+ * "December"]
94
118
  */
95
119
  months: [
96
120
  'January', 'February', 'March', 'April', 'May', 'June', 'July',
@@ -101,9 +125,9 @@ H.defaultOptions = {
101
125
  * An array containing the months names in abbreviated form. Corresponds
102
126
  * to the `%b` format in `Highcharts.dateFormat()`.
103
127
  *
104
- * @type {Array<String>}
105
- * @default [ "Jan" , "Feb" , "Mar" , "Apr" , "May" , "Jun" ,
106
- * "Jul" , "Aug" , "Sep" , "Oct" , "Nov" , "Dec"]
128
+ * @type {Array<string>}
129
+ * @default ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
130
+ * "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
107
131
  */
108
132
  shortMonths: [
109
133
  'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul',
@@ -113,7 +137,7 @@ H.defaultOptions = {
113
137
  /**
114
138
  * An array containing the weekday names.
115
139
  *
116
- * @type {Array<String>}
140
+ * @type {Array<string>}
117
141
  * @default ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday",
118
142
  * "Friday", "Saturday"]
119
143
  */
@@ -126,10 +150,11 @@ H.defaultOptions = {
126
150
  * Short week days, starting Sunday. If not specified, Highcharts uses
127
151
  * the first three letters of the `lang.weekdays` option.
128
152
  *
129
- * @type {Array<String>}
130
153
  * @sample highcharts/lang/shortweekdays/
131
154
  * Finnish two-letter abbreviations
132
- * @since 4.2.4
155
+ *
156
+ * @type {Array<string>}
157
+ * @since 4.2.4
133
158
  * @apioption lang.shortWeekdays
134
159
  */
135
160
 
@@ -137,18 +162,36 @@ H.defaultOptions = {
137
162
  * What to show in a date field for invalid dates. Defaults to an empty
138
163
  * string.
139
164
  *
140
- * @type {String}
141
- * @since 4.1.8
142
- * @product highcharts highstock
165
+ * @type {string}
166
+ * @since 4.1.8
167
+ * @product highcharts highstock
143
168
  * @apioption lang.invalidDate
144
169
  */
145
170
 
171
+ /**
172
+ * The title appearing on hovering the zoom in button. The text itself
173
+ * defaults to "+" and can be changed in the button options.
174
+ *
175
+ * @type {string}
176
+ * @default Zoom in
177
+ * @product highmaps
178
+ * @apioption lang.zoomIn
179
+ */
180
+
181
+ /**
182
+ * The title appearing on hovering the zoom out button. The text itself
183
+ * defaults to "-" and can be changed in the button options.
184
+ *
185
+ * @type {string}
186
+ * @default Zoom out
187
+ * @product highmaps
188
+ * @apioption lang.zoomOut
189
+ */
190
+
146
191
  /**
147
192
  * The default decimal point used in the `Highcharts.numberFormat`
148
193
  * method unless otherwise specified in the function arguments.
149
194
  *
150
- * @type {String}
151
- * @default .
152
195
  * @since 1.2.2
153
196
  */
154
197
  decimalPoint: '.',
@@ -159,13 +202,14 @@ H.defaultOptions = {
159
202
  * positions with `null` causes the full number to be written. Setting
160
203
  * `numericSymbols` to `null` disables shortening altogether.
161
204
  *
162
- * @type {Array<String>}
163
205
  * @sample {highcharts} highcharts/lang/numericsymbols/
164
206
  * Replacing the symbols with text
165
207
  * @sample {highstock} highcharts/lang/numericsymbols/
166
208
  * Replacing the symbols with text
167
- * @default [ "k" , "M" , "G" , "T" , "P" , "E"]
168
- * @since 2.3.0
209
+ *
210
+ * @type {Array<string>}
211
+ * @default ["k", "M", "G", "T", "P", "E"]
212
+ * @since 2.3.0
169
213
  */
170
214
  numericSymbols: ['k', 'M', 'G', 'T', 'P', 'E'],
171
215
 
@@ -174,19 +218,18 @@ H.defaultOptions = {
174
218
  * Use 10000 for Japanese, Korean and various Chinese locales, which
175
219
  * use symbols for 10^4, 10^8 and 10^12.
176
220
  *
177
- * @type {Number}
178
221
  * @sample highcharts/lang/numericsymbolmagnitude/
179
222
  * 10000 magnitude for Japanese
180
- * @default 1000
181
- * @since 5.0.3
223
+ *
224
+ * @type {number}
225
+ * @default 1000
226
+ * @since 5.0.3
182
227
  * @apioption lang.numericSymbolMagnitude
183
228
  */
184
229
 
185
230
  /**
186
231
  * The text for the label appearing when a chart is zoomed.
187
232
  *
188
- * @type {String}
189
- * @default Reset zoom
190
233
  * @since 1.2.4
191
234
  */
192
235
  resetZoom: 'Reset zoom',
@@ -194,8 +237,6 @@ H.defaultOptions = {
194
237
  /**
195
238
  * The tooltip title for the label appearing when a chart is zoomed.
196
239
  *
197
- * @type {String}
198
- * @default Reset zoom level 1:1
199
240
  * @since 1.2.4
200
241
  */
201
242
  resetZoomTitle: 'Reset zoom level 1:1',
@@ -209,9 +250,8 @@ H.defaultOptions = {
209
250
  *
210
251
  * The default is a single space.
211
252
  *
212
- * @type {String}
213
- * @default
214
- * @since 1.2.2
253
+ * @default \u0020
254
+ * @since 1.2.2
215
255
  */
216
256
  thousandsSep: ' '
217
257
  },
@@ -240,10 +280,11 @@ H.defaultOptions = {
240
280
  * our site, you can install canvas-tools.js on your own server and
241
281
  * change this option accordingly.
242
282
  *
243
- * @type {String}
244
283
  * @deprecated
245
- * @default http://code.highcharts.com/{version}/modules/canvas-tools.js
246
- * @product highcharts highmaps
284
+ *
285
+ * @type {string}
286
+ * @default http://code.highcharts.com/{version}/modules/canvas-tools.js
287
+ * @product highcharts highmaps
247
288
  * @apioption global.canvasToolsURL
248
289
  */
249
290
 
@@ -253,7 +294,8 @@ H.defaultOptions = {
253
294
  * per chart.
254
295
  *
255
296
  * @deprecated
256
- * @type {Boolean}
297
+ *
298
+ * @type {boolean}
257
299
  * @apioption global.useUTC
258
300
  */
259
301
 
@@ -263,8 +305,9 @@ H.defaultOptions = {
263
305
  * per chart.
264
306
  *
265
307
  * @deprecated
266
- * @type {Object}
267
- * @product highcharts highstock
308
+ *
309
+ * @type {Function}
310
+ * @product highcharts highstock
268
311
  * @apioption global.Date
269
312
  */
270
313
 
@@ -274,8 +317,9 @@ H.defaultOptions = {
274
317
  * individual time settings per chart.
275
318
  *
276
319
  * @deprecated
277
- * @type {Function}
278
- * @product highcharts highstock
320
+ *
321
+ * @type {Function}
322
+ * @product highcharts highstock
279
323
  * @apioption global.getTimezoneOffset
280
324
  */
281
325
 
@@ -285,8 +329,9 @@ H.defaultOptions = {
285
329
  * settings per chart.
286
330
  *
287
331
  * @deprecated
288
- * @type {String}
289
- * @product highcharts highstock
332
+ *
333
+ * @type {string}
334
+ * @product highcharts highstock
290
335
  * @apioption global.timezone
291
336
  */
292
337
 
@@ -296,21 +341,44 @@ H.defaultOptions = {
296
341
  * time settings per chart.
297
342
  *
298
343
  * @deprecated
299
- * @type {Number}
300
- * @product highcharts highstock
344
+ *
345
+ * @type {number}
346
+ * @product highcharts highstock
301
347
  * @apioption global.timezoneOffset
302
348
  */
303
- global: {},
304
349
 
350
+ global: {},
305
351
 
306
352
  time: H.Time.prototype.defaultOptions,
307
353
 
308
354
  /**
309
355
  * General options for the chart.
310
- * @type {Object}
311
356
  */
312
357
  chart: {
313
358
 
359
+ /**
360
+ * Default `mapData` for all series. If set to a string, it functions
361
+ * as an index into the `Highcharts.maps` array. Otherwise it is
362
+ * interpreted s map data.
363
+ *
364
+ * @see [mapData](#series.map.mapData)
365
+ *
366
+ * @type {string|Array<*>}
367
+ * @since 5.0.0
368
+ * @product highmaps
369
+ * @apioption chart.map
370
+ */
371
+
372
+ /**
373
+ * Set lat/lon transformation definitions for the chart. If not defined,
374
+ * these are extracted from the map data.
375
+ *
376
+ * @type {*}
377
+ * @since 5.0.0
378
+ * @product highmaps
379
+ * @apioption chart.mapTransforms
380
+ */
381
+
314
382
  /**
315
383
  * When using multiple axis, the ticks of two or more opposite axes
316
384
  * will automatically be aligned by adding ticks to the axis or axes
@@ -325,21 +393,21 @@ H.defaultOptions = {
325
393
  *
326
394
  * Disabled for logarithmic axes.
327
395
  *
328
- * @type {Boolean}
329
- * @sample {highcharts} highcharts/chart/alignticks-true/
330
- * True by default
331
- * @sample {highcharts} highcharts/chart/alignticks-false/
332
- * False
333
- * @sample {highstock} stock/chart/alignticks-true/
334
- * True by default
335
- * @sample {highstock} stock/chart/alignticks-false/
336
- * False
396
+ * @sample {highcharts} highcharts/chart/alignticks-true/
397
+ * True by default
398
+ * @sample {highcharts} highcharts/chart/alignticks-false/
399
+ * False
400
+ * @sample {highstock} stock/chart/alignticks-true/
401
+ * True by default
402
+ * @sample {highstock} stock/chart/alignticks-false/
403
+ * False
404
+ *
405
+ * @type {boolean}
337
406
  * @default true
338
- * @product highcharts highstock
407
+ * @product highcharts highstock gantt
339
408
  * @apioption chart.alignTicks
340
409
  */
341
410
 
342
-
343
411
  /**
344
412
  * Set the overall animation for all chart updating. Animation can be
345
413
  * disabled throughout the chart by setting it to false here. It can
@@ -362,13 +430,12 @@ H.defaultOptions = {
362
430
  * <dt>easing</dt>
363
431
  *
364
432
  * <dd>A string reference to an easing function set on the `Math`
365
- * object. See [the easing demo](
366
- * http://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).
433
+ * object. See [the easing
434
+ * demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).
367
435
  * </dd>
368
436
  *
369
437
  * </dl>
370
438
  *
371
- * @type {Boolean|Object}
372
439
  * @sample {highcharts} highcharts/chart/animation-none/
373
440
  * Updating with no animation
374
441
  * @sample {highcharts} highcharts/chart/animation-duration/
@@ -379,7 +446,9 @@ H.defaultOptions = {
379
446
  * Updating with no animation
380
447
  * @sample {highmaps} maps/chart/animation-duration/
381
448
  * With a longer duration
382
- * @default true
449
+ *
450
+ * @type {boolean|Highcharts.AnimationOptionsObject}
451
+ * @default true
383
452
  * @apioption chart.animation
384
453
  */
385
454
 
@@ -387,7 +456,7 @@ H.defaultOptions = {
387
456
  * A CSS class name to apply to the charts container `div`, allowing
388
457
  * unique CSS styling for each chart.
389
458
  *
390
- * @type {String}
459
+ * @type {string}
391
460
  * @apioption chart.className
392
461
  */
393
462
 
@@ -405,11 +474,14 @@ H.defaultOptions = {
405
474
  * passed to the `addSeries` method. Returning false prevents the series
406
475
  * from being added.
407
476
  *
408
- * @type {Function}
409
- * @context Chart
410
- * @sample {highcharts} highcharts/chart/events-addseries/ Alert on add series
411
- * @sample {highstock} stock/chart/events-addseries/ Alert on add series
412
- * @since 1.2.0
477
+ * @sample {highcharts} highcharts/chart/events-addseries/
478
+ * Alert on add series
479
+ * @sample {highstock} stock/chart/events-addseries/
480
+ * Alert on add series
481
+ *
482
+ * @type {Function}
483
+ * @since 1.2.0
484
+ * @context Highcharts.Chart
413
485
  * @apioption chart.events.addSeries
414
486
  */
415
487
 
@@ -430,8 +502,6 @@ H.defaultOptions = {
430
502
  * )
431
503
  * }</pre>
432
504
  *
433
- * @type {Function}
434
- * @context Chart
435
505
  * @sample {highcharts} highcharts/chart/events-click/
436
506
  * Alert coordinates on click
437
507
  * @sample {highcharts} highcharts/chart/events-container/
@@ -444,7 +514,10 @@ H.defaultOptions = {
444
514
  * Record coordinates on click
445
515
  * @sample {highmaps} highcharts/chart/events-container/
446
516
  * Alternatively, attach event to container
447
- * @since 1.2.0
517
+ *
518
+ * @type {Function}
519
+ * @since 1.2.0
520
+ * @context Highcharts.Chart
448
521
  * @apioption chart.events.click
449
522
  */
450
523
 
@@ -458,14 +531,15 @@ H.defaultOptions = {
458
531
  * There is also a second parameter to the chart constructor where a
459
532
  * callback function can be passed to be executed on chart.load.
460
533
  *
461
- * @type {Function}
462
- * @context Chart
463
534
  * @sample {highcharts} highcharts/chart/events-load/
464
535
  * Alert on chart load
465
536
  * @sample {highstock} stock/chart/events-load/
466
537
  * Alert on chart load
467
538
  * @sample {highmaps} maps/chart/events-load/
468
539
  * Add series on chart load
540
+ *
541
+ * @type {Function}
542
+ * @context Highcharts.Chart
469
543
  * @apioption chart.events.load
470
544
  */
471
545
 
@@ -475,8 +549,6 @@ H.defaultOptions = {
475
549
  * the `redraw` option set to true. One parameter, `event`, is passed to
476
550
  * the function, containing common event information.
477
551
  *
478
- * @type {Function}
479
- * @context Chart
480
552
  * @sample {highcharts} highcharts/chart/events-redraw/
481
553
  * Alert on chart redraw
482
554
  * @sample {highstock} stock/chart/events-redraw/
@@ -484,7 +556,10 @@ H.defaultOptions = {
484
556
  * zoomed range
485
557
  * @sample {highmaps} maps/chart/events-redraw/
486
558
  * Set subtitle on chart redraw
487
- * @since 1.2.0
559
+ *
560
+ * @type {Function}
561
+ * @since 1.2.0
562
+ * @context Highcharts.Chart
488
563
  * @apioption chart.events.redraw
489
564
  */
490
565
 
@@ -492,9 +567,9 @@ H.defaultOptions = {
492
567
  * Fires after initial load of the chart (directly after the `load`
493
568
  * event), and after each redraw (directly after the `redraw` event).
494
569
  *
495
- * @type {Function}
496
- * @context Chart
497
- * @since 5.0.7
570
+ * @type {Function}
571
+ * @since 5.0.7
572
+ * @context Highcharts.Chart
498
573
  * @apioption chart.events.render
499
574
  */
500
575
 
@@ -528,7 +603,6 @@ H.defaultOptions = {
528
603
  * console.log(event.yAxis[0].min, event.yAxis[0].max);
529
604
  * }</pre>
530
605
  *
531
- * @type {Function}
532
606
  * @sample {highcharts} highcharts/chart/events-selection/
533
607
  * Report on selection and reset
534
608
  * @sample {highcharts} highcharts/chart/events-selection-points/
@@ -538,6 +612,8 @@ H.defaultOptions = {
538
612
  * @sample {highstock} highcharts/chart/events-selection-points/
539
613
  * Select a range of points through a drag selection
540
614
  * (Highcharts)
615
+ *
616
+ * @type {Function}
541
617
  * @apioption chart.events.selection
542
618
  */
543
619
 
@@ -552,13 +628,12 @@ H.defaultOptions = {
552
628
  * subtitle and legend in addition to the `spacingTop`, `spacingRight`,
553
629
  * `spacingBottom` and `spacingLeft` options.
554
630
  *
555
- * @type {Array}
556
631
  * @sample {highcharts} highcharts/chart/margins-zero/
557
632
  * Zero margins
558
633
  * @sample {highstock} stock/chart/margin-zero/
559
634
  * Zero margins
560
635
  *
561
- * @defaults {all} null
636
+ * @type {number|Array<number>}
562
637
  * @apioption chart.margin
563
638
  */
564
639
 
@@ -567,14 +642,15 @@ H.defaultOptions = {
567
642
  * area. Use this to set a fixed pixel value for the margin as opposed
568
643
  * to the default dynamic margin. See also `spacingBottom`.
569
644
  *
570
- * @type {Number}
571
645
  * @sample {highcharts} highcharts/chart/marginbottom/
572
646
  * 100px bottom margin
573
647
  * @sample {highstock} stock/chart/marginbottom/
574
648
  * 100px bottom margin
575
649
  * @sample {highmaps} maps/chart/margin/
576
650
  * 100px margins
577
- * @since 2.0
651
+ *
652
+ * @type {number}
653
+ * @since 2.0
578
654
  * @apioption chart.marginBottom
579
655
  */
580
656
 
@@ -583,15 +659,15 @@ H.defaultOptions = {
583
659
  * area. Use this to set a fixed pixel value for the margin as opposed
584
660
  * to the default dynamic margin. See also `spacingLeft`.
585
661
  *
586
- * @type {Number}
587
662
  * @sample {highcharts} highcharts/chart/marginleft/
588
663
  * 150px left margin
589
664
  * @sample {highstock} stock/chart/marginleft/
590
665
  * 150px left margin
591
666
  * @sample {highmaps} maps/chart/margin/
592
667
  * 100px margins
593
- * @default null
594
- * @since 2.0
668
+ *
669
+ * @type {number}
670
+ * @since 2.0
595
671
  * @apioption chart.marginLeft
596
672
  */
597
673
 
@@ -600,15 +676,15 @@ H.defaultOptions = {
600
676
  * area. Use this to set a fixed pixel value for the margin as opposed
601
677
  * to the default dynamic margin. See also `spacingRight`.
602
678
  *
603
- * @type {Number}
604
679
  * @sample {highcharts} highcharts/chart/marginright/
605
680
  * 100px right margin
606
681
  * @sample {highstock} stock/chart/marginright/
607
682
  * 100px right margin
608
683
  * @sample {highmaps} maps/chart/margin/
609
684
  * 100px margins
610
- * @default null
611
- * @since 2.0
685
+ *
686
+ * @type {number}
687
+ * @since 2.0
612
688
  * @apioption chart.marginRight
613
689
  */
614
690
 
@@ -617,14 +693,14 @@ H.defaultOptions = {
617
693
  * Use this to set a fixed pixel value for the margin as opposed to
618
694
  * the default dynamic margin. See also `spacingTop`.
619
695
  *
620
- * @type {Number}
621
696
  * @sample {highcharts} highcharts/chart/margintop/ 100px top margin
622
697
  * @sample {highstock} stock/chart/margintop/
623
698
  * 100px top margin
624
699
  * @sample {highmaps} maps/chart/margin/
625
700
  * 100px margins
626
- * @default null
627
- * @since 2.0
701
+ *
702
+ * @type {number}
703
+ * @since 2.0
628
704
  * @apioption chart.marginTop
629
705
  */
630
706
 
@@ -635,11 +711,11 @@ H.defaultOptions = {
635
711
  * properties of the click event argument (`event.altKey`,
636
712
  * `event.ctrlKey`, `event.metaKey` and `event.shiftKey`).
637
713
  *
638
- * @validvalue [null, "alt", "ctrl", "meta", "shift"]
639
- * @type {String}
640
- * @since 4.0.3
641
- * @product highcharts
642
- * @apioption chart.panKey
714
+ * @type {string}
715
+ * @since 4.0.3
716
+ * @product highcharts gantt
717
+ * @validvalue ["alt", "ctrl", "meta", "shift"]
718
+ * @apioption chart.panKey
643
719
  */
644
720
 
645
721
  /**
@@ -651,12 +727,13 @@ H.defaultOptions = {
651
727
  * requires two fingers. To allow panning with one finger, set
652
728
  * `followTouchMove` to `false`.
653
729
  *
654
- * @type {Boolean}
655
730
  * @sample {highcharts} highcharts/chart/pankey/ Zooming and panning
656
- * @default {highcharts} false
657
- * @default {highstock} true
658
- * @since 4.0.3
659
- * @product highcharts highstock
731
+ *
732
+ * @type {boolean}
733
+ * @default {highcharts} false
734
+ * @default {highstock} true
735
+ * @since 4.0.3
736
+ * @product highcharts highstock gantt
660
737
  * @apioption chart.panning
661
738
  */
662
739
 
@@ -670,35 +747,38 @@ H.defaultOptions = {
670
747
  * #tooltip.followTouchMove) is true, pinchType only applies to
671
748
  * two-finger touches.
672
749
  *
673
- * @validvalue [null, "x", "y", "xy"]
674
- * @type {String}
675
- * @default {highcharts} null
676
- * @default {highstock} x
677
- * @since 3.0
678
- * @product highcharts highstock
679
- * @apioption chart.pinchType
750
+ * @type {string}
751
+ * @default {highcharts} undefined
752
+ * @default {highstock} x
753
+ * @since 3.0
754
+ * @product highcharts highstock gantt
755
+ * @validvalue ["x", "y", "xy"]
756
+ * @apioption chart.pinchType
680
757
  */
681
758
 
682
759
  /**
683
760
  * The corner radius of the outer chart border.
684
761
  *
685
- * @type {Number}
686
- * @sample {highcharts} highcharts/chart/borderradius/ 20px radius
687
- * @sample {highstock} stock/chart/border/ 10px radius
688
- * @sample {highmaps} maps/chart/border/ Border options
689
- * @default 0
762
+ * @sample {highcharts} highcharts/chart/borderradius/
763
+ * 20px radius
764
+ * @sample {highstock} stock/chart/border/
765
+ * 10px radius
766
+ * @sample {highmaps} maps/chart/border/
767
+ * Border options
768
+ *
690
769
  */
691
770
  borderRadius: 0,
771
+
692
772
 
693
773
 
694
774
  /**
695
775
  * Alias of `type`.
696
776
  *
697
- * @validvalue ["line", "spline", "column", "area", "areaspline", "pie"]
698
- * @type {String}
777
+ * @sample {highcharts} highcharts/chart/defaultseriestype/
778
+ * Bar
779
+ *
699
780
  * @deprecated
700
- * @sample {highcharts} highcharts/chart/defaultseriestype/ Bar
701
- * @default line
781
+ *
702
782
  * @product highcharts
703
783
  */
704
784
  defaultSeriesType: 'line',
@@ -710,7 +790,6 @@ H.defaultOptions = {
710
790
  * within the stack is hidden, the rest of the stack will close in
711
791
  * around it even if the axis is not affected.
712
792
  *
713
- * @type {Boolean}
714
793
  * @sample {highcharts} highcharts/chart/ignorehiddenseries-true/
715
794
  * True by default
716
795
  * @sample {highcharts} highcharts/chart/ignorehiddenseries-false/
@@ -721,9 +800,9 @@ H.defaultOptions = {
721
800
  * True by default
722
801
  * @sample {highstock} stock/chart/ignorehiddenseries-false/
723
802
  * False
724
- * @default true
725
- * @since 1.2.0
726
- * @product highcharts highstock
803
+ *
804
+ * @since 1.2.0
805
+ * @product highcharts highstock gantt
727
806
  */
728
807
  ignoreHiddenSeries: true,
729
808
 
@@ -739,13 +818,14 @@ H.defaultOptions = {
739
818
  * are no cartesian series in the chart, or if the chart is
740
819
  * [polar](#chart.polar).
741
820
  *
742
- * @type {Boolean}
743
821
  * @sample {highcharts} highcharts/chart/inverted/
744
822
  * Inverted line
745
823
  * @sample {highstock} stock/navigator/inverted/
746
824
  * Inverted stock chart
747
- * @default false
748
- * @product highcharts highstock
825
+ *
826
+ * @type {boolean}
827
+ * @default false
828
+ * @product highcharts highstock gantt
749
829
  * @apioption chart.inverted
750
830
  */
751
831
 
@@ -756,17 +836,16 @@ H.defaultOptions = {
756
836
  * respectively. Use the options spacingTop, spacingRight, spacingBottom
757
837
  * and spacingLeft options for shorthand setting of one option.
758
838
  *
759
- * @type {Array<Number>}
760
- * @see [chart.margin](#chart.margin)
839
+ * @type {Array<number>}
840
+ * @see [chart.margin](#chart.margin)
761
841
  * @default [10, 10, 15, 10]
762
- * @since 3.0.6
842
+ * @since 3.0.6
763
843
  */
764
844
  spacing: [10, 10, 15, 10],
765
845
 
766
846
  /**
767
847
  * The button that appears after a selection zoom, allowing the user
768
848
  * to reset zoom.
769
- *
770
849
  */
771
850
  resetZoomButton: {
772
851
 
@@ -774,15 +853,16 @@ H.defaultOptions = {
774
853
  * What frame the button should be placed related to. Can be either
775
854
  * `plot` or `chart`
776
855
  *
777
- * @validvalue ["plot", "chart"]
778
- * @type {String}
779
856
  * @sample {highcharts} highcharts/chart/resetzoombutton-relativeto/
780
857
  * Relative to the chart
781
858
  * @sample {highstock} highcharts/chart/resetzoombutton-relativeto/
782
859
  * Relative to the chart
783
- * @default plot
784
- * @since 2.2
785
- * @apioption chart.resetZoomButton.relativeTo
860
+ *
861
+ * @type {string}
862
+ * @default plot
863
+ * @since 2.2
864
+ * @validvalue ["plot", "chart"]
865
+ * @apioption chart.resetZoomButton.relativeTo
786
866
  */
787
867
 
788
868
  /**
@@ -792,11 +872,11 @@ H.defaultOptions = {
792
872
  * CSS properties for the text. Equivalent attributes for the hover
793
873
  * state are given in `theme.states.hover`.
794
874
  *
795
- * @type {Object}
796
875
  * @sample {highcharts} highcharts/chart/resetzoombutton-theme/
797
876
  * Theming the button
798
877
  * @sample {highstock} highcharts/chart/resetzoombutton-theme/
799
878
  * Theming the button
879
+ *
800
880
  * @since 2.2
801
881
  */
802
882
  theme: {
@@ -811,44 +891,38 @@ H.defaultOptions = {
811
891
  /**
812
892
  * The position of the button.
813
893
  *
814
- * @type {Object}
815
894
  * @sample {highcharts} highcharts/chart/resetzoombutton-position/
816
895
  * Above the plot area
817
896
  * @sample {highstock} highcharts/chart/resetzoombutton-position/
818
897
  * Above the plot area
819
898
  * @sample {highmaps} highcharts/chart/resetzoombutton-position/
820
899
  * Above the plot area
900
+ *
821
901
  * @since 2.2
822
902
  */
823
903
  position: {
824
904
 
825
905
  /**
826
906
  * The horizontal alignment of the button.
827
- *
828
- * @type {String}
829
907
  */
830
908
  align: 'right',
831
909
 
832
910
  /**
833
911
  * The horizontal offset of the button.
834
- *
835
- * @type {Number}
836
912
  */
837
913
  x: -10,
838
914
 
839
915
  /**
840
916
  * The vertical alignment of the button.
841
917
  *
918
+ * @type {string}
919
+ * @default top
842
920
  * @validvalue ["top", "middle", "bottom"]
843
- * @type {String}
844
- * @default top
845
- * @apioption chart.resetZoomButton.position.verticalAlign
921
+ * @apioption chart.resetZoomButton.position.verticalAlign
846
922
  */
847
923
 
848
924
  /**
849
925
  * The vertical offset of the button.
850
- *
851
- * @type {Number}
852
926
  */
853
927
  y: 10
854
928
  }
@@ -857,13 +931,15 @@ H.defaultOptions = {
857
931
  /**
858
932
  * The pixel width of the plot area border.
859
933
  *
860
- * @type {Number}
861
- * @sample {highcharts} highcharts/chart/plotborderwidth/ 1px border
934
+ * @sample {highcharts} highcharts/chart/plotborderwidth/
935
+ * 1px border
862
936
  * @sample {highstock} stock/chart/plotborder/
863
937
  * 2px border
864
938
  * @sample {highmaps} maps/chart/plotborder/
865
939
  * Plot border options
866
- * @default 0
940
+ *
941
+ * @type {number}
942
+ * @default 0
867
943
  * @apioption chart.plotBorderWidth
868
944
  */
869
945
 
@@ -872,13 +948,15 @@ H.defaultOptions = {
872
948
  * plotBackgroundColor be set. The shadow can be an object configuration
873
949
  * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
874
950
  *
875
- * @type {Boolean|Object}
876
- * @sample {highcharts} highcharts/chart/plotshadow/ Plot shadow
951
+ * @sample {highcharts} highcharts/chart/plotshadow/
952
+ * Plot shadow
877
953
  * @sample {highstock} stock/chart/plotshadow/
878
954
  * Plot shadow
879
955
  * @sample {highmaps} maps/chart/plotborder/
880
956
  * Plot border options
881
- * @default false
957
+ *
958
+ * @type {boolean|Highcharts.CSSObject}
959
+ * @default false
882
960
  * @apioption chart.plotShadow
883
961
  */
884
962
 
@@ -896,10 +974,10 @@ H.defaultOptions = {
896
974
  * @sample {highcharts} highcharts/parallel-coordinates/polar/
897
975
  * Star plot, multivariate data in a polar chart
898
976
  *
899
- * @type {Boolean}
900
- * @default false
901
- * @since 2.3.0
902
- * @product highcharts
977
+ * @type {boolean}
978
+ * @default false
979
+ * @since 2.3.0
980
+ * @product highcharts
903
981
  * @apioption chart.polar
904
982
  */
905
983
 
@@ -907,9 +985,10 @@ H.defaultOptions = {
907
985
  * Whether to reflow the chart to fit the width of the container div
908
986
  * on resizing the window.
909
987
  *
910
- * @type {Boolean}
911
- * @sample {highcharts} highcharts/chart/reflow-true/ True by default
912
- * @sample {highcharts} highcharts/chart/reflow-false/ False
988
+ * @sample {highcharts} highcharts/chart/reflow-true/
989
+ * True by default
990
+ * @sample {highcharts} highcharts/chart/reflow-false/
991
+ * False
913
992
  * @sample {highstock} stock/chart/reflow-true/
914
993
  * True by default
915
994
  * @sample {highstock} stock/chart/reflow-false/
@@ -918,8 +997,10 @@ H.defaultOptions = {
918
997
  * True by default
919
998
  * @sample {highmaps} maps/chart/reflow-false/
920
999
  * False
921
- * @default true
922
- * @since 2.1
1000
+ *
1001
+ * @type {boolean}
1002
+ * @default true
1003
+ * @since 2.1
923
1004
  * @apioption chart.reflow
924
1005
  */
925
1006
 
@@ -929,7 +1010,6 @@ H.defaultOptions = {
929
1010
  * by direct reference, or as the first argument of the chart
930
1011
  * constructor, in which case the option is not needed.
931
1012
  *
932
- * @type {String|Object}
933
1013
  * @sample {highcharts} highcharts/chart/reflow-true/
934
1014
  * String
935
1015
  * @sample {highcharts} highcharts/chart/renderto-object/
@@ -942,6 +1022,8 @@ H.defaultOptions = {
942
1022
  * Object reference
943
1023
  * @sample {highstock} stock/chart/renderto-jquery/
944
1024
  * Object reference through jQuery
1025
+ *
1026
+ * @type {string|Highcharts.SVGDOMElement}
945
1027
  * @apioption chart.renderTo
946
1028
  */
947
1029
 
@@ -949,11 +1031,12 @@ H.defaultOptions = {
949
1031
  * The background color of the marker square when selecting (zooming
950
1032
  * in on) an area of the chart.
951
1033
  *
952
- * @type {Color}
953
1034
  * @see In styled mode, the selection marker fill is set with the
954
- * `.highcharts-selection-marker` class.
955
- * @default rgba(51,92,173,0.25)
956
- * @since 2.1.7
1035
+ * `.highcharts-selection-marker` class.
1036
+ *
1037
+ * @type {Highcharts.ColorString}
1038
+ * @default rgba(51,92,173,0.25)
1039
+ * @since 2.1.7
957
1040
  * @apioption chart.selectionMarkerFill
958
1041
  */
959
1042
 
@@ -963,13 +1046,15 @@ H.defaultOptions = {
963
1046
  * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
964
1047
  * `width`.
965
1048
  *
966
- * @type {Boolean|Object}
967
- * @sample {highcharts} highcharts/chart/shadow/ Shadow
1049
+ * @sample {highcharts} highcharts/chart/shadow/
1050
+ * Shadow
968
1051
  * @sample {highstock} stock/chart/shadow/
969
1052
  * Shadow
970
1053
  * @sample {highmaps} maps/chart/border/
971
1054
  * Chart border and shadow
972
- * @default false
1055
+ *
1056
+ * @type {boolean|Highcharts.CSSObject}
1057
+ * @default false
973
1058
  * @apioption chart.shadow
974
1059
  */
975
1060
 
@@ -978,11 +1063,14 @@ H.defaultOptions = {
978
1063
  * where series are added dynamically, as axes are automatically added
979
1064
  * to cartesian series.
980
1065
  *
981
- * @type {Boolean}
982
- * @sample {highcharts} highcharts/chart/showaxes-false/ False by default
983
- * @sample {highcharts} highcharts/chart/showaxes-true/ True
984
- * @since 1.2.5
985
- * @product highcharts
1066
+ * @sample {highcharts} highcharts/chart/showaxes-false/
1067
+ * False by default
1068
+ * @sample {highcharts} highcharts/chart/showaxes-true/
1069
+ * True
1070
+ *
1071
+ * @type {boolean}
1072
+ * @since 1.2.5
1073
+ * @product highcharts gantt
986
1074
  * @apioption chart.showAxes
987
1075
  */
988
1076
 
@@ -991,15 +1079,16 @@ H.defaultOptions = {
991
1079
  * area, axis title and labels, title, subtitle or legend in top
992
1080
  * position).
993
1081
  *
994
- * @type {Number}
995
1082
  * @sample {highcharts} highcharts/chart/spacingbottom/
996
1083
  * Spacing bottom set to 100
997
1084
  * @sample {highstock} stock/chart/spacingbottom/
998
1085
  * Spacing bottom set to 100
999
1086
  * @sample {highmaps} maps/chart/spacing/
1000
1087
  * Spacing 100 all around
1001
- * @default 15
1002
- * @since 2.1
1088
+ *
1089
+ * @type {number}
1090
+ * @default 15
1091
+ * @since 2.1
1003
1092
  * @apioption chart.spacingBottom
1004
1093
  */
1005
1094
 
@@ -1008,15 +1097,16 @@ H.defaultOptions = {
1008
1097
  * area, axis title and labels, title, subtitle or legend in top
1009
1098
  * position).
1010
1099
  *
1011
- * @type {Number}
1012
1100
  * @sample {highcharts} highcharts/chart/spacingleft/
1013
1101
  * Spacing left set to 100
1014
1102
  * @sample {highstock} stock/chart/spacingleft/
1015
1103
  * Spacing left set to 100
1016
1104
  * @sample {highmaps} maps/chart/spacing/
1017
1105
  * Spacing 100 all around
1018
- * @default 10
1019
- * @since 2.1
1106
+ *
1107
+ * @type {number}
1108
+ * @default 10
1109
+ * @since 2.1
1020
1110
  * @apioption chart.spacingLeft
1021
1111
  */
1022
1112
 
@@ -1025,7 +1115,6 @@ H.defaultOptions = {
1025
1115
  * area, axis title and labels, title, subtitle or legend in top
1026
1116
  * position).
1027
1117
  *
1028
- * @type {Number}
1029
1118
  * @sample {highcharts} highcharts/chart/spacingright-100/
1030
1119
  * Spacing set to 100
1031
1120
  * @sample {highcharts} highcharts/chart/spacingright-legend/
@@ -1034,8 +1123,10 @@ H.defaultOptions = {
1034
1123
  * Spacing set to 100
1035
1124
  * @sample {highmaps} maps/chart/spacing/
1036
1125
  * Spacing 100 all around
1037
- * @default 10
1038
- * @since 2.1
1126
+ *
1127
+ * @type {number}
1128
+ * @default 10
1129
+ * @since 2.1
1039
1130
  * @apioption chart.spacingRight
1040
1131
  */
1041
1132
 
@@ -1044,7 +1135,6 @@ H.defaultOptions = {
1044
1135
  * area, axis title and labels, title, subtitle or legend in top
1045
1136
  * position).
1046
1137
  *
1047
- * @type {Number}
1048
1138
  * @sample {highcharts} highcharts/chart/spacingtop-100/
1049
1139
  * A top spacing of 100
1050
1140
  * @sample {highcharts} highcharts/chart/spacingtop-10/
@@ -1054,8 +1144,10 @@ H.defaultOptions = {
1054
1144
  * A top spacing of 100
1055
1145
  * @sample {highmaps} maps/chart/spacing/
1056
1146
  * Spacing 100 all around
1057
- * @default 10
1058
- * @since 2.1
1147
+ *
1148
+ * @type {number}
1149
+ * @default 10
1150
+ * @since 2.1
1059
1151
  * @apioption chart.spacingTop
1060
1152
  */
1061
1153
 
@@ -1064,7 +1156,6 @@ H.defaultOptions = {
1064
1156
  * that since the default font styles are applied in the renderer, it
1065
1157
  * is ignorant of the individual chart options and must be set globally.
1066
1158
  *
1067
- * @type {CSSObject}
1068
1159
  * @see In styled mode, general chart styles can be set with the
1069
1160
  * `.highcharts-root` class.
1070
1161
  * @sample {highcharts} highcharts/chart/style-serif-font/
@@ -1075,7 +1166,9 @@ H.defaultOptions = {
1075
1166
  * Using a serif type font
1076
1167
  * @sample {highmaps} maps/chart/style-serif-font/
1077
1168
  * Using a serif type font
1078
- * @default {"fontFamily":"\"Lucida Grande\", \"Lucida Sans Unicode\", Verdana, Arial, Helvetica, sans-serif","fontSize":"12px"}
1169
+ *
1170
+ * @type {Highcharts.CSSObject}
1171
+ * @default {"fontFamily": "\"Lucida Grande\", \"Lucida Sans Unicode\", Verdana, Arial, Helvetica, sans-serif","fontSize":"12px"}
1079
1172
  * @apioption chart.style
1080
1173
  */
1081
1174
 
@@ -1083,49 +1176,67 @@ H.defaultOptions = {
1083
1176
  * The default series type for the chart. Can be any of the chart types
1084
1177
  * listed under [plotOptions](#plotOptions).
1085
1178
  *
1086
- * @validvalue ["line", "spline", "column", "bar", "area", "areaspline", "pie", "arearange", "areasplinerange", "boxplot", "bubble", "columnrange", "errorbar", "funnel", "gauge", "heatmap", "polygon", "pyramid", "scatter", "solidgauge", "treemap", "waterfall"]
1087
- * @type {String}
1088
- * @sample {highcharts} highcharts/chart/type-bar/ Bar
1179
+ * @sample {highcharts} highcharts/chart/type-bar/
1180
+ * Bar
1089
1181
  * @sample {highstock} stock/chart/type/
1090
1182
  * Areaspline
1091
1183
  * @sample {highmaps} maps/chart/type-mapline/
1092
1184
  * Mapline
1093
- * @default {highcharts} line
1094
- * @default {highstock} line
1095
- * @default {highmaps} map
1096
- * @since 2.1.0
1097
- * @apioption chart.type
1185
+ *
1186
+ * @type {string}
1187
+ * @default {highcharts} line
1188
+ * @default {highstock} line
1189
+ * @default {highmaps} map
1190
+ * @since 2.1.0
1191
+ * @validvalue ["line", "spline", "column", "bar", "area", "areaspline",
1192
+ * "pie", "arearange", "areasplinerange", "boxplot",
1193
+ * "bubble", "columnrange", "errorbar", "funnel", "gauge",
1194
+ * "heatmap", "polygon", "pyramid", "scatter", "solidgauge",
1195
+ * "treemap", "waterfall"]
1196
+ * @apioption chart.type
1098
1197
  */
1099
1198
 
1100
1199
  /**
1101
1200
  * Decides in what dimensions the user can zoom by dragging the mouse.
1102
1201
  * Can be one of `x`, `y` or `xy`.
1103
1202
  *
1104
- * @validvalue [null, "x", "y", "xy"]
1105
- * @type {String}
1106
1203
  * @see [panKey](#chart.panKey)
1107
- * @default null
1108
- * @sample {highcharts} highcharts/chart/zoomtype-none/ None by default
1109
- * @sample {highcharts} highcharts/chart/zoomtype-x/ X
1110
- * @sample {highcharts} highcharts/chart/zoomtype-y/ Y
1111
- * @sample {highcharts} highcharts/chart/zoomtype-xy/ Xy
1112
- * @sample {highstock} stock/demo/basic-line/ None by default
1113
- * @sample {highstock} stock/chart/zoomtype-x/ X
1114
- * @sample {highstock} stock/chart/zoomtype-y/ Y
1115
- * @sample {highstock} stock/chart/zoomtype-xy/ Xy
1116
- * @product highcharts highstock
1117
- * @apioption chart.zoomType
1204
+ *
1205
+ * @sample {highcharts} highcharts/chart/zoomtype-none/
1206
+ * None by default
1207
+ * @sample {highcharts} highcharts/chart/zoomtype-x/
1208
+ * X
1209
+ * @sample {highcharts} highcharts/chart/zoomtype-y/
1210
+ * Y
1211
+ * @sample {highcharts} highcharts/chart/zoomtype-xy/
1212
+ * Xy
1213
+ * @sample {highstock} stock/demo/basic-line/
1214
+ * None by default
1215
+ * @sample {highstock} stock/chart/zoomtype-x/
1216
+ * X
1217
+ * @sample {highstock} stock/chart/zoomtype-y/
1218
+ * Y
1219
+ * @sample {highstock} stock/chart/zoomtype-xy/
1220
+ * Xy
1221
+ *
1222
+ * @type {string}
1223
+ * @product highcharts highstock gantt
1224
+ * @validvalue ["x", "y", "xy"]
1225
+ * @apioption chart.zoomType
1118
1226
  */
1119
1227
 
1120
1228
  /**
1121
1229
  * An explicit width for the chart. By default (when `null`) the width
1122
1230
  * is calculated from the offset width of the containing element.
1123
1231
  *
1124
- * @type {Number}
1125
- * @sample {highcharts} highcharts/chart/width/ 800px wide
1126
- * @sample {highstock} stock/chart/width/ 800px wide
1127
- * @sample {highmaps} maps/chart/size/ Chart with explicit size
1128
- * @default null
1232
+ * @sample {highcharts} highcharts/chart/width/
1233
+ * 800px wide
1234
+ * @sample {highstock} stock/chart/width/
1235
+ * 800px wide
1236
+ * @sample {highmaps} maps/chart/size/
1237
+ * Chart with explicit size
1238
+ *
1239
+ * @type {number|null}
1129
1240
  */
1130
1241
  width: null,
1131
1242
 
@@ -1140,7 +1251,6 @@ H.defaultOptions = {
1140
1251
  * height of the containing element, or 400 pixels if the containing
1141
1252
  * element's height is 0.
1142
1253
  *
1143
- * @type {Number|String}
1144
1254
  * @sample {highcharts} highcharts/chart/height/
1145
1255
  * 500px height
1146
1256
  * @sample {highstock} stock/chart/height/
@@ -1149,7 +1259,8 @@ H.defaultOptions = {
1149
1259
  * Chart with explicit size
1150
1260
  * @sample highcharts/chart/height-percent/
1151
1261
  * Highcharts with percentage height
1152
- * @default null
1262
+ *
1263
+ * @type {number|string|null}
1153
1264
  */
1154
1265
  height: null,
1155
1266
 
@@ -1158,39 +1269,48 @@ H.defaultOptions = {
1158
1269
  /**
1159
1270
  * The color of the outer chart border.
1160
1271
  *
1161
- * @type {Color}
1162
- * @see In styled mode, the stroke is set with the
1163
- * `.highcharts-background` class.
1164
- * @sample {highcharts} highcharts/chart/bordercolor/ Brown border
1165
- * @sample {highstock} stock/chart/border/ Brown border
1166
- * @sample {highmaps} maps/chart/border/ Border options
1167
- * @default #335cad
1272
+ * @see In styled mode, the stroke is set with the
1273
+ * `.highcharts-background` class.
1274
+ *
1275
+ * @sample {highcharts} highcharts/chart/bordercolor/
1276
+ * Brown border
1277
+ * @sample {highstock} stock/chart/border/
1278
+ * Brown border
1279
+ * @sample {highmaps} maps/chart/border/
1280
+ * Border options
1281
+ *
1282
+ * @type {Highcharts.ColorString}
1168
1283
  */
1169
1284
  borderColor: '#335cad',
1170
1285
 
1171
1286
  /**
1172
1287
  * The pixel width of the outer chart border.
1173
1288
  *
1174
- * @type {Number}
1175
- * @see In styled mode, the stroke is set with the
1176
- * `.highcharts-background` class.
1177
- * @sample {highcharts} highcharts/chart/borderwidth/ 5px border
1289
+ * @see In styled mode, the stroke is set with the
1290
+ * `.highcharts-background` class.
1291
+ *
1292
+ * @sample {highcharts} highcharts/chart/borderwidth/
1293
+ * 5px border
1178
1294
  * @sample {highstock} stock/chart/border/
1179
1295
  * 2px border
1180
1296
  * @sample {highmaps} maps/chart/border/
1181
1297
  * Border options
1182
- * @default 0
1298
+ *
1299
+ * @type {number}
1300
+ * @default 0
1183
1301
  * @apioption chart.borderWidth
1184
1302
  */
1185
1303
 
1186
1304
  /**
1187
1305
  * The background color or gradient for the outer chart area.
1188
1306
  *
1189
- * @type {Color}
1190
- * @see In styled mode, the background is set with the
1191
- * `.highcharts-background` class.
1192
- * @sample {highcharts} highcharts/chart/backgroundcolor-color/ Color
1193
- * @sample {highcharts} highcharts/chart/backgroundcolor-gradient/ Gradient
1307
+ * @see In styled mode, the background is set with the
1308
+ * `.highcharts-background` class.
1309
+ *
1310
+ * @sample {highcharts} highcharts/chart/backgroundcolor-color/
1311
+ * Color
1312
+ * @sample {highcharts} highcharts/chart/backgroundcolor-gradient/
1313
+ * Gradient
1194
1314
  * @sample {highstock} stock/chart/backgroundcolor-color/
1195
1315
  * Color
1196
1316
  * @sample {highstock} stock/chart/backgroundcolor-gradient/
@@ -1199,16 +1319,17 @@ H.defaultOptions = {
1199
1319
  * Color
1200
1320
  * @sample {highmaps} maps/chart/backgroundcolor-gradient/
1201
1321
  * Gradient
1202
- * @default #FFFFFF
1322
+ *
1323
+ * @type {Highcharts.ColorString}
1203
1324
  */
1204
1325
  backgroundColor: '#ffffff',
1205
1326
 
1206
1327
  /**
1207
1328
  * The background color or gradient for the plot area.
1208
1329
  *
1209
- * @type {Color}
1210
- * @see In styled mode, the plot background is set with the
1211
- * `.highcharts-plot-background` class.
1330
+ * @see In styled mode, the plot background is set with the
1331
+ * `.highcharts-plot-background` class.
1332
+ *
1212
1333
  * @sample {highcharts} highcharts/chart/plotbackgroundcolor-color/
1213
1334
  * Color
1214
1335
  * @sample {highcharts} highcharts/chart/plotbackgroundcolor-gradient/
@@ -1221,40 +1342,48 @@ H.defaultOptions = {
1221
1342
  * Color
1222
1343
  * @sample {highmaps} maps/chart/plotbackgroundcolor-gradient/
1223
1344
  * Gradient
1224
- * @default null
1345
+ *
1346
+ * @type {Highcharts.ColorString}
1225
1347
  * @apioption chart.plotBackgroundColor
1226
1348
  */
1227
1349
 
1228
-
1229
1350
  /**
1230
1351
  * The URL for an image to use as the plot background. To set an image
1231
1352
  * as the background for the entire chart, set a CSS background image
1232
1353
  * to the container element. Note that for the image to be applied to
1233
1354
  * exported charts, its URL needs to be accessible by the export server.
1234
1355
  *
1235
- * @type {String}
1236
1356
  * @see In styled mode, a plot background image can be set with the
1237
- * `.highcharts-plot-background` class and a [custom pattern](http://www.
1238
- * highcharts.com/docs/chart-design-and-style/gradients-shadows-and-
1239
- * patterns).
1240
- * @sample {highcharts} highcharts/chart/plotbackgroundimage/ Skies
1241
- * @sample {highstock} stock/chart/plotbackgroundimage/ Skies
1242
- * @default null
1357
+ * `.highcharts-plot-background` class and a [custom pattern](
1358
+ * https://www.highcharts.com/docs/chart-design-and-style/
1359
+ * gradients-shadows-and-patterns).
1360
+ *
1361
+ * @sample {highcharts} highcharts/chart/plotbackgroundimage/
1362
+ * Skies
1363
+ * @sample {highstock} stock/chart/plotbackgroundimage/
1364
+ * Skies
1365
+ *
1366
+ * @type {string}
1243
1367
  * @apioption chart.plotBackgroundImage
1244
1368
  */
1245
1369
 
1246
1370
  /**
1247
1371
  * The color of the inner chart or plot area border.
1248
1372
  *
1249
- * @type {Color}
1250
1373
  * @see In styled mode, a plot border stroke can be set with the
1251
1374
  * `.highcharts-plot-border` class.
1252
- * @sample {highcharts} highcharts/chart/plotbordercolor/ Blue border
1253
- * @sample {highstock} stock/chart/plotborder/ Blue border
1254
- * @sample {highmaps} maps/chart/plotborder/ Plot border options
1255
- * @default #cccccc
1375
+ *
1376
+ * @sample {highcharts} highcharts/chart/plotbordercolor/
1377
+ * Blue border
1378
+ * @sample {highstock} stock/chart/plotborder/
1379
+ * Blue border
1380
+ * @sample {highmaps} maps/chart/plotborder/
1381
+ * Plot border options
1382
+ *
1383
+ * @type {Highcharts.ColorString}
1256
1384
  */
1257
1385
  plotBorderColor: '#cccccc'
1386
+
1258
1387
 
1259
1388
 
1260
1389
  },
@@ -1262,7 +1391,8 @@ H.defaultOptions = {
1262
1391
  /**
1263
1392
  * The chart's main title.
1264
1393
  *
1265
- * @sample {highmaps} maps/title/title/ Title options demonstrated
1394
+ * @sample {highmaps} maps/title/title/
1395
+ * Title options demonstrated
1266
1396
  */
1267
1397
  title: {
1268
1398
 
@@ -1270,14 +1400,16 @@ H.defaultOptions = {
1270
1400
  * When the title is floating, the plot area will not move to make space
1271
1401
  * for it.
1272
1402
  *
1273
- * @type {Boolean}
1274
- * @sample {highcharts} highcharts/chart/zoomtype-none/ False by default
1403
+ * @sample {highcharts} highcharts/chart/zoomtype-none/
1404
+ * False by default
1275
1405
  * @sample {highcharts} highcharts/title/floating/
1276
1406
  * True - title on top of the plot area
1277
1407
  * @sample {highstock} stock/chart/title-floating/
1278
1408
  * True - title on top of the plot area
1279
- * @default false
1280
- * @since 2.1
1409
+ *
1410
+ * @type {boolean}
1411
+ * @default false
1412
+ * @since 2.1
1281
1413
  * @apioption title.floating
1282
1414
  */
1283
1415
 
@@ -1288,21 +1420,26 @@ H.defaultOptions = {
1288
1420
  * In styled mode, the title style is given in the `.highcharts-title`
1289
1421
  * class.
1290
1422
  *
1291
- * @type {CSSObject}
1292
- * @sample {highcharts} highcharts/title/style/ Custom color and weight
1293
- * @sample {highstock} stock/chart/title-style/ Custom color and weight
1294
- * @sample highcharts/css/titles/ Styled mode
1295
- * @default {highcharts|highmaps} { "color": "#333333", "fontSize": "18px" }
1296
- * @default {highstock} { "color": "#333333", "fontSize": "16px" }
1423
+ * @sample {highcharts} highcharts/title/style/
1424
+ * Custom color and weight
1425
+ * @sample {highstock} stock/chart/title-style/
1426
+ * Custom color and weight
1427
+ * @sample highcharts/css/titles/
1428
+ * Styled mode
1429
+ *
1430
+ * @type {Highcharts.CSSObject}
1431
+ * @default {highcharts|highmaps} { "color": "#333333", "fontSize": "18px" }
1432
+ * @default {highstock} { "color": "#333333", "fontSize": "16px" }
1297
1433
  * @apioption title.style
1298
1434
  */
1299
1435
 
1300
1436
  /**
1301
- * Whether to [use HTML](http://www.highcharts.com/docs/chart-concepts/labels-
1302
- * and-string-formatting#html) to render the text.
1437
+ * Whether to
1438
+ * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
1439
+ * to render the text.
1303
1440
  *
1304
- * @type {Boolean}
1305
- * @default false
1441
+ * @type {boolean}
1442
+ * @default false
1306
1443
  * @apioption title.useHTML
1307
1444
  */
1308
1445
 
@@ -1311,29 +1448,31 @@ H.defaultOptions = {
1311
1448
  * `"middle"` and `"bottom"`. When a value is given, the title behaves
1312
1449
  * as if [floating](#title.floating) were `true`.
1313
1450
  *
1314
- * @validvalue ["top", "middle", "bottom"]
1315
- * @type {String}
1316
1451
  * @sample {highcharts} highcharts/title/verticalalign/
1317
1452
  * Chart title in bottom right corner
1318
1453
  * @sample {highstock} stock/chart/title-verticalalign/
1319
1454
  * Chart title in bottom right corner
1320
- * @since 2.1
1321
- * @apioption title.verticalAlign
1455
+ *
1456
+ * @type {string}
1457
+ * @since 2.1
1458
+ * @validvalue ["top", "middle", "bottom"]
1459
+ * @apioption title.verticalAlign
1322
1460
  */
1323
1461
 
1324
1462
  /**
1325
1463
  * The x position of the title relative to the alignment within
1326
1464
  * `chart.spacingLeft` and `chart.spacingRight`.
1327
1465
  *
1328
- * @type {Number}
1329
1466
  * @sample {highcharts} highcharts/title/align/
1330
1467
  * Aligned to the plot area (x = 70px = margin left - spacing
1331
1468
  * left)
1332
1469
  * @sample {highstock} stock/chart/title-align/
1333
1470
  * Aligned to the plot area (x = 50px = margin left - spacing
1334
1471
  * left)
1335
- * @default 0
1336
- * @since 2.0
1472
+ *
1473
+ * @type {number}
1474
+ * @default 0
1475
+ * @since 2.0
1337
1476
  * @apioption title.x
1338
1477
  */
1339
1478
 
@@ -1342,24 +1481,27 @@ H.defaultOptions = {
1342
1481
  * [chart.spacingTop](#chart.spacingTop) and [chart.spacingBottom](
1343
1482
  * #chart.spacingBottom). By default it depends on the font size.
1344
1483
  *
1345
- * @type {Number}
1346
1484
  * @sample {highcharts} highcharts/title/y/
1347
1485
  * Title inside the plot area
1348
1486
  * @sample {highstock} stock/chart/title-verticalalign/
1349
1487
  * Chart title in bottom right corner
1350
- * @since 2.0
1488
+ *
1489
+ * @type {number}
1490
+ * @since 2.0
1351
1491
  * @apioption title.y
1352
1492
  */
1353
1493
 
1354
1494
  /**
1355
1495
  * The title of the chart. To disable the title, set the `text` to
1356
- * `null`.
1496
+ * `undefined`.
1497
+ *
1498
+ * @sample {highcharts} highcharts/title/text/
1499
+ * Custom title
1500
+ * @sample {highstock} stock/chart/title-text/
1501
+ * Custom title
1357
1502
  *
1358
- * @type {String}
1359
- * @sample {highcharts} highcharts/title/text/ Custom title
1360
- * @sample {highstock} stock/chart/title-text/ Custom title
1361
1503
  * @default {highcharts|highmaps} Chart title
1362
- * @default {highstock} null
1504
+ * @default {highstock} undefined
1363
1505
  */
1364
1506
  text: 'Chart title',
1365
1507
 
@@ -1367,16 +1509,15 @@ H.defaultOptions = {
1367
1509
  * The horizontal alignment of the title. Can be one of "left", "center"
1368
1510
  * and "right".
1369
1511
  *
1370
- * @validvalue ["left", "center", "right"]
1371
- * @type {String}
1372
1512
  * @sample {highcharts} highcharts/title/align/
1373
1513
  * Aligned to the plot area (x = 70px = margin left - spacing
1374
1514
  * left)
1375
1515
  * @sample {highstock} stock/chart/title-align/
1376
1516
  * Aligned to the plot area (x = 50px = margin left - spacing
1377
1517
  * left)
1378
- * @default center
1379
- * @since 2.0
1518
+ *
1519
+ * @since 2.0
1520
+ * @validvalue ["left", "center", "right"]
1380
1521
  */
1381
1522
  align: 'center',
1382
1523
 
@@ -1384,14 +1525,13 @@ H.defaultOptions = {
1384
1525
  * The margin between the title and the plot area, or if a subtitle
1385
1526
  * is present, the margin between the subtitle and the plot area.
1386
1527
  *
1387
- * @type {Number}
1388
1528
  * @sample {highcharts} highcharts/title/margin-50/
1389
1529
  * A chart title margin of 50
1390
1530
  * @sample {highcharts} highcharts/title/margin-subtitle/
1391
1531
  * The same margin applied with a subtitle
1392
1532
  * @sample {highstock} stock/chart/title-margin/
1393
1533
  * A chart title margin of 50
1394
- * @default 15
1534
+ *
1395
1535
  * @since 2.1
1396
1536
  */
1397
1537
  margin: 15,
@@ -1400,10 +1540,9 @@ H.defaultOptions = {
1400
1540
  * Adjustment made to the title width, normally to reserve space for
1401
1541
  * the exporting burger menu.
1402
1542
  *
1403
- * @type {Number}
1404
1543
  * @sample highcharts/title/widthadjust/
1405
1544
  * Wider menu, greater padding
1406
- * @default -44
1545
+ *
1407
1546
  * @since 4.2.5
1408
1547
  */
1409
1548
  widthAdjust: -44
@@ -1416,7 +1555,8 @@ H.defaultOptions = {
1416
1555
  * subtitle can be updated after chart initialization through the
1417
1556
  * `Chart.setTitle` method.
1418
1557
  *
1419
- * @sample {highmaps} maps/title/subtitle/ Subtitle options demonstrated
1558
+ * @sample {highmaps} maps/title/subtitle/
1559
+ * Subtitle options demonstrated
1420
1560
  */
1421
1561
  subtitle: {
1422
1562
 
@@ -1424,13 +1564,14 @@ H.defaultOptions = {
1424
1564
  * When the subtitle is floating, the plot area will not move to make
1425
1565
  * space for it.
1426
1566
  *
1427
- * @type {Boolean}
1428
1567
  * @sample {highcharts} highcharts/subtitle/floating/
1429
1568
  * Floating title and subtitle
1430
1569
  * @sample {highstock} stock/chart/subtitle-footnote
1431
1570
  * Footnote floating at bottom right of plot area
1432
- * @default false
1433
- * @since 2.1
1571
+ *
1572
+ * @type {boolean}
1573
+ * @default false
1574
+ * @since 2.1
1434
1575
  * @apioption subtitle.floating
1435
1576
  */
1436
1577
 
@@ -1440,7 +1581,6 @@ H.defaultOptions = {
1440
1581
  * In styled mode, the subtitle style is given in the
1441
1582
  * `.highcharts-subtitle` class.
1442
1583
  *
1443
- * @type {CSSObject}
1444
1584
  * @sample {highcharts} highcharts/subtitle/style/
1445
1585
  * Custom color and weight
1446
1586
  * @sample {highcharts} highcharts/css/titles/
@@ -1451,16 +1591,19 @@ H.defaultOptions = {
1451
1591
  * Styled mode
1452
1592
  * @sample {highmaps} highcharts/css/titles/
1453
1593
  * Styled mode
1454
- * @default { "color": "#666666" }
1594
+ *
1595
+ * @type {Highcharts.CSSObject}
1596
+ * @default {"color": "#666666"}
1455
1597
  * @apioption subtitle.style
1456
1598
  */
1457
1599
 
1458
1600
  /**
1459
- * Whether to [use HTML](http://www.highcharts.com/docs/chart-concepts/labels-
1460
- * and-string-formatting#html) to render the text.
1601
+ * Whether to
1602
+ * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
1603
+ * to render the text.
1461
1604
  *
1462
- * @type {Boolean}
1463
- * @default false
1605
+ * @type {boolean}
1606
+ * @default false
1464
1607
  * @apioption subtitle.useHTML
1465
1608
  */
1466
1609
 
@@ -1468,28 +1611,29 @@ H.defaultOptions = {
1468
1611
  * The vertical alignment of the title. Can be one of "top", "middle"
1469
1612
  * and "bottom". When a value is given, the title behaves as floating.
1470
1613
  *
1471
- * @validvalue ["top", "middle", "bottom"]
1472
- * @type {String}
1473
1614
  * @sample {highcharts} highcharts/subtitle/verticalalign/
1474
1615
  * Footnote at the bottom right of plot area
1475
1616
  * @sample {highstock} stock/chart/subtitle-footnote
1476
1617
  * Footnote at the bottom right of plot area
1477
- * @default
1478
- * @since 2.1
1479
- * @apioption subtitle.verticalAlign
1618
+ *
1619
+ * @type {string}
1620
+ * @since 2.1
1621
+ * @validvalue ["top", "middle", "bottom"]
1622
+ * @apioption subtitle.verticalAlign
1480
1623
  */
1481
1624
 
1482
1625
  /**
1483
1626
  * The x position of the subtitle relative to the alignment within
1484
1627
  * `chart.spacingLeft` and `chart.spacingRight`.
1485
1628
  *
1486
- * @type {Number}
1487
1629
  * @sample {highcharts} highcharts/subtitle/align/
1488
1630
  * Footnote at right of plot area
1489
1631
  * @sample {highstock} stock/chart/subtitle-footnote
1490
1632
  * Footnote at the bottom right of plot area
1491
- * @default 0
1492
- * @since 2.0
1633
+ *
1634
+ * @type {number}
1635
+ * @default 0
1636
+ * @since 2.0
1493
1637
  * @apioption subtitle.x
1494
1638
  */
1495
1639
 
@@ -1498,22 +1642,19 @@ H.defaultOptions = {
1498
1642
  * `chart.spacingTop` and `chart.spacingBottom`. By default the subtitle
1499
1643
  * is laid out below the title unless the title is floating.
1500
1644
  *
1501
- * @type {Number}
1502
1645
  * @sample {highcharts} highcharts/subtitle/verticalalign/
1503
1646
  * Footnote at the bottom right of plot area
1504
1647
  * @sample {highstock} stock/chart/subtitle-footnote
1505
1648
  * Footnote at the bottom right of plot area
1506
- * @default {highcharts} null
1507
- * @default {highstock} null
1508
- * @default {highmaps}
1509
- * @since 2.0
1649
+ *
1650
+ * @type {number}
1651
+ * @since 2.0
1510
1652
  * @apioption subtitle.y
1511
1653
  */
1512
1654
 
1513
1655
  /**
1514
1656
  * The subtitle of the chart.
1515
1657
  *
1516
- * @type {String}
1517
1658
  * @sample {highcharts|highstock} highcharts/subtitle/text/
1518
1659
  * Custom subtitle
1519
1660
  * @sample {highcharts|highstock} highcharts/subtitle/text-formatted/
@@ -1525,14 +1666,13 @@ H.defaultOptions = {
1525
1666
  * The horizontal alignment of the subtitle. Can be one of "left",
1526
1667
  * "center" and "right".
1527
1668
  *
1528
- * @validvalue ["left", "center", "right"]
1529
- * @type {String}
1530
1669
  * @sample {highcharts} highcharts/subtitle/align/
1531
1670
  * Footnote at right of plot area
1532
1671
  * @sample {highstock} stock/chart/subtitle-footnote
1533
1672
  * Footnote at bottom right of plot area
1534
- * @default center
1535
- * @since 2.0
1673
+ *
1674
+ * @since 2.0
1675
+ * @validvalue ["left", "center", "right"]
1536
1676
  */
1537
1677
  align: 'center',
1538
1678
 
@@ -1540,11 +1680,11 @@ H.defaultOptions = {
1540
1680
  * Adjustment made to the subtitle width, normally to reserve space
1541
1681
  * for the exporting burger menu.
1542
1682
  *
1543
- * @type {Number}
1544
1683
  * @see [title.widthAdjust](#title.widthAdjust)
1684
+ *
1545
1685
  * @sample highcharts/title/widthadjust/
1546
1686
  * Wider menu, greater padding
1547
- * @default -44
1687
+ *
1548
1688
  * @since 4.2.5
1549
1689
  */
1550
1690
  widthAdjust: -44
@@ -1561,27 +1701,25 @@ H.defaultOptions = {
1561
1701
  * type are given in the plotOptions of that type, for example
1562
1702
  * `plotOptions.line`. Next, options for one single series are given in
1563
1703
  * [the series array](#series).
1564
- *
1565
1704
  */
1566
1705
  plotOptions: {},
1567
1706
 
1568
1707
  /**
1569
1708
  * HTML labels that can be positioned anywhere in the chart area.
1570
- *
1571
1709
  */
1572
1710
  labels: {
1573
1711
 
1574
1712
  /**
1575
- * A HTML label that can be positioned anywhere in the chart area.
1713
+ * An HTML label that can be positioned anywhere in the chart area.
1576
1714
  *
1577
- * @type {Array<Object>}
1715
+ * @type {Array<*>}
1578
1716
  * @apioption labels.items
1579
1717
  */
1580
1718
 
1581
1719
  /**
1582
1720
  * Inner HTML or text for the label.
1583
1721
  *
1584
- * @type {String}
1722
+ * @type {string}
1585
1723
  * @apioption labels.items.html
1586
1724
  */
1587
1725
 
@@ -1594,18 +1732,24 @@ H.defaultOptions = {
1594
1732
  * top: '100px'
1595
1733
  * }</pre>
1596
1734
  *
1597
- * @type {CSSObject}
1735
+ * @type {Highcharts.CSSObject}
1598
1736
  * @apioption labels.items.style
1599
1737
  */
1600
1738
 
1601
1739
  /**
1602
1740
  * Shared CSS styles for all labels.
1603
1741
  *
1604
- * @type {CSSObject}
1605
- * @default { "color": "#333333" }
1742
+ * @type {Highcharts.CSSObject}
1743
+ * @default {"color": "#333333", "position": "absolute"}
1606
1744
  */
1607
1745
  style: {
1746
+ /**
1747
+ * @ignore
1748
+ */
1608
1749
  position: 'absolute',
1750
+ /**
1751
+ * @ignore
1752
+ */
1609
1753
  color: '#333333'
1610
1754
  }
1611
1755
  },
@@ -1615,9 +1759,8 @@ H.defaultOptions = {
1615
1759
  * item or point item in the chart. Each series (or points in case
1616
1760
  * of pie charts) is represented by a symbol and its name in the legend.
1617
1761
  *
1618
- * It is possible to override the symbol creator function and
1619
- * create [custom legend symbols](http://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/studies/legend-
1620
- * custom-symbol/).
1762
+ * It is possible to override the symbol creator function and create
1763
+ * [custom legend symbols](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/studies/legend-custom-symbol/).
1621
1764
  *
1622
1765
  * @productdesc {highmaps}
1623
1766
  * A Highmaps legend by default contains one legend item per series, but if
@@ -1629,40 +1772,52 @@ H.defaultOptions = {
1629
1772
  /**
1630
1773
  * The background color of the legend.
1631
1774
  *
1632
- * @type {Color}
1633
1775
  * @see In styled mode, the legend background fill can be applied with
1634
- * the `.highcharts-legend-box` class.
1776
+ * the `.highcharts-legend-box` class.
1777
+ *
1635
1778
  * @sample {highcharts} highcharts/legend/backgroundcolor/
1636
1779
  * Yellowish background
1637
- * @sample {highstock} stock/legend/align/ Various legend options
1780
+ * @sample {highstock} stock/legend/align/
1781
+ * Various legend options
1638
1782
  * @sample {highmaps} maps/legend/border-background/
1639
1783
  * Border and background options
1784
+ *
1785
+ * @type {Highcharts.ColorString}
1640
1786
  * @apioption legend.backgroundColor
1641
1787
  */
1642
1788
 
1643
1789
  /**
1644
1790
  * The width of the drawn border around the legend.
1645
1791
  *
1646
- * @type {Number}
1647
1792
  * @see In styled mode, the legend border stroke width can be applied
1648
- * with the `.highcharts-legend-box` class.
1649
- * @sample {highcharts} highcharts/legend/borderwidth/ 2px border width
1650
- * @sample {highstock} stock/legend/align/ Various legend options
1793
+ * with the `.highcharts-legend-box` class.
1794
+ *
1795
+ * @sample {highcharts} highcharts/legend/borderwidth/
1796
+ * 2px border width
1797
+ * @sample {highstock} stock/legend/align/
1798
+ * Various legend options
1651
1799
  * @sample {highmaps} maps/legend/border-background/
1652
1800
  * Border and background options
1653
- * @default 0
1801
+ *
1802
+ * @type {number}
1803
+ * @default 0
1654
1804
  * @apioption legend.borderWidth
1655
1805
  */
1656
1806
 
1657
1807
  /**
1658
- * Enable or disable the legend.
1808
+ * Enable or disable the legend. There is also a series-specific option,
1809
+ * [showInLegend](#plotOptions.series.showInLegend), that can hide the
1810
+ * series from the legend. In some series types this is `false` by
1811
+ * default, so it must set to `true` in order to show the legend for the
1812
+ * series.
1659
1813
  *
1660
- * @type {Boolean}
1661
1814
  * @sample {highcharts} highcharts/legend/enabled-false/ Legend disabled
1662
1815
  * @sample {highstock} stock/legend/align/ Various legend options
1663
1816
  * @sample {highmaps} maps/legend/enabled-false/ Legend disabled
1817
+ *
1664
1818
  * @default {highstock} false
1665
1819
  * @default {highmaps} true
1820
+ * @default {gantt} false
1666
1821
  */
1667
1822
  enabled: true,
1668
1823
 
@@ -1674,15 +1829,15 @@ H.defaultOptions = {
1674
1829
  * `layout` option will determine whether to place it above/below
1675
1830
  * or on the side of the plot area.
1676
1831
  *
1677
- * @validvalue ["left", "center", "right"]
1678
- * @type {String}
1679
1832
  * @sample {highcharts} highcharts/legend/align/
1680
1833
  * Legend at the right of the chart
1681
1834
  * @sample {highstock} stock/legend/align/
1682
1835
  * Various legend options
1683
1836
  * @sample {highmaps} maps/legend/alignment/
1684
1837
  * Legend alignment
1685
- * @since 2.0
1838
+ *
1839
+ * @since 2.0
1840
+ * @validvalue ["left", "center", "right"]
1686
1841
  */
1687
1842
  align: 'center',
1688
1843
 
@@ -1700,12 +1855,16 @@ H.defaultOptions = {
1700
1855
  * When the legend is floating, the plot area ignores it and is allowed
1701
1856
  * to be placed below it.
1702
1857
  *
1703
- * @type {Boolean}
1704
- * @sample {highcharts} highcharts/legend/floating-false/ False by default
1705
- * @sample {highcharts} highcharts/legend/floating-true/ True
1706
- * @sample {highmaps} maps/legend/alignment/ Floating legend
1707
- * @default false
1708
- * @since 2.1
1858
+ * @sample {highcharts} highcharts/legend/floating-false/
1859
+ * False by default
1860
+ * @sample {highcharts} highcharts/legend/floating-true/
1861
+ * True
1862
+ * @sample {highmaps} maps/legend/alignment/
1863
+ * Floating legend
1864
+ *
1865
+ * @type {boolean}
1866
+ * @default false
1867
+ * @since 2.1
1709
1868
  * @apioption legend.floating
1710
1869
  */
1711
1870
 
@@ -1716,8 +1875,6 @@ H.defaultOptions = {
1716
1875
  * except in inverted charts or when the legend position doesn't allow
1717
1876
  * it.
1718
1877
  *
1719
- * @validvalue ["horizontal", "vertical", "proximate"]
1720
- * @type {String}
1721
1878
  * @sample {highcharts} highcharts/legend/layout-horizontal/
1722
1879
  * Horizontal by default
1723
1880
  * @sample {highcharts} highcharts/legend/layout-vertical/
@@ -1730,7 +1887,8 @@ H.defaultOptions = {
1730
1887
  * Vertical with data classes
1731
1888
  * @sample {highmaps} maps/legend/layout-vertical/
1732
1889
  * Vertical with color axis gradient
1733
- * @default horizontal
1890
+ *
1891
+ * @validvalue ["horizontal", "vertical", "proximate"]
1734
1892
  */
1735
1893
  layout: 'horizontal',
1736
1894
 
@@ -1738,39 +1896,44 @@ H.defaultOptions = {
1738
1896
  * In a legend with horizontal layout, the itemDistance defines the
1739
1897
  * pixel distance between each item.
1740
1898
  *
1741
- * @type {Number}
1742
- * @sample {highcharts} highcharts/legend/layout-horizontal/ 50px item distance
1743
- * @sample {highstock} highcharts/legend/layout-horizontal/ 50px item distance
1744
- * @default {highcharts} 20
1745
- * @default {highstock} 20
1746
- * @default {highmaps} 8
1747
- * @since 3.0.3
1899
+ * @sample {highcharts} highcharts/legend/layout-horizontal/
1900
+ * 50px item distance
1901
+ * @sample {highstock} highcharts/legend/layout-horizontal/
1902
+ * 50px item distance
1903
+ *
1904
+ * @type {number}
1905
+ * @default {highcharts} 20
1906
+ * @default {highstock} 20
1907
+ * @default {highmaps} 8
1908
+ * @since 3.0.3
1748
1909
  * @apioption legend.itemDistance
1749
1910
  */
1750
1911
 
1751
1912
  /**
1752
1913
  * The pixel bottom margin for each legend item.
1753
1914
  *
1754
- * @type {Number}
1755
1915
  * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
1756
1916
  * Padding and item margins demonstrated
1757
1917
  * @sample {highmaps} maps/legend/padding-itemmargin/
1758
1918
  * Padding and item margins demonstrated
1759
- * @default 0
1760
- * @since 2.2.0
1919
+ *
1920
+ * @type {number}
1921
+ * @default 0
1922
+ * @since 2.2.0
1761
1923
  * @apioption legend.itemMarginBottom
1762
1924
  */
1763
1925
 
1764
1926
  /**
1765
1927
  * The pixel top margin for each legend item.
1766
1928
  *
1767
- * @type {Number}
1768
1929
  * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
1769
1930
  * Padding and item margins demonstrated
1770
1931
  * @sample {highmaps} maps/legend/padding-itemmargin/
1771
1932
  * Padding and item margins demonstrated
1772
- * @default 0
1773
- * @since 2.2.0
1933
+ *
1934
+ * @type {number}
1935
+ * @default 0
1936
+ * @since 2.2.0
1774
1937
  * @apioption legend.itemMarginTop
1775
1938
  */
1776
1939
 
@@ -1780,25 +1943,25 @@ H.defaultOptions = {
1780
1943
  * are laid out across two rows or more, they will be vertically aligned
1781
1944
  * depending on the [legend.alignColumns](legend.alignColumns) option.
1782
1945
  *
1783
- * @type {Number}
1784
1946
  * @sample {highcharts} highcharts/legend/itemwidth-default/
1785
- * Null by default
1947
+ * Undefined by default
1786
1948
  * @sample {highcharts} highcharts/legend/itemwidth-80/
1787
1949
  * 80 for aligned legend items
1788
- * @default null
1789
- * @since 2.0
1950
+ *
1951
+ * @type {number}
1952
+ * @since 2.0
1790
1953
  * @apioption legend.itemWidth
1791
1954
  */
1792
1955
 
1793
1956
  /**
1794
- * A [format string](
1795
- * https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
1796
- * for each legend label. Available variables relates to properties on
1797
- * the series, or the point in case of pies.
1957
+ * A [format string](https://www.highcharts.com/docs/chart-concepts/
1958
+ * labels-and-string-formatting) for each legend label. Available
1959
+ * variables relates to properties on the series, or the point in case
1960
+ * of pies.
1798
1961
  *
1799
- * @type {String}
1800
- * @default {name}
1801
- * @since 1.3
1962
+ * @type {string}
1963
+ * @default {name}
1964
+ * @since 1.3
1802
1965
  * @apioption legend.labelFormat
1803
1966
  */
1804
1967
 
@@ -1808,14 +1971,15 @@ H.defaultOptions = {
1808
1971
  * of pie charts. By default the series or point name is printed.
1809
1972
  *
1810
1973
  * @productdesc {highmaps}
1811
- * In Highmaps the context can also be a data class in case
1812
- * of a `colorAxis`.
1974
+ * In Highmaps the context can also be a data class in case of a
1975
+ * `colorAxis`.
1976
+ *
1977
+ * @sample {highcharts} highcharts/legend/labelformatter/
1978
+ * Add text
1979
+ * @sample {highmaps} maps/legend/labelformatter/
1980
+ * Data classes with label formatter
1813
1981
  *
1814
- * @type {Function}
1815
- * @sample {highcharts} highcharts/legend/labelformatter/ Add text
1816
- * @sample {highmaps} maps/legend/labelformatter/
1817
- * Data classes with label formatter
1818
- * @context {Series|Point}
1982
+ * @context {Highcharts.Series|Highcharts.Point}
1819
1983
  */
1820
1984
  labelFormatter: function () {
1821
1985
  return this.name;
@@ -1827,11 +1991,15 @@ H.defaultOptions = {
1827
1991
  * and the padding between items using `itemMarginTop` and
1828
1992
  * `itemMarginBottom`.
1829
1993
  *
1830
- * @type {Number}
1831
- * @sample {highcharts} highcharts/legend/lineheight/ Setting padding
1832
- * @default 16
1833
- * @since 2.0
1834
- * @product highcharts
1994
+ * @sample {highcharts} highcharts/legend/lineheight/
1995
+ * Setting padding
1996
+ *
1997
+ * @deprecated
1998
+ *
1999
+ * @type {number}
2000
+ * @default 16
2001
+ * @since 2.0
2002
+ * @product highcharts gantt
1835
2003
  * @apioption legend.lineHeight
1836
2004
  */
1837
2005
 
@@ -1840,12 +2008,14 @@ H.defaultOptions = {
1840
2008
  * is not floating, the legend margin is the space between the legend
1841
2009
  * and the axis labels or plot area.
1842
2010
  *
1843
- * @type {Number}
1844
2011
  * @sample {highcharts} highcharts/legend/margin-default/
1845
2012
  * 12 pixels by default
1846
- * @sample {highcharts} highcharts/legend/margin-30/ 30 pixels
1847
- * @default 12
1848
- * @since 2.1
2013
+ * @sample {highcharts} highcharts/legend/margin-30/
2014
+ * 30 pixels
2015
+ *
2016
+ * @type {number}
2017
+ * @default 12
2018
+ * @since 2.1
1849
2019
  * @apioption legend.margin
1850
2020
  */
1851
2021
 
@@ -1853,45 +2023,46 @@ H.defaultOptions = {
1853
2023
  * Maximum pixel height for the legend. When the maximum height is
1854
2024
  * extended, navigation will show.
1855
2025
  *
1856
- * @type {Number}
1857
- * @default undefined
1858
- * @since 2.3.0
2026
+ * @type {number}
2027
+ * @since 2.3.0
1859
2028
  * @apioption legend.maxHeight
1860
2029
  */
1861
2030
 
1862
2031
  /**
1863
2032
  * The color of the drawn border around the legend.
1864
2033
  *
1865
- * @type {Color}
1866
- * @see In styled mode, the legend border stroke can be applied with
1867
- * the `.highcharts-legend-box` class.
1868
- * @sample {highcharts} highcharts/legend/bordercolor/ Brown border
1869
- * @sample {highstock} stock/legend/align/ Various legend options
2034
+ * @see In styled mode, the legend border stroke can be applied with the
2035
+ * `.highcharts-legend-box` class.
2036
+ *
2037
+ * @sample {highcharts} highcharts/legend/bordercolor/
2038
+ * Brown border
2039
+ * @sample {highstock} stock/legend/align/
2040
+ * Various legend options
1870
2041
  * @sample {highmaps} maps/legend/border-background/
1871
2042
  * Border and background options
1872
- * @default #999999
2043
+ *
2044
+ * @type {Highcharts.ColorString}
1873
2045
  */
1874
2046
  borderColor: '#999999',
1875
2047
 
1876
2048
  /**
1877
2049
  * The border corner radius of the legend.
1878
2050
  *
1879
- * @type {Number}
1880
- * @sample {highcharts} highcharts/legend/borderradius-default/ Square by default
1881
- * @sample {highcharts} highcharts/legend/borderradius-round/ 5px rounded
2051
+ * @sample {highcharts} highcharts/legend/borderradius-default/
2052
+ * Square by default
2053
+ * @sample {highcharts} highcharts/legend/borderradius-round/
2054
+ * 5px rounded
1882
2055
  * @sample {highmaps} maps/legend/border-background/
1883
2056
  * Border and background options
1884
- * @default 0
1885
2057
  */
1886
2058
  borderRadius: 0,
1887
2059
 
1888
2060
  /**
1889
2061
  * Options for the paging or navigation appearing when the legend
1890
2062
  * is overflown. Navigation works well on screen, but not in static
1891
- * exported images. One way of working around that is to [increase
1892
- * the chart height in export](http://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/legend/navigation-
1893
- * enabled-false/).
1894
- *
2063
+ * exported images. One way of working around that is to
2064
+ * [increase the chart height in
2065
+ * export](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/legend/navigation-enabled-false/).
1895
2066
  */
1896
2067
  navigation: {
1897
2068
 
@@ -1901,13 +2072,14 @@ H.defaultOptions = {
1901
2072
  * `chart.animation` option. Additional options can be given as an
1902
2073
  * object containing values for easing and duration.
1903
2074
  *
1904
- * @type {Boolean|Object}
1905
2075
  * @sample {highcharts} highcharts/legend/navigation/
1906
2076
  * Legend page navigation demonstrated
1907
2077
  * @sample {highstock} highcharts/legend/navigation/
1908
2078
  * Legend page navigation demonstrated
1909
- * @default true
1910
- * @since 2.2.4
2079
+ *
2080
+ * @type {boolean|Highcharts.AnimationObject}
2081
+ * @default true
2082
+ * @since 2.2.4
1911
2083
  * @apioption legend.navigation.animation
1912
2084
  */
1913
2085
 
@@ -1915,13 +2087,14 @@ H.defaultOptions = {
1915
2087
  * The pixel size of the up and down arrows in the legend paging
1916
2088
  * navigation.
1917
2089
  *
1918
- * @type {Number}
1919
2090
  * @sample {highcharts} highcharts/legend/navigation/
1920
2091
  * Legend page navigation demonstrated
1921
2092
  * @sample {highstock} highcharts/legend/navigation/
1922
2093
  * Legend page navigation demonstrated
1923
- * @default 12
1924
- * @since 2.2.4
2094
+ *
2095
+ * @type {number}
2096
+ * @default 12
2097
+ * @since 2.2.4
1925
2098
  * @apioption legend.navigation.arrowSize
1926
2099
  */
1927
2100
 
@@ -1930,27 +2103,29 @@ H.defaultOptions = {
1930
2103
  * the navigation results in an unwanted overflow.
1931
2104
  *
1932
2105
  * See also the [adapt chart to legend](
1933
- * https://www.highcharts.com/plugin-registry/single/8/Adapt-Chart-To-Legend)
2106
+ * https://www.highcharts.com/products/plugin-registry/single/8/Adapt-Chart-To-Legend)
1934
2107
  * plugin for a solution to extend the chart height to make room for
1935
2108
  * the legend, optionally in exported charts only.
1936
2109
  *
1937
- * @type {Boolean}
1938
- * @default true
1939
- * @since 4.2.4
2110
+ * @type {boolean}
2111
+ * @default true
2112
+ * @since 4.2.4
1940
2113
  * @apioption legend.navigation.enabled
1941
2114
  */
1942
2115
 
1943
2116
  /**
1944
2117
  * Text styles for the legend page navigation.
1945
2118
  *
1946
- * @type {CSSObject}
1947
2119
  * @see In styled mode, the navigation items are styled with the
1948
- * `.highcharts-legend-navigation` class.
2120
+ * `.highcharts-legend-navigation` class.
2121
+ *
1949
2122
  * @sample {highcharts} highcharts/legend/navigation/
1950
2123
  * Legend page navigation demonstrated
1951
2124
  * @sample {highstock} highcharts/legend/navigation/
1952
2125
  * Legend page navigation demonstrated
1953
- * @since 2.2.4
2126
+ *
2127
+ * @type {Highcharts.CSSObject}
2128
+ * @since 2.2.4
1954
2129
  * @apioption legend.navigation.style
1955
2130
  */
1956
2131
 
@@ -1960,14 +2135,15 @@ H.defaultOptions = {
1960
2135
  * The color for the active up or down arrow in the legend page
1961
2136
  * navigation.
1962
2137
  *
1963
- * @type {Color}
1964
- * @see In styled mode, the active arrow be styled with the
1965
- * `.highcharts-legend-nav-active` class.
2138
+ * @see In styled mode, the active arrow be styled with the
2139
+ * `.highcharts-legend-nav-active` class.
2140
+ *
1966
2141
  * @sample {highcharts} highcharts/legend/navigation/
1967
2142
  * Legend page navigation demonstrated
1968
2143
  * @sample {highstock} highcharts/legend/navigation/
1969
2144
  * Legend page navigation demonstrated
1970
- * @default #003399
2145
+ *
2146
+ * @type {Highcharts.ColorString}
1971
2147
  * @since 2.2.4
1972
2148
  */
1973
2149
  activeColor: '#003399',
@@ -1976,16 +2152,15 @@ H.defaultOptions = {
1976
2152
  * The color of the inactive up or down arrow in the legend page
1977
2153
  * navigation. .
1978
2154
  *
1979
- * @type {Color}
1980
2155
  * @see In styled mode, the inactive arrow be styled with the
1981
2156
  * `.highcharts-legend-nav-inactive` class.
2157
+ *
1982
2158
  * @sample {highcharts} highcharts/legend/navigation/
1983
2159
  * Legend page navigation demonstrated
1984
2160
  * @sample {highstock} highcharts/legend/navigation/
1985
2161
  * Legend page navigation demonstrated
1986
- * @default {highcharts} #cccccc
1987
- * @default {highstock} #cccccc
1988
- * @default {highmaps} ##cccccc
2162
+ *
2163
+ * @type {Highcharts.ColorString}
1989
2164
  * @since 2.2.4
1990
2165
  */
1991
2166
  inactiveColor: '#cccccc'
@@ -1995,13 +2170,14 @@ H.defaultOptions = {
1995
2170
  /**
1996
2171
  * The inner padding of the legend box.
1997
2172
  *
1998
- * @type {Number}
1999
2173
  * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
2000
2174
  * Padding and item margins demonstrated
2001
2175
  * @sample {highmaps} maps/legend/padding-itemmargin/
2002
2176
  * Padding and item margins demonstrated
2003
- * @default 8
2004
- * @since 2.2.0
2177
+ *
2178
+ * @type {number}
2179
+ * @default 8
2180
+ * @since 2.2.0
2005
2181
  * @apioption legend.padding
2006
2182
  */
2007
2183
 
@@ -2009,13 +2185,15 @@ H.defaultOptions = {
2009
2185
  * Whether to reverse the order of the legend items compared to the
2010
2186
  * order of the series or points as defined in the configuration object.
2011
2187
  *
2012
- * @type {Boolean}
2013
2188
  * @see [yAxis.reversedStacks](#yAxis.reversedStacks),
2014
2189
  * [series.legendIndex](#series.legendIndex)
2190
+ *
2015
2191
  * @sample {highcharts} highcharts/legend/reversed/
2016
2192
  * Stacked bar with reversed legend
2017
- * @default false
2018
- * @since 1.2.5
2193
+ *
2194
+ * @type {boolean}
2195
+ * @default false
2196
+ * @since 1.2.5
2019
2197
  * @apioption legend.reversed
2020
2198
  */
2021
2199
 
@@ -2023,10 +2201,12 @@ H.defaultOptions = {
2023
2201
  * Whether to show the symbol on the right side of the text rather than
2024
2202
  * the left side. This is common in Arabic and Hebraic.
2025
2203
  *
2026
- * @type {Boolean}
2027
- * @sample {highcharts} highcharts/legend/rtl/ Symbol to the right
2028
- * @default false
2029
- * @since 2.2
2204
+ * @sample {highcharts} highcharts/legend/rtl/
2205
+ * Symbol to the right
2206
+ *
2207
+ * @type {boolean}
2208
+ * @default false
2209
+ * @since 2.2
2030
2210
  * @apioption legend.rtl
2031
2211
  */
2032
2212
 
@@ -2034,11 +2214,12 @@ H.defaultOptions = {
2034
2214
  * CSS styles for the legend area. In the 1.x versions the position
2035
2215
  * of the legend area was determined by CSS. In 2.x, the position is
2036
2216
  * determined by properties like `align`, `verticalAlign`, `x` and `y`,
2037
- * but the styles are still parsed for backwards compatibility.
2217
+ * but the styles are still parsed for backwards compatibility.
2038
2218
  *
2039
- * @type {CSSObject}
2040
2219
  * @deprecated
2041
- * @product highcharts highstock
2220
+ *
2221
+ * @type {Highcharts.CSSObject}
2222
+ * @product highcharts highstock
2042
2223
  * @apioption legend.style
2043
2224
  */
2044
2225
 
@@ -2047,20 +2228,37 @@ H.defaultOptions = {
2047
2228
  /**
2048
2229
  * CSS styles for each legend item. Only a subset of CSS is supported,
2049
2230
  * notably those options related to text. The default `textOverflow`
2050
- * property makes long texts truncate. Set it to `null` to wrap text
2051
- * instead. A `width` property can be added to control the text width.
2231
+ * property makes long texts truncate. Set it to `undefined` to wrap
2232
+ * text instead. A `width` property can be added to control the text
2233
+ * width.
2052
2234
  *
2053
- * @type {CSSObject}
2054
2235
  * @see In styled mode, the legend items can be styled with the
2055
- * `.highcharts-legend-item` class.
2056
- * @sample {highcharts} highcharts/legend/itemstyle/ Bold black text
2057
- * @sample {highmaps} maps/legend/itemstyle/ Item text styles
2058
- * @default { "color": "#333333", "cursor": "pointer", "fontSize": "12px", "fontWeight": "bold", "textOverflow": "ellipsis" }
2236
+ * `.highcharts-legend-item` class.
2237
+ *
2238
+ * @sample {highcharts} highcharts/legend/itemstyle/
2239
+ * Bold black text
2240
+ * @sample {highmaps} maps/legend/itemstyle/
2241
+ * Item text styles
2242
+ *
2243
+ * @type {Highcharts.CSSObject}
2244
+ * @default {"color": "#333333", "cursor": "pointer", "fontSize": "12px", "fontWeight": "bold", "textOverflow": "ellipsis"}
2059
2245
  */
2060
2246
  itemStyle: {
2247
+ /**
2248
+ * @ignore
2249
+ */
2061
2250
  color: '#333333',
2251
+ /**
2252
+ * @ignore
2253
+ */
2062
2254
  fontSize: '12px',
2255
+ /**
2256
+ * @ignore
2257
+ */
2063
2258
  fontWeight: 'bold',
2259
+ /**
2260
+ * @ignore
2261
+ */
2064
2262
  textOverflow: 'ellipsis'
2065
2263
  },
2066
2264
 
@@ -2069,14 +2267,21 @@ H.defaultOptions = {
2069
2267
  * CSS is supported, notably those options related to text. Properties
2070
2268
  * are inherited from `style` unless overridden here.
2071
2269
  *
2072
- * @type {CSSObject}
2073
2270
  * @see In styled mode, the hovered legend items can be styled with
2074
- * the `.highcharts-legend-item:hover` pesudo-class.
2075
- * @sample {highcharts} highcharts/legend/itemhoverstyle/ Red on hover
2076
- * @sample {highmaps} maps/legend/itemstyle/ Item text styles
2077
- * @default { "color": "#000000" }
2271
+ * the `.highcharts-legend-item:hover` pesudo-class.
2272
+ *
2273
+ * @sample {highcharts} highcharts/legend/itemhoverstyle/
2274
+ * Red on hover
2275
+ * @sample {highmaps} maps/legend/itemstyle/
2276
+ * Item text styles
2277
+ *
2278
+ * @type {Highcharts.CSSObject}
2279
+ * @default {"color": "#000000"}
2078
2280
  */
2079
2281
  itemHoverStyle: {
2282
+ /**
2283
+ * @ignore
2284
+ */
2080
2285
  color: '#000000'
2081
2286
  },
2082
2287
 
@@ -2086,14 +2291,19 @@ H.defaultOptions = {
2086
2291
  * options related to text. Properties are inherited from `style`
2087
2292
  * unless overridden here.
2088
2293
  *
2089
- * @type {CSSObject}
2090
2294
  * @see In styled mode, the hidden legend items can be styled with
2091
- * the `.highcharts-legend-item-hidden` class.
2295
+ * the `.highcharts-legend-item-hidden` class.
2296
+ *
2092
2297
  * @sample {highcharts} highcharts/legend/itemhiddenstyle/
2093
2298
  * Darker gray color
2094
- * @default { "color": "#cccccc" }
2299
+ *
2300
+ * @type {Highcharts.CSSObject}
2301
+ * @default {"color": "#cccccc"}
2095
2302
  */
2096
2303
  itemHiddenStyle: {
2304
+ /**
2305
+ * @ignore
2306
+ */
2097
2307
  color: '#cccccc'
2098
2308
  },
2099
2309
 
@@ -2103,25 +2313,38 @@ H.defaultOptions = {
2103
2313
  * an object configuration containing `color`, `offsetX`, `offsetY`,
2104
2314
  * `opacity` and `width`.
2105
2315
  *
2106
- * @type {Boolean|Object}
2107
2316
  * @sample {highcharts} highcharts/legend/shadow/
2108
2317
  * White background and drop shadow
2109
2318
  * @sample {highstock} stock/legend/align/
2110
2319
  * Various legend options
2111
2320
  * @sample {highmaps} maps/legend/border-background/
2112
2321
  * Border and background options
2113
- * @default false
2322
+ *
2323
+ * @type {boolean|Highcharts.CSSObject}
2114
2324
  */
2115
2325
  shadow: false,
2326
+
2116
2327
 
2117
2328
 
2118
2329
  /**
2119
2330
  * Default styling for the checkbox next to a legend item when
2120
2331
  * `showCheckbox` is true.
2332
+ *
2333
+ * @type {Highcharts.CSSObject}
2334
+ * @default {"width": "13px", "height": "13px", "position":"absolute"}
2121
2335
  */
2122
2336
  itemCheckboxStyle: {
2337
+ /**
2338
+ * @ignore
2339
+ */
2123
2340
  position: 'absolute',
2341
+ /**
2342
+ * @ignore
2343
+ */
2124
2344
  width: '13px', // for IE precision
2345
+ /**
2346
+ * @ignore
2347
+ */
2125
2348
  height: '13px'
2126
2349
  },
2127
2350
  // itemWidth: undefined,
@@ -2131,8 +2354,6 @@ H.defaultOptions = {
2131
2354
  * the symbol height, which in turn defaults to the font size of the
2132
2355
  * legend items.
2133
2356
  *
2134
- * @type {Boolean}
2135
- * @default true
2136
2357
  * @since 5.0.0
2137
2358
  */
2138
2359
  squareSymbol: true,
@@ -2145,12 +2366,13 @@ H.defaultOptions = {
2145
2366
  * In Highmaps, when the symbol is the gradient of a vertical color
2146
2367
  * axis, the height defaults to 200.
2147
2368
  *
2148
- * @type {Number}
2149
2369
  * @sample {highmaps} maps/legend/layout-vertical-sized/
2150
2370
  * Sized vertical gradient
2151
2371
  * @sample {highmaps} maps/legend/padding-itemmargin/
2152
2372
  * No distance between data classes
2153
- * @since 3.0.8
2373
+ *
2374
+ * @type {number}
2375
+ * @since 3.0.8
2154
2376
  * @apioption legend.symbolHeight
2155
2377
  */
2156
2378
 
@@ -2158,11 +2380,15 @@ H.defaultOptions = {
2158
2380
  * The border radius of the symbol for series types that use a rectangle
2159
2381
  * in the legend. Defaults to half the `symbolHeight`.
2160
2382
  *
2161
- * @type {Number}
2162
- * @sample {highcharts} highcharts/legend/symbolradius/ Round symbols
2163
- * @sample {highstock} highcharts/legend/symbolradius/ Round symbols
2164
- * @sample {highmaps} highcharts/legend/symbolradius/ Round symbols
2165
- * @since 3.0.8
2383
+ * @sample {highcharts} highcharts/legend/symbolradius/
2384
+ * Round symbols
2385
+ * @sample {highstock} highcharts/legend/symbolradius/
2386
+ * Round symbols
2387
+ * @sample {highmaps} highcharts/legend/symbolradius/
2388
+ * Round symbols
2389
+ *
2390
+ * @type {number}
2391
+ * @since 3.0.8
2166
2392
  * @apioption legend.symbolRadius
2167
2393
  */
2168
2394
 
@@ -2174,34 +2400,37 @@ H.defaultOptions = {
2174
2400
  * In Highmaps, when the symbol is the gradient of a horizontal color
2175
2401
  * axis, the width defaults to 200.
2176
2402
  *
2177
- * @type {Number}
2178
2403
  * @sample {highcharts} highcharts/legend/symbolwidth/
2179
2404
  * Greater symbol width and padding
2180
2405
  * @sample {highmaps} maps/legend/padding-itemmargin/
2181
2406
  * Padding and item margins demonstrated
2182
2407
  * @sample {highmaps} maps/legend/layout-vertical-sized/
2183
2408
  * Sized vertical gradient
2409
+ *
2410
+ * @type {number}
2184
2411
  * @apioption legend.symbolWidth
2185
2412
  */
2186
2413
 
2187
2414
  /**
2188
- * Whether to [use HTML](http://www.highcharts.com/docs/chart-concepts/labels-
2189
- * and-string-formatting#html) to render the legend item texts. Prior
2190
- * to 4.1.7, when using HTML, [legend.navigation](#legend.navigation)
2191
- * was disabled.
2415
+ * Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/
2416
+ * labels-and-string-formatting#html) to render the legend item texts.
2417
+ *
2418
+ * Prior to 4.1.7, when using HTML, [legend.navigation](
2419
+ * #legend.navigation) was disabled.
2192
2420
  *
2193
- * @type {Boolean}
2194
- * @default false
2421
+ * @type {boolean}
2422
+ * @default false
2195
2423
  * @apioption legend.useHTML
2196
2424
  */
2197
2425
 
2198
2426
  /**
2199
2427
  * The width of the legend box.
2200
2428
  *
2201
- * @type {Number}
2202
- * @sample {highcharts} highcharts/legend/width/ Aligned to the plot area
2203
- * @default null
2204
- * @since 2.0
2429
+ * @sample {highcharts} highcharts/legend/width/
2430
+ * Aligned to the plot area
2431
+ *
2432
+ * @type {number}
2433
+ * @since 2.0
2205
2434
  * @apioption legend.width
2206
2435
  */
2207
2436
 
@@ -2209,9 +2438,8 @@ H.defaultOptions = {
2209
2438
  * The pixel padding between the legend item symbol and the legend
2210
2439
  * item text.
2211
2440
  *
2212
- * @type {Number}
2213
- * @sample {highcharts} highcharts/legend/symbolpadding/ Greater symbol width and padding
2214
- * @default 5
2441
+ * @sample {highcharts} highcharts/legend/symbolpadding/
2442
+ * Greater symbol width and padding
2215
2443
  */
2216
2444
  symbolPadding: 5,
2217
2445
 
@@ -2227,16 +2455,18 @@ H.defaultOptions = {
2227
2455
  * When the [layout](#legend.layout) option is `proximate`, the
2228
2456
  * `verticalAlign` option doesn't apply.
2229
2457
  *
2230
- * @validvalue ["top", "middle", "bottom"]
2231
- * @type {String}
2232
2458
  * @sample {highcharts} highcharts/legend/verticalalign/
2233
2459
  * Legend 100px from the top of the chart
2234
- * @sample {highstock} stock/legend/align/ Various legend options
2235
- * @sample {highmaps} maps/legend/alignment/ Legend alignment
2236
- * @default bottom
2237
- * @since 2.0
2460
+ * @sample {highstock} stock/legend/align/
2461
+ * Various legend options
2462
+ * @sample {highmaps} maps/legend/alignment/
2463
+ * Legend alignment
2464
+ *
2465
+ * @since 2.0
2466
+ * @validvalue ["top", "middle", "bottom"]
2238
2467
  */
2239
2468
  verticalAlign: 'bottom',
2469
+
2240
2470
  // width: undefined,
2241
2471
 
2242
2472
  /**
@@ -2244,9 +2474,9 @@ H.defaultOptions = {
2244
2474
  * `align` within chart.spacingLeft and chart.spacingRight. Negative
2245
2475
  * x moves it to the left, positive x moves it to the right.
2246
2476
  *
2247
- * @type {Number}
2248
- * @sample {highcharts} highcharts/legend/width/ Aligned to the plot area
2249
- * @default 0
2477
+ * @sample {highcharts} highcharts/legend/width/
2478
+ * Aligned to the plot area
2479
+ *
2250
2480
  * @since 2.0
2251
2481
  */
2252
2482
  x: 0,
@@ -2256,11 +2486,13 @@ H.defaultOptions = {
2256
2486
  * `verticalAlign` within chart.spacingTop and chart.spacingBottom.
2257
2487
  * Negative y moves it up, positive y moves it down.
2258
2488
  *
2259
- * @type {Number}
2260
- * @sample {highcharts} highcharts/legend/verticalalign/ Legend 100px from the top of the chart
2261
- * @sample {highstock} stock/legend/align/ Various legend options
2262
- * @sample {highmaps} maps/legend/alignment/ Legend alignment
2263
- * @default 0
2489
+ * @sample {highcharts} highcharts/legend/verticalalign/
2490
+ * Legend 100px from the top of the chart
2491
+ * @sample {highstock} stock/legend/align/
2492
+ * Various legend options
2493
+ * @sample {highmaps} maps/legend/alignment/
2494
+ * Legend alignment
2495
+ *
2264
2496
  * @since 2.0
2265
2497
  */
2266
2498
  y: 0,
@@ -2268,17 +2500,19 @@ H.defaultOptions = {
2268
2500
  /**
2269
2501
  * A title to be added on top of the legend.
2270
2502
  *
2271
- * @sample {highcharts} highcharts/legend/title/ Legend title
2272
- * @sample {highmaps} maps/legend/alignment/ Legend with title
2503
+ * @sample {highcharts} highcharts/legend/title/
2504
+ * Legend title
2505
+ * @sample {highmaps} maps/legend/alignment/
2506
+ * Legend with title
2507
+ *
2273
2508
  * @since 3.0
2274
2509
  */
2275
2510
  title: {
2276
2511
  /**
2277
2512
  * A text or HTML string for the title.
2278
2513
  *
2279
- * @type {String}
2280
- * @default null
2281
- * @since 3.0
2514
+ * @type {string}
2515
+ * @since 3.0
2282
2516
  * @apioption legend.title.text
2283
2517
  */
2284
2518
 
@@ -2287,16 +2521,22 @@ H.defaultOptions = {
2287
2521
  /**
2288
2522
  * Generic CSS styles for the legend title.
2289
2523
  *
2290
- * @type {CSSObject}
2291
2524
  * @see In styled mode, the legend title is styled with the
2292
- * `.highcharts-legend-title` class.
2293
- * @default {"fontWeight":"bold"}
2294
- * @since 3.0
2525
+ * `.highcharts-legend-title` class.
2526
+ *
2527
+ * @type {Highcharts.CSSObject}
2528
+ * @default {"fontWeight": "bold"}
2529
+ * @since 3.0
2295
2530
  */
2296
2531
  style: {
2532
+ /**
2533
+ * @ignore
2534
+ */
2297
2535
  fontWeight: 'bold'
2298
2536
  }
2537
+
2299
2538
 
2539
+
2300
2540
  }
2301
2541
  },
2302
2542
 
@@ -2309,45 +2549,62 @@ H.defaultOptions = {
2309
2549
  * is going on, for example while retrieving new data via an XHR connection.
2310
2550
  * The "Loading..." text itself is not part of this configuration
2311
2551
  * object, but part of the `lang` object.
2312
- *
2313
2552
  */
2314
2553
  loading: {
2315
2554
 
2316
2555
  /**
2317
2556
  * The duration in milliseconds of the fade out effect.
2318
2557
  *
2319
- * @type {Number}
2320
- * @sample highcharts/loading/hideduration/ Fade in and out over a second
2321
- * @default 100
2322
- * @since 1.2.0
2558
+ * @sample highcharts/loading/hideduration/
2559
+ * Fade in and out over a second
2560
+ *
2561
+ * @type {number}
2562
+ * @default 100
2563
+ * @since 1.2.0
2323
2564
  * @apioption loading.hideDuration
2324
2565
  */
2325
2566
 
2326
2567
  /**
2327
2568
  * The duration in milliseconds of the fade in effect.
2328
2569
  *
2329
- * @type {Number}
2330
- * @sample highcharts/loading/hideduration/ Fade in and out over a second
2331
- * @default 100
2332
- * @since 1.2.0
2570
+ * @sample highcharts/loading/hideduration/
2571
+ * Fade in and out over a second
2572
+ *
2573
+ * @type {number}
2574
+ * @default 100
2575
+ * @since 1.2.0
2333
2576
  * @apioption loading.showDuration
2334
2577
  */
2578
+
2335
2579
 
2336
2580
 
2337
2581
  /**
2338
2582
  * CSS styles for the loading label `span`.
2339
2583
  *
2340
- * @type {CSSObject}
2341
2584
  * @see In styled mode, the loading label is styled with the
2342
- * `.highcharts-loading-inner` class.
2343
- * @sample {highcharts|highmaps} highcharts/loading/labelstyle/ Vertically centered
2344
- * @sample {highstock} stock/loading/general/ Label styles
2345
- * @default { "fontWeight": "bold", "position": "relative", "top": "45%" }
2346
- * @since 1.2.0
2585
+ * `.highcharts-loading-inner` class.
2586
+ *
2587
+ * @sample {highcharts|highmaps} highcharts/loading/labelstyle/
2588
+ * Vertically centered
2589
+ * @sample {highstock} stock/loading/general/
2590
+ * Label styles
2591
+ *
2592
+ * @type {Highcharts.CSSObject}
2593
+ * @default {"fontWeight": "bold", "position": "relative", "top": "45%"}
2594
+ * @since 1.2.0
2347
2595
  */
2348
2596
  labelStyle: {
2597
+ /**
2598
+ * @ignore
2599
+ */
2349
2600
  fontWeight: 'bold',
2601
+ /**
2602
+ * @ignore
2603
+ */
2350
2604
  position: 'relative',
2605
+ /**
2606
+ * @ignore
2607
+ */
2351
2608
  top: '45%'
2352
2609
  },
2353
2610
 
@@ -2357,18 +2614,31 @@ H.defaultOptions = {
2357
2614
  * In styled mode, the loading label is styled with the
2358
2615
  * `.highcharts-loading` class.
2359
2616
  *
2360
- * @type {CSSObject}
2361
2617
  * @sample {highcharts|highmaps} highcharts/loading/style/
2362
2618
  * Gray plot area, white text
2363
2619
  * @sample {highstock} stock/loading/general/
2364
2620
  * Gray plot area, white text
2365
- * @default { "position": "absolute", "backgroundColor": "#ffffff", "opacity": 0.5, "textAlign": "center" }
2366
- * @since 1.2.0
2621
+ *
2622
+ * @type {Highcharts.CSSObject}
2623
+ * @default {"position": "absolute", "backgroundColor": "#ffffff", "opacity": 0.5, "textAlign": "center"}
2624
+ * @since 1.2.0
2367
2625
  */
2368
2626
  style: {
2627
+ /**
2628
+ * @ignore
2629
+ */
2369
2630
  position: 'absolute',
2631
+ /**
2632
+ * @ignore
2633
+ */
2370
2634
  backgroundColor: '#ffffff',
2635
+ /**
2636
+ * @ignore
2637
+ */
2371
2638
  opacity: 0.5,
2639
+ /**
2640
+ * @ignore
2641
+ */
2372
2642
  textAlign: 'center'
2373
2643
  }
2374
2644
 
@@ -2378,16 +2648,14 @@ H.defaultOptions = {
2378
2648
  /**
2379
2649
  * Options for the tooltip that appears when the user hovers over a
2380
2650
  * series or point.
2381
- *
2382
2651
  */
2383
2652
  tooltip: {
2384
2653
 
2385
2654
 
2386
2655
  /**
2387
- * The color of the tooltip border. When `null`, the border takes the
2388
- * color of the corresponding series or point.
2656
+ * The color of the tooltip border. When `undefined`, the border takes
2657
+ * the color of the corresponding series or point.
2389
2658
  *
2390
- * @type {Color}
2391
2659
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2392
2660
  * Follow series by default
2393
2661
  * @sample {highcharts} highcharts/tooltip/bordercolor-black/
@@ -2396,7 +2664,8 @@ H.defaultOptions = {
2396
2664
  * Styled tooltip
2397
2665
  * @sample {highmaps} maps/tooltip/background-border/
2398
2666
  * Background and border demo
2399
- * @default null
2667
+ *
2668
+ * @type {Highcharts.ColorString}
2400
2669
  * @apioption tooltip.borderColor
2401
2670
  */
2402
2671
 
@@ -2405,11 +2674,13 @@ H.defaultOptions = {
2405
2674
  * in order for a better separation from the tooltip. See
2406
2675
  * [xAxis.crosshair](#xAxis.crosshair)<a>.</a>
2407
2676
  *
2408
- * @type {Mixed}
2409
- * @deprecated
2410
2677
  * @sample {highcharts} highcharts/tooltip/crosshairs-x/
2411
2678
  * Enable a crosshair for the x value
2412
- * @default true
2679
+ *
2680
+ * @deprecated
2681
+ *
2682
+ * @type {*}
2683
+ * @default true
2413
2684
  * @apioption tooltip.crosshairs
2414
2685
  */
2415
2686
 
@@ -2422,25 +2693,31 @@ H.defaultOptions = {
2422
2693
  * For touch moves to behave the same way, [followTouchMove](
2423
2694
  * #tooltip.followTouchMove) must be `true` also.
2424
2695
  *
2425
- * @type {Boolean}
2426
- * @default {highcharts} false
2427
- * @default {highstock} false
2428
- * @default {highmaps} true
2429
- * @since 3.0
2696
+ * @type {boolean}
2697
+ * @default {highcharts} false
2698
+ * @default {highstock} false
2699
+ * @default {highmaps} true
2700
+ * @since 3.0
2430
2701
  * @apioption tooltip.followPointer
2431
2702
  */
2432
2703
 
2433
2704
  /**
2434
- * Whether the tooltip should follow the finger as it moves on a touch
2705
+ * Whether the tooltip should update as the finger moves on a touch
2435
2706
  * device. If this is `true` and [chart.panning](#chart.panning) is
2436
2707
  * set,`followTouchMove` will take over one-finger touches, so the user
2437
2708
  * needs to use two fingers for zooming and panning.
2438
2709
  *
2439
- * @type {Boolean}
2440
- * @default {highcharts} true
2441
- * @default {highstock} true
2442
- * @default {highmaps} false
2443
- * @since 3.0.1
2710
+ * Note the difference to [followPointer](#tooltip.followPointer) that
2711
+ * only defines the _position_ of the tooltip. If `followPointer` is
2712
+ * false in for example a column series, the tooltip will show above or
2713
+ * below the column, but as `followTouchMove` is true, the tooltip will
2714
+ * jump from column to column as the user swipes across the plot area.
2715
+ *
2716
+ * @type {boolean}
2717
+ * @default {highcharts} true
2718
+ * @default {highstock} true
2719
+ * @default {highmaps} false
2720
+ * @since 3.0.1
2444
2721
  * @apioption tooltip.followTouchMove
2445
2722
  */
2446
2723
 
@@ -2503,7 +2780,6 @@ H.defaultOptions = {
2503
2780
  *
2504
2781
  * </dl>
2505
2782
  *
2506
- * @type {Function}
2507
2783
  * @sample {highcharts} highcharts/tooltip/formatter-simple/
2508
2784
  * Simple string formatting
2509
2785
  * @sample {highcharts} highcharts/tooltip/formatter-shared/
@@ -2512,6 +2788,8 @@ H.defaultOptions = {
2512
2788
  * Formatting with shared tooltip
2513
2789
  * @sample {highmaps} maps/tooltip/formatter/
2514
2790
  * String formatting
2791
+ *
2792
+ * @type {Function}
2515
2793
  * @apioption tooltip.formatter
2516
2794
  */
2517
2795
 
@@ -2519,9 +2797,9 @@ H.defaultOptions = {
2519
2797
  * The number of milliseconds to wait until the tooltip is hidden when
2520
2798
  * mouse out from a point or chart.
2521
2799
  *
2522
- * @type {Number}
2523
- * @default 500
2524
- * @since 3.0
2800
+ * @type {number}
2801
+ * @default 500
2802
+ * @since 3.0
2525
2803
  * @apioption tooltip.hideDelay
2526
2804
  */
2527
2805
 
@@ -2534,11 +2812,12 @@ H.defaultOptions = {
2534
2812
  * overlaid on the page, allowing the tooltip to be aligned inside the
2535
2813
  * page itself.
2536
2814
  *
2537
- * @type {Boolean}
2538
2815
  * @sample highcharts/tooltip/outside
2539
2816
  * Small charts with tooltips outside
2540
- * @default false
2541
- * @since 6.1.1
2817
+ *
2818
+ * @type {boolean}
2819
+ * @default false
2820
+ * @since 6.1.1
2542
2821
  * @apioption tooltip.outside
2543
2822
  */
2544
2823
 
@@ -2547,9 +2826,9 @@ H.defaultOptions = {
2547
2826
  * in the tooltip. Like the `pointFormat` string, but with more
2548
2827
  * flexibility.
2549
2828
  *
2550
- * @type {Function}
2551
- * @context Point
2552
- * @since 4.1.0
2829
+ * @type {Function}
2830
+ * @since 4.1.0
2831
+ * @context Highcharts.Point
2553
2832
  * @apioption tooltip.pointFormatter
2554
2833
  */
2555
2834
 
@@ -2563,25 +2842,31 @@ H.defaultOptions = {
2563
2842
  * The return should be an object containing x and y values, for example
2564
2843
  * `{ x: 100, y: 100 }`.
2565
2844
  *
2566
- * @type {Function}
2567
2845
  * @sample {highcharts} highcharts/tooltip/positioner/
2568
2846
  * A fixed tooltip position
2569
2847
  * @sample {highstock} stock/tooltip/positioner/
2570
2848
  * A fixed tooltip position on top of the chart
2571
2849
  * @sample {highmaps} maps/tooltip/positioner/
2572
2850
  * A fixed tooltip position
2573
- * @since 2.2.4
2851
+ *
2852
+ * @type {Function}
2853
+ * @since 2.2.4
2574
2854
  * @apioption tooltip.positioner
2575
2855
  */
2576
2856
 
2577
2857
  /**
2578
- * The name of a symbol to use for the border around the tooltip.
2858
+ * The name of a symbol to use for the border around the tooltip. Can
2859
+ * be one of: `"callout"`, `"circle"` or `"square"`.
2860
+ *
2861
+ * Custom callbacks for symbol path generation can also be added to
2862
+ * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
2863
+ * [series.marker.symbol](plotOptions.line.marker.symbol).
2579
2864
  *
2580
- * @type {String}
2581
- * @default callout
2865
+ * @type {string}
2866
+ * @default callout
2867
+ * @since 4.0
2582
2868
  * @validvalue ["callout", "square"]
2583
- * @since 4.0
2584
- * @apioption tooltip.shape
2869
+ * @apioption tooltip.shape
2585
2870
  */
2586
2871
 
2587
2872
  /**
@@ -2595,17 +2880,19 @@ H.defaultOptions = {
2595
2880
  * charts with many series, especially line-type series. The
2596
2881
  * `tooltip.split` option takes precedence over `tooltip.shared`.
2597
2882
  *
2598
- * @type {Boolean}
2599
2883
  * @sample {highcharts} highcharts/tooltip/shared-false/
2600
2884
  * False by default
2601
- * @sample {highcharts} highcharts/tooltip/shared-true/ True
2885
+ * @sample {highcharts} highcharts/tooltip/shared-true/
2886
+ * True
2602
2887
  * @sample {highcharts} highcharts/tooltip/shared-x-crosshair/
2603
2888
  * True with x axis crosshair
2604
2889
  * @sample {highcharts} highcharts/tooltip/shared-true-mixed-types/
2605
2890
  * True with mixed series types
2606
- * @default false
2607
- * @since 2.1
2608
- * @product highcharts highstock
2891
+ *
2892
+ * @type {boolean}
2893
+ * @default false
2894
+ * @since 2.1
2895
+ * @product highcharts highstock
2609
2896
  * @apioption tooltip.shared
2610
2897
  */
2611
2898
 
@@ -2620,12 +2907,14 @@ H.defaultOptions = {
2620
2907
  * and multiple panes, making split tooltips the preferred layout over
2621
2908
  * the previous `shared` tooltip.
2622
2909
  *
2623
- * @type {Boolean}
2624
- * @sample highcharts/tooltip/split/ Split tooltip
2625
- * @default {highcharts} false
2626
- * @default {highstock} true
2627
- * @product highcharts highstock
2628
- * @since 5.0.0
2910
+ * @sample highcharts/tooltip/split/
2911
+ * Split tooltip
2912
+ *
2913
+ * @type {boolean}
2914
+ * @default {highcharts} false
2915
+ * @default {highstock} true
2916
+ * @since 5.0.0
2917
+ * @product highcharts highstock
2629
2918
  * @apioption tooltip.split
2630
2919
  */
2631
2920
 
@@ -2635,14 +2924,16 @@ H.defaultOptions = {
2635
2924
  * tooltip. It is also recommended for rtl languages as it works around
2636
2925
  * rtl bugs in early Firefox.
2637
2926
  *
2638
- * @type {Boolean}
2639
2927
  * @sample {highcharts|highstock} highcharts/tooltip/footerformat/
2640
2928
  * A table for value alignment
2641
2929
  * @sample {highcharts|highstock} highcharts/tooltip/fullhtml/
2642
2930
  * Full HTML tooltip
2643
- * @sample {highmaps} maps/tooltip/usehtml/ Pure HTML tooltip
2644
- * @default false
2645
- * @since 2.2
2931
+ * @sample {highmaps} maps/tooltip/usehtml/
2932
+ * Pure HTML tooltip
2933
+ *
2934
+ * @type {boolean}
2935
+ * @default false
2936
+ * @since 2.2
2646
2937
  * @apioption tooltip.useHTML
2647
2938
  */
2648
2939
 
@@ -2651,12 +2942,13 @@ H.defaultOptions = {
2651
2942
  * overridable in each series' tooltip options object. The default is to
2652
2943
  * preserve all decimals.
2653
2944
  *
2654
- * @type {Number}
2655
2945
  * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
2656
2946
  * Set decimals, prefix and suffix for the value
2657
2947
  * @sample {highmaps} maps/tooltip/valuedecimals/
2658
2948
  * Set decimals, prefix and suffix for the value
2659
- * @since 2.2
2949
+ *
2950
+ * @type {number}
2951
+ * @since 2.2
2660
2952
  * @apioption tooltip.valueDecimals
2661
2953
  */
2662
2954
 
@@ -2664,12 +2956,13 @@ H.defaultOptions = {
2664
2956
  * A string to prepend to each series' y value. Overridable in each
2665
2957
  * series' tooltip options object.
2666
2958
  *
2667
- * @type {String}
2668
2959
  * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
2669
2960
  * Set decimals, prefix and suffix for the value
2670
2961
  * @sample {highmaps} maps/tooltip/valuedecimals/
2671
2962
  * Set decimals, prefix and suffix for the value
2672
- * @since 2.2
2963
+ *
2964
+ * @type {string}
2965
+ * @since 2.2
2673
2966
  * @apioption tooltip.valuePrefix
2674
2967
  */
2675
2968
 
@@ -2677,12 +2970,13 @@ H.defaultOptions = {
2677
2970
  * A string to append to each series' y value. Overridable in each
2678
2971
  * series' tooltip options object.
2679
2972
  *
2680
- * @type {String}
2681
2973
  * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
2682
2974
  * Set decimals, prefix and suffix for the value
2683
2975
  * @sample {highmaps} maps/tooltip/valuedecimals/
2684
2976
  * Set decimals, prefix and suffix for the value
2685
- * @since 2.2
2977
+ *
2978
+ * @type {string}
2979
+ * @since 2.2
2686
2980
  * @apioption tooltip.valueSuffix
2687
2981
  */
2688
2982
 
@@ -2691,44 +2985,53 @@ H.defaultOptions = {
2691
2985
  * datetime axis. The default is a best guess based on the smallest
2692
2986
  * distance between points in the chart.
2693
2987
  *
2694
- * @type {String}
2695
- * @sample {highcharts} highcharts/tooltip/xdateformat/ A different format
2696
- * @product highcharts highstock
2988
+ * @sample {highcharts} highcharts/tooltip/xdateformat/
2989
+ * A different format
2990
+ *
2991
+ * @type {string}
2992
+ * @product highcharts highstock gantt
2697
2993
  * @apioption tooltip.xDateFormat
2698
2994
  */
2699
2995
 
2996
+ /**
2997
+ * How many decimals to show for the `point.change` value when the
2998
+ * `series.compare` option is set. This is overridable in each series'
2999
+ * tooltip options object. The default is to preserve all decimals.
3000
+ *
3001
+ * @type {number}
3002
+ * @since 1.0.1
3003
+ * @product highstock
3004
+ * @apioption tooltip.changeDecimals
3005
+ */
3006
+
2700
3007
  /**
2701
3008
  * Enable or disable the tooltip.
2702
3009
  *
2703
- * @type {Boolean}
2704
- * @sample {highcharts} highcharts/tooltip/enabled/ Disabled
2705
- * @sample {highcharts}
2706
- * highcharts/plotoptions/series-point-events-mouseover/
3010
+ * @sample {highcharts} highcharts/tooltip/enabled/
3011
+ * Disabled
3012
+ * @sample {highcharts} highcharts/plotoptions/series-point-events-mouseover/
2707
3013
  * Disable tooltip and show values on chart instead
2708
- * @default true
2709
3014
  */
2710
3015
  enabled: true,
2711
3016
 
2712
3017
  /**
2713
3018
  * Enable or disable animation of the tooltip.
2714
3019
  *
2715
- * @type {Boolean}
2716
- * @default true
2717
- * @since 2.3.0
3020
+ * @type {boolean}
3021
+ * @default true
3022
+ * @since 2.3.0
2718
3023
  */
2719
3024
  animation: svg,
2720
3025
 
2721
3026
  /**
2722
3027
  * The radius of the rounded border corners.
2723
3028
  *
2724
- * @type {Number}
2725
3029
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2726
3030
  * 5px by default
2727
3031
  * @sample {highcharts} highcharts/tooltip/borderradius-0/
2728
3032
  * Square borders
2729
3033
  * @sample {highmaps} maps/tooltip/background-border/
2730
3034
  * Background and border demo
2731
- * @default 3
2732
3035
  */
2733
3036
  borderRadius: 3,
2734
3037
 
@@ -2739,22 +3042,10 @@ H.defaultOptions = {
2739
3042
  * each unit. For an overview of the replacement codes, see
2740
3043
  * [dateFormat](/class-reference/Highcharts#dateFormat).
2741
3044
  *
2742
- * Defaults to:
2743
- *
2744
- * <pre>{
2745
- * millisecond:"%A, %b %e, %H:%M:%S.%L",
2746
- * second:"%A, %b %e, %H:%M:%S",
2747
- * minute:"%A, %b %e, %H:%M",
2748
- * hour:"%A, %b %e, %H:%M",
2749
- * day:"%A, %b %e, %Y",
2750
- * week:"Week from %A, %b %e, %Y",
2751
- * month:"%B %Y",
2752
- * year:"%Y"
2753
- * }</pre>
2754
- *
2755
- * @type {Object}
2756
3045
  * @see [xAxis.dateTimeLabelFormats](#xAxis.dateTimeLabelFormats)
2757
- * @product highcharts highstock
3046
+ *
3047
+ * @type {Highcharts.Dictionary<string>}
3048
+ * @product highcharts highstock gantt
2758
3049
  */
2759
3050
  dateTimeLabelFormats: {
2760
3051
  millisecond: '%A, %b %e, %H:%M:%S.%L',
@@ -2772,7 +3063,9 @@ H.defaultOptions = {
2772
3063
  *
2773
3064
  * @sample {highcharts} highcharts/tooltip/footerformat/
2774
3065
  * A table for value alignment
2775
- * @sample {highmaps} maps/tooltip/format/ Format demo
3066
+ * @sample {highmaps} maps/tooltip/format/
3067
+ * Format demo
3068
+ *
2776
3069
  * @since 2.2
2777
3070
  */
2778
3071
  footerFormat: '',
@@ -2780,9 +3073,7 @@ H.defaultOptions = {
2780
3073
  /**
2781
3074
  * Padding inside the tooltip, in pixels.
2782
3075
  *
2783
- * @type {Number}
2784
- * @default 8
2785
- * @since 5.0.0
3076
+ * @since 5.0.0
2786
3077
  */
2787
3078
  padding: 8,
2788
3079
 
@@ -2796,15 +3087,18 @@ H.defaultOptions = {
2796
3087
  * is `true` (default) and when the tooltip is [shared](#tooltip.shared)
2797
3088
  * or [split](#tooltip.split).
2798
3089
  *
2799
- * @type {Number}
2800
3090
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2801
3091
  * 10 px by default
2802
- * @sample {highcharts} highcharts/tooltip/snap-50/ 50 px on graph
3092
+ * @sample {highcharts} highcharts/tooltip/snap-50/
3093
+ * 50 px on graph
3094
+ *
3095
+ * @type {number}
2803
3096
  * @default 10/25
2804
- * @since 1.2.0
3097
+ * @since 1.2.0
2805
3098
  * @product highcharts highstock
2806
3099
  */
2807
3100
  snap: isTouchDevice ? 25 : 10,
3101
+
2808
3102
 
2809
3103
 
2810
3104
  /**
@@ -2813,21 +3107,22 @@ H.defaultOptions = {
2813
3107
  * In styled mode, the stroke width is set in the
2814
3108
  * `.highcharts-tooltip-box` class.
2815
3109
  *
2816
- * @type {Color}
2817
3110
  * @sample {highcharts} highcharts/tooltip/backgroundcolor-solid/
2818
3111
  * Yellowish background
2819
3112
  * @sample {highcharts} highcharts/tooltip/backgroundcolor-gradient/
2820
3113
  * Gradient
2821
3114
  * @sample {highcharts} highcharts/css/tooltip-border-background/
2822
3115
  * Tooltip in styled mode
2823
- * @sample {highstock} stock/tooltip/general/ Custom tooltip
3116
+ * @sample {highstock} stock/tooltip/general/
3117
+ * Custom tooltip
2824
3118
  * @sample {highstock} highcharts/css/tooltip-border-background/
2825
3119
  * Tooltip in styled mode
2826
3120
  * @sample {highmaps} maps/tooltip/background-border/
2827
3121
  * Background and border demo
2828
3122
  * @sample {highmaps} highcharts/css/tooltip-border-background/
2829
3123
  * Tooltip in styled mode
2830
- * @default rgba(247,247,247,0.85)
3124
+ *
3125
+ * @type {Highcharts.ColorString}
2831
3126
  */
2832
3127
  backgroundColor: color('#f7f7f7')
2833
3128
  .setOpacity(0.85).get(),
@@ -2838,7 +3133,6 @@ H.defaultOptions = {
2838
3133
  * In styled mode, the stroke width is set in the
2839
3134
  * `.highcharts-tooltip-box` class.
2840
3135
  *
2841
- * @type {Number}
2842
3136
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2843
3137
  * 2px by default
2844
3138
  * @sample {highcharts} highcharts/tooltip/borderwidth/
@@ -2853,7 +3147,6 @@ H.defaultOptions = {
2853
3147
  * Background and border demo
2854
3148
  * @sample {highmaps} highcharts/css/tooltip-border-background/
2855
3149
  * Tooltip in styled mode
2856
- * @default 1
2857
3150
  */
2858
3151
  borderWidth: 1,
2859
3152
 
@@ -2864,14 +3157,15 @@ H.defaultOptions = {
2864
3157
  * objects. The `point.key` variable contains the category name, x
2865
3158
  * value or datetime string depending on the type of axis. For datetime
2866
3159
  * axes, the `point.key` date format can be set using
2867
- * `tooltip.xDateFormat`.
3160
+ * `tooltip.xDateFormat`. To access the original point use
3161
+ * `point.point`.
2868
3162
  *
2869
- * @type {String}
2870
3163
  * @sample {highcharts} highcharts/tooltip/footerformat/
2871
- * A HTML table in the tooltip
3164
+ * An HTML table in the tooltip
2872
3165
  * @sample {highstock} highcharts/tooltip/footerformat/
2873
- * A HTML table in the tooltip
2874
- * @sample {highmaps} maps/tooltip/format/ Format demo
3166
+ * An HTML table in the tooltip
3167
+ * @sample {highmaps} maps/tooltip/format/
3168
+ * Format demo
2875
3169
  */
2876
3170
  headerFormat: '<span style="font-size: 10px">{point.key}</span><br/>',
2877
3171
 
@@ -2886,11 +3180,11 @@ H.defaultOptions = {
2886
3180
  * In styled mode, the dot is colored by a class name rather
2887
3181
  * than the point color.
2888
3182
  *
2889
- * @type {String}
2890
3183
  * @sample {highcharts} highcharts/tooltip/pointformat/
2891
3184
  * A different point format with value suffix
2892
- * @sample {highmaps} maps/tooltip/format/ Format demo
2893
- * @default <span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.y}</b><br/>
3185
+ * @sample {highmaps} maps/tooltip/format/
3186
+ * Format demo
3187
+ *
2894
3188
  * @since 2.2
2895
3189
  */
2896
3190
  pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.y}</b><br/>',
@@ -2898,14 +3192,12 @@ H.defaultOptions = {
2898
3192
  /**
2899
3193
  * Whether to apply a drop shadow to the tooltip.
2900
3194
  *
2901
- * @type {Boolean}
2902
3195
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2903
3196
  * True by default
2904
3197
  * @sample {highcharts} highcharts/tooltip/shadow/
2905
3198
  * False
2906
3199
  * @sample {highmaps} maps/tooltip/positioner/
2907
3200
  * Fixed tooltip position, border and shadow disabled
2908
- * @default true
2909
3201
  */
2910
3202
  shadow: true,
2911
3203
 
@@ -2913,17 +3205,33 @@ H.defaultOptions = {
2913
3205
  * CSS styles for the tooltip. The tooltip can also be styled through
2914
3206
  * the CSS class `.highcharts-tooltip`.
2915
3207
  *
2916
- * @type {CSSObject}
2917
3208
  * @sample {highcharts} highcharts/tooltip/style/
2918
3209
  * Greater padding, bold text
2919
- * @default { "color": "#333333", "cursor": "default", "fontSize": "12px", "pointerEvents": "none", "whiteSpace": "nowrap" }
3210
+ *
3211
+ * @type {Highcharts.CSSObject}
3212
+ * @default {"color": "#333333", "cursor": "default", "fontSize": "12px", "pointerEvents": "none", "whiteSpace": "nowrap"}
2920
3213
  */
2921
3214
  style: {
3215
+ /**
3216
+ * @ignore
3217
+ */
2922
3218
  color: '#333333',
3219
+ /**
3220
+ * @ignore
3221
+ */
2923
3222
  cursor: 'default',
3223
+ /**
3224
+ * @ignore
3225
+ */
2924
3226
  fontSize: '12px',
2925
- // #1686 http://caniuse.com/#feat=pointer-events
3227
+ /**
3228
+ * @ignore
3229
+ */
2926
3230
  pointerEvents: 'none',
3231
+ // #1686 http://caniuse.com/#feat=pointer-events
3232
+ /**
3233
+ * @ignore
3234
+ */
2927
3235
  whiteSpace: 'nowrap'
2928
3236
  }
2929
3237
 
@@ -2936,37 +3244,70 @@ H.defaultOptions = {
2936
3244
  */
2937
3245
  credits: {
2938
3246
 
3247
+ /**
3248
+ * Credits for map source to be concatenated with conventional credit
3249
+ * text. By default this is a format string that collects copyright
3250
+ * information from the map if available.
3251
+ *
3252
+ * @see [mapTextFull](#credits.mapTextFull)
3253
+ * @see [text](#credits.text)
3254
+ *
3255
+ * @type {string}
3256
+ * @default \u00a9 <a href="{geojson.copyrightUrl}">{geojson.copyrightShort}</a>
3257
+ * @since 4.2.2
3258
+ * @product highmaps
3259
+ * @apioption credits.mapText
3260
+ */
3261
+
3262
+ /**
3263
+ * Detailed credits for map source to be displayed on hover of credits
3264
+ * text. By default this is a format string that collects copyright
3265
+ * information from the map if available.
3266
+ *
3267
+ * @see [mapText](#credits.mapText)
3268
+ * @see [text](#credits.text)
3269
+ *
3270
+ * @type {string}
3271
+ * @default {geojson.copyright}
3272
+ * @since 4.2.2
3273
+ * @product highmaps
3274
+ * @apioption credits.mapTextFull
3275
+ */
3276
+
2939
3277
  /**
2940
3278
  * Whether to show the credits text.
2941
3279
  *
2942
- * @type {Boolean}
2943
- * @sample {highcharts} highcharts/credits/enabled-false/ Credits disabled
2944
- * @sample {highstock} stock/credits/enabled/ Credits disabled
2945
- * @sample {highmaps} maps/credits/enabled-false/ Credits disabled
2946
- * @default true
3280
+ * @sample {highcharts} highcharts/credits/enabled-false/
3281
+ * Credits disabled
3282
+ * @sample {highstock} stock/credits/enabled/
3283
+ * Credits disabled
3284
+ * @sample {highmaps} maps/credits/enabled-false/
3285
+ * Credits disabled
2947
3286
  */
2948
3287
  enabled: true,
2949
3288
 
2950
3289
  /**
2951
3290
  * The URL for the credits label.
2952
3291
  *
2953
- * @type {String}
2954
- * @sample {highcharts} highcharts/credits/href/ Custom URL and text
2955
- * @sample {highmaps} maps/credits/customized/ Custom URL and text
2956
- * @default {highcharts} http://www.highcharts.com
2957
- * @default {highstock} "http://www.highcharts.com"
2958
- * @default {highmaps} http://www.highcharts.com
3292
+ * @sample {highcharts} highcharts/credits/href/
3293
+ * Custom URL and text
3294
+ * @sample {highmaps} maps/credits/customized/
3295
+ * Custom URL and text
2959
3296
  */
2960
- href: 'http://www.highcharts.com',
3297
+ href: 'https://www.highcharts.com',
2961
3298
 
2962
3299
  /**
2963
3300
  * Position configuration for the credits label.
2964
3301
  *
2965
- * @type {Object}
2966
- * @sample {highcharts} highcharts/credits/position-left/ Left aligned
2967
- * @sample {highcharts} highcharts/credits/position-left/ Left aligned
2968
- * @sample {highmaps} maps/credits/customized/ Left aligned
2969
- * @sample {highmaps} maps/credits/customized/ Left aligned
3302
+ * @sample {highcharts} highcharts/credits/position-left/
3303
+ * Left aligned
3304
+ * @sample {highcharts} highcharts/credits/position-left/
3305
+ * Left aligned
3306
+ * @sample {highmaps} maps/credits/customized/
3307
+ * Left aligned
3308
+ * @sample {highmaps} maps/credits/customized/
3309
+ * Left aligned
3310
+ *
2970
3311
  * @since 2.1
2971
3312
  */
2972
3313
  position: {
@@ -2975,16 +3316,11 @@ H.defaultOptions = {
2975
3316
  * Horizontal alignment of the credits.
2976
3317
  *
2977
3318
  * @validvalue ["left", "center", "right"]
2978
- * @type {String}
2979
- * @default right
2980
3319
  */
2981
3320
  align: 'right',
2982
3321
 
2983
3322
  /**
2984
3323
  * Horizontal pixel offset of the credits.
2985
- *
2986
- * @type {Number}
2987
- * @default -10
2988
3324
  */
2989
3325
  x: -10,
2990
3326
 
@@ -2992,35 +3328,42 @@ H.defaultOptions = {
2992
3328
  * Vertical alignment of the credits.
2993
3329
  *
2994
3330
  * @validvalue ["top", "middle", "bottom"]
2995
- * @type {String}
2996
- * @default bottom
2997
3331
  */
2998
3332
  verticalAlign: 'bottom',
2999
3333
 
3000
3334
  /**
3001
3335
  * Vertical pixel offset of the credits.
3002
- *
3003
- * @type {Number}
3004
- * @default -5
3005
3336
  */
3006
3337
  y: -5
3338
+
3007
3339
  },
3340
+
3008
3341
 
3009
3342
 
3010
3343
  /**
3011
3344
  * CSS styles for the credits label.
3012
3345
  *
3013
- * @type {CSSObject}
3014
3346
  * @see In styled mode, credits styles can be set with the
3015
- * `.highcharts-credits` class.
3016
- * @default { "cursor": "pointer", "color": "#999999", "fontSize": "10px" }
3347
+ * `.highcharts-credits` class.
3348
+ *
3349
+ * @type {Highcharts.CSSObject}
3350
+ * @default {"cursor": "pointer", "color": "#999999", "fontSize": "10px"}
3017
3351
  */
3018
3352
  style: {
3019
-
3353
+ /**
3354
+ * @ignore
3355
+ */
3020
3356
  cursor: 'pointer',
3357
+ /**
3358
+ * @ignore
3359
+ */
3021
3360
  color: '#999999',
3361
+ /**
3362
+ * @ignore
3363
+ */
3022
3364
  fontSize: '9px'
3023
3365
  },
3366
+
3024
3367
 
3025
3368
 
3026
3369
  /**
@@ -3031,12 +3374,13 @@ H.defaultOptions = {
3031
3374
  * `Highcharts @ {map-credits}`. Otherwise, it defaults to
3032
3375
  * `Highcharts.com`.
3033
3376
  *
3034
- * @type {String}
3035
- * @sample {highcharts} highcharts/credits/href/ Custom URL and text
3036
- * @sample {highmaps} maps/credits/customized/ Custom URL and text
3037
- * @default {highcharts|highstock} Highcharts.com
3377
+ * @sample {highcharts} highcharts/credits/href/
3378
+ * Custom URL and text
3379
+ * @sample {highmaps} maps/credits/customized/
3380
+ * Custom URL and text
3038
3381
  */
3039
3382
  text: 'Highcharts.com'
3383
+
3040
3384
  }
3041
3385
  };
3042
3386
 
@@ -3044,12 +3388,16 @@ H.defaultOptions = {
3044
3388
  * Merge the default options with custom options and return the new options
3045
3389
  * structure. Commonly used for defining reusable templates.
3046
3390
  *
3047
- * @function #setOptions
3048
- * @memberof Highcharts
3049
3391
  * @sample highcharts/global/useutc-false Setting a global option
3050
3392
  * @sample highcharts/members/setoptions Applying a global theme
3051
- * @param {Object} options The new custom chart options.
3052
- * @returns {Object} Updated options.
3393
+ *
3394
+ * @function Highcharts.setOptions
3395
+ *
3396
+ * @param {Highcharts.Options} options
3397
+ * The new custom chart options.
3398
+ *
3399
+ * @return {Highcharts.Options}
3400
+ * Updated options.
3053
3401
  */
3054
3402
  H.setOptions = function (options) {
3055
3403
 
@@ -3069,6 +3417,10 @@ H.setOptions = function (options) {
3069
3417
  * Get the updated default options. Until 3.0.7, merely exposing defaultOptions
3070
3418
  * for outside modules wasn't enough because the setOptions method created a new
3071
3419
  * object.
3420
+ *
3421
+ * @function Highcharts.getOptions
3422
+ *
3423
+ * @return {Highcharts.Options}
3072
3424
  */
3073
3425
  H.getOptions = function () {
3074
3426
  return H.defaultOptions;
@@ -3079,7 +3431,14 @@ H.getOptions = function () {
3079
3431
  H.defaultPlotOptions = H.defaultOptions.plotOptions;
3080
3432
 
3081
3433
 
3082
- // Time utilities
3434
+ /**
3435
+ * Global `Time` object with default options. Since v6.0.5, time settings can be
3436
+ * applied individually for each chart. If no individual settings apply, this
3437
+ * `Time` object is shared by all instances.
3438
+ *
3439
+ * @name Highcharts.time
3440
+ * @type {Highcharts.Time}
3441
+ */
3083
3442
  H.time = new H.Time(merge(H.defaultOptions.global, H.defaultOptions.time));
3084
3443
 
3085
3444
  /**
@@ -3094,13 +3453,20 @@ H.time = new H.Time(merge(H.defaultOptions.global, H.defaultOptions.time));
3094
3453
  * `Highcharts.dateFormat` function only reflects global time settings set with
3095
3454
  * `setOptions`.
3096
3455
  *
3097
- * @function #dateFormat
3098
- * @memberof Highcharts
3099
- * @param {String} format - The desired format where various time
3100
- * representations are prefixed with %.
3101
- * @param {Number} timestamp - The JavaScript timestamp.
3102
- * @param {Boolean} [capitalize=false] - Upper case first letter in the return.
3103
- * @returns {String} The formatted date.
3456
+ * @function Highcharts.dateFormat
3457
+ *
3458
+ * @param {string} format
3459
+ * The desired format where various time representations are prefixed
3460
+ * with `%`.
3461
+ *
3462
+ * @param {number} timestamp
3463
+ * The JavaScript timestamp.
3464
+ *
3465
+ * @param {boolean} [capitalize=false]
3466
+ * Upper case first letter in the return.
3467
+ *
3468
+ * @return {string}
3469
+ * The formatted date.
3104
3470
  */
3105
3471
  H.dateFormat = function (format, timestamp, capitalize) {
3106
3472
  return H.time.dateFormat(format, timestamp, capitalize);