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 = {
@@ -26,12 +31,12 @@ H.defaultOptions = {
26
31
 
27
32
  /**
28
33
  * Styled mode only. Configuration object for adding SVG definitions for
29
- * reusable elements. See [gradients, shadows and patterns](http://www.
30
- * highcharts.com/docs/chart-design-and-style/gradients-shadows-and-
31
- * patterns) for more information and code examples.
34
+ * reusable elements. See [gradients, shadows and
35
+ * patterns](https://www.highcharts.com/docs/chart-design-and-style/gradients-shadows-and-patterns)
36
+ * for more information and code examples.
32
37
  *
33
- * @type {Object}
34
- * @since 5.0.0
38
+ * @type {*}
39
+ * @since 5.0.0
35
40
  * @apioption defs
36
41
  */
37
42
 
@@ -39,14 +44,31 @@ H.defaultOptions = {
39
44
  * @ignore-option
40
45
  */
41
46
  symbols: ['circle', 'diamond', 'square', 'triangle', 'triangle-down'],
47
+
48
+ /**
49
+ * The language object is global and it can't be set on each chart
50
+ * initiation. Instead, use `Highcharts.setOptions` to set it before any
51
+ * chart is initialized.
52
+ *
53
+ * <pre>Highcharts.setOptions({
54
+ * lang: {
55
+ * months: [
56
+ * 'Janvier', 'Février', 'Mars', 'Avril',
57
+ * 'Mai', 'Juin', 'Juillet', 'Août',
58
+ * 'Septembre', 'Octobre', 'Novembre', 'Décembre'
59
+ * ],
60
+ * weekdays: [
61
+ * 'Dimanche', 'Lundi', 'Mardi', 'Mercredi',
62
+ * 'Jeudi', 'Vendredi', 'Samedi'
63
+ * ]
64
+ * }
65
+ * });</pre>
66
+ */
42
67
  lang: {
43
68
 
44
69
  /**
45
70
  * The loading text that appears when the chart is set into the loading
46
71
  * state following a call to `chart.showLoading`.
47
- *
48
- * @type {String}
49
- * @default Loading...
50
72
  */
51
73
  loading: 'Loading...',
52
74
 
@@ -54,10 +76,10 @@ H.defaultOptions = {
54
76
  * An array containing the months names. Corresponds to the `%B` format
55
77
  * in `Highcharts.dateFormat()`.
56
78
  *
57
- * @type {Array<String>}
58
- * @default [ "January" , "February" , "March" , "April" , "May" ,
59
- * "June" , "July" , "August" , "September" , "October" ,
60
- * "November" , "December"]
79
+ * @type {Array<string>}
80
+ * @default ["January", "February", "March", "April", "May", "June",
81
+ * "July", "August", "September", "October", "November",
82
+ * "December"]
61
83
  */
62
84
  months: [
63
85
  'January', 'February', 'March', 'April', 'May', 'June', 'July',
@@ -68,9 +90,9 @@ H.defaultOptions = {
68
90
  * An array containing the months names in abbreviated form. Corresponds
69
91
  * to the `%b` format in `Highcharts.dateFormat()`.
70
92
  *
71
- * @type {Array<String>}
72
- * @default [ "Jan" , "Feb" , "Mar" , "Apr" , "May" , "Jun" ,
73
- * "Jul" , "Aug" , "Sep" , "Oct" , "Nov" , "Dec"]
93
+ * @type {Array<string>}
94
+ * @default ["Jan", "Feb", "Mar", "Apr", "May", "Jun",
95
+ * "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]
74
96
  */
75
97
  shortMonths: [
76
98
  'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul',
@@ -80,7 +102,7 @@ H.defaultOptions = {
80
102
  /**
81
103
  * An array containing the weekday names.
82
104
  *
83
- * @type {Array<String>}
105
+ * @type {Array<string>}
84
106
  * @default ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday",
85
107
  * "Friday", "Saturday"]
86
108
  */
@@ -93,10 +115,11 @@ H.defaultOptions = {
93
115
  * Short week days, starting Sunday. If not specified, Highcharts uses
94
116
  * the first three letters of the `lang.weekdays` option.
95
117
  *
96
- * @type {Array<String>}
97
118
  * @sample highcharts/lang/shortweekdays/
98
119
  * Finnish two-letter abbreviations
99
- * @since 4.2.4
120
+ *
121
+ * @type {Array<string>}
122
+ * @since 4.2.4
100
123
  * @apioption lang.shortWeekdays
101
124
  */
102
125
 
@@ -104,18 +127,36 @@ H.defaultOptions = {
104
127
  * What to show in a date field for invalid dates. Defaults to an empty
105
128
  * string.
106
129
  *
107
- * @type {String}
108
- * @since 4.1.8
109
- * @product highcharts highstock
130
+ * @type {string}
131
+ * @since 4.1.8
132
+ * @product highcharts highstock
110
133
  * @apioption lang.invalidDate
111
134
  */
112
135
 
136
+ /**
137
+ * The title appearing on hovering the zoom in button. The text itself
138
+ * defaults to "+" and can be changed in the button options.
139
+ *
140
+ * @type {string}
141
+ * @default Zoom in
142
+ * @product highmaps
143
+ * @apioption lang.zoomIn
144
+ */
145
+
146
+ /**
147
+ * The title appearing on hovering the zoom out button. The text itself
148
+ * defaults to "-" and can be changed in the button options.
149
+ *
150
+ * @type {string}
151
+ * @default Zoom out
152
+ * @product highmaps
153
+ * @apioption lang.zoomOut
154
+ */
155
+
113
156
  /**
114
157
  * The default decimal point used in the `Highcharts.numberFormat`
115
158
  * method unless otherwise specified in the function arguments.
116
159
  *
117
- * @type {String}
118
- * @default .
119
160
  * @since 1.2.2
120
161
  */
121
162
  decimalPoint: '.',
@@ -126,13 +167,14 @@ H.defaultOptions = {
126
167
  * positions with `null` causes the full number to be written. Setting
127
168
  * `numericSymbols` to `null` disables shortening altogether.
128
169
  *
129
- * @type {Array<String>}
130
170
  * @sample {highcharts} highcharts/lang/numericsymbols/
131
171
  * Replacing the symbols with text
132
172
  * @sample {highstock} highcharts/lang/numericsymbols/
133
173
  * Replacing the symbols with text
134
- * @default [ "k" , "M" , "G" , "T" , "P" , "E"]
135
- * @since 2.3.0
174
+ *
175
+ * @type {Array<string>}
176
+ * @default ["k", "M", "G", "T", "P", "E"]
177
+ * @since 2.3.0
136
178
  */
137
179
  numericSymbols: ['k', 'M', 'G', 'T', 'P', 'E'],
138
180
 
@@ -141,19 +183,18 @@ H.defaultOptions = {
141
183
  * Use 10000 for Japanese, Korean and various Chinese locales, which
142
184
  * use symbols for 10^4, 10^8 and 10^12.
143
185
  *
144
- * @type {Number}
145
186
  * @sample highcharts/lang/numericsymbolmagnitude/
146
187
  * 10000 magnitude for Japanese
147
- * @default 1000
148
- * @since 5.0.3
188
+ *
189
+ * @type {number}
190
+ * @default 1000
191
+ * @since 5.0.3
149
192
  * @apioption lang.numericSymbolMagnitude
150
193
  */
151
194
 
152
195
  /**
153
196
  * The text for the label appearing when a chart is zoomed.
154
197
  *
155
- * @type {String}
156
- * @default Reset zoom
157
198
  * @since 1.2.4
158
199
  */
159
200
  resetZoom: 'Reset zoom',
@@ -161,8 +202,6 @@ H.defaultOptions = {
161
202
  /**
162
203
  * The tooltip title for the label appearing when a chart is zoomed.
163
204
  *
164
- * @type {String}
165
- * @default Reset zoom level 1:1
166
205
  * @since 1.2.4
167
206
  */
168
207
  resetZoomTitle: 'Reset zoom level 1:1',
@@ -176,9 +215,8 @@ H.defaultOptions = {
176
215
  *
177
216
  * The default is a single space.
178
217
  *
179
- * @type {String}
180
- * @default
181
- * @since 1.2.2
218
+ * @default \u0020
219
+ * @since 1.2.2
182
220
  */
183
221
  thousandsSep: ' '
184
222
  },
@@ -207,10 +245,11 @@ H.defaultOptions = {
207
245
  * our site, you can install canvas-tools.js on your own server and
208
246
  * change this option accordingly.
209
247
  *
210
- * @type {String}
211
248
  * @deprecated
212
- * @default http://code.highcharts.com/{version}/modules/canvas-tools.js
213
- * @product highcharts highmaps
249
+ *
250
+ * @type {string}
251
+ * @default http://code.highcharts.com/{version}/modules/canvas-tools.js
252
+ * @product highcharts highmaps
214
253
  * @apioption global.canvasToolsURL
215
254
  */
216
255
 
@@ -220,7 +259,8 @@ H.defaultOptions = {
220
259
  * per chart.
221
260
  *
222
261
  * @deprecated
223
- * @type {Boolean}
262
+ *
263
+ * @type {boolean}
224
264
  * @apioption global.useUTC
225
265
  */
226
266
 
@@ -230,8 +270,9 @@ H.defaultOptions = {
230
270
  * per chart.
231
271
  *
232
272
  * @deprecated
233
- * @type {Object}
234
- * @product highcharts highstock
273
+ *
274
+ * @type {Function}
275
+ * @product highcharts highstock
235
276
  * @apioption global.Date
236
277
  */
237
278
 
@@ -241,8 +282,9 @@ H.defaultOptions = {
241
282
  * individual time settings per chart.
242
283
  *
243
284
  * @deprecated
244
- * @type {Function}
245
- * @product highcharts highstock
285
+ *
286
+ * @type {Function}
287
+ * @product highcharts highstock
246
288
  * @apioption global.getTimezoneOffset
247
289
  */
248
290
 
@@ -252,8 +294,9 @@ H.defaultOptions = {
252
294
  * settings per chart.
253
295
  *
254
296
  * @deprecated
255
- * @type {String}
256
- * @product highcharts highstock
297
+ *
298
+ * @type {string}
299
+ * @product highcharts highstock
257
300
  * @apioption global.timezone
258
301
  */
259
302
 
@@ -263,21 +306,44 @@ H.defaultOptions = {
263
306
  * time settings per chart.
264
307
  *
265
308
  * @deprecated
266
- * @type {Number}
267
- * @product highcharts highstock
309
+ *
310
+ * @type {number}
311
+ * @product highcharts highstock
268
312
  * @apioption global.timezoneOffset
269
313
  */
270
- global: {},
271
314
 
315
+ global: {},
272
316
 
273
317
  time: H.Time.prototype.defaultOptions,
274
318
 
275
319
  /**
276
320
  * General options for the chart.
277
- * @type {Object}
278
321
  */
279
322
  chart: {
280
323
 
324
+ /**
325
+ * Default `mapData` for all series. If set to a string, it functions
326
+ * as an index into the `Highcharts.maps` array. Otherwise it is
327
+ * interpreted s map data.
328
+ *
329
+ * @see [mapData](#series.map.mapData)
330
+ *
331
+ * @type {string|Array<*>}
332
+ * @since 5.0.0
333
+ * @product highmaps
334
+ * @apioption chart.map
335
+ */
336
+
337
+ /**
338
+ * Set lat/lon transformation definitions for the chart. If not defined,
339
+ * these are extracted from the map data.
340
+ *
341
+ * @type {*}
342
+ * @since 5.0.0
343
+ * @product highmaps
344
+ * @apioption chart.mapTransforms
345
+ */
346
+
281
347
  /**
282
348
  * When using multiple axis, the ticks of two or more opposite axes
283
349
  * will automatically be aligned by adding ticks to the axis or axes
@@ -292,21 +358,21 @@ H.defaultOptions = {
292
358
  *
293
359
  * Disabled for logarithmic axes.
294
360
  *
295
- * @type {Boolean}
296
- * @sample {highcharts} highcharts/chart/alignticks-true/
297
- * True by default
298
- * @sample {highcharts} highcharts/chart/alignticks-false/
299
- * False
300
- * @sample {highstock} stock/chart/alignticks-true/
301
- * True by default
302
- * @sample {highstock} stock/chart/alignticks-false/
303
- * False
361
+ * @sample {highcharts} highcharts/chart/alignticks-true/
362
+ * True by default
363
+ * @sample {highcharts} highcharts/chart/alignticks-false/
364
+ * False
365
+ * @sample {highstock} stock/chart/alignticks-true/
366
+ * True by default
367
+ * @sample {highstock} stock/chart/alignticks-false/
368
+ * False
369
+ *
370
+ * @type {boolean}
304
371
  * @default true
305
- * @product highcharts highstock
372
+ * @product highcharts highstock gantt
306
373
  * @apioption chart.alignTicks
307
374
  */
308
375
 
309
-
310
376
  /**
311
377
  * Set the overall animation for all chart updating. Animation can be
312
378
  * disabled throughout the chart by setting it to false here. It can
@@ -329,13 +395,12 @@ H.defaultOptions = {
329
395
  * <dt>easing</dt>
330
396
  *
331
397
  * <dd>A string reference to an easing function set on the `Math`
332
- * object. See [the easing demo](
333
- * http://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).
398
+ * object. See [the easing
399
+ * demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).
334
400
  * </dd>
335
401
  *
336
402
  * </dl>
337
403
  *
338
- * @type {Boolean|Object}
339
404
  * @sample {highcharts} highcharts/chart/animation-none/
340
405
  * Updating with no animation
341
406
  * @sample {highcharts} highcharts/chart/animation-duration/
@@ -346,7 +411,9 @@ H.defaultOptions = {
346
411
  * Updating with no animation
347
412
  * @sample {highmaps} maps/chart/animation-duration/
348
413
  * With a longer duration
349
- * @default true
414
+ *
415
+ * @type {boolean|Highcharts.AnimationOptionsObject}
416
+ * @default true
350
417
  * @apioption chart.animation
351
418
  */
352
419
 
@@ -354,7 +421,7 @@ H.defaultOptions = {
354
421
  * A CSS class name to apply to the charts container `div`, allowing
355
422
  * unique CSS styling for each chart.
356
423
  *
357
- * @type {String}
424
+ * @type {string}
358
425
  * @apioption chart.className
359
426
  */
360
427
 
@@ -372,11 +439,14 @@ H.defaultOptions = {
372
439
  * passed to the `addSeries` method. Returning false prevents the series
373
440
  * from being added.
374
441
  *
375
- * @type {Function}
376
- * @context Chart
377
- * @sample {highcharts} highcharts/chart/events-addseries/ Alert on add series
378
- * @sample {highstock} stock/chart/events-addseries/ Alert on add series
379
- * @since 1.2.0
442
+ * @sample {highcharts} highcharts/chart/events-addseries/
443
+ * Alert on add series
444
+ * @sample {highstock} stock/chart/events-addseries/
445
+ * Alert on add series
446
+ *
447
+ * @type {Function}
448
+ * @since 1.2.0
449
+ * @context Highcharts.Chart
380
450
  * @apioption chart.events.addSeries
381
451
  */
382
452
 
@@ -397,8 +467,6 @@ H.defaultOptions = {
397
467
  * )
398
468
  * }</pre>
399
469
  *
400
- * @type {Function}
401
- * @context Chart
402
470
  * @sample {highcharts} highcharts/chart/events-click/
403
471
  * Alert coordinates on click
404
472
  * @sample {highcharts} highcharts/chart/events-container/
@@ -411,7 +479,10 @@ H.defaultOptions = {
411
479
  * Record coordinates on click
412
480
  * @sample {highmaps} highcharts/chart/events-container/
413
481
  * Alternatively, attach event to container
414
- * @since 1.2.0
482
+ *
483
+ * @type {Function}
484
+ * @since 1.2.0
485
+ * @context Highcharts.Chart
415
486
  * @apioption chart.events.click
416
487
  */
417
488
 
@@ -425,14 +496,15 @@ H.defaultOptions = {
425
496
  * There is also a second parameter to the chart constructor where a
426
497
  * callback function can be passed to be executed on chart.load.
427
498
  *
428
- * @type {Function}
429
- * @context Chart
430
499
  * @sample {highcharts} highcharts/chart/events-load/
431
500
  * Alert on chart load
432
501
  * @sample {highstock} stock/chart/events-load/
433
502
  * Alert on chart load
434
503
  * @sample {highmaps} maps/chart/events-load/
435
504
  * Add series on chart load
505
+ *
506
+ * @type {Function}
507
+ * @context Highcharts.Chart
436
508
  * @apioption chart.events.load
437
509
  */
438
510
 
@@ -442,8 +514,6 @@ H.defaultOptions = {
442
514
  * the `redraw` option set to true. One parameter, `event`, is passed to
443
515
  * the function, containing common event information.
444
516
  *
445
- * @type {Function}
446
- * @context Chart
447
517
  * @sample {highcharts} highcharts/chart/events-redraw/
448
518
  * Alert on chart redraw
449
519
  * @sample {highstock} stock/chart/events-redraw/
@@ -451,7 +521,10 @@ H.defaultOptions = {
451
521
  * zoomed range
452
522
  * @sample {highmaps} maps/chart/events-redraw/
453
523
  * Set subtitle on chart redraw
454
- * @since 1.2.0
524
+ *
525
+ * @type {Function}
526
+ * @since 1.2.0
527
+ * @context Highcharts.Chart
455
528
  * @apioption chart.events.redraw
456
529
  */
457
530
 
@@ -459,9 +532,9 @@ H.defaultOptions = {
459
532
  * Fires after initial load of the chart (directly after the `load`
460
533
  * event), and after each redraw (directly after the `redraw` event).
461
534
  *
462
- * @type {Function}
463
- * @context Chart
464
- * @since 5.0.7
535
+ * @type {Function}
536
+ * @since 5.0.7
537
+ * @context Highcharts.Chart
465
538
  * @apioption chart.events.render
466
539
  */
467
540
 
@@ -495,7 +568,6 @@ H.defaultOptions = {
495
568
  * console.log(event.yAxis[0].min, event.yAxis[0].max);
496
569
  * }</pre>
497
570
  *
498
- * @type {Function}
499
571
  * @sample {highcharts} highcharts/chart/events-selection/
500
572
  * Report on selection and reset
501
573
  * @sample {highcharts} highcharts/chart/events-selection-points/
@@ -505,6 +577,8 @@ H.defaultOptions = {
505
577
  * @sample {highstock} highcharts/chart/events-selection-points/
506
578
  * Select a range of points through a drag selection
507
579
  * (Highcharts)
580
+ *
581
+ * @type {Function}
508
582
  * @apioption chart.events.selection
509
583
  */
510
584
 
@@ -519,13 +593,12 @@ H.defaultOptions = {
519
593
  * subtitle and legend in addition to the `spacingTop`, `spacingRight`,
520
594
  * `spacingBottom` and `spacingLeft` options.
521
595
  *
522
- * @type {Array}
523
596
  * @sample {highcharts} highcharts/chart/margins-zero/
524
597
  * Zero margins
525
598
  * @sample {highstock} stock/chart/margin-zero/
526
599
  * Zero margins
527
600
  *
528
- * @defaults {all} null
601
+ * @type {number|Array<number>}
529
602
  * @apioption chart.margin
530
603
  */
531
604
 
@@ -534,14 +607,15 @@ H.defaultOptions = {
534
607
  * area. Use this to set a fixed pixel value for the margin as opposed
535
608
  * to the default dynamic margin. See also `spacingBottom`.
536
609
  *
537
- * @type {Number}
538
610
  * @sample {highcharts} highcharts/chart/marginbottom/
539
611
  * 100px bottom margin
540
612
  * @sample {highstock} stock/chart/marginbottom/
541
613
  * 100px bottom margin
542
614
  * @sample {highmaps} maps/chart/margin/
543
615
  * 100px margins
544
- * @since 2.0
616
+ *
617
+ * @type {number}
618
+ * @since 2.0
545
619
  * @apioption chart.marginBottom
546
620
  */
547
621
 
@@ -550,15 +624,15 @@ H.defaultOptions = {
550
624
  * area. Use this to set a fixed pixel value for the margin as opposed
551
625
  * to the default dynamic margin. See also `spacingLeft`.
552
626
  *
553
- * @type {Number}
554
627
  * @sample {highcharts} highcharts/chart/marginleft/
555
628
  * 150px left margin
556
629
  * @sample {highstock} stock/chart/marginleft/
557
630
  * 150px left margin
558
631
  * @sample {highmaps} maps/chart/margin/
559
632
  * 100px margins
560
- * @default null
561
- * @since 2.0
633
+ *
634
+ * @type {number}
635
+ * @since 2.0
562
636
  * @apioption chart.marginLeft
563
637
  */
564
638
 
@@ -567,15 +641,15 @@ H.defaultOptions = {
567
641
  * area. Use this to set a fixed pixel value for the margin as opposed
568
642
  * to the default dynamic margin. See also `spacingRight`.
569
643
  *
570
- * @type {Number}
571
644
  * @sample {highcharts} highcharts/chart/marginright/
572
645
  * 100px right margin
573
646
  * @sample {highstock} stock/chart/marginright/
574
647
  * 100px right margin
575
648
  * @sample {highmaps} maps/chart/margin/
576
649
  * 100px margins
577
- * @default null
578
- * @since 2.0
650
+ *
651
+ * @type {number}
652
+ * @since 2.0
579
653
  * @apioption chart.marginRight
580
654
  */
581
655
 
@@ -584,14 +658,14 @@ H.defaultOptions = {
584
658
  * Use this to set a fixed pixel value for the margin as opposed to
585
659
  * the default dynamic margin. See also `spacingTop`.
586
660
  *
587
- * @type {Number}
588
661
  * @sample {highcharts} highcharts/chart/margintop/ 100px top margin
589
662
  * @sample {highstock} stock/chart/margintop/
590
663
  * 100px top margin
591
664
  * @sample {highmaps} maps/chart/margin/
592
665
  * 100px margins
593
- * @default null
594
- * @since 2.0
666
+ *
667
+ * @type {number}
668
+ * @since 2.0
595
669
  * @apioption chart.marginTop
596
670
  */
597
671
 
@@ -602,11 +676,11 @@ H.defaultOptions = {
602
676
  * properties of the click event argument (`event.altKey`,
603
677
  * `event.ctrlKey`, `event.metaKey` and `event.shiftKey`).
604
678
  *
605
- * @validvalue [null, "alt", "ctrl", "meta", "shift"]
606
- * @type {String}
607
- * @since 4.0.3
608
- * @product highcharts
609
- * @apioption chart.panKey
679
+ * @type {string}
680
+ * @since 4.0.3
681
+ * @product highcharts gantt
682
+ * @validvalue ["alt", "ctrl", "meta", "shift"]
683
+ * @apioption chart.panKey
610
684
  */
611
685
 
612
686
  /**
@@ -618,12 +692,13 @@ H.defaultOptions = {
618
692
  * requires two fingers. To allow panning with one finger, set
619
693
  * `followTouchMove` to `false`.
620
694
  *
621
- * @type {Boolean}
622
695
  * @sample {highcharts} highcharts/chart/pankey/ Zooming and panning
623
- * @default {highcharts} false
624
- * @default {highstock} true
625
- * @since 4.0.3
626
- * @product highcharts highstock
696
+ *
697
+ * @type {boolean}
698
+ * @default {highcharts} false
699
+ * @default {highstock} true
700
+ * @since 4.0.3
701
+ * @product highcharts highstock gantt
627
702
  * @apioption chart.panning
628
703
  */
629
704
 
@@ -637,25 +712,28 @@ H.defaultOptions = {
637
712
  * #tooltip.followTouchMove) is true, pinchType only applies to
638
713
  * two-finger touches.
639
714
  *
640
- * @validvalue [null, "x", "y", "xy"]
641
- * @type {String}
642
- * @default {highcharts} null
643
- * @default {highstock} x
644
- * @since 3.0
645
- * @product highcharts highstock
646
- * @apioption chart.pinchType
715
+ * @type {string}
716
+ * @default {highcharts} undefined
717
+ * @default {highstock} x
718
+ * @since 3.0
719
+ * @product highcharts highstock gantt
720
+ * @validvalue ["x", "y", "xy"]
721
+ * @apioption chart.pinchType
647
722
  */
648
723
 
649
724
  /**
650
725
  * The corner radius of the outer chart border.
651
726
  *
652
- * @type {Number}
653
- * @sample {highcharts} highcharts/chart/borderradius/ 20px radius
654
- * @sample {highstock} stock/chart/border/ 10px radius
655
- * @sample {highmaps} maps/chart/border/ Border options
656
- * @default 0
727
+ * @sample {highcharts} highcharts/chart/borderradius/
728
+ * 20px radius
729
+ * @sample {highstock} stock/chart/border/
730
+ * 10px radius
731
+ * @sample {highmaps} maps/chart/border/
732
+ * Border options
733
+ *
657
734
  */
658
735
  borderRadius: 0,
736
+
659
737
 
660
738
 
661
739
  /**
@@ -665,21 +743,20 @@ H.defaultOptions = {
665
743
  * [...] `highcharts-color-9`. The equivalent in non-styled mode
666
744
  * is to set colors using the [colors](#colors) setting.
667
745
  *
668
- * @type {Number}
669
- * @default 10
670
- * @since 5.0.0
746
+ * @since 5.0.0
671
747
  */
672
748
  colorCount: 10,
749
+
673
750
 
674
751
 
675
752
  /**
676
753
  * Alias of `type`.
677
754
  *
678
- * @validvalue ["line", "spline", "column", "area", "areaspline", "pie"]
679
- * @type {String}
755
+ * @sample {highcharts} highcharts/chart/defaultseriestype/
756
+ * Bar
757
+ *
680
758
  * @deprecated
681
- * @sample {highcharts} highcharts/chart/defaultseriestype/ Bar
682
- * @default line
759
+ *
683
760
  * @product highcharts
684
761
  */
685
762
  defaultSeriesType: 'line',
@@ -691,7 +768,6 @@ H.defaultOptions = {
691
768
  * within the stack is hidden, the rest of the stack will close in
692
769
  * around it even if the axis is not affected.
693
770
  *
694
- * @type {Boolean}
695
771
  * @sample {highcharts} highcharts/chart/ignorehiddenseries-true/
696
772
  * True by default
697
773
  * @sample {highcharts} highcharts/chart/ignorehiddenseries-false/
@@ -702,9 +778,9 @@ H.defaultOptions = {
702
778
  * True by default
703
779
  * @sample {highstock} stock/chart/ignorehiddenseries-false/
704
780
  * False
705
- * @default true
706
- * @since 1.2.0
707
- * @product highcharts highstock
781
+ *
782
+ * @since 1.2.0
783
+ * @product highcharts highstock gantt
708
784
  */
709
785
  ignoreHiddenSeries: true,
710
786
 
@@ -720,13 +796,14 @@ H.defaultOptions = {
720
796
  * are no cartesian series in the chart, or if the chart is
721
797
  * [polar](#chart.polar).
722
798
  *
723
- * @type {Boolean}
724
799
  * @sample {highcharts} highcharts/chart/inverted/
725
800
  * Inverted line
726
801
  * @sample {highstock} stock/navigator/inverted/
727
802
  * Inverted stock chart
728
- * @default false
729
- * @product highcharts highstock
803
+ *
804
+ * @type {boolean}
805
+ * @default false
806
+ * @product highcharts highstock gantt
730
807
  * @apioption chart.inverted
731
808
  */
732
809
 
@@ -737,17 +814,16 @@ H.defaultOptions = {
737
814
  * respectively. Use the options spacingTop, spacingRight, spacingBottom
738
815
  * and spacingLeft options for shorthand setting of one option.
739
816
  *
740
- * @type {Array<Number>}
741
- * @see [chart.margin](#chart.margin)
817
+ * @type {Array<number>}
818
+ * @see [chart.margin](#chart.margin)
742
819
  * @default [10, 10, 15, 10]
743
- * @since 3.0.6
820
+ * @since 3.0.6
744
821
  */
745
822
  spacing: [10, 10, 15, 10],
746
823
 
747
824
  /**
748
825
  * The button that appears after a selection zoom, allowing the user
749
826
  * to reset zoom.
750
- *
751
827
  */
752
828
  resetZoomButton: {
753
829
 
@@ -755,15 +831,16 @@ H.defaultOptions = {
755
831
  * What frame the button should be placed related to. Can be either
756
832
  * `plot` or `chart`
757
833
  *
758
- * @validvalue ["plot", "chart"]
759
- * @type {String}
760
834
  * @sample {highcharts} highcharts/chart/resetzoombutton-relativeto/
761
835
  * Relative to the chart
762
836
  * @sample {highstock} highcharts/chart/resetzoombutton-relativeto/
763
837
  * Relative to the chart
764
- * @default plot
765
- * @since 2.2
766
- * @apioption chart.resetZoomButton.relativeTo
838
+ *
839
+ * @type {string}
840
+ * @default plot
841
+ * @since 2.2
842
+ * @validvalue ["plot", "chart"]
843
+ * @apioption chart.resetZoomButton.relativeTo
767
844
  */
768
845
 
769
846
  /**
@@ -773,11 +850,11 @@ H.defaultOptions = {
773
850
  * CSS properties for the text. Equivalent attributes for the hover
774
851
  * state are given in `theme.states.hover`.
775
852
  *
776
- * @type {Object}
777
853
  * @sample {highcharts} highcharts/chart/resetzoombutton-theme/
778
854
  * Theming the button
779
855
  * @sample {highstock} highcharts/chart/resetzoombutton-theme/
780
856
  * Theming the button
857
+ *
781
858
  * @since 2.2
782
859
  */
783
860
  theme: {
@@ -792,44 +869,38 @@ H.defaultOptions = {
792
869
  /**
793
870
  * The position of the button.
794
871
  *
795
- * @type {Object}
796
872
  * @sample {highcharts} highcharts/chart/resetzoombutton-position/
797
873
  * Above the plot area
798
874
  * @sample {highstock} highcharts/chart/resetzoombutton-position/
799
875
  * Above the plot area
800
876
  * @sample {highmaps} highcharts/chart/resetzoombutton-position/
801
877
  * Above the plot area
878
+ *
802
879
  * @since 2.2
803
880
  */
804
881
  position: {
805
882
 
806
883
  /**
807
884
  * The horizontal alignment of the button.
808
- *
809
- * @type {String}
810
885
  */
811
886
  align: 'right',
812
887
 
813
888
  /**
814
889
  * The horizontal offset of the button.
815
- *
816
- * @type {Number}
817
890
  */
818
891
  x: -10,
819
892
 
820
893
  /**
821
894
  * The vertical alignment of the button.
822
895
  *
896
+ * @type {string}
897
+ * @default top
823
898
  * @validvalue ["top", "middle", "bottom"]
824
- * @type {String}
825
- * @default top
826
- * @apioption chart.resetZoomButton.position.verticalAlign
899
+ * @apioption chart.resetZoomButton.position.verticalAlign
827
900
  */
828
901
 
829
902
  /**
830
903
  * The vertical offset of the button.
831
- *
832
- * @type {Number}
833
904
  */
834
905
  y: 10
835
906
  }
@@ -838,13 +909,15 @@ H.defaultOptions = {
838
909
  /**
839
910
  * The pixel width of the plot area border.
840
911
  *
841
- * @type {Number}
842
- * @sample {highcharts} highcharts/chart/plotborderwidth/ 1px border
912
+ * @sample {highcharts} highcharts/chart/plotborderwidth/
913
+ * 1px border
843
914
  * @sample {highstock} stock/chart/plotborder/
844
915
  * 2px border
845
916
  * @sample {highmaps} maps/chart/plotborder/
846
917
  * Plot border options
847
- * @default 0
918
+ *
919
+ * @type {number}
920
+ * @default 0
848
921
  * @apioption chart.plotBorderWidth
849
922
  */
850
923
 
@@ -853,13 +926,15 @@ H.defaultOptions = {
853
926
  * plotBackgroundColor be set. The shadow can be an object configuration
854
927
  * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`.
855
928
  *
856
- * @type {Boolean|Object}
857
- * @sample {highcharts} highcharts/chart/plotshadow/ Plot shadow
929
+ * @sample {highcharts} highcharts/chart/plotshadow/
930
+ * Plot shadow
858
931
  * @sample {highstock} stock/chart/plotshadow/
859
932
  * Plot shadow
860
933
  * @sample {highmaps} maps/chart/plotborder/
861
934
  * Plot border options
862
- * @default false
935
+ *
936
+ * @type {boolean|Highcharts.CSSObject}
937
+ * @default false
863
938
  * @apioption chart.plotShadow
864
939
  */
865
940
 
@@ -877,10 +952,10 @@ H.defaultOptions = {
877
952
  * @sample {highcharts} highcharts/parallel-coordinates/polar/
878
953
  * Star plot, multivariate data in a polar chart
879
954
  *
880
- * @type {Boolean}
881
- * @default false
882
- * @since 2.3.0
883
- * @product highcharts
955
+ * @type {boolean}
956
+ * @default false
957
+ * @since 2.3.0
958
+ * @product highcharts
884
959
  * @apioption chart.polar
885
960
  */
886
961
 
@@ -888,9 +963,10 @@ H.defaultOptions = {
888
963
  * Whether to reflow the chart to fit the width of the container div
889
964
  * on resizing the window.
890
965
  *
891
- * @type {Boolean}
892
- * @sample {highcharts} highcharts/chart/reflow-true/ True by default
893
- * @sample {highcharts} highcharts/chart/reflow-false/ False
966
+ * @sample {highcharts} highcharts/chart/reflow-true/
967
+ * True by default
968
+ * @sample {highcharts} highcharts/chart/reflow-false/
969
+ * False
894
970
  * @sample {highstock} stock/chart/reflow-true/
895
971
  * True by default
896
972
  * @sample {highstock} stock/chart/reflow-false/
@@ -899,8 +975,10 @@ H.defaultOptions = {
899
975
  * True by default
900
976
  * @sample {highmaps} maps/chart/reflow-false/
901
977
  * False
902
- * @default true
903
- * @since 2.1
978
+ *
979
+ * @type {boolean}
980
+ * @default true
981
+ * @since 2.1
904
982
  * @apioption chart.reflow
905
983
  */
906
984
 
@@ -910,7 +988,6 @@ H.defaultOptions = {
910
988
  * by direct reference, or as the first argument of the chart
911
989
  * constructor, in which case the option is not needed.
912
990
  *
913
- * @type {String|Object}
914
991
  * @sample {highcharts} highcharts/chart/reflow-true/
915
992
  * String
916
993
  * @sample {highcharts} highcharts/chart/renderto-object/
@@ -923,6 +1000,8 @@ H.defaultOptions = {
923
1000
  * Object reference
924
1001
  * @sample {highstock} stock/chart/renderto-jquery/
925
1002
  * Object reference through jQuery
1003
+ *
1004
+ * @type {string|Highcharts.SVGDOMElement}
926
1005
  * @apioption chart.renderTo
927
1006
  */
928
1007
 
@@ -930,11 +1009,12 @@ H.defaultOptions = {
930
1009
  * The background color of the marker square when selecting (zooming
931
1010
  * in on) an area of the chart.
932
1011
  *
933
- * @type {Color}
934
1012
  * @see In styled mode, the selection marker fill is set with the
935
- * `.highcharts-selection-marker` class.
936
- * @default rgba(51,92,173,0.25)
937
- * @since 2.1.7
1013
+ * `.highcharts-selection-marker` class.
1014
+ *
1015
+ * @type {Highcharts.ColorString}
1016
+ * @default rgba(51,92,173,0.25)
1017
+ * @since 2.1.7
938
1018
  * @apioption chart.selectionMarkerFill
939
1019
  */
940
1020
 
@@ -944,13 +1024,15 @@ H.defaultOptions = {
944
1024
  * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and
945
1025
  * `width`.
946
1026
  *
947
- * @type {Boolean|Object}
948
- * @sample {highcharts} highcharts/chart/shadow/ Shadow
1027
+ * @sample {highcharts} highcharts/chart/shadow/
1028
+ * Shadow
949
1029
  * @sample {highstock} stock/chart/shadow/
950
1030
  * Shadow
951
1031
  * @sample {highmaps} maps/chart/border/
952
1032
  * Chart border and shadow
953
- * @default false
1033
+ *
1034
+ * @type {boolean|Highcharts.CSSObject}
1035
+ * @default false
954
1036
  * @apioption chart.shadow
955
1037
  */
956
1038
 
@@ -959,11 +1041,14 @@ H.defaultOptions = {
959
1041
  * where series are added dynamically, as axes are automatically added
960
1042
  * to cartesian series.
961
1043
  *
962
- * @type {Boolean}
963
- * @sample {highcharts} highcharts/chart/showaxes-false/ False by default
964
- * @sample {highcharts} highcharts/chart/showaxes-true/ True
965
- * @since 1.2.5
966
- * @product highcharts
1044
+ * @sample {highcharts} highcharts/chart/showaxes-false/
1045
+ * False by default
1046
+ * @sample {highcharts} highcharts/chart/showaxes-true/
1047
+ * True
1048
+ *
1049
+ * @type {boolean}
1050
+ * @since 1.2.5
1051
+ * @product highcharts gantt
967
1052
  * @apioption chart.showAxes
968
1053
  */
969
1054
 
@@ -972,15 +1057,16 @@ H.defaultOptions = {
972
1057
  * area, axis title and labels, title, subtitle or legend in top
973
1058
  * position).
974
1059
  *
975
- * @type {Number}
976
1060
  * @sample {highcharts} highcharts/chart/spacingbottom/
977
1061
  * Spacing bottom set to 100
978
1062
  * @sample {highstock} stock/chart/spacingbottom/
979
1063
  * Spacing bottom set to 100
980
1064
  * @sample {highmaps} maps/chart/spacing/
981
1065
  * Spacing 100 all around
982
- * @default 15
983
- * @since 2.1
1066
+ *
1067
+ * @type {number}
1068
+ * @default 15
1069
+ * @since 2.1
984
1070
  * @apioption chart.spacingBottom
985
1071
  */
986
1072
 
@@ -989,15 +1075,16 @@ H.defaultOptions = {
989
1075
  * area, axis title and labels, title, subtitle or legend in top
990
1076
  * position).
991
1077
  *
992
- * @type {Number}
993
1078
  * @sample {highcharts} highcharts/chart/spacingleft/
994
1079
  * Spacing left set to 100
995
1080
  * @sample {highstock} stock/chart/spacingleft/
996
1081
  * Spacing left set to 100
997
1082
  * @sample {highmaps} maps/chart/spacing/
998
1083
  * Spacing 100 all around
999
- * @default 10
1000
- * @since 2.1
1084
+ *
1085
+ * @type {number}
1086
+ * @default 10
1087
+ * @since 2.1
1001
1088
  * @apioption chart.spacingLeft
1002
1089
  */
1003
1090
 
@@ -1006,7 +1093,6 @@ H.defaultOptions = {
1006
1093
  * area, axis title and labels, title, subtitle or legend in top
1007
1094
  * position).
1008
1095
  *
1009
- * @type {Number}
1010
1096
  * @sample {highcharts} highcharts/chart/spacingright-100/
1011
1097
  * Spacing set to 100
1012
1098
  * @sample {highcharts} highcharts/chart/spacingright-legend/
@@ -1015,8 +1101,10 @@ H.defaultOptions = {
1015
1101
  * Spacing set to 100
1016
1102
  * @sample {highmaps} maps/chart/spacing/
1017
1103
  * Spacing 100 all around
1018
- * @default 10
1019
- * @since 2.1
1104
+ *
1105
+ * @type {number}
1106
+ * @default 10
1107
+ * @since 2.1
1020
1108
  * @apioption chart.spacingRight
1021
1109
  */
1022
1110
 
@@ -1025,7 +1113,6 @@ H.defaultOptions = {
1025
1113
  * area, axis title and labels, title, subtitle or legend in top
1026
1114
  * position).
1027
1115
  *
1028
- * @type {Number}
1029
1116
  * @sample {highcharts} highcharts/chart/spacingtop-100/
1030
1117
  * A top spacing of 100
1031
1118
  * @sample {highcharts} highcharts/chart/spacingtop-10/
@@ -1035,8 +1122,10 @@ H.defaultOptions = {
1035
1122
  * A top spacing of 100
1036
1123
  * @sample {highmaps} maps/chart/spacing/
1037
1124
  * Spacing 100 all around
1038
- * @default 10
1039
- * @since 2.1
1125
+ *
1126
+ * @type {number}
1127
+ * @default 10
1128
+ * @since 2.1
1040
1129
  * @apioption chart.spacingTop
1041
1130
  */
1042
1131
 
@@ -1045,7 +1134,6 @@ H.defaultOptions = {
1045
1134
  * that since the default font styles are applied in the renderer, it
1046
1135
  * is ignorant of the individual chart options and must be set globally.
1047
1136
  *
1048
- * @type {CSSObject}
1049
1137
  * @see In styled mode, general chart styles can be set with the
1050
1138
  * `.highcharts-root` class.
1051
1139
  * @sample {highcharts} highcharts/chart/style-serif-font/
@@ -1056,7 +1144,9 @@ H.defaultOptions = {
1056
1144
  * Using a serif type font
1057
1145
  * @sample {highmaps} maps/chart/style-serif-font/
1058
1146
  * Using a serif type font
1059
- * @default {"fontFamily":"\"Lucida Grande\", \"Lucida Sans Unicode\", Verdana, Arial, Helvetica, sans-serif","fontSize":"12px"}
1147
+ *
1148
+ * @type {Highcharts.CSSObject}
1149
+ * @default {"fontFamily": "\"Lucida Grande\", \"Lucida Sans Unicode\", Verdana, Arial, Helvetica, sans-serif","fontSize":"12px"}
1060
1150
  * @apioption chart.style
1061
1151
  */
1062
1152
 
@@ -1064,49 +1154,67 @@ H.defaultOptions = {
1064
1154
  * The default series type for the chart. Can be any of the chart types
1065
1155
  * listed under [plotOptions](#plotOptions).
1066
1156
  *
1067
- * @validvalue ["line", "spline", "column", "bar", "area", "areaspline", "pie", "arearange", "areasplinerange", "boxplot", "bubble", "columnrange", "errorbar", "funnel", "gauge", "heatmap", "polygon", "pyramid", "scatter", "solidgauge", "treemap", "waterfall"]
1068
- * @type {String}
1069
- * @sample {highcharts} highcharts/chart/type-bar/ Bar
1157
+ * @sample {highcharts} highcharts/chart/type-bar/
1158
+ * Bar
1070
1159
  * @sample {highstock} stock/chart/type/
1071
1160
  * Areaspline
1072
1161
  * @sample {highmaps} maps/chart/type-mapline/
1073
1162
  * Mapline
1074
- * @default {highcharts} line
1075
- * @default {highstock} line
1076
- * @default {highmaps} map
1077
- * @since 2.1.0
1078
- * @apioption chart.type
1163
+ *
1164
+ * @type {string}
1165
+ * @default {highcharts} line
1166
+ * @default {highstock} line
1167
+ * @default {highmaps} map
1168
+ * @since 2.1.0
1169
+ * @validvalue ["line", "spline", "column", "bar", "area", "areaspline",
1170
+ * "pie", "arearange", "areasplinerange", "boxplot",
1171
+ * "bubble", "columnrange", "errorbar", "funnel", "gauge",
1172
+ * "heatmap", "polygon", "pyramid", "scatter", "solidgauge",
1173
+ * "treemap", "waterfall"]
1174
+ * @apioption chart.type
1079
1175
  */
1080
1176
 
1081
1177
  /**
1082
1178
  * Decides in what dimensions the user can zoom by dragging the mouse.
1083
1179
  * Can be one of `x`, `y` or `xy`.
1084
1180
  *
1085
- * @validvalue [null, "x", "y", "xy"]
1086
- * @type {String}
1087
1181
  * @see [panKey](#chart.panKey)
1088
- * @default null
1089
- * @sample {highcharts} highcharts/chart/zoomtype-none/ None by default
1090
- * @sample {highcharts} highcharts/chart/zoomtype-x/ X
1091
- * @sample {highcharts} highcharts/chart/zoomtype-y/ Y
1092
- * @sample {highcharts} highcharts/chart/zoomtype-xy/ Xy
1093
- * @sample {highstock} stock/demo/basic-line/ None by default
1094
- * @sample {highstock} stock/chart/zoomtype-x/ X
1095
- * @sample {highstock} stock/chart/zoomtype-y/ Y
1096
- * @sample {highstock} stock/chart/zoomtype-xy/ Xy
1097
- * @product highcharts highstock
1098
- * @apioption chart.zoomType
1182
+ *
1183
+ * @sample {highcharts} highcharts/chart/zoomtype-none/
1184
+ * None by default
1185
+ * @sample {highcharts} highcharts/chart/zoomtype-x/
1186
+ * X
1187
+ * @sample {highcharts} highcharts/chart/zoomtype-y/
1188
+ * Y
1189
+ * @sample {highcharts} highcharts/chart/zoomtype-xy/
1190
+ * Xy
1191
+ * @sample {highstock} stock/demo/basic-line/
1192
+ * None by default
1193
+ * @sample {highstock} stock/chart/zoomtype-x/
1194
+ * X
1195
+ * @sample {highstock} stock/chart/zoomtype-y/
1196
+ * Y
1197
+ * @sample {highstock} stock/chart/zoomtype-xy/
1198
+ * Xy
1199
+ *
1200
+ * @type {string}
1201
+ * @product highcharts highstock gantt
1202
+ * @validvalue ["x", "y", "xy"]
1203
+ * @apioption chart.zoomType
1099
1204
  */
1100
1205
 
1101
1206
  /**
1102
1207
  * An explicit width for the chart. By default (when `null`) the width
1103
1208
  * is calculated from the offset width of the containing element.
1104
1209
  *
1105
- * @type {Number}
1106
- * @sample {highcharts} highcharts/chart/width/ 800px wide
1107
- * @sample {highstock} stock/chart/width/ 800px wide
1108
- * @sample {highmaps} maps/chart/size/ Chart with explicit size
1109
- * @default null
1210
+ * @sample {highcharts} highcharts/chart/width/
1211
+ * 800px wide
1212
+ * @sample {highstock} stock/chart/width/
1213
+ * 800px wide
1214
+ * @sample {highmaps} maps/chart/size/
1215
+ * Chart with explicit size
1216
+ *
1217
+ * @type {number|null}
1110
1218
  */
1111
1219
  width: null,
1112
1220
 
@@ -1121,7 +1229,6 @@ H.defaultOptions = {
1121
1229
  * height of the containing element, or 400 pixels if the containing
1122
1230
  * element's height is 0.
1123
1231
  *
1124
- * @type {Number|String}
1125
1232
  * @sample {highcharts} highcharts/chart/height/
1126
1233
  * 500px height
1127
1234
  * @sample {highstock} stock/chart/height/
@@ -1130,7 +1237,8 @@ H.defaultOptions = {
1130
1237
  * Chart with explicit size
1131
1238
  * @sample highcharts/chart/height-percent/
1132
1239
  * Highcharts with percentage height
1133
- * @default null
1240
+ *
1241
+ * @type {number|string|null}
1134
1242
  */
1135
1243
  height: null
1136
1244
 
@@ -1141,7 +1249,8 @@ H.defaultOptions = {
1141
1249
  /**
1142
1250
  * The chart's main title.
1143
1251
  *
1144
- * @sample {highmaps} maps/title/title/ Title options demonstrated
1252
+ * @sample {highmaps} maps/title/title/
1253
+ * Title options demonstrated
1145
1254
  */
1146
1255
  title: {
1147
1256
 
@@ -1149,14 +1258,16 @@ H.defaultOptions = {
1149
1258
  * When the title is floating, the plot area will not move to make space
1150
1259
  * for it.
1151
1260
  *
1152
- * @type {Boolean}
1153
- * @sample {highcharts} highcharts/chart/zoomtype-none/ False by default
1261
+ * @sample {highcharts} highcharts/chart/zoomtype-none/
1262
+ * False by default
1154
1263
  * @sample {highcharts} highcharts/title/floating/
1155
1264
  * True - title on top of the plot area
1156
1265
  * @sample {highstock} stock/chart/title-floating/
1157
1266
  * True - title on top of the plot area
1158
- * @default false
1159
- * @since 2.1
1267
+ *
1268
+ * @type {boolean}
1269
+ * @default false
1270
+ * @since 2.1
1160
1271
  * @apioption title.floating
1161
1272
  */
1162
1273
 
@@ -1167,21 +1278,26 @@ H.defaultOptions = {
1167
1278
  * In styled mode, the title style is given in the `.highcharts-title`
1168
1279
  * class.
1169
1280
  *
1170
- * @type {CSSObject}
1171
- * @sample {highcharts} highcharts/title/style/ Custom color and weight
1172
- * @sample {highstock} stock/chart/title-style/ Custom color and weight
1173
- * @sample highcharts/css/titles/ Styled mode
1174
- * @default {highcharts|highmaps} { "color": "#333333", "fontSize": "18px" }
1175
- * @default {highstock} { "color": "#333333", "fontSize": "16px" }
1281
+ * @sample {highcharts} highcharts/title/style/
1282
+ * Custom color and weight
1283
+ * @sample {highstock} stock/chart/title-style/
1284
+ * Custom color and weight
1285
+ * @sample highcharts/css/titles/
1286
+ * Styled mode
1287
+ *
1288
+ * @type {Highcharts.CSSObject}
1289
+ * @default {highcharts|highmaps} { "color": "#333333", "fontSize": "18px" }
1290
+ * @default {highstock} { "color": "#333333", "fontSize": "16px" }
1176
1291
  * @apioption title.style
1177
1292
  */
1178
1293
 
1179
1294
  /**
1180
- * Whether to [use HTML](http://www.highcharts.com/docs/chart-concepts/labels-
1181
- * and-string-formatting#html) to render the text.
1295
+ * Whether to
1296
+ * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
1297
+ * to render the text.
1182
1298
  *
1183
- * @type {Boolean}
1184
- * @default false
1299
+ * @type {boolean}
1300
+ * @default false
1185
1301
  * @apioption title.useHTML
1186
1302
  */
1187
1303
 
@@ -1190,29 +1306,31 @@ H.defaultOptions = {
1190
1306
  * `"middle"` and `"bottom"`. When a value is given, the title behaves
1191
1307
  * as if [floating](#title.floating) were `true`.
1192
1308
  *
1193
- * @validvalue ["top", "middle", "bottom"]
1194
- * @type {String}
1195
1309
  * @sample {highcharts} highcharts/title/verticalalign/
1196
1310
  * Chart title in bottom right corner
1197
1311
  * @sample {highstock} stock/chart/title-verticalalign/
1198
1312
  * Chart title in bottom right corner
1199
- * @since 2.1
1200
- * @apioption title.verticalAlign
1313
+ *
1314
+ * @type {string}
1315
+ * @since 2.1
1316
+ * @validvalue ["top", "middle", "bottom"]
1317
+ * @apioption title.verticalAlign
1201
1318
  */
1202
1319
 
1203
1320
  /**
1204
1321
  * The x position of the title relative to the alignment within
1205
1322
  * `chart.spacingLeft` and `chart.spacingRight`.
1206
1323
  *
1207
- * @type {Number}
1208
1324
  * @sample {highcharts} highcharts/title/align/
1209
1325
  * Aligned to the plot area (x = 70px = margin left - spacing
1210
1326
  * left)
1211
1327
  * @sample {highstock} stock/chart/title-align/
1212
1328
  * Aligned to the plot area (x = 50px = margin left - spacing
1213
1329
  * left)
1214
- * @default 0
1215
- * @since 2.0
1330
+ *
1331
+ * @type {number}
1332
+ * @default 0
1333
+ * @since 2.0
1216
1334
  * @apioption title.x
1217
1335
  */
1218
1336
 
@@ -1221,24 +1339,27 @@ H.defaultOptions = {
1221
1339
  * [chart.spacingTop](#chart.spacingTop) and [chart.spacingBottom](
1222
1340
  * #chart.spacingBottom). By default it depends on the font size.
1223
1341
  *
1224
- * @type {Number}
1225
1342
  * @sample {highcharts} highcharts/title/y/
1226
1343
  * Title inside the plot area
1227
1344
  * @sample {highstock} stock/chart/title-verticalalign/
1228
1345
  * Chart title in bottom right corner
1229
- * @since 2.0
1346
+ *
1347
+ * @type {number}
1348
+ * @since 2.0
1230
1349
  * @apioption title.y
1231
1350
  */
1232
1351
 
1233
1352
  /**
1234
1353
  * The title of the chart. To disable the title, set the `text` to
1235
- * `null`.
1354
+ * `undefined`.
1355
+ *
1356
+ * @sample {highcharts} highcharts/title/text/
1357
+ * Custom title
1358
+ * @sample {highstock} stock/chart/title-text/
1359
+ * Custom title
1236
1360
  *
1237
- * @type {String}
1238
- * @sample {highcharts} highcharts/title/text/ Custom title
1239
- * @sample {highstock} stock/chart/title-text/ Custom title
1240
1361
  * @default {highcharts|highmaps} Chart title
1241
- * @default {highstock} null
1362
+ * @default {highstock} undefined
1242
1363
  */
1243
1364
  text: 'Chart title',
1244
1365
 
@@ -1246,16 +1367,15 @@ H.defaultOptions = {
1246
1367
  * The horizontal alignment of the title. Can be one of "left", "center"
1247
1368
  * and "right".
1248
1369
  *
1249
- * @validvalue ["left", "center", "right"]
1250
- * @type {String}
1251
1370
  * @sample {highcharts} highcharts/title/align/
1252
1371
  * Aligned to the plot area (x = 70px = margin left - spacing
1253
1372
  * left)
1254
1373
  * @sample {highstock} stock/chart/title-align/
1255
1374
  * Aligned to the plot area (x = 50px = margin left - spacing
1256
1375
  * left)
1257
- * @default center
1258
- * @since 2.0
1376
+ *
1377
+ * @since 2.0
1378
+ * @validvalue ["left", "center", "right"]
1259
1379
  */
1260
1380
  align: 'center',
1261
1381
 
@@ -1263,14 +1383,13 @@ H.defaultOptions = {
1263
1383
  * The margin between the title and the plot area, or if a subtitle
1264
1384
  * is present, the margin between the subtitle and the plot area.
1265
1385
  *
1266
- * @type {Number}
1267
1386
  * @sample {highcharts} highcharts/title/margin-50/
1268
1387
  * A chart title margin of 50
1269
1388
  * @sample {highcharts} highcharts/title/margin-subtitle/
1270
1389
  * The same margin applied with a subtitle
1271
1390
  * @sample {highstock} stock/chart/title-margin/
1272
1391
  * A chart title margin of 50
1273
- * @default 15
1392
+ *
1274
1393
  * @since 2.1
1275
1394
  */
1276
1395
  margin: 15,
@@ -1279,10 +1398,9 @@ H.defaultOptions = {
1279
1398
  * Adjustment made to the title width, normally to reserve space for
1280
1399
  * the exporting burger menu.
1281
1400
  *
1282
- * @type {Number}
1283
1401
  * @sample highcharts/title/widthadjust/
1284
1402
  * Wider menu, greater padding
1285
- * @default -44
1403
+ *
1286
1404
  * @since 4.2.5
1287
1405
  */
1288
1406
  widthAdjust: -44
@@ -1295,7 +1413,8 @@ H.defaultOptions = {
1295
1413
  * subtitle can be updated after chart initialization through the
1296
1414
  * `Chart.setTitle` method.
1297
1415
  *
1298
- * @sample {highmaps} maps/title/subtitle/ Subtitle options demonstrated
1416
+ * @sample {highmaps} maps/title/subtitle/
1417
+ * Subtitle options demonstrated
1299
1418
  */
1300
1419
  subtitle: {
1301
1420
 
@@ -1303,13 +1422,14 @@ H.defaultOptions = {
1303
1422
  * When the subtitle is floating, the plot area will not move to make
1304
1423
  * space for it.
1305
1424
  *
1306
- * @type {Boolean}
1307
1425
  * @sample {highcharts} highcharts/subtitle/floating/
1308
1426
  * Floating title and subtitle
1309
1427
  * @sample {highstock} stock/chart/subtitle-footnote
1310
1428
  * Footnote floating at bottom right of plot area
1311
- * @default false
1312
- * @since 2.1
1429
+ *
1430
+ * @type {boolean}
1431
+ * @default false
1432
+ * @since 2.1
1313
1433
  * @apioption subtitle.floating
1314
1434
  */
1315
1435
 
@@ -1319,7 +1439,6 @@ H.defaultOptions = {
1319
1439
  * In styled mode, the subtitle style is given in the
1320
1440
  * `.highcharts-subtitle` class.
1321
1441
  *
1322
- * @type {CSSObject}
1323
1442
  * @sample {highcharts} highcharts/subtitle/style/
1324
1443
  * Custom color and weight
1325
1444
  * @sample {highcharts} highcharts/css/titles/
@@ -1330,16 +1449,19 @@ H.defaultOptions = {
1330
1449
  * Styled mode
1331
1450
  * @sample {highmaps} highcharts/css/titles/
1332
1451
  * Styled mode
1333
- * @default { "color": "#666666" }
1452
+ *
1453
+ * @type {Highcharts.CSSObject}
1454
+ * @default {"color": "#666666"}
1334
1455
  * @apioption subtitle.style
1335
1456
  */
1336
1457
 
1337
1458
  /**
1338
- * Whether to [use HTML](http://www.highcharts.com/docs/chart-concepts/labels-
1339
- * and-string-formatting#html) to render the text.
1459
+ * Whether to
1460
+ * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
1461
+ * to render the text.
1340
1462
  *
1341
- * @type {Boolean}
1342
- * @default false
1463
+ * @type {boolean}
1464
+ * @default false
1343
1465
  * @apioption subtitle.useHTML
1344
1466
  */
1345
1467
 
@@ -1347,28 +1469,29 @@ H.defaultOptions = {
1347
1469
  * The vertical alignment of the title. Can be one of "top", "middle"
1348
1470
  * and "bottom". When a value is given, the title behaves as floating.
1349
1471
  *
1350
- * @validvalue ["top", "middle", "bottom"]
1351
- * @type {String}
1352
1472
  * @sample {highcharts} highcharts/subtitle/verticalalign/
1353
1473
  * Footnote at the bottom right of plot area
1354
1474
  * @sample {highstock} stock/chart/subtitle-footnote
1355
1475
  * Footnote at the bottom right of plot area
1356
- * @default
1357
- * @since 2.1
1358
- * @apioption subtitle.verticalAlign
1476
+ *
1477
+ * @type {string}
1478
+ * @since 2.1
1479
+ * @validvalue ["top", "middle", "bottom"]
1480
+ * @apioption subtitle.verticalAlign
1359
1481
  */
1360
1482
 
1361
1483
  /**
1362
1484
  * The x position of the subtitle relative to the alignment within
1363
1485
  * `chart.spacingLeft` and `chart.spacingRight`.
1364
1486
  *
1365
- * @type {Number}
1366
1487
  * @sample {highcharts} highcharts/subtitle/align/
1367
1488
  * Footnote at right of plot area
1368
1489
  * @sample {highstock} stock/chart/subtitle-footnote
1369
1490
  * Footnote at the bottom right of plot area
1370
- * @default 0
1371
- * @since 2.0
1491
+ *
1492
+ * @type {number}
1493
+ * @default 0
1494
+ * @since 2.0
1372
1495
  * @apioption subtitle.x
1373
1496
  */
1374
1497
 
@@ -1377,22 +1500,19 @@ H.defaultOptions = {
1377
1500
  * `chart.spacingTop` and `chart.spacingBottom`. By default the subtitle
1378
1501
  * is laid out below the title unless the title is floating.
1379
1502
  *
1380
- * @type {Number}
1381
1503
  * @sample {highcharts} highcharts/subtitle/verticalalign/
1382
1504
  * Footnote at the bottom right of plot area
1383
1505
  * @sample {highstock} stock/chart/subtitle-footnote
1384
1506
  * Footnote at the bottom right of plot area
1385
- * @default {highcharts} null
1386
- * @default {highstock} null
1387
- * @default {highmaps}
1388
- * @since 2.0
1507
+ *
1508
+ * @type {number}
1509
+ * @since 2.0
1389
1510
  * @apioption subtitle.y
1390
1511
  */
1391
1512
 
1392
1513
  /**
1393
1514
  * The subtitle of the chart.
1394
1515
  *
1395
- * @type {String}
1396
1516
  * @sample {highcharts|highstock} highcharts/subtitle/text/
1397
1517
  * Custom subtitle
1398
1518
  * @sample {highcharts|highstock} highcharts/subtitle/text-formatted/
@@ -1404,14 +1524,13 @@ H.defaultOptions = {
1404
1524
  * The horizontal alignment of the subtitle. Can be one of "left",
1405
1525
  * "center" and "right".
1406
1526
  *
1407
- * @validvalue ["left", "center", "right"]
1408
- * @type {String}
1409
1527
  * @sample {highcharts} highcharts/subtitle/align/
1410
1528
  * Footnote at right of plot area
1411
1529
  * @sample {highstock} stock/chart/subtitle-footnote
1412
1530
  * Footnote at bottom right of plot area
1413
- * @default center
1414
- * @since 2.0
1531
+ *
1532
+ * @since 2.0
1533
+ * @validvalue ["left", "center", "right"]
1415
1534
  */
1416
1535
  align: 'center',
1417
1536
 
@@ -1419,11 +1538,11 @@ H.defaultOptions = {
1419
1538
  * Adjustment made to the subtitle width, normally to reserve space
1420
1539
  * for the exporting burger menu.
1421
1540
  *
1422
- * @type {Number}
1423
1541
  * @see [title.widthAdjust](#title.widthAdjust)
1542
+ *
1424
1543
  * @sample highcharts/title/widthadjust/
1425
1544
  * Wider menu, greater padding
1426
- * @default -44
1545
+ *
1427
1546
  * @since 4.2.5
1428
1547
  */
1429
1548
  widthAdjust: -44
@@ -1440,27 +1559,25 @@ H.defaultOptions = {
1440
1559
  * type are given in the plotOptions of that type, for example
1441
1560
  * `plotOptions.line`. Next, options for one single series are given in
1442
1561
  * [the series array](#series).
1443
- *
1444
1562
  */
1445
1563
  plotOptions: {},
1446
1564
 
1447
1565
  /**
1448
1566
  * HTML labels that can be positioned anywhere in the chart area.
1449
- *
1450
1567
  */
1451
1568
  labels: {
1452
1569
 
1453
1570
  /**
1454
- * A HTML label that can be positioned anywhere in the chart area.
1571
+ * An HTML label that can be positioned anywhere in the chart area.
1455
1572
  *
1456
- * @type {Array<Object>}
1573
+ * @type {Array<*>}
1457
1574
  * @apioption labels.items
1458
1575
  */
1459
1576
 
1460
1577
  /**
1461
1578
  * Inner HTML or text for the label.
1462
1579
  *
1463
- * @type {String}
1580
+ * @type {string}
1464
1581
  * @apioption labels.items.html
1465
1582
  */
1466
1583
 
@@ -1473,18 +1590,24 @@ H.defaultOptions = {
1473
1590
  * top: '100px'
1474
1591
  * }</pre>
1475
1592
  *
1476
- * @type {CSSObject}
1593
+ * @type {Highcharts.CSSObject}
1477
1594
  * @apioption labels.items.style
1478
1595
  */
1479
1596
 
1480
1597
  /**
1481
1598
  * Shared CSS styles for all labels.
1482
1599
  *
1483
- * @type {CSSObject}
1484
- * @default { "color": "#333333" }
1600
+ * @type {Highcharts.CSSObject}
1601
+ * @default {"color": "#333333", "position": "absolute"}
1485
1602
  */
1486
1603
  style: {
1604
+ /**
1605
+ * @ignore
1606
+ */
1487
1607
  position: 'absolute',
1608
+ /**
1609
+ * @ignore
1610
+ */
1488
1611
  color: '#333333'
1489
1612
  }
1490
1613
  },
@@ -1494,9 +1617,8 @@ H.defaultOptions = {
1494
1617
  * item or point item in the chart. Each series (or points in case
1495
1618
  * of pie charts) is represented by a symbol and its name in the legend.
1496
1619
  *
1497
- * It is possible to override the symbol creator function and
1498
- * create [custom legend symbols](http://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/studies/legend-
1499
- * custom-symbol/).
1620
+ * It is possible to override the symbol creator function and create
1621
+ * [custom legend symbols](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/studies/legend-custom-symbol/).
1500
1622
  *
1501
1623
  * @productdesc {highmaps}
1502
1624
  * A Highmaps legend by default contains one legend item per series, but if
@@ -1508,40 +1630,52 @@ H.defaultOptions = {
1508
1630
  /**
1509
1631
  * The background color of the legend.
1510
1632
  *
1511
- * @type {Color}
1512
1633
  * @see In styled mode, the legend background fill can be applied with
1513
- * the `.highcharts-legend-box` class.
1634
+ * the `.highcharts-legend-box` class.
1635
+ *
1514
1636
  * @sample {highcharts} highcharts/legend/backgroundcolor/
1515
1637
  * Yellowish background
1516
- * @sample {highstock} stock/legend/align/ Various legend options
1638
+ * @sample {highstock} stock/legend/align/
1639
+ * Various legend options
1517
1640
  * @sample {highmaps} maps/legend/border-background/
1518
1641
  * Border and background options
1642
+ *
1643
+ * @type {Highcharts.ColorString}
1519
1644
  * @apioption legend.backgroundColor
1520
1645
  */
1521
1646
 
1522
1647
  /**
1523
1648
  * The width of the drawn border around the legend.
1524
1649
  *
1525
- * @type {Number}
1526
1650
  * @see In styled mode, the legend border stroke width can be applied
1527
- * with the `.highcharts-legend-box` class.
1528
- * @sample {highcharts} highcharts/legend/borderwidth/ 2px border width
1529
- * @sample {highstock} stock/legend/align/ Various legend options
1651
+ * with the `.highcharts-legend-box` class.
1652
+ *
1653
+ * @sample {highcharts} highcharts/legend/borderwidth/
1654
+ * 2px border width
1655
+ * @sample {highstock} stock/legend/align/
1656
+ * Various legend options
1530
1657
  * @sample {highmaps} maps/legend/border-background/
1531
1658
  * Border and background options
1532
- * @default 0
1659
+ *
1660
+ * @type {number}
1661
+ * @default 0
1533
1662
  * @apioption legend.borderWidth
1534
1663
  */
1535
1664
 
1536
1665
  /**
1537
- * Enable or disable the legend.
1666
+ * Enable or disable the legend. There is also a series-specific option,
1667
+ * [showInLegend](#plotOptions.series.showInLegend), that can hide the
1668
+ * series from the legend. In some series types this is `false` by
1669
+ * default, so it must set to `true` in order to show the legend for the
1670
+ * series.
1538
1671
  *
1539
- * @type {Boolean}
1540
1672
  * @sample {highcharts} highcharts/legend/enabled-false/ Legend disabled
1541
1673
  * @sample {highstock} stock/legend/align/ Various legend options
1542
1674
  * @sample {highmaps} maps/legend/enabled-false/ Legend disabled
1675
+ *
1543
1676
  * @default {highstock} false
1544
1677
  * @default {highmaps} true
1678
+ * @default {gantt} false
1545
1679
  */
1546
1680
  enabled: true,
1547
1681
 
@@ -1553,15 +1687,15 @@ H.defaultOptions = {
1553
1687
  * `layout` option will determine whether to place it above/below
1554
1688
  * or on the side of the plot area.
1555
1689
  *
1556
- * @validvalue ["left", "center", "right"]
1557
- * @type {String}
1558
1690
  * @sample {highcharts} highcharts/legend/align/
1559
1691
  * Legend at the right of the chart
1560
1692
  * @sample {highstock} stock/legend/align/
1561
1693
  * Various legend options
1562
1694
  * @sample {highmaps} maps/legend/alignment/
1563
1695
  * Legend alignment
1564
- * @since 2.0
1696
+ *
1697
+ * @since 2.0
1698
+ * @validvalue ["left", "center", "right"]
1565
1699
  */
1566
1700
  align: 'center',
1567
1701
 
@@ -1579,12 +1713,16 @@ H.defaultOptions = {
1579
1713
  * When the legend is floating, the plot area ignores it and is allowed
1580
1714
  * to be placed below it.
1581
1715
  *
1582
- * @type {Boolean}
1583
- * @sample {highcharts} highcharts/legend/floating-false/ False by default
1584
- * @sample {highcharts} highcharts/legend/floating-true/ True
1585
- * @sample {highmaps} maps/legend/alignment/ Floating legend
1586
- * @default false
1587
- * @since 2.1
1716
+ * @sample {highcharts} highcharts/legend/floating-false/
1717
+ * False by default
1718
+ * @sample {highcharts} highcharts/legend/floating-true/
1719
+ * True
1720
+ * @sample {highmaps} maps/legend/alignment/
1721
+ * Floating legend
1722
+ *
1723
+ * @type {boolean}
1724
+ * @default false
1725
+ * @since 2.1
1588
1726
  * @apioption legend.floating
1589
1727
  */
1590
1728
 
@@ -1595,8 +1733,6 @@ H.defaultOptions = {
1595
1733
  * except in inverted charts or when the legend position doesn't allow
1596
1734
  * it.
1597
1735
  *
1598
- * @validvalue ["horizontal", "vertical", "proximate"]
1599
- * @type {String}
1600
1736
  * @sample {highcharts} highcharts/legend/layout-horizontal/
1601
1737
  * Horizontal by default
1602
1738
  * @sample {highcharts} highcharts/legend/layout-vertical/
@@ -1609,7 +1745,8 @@ H.defaultOptions = {
1609
1745
  * Vertical with data classes
1610
1746
  * @sample {highmaps} maps/legend/layout-vertical/
1611
1747
  * Vertical with color axis gradient
1612
- * @default horizontal
1748
+ *
1749
+ * @validvalue ["horizontal", "vertical", "proximate"]
1613
1750
  */
1614
1751
  layout: 'horizontal',
1615
1752
 
@@ -1617,39 +1754,44 @@ H.defaultOptions = {
1617
1754
  * In a legend with horizontal layout, the itemDistance defines the
1618
1755
  * pixel distance between each item.
1619
1756
  *
1620
- * @type {Number}
1621
- * @sample {highcharts} highcharts/legend/layout-horizontal/ 50px item distance
1622
- * @sample {highstock} highcharts/legend/layout-horizontal/ 50px item distance
1623
- * @default {highcharts} 20
1624
- * @default {highstock} 20
1625
- * @default {highmaps} 8
1626
- * @since 3.0.3
1757
+ * @sample {highcharts} highcharts/legend/layout-horizontal/
1758
+ * 50px item distance
1759
+ * @sample {highstock} highcharts/legend/layout-horizontal/
1760
+ * 50px item distance
1761
+ *
1762
+ * @type {number}
1763
+ * @default {highcharts} 20
1764
+ * @default {highstock} 20
1765
+ * @default {highmaps} 8
1766
+ * @since 3.0.3
1627
1767
  * @apioption legend.itemDistance
1628
1768
  */
1629
1769
 
1630
1770
  /**
1631
1771
  * The pixel bottom margin for each legend item.
1632
1772
  *
1633
- * @type {Number}
1634
1773
  * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
1635
1774
  * Padding and item margins demonstrated
1636
1775
  * @sample {highmaps} maps/legend/padding-itemmargin/
1637
1776
  * Padding and item margins demonstrated
1638
- * @default 0
1639
- * @since 2.2.0
1777
+ *
1778
+ * @type {number}
1779
+ * @default 0
1780
+ * @since 2.2.0
1640
1781
  * @apioption legend.itemMarginBottom
1641
1782
  */
1642
1783
 
1643
1784
  /**
1644
1785
  * The pixel top margin for each legend item.
1645
1786
  *
1646
- * @type {Number}
1647
1787
  * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
1648
1788
  * Padding and item margins demonstrated
1649
1789
  * @sample {highmaps} maps/legend/padding-itemmargin/
1650
1790
  * Padding and item margins demonstrated
1651
- * @default 0
1652
- * @since 2.2.0
1791
+ *
1792
+ * @type {number}
1793
+ * @default 0
1794
+ * @since 2.2.0
1653
1795
  * @apioption legend.itemMarginTop
1654
1796
  */
1655
1797
 
@@ -1659,25 +1801,25 @@ H.defaultOptions = {
1659
1801
  * are laid out across two rows or more, they will be vertically aligned
1660
1802
  * depending on the [legend.alignColumns](legend.alignColumns) option.
1661
1803
  *
1662
- * @type {Number}
1663
1804
  * @sample {highcharts} highcharts/legend/itemwidth-default/
1664
- * Null by default
1805
+ * Undefined by default
1665
1806
  * @sample {highcharts} highcharts/legend/itemwidth-80/
1666
1807
  * 80 for aligned legend items
1667
- * @default null
1668
- * @since 2.0
1808
+ *
1809
+ * @type {number}
1810
+ * @since 2.0
1669
1811
  * @apioption legend.itemWidth
1670
1812
  */
1671
1813
 
1672
1814
  /**
1673
- * A [format string](
1674
- * https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
1675
- * for each legend label. Available variables relates to properties on
1676
- * the series, or the point in case of pies.
1815
+ * A [format string](https://www.highcharts.com/docs/chart-concepts/
1816
+ * labels-and-string-formatting) for each legend label. Available
1817
+ * variables relates to properties on the series, or the point in case
1818
+ * of pies.
1677
1819
  *
1678
- * @type {String}
1679
- * @default {name}
1680
- * @since 1.3
1820
+ * @type {string}
1821
+ * @default {name}
1822
+ * @since 1.3
1681
1823
  * @apioption legend.labelFormat
1682
1824
  */
1683
1825
 
@@ -1687,14 +1829,15 @@ H.defaultOptions = {
1687
1829
  * of pie charts. By default the series or point name is printed.
1688
1830
  *
1689
1831
  * @productdesc {highmaps}
1690
- * In Highmaps the context can also be a data class in case
1691
- * of a `colorAxis`.
1832
+ * In Highmaps the context can also be a data class in case of a
1833
+ * `colorAxis`.
1834
+ *
1835
+ * @sample {highcharts} highcharts/legend/labelformatter/
1836
+ * Add text
1837
+ * @sample {highmaps} maps/legend/labelformatter/
1838
+ * Data classes with label formatter
1692
1839
  *
1693
- * @type {Function}
1694
- * @sample {highcharts} highcharts/legend/labelformatter/ Add text
1695
- * @sample {highmaps} maps/legend/labelformatter/
1696
- * Data classes with label formatter
1697
- * @context {Series|Point}
1840
+ * @context {Highcharts.Series|Highcharts.Point}
1698
1841
  */
1699
1842
  labelFormatter: function () {
1700
1843
  return this.name;
@@ -1706,11 +1849,15 @@ H.defaultOptions = {
1706
1849
  * and the padding between items using `itemMarginTop` and
1707
1850
  * `itemMarginBottom`.
1708
1851
  *
1709
- * @type {Number}
1710
- * @sample {highcharts} highcharts/legend/lineheight/ Setting padding
1711
- * @default 16
1712
- * @since 2.0
1713
- * @product highcharts
1852
+ * @sample {highcharts} highcharts/legend/lineheight/
1853
+ * Setting padding
1854
+ *
1855
+ * @deprecated
1856
+ *
1857
+ * @type {number}
1858
+ * @default 16
1859
+ * @since 2.0
1860
+ * @product highcharts gantt
1714
1861
  * @apioption legend.lineHeight
1715
1862
  */
1716
1863
 
@@ -1719,12 +1866,14 @@ H.defaultOptions = {
1719
1866
  * is not floating, the legend margin is the space between the legend
1720
1867
  * and the axis labels or plot area.
1721
1868
  *
1722
- * @type {Number}
1723
1869
  * @sample {highcharts} highcharts/legend/margin-default/
1724
1870
  * 12 pixels by default
1725
- * @sample {highcharts} highcharts/legend/margin-30/ 30 pixels
1726
- * @default 12
1727
- * @since 2.1
1871
+ * @sample {highcharts} highcharts/legend/margin-30/
1872
+ * 30 pixels
1873
+ *
1874
+ * @type {number}
1875
+ * @default 12
1876
+ * @since 2.1
1728
1877
  * @apioption legend.margin
1729
1878
  */
1730
1879
 
@@ -1732,45 +1881,46 @@ H.defaultOptions = {
1732
1881
  * Maximum pixel height for the legend. When the maximum height is
1733
1882
  * extended, navigation will show.
1734
1883
  *
1735
- * @type {Number}
1736
- * @default undefined
1737
- * @since 2.3.0
1884
+ * @type {number}
1885
+ * @since 2.3.0
1738
1886
  * @apioption legend.maxHeight
1739
1887
  */
1740
1888
 
1741
1889
  /**
1742
1890
  * The color of the drawn border around the legend.
1743
1891
  *
1744
- * @type {Color}
1745
- * @see In styled mode, the legend border stroke can be applied with
1746
- * the `.highcharts-legend-box` class.
1747
- * @sample {highcharts} highcharts/legend/bordercolor/ Brown border
1748
- * @sample {highstock} stock/legend/align/ Various legend options
1892
+ * @see In styled mode, the legend border stroke can be applied with the
1893
+ * `.highcharts-legend-box` class.
1894
+ *
1895
+ * @sample {highcharts} highcharts/legend/bordercolor/
1896
+ * Brown border
1897
+ * @sample {highstock} stock/legend/align/
1898
+ * Various legend options
1749
1899
  * @sample {highmaps} maps/legend/border-background/
1750
1900
  * Border and background options
1751
- * @default #999999
1901
+ *
1902
+ * @type {Highcharts.ColorString}
1752
1903
  */
1753
1904
  borderColor: '#999999',
1754
1905
 
1755
1906
  /**
1756
1907
  * The border corner radius of the legend.
1757
1908
  *
1758
- * @type {Number}
1759
- * @sample {highcharts} highcharts/legend/borderradius-default/ Square by default
1760
- * @sample {highcharts} highcharts/legend/borderradius-round/ 5px rounded
1909
+ * @sample {highcharts} highcharts/legend/borderradius-default/
1910
+ * Square by default
1911
+ * @sample {highcharts} highcharts/legend/borderradius-round/
1912
+ * 5px rounded
1761
1913
  * @sample {highmaps} maps/legend/border-background/
1762
1914
  * Border and background options
1763
- * @default 0
1764
1915
  */
1765
1916
  borderRadius: 0,
1766
1917
 
1767
1918
  /**
1768
1919
  * Options for the paging or navigation appearing when the legend
1769
1920
  * is overflown. Navigation works well on screen, but not in static
1770
- * exported images. One way of working around that is to [increase
1771
- * the chart height in export](http://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/legend/navigation-
1772
- * enabled-false/).
1773
- *
1921
+ * exported images. One way of working around that is to
1922
+ * [increase the chart height in
1923
+ * export](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/legend/navigation-enabled-false/).
1774
1924
  */
1775
1925
  navigation: {
1776
1926
 
@@ -1780,13 +1930,14 @@ H.defaultOptions = {
1780
1930
  * `chart.animation` option. Additional options can be given as an
1781
1931
  * object containing values for easing and duration.
1782
1932
  *
1783
- * @type {Boolean|Object}
1784
1933
  * @sample {highcharts} highcharts/legend/navigation/
1785
1934
  * Legend page navigation demonstrated
1786
1935
  * @sample {highstock} highcharts/legend/navigation/
1787
1936
  * Legend page navigation demonstrated
1788
- * @default true
1789
- * @since 2.2.4
1937
+ *
1938
+ * @type {boolean|Highcharts.AnimationObject}
1939
+ * @default true
1940
+ * @since 2.2.4
1790
1941
  * @apioption legend.navigation.animation
1791
1942
  */
1792
1943
 
@@ -1794,13 +1945,14 @@ H.defaultOptions = {
1794
1945
  * The pixel size of the up and down arrows in the legend paging
1795
1946
  * navigation.
1796
1947
  *
1797
- * @type {Number}
1798
1948
  * @sample {highcharts} highcharts/legend/navigation/
1799
1949
  * Legend page navigation demonstrated
1800
1950
  * @sample {highstock} highcharts/legend/navigation/
1801
1951
  * Legend page navigation demonstrated
1802
- * @default 12
1803
- * @since 2.2.4
1952
+ *
1953
+ * @type {number}
1954
+ * @default 12
1955
+ * @since 2.2.4
1804
1956
  * @apioption legend.navigation.arrowSize
1805
1957
  */
1806
1958
 
@@ -1809,27 +1961,29 @@ H.defaultOptions = {
1809
1961
  * the navigation results in an unwanted overflow.
1810
1962
  *
1811
1963
  * See also the [adapt chart to legend](
1812
- * https://www.highcharts.com/plugin-registry/single/8/Adapt-Chart-To-Legend)
1964
+ * https://www.highcharts.com/products/plugin-registry/single/8/Adapt-Chart-To-Legend)
1813
1965
  * plugin for a solution to extend the chart height to make room for
1814
1966
  * the legend, optionally in exported charts only.
1815
1967
  *
1816
- * @type {Boolean}
1817
- * @default true
1818
- * @since 4.2.4
1968
+ * @type {boolean}
1969
+ * @default true
1970
+ * @since 4.2.4
1819
1971
  * @apioption legend.navigation.enabled
1820
1972
  */
1821
1973
 
1822
1974
  /**
1823
1975
  * Text styles for the legend page navigation.
1824
1976
  *
1825
- * @type {CSSObject}
1826
1977
  * @see In styled mode, the navigation items are styled with the
1827
- * `.highcharts-legend-navigation` class.
1978
+ * `.highcharts-legend-navigation` class.
1979
+ *
1828
1980
  * @sample {highcharts} highcharts/legend/navigation/
1829
1981
  * Legend page navigation demonstrated
1830
1982
  * @sample {highstock} highcharts/legend/navigation/
1831
1983
  * Legend page navigation demonstrated
1832
- * @since 2.2.4
1984
+ *
1985
+ * @type {Highcharts.CSSObject}
1986
+ * @since 2.2.4
1833
1987
  * @apioption legend.navigation.style
1834
1988
  */
1835
1989
 
@@ -1839,13 +1993,14 @@ H.defaultOptions = {
1839
1993
  /**
1840
1994
  * The inner padding of the legend box.
1841
1995
  *
1842
- * @type {Number}
1843
1996
  * @sample {highcharts|highstock} highcharts/legend/padding-itemmargin/
1844
1997
  * Padding and item margins demonstrated
1845
1998
  * @sample {highmaps} maps/legend/padding-itemmargin/
1846
1999
  * Padding and item margins demonstrated
1847
- * @default 8
1848
- * @since 2.2.0
2000
+ *
2001
+ * @type {number}
2002
+ * @default 8
2003
+ * @since 2.2.0
1849
2004
  * @apioption legend.padding
1850
2005
  */
1851
2006
 
@@ -1853,13 +2008,15 @@ H.defaultOptions = {
1853
2008
  * Whether to reverse the order of the legend items compared to the
1854
2009
  * order of the series or points as defined in the configuration object.
1855
2010
  *
1856
- * @type {Boolean}
1857
2011
  * @see [yAxis.reversedStacks](#yAxis.reversedStacks),
1858
2012
  * [series.legendIndex](#series.legendIndex)
2013
+ *
1859
2014
  * @sample {highcharts} highcharts/legend/reversed/
1860
2015
  * Stacked bar with reversed legend
1861
- * @default false
1862
- * @since 1.2.5
2016
+ *
2017
+ * @type {boolean}
2018
+ * @default false
2019
+ * @since 1.2.5
1863
2020
  * @apioption legend.reversed
1864
2021
  */
1865
2022
 
@@ -1867,10 +2024,12 @@ H.defaultOptions = {
1867
2024
  * Whether to show the symbol on the right side of the text rather than
1868
2025
  * the left side. This is common in Arabic and Hebraic.
1869
2026
  *
1870
- * @type {Boolean}
1871
- * @sample {highcharts} highcharts/legend/rtl/ Symbol to the right
1872
- * @default false
1873
- * @since 2.2
2027
+ * @sample {highcharts} highcharts/legend/rtl/
2028
+ * Symbol to the right
2029
+ *
2030
+ * @type {boolean}
2031
+ * @default false
2032
+ * @since 2.2
1874
2033
  * @apioption legend.rtl
1875
2034
  */
1876
2035
 
@@ -1878,11 +2037,12 @@ H.defaultOptions = {
1878
2037
  * CSS styles for the legend area. In the 1.x versions the position
1879
2038
  * of the legend area was determined by CSS. In 2.x, the position is
1880
2039
  * determined by properties like `align`, `verticalAlign`, `x` and `y`,
1881
- * but the styles are still parsed for backwards compatibility.
2040
+ * but the styles are still parsed for backwards compatibility.
1882
2041
  *
1883
- * @type {CSSObject}
1884
2042
  * @deprecated
1885
- * @product highcharts highstock
2043
+ *
2044
+ * @type {Highcharts.CSSObject}
2045
+ * @product highcharts highstock
1886
2046
  * @apioption legend.style
1887
2047
  */
1888
2048
 
@@ -1891,10 +2051,22 @@ H.defaultOptions = {
1891
2051
  /**
1892
2052
  * Default styling for the checkbox next to a legend item when
1893
2053
  * `showCheckbox` is true.
2054
+ *
2055
+ * @type {Highcharts.CSSObject}
2056
+ * @default {"width": "13px", "height": "13px", "position":"absolute"}
1894
2057
  */
1895
2058
  itemCheckboxStyle: {
2059
+ /**
2060
+ * @ignore
2061
+ */
1896
2062
  position: 'absolute',
2063
+ /**
2064
+ * @ignore
2065
+ */
1897
2066
  width: '13px', // for IE precision
2067
+ /**
2068
+ * @ignore
2069
+ */
1898
2070
  height: '13px'
1899
2071
  },
1900
2072
  // itemWidth: undefined,
@@ -1904,8 +2076,6 @@ H.defaultOptions = {
1904
2076
  * the symbol height, which in turn defaults to the font size of the
1905
2077
  * legend items.
1906
2078
  *
1907
- * @type {Boolean}
1908
- * @default true
1909
2079
  * @since 5.0.0
1910
2080
  */
1911
2081
  squareSymbol: true,
@@ -1918,12 +2088,13 @@ H.defaultOptions = {
1918
2088
  * In Highmaps, when the symbol is the gradient of a vertical color
1919
2089
  * axis, the height defaults to 200.
1920
2090
  *
1921
- * @type {Number}
1922
2091
  * @sample {highmaps} maps/legend/layout-vertical-sized/
1923
2092
  * Sized vertical gradient
1924
2093
  * @sample {highmaps} maps/legend/padding-itemmargin/
1925
2094
  * No distance between data classes
1926
- * @since 3.0.8
2095
+ *
2096
+ * @type {number}
2097
+ * @since 3.0.8
1927
2098
  * @apioption legend.symbolHeight
1928
2099
  */
1929
2100
 
@@ -1931,11 +2102,15 @@ H.defaultOptions = {
1931
2102
  * The border radius of the symbol for series types that use a rectangle
1932
2103
  * in the legend. Defaults to half the `symbolHeight`.
1933
2104
  *
1934
- * @type {Number}
1935
- * @sample {highcharts} highcharts/legend/symbolradius/ Round symbols
1936
- * @sample {highstock} highcharts/legend/symbolradius/ Round symbols
1937
- * @sample {highmaps} highcharts/legend/symbolradius/ Round symbols
1938
- * @since 3.0.8
2105
+ * @sample {highcharts} highcharts/legend/symbolradius/
2106
+ * Round symbols
2107
+ * @sample {highstock} highcharts/legend/symbolradius/
2108
+ * Round symbols
2109
+ * @sample {highmaps} highcharts/legend/symbolradius/
2110
+ * Round symbols
2111
+ *
2112
+ * @type {number}
2113
+ * @since 3.0.8
1939
2114
  * @apioption legend.symbolRadius
1940
2115
  */
1941
2116
 
@@ -1947,34 +2122,37 @@ H.defaultOptions = {
1947
2122
  * In Highmaps, when the symbol is the gradient of a horizontal color
1948
2123
  * axis, the width defaults to 200.
1949
2124
  *
1950
- * @type {Number}
1951
2125
  * @sample {highcharts} highcharts/legend/symbolwidth/
1952
2126
  * Greater symbol width and padding
1953
2127
  * @sample {highmaps} maps/legend/padding-itemmargin/
1954
2128
  * Padding and item margins demonstrated
1955
2129
  * @sample {highmaps} maps/legend/layout-vertical-sized/
1956
2130
  * Sized vertical gradient
2131
+ *
2132
+ * @type {number}
1957
2133
  * @apioption legend.symbolWidth
1958
2134
  */
1959
2135
 
1960
2136
  /**
1961
- * Whether to [use HTML](http://www.highcharts.com/docs/chart-concepts/labels-
1962
- * and-string-formatting#html) to render the legend item texts. Prior
1963
- * to 4.1.7, when using HTML, [legend.navigation](#legend.navigation)
1964
- * was disabled.
2137
+ * Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/
2138
+ * labels-and-string-formatting#html) to render the legend item texts.
1965
2139
  *
1966
- * @type {Boolean}
1967
- * @default false
2140
+ * Prior to 4.1.7, when using HTML, [legend.navigation](
2141
+ * #legend.navigation) was disabled.
2142
+ *
2143
+ * @type {boolean}
2144
+ * @default false
1968
2145
  * @apioption legend.useHTML
1969
2146
  */
1970
2147
 
1971
2148
  /**
1972
2149
  * The width of the legend box.
1973
2150
  *
1974
- * @type {Number}
1975
- * @sample {highcharts} highcharts/legend/width/ Aligned to the plot area
1976
- * @default null
1977
- * @since 2.0
2151
+ * @sample {highcharts} highcharts/legend/width/
2152
+ * Aligned to the plot area
2153
+ *
2154
+ * @type {number}
2155
+ * @since 2.0
1978
2156
  * @apioption legend.width
1979
2157
  */
1980
2158
 
@@ -1982,9 +2160,8 @@ H.defaultOptions = {
1982
2160
  * The pixel padding between the legend item symbol and the legend
1983
2161
  * item text.
1984
2162
  *
1985
- * @type {Number}
1986
- * @sample {highcharts} highcharts/legend/symbolpadding/ Greater symbol width and padding
1987
- * @default 5
2163
+ * @sample {highcharts} highcharts/legend/symbolpadding/
2164
+ * Greater symbol width and padding
1988
2165
  */
1989
2166
  symbolPadding: 5,
1990
2167
 
@@ -2000,16 +2177,18 @@ H.defaultOptions = {
2000
2177
  * When the [layout](#legend.layout) option is `proximate`, the
2001
2178
  * `verticalAlign` option doesn't apply.
2002
2179
  *
2003
- * @validvalue ["top", "middle", "bottom"]
2004
- * @type {String}
2005
2180
  * @sample {highcharts} highcharts/legend/verticalalign/
2006
2181
  * Legend 100px from the top of the chart
2007
- * @sample {highstock} stock/legend/align/ Various legend options
2008
- * @sample {highmaps} maps/legend/alignment/ Legend alignment
2009
- * @default bottom
2010
- * @since 2.0
2182
+ * @sample {highstock} stock/legend/align/
2183
+ * Various legend options
2184
+ * @sample {highmaps} maps/legend/alignment/
2185
+ * Legend alignment
2186
+ *
2187
+ * @since 2.0
2188
+ * @validvalue ["top", "middle", "bottom"]
2011
2189
  */
2012
2190
  verticalAlign: 'bottom',
2191
+
2013
2192
  // width: undefined,
2014
2193
 
2015
2194
  /**
@@ -2017,9 +2196,9 @@ H.defaultOptions = {
2017
2196
  * `align` within chart.spacingLeft and chart.spacingRight. Negative
2018
2197
  * x moves it to the left, positive x moves it to the right.
2019
2198
  *
2020
- * @type {Number}
2021
- * @sample {highcharts} highcharts/legend/width/ Aligned to the plot area
2022
- * @default 0
2199
+ * @sample {highcharts} highcharts/legend/width/
2200
+ * Aligned to the plot area
2201
+ *
2023
2202
  * @since 2.0
2024
2203
  */
2025
2204
  x: 0,
@@ -2029,11 +2208,13 @@ H.defaultOptions = {
2029
2208
  * `verticalAlign` within chart.spacingTop and chart.spacingBottom.
2030
2209
  * Negative y moves it up, positive y moves it down.
2031
2210
  *
2032
- * @type {Number}
2033
- * @sample {highcharts} highcharts/legend/verticalalign/ Legend 100px from the top of the chart
2034
- * @sample {highstock} stock/legend/align/ Various legend options
2035
- * @sample {highmaps} maps/legend/alignment/ Legend alignment
2036
- * @default 0
2211
+ * @sample {highcharts} highcharts/legend/verticalalign/
2212
+ * Legend 100px from the top of the chart
2213
+ * @sample {highstock} stock/legend/align/
2214
+ * Various legend options
2215
+ * @sample {highmaps} maps/legend/alignment/
2216
+ * Legend alignment
2217
+ *
2037
2218
  * @since 2.0
2038
2219
  */
2039
2220
  y: 0,
@@ -2041,21 +2222,24 @@ H.defaultOptions = {
2041
2222
  /**
2042
2223
  * A title to be added on top of the legend.
2043
2224
  *
2044
- * @sample {highcharts} highcharts/legend/title/ Legend title
2045
- * @sample {highmaps} maps/legend/alignment/ Legend with title
2225
+ * @sample {highcharts} highcharts/legend/title/
2226
+ * Legend title
2227
+ * @sample {highmaps} maps/legend/alignment/
2228
+ * Legend with title
2229
+ *
2046
2230
  * @since 3.0
2047
2231
  */
2048
2232
  title: {
2049
2233
  /**
2050
2234
  * A text or HTML string for the title.
2051
2235
  *
2052
- * @type {String}
2053
- * @default null
2054
- * @since 3.0
2236
+ * @type {string}
2237
+ * @since 3.0
2055
2238
  * @apioption legend.title.text
2056
2239
  */
2057
2240
 
2058
2241
 
2242
+
2059
2243
  }
2060
2244
  },
2061
2245
 
@@ -2068,29 +2252,33 @@ H.defaultOptions = {
2068
2252
  * is going on, for example while retrieving new data via an XHR connection.
2069
2253
  * The "Loading..." text itself is not part of this configuration
2070
2254
  * object, but part of the `lang` object.
2071
- *
2072
2255
  */
2073
2256
  loading: {
2074
2257
 
2075
2258
  /**
2076
2259
  * The duration in milliseconds of the fade out effect.
2077
2260
  *
2078
- * @type {Number}
2079
- * @sample highcharts/loading/hideduration/ Fade in and out over a second
2080
- * @default 100
2081
- * @since 1.2.0
2261
+ * @sample highcharts/loading/hideduration/
2262
+ * Fade in and out over a second
2263
+ *
2264
+ * @type {number}
2265
+ * @default 100
2266
+ * @since 1.2.0
2082
2267
  * @apioption loading.hideDuration
2083
2268
  */
2084
2269
 
2085
2270
  /**
2086
2271
  * The duration in milliseconds of the fade in effect.
2087
2272
  *
2088
- * @type {Number}
2089
- * @sample highcharts/loading/hideduration/ Fade in and out over a second
2090
- * @default 100
2091
- * @since 1.2.0
2273
+ * @sample highcharts/loading/hideduration/
2274
+ * Fade in and out over a second
2275
+ *
2276
+ * @type {number}
2277
+ * @default 100
2278
+ * @since 1.2.0
2092
2279
  * @apioption loading.showDuration
2093
2280
  */
2281
+
2094
2282
 
2095
2283
  },
2096
2284
 
@@ -2098,16 +2286,14 @@ H.defaultOptions = {
2098
2286
  /**
2099
2287
  * Options for the tooltip that appears when the user hovers over a
2100
2288
  * series or point.
2101
- *
2102
2289
  */
2103
2290
  tooltip: {
2104
2291
 
2105
2292
 
2106
2293
  /**
2107
- * The color of the tooltip border. When `null`, the border takes the
2108
- * color of the corresponding series or point.
2294
+ * The color of the tooltip border. When `undefined`, the border takes
2295
+ * the color of the corresponding series or point.
2109
2296
  *
2110
- * @type {Color}
2111
2297
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2112
2298
  * Follow series by default
2113
2299
  * @sample {highcharts} highcharts/tooltip/bordercolor-black/
@@ -2116,7 +2302,8 @@ H.defaultOptions = {
2116
2302
  * Styled tooltip
2117
2303
  * @sample {highmaps} maps/tooltip/background-border/
2118
2304
  * Background and border demo
2119
- * @default null
2305
+ *
2306
+ * @type {Highcharts.ColorString}
2120
2307
  * @apioption tooltip.borderColor
2121
2308
  */
2122
2309
 
@@ -2125,11 +2312,13 @@ H.defaultOptions = {
2125
2312
  * in order for a better separation from the tooltip. See
2126
2313
  * [xAxis.crosshair](#xAxis.crosshair)<a>.</a>
2127
2314
  *
2128
- * @type {Mixed}
2129
- * @deprecated
2130
2315
  * @sample {highcharts} highcharts/tooltip/crosshairs-x/
2131
2316
  * Enable a crosshair for the x value
2132
- * @default true
2317
+ *
2318
+ * @deprecated
2319
+ *
2320
+ * @type {*}
2321
+ * @default true
2133
2322
  * @apioption tooltip.crosshairs
2134
2323
  */
2135
2324
 
@@ -2142,25 +2331,31 @@ H.defaultOptions = {
2142
2331
  * For touch moves to behave the same way, [followTouchMove](
2143
2332
  * #tooltip.followTouchMove) must be `true` also.
2144
2333
  *
2145
- * @type {Boolean}
2146
- * @default {highcharts} false
2147
- * @default {highstock} false
2148
- * @default {highmaps} true
2149
- * @since 3.0
2334
+ * @type {boolean}
2335
+ * @default {highcharts} false
2336
+ * @default {highstock} false
2337
+ * @default {highmaps} true
2338
+ * @since 3.0
2150
2339
  * @apioption tooltip.followPointer
2151
2340
  */
2152
2341
 
2153
2342
  /**
2154
- * Whether the tooltip should follow the finger as it moves on a touch
2343
+ * Whether the tooltip should update as the finger moves on a touch
2155
2344
  * device. If this is `true` and [chart.panning](#chart.panning) is
2156
2345
  * set,`followTouchMove` will take over one-finger touches, so the user
2157
2346
  * needs to use two fingers for zooming and panning.
2158
2347
  *
2159
- * @type {Boolean}
2160
- * @default {highcharts} true
2161
- * @default {highstock} true
2162
- * @default {highmaps} false
2163
- * @since 3.0.1
2348
+ * Note the difference to [followPointer](#tooltip.followPointer) that
2349
+ * only defines the _position_ of the tooltip. If `followPointer` is
2350
+ * false in for example a column series, the tooltip will show above or
2351
+ * below the column, but as `followTouchMove` is true, the tooltip will
2352
+ * jump from column to column as the user swipes across the plot area.
2353
+ *
2354
+ * @type {boolean}
2355
+ * @default {highcharts} true
2356
+ * @default {highstock} true
2357
+ * @default {highmaps} false
2358
+ * @since 3.0.1
2164
2359
  * @apioption tooltip.followTouchMove
2165
2360
  */
2166
2361
 
@@ -2223,7 +2418,6 @@ H.defaultOptions = {
2223
2418
  *
2224
2419
  * </dl>
2225
2420
  *
2226
- * @type {Function}
2227
2421
  * @sample {highcharts} highcharts/tooltip/formatter-simple/
2228
2422
  * Simple string formatting
2229
2423
  * @sample {highcharts} highcharts/tooltip/formatter-shared/
@@ -2232,6 +2426,8 @@ H.defaultOptions = {
2232
2426
  * Formatting with shared tooltip
2233
2427
  * @sample {highmaps} maps/tooltip/formatter/
2234
2428
  * String formatting
2429
+ *
2430
+ * @type {Function}
2235
2431
  * @apioption tooltip.formatter
2236
2432
  */
2237
2433
 
@@ -2239,9 +2435,9 @@ H.defaultOptions = {
2239
2435
  * The number of milliseconds to wait until the tooltip is hidden when
2240
2436
  * mouse out from a point or chart.
2241
2437
  *
2242
- * @type {Number}
2243
- * @default 500
2244
- * @since 3.0
2438
+ * @type {number}
2439
+ * @default 500
2440
+ * @since 3.0
2245
2441
  * @apioption tooltip.hideDelay
2246
2442
  */
2247
2443
 
@@ -2254,11 +2450,12 @@ H.defaultOptions = {
2254
2450
  * overlaid on the page, allowing the tooltip to be aligned inside the
2255
2451
  * page itself.
2256
2452
  *
2257
- * @type {Boolean}
2258
2453
  * @sample highcharts/tooltip/outside
2259
2454
  * Small charts with tooltips outside
2260
- * @default false
2261
- * @since 6.1.1
2455
+ *
2456
+ * @type {boolean}
2457
+ * @default false
2458
+ * @since 6.1.1
2262
2459
  * @apioption tooltip.outside
2263
2460
  */
2264
2461
 
@@ -2267,9 +2464,9 @@ H.defaultOptions = {
2267
2464
  * in the tooltip. Like the `pointFormat` string, but with more
2268
2465
  * flexibility.
2269
2466
  *
2270
- * @type {Function}
2271
- * @context Point
2272
- * @since 4.1.0
2467
+ * @type {Function}
2468
+ * @since 4.1.0
2469
+ * @context Highcharts.Point
2273
2470
  * @apioption tooltip.pointFormatter
2274
2471
  */
2275
2472
 
@@ -2283,25 +2480,31 @@ H.defaultOptions = {
2283
2480
  * The return should be an object containing x and y values, for example
2284
2481
  * `{ x: 100, y: 100 }`.
2285
2482
  *
2286
- * @type {Function}
2287
2483
  * @sample {highcharts} highcharts/tooltip/positioner/
2288
2484
  * A fixed tooltip position
2289
2485
  * @sample {highstock} stock/tooltip/positioner/
2290
2486
  * A fixed tooltip position on top of the chart
2291
2487
  * @sample {highmaps} maps/tooltip/positioner/
2292
2488
  * A fixed tooltip position
2293
- * @since 2.2.4
2489
+ *
2490
+ * @type {Function}
2491
+ * @since 2.2.4
2294
2492
  * @apioption tooltip.positioner
2295
2493
  */
2296
2494
 
2297
2495
  /**
2298
- * The name of a symbol to use for the border around the tooltip.
2496
+ * The name of a symbol to use for the border around the tooltip. Can
2497
+ * be one of: `"callout"`, `"circle"` or `"square"`.
2299
2498
  *
2300
- * @type {String}
2301
- * @default callout
2499
+ * Custom callbacks for symbol path generation can also be added to
2500
+ * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
2501
+ * [series.marker.symbol](plotOptions.line.marker.symbol).
2502
+ *
2503
+ * @type {string}
2504
+ * @default callout
2505
+ * @since 4.0
2302
2506
  * @validvalue ["callout", "square"]
2303
- * @since 4.0
2304
- * @apioption tooltip.shape
2507
+ * @apioption tooltip.shape
2305
2508
  */
2306
2509
 
2307
2510
  /**
@@ -2315,17 +2518,19 @@ H.defaultOptions = {
2315
2518
  * charts with many series, especially line-type series. The
2316
2519
  * `tooltip.split` option takes precedence over `tooltip.shared`.
2317
2520
  *
2318
- * @type {Boolean}
2319
2521
  * @sample {highcharts} highcharts/tooltip/shared-false/
2320
2522
  * False by default
2321
- * @sample {highcharts} highcharts/tooltip/shared-true/ True
2523
+ * @sample {highcharts} highcharts/tooltip/shared-true/
2524
+ * True
2322
2525
  * @sample {highcharts} highcharts/tooltip/shared-x-crosshair/
2323
2526
  * True with x axis crosshair
2324
2527
  * @sample {highcharts} highcharts/tooltip/shared-true-mixed-types/
2325
2528
  * True with mixed series types
2326
- * @default false
2327
- * @since 2.1
2328
- * @product highcharts highstock
2529
+ *
2530
+ * @type {boolean}
2531
+ * @default false
2532
+ * @since 2.1
2533
+ * @product highcharts highstock
2329
2534
  * @apioption tooltip.shared
2330
2535
  */
2331
2536
 
@@ -2340,12 +2545,14 @@ H.defaultOptions = {
2340
2545
  * and multiple panes, making split tooltips the preferred layout over
2341
2546
  * the previous `shared` tooltip.
2342
2547
  *
2343
- * @type {Boolean}
2344
- * @sample highcharts/tooltip/split/ Split tooltip
2345
- * @default {highcharts} false
2346
- * @default {highstock} true
2347
- * @product highcharts highstock
2348
- * @since 5.0.0
2548
+ * @sample highcharts/tooltip/split/
2549
+ * Split tooltip
2550
+ *
2551
+ * @type {boolean}
2552
+ * @default {highcharts} false
2553
+ * @default {highstock} true
2554
+ * @since 5.0.0
2555
+ * @product highcharts highstock
2349
2556
  * @apioption tooltip.split
2350
2557
  */
2351
2558
 
@@ -2355,14 +2562,16 @@ H.defaultOptions = {
2355
2562
  * tooltip. It is also recommended for rtl languages as it works around
2356
2563
  * rtl bugs in early Firefox.
2357
2564
  *
2358
- * @type {Boolean}
2359
2565
  * @sample {highcharts|highstock} highcharts/tooltip/footerformat/
2360
2566
  * A table for value alignment
2361
2567
  * @sample {highcharts|highstock} highcharts/tooltip/fullhtml/
2362
2568
  * Full HTML tooltip
2363
- * @sample {highmaps} maps/tooltip/usehtml/ Pure HTML tooltip
2364
- * @default false
2365
- * @since 2.2
2569
+ * @sample {highmaps} maps/tooltip/usehtml/
2570
+ * Pure HTML tooltip
2571
+ *
2572
+ * @type {boolean}
2573
+ * @default false
2574
+ * @since 2.2
2366
2575
  * @apioption tooltip.useHTML
2367
2576
  */
2368
2577
 
@@ -2371,12 +2580,13 @@ H.defaultOptions = {
2371
2580
  * overridable in each series' tooltip options object. The default is to
2372
2581
  * preserve all decimals.
2373
2582
  *
2374
- * @type {Number}
2375
2583
  * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
2376
2584
  * Set decimals, prefix and suffix for the value
2377
2585
  * @sample {highmaps} maps/tooltip/valuedecimals/
2378
2586
  * Set decimals, prefix and suffix for the value
2379
- * @since 2.2
2587
+ *
2588
+ * @type {number}
2589
+ * @since 2.2
2380
2590
  * @apioption tooltip.valueDecimals
2381
2591
  */
2382
2592
 
@@ -2384,12 +2594,13 @@ H.defaultOptions = {
2384
2594
  * A string to prepend to each series' y value. Overridable in each
2385
2595
  * series' tooltip options object.
2386
2596
  *
2387
- * @type {String}
2388
2597
  * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
2389
2598
  * Set decimals, prefix and suffix for the value
2390
2599
  * @sample {highmaps} maps/tooltip/valuedecimals/
2391
2600
  * Set decimals, prefix and suffix for the value
2392
- * @since 2.2
2601
+ *
2602
+ * @type {string}
2603
+ * @since 2.2
2393
2604
  * @apioption tooltip.valuePrefix
2394
2605
  */
2395
2606
 
@@ -2397,12 +2608,13 @@ H.defaultOptions = {
2397
2608
  * A string to append to each series' y value. Overridable in each
2398
2609
  * series' tooltip options object.
2399
2610
  *
2400
- * @type {String}
2401
2611
  * @sample {highcharts|highstock} highcharts/tooltip/valuedecimals/
2402
2612
  * Set decimals, prefix and suffix for the value
2403
2613
  * @sample {highmaps} maps/tooltip/valuedecimals/
2404
2614
  * Set decimals, prefix and suffix for the value
2405
- * @since 2.2
2615
+ *
2616
+ * @type {string}
2617
+ * @since 2.2
2406
2618
  * @apioption tooltip.valueSuffix
2407
2619
  */
2408
2620
 
@@ -2411,44 +2623,53 @@ H.defaultOptions = {
2411
2623
  * datetime axis. The default is a best guess based on the smallest
2412
2624
  * distance between points in the chart.
2413
2625
  *
2414
- * @type {String}
2415
- * @sample {highcharts} highcharts/tooltip/xdateformat/ A different format
2416
- * @product highcharts highstock
2626
+ * @sample {highcharts} highcharts/tooltip/xdateformat/
2627
+ * A different format
2628
+ *
2629
+ * @type {string}
2630
+ * @product highcharts highstock gantt
2417
2631
  * @apioption tooltip.xDateFormat
2418
2632
  */
2419
2633
 
2634
+ /**
2635
+ * How many decimals to show for the `point.change` value when the
2636
+ * `series.compare` option is set. This is overridable in each series'
2637
+ * tooltip options object. The default is to preserve all decimals.
2638
+ *
2639
+ * @type {number}
2640
+ * @since 1.0.1
2641
+ * @product highstock
2642
+ * @apioption tooltip.changeDecimals
2643
+ */
2644
+
2420
2645
  /**
2421
2646
  * Enable or disable the tooltip.
2422
2647
  *
2423
- * @type {Boolean}
2424
- * @sample {highcharts} highcharts/tooltip/enabled/ Disabled
2425
- * @sample {highcharts}
2426
- * highcharts/plotoptions/series-point-events-mouseover/
2648
+ * @sample {highcharts} highcharts/tooltip/enabled/
2649
+ * Disabled
2650
+ * @sample {highcharts} highcharts/plotoptions/series-point-events-mouseover/
2427
2651
  * Disable tooltip and show values on chart instead
2428
- * @default true
2429
2652
  */
2430
2653
  enabled: true,
2431
2654
 
2432
2655
  /**
2433
2656
  * Enable or disable animation of the tooltip.
2434
2657
  *
2435
- * @type {Boolean}
2436
- * @default true
2437
- * @since 2.3.0
2658
+ * @type {boolean}
2659
+ * @default true
2660
+ * @since 2.3.0
2438
2661
  */
2439
2662
  animation: svg,
2440
2663
 
2441
2664
  /**
2442
2665
  * The radius of the rounded border corners.
2443
2666
  *
2444
- * @type {Number}
2445
2667
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2446
2668
  * 5px by default
2447
2669
  * @sample {highcharts} highcharts/tooltip/borderradius-0/
2448
2670
  * Square borders
2449
2671
  * @sample {highmaps} maps/tooltip/background-border/
2450
2672
  * Background and border demo
2451
- * @default 3
2452
2673
  */
2453
2674
  borderRadius: 3,
2454
2675
 
@@ -2459,22 +2680,10 @@ H.defaultOptions = {
2459
2680
  * each unit. For an overview of the replacement codes, see
2460
2681
  * [dateFormat](/class-reference/Highcharts#dateFormat).
2461
2682
  *
2462
- * Defaults to:
2463
- *
2464
- * <pre>{
2465
- * millisecond:"%A, %b %e, %H:%M:%S.%L",
2466
- * second:"%A, %b %e, %H:%M:%S",
2467
- * minute:"%A, %b %e, %H:%M",
2468
- * hour:"%A, %b %e, %H:%M",
2469
- * day:"%A, %b %e, %Y",
2470
- * week:"Week from %A, %b %e, %Y",
2471
- * month:"%B %Y",
2472
- * year:"%Y"
2473
- * }</pre>
2474
- *
2475
- * @type {Object}
2476
2683
  * @see [xAxis.dateTimeLabelFormats](#xAxis.dateTimeLabelFormats)
2477
- * @product highcharts highstock
2684
+ *
2685
+ * @type {Highcharts.Dictionary<string>}
2686
+ * @product highcharts highstock gantt
2478
2687
  */
2479
2688
  dateTimeLabelFormats: {
2480
2689
  millisecond: '%A, %b %e, %H:%M:%S.%L',
@@ -2492,7 +2701,9 @@ H.defaultOptions = {
2492
2701
  *
2493
2702
  * @sample {highcharts} highcharts/tooltip/footerformat/
2494
2703
  * A table for value alignment
2495
- * @sample {highmaps} maps/tooltip/format/ Format demo
2704
+ * @sample {highmaps} maps/tooltip/format/
2705
+ * Format demo
2706
+ *
2496
2707
  * @since 2.2
2497
2708
  */
2498
2709
  footerFormat: '',
@@ -2500,9 +2711,7 @@ H.defaultOptions = {
2500
2711
  /**
2501
2712
  * Padding inside the tooltip, in pixels.
2502
2713
  *
2503
- * @type {Number}
2504
- * @default 8
2505
- * @since 5.0.0
2714
+ * @since 5.0.0
2506
2715
  */
2507
2716
  padding: 8,
2508
2717
 
@@ -2516,20 +2725,26 @@ H.defaultOptions = {
2516
2725
  * is `true` (default) and when the tooltip is [shared](#tooltip.shared)
2517
2726
  * or [split](#tooltip.split).
2518
2727
  *
2519
- * @type {Number}
2520
2728
  * @sample {highcharts} highcharts/tooltip/bordercolor-default/
2521
2729
  * 10 px by default
2522
- * @sample {highcharts} highcharts/tooltip/snap-50/ 50 px on graph
2730
+ * @sample {highcharts} highcharts/tooltip/snap-50/
2731
+ * 50 px on graph
2732
+ *
2733
+ * @type {number}
2523
2734
  * @default 10/25
2524
- * @since 1.2.0
2735
+ * @since 1.2.0
2525
2736
  * @product highcharts highstock
2526
2737
  */
2527
2738
  snap: isTouchDevice ? 25 : 10,
2739
+
2528
2740
 
2741
+
2529
2742
  headerFormat: '<span class="highcharts-header">{point.key}</span><br/>',
2743
+
2530
2744
  pointFormat: '<span class="highcharts-color-{point.colorIndex}">' +
2531
2745
  '\u25CF</span> {series.name}: <span class="highcharts-strong">' +
2532
2746
  '{point.y}</span><br/>'
2747
+
2533
2748
 
2534
2749
  },
2535
2750
 
@@ -2540,37 +2755,70 @@ H.defaultOptions = {
2540
2755
  */
2541
2756
  credits: {
2542
2757
 
2758
+ /**
2759
+ * Credits for map source to be concatenated with conventional credit
2760
+ * text. By default this is a format string that collects copyright
2761
+ * information from the map if available.
2762
+ *
2763
+ * @see [mapTextFull](#credits.mapTextFull)
2764
+ * @see [text](#credits.text)
2765
+ *
2766
+ * @type {string}
2767
+ * @default \u00a9 <a href="{geojson.copyrightUrl}">{geojson.copyrightShort}</a>
2768
+ * @since 4.2.2
2769
+ * @product highmaps
2770
+ * @apioption credits.mapText
2771
+ */
2772
+
2773
+ /**
2774
+ * Detailed credits for map source to be displayed on hover of credits
2775
+ * text. By default this is a format string that collects copyright
2776
+ * information from the map if available.
2777
+ *
2778
+ * @see [mapText](#credits.mapText)
2779
+ * @see [text](#credits.text)
2780
+ *
2781
+ * @type {string}
2782
+ * @default {geojson.copyright}
2783
+ * @since 4.2.2
2784
+ * @product highmaps
2785
+ * @apioption credits.mapTextFull
2786
+ */
2787
+
2543
2788
  /**
2544
2789
  * Whether to show the credits text.
2545
2790
  *
2546
- * @type {Boolean}
2547
- * @sample {highcharts} highcharts/credits/enabled-false/ Credits disabled
2548
- * @sample {highstock} stock/credits/enabled/ Credits disabled
2549
- * @sample {highmaps} maps/credits/enabled-false/ Credits disabled
2550
- * @default true
2791
+ * @sample {highcharts} highcharts/credits/enabled-false/
2792
+ * Credits disabled
2793
+ * @sample {highstock} stock/credits/enabled/
2794
+ * Credits disabled
2795
+ * @sample {highmaps} maps/credits/enabled-false/
2796
+ * Credits disabled
2551
2797
  */
2552
2798
  enabled: true,
2553
2799
 
2554
2800
  /**
2555
2801
  * The URL for the credits label.
2556
2802
  *
2557
- * @type {String}
2558
- * @sample {highcharts} highcharts/credits/href/ Custom URL and text
2559
- * @sample {highmaps} maps/credits/customized/ Custom URL and text
2560
- * @default {highcharts} http://www.highcharts.com
2561
- * @default {highstock} "http://www.highcharts.com"
2562
- * @default {highmaps} http://www.highcharts.com
2803
+ * @sample {highcharts} highcharts/credits/href/
2804
+ * Custom URL and text
2805
+ * @sample {highmaps} maps/credits/customized/
2806
+ * Custom URL and text
2563
2807
  */
2564
- href: 'http://www.highcharts.com',
2808
+ href: 'https://www.highcharts.com',
2565
2809
 
2566
2810
  /**
2567
2811
  * Position configuration for the credits label.
2568
2812
  *
2569
- * @type {Object}
2570
- * @sample {highcharts} highcharts/credits/position-left/ Left aligned
2571
- * @sample {highcharts} highcharts/credits/position-left/ Left aligned
2572
- * @sample {highmaps} maps/credits/customized/ Left aligned
2573
- * @sample {highmaps} maps/credits/customized/ Left aligned
2813
+ * @sample {highcharts} highcharts/credits/position-left/
2814
+ * Left aligned
2815
+ * @sample {highcharts} highcharts/credits/position-left/
2816
+ * Left aligned
2817
+ * @sample {highmaps} maps/credits/customized/
2818
+ * Left aligned
2819
+ * @sample {highmaps} maps/credits/customized/
2820
+ * Left aligned
2821
+ *
2574
2822
  * @since 2.1
2575
2823
  */
2576
2824
  position: {
@@ -2579,16 +2827,11 @@ H.defaultOptions = {
2579
2827
  * Horizontal alignment of the credits.
2580
2828
  *
2581
2829
  * @validvalue ["left", "center", "right"]
2582
- * @type {String}
2583
- * @default right
2584
2830
  */
2585
2831
  align: 'right',
2586
2832
 
2587
2833
  /**
2588
2834
  * Horizontal pixel offset of the credits.
2589
- *
2590
- * @type {Number}
2591
- * @default -10
2592
2835
  */
2593
2836
  x: -10,
2594
2837
 
@@ -2596,19 +2839,16 @@ H.defaultOptions = {
2596
2839
  * Vertical alignment of the credits.
2597
2840
  *
2598
2841
  * @validvalue ["top", "middle", "bottom"]
2599
- * @type {String}
2600
- * @default bottom
2601
2842
  */
2602
2843
  verticalAlign: 'bottom',
2603
2844
 
2604
2845
  /**
2605
2846
  * Vertical pixel offset of the credits.
2606
- *
2607
- * @type {Number}
2608
- * @default -5
2609
2847
  */
2610
2848
  y: -5
2849
+
2611
2850
  },
2851
+
2612
2852
 
2613
2853
 
2614
2854
  /**
@@ -2619,12 +2859,13 @@ H.defaultOptions = {
2619
2859
  * `Highcharts @ {map-credits}`. Otherwise, it defaults to
2620
2860
  * `Highcharts.com`.
2621
2861
  *
2622
- * @type {String}
2623
- * @sample {highcharts} highcharts/credits/href/ Custom URL and text
2624
- * @sample {highmaps} maps/credits/customized/ Custom URL and text
2625
- * @default {highcharts|highstock} Highcharts.com
2862
+ * @sample {highcharts} highcharts/credits/href/
2863
+ * Custom URL and text
2864
+ * @sample {highmaps} maps/credits/customized/
2865
+ * Custom URL and text
2626
2866
  */
2627
2867
  text: 'Highcharts.com'
2868
+
2628
2869
  }
2629
2870
  };
2630
2871
 
@@ -2632,12 +2873,16 @@ H.defaultOptions = {
2632
2873
  * Merge the default options with custom options and return the new options
2633
2874
  * structure. Commonly used for defining reusable templates.
2634
2875
  *
2635
- * @function #setOptions
2636
- * @memberof Highcharts
2637
2876
  * @sample highcharts/global/useutc-false Setting a global option
2638
2877
  * @sample highcharts/members/setoptions Applying a global theme
2639
- * @param {Object} options The new custom chart options.
2640
- * @returns {Object} Updated options.
2878
+ *
2879
+ * @function Highcharts.setOptions
2880
+ *
2881
+ * @param {Highcharts.Options} options
2882
+ * The new custom chart options.
2883
+ *
2884
+ * @return {Highcharts.Options}
2885
+ * Updated options.
2641
2886
  */
2642
2887
  H.setOptions = function (options) {
2643
2888
 
@@ -2657,6 +2902,10 @@ H.setOptions = function (options) {
2657
2902
  * Get the updated default options. Until 3.0.7, merely exposing defaultOptions
2658
2903
  * for outside modules wasn't enough because the setOptions method created a new
2659
2904
  * object.
2905
+ *
2906
+ * @function Highcharts.getOptions
2907
+ *
2908
+ * @return {Highcharts.Options}
2660
2909
  */
2661
2910
  H.getOptions = function () {
2662
2911
  return H.defaultOptions;
@@ -2667,7 +2916,14 @@ H.getOptions = function () {
2667
2916
  H.defaultPlotOptions = H.defaultOptions.plotOptions;
2668
2917
 
2669
2918
 
2670
- // Time utilities
2919
+ /**
2920
+ * Global `Time` object with default options. Since v6.0.5, time settings can be
2921
+ * applied individually for each chart. If no individual settings apply, this
2922
+ * `Time` object is shared by all instances.
2923
+ *
2924
+ * @name Highcharts.time
2925
+ * @type {Highcharts.Time}
2926
+ */
2671
2927
  H.time = new H.Time(merge(H.defaultOptions.global, H.defaultOptions.time));
2672
2928
 
2673
2929
  /**
@@ -2682,13 +2938,20 @@ H.time = new H.Time(merge(H.defaultOptions.global, H.defaultOptions.time));
2682
2938
  * `Highcharts.dateFormat` function only reflects global time settings set with
2683
2939
  * `setOptions`.
2684
2940
  *
2685
- * @function #dateFormat
2686
- * @memberof Highcharts
2687
- * @param {String} format - The desired format where various time
2688
- * representations are prefixed with %.
2689
- * @param {Number} timestamp - The JavaScript timestamp.
2690
- * @param {Boolean} [capitalize=false] - Upper case first letter in the return.
2691
- * @returns {String} The formatted date.
2941
+ * @function Highcharts.dateFormat
2942
+ *
2943
+ * @param {string} format
2944
+ * The desired format where various time representations are prefixed
2945
+ * with `%`.
2946
+ *
2947
+ * @param {number} timestamp
2948
+ * The JavaScript timestamp.
2949
+ *
2950
+ * @param {boolean} [capitalize=false]
2951
+ * Upper case first letter in the return.
2952
+ *
2953
+ * @return {string}
2954
+ * The formatted date.
2692
2955
  */
2693
2956
  H.dateFormat = function (format, timestamp, capitalize) {
2694
2957
  return H.time.dateFormat(format, timestamp, capitalize);