highcharts 9.3.3 → 10.0.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 (670) hide show
  1. package/bower.json +1 -1
  2. package/css/highcharts.css +19 -2
  3. package/css/highcharts.scss +17 -2
  4. package/css/themes/dark-unica.css +19 -2
  5. package/css/themes/grid-light.css +19 -2
  6. package/css/themes/sand-signika.css +19 -2
  7. package/es-modules/Accessibility/Accessibility.js +1 -1
  8. package/es-modules/Accessibility/Components/LegendComponent.js +31 -23
  9. package/es-modules/Accessibility/Components/MenuComponent.js +4 -5
  10. package/es-modules/Accessibility/Components/RangeSelectorComponent.js +2 -2
  11. package/es-modules/Accessibility/Components/SeriesComponent/ForcedMarkers.js +7 -6
  12. package/es-modules/Accessibility/Components/SeriesComponent/NewDataAnnouncer.js +1 -1
  13. package/es-modules/Accessibility/Components/SeriesComponent/SeriesComponent.js +0 -1
  14. package/es-modules/Accessibility/Components/SeriesComponent/SeriesDescriber.js +3 -3
  15. package/es-modules/Accessibility/Components/SeriesComponent/SeriesKeyboardNavigation.js +61 -29
  16. package/es-modules/Accessibility/Components/ZoomComponent.js +13 -10
  17. package/es-modules/Accessibility/HighContrastMode.js +2 -2
  18. package/es-modules/Accessibility/KeyboardNavigation.js +113 -98
  19. package/es-modules/Accessibility/ProxyElement.js +14 -6
  20. package/es-modules/Accessibility/ProxyProvider.js +10 -2
  21. package/es-modules/Core/Axis/Axis.js +150 -46
  22. package/es-modules/Core/Axis/Color/ColorAxis.js +22 -5
  23. package/es-modules/Core/Axis/GridAxis.js +10 -9
  24. package/es-modules/Core/Axis/TreeGridTick.js +11 -0
  25. package/es-modules/Core/Chart/Chart3D.js +1 -11
  26. package/es-modules/Core/Chart/ChartDefaults.js +32 -11
  27. package/es-modules/Core/Chart/MapChart.js +1 -6
  28. package/es-modules/Core/DefaultOptions.js +2 -0
  29. package/es-modules/Core/Geometry/PolygonClip.js +84 -0
  30. package/es-modules/Core/Globals.js +4 -18
  31. package/es-modules/Core/HttpUtilities.js +13 -8
  32. package/es-modules/Core/Legend/Legend.js +10 -8
  33. package/es-modules/Core/Navigator.js +9 -6
  34. package/es-modules/Core/Pointer.js +15 -11
  35. package/es-modules/Core/Renderer/HTML/AST.js +62 -5
  36. package/es-modules/Core/Renderer/SVG/SVGElement.js +25 -41
  37. package/es-modules/Core/Renderer/SVG/SVGElement3D.js +17 -5
  38. package/es-modules/Core/Renderer/SVG/SVGRenderer.js +17 -17
  39. package/es-modules/Core/Renderer/SVG/TextBuilder.js +12 -10
  40. package/es-modules/Core/Series/DataLabel.js +11 -3
  41. package/es-modules/Core/Series/Point.js +2 -2
  42. package/es-modules/Core/Series/Series.js +33 -15
  43. package/es-modules/Core/Series/SeriesDefaults.js +4 -1
  44. package/es-modules/Core/Tooltip.js +14 -31
  45. package/es-modules/Core/Utilities.js +28 -28
  46. package/es-modules/Extensions/Annotations/Annotations.js +7 -0
  47. package/es-modules/Extensions/Annotations/MockPoint.js +1 -1
  48. package/es-modules/Extensions/Annotations/NavigationBindings.js +1 -1
  49. package/es-modules/Extensions/Annotations/Popup.js +1 -1
  50. package/es-modules/Extensions/Annotations/Types/BasicAnnotation.js +5 -3
  51. package/es-modules/Extensions/Boost/BoostInit.js +6 -1
  52. package/es-modules/Extensions/Boost/BoostOptions.js +26 -0
  53. package/es-modules/Extensions/Boost/Boostables.js +1 -0
  54. package/es-modules/Extensions/Boost/WGLRenderer.js +48 -37
  55. package/es-modules/Extensions/Boost/WGLShader.js +4 -3
  56. package/es-modules/Extensions/Breadcrumbs.js +874 -0
  57. package/es-modules/Extensions/Data.js +26 -14
  58. package/es-modules/Extensions/DataGrouping.js +5 -2
  59. package/es-modules/Extensions/DraggablePoints.js +9 -7
  60. package/es-modules/Extensions/Drilldown.js +147 -94
  61. package/es-modules/Extensions/Exporting/Exporting.js +9 -7
  62. package/es-modules/Extensions/Exporting/ExportingDefaults.js +49 -1
  63. package/es-modules/Extensions/GeoJSON.js +149 -124
  64. package/es-modules/Extensions/MarkerClusters.js +34 -20
  65. package/es-modules/Extensions/OfflineExporting/OfflineExporting.js +110 -22
  66. package/es-modules/Extensions/OfflineExporting/OfflineExportingDefaults.js +1 -1
  67. package/es-modules/Extensions/Oldie/Oldie.js +1 -1
  68. package/es-modules/Extensions/ScrollablePlotArea.js +5 -1
  69. package/es-modules/Extensions/Stacking.js +3 -2
  70. package/es-modules/Extensions/Themes/HighContrastDark.js +10 -10
  71. package/es-modules/Extensions/Themes/HighContrastLight.js +10 -10
  72. package/es-modules/Maps/MapNavigation.js +49 -8
  73. package/es-modules/Maps/MapPointer.js +16 -0
  74. package/es-modules/Maps/MapUtilities.js +56 -0
  75. package/es-modules/Maps/MapView.js +606 -135
  76. package/es-modules/Maps/MapViewInsetsOptionsDefault.js +148 -0
  77. package/es-modules/Maps/MapViewOptionsDefault.js +58 -20
  78. package/es-modules/Maps/Projection.js +169 -77
  79. package/es-modules/Maps/Projections/EqualEarth.js +15 -6
  80. package/es-modules/Maps/Projections/LambertConformalConic.js +27 -19
  81. package/es-modules/Maps/Projections/Miller.js +23 -10
  82. package/es-modules/Maps/Projections/Orthographic.js +21 -10
  83. package/es-modules/Maps/Projections/WebMercator.js +25 -13
  84. package/es-modules/Series/ArcDiagram/ArcDiagramPoint.js +77 -0
  85. package/es-modules/Series/ArcDiagram/ArcDiagramSeries.js +581 -0
  86. package/es-modules/Series/Column/ColumnSeries.js +4 -3
  87. package/es-modules/Series/DataModifyComposition.js +1 -0
  88. package/es-modules/Series/DependencyWheel/DependencyWheelSeries.js +2 -2
  89. package/es-modules/Series/DrawPointComposition.js +7 -4
  90. package/es-modules/Series/Lollipop/LollipopSeries.js +1 -1
  91. package/es-modules/Series/Map/MapPoint.js +24 -1
  92. package/es-modules/Series/Map/MapSeries.js +196 -169
  93. package/es-modules/Series/MapBubble/MapBubblePoint.js +16 -24
  94. package/es-modules/Series/MapBubble/MapBubbleSeries.js +11 -0
  95. package/es-modules/Series/MapPoint/MapPointPoint.js +2 -8
  96. package/es-modules/Series/MapPoint/MapPointSeries.js +36 -14
  97. package/es-modules/Series/NodesComposition.js +60 -13
  98. package/es-modules/Series/OHLC/OHLCSeries.js +7 -0
  99. package/es-modules/Series/Organization/OrganizationPoint.js +68 -2
  100. package/es-modules/Series/Organization/OrganizationSeries.js +79 -25
  101. package/es-modules/Series/Pie/PiePoint.js +12 -5
  102. package/es-modules/Series/Pie3D/Pie3DSeries.js +19 -0
  103. package/es-modules/Series/Sankey/SankeyColumnComposition.js +193 -0
  104. package/es-modules/Series/Sankey/SankeyPoint.js +37 -1
  105. package/es-modules/Series/Sankey/SankeySeries.js +10 -127
  106. package/es-modules/Series/Scatter/ScatterSeries.js +1 -1
  107. package/es-modules/Series/Sunburst/SunburstSeries.js +13 -2
  108. package/es-modules/Series/Treemap/TreemapSeries.js +88 -80
  109. package/es-modules/Series/Waterfall/WaterfallSeries.js +2 -0
  110. package/es-modules/Stock/Indicators/SMA/SMAIndicator.js +9 -2
  111. package/es-modules/Stock/StockToolsGui.js +1 -1
  112. package/es-modules/masters/highcharts-3d.src.js +1 -1
  113. package/es-modules/masters/highcharts-gantt.src.js +1 -1
  114. package/es-modules/masters/highcharts-more.src.js +1 -1
  115. package/es-modules/masters/highcharts.src.js +1 -1
  116. package/es-modules/masters/highmaps.src.js +1 -1
  117. package/es-modules/masters/highstock.src.js +1 -1
  118. package/es-modules/masters/indicators/acceleration-bands.src.js +1 -1
  119. package/es-modules/masters/indicators/accumulation-distribution.src.js +1 -1
  120. package/es-modules/masters/indicators/ao.src.js +1 -1
  121. package/es-modules/masters/indicators/apo.src.js +1 -1
  122. package/es-modules/masters/indicators/aroon-oscillator.src.js +1 -1
  123. package/es-modules/masters/indicators/aroon.src.js +1 -1
  124. package/es-modules/masters/indicators/atr.src.js +1 -1
  125. package/es-modules/masters/indicators/bollinger-bands.src.js +1 -1
  126. package/es-modules/masters/indicators/cci.src.js +1 -1
  127. package/es-modules/masters/indicators/chaikin.src.js +1 -1
  128. package/es-modules/masters/indicators/cmf.src.js +1 -1
  129. package/es-modules/masters/indicators/cmo.src.js +1 -1
  130. package/es-modules/masters/indicators/dema.src.js +1 -1
  131. package/es-modules/masters/indicators/disparity-index.src.js +1 -1
  132. package/es-modules/masters/indicators/dmi.src.js +1 -1
  133. package/es-modules/masters/indicators/dpo.src.js +1 -1
  134. package/es-modules/masters/indicators/ichimoku-kinko-hyo.src.js +1 -1
  135. package/es-modules/masters/indicators/indicators-all.src.js +1 -1
  136. package/es-modules/masters/indicators/indicators.src.js +1 -1
  137. package/es-modules/masters/indicators/keltner-channels.src.js +1 -1
  138. package/es-modules/masters/indicators/klinger.src.js +1 -1
  139. package/es-modules/masters/indicators/macd.src.js +1 -1
  140. package/es-modules/masters/indicators/mfi.src.js +1 -1
  141. package/es-modules/masters/indicators/momentum.src.js +1 -1
  142. package/es-modules/masters/indicators/natr.src.js +1 -1
  143. package/es-modules/masters/indicators/obv.src.js +1 -1
  144. package/es-modules/masters/indicators/pivot-points.src.js +1 -1
  145. package/es-modules/masters/indicators/ppo.src.js +1 -1
  146. package/es-modules/masters/indicators/price-channel.src.js +1 -1
  147. package/es-modules/masters/indicators/price-envelopes.src.js +1 -1
  148. package/es-modules/masters/indicators/psar.src.js +1 -1
  149. package/es-modules/masters/indicators/regressions.src.js +1 -1
  150. package/es-modules/masters/indicators/roc.src.js +1 -1
  151. package/es-modules/masters/indicators/rsi.src.js +1 -1
  152. package/es-modules/masters/indicators/slow-stochastic.src.js +1 -1
  153. package/es-modules/masters/indicators/stochastic.src.js +1 -1
  154. package/es-modules/masters/indicators/supertrend.src.js +1 -1
  155. package/es-modules/masters/indicators/tema.src.js +1 -1
  156. package/es-modules/masters/indicators/trendline.src.js +1 -1
  157. package/es-modules/masters/indicators/trix.src.js +1 -1
  158. package/es-modules/masters/indicators/volume-by-price.src.js +1 -1
  159. package/es-modules/masters/indicators/vwap.src.js +1 -1
  160. package/es-modules/masters/indicators/williams-r.src.js +1 -1
  161. package/es-modules/masters/indicators/wma.src.js +1 -1
  162. package/es-modules/masters/indicators/zigzag.src.js +1 -1
  163. package/es-modules/masters/modules/accessibility.src.js +1 -1
  164. package/es-modules/masters/modules/annotations-advanced.src.js +1 -1
  165. package/es-modules/masters/modules/annotations.src.js +1 -1
  166. package/es-modules/masters/modules/arc-diagram.src.js +14 -0
  167. package/es-modules/masters/modules/arrow-symbols.src.js +1 -1
  168. package/es-modules/masters/modules/boost-canvas.src.js +1 -1
  169. package/es-modules/masters/modules/boost.src.js +1 -1
  170. package/es-modules/masters/modules/broken-axis.src.js +1 -1
  171. package/es-modules/masters/modules/bullet.src.js +1 -1
  172. package/es-modules/masters/modules/coloraxis.src.js +1 -1
  173. package/es-modules/masters/modules/current-date-indicator.src.js +1 -1
  174. package/es-modules/masters/modules/cylinder.src.js +1 -1
  175. package/es-modules/masters/modules/data.src.js +1 -1
  176. package/es-modules/masters/modules/datagrouping.src.js +1 -1
  177. package/es-modules/masters/modules/debugger.src.js +1 -1
  178. package/es-modules/masters/modules/dependency-wheel.src.js +1 -1
  179. package/es-modules/masters/modules/dotplot.src.js +1 -1
  180. package/es-modules/masters/modules/drag-panes.src.js +1 -1
  181. package/es-modules/masters/modules/draggable-points.src.js +1 -1
  182. package/es-modules/masters/modules/drilldown.src.js +2 -1
  183. package/es-modules/masters/modules/dumbbell.src.js +1 -1
  184. package/es-modules/masters/modules/export-data.src.js +1 -1
  185. package/es-modules/masters/modules/exporting.src.js +1 -1
  186. package/es-modules/masters/modules/full-screen.src.js +1 -1
  187. package/es-modules/masters/modules/funnel.src.js +1 -1
  188. package/es-modules/masters/modules/funnel3d.src.js +1 -1
  189. package/es-modules/masters/modules/gantt.src.js +1 -1
  190. package/es-modules/masters/modules/grid-axis.src.js +1 -1
  191. package/es-modules/masters/modules/heatmap.src.js +1 -1
  192. package/es-modules/masters/modules/heikinashi.src.js +1 -1
  193. package/es-modules/masters/modules/histogram-bellcurve.src.js +1 -1
  194. package/es-modules/masters/modules/hollowcandlestick.src.js +1 -1
  195. package/es-modules/masters/modules/item-series.src.js +1 -1
  196. package/es-modules/masters/modules/lollipop.src.js +1 -1
  197. package/es-modules/masters/modules/map.src.js +5 -1
  198. package/es-modules/masters/modules/marker-clusters.src.js +1 -1
  199. package/es-modules/masters/modules/networkgraph.src.js +1 -1
  200. package/es-modules/masters/modules/no-data-to-display.src.js +1 -1
  201. package/es-modules/masters/modules/offline-exporting.src.js +1 -1
  202. package/es-modules/masters/modules/oldie-polyfills.src.js +1 -1
  203. package/es-modules/masters/modules/oldie.src.js +1 -1
  204. package/es-modules/masters/modules/organization.src.js +1 -1
  205. package/es-modules/masters/modules/overlapping-datalabels.src.js +1 -1
  206. package/es-modules/masters/modules/parallel-coordinates.src.js +1 -1
  207. package/es-modules/masters/modules/pareto.src.js +1 -1
  208. package/es-modules/masters/modules/pathfinder.src.js +1 -1
  209. package/es-modules/masters/modules/pattern-fill.src.js +1 -1
  210. package/es-modules/masters/modules/price-indicator.src.js +1 -1
  211. package/es-modules/masters/modules/pyramid3d.src.js +1 -1
  212. package/es-modules/masters/modules/sankey.src.js +1 -1
  213. package/es-modules/masters/modules/series-label.src.js +1 -1
  214. package/es-modules/masters/modules/solid-gauge.src.js +1 -1
  215. package/es-modules/masters/modules/sonification.src.js +1 -1
  216. package/es-modules/masters/modules/static-scale.src.js +1 -1
  217. package/es-modules/masters/modules/stock-tools.src.js +1 -1
  218. package/es-modules/masters/modules/stock.src.js +1 -1
  219. package/es-modules/masters/modules/streamgraph.src.js +1 -1
  220. package/es-modules/masters/modules/sunburst.src.js +1 -1
  221. package/es-modules/masters/modules/tilemap.src.js +1 -1
  222. package/es-modules/masters/modules/timeline.src.js +1 -1
  223. package/es-modules/masters/modules/treegrid.src.js +1 -1
  224. package/es-modules/masters/modules/treemap.src.js +5 -1
  225. package/es-modules/masters/modules/variable-pie.src.js +1 -1
  226. package/es-modules/masters/modules/variwide.src.js +1 -1
  227. package/es-modules/masters/modules/vector.src.js +1 -1
  228. package/es-modules/masters/modules/venn.src.js +1 -1
  229. package/es-modules/masters/modules/windbarb.src.js +1 -1
  230. package/es-modules/masters/modules/wordcloud.src.js +1 -1
  231. package/es-modules/masters/modules/xrange.src.js +1 -1
  232. package/es-modules/masters/themes/avocado.src.js +1 -1
  233. package/es-modules/masters/themes/brand-dark.src.js +1 -1
  234. package/es-modules/masters/themes/brand-light.src.js +1 -1
  235. package/es-modules/masters/themes/dark-blue.src.js +1 -1
  236. package/es-modules/masters/themes/dark-green.src.js +1 -1
  237. package/es-modules/masters/themes/dark-unica.src.js +1 -1
  238. package/es-modules/masters/themes/gray.src.js +1 -1
  239. package/es-modules/masters/themes/grid-light.src.js +1 -1
  240. package/es-modules/masters/themes/grid.src.js +1 -1
  241. package/es-modules/masters/themes/high-contrast-dark.src.js +1 -1
  242. package/es-modules/masters/themes/high-contrast-light.src.js +1 -1
  243. package/es-modules/masters/themes/sand-signika.src.js +1 -1
  244. package/es-modules/masters/themes/skies.src.js +1 -1
  245. package/es-modules/masters/themes/sunset.src.js +1 -1
  246. package/highcharts-3d.js +99 -98
  247. package/highcharts-3d.js.map +1 -1
  248. package/highcharts-3d.src.js +50 -20
  249. package/highcharts-gantt.js +800 -795
  250. package/highcharts-gantt.js.map +1 -1
  251. package/highcharts-gantt.src.js +528 -290
  252. package/highcharts-more.js +195 -194
  253. package/highcharts-more.js.map +1 -1
  254. package/highcharts-more.src.js +13 -2
  255. package/highcharts.d.ts +2162 -504
  256. package/highcharts.js +586 -581
  257. package/highcharts.js.map +1 -1
  258. package/highcharts.src.d.ts +2162 -504
  259. package/highcharts.src.js +494 -272
  260. package/highmaps.js +753 -723
  261. package/highmaps.js.map +1 -1
  262. package/highmaps.src.js +3603 -2117
  263. package/highstock.js +790 -786
  264. package/highstock.js.map +1 -1
  265. package/highstock.src.js +519 -283
  266. package/indicators/acceleration-bands.js +12 -11
  267. package/indicators/acceleration-bands.js.map +1 -1
  268. package/indicators/acceleration-bands.src.js +11 -2
  269. package/indicators/accumulation-distribution.js +5 -5
  270. package/indicators/accumulation-distribution.js.map +1 -1
  271. package/indicators/accumulation-distribution.src.js +11 -2
  272. package/indicators/ao.js +6 -6
  273. package/indicators/ao.js.map +1 -1
  274. package/indicators/ao.src.js +11 -2
  275. package/indicators/apo.js +5 -5
  276. package/indicators/apo.js.map +1 -1
  277. package/indicators/apo.src.js +11 -2
  278. package/indicators/aroon-oscillator.js +10 -10
  279. package/indicators/aroon-oscillator.js.map +1 -1
  280. package/indicators/aroon-oscillator.src.js +11 -2
  281. package/indicators/aroon.js +11 -11
  282. package/indicators/aroon.js.map +1 -1
  283. package/indicators/aroon.src.js +11 -2
  284. package/indicators/atr.js +5 -5
  285. package/indicators/atr.js.map +1 -1
  286. package/indicators/atr.src.js +11 -2
  287. package/indicators/bollinger-bands.js +12 -12
  288. package/indicators/bollinger-bands.js.map +1 -1
  289. package/indicators/bollinger-bands.src.js +11 -2
  290. package/indicators/cci.js +5 -5
  291. package/indicators/cci.js.map +1 -1
  292. package/indicators/cci.src.js +11 -2
  293. package/indicators/chaikin.js +8 -8
  294. package/indicators/chaikin.js.map +1 -1
  295. package/indicators/chaikin.src.js +11 -2
  296. package/indicators/cmf.js +6 -6
  297. package/indicators/cmf.js.map +1 -1
  298. package/indicators/cmf.src.js +11 -2
  299. package/indicators/cmo.js +5 -5
  300. package/indicators/cmo.js.map +1 -1
  301. package/indicators/cmo.src.js +11 -2
  302. package/indicators/dema.js +5 -5
  303. package/indicators/dema.js.map +1 -1
  304. package/indicators/dema.src.js +11 -2
  305. package/indicators/disparity-index.js +6 -6
  306. package/indicators/disparity-index.js.map +1 -1
  307. package/indicators/disparity-index.src.js +11 -2
  308. package/indicators/dmi.js +12 -12
  309. package/indicators/dmi.js.map +1 -1
  310. package/indicators/dmi.src.js +11 -2
  311. package/indicators/dpo.js +5 -5
  312. package/indicators/dpo.js.map +1 -1
  313. package/indicators/dpo.src.js +11 -2
  314. package/indicators/ema.js +2 -1
  315. package/indicators/ema.js.map +1 -1
  316. package/indicators/ema.src.js +10 -1
  317. package/indicators/ichimoku-kinko-hyo.js +16 -16
  318. package/indicators/ichimoku-kinko-hyo.js.map +1 -1
  319. package/indicators/ichimoku-kinko-hyo.src.js +11 -2
  320. package/indicators/indicators-all.js +195 -194
  321. package/indicators/indicators-all.js.map +1 -1
  322. package/indicators/indicators-all.src.js +21 -5
  323. package/indicators/indicators.js +13 -12
  324. package/indicators/indicators.js.map +1 -1
  325. package/indicators/indicators.src.js +21 -5
  326. package/indicators/keltner-channels.js +12 -11
  327. package/indicators/keltner-channels.js.map +1 -1
  328. package/indicators/keltner-channels.src.js +11 -2
  329. package/indicators/klinger.js +13 -13
  330. package/indicators/klinger.js.map +1 -1
  331. package/indicators/klinger.src.js +11 -2
  332. package/indicators/macd.js +12 -11
  333. package/indicators/macd.js.map +1 -1
  334. package/indicators/macd.src.js +11 -2
  335. package/indicators/mfi.js +6 -6
  336. package/indicators/mfi.js.map +1 -1
  337. package/indicators/mfi.src.js +11 -2
  338. package/indicators/momentum.js +5 -5
  339. package/indicators/momentum.js.map +1 -1
  340. package/indicators/momentum.src.js +11 -2
  341. package/indicators/natr.js +5 -4
  342. package/indicators/natr.js.map +1 -1
  343. package/indicators/natr.src.js +11 -2
  344. package/indicators/obv.js +5 -5
  345. package/indicators/obv.js.map +1 -1
  346. package/indicators/obv.src.js +11 -2
  347. package/indicators/pivot-points.js +11 -11
  348. package/indicators/pivot-points.js.map +1 -1
  349. package/indicators/pivot-points.src.js +11 -2
  350. package/indicators/ppo.js +5 -5
  351. package/indicators/ppo.js.map +1 -1
  352. package/indicators/ppo.src.js +11 -2
  353. package/indicators/price-channel.js +11 -11
  354. package/indicators/price-channel.js.map +1 -1
  355. package/indicators/price-channel.src.js +11 -2
  356. package/indicators/price-envelopes.js +8 -8
  357. package/indicators/price-envelopes.js.map +1 -1
  358. package/indicators/price-envelopes.src.js +11 -2
  359. package/indicators/psar.js +7 -6
  360. package/indicators/psar.js.map +1 -1
  361. package/indicators/psar.src.js +11 -2
  362. package/indicators/regressions.js +12 -12
  363. package/indicators/regressions.js.map +1 -1
  364. package/indicators/regressions.src.js +11 -2
  365. package/indicators/roc.js +5 -5
  366. package/indicators/roc.js.map +1 -1
  367. package/indicators/roc.src.js +11 -2
  368. package/indicators/rsi.js +6 -5
  369. package/indicators/rsi.js.map +1 -1
  370. package/indicators/rsi.src.js +11 -2
  371. package/indicators/slow-stochastic.js +5 -5
  372. package/indicators/slow-stochastic.js.map +1 -1
  373. package/indicators/slow-stochastic.src.js +11 -2
  374. package/indicators/stochastic.js +12 -12
  375. package/indicators/stochastic.js.map +1 -1
  376. package/indicators/stochastic.src.js +11 -2
  377. package/indicators/supertrend.js +10 -10
  378. package/indicators/supertrend.js.map +1 -1
  379. package/indicators/supertrend.src.js +11 -2
  380. package/indicators/tema.js +6 -6
  381. package/indicators/tema.js.map +1 -1
  382. package/indicators/tema.src.js +11 -2
  383. package/indicators/trendline.js +5 -5
  384. package/indicators/trendline.js.map +1 -1
  385. package/indicators/trendline.src.js +11 -2
  386. package/indicators/trix.js +4 -4
  387. package/indicators/trix.js.map +1 -1
  388. package/indicators/trix.src.js +11 -2
  389. package/indicators/volume-by-price.js +17 -17
  390. package/indicators/volume-by-price.js.map +1 -1
  391. package/indicators/volume-by-price.src.js +11 -2
  392. package/indicators/vwap.js +5 -5
  393. package/indicators/vwap.js.map +1 -1
  394. package/indicators/vwap.src.js +11 -2
  395. package/indicators/williams-r.js +6 -5
  396. package/indicators/williams-r.js.map +1 -1
  397. package/indicators/williams-r.src.js +11 -2
  398. package/indicators/wma.js +5 -5
  399. package/indicators/wma.js.map +1 -1
  400. package/indicators/wma.src.js +11 -2
  401. package/indicators/zigzag.js +6 -6
  402. package/indicators/zigzag.js.map +1 -1
  403. package/indicators/zigzag.src.js +11 -2
  404. package/lib/jspdf.js +299 -184
  405. package/lib/jspdf.src.js +25266 -18067
  406. package/lib/svg2pdf.js +35 -31
  407. package/lib/svg2pdf.src.js +5721 -4179
  408. package/modules/accessibility.js +231 -229
  409. package/modules/accessibility.js.map +1 -1
  410. package/modules/accessibility.src.js +278 -197
  411. package/modules/annotations-advanced.js +144 -144
  412. package/modules/annotations-advanced.js.map +1 -1
  413. package/modules/annotations-advanced.src.js +26 -8
  414. package/modules/annotations.js +79 -79
  415. package/modules/annotations.js.map +1 -1
  416. package/modules/annotations.src.js +21 -5
  417. package/modules/arc-diagram.js +25 -0
  418. package/modules/arc-diagram.js.map +1 -0
  419. package/modules/arc-diagram.src.js +770 -0
  420. package/modules/arrow-symbols.js +4 -3
  421. package/modules/arrow-symbols.js.map +1 -1
  422. package/modules/arrow-symbols.src.js +11 -2
  423. package/modules/boost-canvas.js +15 -15
  424. package/modules/boost-canvas.js.map +1 -1
  425. package/modules/boost-canvas.src.js +11 -2
  426. package/modules/boost.js +80 -79
  427. package/modules/boost.js.map +1 -1
  428. package/modules/boost.src.js +71 -43
  429. package/modules/broken-axis.js +13 -13
  430. package/modules/broken-axis.js.map +1 -1
  431. package/modules/broken-axis.src.js +11 -2
  432. package/modules/bullet.js +9 -9
  433. package/modules/bullet.js.map +1 -1
  434. package/modules/bullet.src.js +11 -2
  435. package/modules/coloraxis.js +24 -24
  436. package/modules/coloraxis.js.map +1 -1
  437. package/modules/coloraxis.src.js +33 -7
  438. package/modules/current-date-indicator.js +5 -4
  439. package/modules/current-date-indicator.js.map +1 -1
  440. package/modules/current-date-indicator.src.js +11 -2
  441. package/modules/cylinder.js +11 -11
  442. package/modules/cylinder.js.map +1 -1
  443. package/modules/cylinder.src.js +11 -2
  444. package/modules/data.js +34 -33
  445. package/modules/data.js.map +1 -1
  446. package/modules/data.src.js +59 -32
  447. package/modules/datagrouping.js +21 -20
  448. package/modules/datagrouping.js.map +1 -1
  449. package/modules/datagrouping.src.js +16 -4
  450. package/modules/debugger.js +6 -6
  451. package/modules/debugger.js.map +1 -1
  452. package/modules/debugger.src.js +11 -2
  453. package/modules/dependency-wheel.js +12 -11
  454. package/modules/dependency-wheel.js.map +1 -1
  455. package/modules/dependency-wheel.src.js +14 -5
  456. package/modules/dotplot.js +6 -6
  457. package/modules/dotplot.js.map +1 -1
  458. package/modules/dotplot.src.js +11 -2
  459. package/modules/drag-panes.js +10 -10
  460. package/modules/drag-panes.js.map +1 -1
  461. package/modules/drag-panes.src.js +11 -2
  462. package/modules/draggable-points.js +35 -34
  463. package/modules/draggable-points.js.map +1 -1
  464. package/modules/draggable-points.src.js +20 -9
  465. package/modules/drilldown.d.ts +19 -0
  466. package/modules/drilldown.js +37 -25
  467. package/modules/drilldown.js.map +1 -1
  468. package/modules/drilldown.src.d.ts +19 -0
  469. package/modules/drilldown.src.js +1090 -105
  470. package/modules/dumbbell.js +17 -17
  471. package/modules/dumbbell.js.map +1 -1
  472. package/modules/dumbbell.src.js +11 -2
  473. package/modules/export-data.js +21 -20
  474. package/modules/export-data.js.map +1 -1
  475. package/modules/export-data.src.js +11 -2
  476. package/modules/exporting.js +39 -39
  477. package/modules/exporting.js.map +1 -1
  478. package/modules/exporting.src.js +82 -18
  479. package/modules/full-screen.js +8 -7
  480. package/modules/full-screen.js.map +1 -1
  481. package/modules/full-screen.src.js +11 -2
  482. package/modules/funnel.js +12 -12
  483. package/modules/funnel.js.map +1 -1
  484. package/modules/funnel.src.js +11 -2
  485. package/modules/funnel3d.js +21 -21
  486. package/modules/funnel3d.js.map +1 -1
  487. package/modules/funnel3d.src.js +11 -2
  488. package/modules/gantt.js +217 -217
  489. package/modules/gantt.js.map +1 -1
  490. package/modules/gantt.src.js +45 -20
  491. package/modules/grid-axis.js +23 -23
  492. package/modules/grid-axis.js.map +1 -1
  493. package/modules/grid-axis.src.js +22 -11
  494. package/modules/heatmap.js +40 -39
  495. package/modules/heatmap.js.map +1 -1
  496. package/modules/heatmap.src.js +33 -7
  497. package/modules/heikinashi.js +8 -8
  498. package/modules/heikinashi.js.map +1 -1
  499. package/modules/heikinashi.src.js +11 -2
  500. package/modules/histogram-bellcurve.js +13 -13
  501. package/modules/histogram-bellcurve.js.map +1 -1
  502. package/modules/histogram-bellcurve.src.js +11 -2
  503. package/modules/hollowcandlestick.js +9 -9
  504. package/modules/hollowcandlestick.js.map +1 -1
  505. package/modules/hollowcandlestick.src.js +11 -2
  506. package/modules/item-series.js +12 -12
  507. package/modules/item-series.js.map +1 -1
  508. package/modules/item-series.src.js +11 -2
  509. package/modules/lollipop.js +7 -7
  510. package/modules/lollipop.js.map +1 -1
  511. package/modules/lollipop.src.js +12 -3
  512. package/modules/map.d.ts +80 -43
  513. package/modules/map.js +169 -144
  514. package/modules/map.js.map +1 -1
  515. package/modules/map.src.d.ts +80 -43
  516. package/modules/map.src.js +7960 -6687
  517. package/modules/marker-clusters.js +36 -36
  518. package/modules/marker-clusters.js.map +1 -1
  519. package/modules/marker-clusters.src.js +47 -23
  520. package/modules/networkgraph.d.ts +5 -0
  521. package/modules/networkgraph.js +49 -48
  522. package/modules/networkgraph.js.map +1 -1
  523. package/modules/networkgraph.src.d.ts +5 -0
  524. package/modules/networkgraph.src.js +77 -15
  525. package/modules/no-data-to-display.js +5 -5
  526. package/modules/no-data-to-display.js.map +1 -1
  527. package/modules/no-data-to-display.src.js +11 -2
  528. package/modules/offline-exporting.js +20 -18
  529. package/modules/offline-exporting.js.map +1 -1
  530. package/modules/offline-exporting.src.js +126 -25
  531. package/modules/oldie-polyfills.js +7 -7
  532. package/modules/oldie-polyfills.js.map +1 -1
  533. package/modules/oldie-polyfills.src.js +11 -2
  534. package/modules/oldie.js +30 -30
  535. package/modules/oldie.js.map +1 -1
  536. package/modules/oldie.src.js +12 -3
  537. package/modules/organization.js +16 -14
  538. package/modules/organization.js.map +1 -1
  539. package/modules/organization.src.js +166 -32
  540. package/modules/overlapping-datalabels.js +3 -2
  541. package/modules/overlapping-datalabels.js.map +1 -1
  542. package/modules/overlapping-datalabels.src.js +11 -2
  543. package/modules/parallel-coordinates.js +11 -11
  544. package/modules/parallel-coordinates.js.map +1 -1
  545. package/modules/parallel-coordinates.src.js +11 -2
  546. package/modules/pareto.js +7 -7
  547. package/modules/pareto.js.map +1 -1
  548. package/modules/pareto.src.js +11 -2
  549. package/modules/pathfinder.js +31 -31
  550. package/modules/pathfinder.js.map +1 -1
  551. package/modules/pathfinder.src.js +11 -2
  552. package/modules/pattern-fill.js +14 -14
  553. package/modules/pattern-fill.js.map +1 -1
  554. package/modules/pattern-fill.src.js +11 -2
  555. package/modules/price-indicator.js +5 -5
  556. package/modules/price-indicator.js.map +1 -1
  557. package/modules/price-indicator.src.js +11 -2
  558. package/modules/pyramid3d.js +4 -4
  559. package/modules/pyramid3d.js.map +1 -1
  560. package/modules/pyramid3d.src.js +11 -2
  561. package/modules/sankey.d.ts +5 -0
  562. package/modules/sankey.js +32 -29
  563. package/modules/sankey.js.map +1 -1
  564. package/modules/sankey.src.d.ts +5 -0
  565. package/modules/sankey.src.js +338 -156
  566. package/modules/series-label.js +18 -17
  567. package/modules/series-label.js.map +1 -1
  568. package/modules/series-label.src.js +11 -2
  569. package/modules/solid-gauge.js +10 -10
  570. package/modules/solid-gauge.js.map +1 -1
  571. package/modules/solid-gauge.src.js +11 -2
  572. package/modules/sonification.js +59 -59
  573. package/modules/sonification.js.map +1 -1
  574. package/modules/sonification.src.js +11 -2
  575. package/modules/static-scale.js +5 -4
  576. package/modules/static-scale.js.map +1 -1
  577. package/modules/static-scale.src.js +11 -2
  578. package/modules/stock-tools.js +78 -78
  579. package/modules/stock-tools.js.map +1 -1
  580. package/modules/stock-tools.src.js +21 -5
  581. package/modules/stock.js +162 -162
  582. package/modules/stock.js.map +1 -1
  583. package/modules/stock.src.js +36 -13
  584. package/modules/streamgraph.js +5 -4
  585. package/modules/streamgraph.js.map +1 -1
  586. package/modules/streamgraph.src.js +11 -2
  587. package/modules/sunburst.d.ts +3 -0
  588. package/modules/sunburst.js +73 -60
  589. package/modules/sunburst.js.map +1 -1
  590. package/modules/sunburst.src.d.ts +3 -0
  591. package/modules/sunburst.src.js +1049 -96
  592. package/modules/tilemap.js +17 -17
  593. package/modules/tilemap.js.map +1 -1
  594. package/modules/tilemap.src.js +11 -2
  595. package/modules/timeline.js +18 -18
  596. package/modules/timeline.js.map +1 -1
  597. package/modules/timeline.src.js +11 -2
  598. package/modules/treegrid.js +57 -56
  599. package/modules/treegrid.js.map +1 -1
  600. package/modules/treegrid.src.js +33 -11
  601. package/modules/treemap.d.ts +3 -0
  602. package/modules/treemap.js +53 -41
  603. package/modules/treemap.js.map +1 -1
  604. package/modules/treemap.src.d.ts +3 -0
  605. package/modules/treemap.src.js +1039 -95
  606. package/modules/variable-pie.js +9 -9
  607. package/modules/variable-pie.js.map +1 -1
  608. package/modules/variable-pie.src.js +11 -2
  609. package/modules/variwide.js +12 -12
  610. package/modules/variwide.js.map +1 -1
  611. package/modules/variwide.src.js +11 -2
  612. package/modules/vector.js +8 -7
  613. package/modules/vector.js.map +1 -1
  614. package/modules/vector.src.js +11 -2
  615. package/modules/venn.js +31 -31
  616. package/modules/venn.js.map +1 -1
  617. package/modules/venn.src.js +18 -6
  618. package/modules/windbarb.js +15 -15
  619. package/modules/windbarb.js.map +1 -1
  620. package/modules/windbarb.src.js +11 -2
  621. package/modules/wordcloud.js +23 -23
  622. package/modules/wordcloud.js.map +1 -1
  623. package/modules/wordcloud.src.js +18 -6
  624. package/modules/xrange.js +16 -16
  625. package/modules/xrange.js.map +1 -1
  626. package/modules/xrange.src.js +11 -2
  627. package/package.json +1 -1
  628. package/themes/avocado.js +4 -3
  629. package/themes/avocado.js.map +1 -1
  630. package/themes/avocado.src.js +11 -2
  631. package/themes/brand-dark.js +9 -8
  632. package/themes/brand-dark.js.map +1 -1
  633. package/themes/brand-dark.src.js +11 -2
  634. package/themes/brand-light.js +8 -8
  635. package/themes/brand-light.js.map +1 -1
  636. package/themes/brand-light.src.js +11 -2
  637. package/themes/dark-blue.js +9 -8
  638. package/themes/dark-blue.js.map +1 -1
  639. package/themes/dark-blue.src.js +11 -2
  640. package/themes/dark-green.js +9 -8
  641. package/themes/dark-green.js.map +1 -1
  642. package/themes/dark-green.src.js +11 -2
  643. package/themes/dark-unica.js +8 -7
  644. package/themes/dark-unica.js.map +1 -1
  645. package/themes/dark-unica.src.js +11 -2
  646. package/themes/gray.js +9 -8
  647. package/themes/gray.js.map +1 -1
  648. package/themes/gray.src.js +11 -2
  649. package/themes/grid-light.js +5 -4
  650. package/themes/grid-light.js.map +1 -1
  651. package/themes/grid-light.src.js +11 -2
  652. package/themes/grid.js +5 -5
  653. package/themes/grid.js.map +1 -1
  654. package/themes/grid.src.js +11 -2
  655. package/themes/high-contrast-dark.js +7 -7
  656. package/themes/high-contrast-dark.js.map +1 -1
  657. package/themes/high-contrast-dark.src.js +21 -12
  658. package/themes/high-contrast-light.js +3 -3
  659. package/themes/high-contrast-light.js.map +1 -1
  660. package/themes/high-contrast-light.src.js +21 -12
  661. package/themes/sand-signika.js +5 -5
  662. package/themes/sand-signika.js.map +1 -1
  663. package/themes/sand-signika.src.js +11 -2
  664. package/themes/skies.js +5 -5
  665. package/themes/skies.js.map +1 -1
  666. package/themes/skies.src.js +11 -2
  667. package/themes/sunset.js +3 -3
  668. package/themes/sunset.js.map +1 -1
  669. package/themes/sunset.src.js +11 -2
  670. package/es-modules/Maps/ProjectionDefinition.js +0 -9
@@ -89,6 +89,31 @@ export type AxisTickPositionerCallbackFunction = (this: Axis) => AxisTickPositio
89
89
  export type AxisTitleAlignValue = ("high"|"low"|"middle");
90
90
  export type AxisTitleOptions = (XAxisTitleOptions|YAxisTitleOptions|ZAxisTitleOptions);
91
91
  export type AxisTypeValue = ("category"|"datetime"|"linear"|"logarithmic"|"treegrid");
92
+ /**
93
+ * Callback function to react on button clicks.
94
+ *
95
+ * @param event
96
+ * Event.
97
+ *
98
+ * @param options
99
+ * Breadcrumb options.
100
+ *
101
+ * @param e
102
+ * Event arguments.
103
+ */
104
+ export type BreadcrumbsClickCallbackFunction = (event: Event, options: BreadcrumbOptions, e: Event) => void;
105
+ /**
106
+ * Callback function to format the breadcrumb text from scratch.
107
+ *
108
+ * @param event
109
+ * Event.
110
+ *
111
+ * @param options
112
+ * Breadcrumb options.
113
+ *
114
+ * @return Formatted text or false
115
+ */
116
+ export type BreadcrumbsFormatterCallbackFunction = (event: Event, options: BreadcrumbOptions) => string;
92
117
  export type BubbleSizeByValue = ("area"|"width");
93
118
  export type ButtonRelativeToValue = ("plotBox"|"spacingBox");
94
119
  /**
@@ -428,6 +453,7 @@ export type NumberFormatterCallbackFunction = (number: number, decimals: number,
428
453
  export type ObjectEachCallbackFunction<T> = (this: T, value: any, key: string, obj: any) => void;
429
454
  export type OptionsApproximationValue = ("barnes-hut"|"none");
430
455
  export type OptionsBoostBlendingValue = ("add"|"darken"|"multiply");
456
+ export type OptionsCompareValue = ("percent"|"value");
431
457
  export type OptionsDataClassColorValue = ("category"|"tween");
432
458
  export type OptionsDateFormatValue = ("dd/mm/YY"|"dd/mm/YYYY"|"mm/dd/YY"|"mm/dd/YYYY"|"YYYY/mm/dd");
433
459
  export type OptionsDropdownValue = ("always"|"never"|"responsive");
@@ -453,6 +479,7 @@ export type OptionsPlacementStrategyValue = ("center"|"random");
453
479
  export type OptionsPointIntervalUnitValue = ("day"|"month"|"year");
454
480
  export type OptionsPointValKeyValue = ("close"|"high"|"low");
455
481
  export type OptionsPosition3dValue = ("chart"|"flap"|"offset"|"ortho");
482
+ export type OptionsRelativeToValue = ("mapBoundingBox"|"plotBox");
456
483
  export type OptionsRotationModeValue = ("auto"|"circular"|"parallel"|"perpendicular");
457
484
  export type OptionsRotationOriginValue = ("center"|"end"|"start");
458
485
  export type OptionsSpiralValue = ("archimedean"|"rectangular"|"square");
@@ -462,9 +489,16 @@ export type OptionsTextAlignValue = ("center"|"left"|"right");
462
489
  export type OptionsTickmarkPlacementValue = ("between"|"on");
463
490
  export type OptionsTickPositionValue = ("inside"|"outside");
464
491
  export type OptionsTypeValue = ("x"|"xy"|"y"|"LineString"|"MultiLineString"|"MultiPolygon"|"Polygon");
492
+ export type OptionsUnitsValue = ("percent"|"pixels");
465
493
  export type OptionsUnitValue = ("percentage"|"pixels"|"weight");
466
494
  export type OptionsZoomKeyValue = ("alt"|"ctrl"|"meta"|"shift");
467
495
  export type OptionsZoomTypeValue = ("x"|"xy"|"y");
496
+ /**
497
+ * Indent translation value for the child nodes in an organization chart, when
498
+ * parent has `hanging` layout. Option can shrink nodes (for tight charts),
499
+ * translate children to the left, or render nodes directly under the parent.
500
+ */
501
+ export type OrganizationHangingIndentTranslationValue = ("cumulative"|"inherit"|"shrink");
468
502
  export type PaneBackgroundShapeValue = ("arc"|"circle"|"solid");
469
503
  /**
470
504
  * The default pathfinder algorithm to use for a chart. It is possible to define
@@ -894,6 +928,10 @@ export type TooltipFormatterCallbackFunction = (this: TooltipFormatterContextObj
894
928
  */
895
929
  export type TooltipPositionerCallbackFunction = (this: Tooltip, labelWidth: number, labelHeight: number, point: TooltipPositionerPointObject) => PositionObject;
896
930
  export type TooltipShapeValue = ("callout"|"circle"|"square");
931
+ /**
932
+ * A TopoJSON object, see description on the project's GitHub page.
933
+ */
934
+ export type TopoJSON = object;
897
935
  export type VariablePieSizeByValue = ("area"|"radius");
898
936
  /**
899
937
  * The vertical alignment of an element.
@@ -2000,6 +2038,11 @@ export interface AnnotationsEventsOptions {
2000
2038
  * is updated (e.g. drag and droppped or resized by control points).
2001
2039
  */
2002
2040
  afterUpdate?: EventCallbackFunction<Annotation>;
2041
+ /**
2042
+ * (Highcharts, Highstock, Highmaps, Gantt) Fires when the annotation is
2043
+ * clicked.
2044
+ */
2045
+ click?: EventCallbackFunction<Annotation>;
2003
2046
  /**
2004
2047
  * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
2005
2048
  * is removed from the chart.
@@ -5059,6 +5102,24 @@ export interface BoostOptions {
5059
5102
  * (Highcharts, Highstock) Enable or disable boost on a chart.
5060
5103
  */
5061
5104
  enabled?: boolean;
5105
+ /**
5106
+ * (Highcharts, Highstock) The pixel ratio for the WebGL content. If 0, the
5107
+ * `window.devicePixelRatio` is used. This ensures sharp graphics on high
5108
+ * DPI displays like Apple's Retina, as well as when a page is zoomed.
5109
+ *
5110
+ * The default is left at 1 for now, as this is a new feature that has the
5111
+ * potential to break existing setups. Over time, when it has been battle
5112
+ * tested, the intention is to set it to 0 by default.
5113
+ *
5114
+ * Another use case for this option is to set it to 2 in order to make
5115
+ * exported and upscaled charts render sharp.
5116
+ *
5117
+ * One limitation when using the `pixelRatio` is that the line width of
5118
+ * graphs is scaled down. Since the Boost module currently can only render
5119
+ * 1px line widths, it is scaled down to a thin 0.5 pixels on a Retina
5120
+ * display.
5121
+ */
5122
+ pixelRatio?: number;
5062
5123
  /**
5063
5124
  * (Highcharts, Highstock) Set the series threshold for when the boost
5064
5125
  * should kick in globally.
@@ -5096,6 +5157,40 @@ export interface BoostOptions {
5096
5157
  */
5097
5158
  usePreallocated?: boolean;
5098
5159
  }
5160
+ /**
5161
+ * Options for the one breadcrumb.
5162
+ */
5163
+ export interface BreadcrumbOptions {
5164
+ /**
5165
+ * Level connected to a specific breadcrumb.
5166
+ */
5167
+ level: number;
5168
+ /**
5169
+ * Options for series or point connected to a specific breadcrumb.
5170
+ */
5171
+ levelOptions: (PointOptionsObject|SeriesOptions);
5172
+ }
5173
+ /**
5174
+ * Options for aligning breadcrumbs group.
5175
+ */
5176
+ export interface BreadcrumbsAlignOptions {
5177
+ /**
5178
+ * Align of a Breadcrumb group.
5179
+ */
5180
+ align: AlignValue;
5181
+ /**
5182
+ * Vertical align of a Breadcrumb group.
5183
+ */
5184
+ verticalAlign: VerticalAlignValue;
5185
+ /**
5186
+ * X offset of a Breadcrumbs group.
5187
+ */
5188
+ x: number;
5189
+ /**
5190
+ * Y offset of a Breadcrumbs group.
5191
+ */
5192
+ y: number;
5193
+ }
5099
5194
  export interface BubbleLegendFormatterContextObject {
5100
5195
  /**
5101
5196
  * The center y position of the range.
@@ -5565,7 +5660,20 @@ export interface ChartIsInsideOptionsObject {
5565
5660
  */
5566
5661
  export interface ChartOptions {
5567
5662
  /**
5568
- * (Highcharts, Highstock, Gantt) When using multiple axis, the ticks of two
5663
+ * (Highcharts, Highstock, Gantt) When using multiple axes, align the
5664
+ * thresholds. When this is true, other ticks will also be aligned.
5665
+ *
5666
+ * Note that for line series and some other series types, the `threshold`
5667
+ * option is set to `null` by default. This will in turn cause their y-axis
5668
+ * to not have a threshold. In order to avoid that, set the series
5669
+ * `threshold` to 0 or another number.
5670
+ *
5671
+ * If `startOnTick` or `endOnTick` in the axis options are set to false, or
5672
+ * if the axis is logarithmic, the threshold will not be aligned.
5673
+ */
5674
+ alignThresholds?: object;
5675
+ /**
5676
+ * (Highcharts, Highstock, Gantt) When using multiple axes, the ticks of two
5569
5677
  * or more opposite axes will automatically be aligned by adding ticks to
5570
5678
  * the axis or axes with the least ticks, as if `tickAmount` were specified.
5571
5679
  *
@@ -5573,8 +5681,8 @@ export interface ChartOptions {
5573
5681
  * look messy, it's a good idea to hide them for the secondary axis by
5574
5682
  * setting `gridLineWidth` to 0.
5575
5683
  *
5576
- * If `startOnTick` or `endOnTick` in an Axis options are set to false, then
5577
- * the `alignTicks ` will be disabled for the Axis.
5684
+ * If `startOnTick` or `endOnTick` in the axis options are set to false,
5685
+ * then the `alignTicks ` will be disabled for the axis.
5578
5686
  *
5579
5687
  * Disabled for logarithmic axes.
5580
5688
  */
@@ -5672,11 +5780,14 @@ export interface ChartOptions {
5672
5780
  */
5673
5781
  inverted?: boolean;
5674
5782
  /**
5675
- * (Highmaps) Default `mapData` for all series. If set to a string, it
5676
- * functions as an index into the `Highcharts.maps` array. Otherwise it is
5677
- * interpreted as map data.
5783
+ * (Highmaps) Default `mapData` for all series, in terms of a GeoJSON or
5784
+ * TopoJSON object. If set to a string, it functions as an index into the
5785
+ * `Highcharts.maps` array.
5786
+ *
5787
+ * For picking out individual shapes and geometries to use for each series
5788
+ * of the map, see series.mapData.
5678
5789
  */
5679
- map?: (string|GeoJSON|Array<any>);
5790
+ map?: (string|GeoJSON|TopoJSON|Array<any>);
5680
5791
  /**
5681
5792
  * (Highmaps) Set lat/lon transformation definitions for the chart. If not
5682
5793
  * defined, these are extracted from the map data.
@@ -5947,8 +6058,8 @@ export interface ChartOptions {
5947
6058
  */
5948
6059
  zoomKey?: OptionsZoomKeyValue;
5949
6060
  /**
5950
- * (Highcharts, Highstock, Gantt) Decides in what dimensions the user can
5951
- * zoom by dragging the mouse. Can be one of `x`, `y` or `xy`.
6061
+ * (Highcharts, Highstock, Highmaps, Gantt) Decides in what dimensions the
6062
+ * user can zoom by dragging the mouse. Can be one of `x`, `y` or `xy`.
5952
6063
  */
5953
6064
  zoomType?: OptionsZoomTypeValue;
5954
6065
  }
@@ -9089,7 +9200,8 @@ export interface DragDropGuideBoxOptionsObject {
9089
9200
  zIndex?: number;
9090
9201
  }
9091
9202
  /**
9092
- * (Highcharts, Highstock, Gantt) Options for the drag handles.
9203
+ * (Highcharts, Highstock, Gantt) Options for the drag handles available in
9204
+ * column series.
9093
9205
  */
9094
9206
  export interface DragDropHandleOptionsObject {
9095
9207
  /**
@@ -9170,56 +9282,151 @@ export interface DrilldownActiveDataLabelStyleOptions {
9170
9282
  textDecoration?: string;
9171
9283
  }
9172
9284
  /**
9173
- * (Highcharts, Highmaps) Options for the drill up button that appears when
9174
- * drilling down on a series. The text for the button is defined in
9175
- * lang.drillUpText.
9285
+ * (Highcharts) A collection of attributes for the buttons. The object takes SVG
9286
+ * attributes like `fill`, `stroke`, `stroke-width`, as well as `style`, a
9287
+ * collection of CSS properties for the text.
9288
+ *
9289
+ * The object can also be extended with states, so you can set presentational
9290
+ * options for `hover`, `select` or `disabled` button states.
9176
9291
  */
9177
- export interface DrilldownDrillUpButtonOptions {
9292
+ export interface DrilldownBreadcrumbsButtonThemeOptions {
9293
+ style?: DrilldownBreadcrumbsButtonThemeStyleOptions;
9294
+ }
9295
+ export interface DrilldownBreadcrumbsButtonThemeStyleOptions {
9296
+ color?: string;
9297
+ }
9298
+ export interface DrilldownBreadcrumbsEventsOptions {
9178
9299
  /**
9179
- * (Highcharts, Highmaps) Positioning options for the button within the
9180
- * `relativeTo` box. Available properties are `x`, `y`, `align` and
9181
- * `verticalAlign`.
9300
+ * (Highcharts) Fires when clicking on the breadcrumbs button. Two arguments
9301
+ * are passed to the function. First breadcrumb button as an SVG element.
9302
+ * Second is the breadcrumbs class, containing reference to the chart,
9303
+ * series etc. (see online documentation for example)
9304
+ *
9305
+ * Return false to stop default buttons click action.
9306
+ */
9307
+ click?: BreadcrumbsClickCallbackFunction;
9308
+ }
9309
+ /**
9310
+ * (Highcharts) Options for the breadcrumbs, the navigation at the top leading
9311
+ * the way up through the drilldown levels.
9312
+ */
9313
+ export interface DrilldownBreadcrumbsOptions {
9314
+ /**
9315
+ * (Highcharts) The default padding for each button and separator in each
9316
+ * direction.
9182
9317
  */
9183
- position?: (AlignObject|DrilldownDrillUpButtonPositionOptions);
9318
+ buttonSpacing?: number;
9319
+ /**
9320
+ * (Highcharts) A collection of attributes for the buttons. The object takes
9321
+ * SVG attributes like `fill`, `stroke`, `stroke-width`, as well as `style`,
9322
+ * a collection of CSS properties for the text.
9323
+ *
9324
+ * The object can also be extended with states, so you can set
9325
+ * presentational options for `hover`, `select` or `disabled` button states.
9326
+ */
9327
+ buttonTheme?: (DrilldownBreadcrumbsButtonThemeOptions|SVGAttributes);
9328
+ events?: DrilldownBreadcrumbsEventsOptions;
9329
+ /**
9330
+ * (Highcharts) When the breadcrumbs are floating, the plot area will not
9331
+ * move to make space for it. By default, the chart will not make space for
9332
+ * the buttons. This property won't work when positioned in the middle.
9333
+ */
9334
+ floating?: boolean;
9335
+ /**
9336
+ * (Highcharts) A format string for the breadcrumbs button. Variables are
9337
+ * enclosed by curly brackets. Available values are passed in the declared
9338
+ * point options.
9339
+ */
9340
+ format?: (string|undefined);
9341
+ /**
9342
+ * (Highcharts) Callback function to format the breadcrumb text from
9343
+ * scratch.
9344
+ */
9345
+ formatter?: BreadcrumbsFormatterCallbackFunction;
9346
+ /**
9347
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
9348
+ * buttons will be aligned properly for the default chart layout (title,
9349
+ * subtitle, legend, range selector) for the custom chart layout set the
9350
+ * position properties.
9351
+ */
9352
+ position?: (BreadcrumbsAlignOptions|DrilldownBreadcrumbsPositionOptions);
9184
9353
  /**
9185
9354
  * (Highcharts, Highmaps) What box to align the button to. Can be either
9186
9355
  * `plotBox` or `spacingBox`.
9187
9356
  */
9188
9357
  relativeTo?: ButtonRelativeToValue;
9189
9358
  /**
9190
- * (Highcharts, Highmaps) A collection of attributes for the button. The
9191
- * object takes SVG attributes like `fill`, `stroke`, `stroke-width` or `r`,
9192
- * the border radius. The theme also supports `style`, a collection of CSS
9193
- * properties for the text. Equivalent attributes for the hover state are
9194
- * given in `theme.states.hover`.
9359
+ * (Highcharts) Options object for Breadcrumbs separator.
9360
+ */
9361
+ separator?: DrilldownBreadcrumbsSeparatorOptions;
9362
+ /**
9363
+ * (Highcharts) Show full path or only a single button.
9364
+ */
9365
+ showFullPath?: boolean;
9366
+ /**
9367
+ * (Highcharts) CSS styles for all breadcrumbs.
9195
9368
  *
9196
- * In styled mode, drill-up button styles can be applied with the
9197
- * `.highcharts-drillup-button` class.
9369
+ * In styled mode, the breadcrumbs buttons are styled by the
9370
+ * `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its
9371
+ * different states.
9198
9372
  */
9199
- theme?: object;
9373
+ style?: SVGAttributes;
9374
+ /**
9375
+ * (Highcharts) Whether to use HTML to render the breadcrumbs items texts.
9376
+ */
9377
+ useHTML?: boolean;
9378
+ /**
9379
+ * (Highcharts) The z index of the breadcrumbs group.
9380
+ */
9381
+ zIndex?: number;
9200
9382
  }
9201
9383
  /**
9202
- * (Highcharts, Highmaps) Positioning options for the button within the
9203
- * `relativeTo` box. Available properties are `x`, `y`, `align` and
9204
- * `verticalAlign`.
9384
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
9385
+ * buttons will be aligned properly for the default chart layout (title,
9386
+ * subtitle, legend, range selector) for the custom chart layout set the
9387
+ * position properties.
9205
9388
  */
9206
- export interface DrilldownDrillUpButtonPositionOptions {
9389
+ export interface DrilldownBreadcrumbsPositionOptions {
9207
9390
  /**
9208
- * (Highcharts, Highmaps) Horizontal alignment.
9391
+ * (Highcharts, Highmaps) Horizontal alignment of the breadcrumbs buttons.
9209
9392
  */
9210
9393
  align?: AlignValue;
9211
9394
  /**
9212
- * (Highcharts, Highmaps) Vertical alignment of the button.
9395
+ * (Highcharts, Highmaps) Vertical alignment of the breadcrumbs buttons.
9213
9396
  */
9214
9397
  verticalAlign?: VerticalAlignValue;
9215
9398
  /**
9216
- * (Highcharts, Highmaps) The X offset of the button.
9399
+ * (Highcharts, Highmaps) The X offset of the breadcrumbs button group.
9217
9400
  */
9218
9401
  x?: number;
9219
9402
  /**
9220
- * (Highcharts, Highmaps) The Y offset of the button.
9403
+ * (Highcharts, Highmaps) The Y offset of the breadcrumbs button group. When
9404
+ * `undefined`, and `floating` is `false`, the `y` position is adapted so
9405
+ * that the breadcrumbs are rendered outside the target area.
9221
9406
  */
9222
- y?: number;
9407
+ y?: (number|undefined);
9408
+ }
9409
+ /**
9410
+ * (Highcharts) Options object for Breadcrumbs separator.
9411
+ */
9412
+ export interface DrilldownBreadcrumbsSeparatorOptions {
9413
+ /**
9414
+ * (Highcharts) CSS styles for the breadcrumbs separator.
9415
+ *
9416
+ * In styled mode, the breadcrumbs separators are styled by the
9417
+ * `.highcharts-separator` rule with its different states.
9418
+ */
9419
+ style?: (CSSObject|DrilldownBreadcrumbsSeparatorStyleOptions);
9420
+ text?: string;
9421
+ }
9422
+ /**
9423
+ * (Highcharts) CSS styles for the breadcrumbs separator.
9424
+ *
9425
+ * In styled mode, the breadcrumbs separators are styled by the
9426
+ * `.highcharts-separator` rule with its different states.
9427
+ */
9428
+ export interface DrilldownBreadcrumbsSeparatorStyleOptions {
9429
+ color?: string;
9223
9430
  }
9224
9431
  /**
9225
9432
  * The event arguments when a drilldown point is clicked.
@@ -9313,11 +9520,10 @@ export interface DrilldownOptions {
9313
9520
  */
9314
9521
  animation?: (boolean|Partial<AnimationOptionsObject>);
9315
9522
  /**
9316
- * (Highcharts, Highmaps) Options for the drill up button that appears when
9317
- * drilling down on a series. The text for the button is defined in
9318
- * lang.drillUpText.
9523
+ * (Highcharts) Options for the breadcrumbs, the navigation at the top
9524
+ * leading the way up through the drilldown levels.
9319
9525
  */
9320
- drillUpButton?: DrilldownDrillUpButtonOptions;
9526
+ breadcrumbs?: DrilldownBreadcrumbsOptions;
9321
9527
  /**
9322
9528
  * (Highcharts, Highmaps) An array of series configurations for the drill
9323
9529
  * down. Each series configuration uses the same syntax as the series option
@@ -9722,6 +9928,20 @@ export interface ExportingOptions {
9722
9928
  * is not a separate button).
9723
9929
  */
9724
9930
  menuItemDefinitions?: Dictionary<ExportingMenuObject>;
9931
+ /**
9932
+ * (Highcharts, Highstock, Highmaps, Gantt) Settings for a custom font for
9933
+ * the exported PDF, when using the `offline-exporting` module. This is used
9934
+ * for languages containing non-ASCII characters, like Chinese, Russian,
9935
+ * Japanese etc.
9936
+ *
9937
+ * As described in the jsPDF docs, the 14 standard fonts in PDF are limited
9938
+ * to the ASCII-codepage. Therefore, in order to support other text in the
9939
+ * exported PDF, one or more TTF font files have to be passed on to the
9940
+ * exporting module.
9941
+ *
9942
+ * See more in the docs.
9943
+ */
9944
+ pdfFont?: ExportingPdfFontOptions;
9725
9945
  /**
9726
9946
  * (Highcharts, Highstock, Highmaps, Gantt) When printing the chart from the
9727
9947
  * menu item in the burger menu, if the on-screen chart exceeds this width,
@@ -9791,6 +10011,40 @@ export interface ExportingOptions {
9791
10011
  */
9792
10012
  width?: number;
9793
10013
  }
10014
+ /**
10015
+ * (Highcharts, Highstock, Highmaps, Gantt) Settings for a custom font for the
10016
+ * exported PDF, when using the `offline-exporting` module. This is used for
10017
+ * languages containing non-ASCII characters, like Chinese, Russian, Japanese
10018
+ * etc.
10019
+ *
10020
+ * As described in the jsPDF docs, the 14 standard fonts in PDF are limited to
10021
+ * the ASCII-codepage. Therefore, in order to support other text in the exported
10022
+ * PDF, one or more TTF font files have to be passed on to the exporting module.
10023
+ *
10024
+ * See more in the docs.
10025
+ */
10026
+ export interface ExportingPdfFontOptions {
10027
+ /**
10028
+ * (Highcharts, Highstock, Highmaps, Gantt) The TTF font file for bold text.
10029
+ */
10030
+ bold?: (string|undefined);
10031
+ /**
10032
+ * (Highcharts, Highstock, Highmaps, Gantt) The TTF font file for bold and
10033
+ * italic text.
10034
+ */
10035
+ bolditalic?: (string|undefined);
10036
+ /**
10037
+ * (Highcharts, Highstock, Highmaps, Gantt) The TTF font file for italic
10038
+ * text.
10039
+ */
10040
+ italic?: (string|undefined);
10041
+ /**
10042
+ * (Highcharts, Highstock, Highmaps, Gantt) The TTF font file for normal
10043
+ * `font-style`. If font variations like `bold` or `italic` are not defined,
10044
+ * the `normal` font will be used for those too.
10045
+ */
10046
+ normal?: (string|undefined);
10047
+ }
9794
10048
  /**
9795
10049
  * The returned object literal from the Highcharts.Axis#getExtremes function.
9796
10050
  */
@@ -10937,7 +11191,7 @@ export interface LangOptions {
10937
11191
  * down, linking back to the parent series. The parent series' name is
10938
11192
  * inserted for `{series.name}`.
10939
11193
  */
10940
- drillUpText?: string;
11194
+ drillUpText?: object;
10941
11195
  /**
10942
11196
  * (Highcharts, Highstock, Highmaps, Gantt) Exporting module only. The text
10943
11197
  * for the menu item to exit the chart from full screen.
@@ -10962,6 +11216,7 @@ export interface LangOptions {
10962
11216
  * `chart.showLoading`.
10963
11217
  */
10964
11218
  loading?: string;
11219
+ mainBreadcrumb?: string;
10965
11220
  /**
10966
11221
  * (Highcharts, Highstock, Highmaps, Gantt) An array containing the months
10967
11222
  * names. Corresponds to the `%B` format in `Highcharts.dateFormat()`.
@@ -11986,6 +12241,138 @@ export interface MapNavigationOptions {
11986
12241
  */
11987
12242
  mouseWheelSensitivity?: number;
11988
12243
  }
12244
+ /**
12245
+ * (Highmaps) Generic options for the placement and appearance of map insets
12246
+ * like non-contiguous territories.
12247
+ */
12248
+ export interface MapViewInsetOptions {
12249
+ /**
12250
+ * (Highmaps) The border color of the insets.
12251
+ */
12252
+ borderColor?: ColorType;
12253
+ /**
12254
+ * (Highmaps) The pixel border width of the insets.
12255
+ */
12256
+ borderWidth?: number;
12257
+ /**
12258
+ * (Highmaps) The padding of the insets. Can be either a number of pixels, a
12259
+ * percentage string, or an array of either. If an array is given, it sets
12260
+ * the top, right, bottom, left paddings respectively.
12261
+ */
12262
+ padding?: (number|string|Array<(number|string)>);
12263
+ /**
12264
+ * (Highmaps) What coordinate system the `field` and `borderPath` should
12265
+ * relate to. If `plotBox`, they will be fixed to the plot box and
12266
+ * responsively move in relation to the main map. If `mapBoundingBox`, they
12267
+ * will be fixed to the map bounding box, which is constant and centered in
12268
+ * different chart sizes and ratios.
12269
+ */
12270
+ relativeTo?: OptionsRelativeToValue;
12271
+ /**
12272
+ * (Highmaps) What units to use for the `field` and `borderPath` geometries.
12273
+ * If `percent` (default), they relate to the box given in `relativeTo`. If
12274
+ * `pixels`, they are absolute values.
12275
+ */
12276
+ units?: OptionsUnitsValue;
12277
+ }
12278
+ /**
12279
+ * (Highmaps) The individual MapView insets, typically used for non-contiguous
12280
+ * areas of a country. Each item inherits from the generic `insetOptions`.
12281
+ *
12282
+ * Some of the TopoJSON files of the Highcharts Map Collection include a
12283
+ * property called `hc-recommended-mapview`, and some of these include insets.
12284
+ * In order to override the recommended inset options, an inset option with a
12285
+ * matching id can be applied, and it will be merged into the embedded settings.
12286
+ */
12287
+ export interface MapViewInsetsOptions {
12288
+ /**
12289
+ * (Highmaps) The border color of the insets.
12290
+ */
12291
+ borderColor?: ColorType;
12292
+ /**
12293
+ * (Highmaps) A geometry object of type `MultiLineString` defining the
12294
+ * border path of the inset in terms of `units`. If undefined, a border is
12295
+ * rendered around the `field` geometry. It is recommended that the
12296
+ * `borderPath` partly follows the outline of the `field` in order to make
12297
+ * pointer positioning consistent.
12298
+ */
12299
+ borderPath?: (object|undefined);
12300
+ /**
12301
+ * (Highmaps) The pixel border width of the insets.
12302
+ */
12303
+ borderWidth?: number;
12304
+ /**
12305
+ * (Highmaps) A geometry object of type `Polygon` defining where in the
12306
+ * chart the inset should be rendered, in terms of `units` and relative to
12307
+ * the `relativeTo` setting. If a `borderPath` is omitted, a border is
12308
+ * rendered around the field. If undefined, the inset is rendered in the
12309
+ * full plot area.
12310
+ */
12311
+ field?: (object|undefined);
12312
+ /**
12313
+ * (Highmaps) A geometry object of type `Polygon` encircling the shapes that
12314
+ * should be rendered in the inset, in terms of geographic coordinates.
12315
+ * Geometries within this geometry are removed from the default map view and
12316
+ * rendered in the inset.
12317
+ */
12318
+ geoBounds?: object;
12319
+ /**
12320
+ * (Highmaps) The id of the inset, used for internal reference.
12321
+ */
12322
+ id?: string;
12323
+ /**
12324
+ * (Highmaps) The padding of the insets. Can be either a number of pixels, a
12325
+ * percentage string, or an array of either. If an array is given, it sets
12326
+ * the top, right, bottom, left paddings respectively.
12327
+ */
12328
+ padding?: (number|string|Array<(number|string)>);
12329
+ /**
12330
+ * (Highmaps) The projection options for the inset.
12331
+ */
12332
+ projection?: (object|MapViewInsetsProjectionOptions);
12333
+ /**
12334
+ * (Highmaps) What coordinate system the `field` and `borderPath` should
12335
+ * relate to. If `plotBox`, they will be fixed to the plot box and
12336
+ * responsively move in relation to the main map. If `mapBoundingBox`, they
12337
+ * will be fixed to the map bounding box, which is constant and centered in
12338
+ * different chart sizes and ratios.
12339
+ */
12340
+ relativeTo?: OptionsRelativeToValue;
12341
+ /**
12342
+ * (Highmaps) What units to use for the `field` and `borderPath` geometries.
12343
+ * If `percent` (default), they relate to the box given in `relativeTo`. If
12344
+ * `pixels`, they are absolute values.
12345
+ */
12346
+ units?: OptionsUnitsValue;
12347
+ }
12348
+ /**
12349
+ * (Highmaps) The projection options for the inset.
12350
+ */
12351
+ export interface MapViewInsetsProjectionOptions {
12352
+ /**
12353
+ * (Highmaps) Projection name. Built-in projections are `EqualEarth`,
12354
+ * `LambertConformalConic`, `Miller`, `Orthographic` and `WebMercator`.
12355
+ */
12356
+ name?: string;
12357
+ /**
12358
+ * (Highmaps) The two standard parallels that define the map layout in conic
12359
+ * projections, like the LambertConformalConic projection. If only one
12360
+ * number is given, the second parallel will be the same as the first.
12361
+ */
12362
+ parallels?: Array<number>;
12363
+ /**
12364
+ * (Highmaps) Rotation of the projection in terms of degrees `[lambda, phi,
12365
+ * gamma]`. When given, a three-axis spherical rotation is be applied to the
12366
+ * globe prior to the projection.
12367
+ *
12368
+ * * `lambda` shifts the longitudes by the given value.
12369
+ *
12370
+ * * `phi` shifts the latitudes by the given value. Can be omitted.
12371
+ *
12372
+ * * `gamma` applies a _roll_. Can be omitted.
12373
+ */
12374
+ rotation?: string;
12375
+ }
11989
12376
  /**
11990
12377
  * (Highmaps) The `mapView` options control the initial view of the chart, and
11991
12378
  * how projection is set up for raw geoJSON maps (beta as of v9.3).
@@ -11995,10 +12382,27 @@ export interface MapNavigationOptions {
11995
12382
  export interface MapViewOptions {
11996
12383
  /**
11997
12384
  * (Highmaps) The center of the map in terms of longitude and latitude. For
11998
- * preprojected maps (like in Map Collection v1.x), the units are projected
11999
- * x and y units.
12385
+ * preprojected maps (like the GeoJSON files in Map Collection v1.x), the
12386
+ * units are projected x and y units.
12000
12387
  */
12001
12388
  center?: LonLatArray;
12389
+ /**
12390
+ * (Highmaps) Generic options for the placement and appearance of map insets
12391
+ * like non-contiguous territories.
12392
+ */
12393
+ insetOptions?: MapViewInsetOptions;
12394
+ /**
12395
+ * (Highmaps) The individual MapView insets, typically used for
12396
+ * non-contiguous areas of a country. Each item inherits from the generic
12397
+ * `insetOptions`.
12398
+ *
12399
+ * Some of the TopoJSON files of the Highcharts Map Collection include a
12400
+ * property called `hc-recommended-mapview`, and some of these include
12401
+ * insets. In order to override the recommended inset options, an inset
12402
+ * option with a matching id can be applied, and it will be merged into the
12403
+ * embedded settings.
12404
+ */
12405
+ insets?: (MapViewInsetsOptions|Array<object>);
12002
12406
  /**
12003
12407
  * (Highmaps) Prevents the end user from zooming too far in on the map. See
12004
12408
  * zoom.
@@ -12009,25 +12413,13 @@ export interface MapViewOptions {
12009
12413
  * bounds. A number signifies pixels, and a percentage is relative to the
12010
12414
  * plot area size.
12011
12415
  */
12012
- padding?: number;
12416
+ padding?: (number|string|Array<(number|string)>);
12013
12417
  /**
12014
- * (Highmaps) Beta feature in v9.3. The projection options allow applying
12015
- * client side projection to a map given in coordinates, typically from
12016
- * TopoJSON or GeoJSON.
12017
- *
12018
- * Sub-options are:
12019
- *
12020
- * * `name`, which as of v9.3 can be `EqualEarth`, `LambertConformalConic`,
12021
- * `Miller`, `Orthographic` or `WebMercator`.
12022
- *
12023
- * * `parallels`, the standard parallels for the LambertConformalConic
12024
- * projection.
12025
- *
12026
- * * `rotation`, a three-axis rotation of the globe prior to projection,
12027
- * which in practice can be used for example to render a world map with the
12028
- * Americas centered (`[90, 0]`), or to rotate an orthographic projection.
12418
+ * (Highmaps) The projection options allow applying client side projection
12419
+ * to a map given in geographic coordinates, typically from TopoJSON or
12420
+ * GeoJSON.
12029
12421
  */
12030
- projection?: object;
12422
+ projection?: (object|MapViewProjectionOptions);
12031
12423
  /**
12032
12424
  * (Highmaps) The zoom level of a map. Higher zoom levels means more zoomed
12033
12425
  * in. An increase of 1 zooms in to a quarter of the viewed area (half the
@@ -12038,6 +12430,35 @@ export interface MapViewOptions {
12038
12430
  */
12039
12431
  zoom?: (number|undefined);
12040
12432
  }
12433
+ /**
12434
+ * (Highmaps) The projection options allow applying client side projection to a
12435
+ * map given in geographic coordinates, typically from TopoJSON or GeoJSON.
12436
+ */
12437
+ export interface MapViewProjectionOptions {
12438
+ /**
12439
+ * (Highmaps) Projection name. Built-in projections are `EqualEarth`,
12440
+ * `LambertConformalConic`, `Miller`, `Orthographic` and `WebMercator`.
12441
+ */
12442
+ name?: string;
12443
+ /**
12444
+ * (Highmaps) The two standard parallels that define the map layout in conic
12445
+ * projections, like the LambertConformalConic projection. If only one
12446
+ * number is given, the second parallel will be the same as the first.
12447
+ */
12448
+ parallels?: Array<number>;
12449
+ /**
12450
+ * (Highmaps) Rotation of the projection in terms of degrees `[lambda, phi,
12451
+ * gamma]`. When given, a three-axis spherical rotation is be applied to the
12452
+ * globe prior to the projection.
12453
+ *
12454
+ * * `lambda` shifts the longitudes by the given value.
12455
+ *
12456
+ * * `phi` shifts the latitudes by the given value. Can be omitted.
12457
+ *
12458
+ * * `gamma` applies a _roll_. Can be omitted.
12459
+ */
12460
+ rotation?: string;
12461
+ }
12041
12462
  /**
12042
12463
  * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
12043
12464
  * animation when a series is displayed for the `annotation`. The animation can
@@ -12070,6 +12491,11 @@ export interface NavigationAnnotationsEventsOptions {
12070
12491
  * is updated (e.g. drag and droppped or resized by control points).
12071
12492
  */
12072
12493
  afterUpdate?: EventCallbackFunction<Annotation>;
12494
+ /**
12495
+ * (Highcharts, Highstock, Highmaps, Gantt) Fires when the annotation is
12496
+ * clicked.
12497
+ */
12498
+ click?: EventCallbackFunction<Annotation>;
12073
12499
  /**
12074
12500
  * (Highcharts, Highstock, Highmaps, Gantt) Event callback when annotation
12075
12501
  * is removed from the chart.
@@ -13259,6 +13685,155 @@ export interface NavigationBindingsSeriesTypeHLCOptions {
13259
13685
  export interface NavigationBindingsTimeCyclesOptions {
13260
13686
  className?: string;
13261
13687
  }
13688
+ /**
13689
+ * (Highcharts) A collection of attributes for the buttons. The object takes SVG
13690
+ * attributes like `fill`, `stroke`, `stroke-width`, as well as `style`, a
13691
+ * collection of CSS properties for the text.
13692
+ *
13693
+ * The object can also be extended with states, so you can set presentational
13694
+ * options for `hover`, `select` or `disabled` button states.
13695
+ */
13696
+ export interface NavigationBreadcrumbsButtonThemeOptions {
13697
+ style?: NavigationBreadcrumbsButtonThemeStyleOptions;
13698
+ }
13699
+ export interface NavigationBreadcrumbsButtonThemeStyleOptions {
13700
+ color?: string;
13701
+ }
13702
+ export interface NavigationBreadcrumbsEventsOptions {
13703
+ /**
13704
+ * (Highcharts) Fires when clicking on the breadcrumbs button. Two arguments
13705
+ * are passed to the function. First breadcrumb button as an SVG element.
13706
+ * Second is the breadcrumbs class, containing reference to the chart,
13707
+ * series etc. (see online documentation for example)
13708
+ *
13709
+ * Return false to stop default buttons click action.
13710
+ */
13711
+ click?: BreadcrumbsClickCallbackFunction;
13712
+ }
13713
+ /**
13714
+ * (Highcharts) Options for breadcrumbs. Breadcrumbs general options are defined
13715
+ * in `navigation.breadcrumbs`. Specific options for drilldown are set in
13716
+ * `drilldown.breadcrumbs` and for tree-like series traversing, in
13717
+ * `plotOptions[series].breadcrumbs`.
13718
+ */
13719
+ export interface NavigationBreadcrumbsOptions {
13720
+ /**
13721
+ * (Highcharts) The default padding for each button and separator in each
13722
+ * direction.
13723
+ */
13724
+ buttonSpacing?: number;
13725
+ /**
13726
+ * (Highcharts) A collection of attributes for the buttons. The object takes
13727
+ * SVG attributes like `fill`, `stroke`, `stroke-width`, as well as `style`,
13728
+ * a collection of CSS properties for the text.
13729
+ *
13730
+ * The object can also be extended with states, so you can set
13731
+ * presentational options for `hover`, `select` or `disabled` button states.
13732
+ */
13733
+ buttonTheme?: (NavigationBreadcrumbsButtonThemeOptions|SVGAttributes);
13734
+ events?: NavigationBreadcrumbsEventsOptions;
13735
+ /**
13736
+ * (Highcharts) When the breadcrumbs are floating, the plot area will not
13737
+ * move to make space for it. By default, the chart will not make space for
13738
+ * the buttons. This property won't work when positioned in the middle.
13739
+ */
13740
+ floating?: boolean;
13741
+ /**
13742
+ * (Highcharts) A format string for the breadcrumbs button. Variables are
13743
+ * enclosed by curly brackets. Available values are passed in the declared
13744
+ * point options.
13745
+ */
13746
+ format?: (string|undefined);
13747
+ /**
13748
+ * (Highcharts) Callback function to format the breadcrumb text from
13749
+ * scratch.
13750
+ */
13751
+ formatter?: BreadcrumbsFormatterCallbackFunction;
13752
+ /**
13753
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
13754
+ * buttons will be aligned properly for the default chart layout (title,
13755
+ * subtitle, legend, range selector) for the custom chart layout set the
13756
+ * position properties.
13757
+ */
13758
+ position?: (BreadcrumbsAlignOptions|NavigationBreadcrumbsPositionOptions);
13759
+ /**
13760
+ * (Highcharts, Highmaps) What box to align the button to. Can be either
13761
+ * `plotBox` or `spacingBox`.
13762
+ */
13763
+ relativeTo?: ButtonRelativeToValue;
13764
+ /**
13765
+ * (Highcharts) Options object for Breadcrumbs separator.
13766
+ */
13767
+ separator?: NavigationBreadcrumbsSeparatorOptions;
13768
+ /**
13769
+ * (Highcharts) Show full path or only a single button.
13770
+ */
13771
+ showFullPath?: boolean;
13772
+ /**
13773
+ * (Highcharts) CSS styles for all breadcrumbs.
13774
+ *
13775
+ * In styled mode, the breadcrumbs buttons are styled by the
13776
+ * `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its
13777
+ * different states.
13778
+ */
13779
+ style?: SVGAttributes;
13780
+ /**
13781
+ * (Highcharts) Whether to use HTML to render the breadcrumbs items texts.
13782
+ */
13783
+ useHTML?: boolean;
13784
+ /**
13785
+ * (Highcharts) The z index of the breadcrumbs group.
13786
+ */
13787
+ zIndex?: number;
13788
+ }
13789
+ /**
13790
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
13791
+ * buttons will be aligned properly for the default chart layout (title,
13792
+ * subtitle, legend, range selector) for the custom chart layout set the
13793
+ * position properties.
13794
+ */
13795
+ export interface NavigationBreadcrumbsPositionOptions {
13796
+ /**
13797
+ * (Highcharts, Highmaps) Horizontal alignment of the breadcrumbs buttons.
13798
+ */
13799
+ align?: AlignValue;
13800
+ /**
13801
+ * (Highcharts, Highmaps) Vertical alignment of the breadcrumbs buttons.
13802
+ */
13803
+ verticalAlign?: VerticalAlignValue;
13804
+ /**
13805
+ * (Highcharts, Highmaps) The X offset of the breadcrumbs button group.
13806
+ */
13807
+ x?: number;
13808
+ /**
13809
+ * (Highcharts, Highmaps) The Y offset of the breadcrumbs button group. When
13810
+ * `undefined`, and `floating` is `false`, the `y` position is adapted so
13811
+ * that the breadcrumbs are rendered outside the target area.
13812
+ */
13813
+ y?: (number|undefined);
13814
+ }
13815
+ /**
13816
+ * (Highcharts) Options object for Breadcrumbs separator.
13817
+ */
13818
+ export interface NavigationBreadcrumbsSeparatorOptions {
13819
+ /**
13820
+ * (Highcharts) CSS styles for the breadcrumbs separator.
13821
+ *
13822
+ * In styled mode, the breadcrumbs separators are styled by the
13823
+ * `.highcharts-separator` rule with its different states.
13824
+ */
13825
+ style?: (CSSObject|NavigationBreadcrumbsSeparatorStyleOptions);
13826
+ text?: string;
13827
+ }
13828
+ /**
13829
+ * (Highcharts) CSS styles for the breadcrumbs separator.
13830
+ *
13831
+ * In styled mode, the breadcrumbs separators are styled by the
13832
+ * `.highcharts-separator` rule with its different states.
13833
+ */
13834
+ export interface NavigationBreadcrumbsSeparatorStyleOptions {
13835
+ color?: string;
13836
+ }
13262
13837
  export interface NavigationButtonOptions {
13263
13838
  /**
13264
13839
  * (Highcharts, Highstock, Highmaps, Gantt) Whether to enable buttons.
@@ -13346,6 +13921,13 @@ export interface NavigationOptions {
13346
13921
  * Default value of versions < 7.0.4 `highcharts-bindings-wrapper`
13347
13922
  */
13348
13923
  bindingsClassName?: string;
13924
+ /**
13925
+ * (Highcharts) Options for breadcrumbs. Breadcrumbs general options are
13926
+ * defined in `navigation.breadcrumbs`. Specific options for drilldown are
13927
+ * set in `drilldown.breadcrumbs` and for tree-like series traversing, in
13928
+ * `plotOptions[series].breadcrumbs`.
13929
+ */
13930
+ breadcrumbs?: NavigationBreadcrumbsOptions;
13349
13931
  buttonOptions?: NavigationButtonOptions;
13350
13932
  /**
13351
13933
  * (Highcharts, Highstock) Events to communicate between Stock Tools and
@@ -18535,7 +19117,7 @@ export interface PlotAdOptions {
18535
19117
  * the development of the series against each other. Adds a `change` field
18536
19118
  * to every point object.
18537
19119
  */
18538
- compare?: string;
19120
+ compare?: OptionsCompareValue;
18539
19121
  /**
18540
19122
  * (Highstock) When compare is `percent`, this option dictates whether to
18541
19123
  * use 0 or 100 as the base of comparison.
@@ -19422,7 +20004,7 @@ export interface PlotAoOptions {
19422
20004
  * the development of the series against each other. Adds a `change` field
19423
20005
  * to every point object.
19424
20006
  */
19425
- compare?: string;
20007
+ compare?: OptionsCompareValue;
19426
20008
  /**
19427
20009
  * (Highstock) When compare is `percent`, this option dictates whether to
19428
20010
  * use 0 or 100 as the base of comparison.
@@ -20307,7 +20889,7 @@ export interface PlotApoOptions {
20307
20889
  * the development of the series against each other. Adds a `change` field
20308
20890
  * to every point object.
20309
20891
  */
20310
- compare?: string;
20892
+ compare?: OptionsCompareValue;
20311
20893
  /**
20312
20894
  * (Highstock) When compare is `percent`, this option dictates whether to
20313
20895
  * use 0 or 100 as the base of comparison.
@@ -20713,6 +21295,602 @@ export interface PlotApoParamsOptions {
20713
21295
  */
20714
21296
  periods?: Array<number>;
20715
21297
  }
21298
+ /**
21299
+ * (Highcharts) Point accessibility options for a series.
21300
+ */
21301
+ export interface PlotArcdiagramAccessibilityPointOptions {
21302
+ /**
21303
+ * (Highcharts) Date format to use for points on datetime axes when
21304
+ * describing them to screen reader users.
21305
+ *
21306
+ * Defaults to the same format as in tooltip.
21307
+ *
21308
+ * For an overview of the replacement codes, see dateFormat.
21309
+ */
21310
+ dateFormat?: string;
21311
+ /**
21312
+ * (Highcharts) Formatter function to determine the date/time format used
21313
+ * with points on datetime axes when describing them to screen reader users.
21314
+ * Receives one argument, `point`, referring to the point to describe.
21315
+ * Should return a date format string compatible with dateFormat.
21316
+ */
21317
+ dateFormatter?: ScreenReaderFormatterCallbackFunction<Point>;
21318
+ /**
21319
+ * (Highcharts) Formatter function to use instead of the default for point
21320
+ * descriptions. Same as `accessibility.point.descriptionFormatter`, but
21321
+ * applies to a series instead of the whole chart.
21322
+ *
21323
+ * Note: Prefer using accessibility.point.valueDescriptionFormat instead if
21324
+ * possible, as default functionality such as describing annotations will be
21325
+ * preserved.
21326
+ */
21327
+ descriptionFormatter?: ScreenReaderFormatterCallbackFunction<Point>;
21328
+ /**
21329
+ * (Highcharts) Decimals to use for the values in the point descriptions.
21330
+ * Uses tooltip.valueDecimals if not defined.
21331
+ */
21332
+ valueDecimals?: number;
21333
+ /**
21334
+ * (Highcharts) Format to use for describing the values of data points to
21335
+ * assistive technology - including screen readers. The point context is
21336
+ * available as `{point}`.
21337
+ *
21338
+ * Additionally, the series name, annotation info, and description added in
21339
+ * `point.accessibility.description` is added by default if relevant. To
21340
+ * override this, use the accessibility.point.descriptionFormatter option.
21341
+ */
21342
+ valueDescriptionFormat?: string;
21343
+ /**
21344
+ * (Highcharts) Prefix to add to the values in the point descriptions. Uses
21345
+ * tooltip.valuePrefix if not defined.
21346
+ */
21347
+ valuePrefix?: string;
21348
+ /**
21349
+ * (Highcharts) Suffix to add to the values in the point descriptions. Uses
21350
+ * tooltip.valueSuffix if not defined.
21351
+ */
21352
+ valueSuffix?: string;
21353
+ }
21354
+ /**
21355
+ * (Highcharts) Enable or disable the initial animation when a series is
21356
+ * displayed. The animation can also be set as a configuration object. Please
21357
+ * note that this option only applies to the initial animation of the series
21358
+ * itself. For other animations, see chart.animation and the animation parameter
21359
+ * under the API methods. The following properties are supported:
21360
+ *
21361
+ * - `defer`: The animation delay time in milliseconds.
21362
+ *
21363
+ * - `duration`: The duration of the animation in milliseconds.
21364
+ *
21365
+ * - `easing`: Can be a string reference to an easing function set on the `Math`
21366
+ * object or a function. See the _Custom easing function_ demo below.
21367
+ *
21368
+ * Due to poor performance, animation is disabled in old IE browsers for several
21369
+ * chart types.
21370
+ */
21371
+ export interface PlotArcdiagramAnimationOptions {
21372
+ defer?: number;
21373
+ }
21374
+ /**
21375
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
21376
+ * animation when a series is displayed for the `dataLabels`. The animation can
21377
+ * also be set as a configuration object. Please note that this option only
21378
+ * applies to the initial animation. For other animations, see chart.animation
21379
+ * and the animation parameter under the API methods. The following properties
21380
+ * are supported:
21381
+ *
21382
+ * - `defer`: The animation delay time in milliseconds.
21383
+ */
21384
+ export interface PlotArcdiagramDataLabelsAnimationOptions {
21385
+ /**
21386
+ * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
21387
+ * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
21388
+ * inherits defer time from the series.animation.defer.
21389
+ */
21390
+ defer?: number;
21391
+ }
21392
+ export interface PlotArcdiagramDataLabelsLinkTextPathAttributesOptions {
21393
+ startOffset?: string;
21394
+ }
21395
+ /**
21396
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for a _link_ label text
21397
+ * which should follow link connection. Border and background are disabled for a
21398
+ * label that follows a path.
21399
+ *
21400
+ * **Note:** Only SVG-based renderer supports this option. Setting `useHTML` to
21401
+ * true will disable this option.
21402
+ */
21403
+ export interface PlotArcdiagramDataLabelsLinkTextPathOptions {
21404
+ attributes?: PlotArcdiagramDataLabelsLinkTextPathAttributesOptions;
21405
+ }
21406
+ /**
21407
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
21408
+ * animation when a series is displayed for the `dataLabels`. The animation can
21409
+ * also be set as a configuration object. Please note that this option only
21410
+ * applies to the initial animation. For other animations, see chart.animation
21411
+ * and the animation parameter under the API methods. The following properties
21412
+ * are supported:
21413
+ *
21414
+ * - `defer`: The animation delay time in milliseconds.
21415
+ */
21416
+ export interface PlotArcdiagramLevelsDataLabelsAnimationOptions {
21417
+ /**
21418
+ * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
21419
+ * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
21420
+ * inherits defer time from the series.animation.defer.
21421
+ */
21422
+ defer?: number;
21423
+ }
21424
+ /**
21425
+ * (Highcharts) Set options on specific levels. Takes precedence over series
21426
+ * options, but not node and link options.
21427
+ */
21428
+ export interface PlotArcdiagramLevelsOptions {
21429
+ /**
21430
+ * (Highcharts) Can set `borderColor` on all nodes which lay on the same
21431
+ * level.
21432
+ */
21433
+ borderColor?: ColorString;
21434
+ /**
21435
+ * (Highcharts) Can set `borderWidth` on all nodes which lay on the same
21436
+ * level.
21437
+ */
21438
+ borderWidth?: number;
21439
+ /**
21440
+ * (Highcharts) Can set `color` on all nodes which lay on the same level.
21441
+ */
21442
+ color?: (ColorString|GradientColorObject|PatternObject);
21443
+ /**
21444
+ * (Highcharts) Can set `colorByPoint` on all nodes which lay on the same
21445
+ * level.
21446
+ */
21447
+ colorByPoint?: boolean;
21448
+ /**
21449
+ * (Highcharts, Highstock, Highmaps, Gantt) Can set `dataLabels` on all
21450
+ * points which lay on the same level.
21451
+ */
21452
+ dataLabels?: (SeriesSankeyDataLabelsOptionsObject|Array<SeriesSankeyDataLabelsOptionsObject>);
21453
+ /**
21454
+ * (Highcharts) Decides which level takes effect from the options set in the
21455
+ * levels object.
21456
+ */
21457
+ level?: number;
21458
+ /**
21459
+ * (Highcharts) Can set `linkOpacity` on all points which lay on the same
21460
+ * level.
21461
+ */
21462
+ linkOpacity?: number;
21463
+ /**
21464
+ * (Highcharts) Can set `states` on all nodes and points which lay on the
21465
+ * same level.
21466
+ */
21467
+ states?: SeriesStatesOptionsObject;
21468
+ }
21469
+ /**
21470
+ * (Highcharts) Arc diagram series is a chart drawing style in which the
21471
+ * vertices of the chart are positioned along a line on the Euclidean plane and
21472
+ * the edges are drawn as a semicircle in one of the two half-planes delimited
21473
+ * by the line, or as smooth curves formed by sequences of semicircles.
21474
+ *
21475
+ * In TypeScript the type option must always be set.
21476
+ *
21477
+ * Configuration options for the series are given in three levels:
21478
+ *
21479
+ * 1. Options for all series in a chart are defined in the plotOptions.series
21480
+ * object.
21481
+ *
21482
+ * 2. Options for all `arcdiagram` series are defined in plotOptions.arcdiagram.
21483
+ *
21484
+ * 3. Options for one single series are given in the series instance array. (see
21485
+ * online documentation for example)
21486
+ */
21487
+ export interface PlotArcdiagramOptions {
21488
+ /**
21489
+ * (Highcharts) Accessibility options for a series.
21490
+ */
21491
+ accessibility?: SeriesAccessibilityOptionsObject;
21492
+ /**
21493
+ * (Highmaps) Whether all areas of the map defined in `mapData` should be
21494
+ * rendered. If `true`, areas which don't correspond to a data point, are
21495
+ * rendered as `null` points. If `false`, those areas are skipped.
21496
+ */
21497
+ allAreas?: boolean;
21498
+ /**
21499
+ * (Highcharts) Allow this series' points to be selected by clicking on the
21500
+ * graphic (columns, point markers, pie slices, map areas etc).
21501
+ *
21502
+ * The selected points can be handled by point select and unselect events,
21503
+ * or collectively by the getSelectedPoints function.
21504
+ *
21505
+ * And alternative way of selecting points is through dragging.
21506
+ */
21507
+ allowPointSelect?: boolean;
21508
+ /**
21509
+ * (Highcharts) Enable or disable the initial animation when a series is
21510
+ * displayed. The animation can also be set as a configuration object.
21511
+ * Please note that this option only applies to the initial animation of the
21512
+ * series itself. For other animations, see chart.animation and the
21513
+ * animation parameter under the API methods. The following properties are
21514
+ * supported:
21515
+ *
21516
+ * - `defer`: The animation delay time in milliseconds.
21517
+ *
21518
+ * - `duration`: The duration of the animation in milliseconds.
21519
+ *
21520
+ * - `easing`: Can be a string reference to an easing function set on the
21521
+ * `Math` object or a function. See the _Custom easing function_ demo below.
21522
+ *
21523
+ * Due to poor performance, animation is disabled in old IE browsers for
21524
+ * several chart types.
21525
+ */
21526
+ animation?: (boolean|PlotArcdiagramAnimationOptions|Partial<AnimationOptionsObject>);
21527
+ /**
21528
+ * (Highcharts, Highstock, Gantt) The color of the border surrounding each
21529
+ * column or bar.
21530
+ *
21531
+ * In styled mode, the border stroke can be set with the `.highcharts-point`
21532
+ * rule.
21533
+ */
21534
+ borderColor?: (ColorString|GradientColorObject|PatternObject);
21535
+ /**
21536
+ * (Highcharts, Highstock, Gantt) The width of the border surrounding each
21537
+ * column or bar. Defaults to `1` when there is room for a border, but to
21538
+ * `0` when the columns are so dense that a border would cover the next
21539
+ * column.
21540
+ *
21541
+ * In styled mode, the stroke width can be set with the `.highcharts-point`
21542
+ * rule.
21543
+ */
21544
+ borderWidth?: number;
21545
+ /**
21546
+ * (Highcharts) The option to center links rather than position them one
21547
+ * after another
21548
+ */
21549
+ centeredLinks?: boolean;
21550
+ /**
21551
+ * (Highcharts) An additional class name to apply to the series' graphical
21552
+ * elements. This option does not replace default class names of the
21553
+ * graphical element.
21554
+ */
21555
+ className?: string;
21556
+ /**
21557
+ * (Highcharts) Disable this option to allow series rendering in the whole
21558
+ * plotting area.
21559
+ *
21560
+ * **Note:** Clipping should be always enabled when chart.zoomType is set
21561
+ */
21562
+ clip?: boolean;
21563
+ /**
21564
+ * (Highcharts) The main color of the series. In line type series it applies
21565
+ * to the line and the point markers unless otherwise specified. In bar type
21566
+ * series it applies to the bars unless a color is specified per point. The
21567
+ * default value is pulled from the `options.colors` array.
21568
+ *
21569
+ * In styled mode, the color can be defined by the colorIndex option. Also,
21570
+ * the series color can be set with the `.highcharts-series`,
21571
+ * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
21572
+ * `.highcharts-series-{n}` class, or individual classes given by the
21573
+ * `className` option.
21574
+ */
21575
+ color?: (ColorString|GradientColorObject|PatternObject);
21576
+ /**
21577
+ * (Highcharts, Highstock, Gantt) When using automatic point colors pulled
21578
+ * from the global colors or series-specific plotOptions.column.colors
21579
+ * collections, this option determines whether the chart should receive one
21580
+ * color per series or one color per point.
21581
+ *
21582
+ * In styled mode, the `colors` or `series.colors` arrays are not supported,
21583
+ * and instead this option gives the points individual color class names on
21584
+ * the form `highcharts-color-{n}`.
21585
+ */
21586
+ colorByPoint?: boolean;
21587
+ /**
21588
+ * (Highcharts) Styled mode only. A specific color index to use for the
21589
+ * series, so its graphic representations are given the class name
21590
+ * `highcharts-color-{n}`.
21591
+ */
21592
+ colorIndex?: number;
21593
+ /**
21594
+ * (Highcharts, Highstock, Gantt) A series specific or series type specific
21595
+ * color set to apply instead of the global colors when colorByPoint is
21596
+ * true.
21597
+ */
21598
+ colors?: Array<(ColorString|GradientColorObject|PatternObject)>;
21599
+ /**
21600
+ * (Highstock) Compare the values of the series against the first non-null,
21601
+ * non- zero value in the visible range. The y axis will show percentage or
21602
+ * absolute change depending on whether `compare` is set to `"percent"` or
21603
+ * `"value"`. When this is applied to multiple series, it allows comparing
21604
+ * the development of the series against each other. Adds a `change` field
21605
+ * to every point object.
21606
+ */
21607
+ compare?: OptionsCompareValue;
21608
+ /**
21609
+ * (Highstock) When compare is `percent`, this option dictates whether to
21610
+ * use 0 or 100 as the base of comparison.
21611
+ */
21612
+ compareBase?: (0|100);
21613
+ /**
21614
+ * (Highstock) Defines if comparison should start from the first point
21615
+ * within the visible range or should start from the first point **before**
21616
+ * the range.
21617
+ *
21618
+ * In other words, this flag determines if first point within the visible
21619
+ * range will have 0% (`compareStart=true`) or should have been already
21620
+ * calculated according to the previous point (`compareStart=false`).
21621
+ */
21622
+ compareStart?: boolean;
21623
+ /**
21624
+ * (Gantt) Override Pathfinder connector options for a series. Requires
21625
+ * Highcharts Gantt to be loaded.
21626
+ */
21627
+ connectors?: SeriesConnectorsOptionsObject;
21628
+ /**
21629
+ * (Highstock) Cumulative Sum feature replaces points' values with the
21630
+ * following formula: `sum of all previous points' values + current point's
21631
+ * value`. Works only for points in a visible range. Adds the
21632
+ * `cumulativeSum` field to each point object that can be accessed e.g. in
21633
+ * the tooltip.pointFormat.
21634
+ */
21635
+ cumulative?: boolean;
21636
+ /**
21637
+ * (Highcharts) You can set the cursor to "pointer" if you have click events
21638
+ * attached to the series, to signal to the user that the points and lines
21639
+ * can be clicked.
21640
+ *
21641
+ * In styled mode, the series cursor can be set with the same classes as
21642
+ * listed under series.color.
21643
+ */
21644
+ cursor?: (string|CursorValue);
21645
+ /**
21646
+ * (Highcharts) A reserved subspace to store options and values for
21647
+ * customized functionality. Here you can add additional data for your own
21648
+ * event callbacks and formatter callbacks.
21649
+ */
21650
+ custom?: Dictionary<any>;
21651
+ /**
21652
+ * (Highcharts) Name of the dash style to use for the graph, or for some
21653
+ * series types the outline of each shape.
21654
+ *
21655
+ * In styled mode, the stroke dash-array can be set with the same classes as
21656
+ * listed under series.color.
21657
+ */
21658
+ dashStyle?: DashStyleValue;
21659
+ /**
21660
+ * (Highstock) Data grouping is the concept of sampling the data values into
21661
+ * larger blocks in order to ease readability and increase performance of
21662
+ * the JavaScript charts. Highcharts Stock by default applies data grouping
21663
+ * when the points become closer than a certain pixel value, determined by
21664
+ * the `groupPixelWidth` option.
21665
+ *
21666
+ * If data grouping is applied, the grouping information of grouped points
21667
+ * can be read from the Point.dataGroup. If point options other than the
21668
+ * data itself are set, for example `name` or `color` or custom properties,
21669
+ * the grouping logic doesn't know how to group it. In this case the options
21670
+ * of the first point instance are copied over to the group point. This can
21671
+ * be altered through a custom `approximation` callback function.
21672
+ */
21673
+ dataGrouping?: DataGroupingOptionsObject;
21674
+ /**
21675
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
21676
+ * appearing on top of the nodes and links. For arc diagram charts, data
21677
+ * labels are visible for the nodes by default, but hidden for links. This
21678
+ * is controlled by modifying the `nodeFormat`, and the `format` that
21679
+ * applies to links and is an empty string by default.
21680
+ */
21681
+ dataLabels?: (SeriesArcDiagramDataLabelsOptionsObject|Array<SeriesArcDiagramDataLabelsOptionsObject>);
21682
+ /**
21683
+ * (Highcharts) A description of the series to add to the screen reader
21684
+ * information about the series.
21685
+ */
21686
+ description?: string;
21687
+ /**
21688
+ * (Highcharts) Enable or disable the mouse tracking for a specific series.
21689
+ * This includes point tooltips and click events on graphs and points. For
21690
+ * large datasets it improves performance.
21691
+ */
21692
+ enableMouseTracking?: boolean;
21693
+ /**
21694
+ * (Highcharts) Whether nodes with different values should have the same
21695
+ * size. If set to true, all nodes are calculated based on the `nodePadding`
21696
+ * and current `plotArea`. It is possible to override it using the
21697
+ * `marker.radius` option.
21698
+ */
21699
+ equalNodes?: boolean;
21700
+ /**
21701
+ * (Highcharts) General event handlers for the series items. These event
21702
+ * hooks can also be attached to the series at run time using the
21703
+ * `Highcharts.addEvent` function.
21704
+ */
21705
+ events?: SeriesEventsOptionsObject;
21706
+ /**
21707
+ * (Highcharts) When set to `false` will prevent the series data from being
21708
+ * included in any form of data export.
21709
+ *
21710
+ * Since version 6.0.0 until 7.1.0 the option was existing undocumented as
21711
+ * `includeInCSVExport`.
21712
+ */
21713
+ includeInDataExport?: boolean;
21714
+ /**
21715
+ * (Highmaps) What property to join the `mapData` to the value data. For
21716
+ * example, if joinBy is "code", the mapData items with a specific code is
21717
+ * merged into the data with the same code. For maps loaded from GeoJSON,
21718
+ * the keys may be held in each point's `properties` object.
21719
+ *
21720
+ * The joinBy option can also be an array of two values, where the first
21721
+ * points to a key in the `mapData`, and the second points to another key in
21722
+ * the `data`.
21723
+ *
21724
+ * When joinBy is `null`, the map items are joined by their position in the
21725
+ * array, which performs much better in maps with many data points. This is
21726
+ * the recommended option if you are printing more than a thousand data
21727
+ * points and have a backend that can preprocess the data into a parallel
21728
+ * array of the mapData.
21729
+ */
21730
+ joinBy?: (string|Array<string>);
21731
+ /**
21732
+ * (Highcharts) An array specifying which option maps to which key in the
21733
+ * data point array. This makes it convenient to work with unstructured data
21734
+ * arrays from different sources.
21735
+ */
21736
+ keys?: Array<string>;
21737
+ /**
21738
+ * (Highcharts, Highstock, Gantt) Series labels are placed as close to the
21739
+ * series as possible in a natural way, seeking to avoid other series. The
21740
+ * goal of this feature is to make the chart more easily readable, like if a
21741
+ * human designer placed the labels in the optimal position.
21742
+ *
21743
+ * The series labels currently work with series types having a `graph` or an
21744
+ * `area`.
21745
+ */
21746
+ label?: SeriesLabelOptionsObject;
21747
+ /**
21748
+ * (Highstock) The line marks the last price from all points.
21749
+ */
21750
+ lastPrice?: SeriesLastPriceOptionsObject;
21751
+ /**
21752
+ * (Highstock) The line marks the last price from visible range of points.
21753
+ */
21754
+ lastVisiblePrice?: SeriesLastVisiblePriceOptionsObject;
21755
+ /**
21756
+ * (Highcharts) Set options on specific levels. Takes precedence over series
21757
+ * options, but not node and link options.
21758
+ */
21759
+ levels?: Array<PlotArcdiagramLevelsOptions>;
21760
+ /**
21761
+ * (Highcharts, Highstock, Gantt) The id of another series to link to.
21762
+ * Additionally, the value can be ":previous" to link to the previous
21763
+ * series. When two series are linked, only the first one appears in the
21764
+ * legend. Toggling the visibility of this also toggles the linked series.
21765
+ *
21766
+ * If master series uses data sorting and linked series does not have its
21767
+ * own sorting definition, the linked series will be sorted in the same
21768
+ * order as the master one.
21769
+ */
21770
+ linkedTo?: string;
21771
+ /**
21772
+ * (Highcharts) Opacity for the links between nodes in the sankey diagram.
21773
+ */
21774
+ linkOpacity?: number;
21775
+ /**
21776
+ * (Highcharts) Options for the point markers of line-like series.
21777
+ * Properties like `fillColor`, `lineColor` and `lineWidth` define the
21778
+ * visual appearance of the markers. Other series types, like column series,
21779
+ * don't have markers, but have visual options on the series level instead.
21780
+ *
21781
+ * In styled mode, the markers can be styled with the `.highcharts-point`,
21782
+ * `.highcharts-point-hover` and `.highcharts-point-select` class names.
21783
+ */
21784
+ marker?: PointMarkerOptionsObject;
21785
+ /**
21786
+ * (Highcharts) The minimal width for a line of a sankey. By default, 0
21787
+ * values are not shown.
21788
+ */
21789
+ minLinkWidth?: number;
21790
+ /**
21791
+ * (Highstock) Options for the corresponding navigator series if
21792
+ * `showInNavigator` is `true` for this series. Available options are the
21793
+ * same as any series, documented at plotOptions and series.
21794
+ *
21795
+ * These options are merged with options in navigator.series, and will take
21796
+ * precedence if the same option is defined both places.
21797
+ */
21798
+ navigatorOptions?: PlotSeriesOptions;
21799
+ /**
21800
+ * (Highcharts) The pixel width of each node in a sankey diagram or
21801
+ * dependency wheel, or the height in case the chart is inverted.
21802
+ */
21803
+ nodeWidth?: number;
21804
+ /**
21805
+ * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
21806
+ * dataLabels.
21807
+ */
21808
+ opacity?: number;
21809
+ /**
21810
+ * (Highcharts) Properties for each single point.
21811
+ */
21812
+ point?: PlotSeriesPointOptions;
21813
+ /**
21814
+ * (Highcharts) Same as accessibility.series.descriptionFormatter, but for
21815
+ * an individual series. Overrides the chart wide configuration.
21816
+ */
21817
+ pointDescriptionFormatter?: Function;
21818
+ /**
21819
+ * (Highcharts) Whether the series should be placed on the other side of the
21820
+ * `plotArea`.
21821
+ */
21822
+ reversed?: boolean;
21823
+ /**
21824
+ * (Highcharts) Whether to select the series initially. If `showCheckbox` is
21825
+ * true, the checkbox next to the series name in the legend will be checked
21826
+ * for a selected series.
21827
+ */
21828
+ selected?: boolean;
21829
+ /**
21830
+ * (Highcharts) If true, a checkbox is displayed next to the legend item to
21831
+ * allow selecting the series. The state of the checkbox is determined by
21832
+ * the `selected` option.
21833
+ */
21834
+ showCheckbox?: boolean;
21835
+ /**
21836
+ * (Highcharts) Whether to display this particular series or series type in
21837
+ * the legend. Standalone series are shown in legend by default, and linked
21838
+ * series are not. Since v7.2.0 it is possible to show series that use
21839
+ * colorAxis by setting this option to `true`.
21840
+ */
21841
+ showInLegend?: boolean;
21842
+ /**
21843
+ * (Highstock) Whether or not to show the series in the navigator. Takes
21844
+ * precedence over navigator.baseSeries if defined.
21845
+ */
21846
+ showInNavigator?: boolean;
21847
+ /**
21848
+ * (Highcharts) If set to `true`, the accessibility module will skip past
21849
+ * the points in this series for keyboard navigation.
21850
+ */
21851
+ skipKeyboardNavigation?: boolean;
21852
+ states?: SeriesStatesOptionsObject;
21853
+ /**
21854
+ * (Highcharts) Sticky tracking of mouse events. When true, the `mouseOut`
21855
+ * event on a series isn't triggered until the mouse moves over another
21856
+ * series, or out of the plot area. When false, the `mouseOut` event on a
21857
+ * series is triggered when the mouse leaves the area around the series'
21858
+ * graph or markers. This also implies the tooltip when not shared. When
21859
+ * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
21860
+ * be hidden when moving the mouse between series. Defaults to true for line
21861
+ * and area type series, but to false for columns, pies etc.
21862
+ *
21863
+ * **Note:** The boost module will force this option because of technical
21864
+ * limitations.
21865
+ */
21866
+ stickyTracking?: boolean;
21867
+ /**
21868
+ * (Highcharts) A configuration object for the tooltip rendering of each
21869
+ * single series. Properties are inherited from tooltip, but only the
21870
+ * following properties can be defined on a series level.
21871
+ */
21872
+ tooltip?: SeriesTooltipOptionsObject;
21873
+ /**
21874
+ * (Highcharts, Highstock, Gantt) When a series contains a data array that
21875
+ * is longer than this, only one dimensional arrays of numbers, or two
21876
+ * dimensional arrays with x and y values are allowed. Also, only the first
21877
+ * point is tested, and the rest are assumed to be the same format. This
21878
+ * saves expensive data checking and indexing in long series. Set it to `0`
21879
+ * disable.
21880
+ *
21881
+ * Note: In boost mode turbo threshold is forced. Only array of numbers or
21882
+ * two dimensional arrays are allowed.
21883
+ */
21884
+ turboThreshold?: number;
21885
+ /**
21886
+ * (Highcharts) Set the initial visibility of the series.
21887
+ */
21888
+ visible?: boolean;
21889
+ /**
21890
+ * (Highmaps) Define the z index of the series.
21891
+ */
21892
+ zIndex?: number;
21893
+ }
20716
21894
  /**
20717
21895
  * (Highcharts, Highstock) Point accessibility options for a series.
20718
21896
  */
@@ -21226,7 +22404,7 @@ export interface PlotAreaOptions {
21226
22404
  * the development of the series against each other. Adds a `change` field
21227
22405
  * to every point object.
21228
22406
  */
21229
- compare?: string;
22407
+ compare?: OptionsCompareValue;
21230
22408
  /**
21231
22409
  * (Highstock) When compare is `percent`, this option dictates whether to
21232
22410
  * use 0 or 100 as the base of comparison.
@@ -22066,7 +23244,7 @@ export interface PlotArearangeOptions {
22066
23244
  * the development of the series against each other. Adds a `change` field
22067
23245
  * to every point object.
22068
23246
  */
22069
- compare?: string;
23247
+ compare?: OptionsCompareValue;
22070
23248
  /**
22071
23249
  * (Highstock) When compare is `percent`, this option dictates whether to
22072
23250
  * use 0 or 100 as the base of comparison.
@@ -23100,7 +24278,7 @@ export interface PlotAreasplineOptions {
23100
24278
  * the development of the series against each other. Adds a `change` field
23101
24279
  * to every point object.
23102
24280
  */
23103
- compare?: string;
24281
+ compare?: OptionsCompareValue;
23104
24282
  /**
23105
24283
  * (Highstock) When compare is `percent`, this option dictates whether to
23106
24284
  * use 0 or 100 as the base of comparison.
@@ -23916,7 +25094,7 @@ export interface PlotAreasplinerangeOptions {
23916
25094
  * the development of the series against each other. Adds a `change` field
23917
25095
  * to every point object.
23918
25096
  */
23919
- compare?: string;
25097
+ compare?: OptionsCompareValue;
23920
25098
  /**
23921
25099
  * (Highstock) When compare is `percent`, this option dictates whether to
23922
25100
  * use 0 or 100 as the base of comparison.
@@ -26699,7 +27877,7 @@ export interface PlotAtrOptions {
26699
27877
  * the development of the series against each other. Adds a `change` field
26700
27878
  * to every point object.
26701
27879
  */
26702
- compare?: string;
27880
+ compare?: OptionsCompareValue;
26703
27881
  /**
26704
27882
  * (Highstock) When compare is `percent`, this option dictates whether to
26705
27883
  * use 0 or 100 as the base of comparison.
@@ -27639,7 +28817,7 @@ export interface PlotBarOptions {
27639
28817
  * the development of the series against each other. Adds a `change` field
27640
28818
  * to every point object.
27641
28819
  */
27642
- compare?: string;
28820
+ compare?: OptionsCompareValue;
27643
28821
  /**
27644
28822
  * (Highstock) When compare is `percent`, this option dictates whether to
27645
28823
  * use 0 or 100 as the base of comparison.
@@ -28653,7 +29831,7 @@ export interface PlotBbOptions {
28653
29831
  * the development of the series against each other. Adds a `change` field
28654
29832
  * to every point object.
28655
29833
  */
28656
- compare?: string;
29834
+ compare?: OptionsCompareValue;
28657
29835
  /**
28658
29836
  * (Highstock) When compare is `percent`, this option dictates whether to
28659
29837
  * use 0 or 100 as the base of comparison.
@@ -29570,7 +30748,7 @@ export interface PlotBellcurveOptions {
29570
30748
  * the development of the series against each other. Adds a `change` field
29571
30749
  * to every point object.
29572
30750
  */
29573
- compare?: string;
30751
+ compare?: OptionsCompareValue;
29574
30752
  /**
29575
30753
  * (Highstock) When compare is `percent`, this option dictates whether to
29576
30754
  * use 0 or 100 as the base of comparison.
@@ -30583,7 +31761,7 @@ export interface PlotBoxplotOptions {
30583
31761
  * the development of the series against each other. Adds a `change` field
30584
31762
  * to every point object.
30585
31763
  */
30586
- compare?: string;
31764
+ compare?: OptionsCompareValue;
30587
31765
  /**
30588
31766
  * (Highstock) When compare is `percent`, this option dictates whether to
30589
31767
  * use 0 or 100 as the base of comparison.
@@ -31692,7 +32870,7 @@ export interface PlotBubbleOptions {
31692
32870
  * the development of the series against each other. Adds a `change` field
31693
32871
  * to every point object.
31694
32872
  */
31695
- compare?: string;
32873
+ compare?: OptionsCompareValue;
31696
32874
  /**
31697
32875
  * (Highstock) When compare is `percent`, this option dictates whether to
31698
32876
  * use 0 or 100 as the base of comparison.
@@ -32142,11 +33320,11 @@ export interface PlotBubbleOptions {
32142
33320
  */
32143
33321
  step?: OptionsStepValue;
32144
33322
  /**
32145
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
32146
- * `mouseOut` event on a series isn't triggered until the mouse moves over
32147
- * another series, or out of the plot area. When false, the `mouseOut` event
32148
- * on a series is triggered when the mouse leaves the area around the
32149
- * series' graph or markers. This also implies the tooltip. When
33323
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
33324
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
33325
+ * moves over another series, or out of the plot area. When false, the
33326
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
33327
+ * around the series' graph or markers. This also implies the tooltip. When
32150
33328
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
32151
33329
  * be hidden when moving the mouse between series.
32152
33330
  */
@@ -33756,7 +34934,7 @@ export interface PlotCandlestickOptions {
33756
34934
  * the development of the series against each other. Adds a `change` field
33757
34935
  * to every point object.
33758
34936
  */
33759
- compare?: string;
34937
+ compare?: OptionsCompareValue;
33760
34938
  /**
33761
34939
  * (Highstock) When compare is `percent`, this option dictates whether to
33762
34940
  * use 0 or 100 as the base of comparison.
@@ -34754,7 +35932,7 @@ export interface PlotCciOptions {
34754
35932
  * the development of the series against each other. Adds a `change` field
34755
35933
  * to every point object.
34756
35934
  */
34757
- compare?: string;
35935
+ compare?: OptionsCompareValue;
34758
35936
  /**
34759
35937
  * (Highstock) When compare is `percent`, this option dictates whether to
34760
35938
  * use 0 or 100 as the base of comparison.
@@ -35635,7 +36813,7 @@ export interface PlotChaikinOptions {
35635
36813
  * the development of the series against each other. Adds a `change` field
35636
36814
  * to every point object.
35637
36815
  */
35638
- compare?: string;
36816
+ compare?: OptionsCompareValue;
35639
36817
  /**
35640
36818
  * (Highstock) When compare is `percent`, this option dictates whether to
35641
36819
  * use 0 or 100 as the base of comparison.
@@ -36519,7 +37697,7 @@ export interface PlotCmfOptions {
36519
37697
  * the development of the series against each other. Adds a `change` field
36520
37698
  * to every point object.
36521
37699
  */
36522
- compare?: string;
37700
+ compare?: OptionsCompareValue;
36523
37701
  /**
36524
37702
  * (Highstock) When compare is `percent`, this option dictates whether to
36525
37703
  * use 0 or 100 as the base of comparison.
@@ -37406,7 +38584,7 @@ export interface PlotCmoOptions {
37406
38584
  * the development of the series against each other. Adds a `change` field
37407
38585
  * to every point object.
37408
38586
  */
37409
- compare?: string;
38587
+ compare?: OptionsCompareValue;
37410
38588
  /**
37411
38589
  * (Highstock) When compare is `percent`, this option dictates whether to
37412
38590
  * use 0 or 100 as the base of comparison.
@@ -38353,7 +39531,7 @@ export interface PlotColumnOptions {
38353
39531
  * the development of the series against each other. Adds a `change` field
38354
39532
  * to every point object.
38355
39533
  */
38356
- compare?: string;
39534
+ compare?: OptionsCompareValue;
38357
39535
  /**
38358
39536
  * (Highstock) When compare is `percent`, this option dictates whether to
38359
39537
  * use 0 or 100 as the base of comparison.
@@ -39378,7 +40556,7 @@ export interface PlotColumnpyramidOptions {
39378
40556
  * the development of the series against each other. Adds a `change` field
39379
40557
  * to every point object.
39380
40558
  */
39381
- compare?: string;
40559
+ compare?: OptionsCompareValue;
39382
40560
  /**
39383
40561
  * (Highstock) When compare is `percent`, this option dictates whether to
39384
40562
  * use 0 or 100 as the base of comparison.
@@ -40132,7 +41310,7 @@ export interface PlotColumnrangeOptions {
40132
41310
  * the development of the series against each other. Adds a `change` field
40133
41311
  * to every point object.
40134
41312
  */
40135
- compare?: string;
41313
+ compare?: OptionsCompareValue;
40136
41314
  /**
40137
41315
  * (Highstock) When compare is `percent`, this option dictates whether to
40138
41316
  * use 0 or 100 as the base of comparison.
@@ -42750,7 +43928,7 @@ export interface PlotDependencywheelOptions {
42750
43928
  * the development of the series against each other. Adds a `change` field
42751
43929
  * to every point object.
42752
43930
  */
42753
- compare?: string;
43931
+ compare?: OptionsCompareValue;
42754
43932
  /**
42755
43933
  * (Highstock) When compare is `percent`, this option dictates whether to
42756
43934
  * use 0 or 100 as the base of comparison.
@@ -43539,7 +44717,7 @@ export interface PlotDisparityindexOptions {
43539
44717
  * the development of the series against each other. Adds a `change` field
43540
44718
  * to every point object.
43541
44719
  */
43542
- compare?: string;
44720
+ compare?: OptionsCompareValue;
43543
44721
  /**
43544
44722
  * (Highstock) When compare is `percent`, this option dictates whether to
43545
44723
  * use 0 or 100 as the base of comparison.
@@ -44457,7 +45635,7 @@ export interface PlotDmiOptions {
44457
45635
  * the development of the series against each other. Adds a `change` field
44458
45636
  * to every point object.
44459
45637
  */
44460
- compare?: string;
45638
+ compare?: OptionsCompareValue;
44461
45639
  /**
44462
45640
  * (Highstock) When compare is `percent`, this option dictates whether to
44463
45641
  * use 0 or 100 as the base of comparison.
@@ -46021,7 +47199,7 @@ export interface PlotDumbbellOptions {
46021
47199
  * the development of the series against each other. Adds a `change` field
46022
47200
  * to every point object.
46023
47201
  */
46024
- compare?: string;
47202
+ compare?: OptionsCompareValue;
46025
47203
  /**
46026
47204
  * (Highstock) When compare is `percent`, this option dictates whether to
46027
47205
  * use 0 or 100 as the base of comparison.
@@ -47020,7 +48198,7 @@ export interface PlotEmaOptions {
47020
48198
  * the development of the series against each other. Adds a `change` field
47021
48199
  * to every point object.
47022
48200
  */
47023
- compare?: string;
48201
+ compare?: OptionsCompareValue;
47024
48202
  /**
47025
48203
  * (Highstock) When compare is `percent`, this option dictates whether to
47026
48204
  * use 0 or 100 as the base of comparison.
@@ -47925,7 +49103,7 @@ export interface PlotErrorbarOptions {
47925
49103
  * the development of the series against each other. Adds a `change` field
47926
49104
  * to every point object.
47927
49105
  */
47928
- compare?: string;
49106
+ compare?: OptionsCompareValue;
47929
49107
  /**
47930
49108
  * (Highstock) When compare is `percent`, this option dictates whether to
47931
49109
  * use 0 or 100 as the base of comparison.
@@ -48963,7 +50141,7 @@ export interface PlotFlagsOptions {
48963
50141
  * the development of the series against each other. Adds a `change` field
48964
50142
  * to every point object.
48965
50143
  */
48966
- compare?: string;
50144
+ compare?: OptionsCompareValue;
48967
50145
  /**
48968
50146
  * (Highstock) When compare is `percent`, this option dictates whether to
48969
50147
  * use 0 or 100 as the base of comparison.
@@ -50721,7 +51899,7 @@ export interface PlotFunnelOptions {
50721
51899
  * the development of the series against each other. Adds a `change` field
50722
51900
  * to every point object.
50723
51901
  */
50724
- compare?: string;
51902
+ compare?: OptionsCompareValue;
50725
51903
  /**
50726
51904
  * (Highstock) When compare is `percent`, this option dictates whether to
50727
51905
  * use 0 or 100 as the base of comparison.
@@ -51577,7 +52755,7 @@ export interface PlotGanttOptions {
51577
52755
  * the development of the series against each other. Adds a `change` field
51578
52756
  * to every point object.
51579
52757
  */
51580
- compare?: string;
52758
+ compare?: OptionsCompareValue;
51581
52759
  /**
51582
52760
  * (Highstock) When compare is `percent`, this option dictates whether to
51583
52761
  * use 0 or 100 as the base of comparison.
@@ -52390,7 +53568,7 @@ export interface PlotGaugeOptions {
52390
53568
  * the development of the series against each other. Adds a `change` field
52391
53569
  * to every point object.
52392
53570
  */
52393
- compare?: string;
53571
+ compare?: OptionsCompareValue;
52394
53572
  /**
52395
53573
  * (Highstock) When compare is `percent`, this option dictates whether to
52396
53574
  * use 0 or 100 as the base of comparison.
@@ -53255,7 +54433,7 @@ export interface PlotHeatmapOptions {
53255
54433
  * the development of the series against each other. Adds a `change` field
53256
54434
  * to every point object.
53257
54435
  */
53258
- compare?: string;
54436
+ compare?: OptionsCompareValue;
53259
54437
  /**
53260
54438
  * (Highstock) When compare is `percent`, this option dictates whether to
53261
54439
  * use 0 or 100 as the base of comparison.
@@ -53548,11 +54726,11 @@ export interface PlotHeatmapOptions {
53548
54726
  skipKeyboardNavigation?: boolean;
53549
54727
  states?: SeriesStatesOptionsObject;
53550
54728
  /**
53551
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
53552
- * `mouseOut` event on a series isn't triggered until the mouse moves over
53553
- * another series, or out of the plot area. When false, the `mouseOut` event
53554
- * on a series is triggered when the mouse leaves the area around the
53555
- * series' graph or markers. This also implies the tooltip. When
54729
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
54730
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
54731
+ * moves over another series, or out of the plot area. When false, the
54732
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
54733
+ * around the series' graph or markers. This also implies the tooltip. When
53556
54734
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
53557
54735
  * be hidden when moving the mouse between series.
53558
54736
  */
@@ -54124,7 +55302,7 @@ export interface PlotHeikinashiOptions {
54124
55302
  * the development of the series against each other. Adds a `change` field
54125
55303
  * to every point object.
54126
55304
  */
54127
- compare?: string;
55305
+ compare?: OptionsCompareValue;
54128
55306
  /**
54129
55307
  * (Highstock) When compare is `percent`, this option dictates whether to
54130
55308
  * use 0 or 100 as the base of comparison.
@@ -55166,7 +56344,7 @@ export interface PlotHistogramOptions {
55166
56344
  * the development of the series against each other. Adds a `change` field
55167
56345
  * to every point object.
55168
56346
  */
55169
- compare?: string;
56347
+ compare?: OptionsCompareValue;
55170
56348
  /**
55171
56349
  * (Highstock) When compare is `percent`, this option dictates whether to
55172
56350
  * use 0 or 100 as the base of comparison.
@@ -56140,7 +57318,7 @@ export interface PlotHlcOptions {
56140
57318
  * the development of the series against each other. Adds a `change` field
56141
57319
  * to every point object.
56142
57320
  */
56143
- compare?: string;
57321
+ compare?: OptionsCompareValue;
56144
57322
  /**
56145
57323
  * (Highstock) When compare is `percent`, this option dictates whether to
56146
57324
  * use 0 or 100 as the base of comparison.
@@ -57144,7 +58322,7 @@ export interface PlotHollowcandlestickOptions {
57144
58322
  * the development of the series against each other. Adds a `change` field
57145
58323
  * to every point object.
57146
58324
  */
57147
- compare?: string;
58325
+ compare?: OptionsCompareValue;
57148
58326
  /**
57149
58327
  * (Highstock) When compare is `percent`, this option dictates whether to
57150
58328
  * use 0 or 100 as the base of comparison.
@@ -58875,7 +60053,7 @@ export interface PlotItemOptions {
58875
60053
  * the development of the series against each other. Adds a `change` field
58876
60054
  * to every point object.
58877
60055
  */
58878
- compare?: string;
60056
+ compare?: OptionsCompareValue;
58879
60057
  /**
58880
60058
  * (Highstock) When compare is `percent`, this option dictates whether to
58881
60059
  * use 0 or 100 as the base of comparison.
@@ -60643,7 +61821,7 @@ export interface PlotKlingerOptions {
60643
61821
  * the development of the series against each other. Adds a `change` field
60644
61822
  * to every point object.
60645
61823
  */
60646
- compare?: string;
61824
+ compare?: OptionsCompareValue;
60647
61825
  /**
60648
61826
  * (Highstock) When compare is `percent`, this option dictates whether to
60649
61827
  * use 0 or 100 as the base of comparison.
@@ -61689,7 +62867,7 @@ export interface PlotLinearregressionangleOptions {
61689
62867
  * the development of the series against each other. Adds a `change` field
61690
62868
  * to every point object.
61691
62869
  */
61692
- compare?: string;
62870
+ compare?: OptionsCompareValue;
61693
62871
  /**
61694
62872
  * (Highstock) When compare is `percent`, this option dictates whether to
61695
62873
  * use 0 or 100 as the base of comparison.
@@ -62888,7 +64066,7 @@ export interface PlotLinearregressioninterceptOptions {
62888
64066
  * the development of the series against each other. Adds a `change` field
62889
64067
  * to every point object.
62890
64068
  */
62891
- compare?: string;
64069
+ compare?: OptionsCompareValue;
62892
64070
  /**
62893
64071
  * (Highstock) When compare is `percent`, this option dictates whether to
62894
64072
  * use 0 or 100 as the base of comparison.
@@ -63451,7 +64629,7 @@ export interface PlotLinearregressionOptions {
63451
64629
  * the development of the series against each other. Adds a `change` field
63452
64630
  * to every point object.
63453
64631
  */
63454
- compare?: string;
64632
+ compare?: OptionsCompareValue;
63455
64633
  /**
63456
64634
  * (Highstock) When compare is `percent`, this option dictates whether to
63457
64635
  * use 0 or 100 as the base of comparison.
@@ -64360,7 +65538,7 @@ export interface PlotLinearregressionslopeOptions {
64360
65538
  * the development of the series against each other. Adds a `change` field
64361
65539
  * to every point object.
64362
65540
  */
64363
- compare?: string;
65541
+ compare?: OptionsCompareValue;
64364
65542
  /**
64365
65543
  * (Highstock) When compare is `percent`, this option dictates whether to
64366
65544
  * use 0 or 100 as the base of comparison.
@@ -65220,7 +66398,7 @@ export interface PlotLineOptions {
65220
66398
  * the development of the series against each other. Adds a `change` field
65221
66399
  * to every point object.
65222
66400
  */
65223
- compare?: string;
66401
+ compare?: OptionsCompareValue;
65224
66402
  /**
65225
66403
  * (Highstock) When compare is `percent`, this option dictates whether to
65226
66404
  * use 0 or 100 as the base of comparison.
@@ -65997,7 +67175,7 @@ export interface PlotLollipopOptions {
65997
67175
  * the development of the series against each other. Adds a `change` field
65998
67176
  * to every point object.
65999
67177
  */
66000
- compare?: string;
67178
+ compare?: OptionsCompareValue;
66001
67179
  /**
66002
67180
  * (Highstock) When compare is `percent`, this option dictates whether to
66003
67181
  * use 0 or 100 as the base of comparison.
@@ -67020,7 +68198,7 @@ export interface PlotMacdOptions {
67020
68198
  * the development of the series against each other. Adds a `change` field
67021
68199
  * to every point object.
67022
68200
  */
67023
- compare?: string;
68201
+ compare?: OptionsCompareValue;
67024
68202
  /**
67025
68203
  * (Highstock) When compare is `percent`, this option dictates whether to
67026
68204
  * use 0 or 100 as the base of comparison.
@@ -68075,7 +69253,7 @@ export interface PlotMapbubbleOptions {
68075
69253
  * the development of the series against each other. Adds a `change` field
68076
69254
  * to every point object.
68077
69255
  */
68078
- compare?: string;
69256
+ compare?: OptionsCompareValue;
68079
69257
  /**
68080
69258
  * (Highstock) When compare is `percent`, this option dictates whether to
68081
69259
  * use 0 or 100 as the base of comparison.
@@ -68294,7 +69472,7 @@ export interface PlotMapbubbleOptions {
68294
69472
  * points and have a backend that can preprocess the data into a parallel
68295
69473
  * array of the mapData.
68296
69474
  */
68297
- joinBy?: (string|Array<string>);
69475
+ joinBy?: string;
68298
69476
  /**
68299
69477
  * (Highmaps) An array specifying which option maps to which key in the data
68300
69478
  * point array. This makes it convenient to work with unstructured data
@@ -68523,11 +69701,11 @@ export interface PlotMapbubbleOptions {
68523
69701
  */
68524
69702
  step?: OptionsStepValue;
68525
69703
  /**
68526
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
68527
- * `mouseOut` event on a series isn't triggered until the mouse moves over
68528
- * another series, or out of the plot area. When false, the `mouseOut` event
68529
- * on a series is triggered when the mouse leaves the area around the
68530
- * series' graph or markers. This also implies the tooltip. When
69704
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
69705
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
69706
+ * moves over another series, or out of the plot area. When false, the
69707
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
69708
+ * around the series' graph or markers. This also implies the tooltip. When
68531
69709
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
68532
69710
  * be hidden when moving the mouse between series.
68533
69711
  */
@@ -69309,6 +70487,11 @@ export interface PlotMaplineOptions {
69309
70487
  * (Highmaps) Accessibility options for a series.
69310
70488
  */
69311
70489
  accessibility?: SeriesAccessibilityOptionsObject;
70490
+ /**
70491
+ * (Highmaps) Whether the MapView takes this series into account when
70492
+ * computing the default zoom and center of the map.
70493
+ */
70494
+ affectsMapView?: boolean;
69312
70495
  /**
69313
70496
  * (Highmaps) Whether all areas of the map defined in `mapData` should be
69314
70497
  * rendered. If `true`, areas which don't correspond to a data point, are
@@ -69444,7 +70627,7 @@ export interface PlotMaplineOptions {
69444
70627
  * the development of the series against each other. Adds a `change` field
69445
70628
  * to every point object.
69446
70629
  */
69447
- compare?: string;
70630
+ compare?: OptionsCompareValue;
69448
70631
  /**
69449
70632
  * (Highstock) When compare is `percent`, this option dictates whether to
69450
70633
  * use 0 or 100 as the base of comparison.
@@ -69867,11 +71050,11 @@ export interface PlotMaplineOptions {
69867
71050
  */
69868
71051
  step?: OptionsStepValue;
69869
71052
  /**
69870
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
69871
- * `mouseOut` event on a series isn't triggered until the mouse moves over
69872
- * another series, or out of the plot area. When false, the `mouseOut` event
69873
- * on a series is triggered when the mouse leaves the area around the
69874
- * series' graph or markers. This also implies the tooltip. When
71053
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
71054
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
71055
+ * moves over another series, or out of the plot area. When false, the
71056
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
71057
+ * around the series' graph or markers. This also implies the tooltip. When
69875
71058
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
69876
71059
  * be hidden when moving the mouse between series.
69877
71060
  */
@@ -69948,6 +71131,11 @@ export interface PlotMapOptions {
69948
71131
  * (Highmaps) Accessibility options for a series.
69949
71132
  */
69950
71133
  accessibility?: SeriesAccessibilityOptionsObject;
71134
+ /**
71135
+ * (Highmaps) Whether the MapView takes this series into account when
71136
+ * computing the default zoom and center of the map.
71137
+ */
71138
+ affectsMapView?: boolean;
69951
71139
  /**
69952
71140
  * (Highmaps) Whether all areas of the map defined in `mapData` should be
69953
71141
  * rendered. If `true`, areas which don't correspond to a data point, are
@@ -70083,7 +71271,7 @@ export interface PlotMapOptions {
70083
71271
  * the development of the series against each other. Adds a `change` field
70084
71272
  * to every point object.
70085
71273
  */
70086
- compare?: string;
71274
+ compare?: OptionsCompareValue;
70087
71275
  /**
70088
71276
  * (Highstock) When compare is `percent`, this option dictates whether to
70089
71277
  * use 0 or 100 as the base of comparison.
@@ -70502,11 +71690,11 @@ export interface PlotMapOptions {
70502
71690
  */
70503
71691
  step?: OptionsStepValue;
70504
71692
  /**
70505
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
70506
- * `mouseOut` event on a series isn't triggered until the mouse moves over
70507
- * another series, or out of the plot area. When false, the `mouseOut` event
70508
- * on a series is triggered when the mouse leaves the area around the
70509
- * series' graph or markers. This also implies the tooltip. When
71693
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
71694
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
71695
+ * moves over another series, or out of the plot area. When false, the
71696
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
71697
+ * around the series' graph or markers. This also implies the tooltip. When
70510
71698
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
70511
71699
  * be hidden when moving the mouse between series.
70512
71700
  */
@@ -71301,7 +72489,7 @@ export interface PlotMappointOptions {
71301
72489
  * the development of the series against each other. Adds a `change` field
71302
72490
  * to every point object.
71303
72491
  */
71304
- compare?: string;
72492
+ compare?: OptionsCompareValue;
71305
72493
  /**
71306
72494
  * (Highstock) When compare is `percent`, this option dictates whether to
71307
72495
  * use 0 or 100 as the base of comparison.
@@ -71718,11 +72906,11 @@ export interface PlotMappointOptions {
71718
72906
  */
71719
72907
  step?: OptionsStepValue;
71720
72908
  /**
71721
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
71722
- * `mouseOut` event on a series isn't triggered until the mouse moves over
71723
- * another series, or out of the plot area. When false, the `mouseOut` event
71724
- * on a series is triggered when the mouse leaves the area around the
71725
- * series' graph or markers. This also implies the tooltip. When
72909
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
72910
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
72911
+ * moves over another series, or out of the plot area. When false, the
72912
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
72913
+ * around the series' graph or markers. This also implies the tooltip. When
71726
72914
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
71727
72915
  * be hidden when moving the mouse between series.
71728
72916
  */
@@ -72263,7 +73451,7 @@ export interface PlotMfiOptions {
72263
73451
  * the development of the series against each other. Adds a `change` field
72264
73452
  * to every point object.
72265
73453
  */
72266
- compare?: string;
73454
+ compare?: OptionsCompareValue;
72267
73455
  /**
72268
73456
  * (Highstock) When compare is `percent`, this option dictates whether to
72269
73457
  * use 0 or 100 as the base of comparison.
@@ -73153,7 +74341,7 @@ export interface PlotMomentumOptions {
73153
74341
  * the development of the series against each other. Adds a `change` field
73154
74342
  * to every point object.
73155
74343
  */
73156
- compare?: string;
74344
+ compare?: OptionsCompareValue;
73157
74345
  /**
73158
74346
  * (Highstock) When compare is `percent`, this option dictates whether to
73159
74347
  * use 0 or 100 as the base of comparison.
@@ -74040,7 +75228,7 @@ export interface PlotNatrOptions {
74040
75228
  * the development of the series against each other. Adds a `change` field
74041
75229
  * to every point object.
74042
75230
  */
74043
- compare?: string;
75231
+ compare?: OptionsCompareValue;
74044
75232
  /**
74045
75233
  * (Highstock) When compare is `percent`, this option dictates whether to
74046
75234
  * use 0 or 100 as the base of comparison.
@@ -74758,7 +75946,7 @@ export interface PlotNetworkgraphOptions {
74758
75946
  * the development of the series against each other. Adds a `change` field
74759
75947
  * to every point object.
74760
75948
  */
74761
- compare?: string;
75949
+ compare?: OptionsCompareValue;
74762
75950
  /**
74763
75951
  * (Highstock) When compare is `percent`, this option dictates whether to
74764
75952
  * use 0 or 100 as the base of comparison.
@@ -75599,7 +76787,7 @@ export interface PlotObvOptions {
75599
76787
  * the development of the series against each other. Adds a `change` field
75600
76788
  * to every point object.
75601
76789
  */
75602
- compare?: string;
76790
+ compare?: OptionsCompareValue;
75603
76791
  /**
75604
76792
  * (Highstock) When compare is `percent`, this option dictates whether to
75605
76793
  * use 0 or 100 as the base of comparison.
@@ -76517,7 +77705,7 @@ export interface PlotOhlcOptions {
76517
77705
  * the development of the series against each other. Adds a `change` field
76518
77706
  * to every point object.
76519
77707
  */
76520
- compare?: string;
77708
+ compare?: OptionsCompareValue;
76521
77709
  /**
76522
77710
  * (Highstock) When compare is `percent`, this option dictates whether to
76523
77711
  * use 0 or 100 as the base of comparison.
@@ -77090,6 +78278,27 @@ export interface PlotOptions {
77090
78278
  * (see online documentation for example)
77091
78279
  */
77092
78280
  apo?: PlotApoOptions;
78281
+ /**
78282
+ * (Highcharts) Arc diagram series is a chart drawing style in which the
78283
+ * vertices of the chart are positioned along a line on the Euclidean plane
78284
+ * and the edges are drawn as a semicircle in one of the two half-planes
78285
+ * delimited by the line, or as smooth curves formed by sequences of
78286
+ * semicircles.
78287
+ *
78288
+ * In TypeScript the type option must always be set.
78289
+ *
78290
+ * Configuration options for the series are given in three levels:
78291
+ *
78292
+ * 1. Options for all series in a chart are defined in the
78293
+ * plotOptions.series object.
78294
+ *
78295
+ * 2. Options for all `arcdiagram` series are defined in
78296
+ * plotOptions.arcdiagram.
78297
+ *
78298
+ * 3. Options for one single series are given in the series instance array.
78299
+ * (see online documentation for example)
78300
+ */
78301
+ arcdiagram?: PlotArcdiagramOptions;
77093
78302
  /**
77094
78303
  * (Highcharts, Highstock) The area series type.
77095
78304
  *
@@ -79307,7 +80516,7 @@ export interface PlotOrganizationOptions {
79307
80516
  * the development of the series against each other. Adds a `change` field
79308
80517
  * to every point object.
79309
80518
  */
79310
- compare?: string;
80519
+ compare?: OptionsCompareValue;
79311
80520
  /**
79312
80521
  * (Highstock) When compare is `percent`, this option dictates whether to
79313
80522
  * use 0 or 100 as the base of comparison.
@@ -79411,6 +80620,21 @@ export interface PlotOrganizationOptions {
79411
80620
  * parent has layout set to `hanging`.
79412
80621
  */
79413
80622
  hangingIndent?: number;
80623
+ /**
80624
+ * (Highcharts) Defines the indentation of a `hanging` layout parent's
80625
+ * children. Possible options:
80626
+ *
80627
+ * - `inherit` (default): Only the first child adds the indentation,
80628
+ * children of a child with indentation inherit the indentation.
80629
+ *
80630
+ * - `cumulative`: All children of a child with indentation add its own
80631
+ * indent. The option may cause overlapping of nodes. Then use `shrink`
80632
+ * option:
80633
+ *
80634
+ * - `shrink`: Nodes shrink by the hangingIndent value until they reach the
80635
+ * minNodeLength.
80636
+ */
80637
+ hangingIndentTranslation?: OrganizationHangingIndentTranslationValue;
79414
80638
  /**
79415
80639
  * (Highcharts) When set to `false` will prevent the series data from being
79416
80640
  * included in any form of data export.
@@ -79497,6 +80721,14 @@ export interface PlotOrganizationOptions {
79497
80721
  * values are not shown.
79498
80722
  */
79499
80723
  minLinkWidth?: number;
80724
+ /**
80725
+ * (Highcharts) In a horizontal chart, the minimum width of the **hanging**
80726
+ * nodes only, in pixels. In a vertical chart, the minimum height of the
80727
+ * **haning** nodes only, in pixels too.
80728
+ *
80729
+ * Note: Used only when hangingIndentTranslation is set to `shrink`.
80730
+ */
80731
+ minNodeLength?: number;
79500
80732
  /**
79501
80733
  * (Highstock) Options for the corresponding navigator series if
79502
80734
  * `showInNavigator` is `true` for this series. Available options are the
@@ -79517,7 +80749,7 @@ export interface PlotOrganizationOptions {
79517
80749
  nodePadding?: number;
79518
80750
  /**
79519
80751
  * (Highcharts) In a horizontal chart, the width of the nodes in pixels.
79520
- * Node that most organization charts are vertical, so the name of this
80752
+ * Note that most organization charts are vertical, so the name of this
79521
80753
  * option is counterintuitive.
79522
80754
  */
79523
80755
  nodeWidth?: number;
@@ -80056,7 +81288,7 @@ export interface PlotPackedbubbleOptions {
80056
81288
  * the development of the series against each other. Adds a `change` field
80057
81289
  * to every point object.
80058
81290
  */
80059
- compare?: string;
81291
+ compare?: OptionsCompareValue;
80060
81292
  /**
80061
81293
  * (Highstock) When compare is `percent`, this option dictates whether to
80062
81294
  * use 0 or 100 as the base of comparison.
@@ -80466,11 +81698,11 @@ export interface PlotPackedbubbleOptions {
80466
81698
  stacking?: OptionsStackingValue;
80467
81699
  states?: SeriesStatesOptionsObject;
80468
81700
  /**
80469
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
80470
- * `mouseOut` event on a series isn't triggered until the mouse moves over
80471
- * another series, or out of the plot area. When false, the `mouseOut` event
80472
- * on a series is triggered when the mouse leaves the area around the
80473
- * series' graph or markers. This also implies the tooltip. When
81701
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
81702
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
81703
+ * moves over another series, or out of the plot area. When false, the
81704
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
81705
+ * around the series' graph or markers. This also implies the tooltip. When
80474
81706
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
80475
81707
  * be hidden when moving the mouse between series.
80476
81708
  */
@@ -81003,7 +82235,7 @@ export interface PlotParetoOptions {
81003
82235
  * the development of the series against each other. Adds a `change` field
81004
82236
  * to every point object.
81005
82237
  */
81006
- compare?: string;
82238
+ compare?: OptionsCompareValue;
81007
82239
  /**
81008
82240
  * (Highstock) When compare is `percent`, this option dictates whether to
81009
82241
  * use 0 or 100 as the base of comparison.
@@ -82460,7 +83692,7 @@ export interface PlotPieOptions {
82460
83692
  * the development of the series against each other. Adds a `change` field
82461
83693
  * to every point object.
82462
83694
  */
82463
- compare?: string;
83695
+ compare?: OptionsCompareValue;
82464
83696
  /**
82465
83697
  * (Highstock) When compare is `percent`, this option dictates whether to
82466
83698
  * use 0 or 100 as the base of comparison.
@@ -83294,7 +84526,7 @@ export interface PlotPivotpointsOptions {
83294
84526
  * the development of the series against each other. Adds a `change` field
83295
84527
  * to every point object.
83296
84528
  */
83297
- compare?: string;
84529
+ compare?: OptionsCompareValue;
83298
84530
  /**
83299
84531
  * (Highstock) When compare is `percent`, this option dictates whether to
83300
84532
  * use 0 or 100 as the base of comparison.
@@ -84191,7 +85423,7 @@ export interface PlotPolygonOptions {
84191
85423
  * the development of the series against each other. Adds a `change` field
84192
85424
  * to every point object.
84193
85425
  */
84194
- compare?: string;
85426
+ compare?: OptionsCompareValue;
84195
85427
  /**
84196
85428
  * (Highstock) When compare is `percent`, this option dictates whether to
84197
85429
  * use 0 or 100 as the base of comparison.
@@ -84585,11 +85817,11 @@ export interface PlotPolygonOptions {
84585
85817
  */
84586
85818
  step?: OptionsStepValue;
84587
85819
  /**
84588
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
84589
- * `mouseOut` event on a series isn't triggered until the mouse moves over
84590
- * another series, or out of the plot area. When false, the `mouseOut` event
84591
- * on a series is triggered when the mouse leaves the area around the
84592
- * series' graph or markers. This also implies the tooltip. When
85820
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
85821
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
85822
+ * moves over another series, or out of the plot area. When false, the
85823
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
85824
+ * around the series' graph or markers. This also implies the tooltip. When
84593
85825
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
84594
85826
  * be hidden when moving the mouse between series.
84595
85827
  */
@@ -85126,7 +86358,7 @@ export interface PlotPpoOptions {
85126
86358
  * the development of the series against each other. Adds a `change` field
85127
86359
  * to every point object.
85128
86360
  */
85129
- compare?: string;
86361
+ compare?: OptionsCompareValue;
85130
86362
  /**
85131
86363
  * (Highstock) When compare is `percent`, this option dictates whether to
85132
86364
  * use 0 or 100 as the base of comparison.
@@ -86040,7 +87272,7 @@ export interface PlotPriceenvelopesOptions {
86040
87272
  * the development of the series against each other. Adds a `change` field
86041
87273
  * to every point object.
86042
87274
  */
86043
- compare?: string;
87275
+ compare?: OptionsCompareValue;
86044
87276
  /**
86045
87277
  * (Highstock) When compare is `percent`, this option dictates whether to
86046
87278
  * use 0 or 100 as the base of comparison.
@@ -86957,7 +88189,7 @@ export interface PlotPsarOptions {
86957
88189
  * the development of the series against each other. Adds a `change` field
86958
88190
  * to every point object.
86959
88191
  */
86960
- compare?: string;
88192
+ compare?: OptionsCompareValue;
86961
88193
  /**
86962
88194
  * (Highstock) When compare is `percent`, this option dictates whether to
86963
88195
  * use 0 or 100 as the base of comparison.
@@ -88578,7 +89810,7 @@ export interface PlotPyramidOptions {
88578
89810
  * the development of the series against each other. Adds a `change` field
88579
89811
  * to every point object.
88580
89812
  */
88581
- compare?: string;
89813
+ compare?: OptionsCompareValue;
88582
89814
  /**
88583
89815
  * (Highstock) When compare is `percent`, this option dictates whether to
88584
89816
  * use 0 or 100 as the base of comparison.
@@ -89427,7 +90659,7 @@ export interface PlotRocOptions {
89427
90659
  * the development of the series against each other. Adds a `change` field
89428
90660
  * to every point object.
89429
90661
  */
89430
- compare?: string;
90662
+ compare?: OptionsCompareValue;
89431
90663
  /**
89432
90664
  * (Highstock) When compare is `percent`, this option dictates whether to
89433
90665
  * use 0 or 100 as the base of comparison.
@@ -90314,7 +91546,7 @@ export interface PlotRsiOptions {
90314
91546
  * the development of the series against each other. Adds a `change` field
90315
91547
  * to every point object.
90316
91548
  */
90317
- compare?: string;
91549
+ compare?: OptionsCompareValue;
90318
91550
  /**
90319
91551
  * (Highstock) When compare is `percent`, this option dictates whether to
90320
91552
  * use 0 or 100 as the base of comparison.
@@ -91010,7 +92242,7 @@ export interface PlotSankeyOptions {
91010
92242
  * the development of the series against each other. Adds a `change` field
91011
92243
  * to every point object.
91012
92244
  */
91013
- compare?: string;
92245
+ compare?: OptionsCompareValue;
91014
92246
  /**
91015
92247
  * (Highstock) When compare is `percent`, this option dictates whether to
91016
92248
  * use 0 or 100 as the base of comparison.
@@ -91816,7 +93048,7 @@ export interface PlotScatter3dOptions {
91816
93048
  * the development of the series against each other. Adds a `change` field
91817
93049
  * to every point object.
91818
93050
  */
91819
- compare?: string;
93051
+ compare?: OptionsCompareValue;
91820
93052
  /**
91821
93053
  * (Highstock) When compare is `percent`, this option dictates whether to
91822
93054
  * use 0 or 100 as the base of comparison.
@@ -92226,11 +93458,11 @@ export interface PlotScatter3dOptions {
92226
93458
  */
92227
93459
  step?: OptionsStepValue;
92228
93460
  /**
92229
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
92230
- * `mouseOut` event on a series isn't triggered until the mouse moves over
92231
- * another series, or out of the plot area. When false, the `mouseOut` event
92232
- * on a series is triggered when the mouse leaves the area around the
92233
- * series' graph or markers. This also implies the tooltip. When
93461
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
93462
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
93463
+ * moves over another series, or out of the plot area. When false, the
93464
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
93465
+ * around the series' graph or markers. This also implies the tooltip. When
92234
93466
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
92235
93467
  * be hidden when moving the mouse between series.
92236
93468
  */
@@ -93027,7 +94259,7 @@ export interface PlotScatterOptions {
93027
94259
  * the development of the series against each other. Adds a `change` field
93028
94260
  * to every point object.
93029
94261
  */
93030
- compare?: string;
94262
+ compare?: OptionsCompareValue;
93031
94263
  /**
93032
94264
  * (Highstock) When compare is `percent`, this option dictates whether to
93033
94265
  * use 0 or 100 as the base of comparison.
@@ -93446,11 +94678,11 @@ export interface PlotScatterOptions {
93446
94678
  */
93447
94679
  step?: OptionsStepValue;
93448
94680
  /**
93449
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
93450
- * `mouseOut` event on a series isn't triggered until the mouse moves over
93451
- * another series, or out of the plot area. When false, the `mouseOut` event
93452
- * on a series is triggered when the mouse leaves the area around the
93453
- * series' graph or markers. This also implies the tooltip. When
94681
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
94682
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
94683
+ * moves over another series, or out of the plot area. When false, the
94684
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
94685
+ * around the series' graph or markers. This also implies the tooltip. When
93454
94686
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
93455
94687
  * be hidden when moving the mouse between series.
93456
94688
  */
@@ -94027,7 +95259,7 @@ export interface PlotSeriesOptions {
94027
95259
  * the development of the series against each other. Adds a `change` field
94028
95260
  * to every point object.
94029
95261
  */
94030
- compare?: string;
95262
+ compare?: OptionsCompareValue;
94031
95263
  /**
94032
95264
  * (Highstock) When compare is `percent`, this option dictates whether to
94033
95265
  * use 0 or 100 as the base of comparison.
@@ -95037,7 +96269,7 @@ export interface PlotSlowstochasticOptions {
95037
96269
  * the development of the series against each other. Adds a `change` field
95038
96270
  * to every point object.
95039
96271
  */
95040
- compare?: string;
96272
+ compare?: OptionsCompareValue;
95041
96273
  /**
95042
96274
  * (Highstock) When compare is `percent`, this option dictates whether to
95043
96275
  * use 0 or 100 as the base of comparison.
@@ -95944,7 +97176,7 @@ export interface PlotSmaOptions {
95944
97176
  * the development of the series against each other. Adds a `change` field
95945
97177
  * to every point object.
95946
97178
  */
95947
- compare?: string;
97179
+ compare?: OptionsCompareValue;
95948
97180
  /**
95949
97181
  * (Highstock) When compare is `percent`, this option dictates whether to
95950
97182
  * use 0 or 100 as the base of comparison.
@@ -96767,7 +97999,7 @@ export interface PlotSolidgaugeOptions {
96767
97999
  * the development of the series against each other. Adds a `change` field
96768
98000
  * to every point object.
96769
98001
  */
96770
- compare?: string;
98002
+ compare?: OptionsCompareValue;
96771
98003
  /**
96772
98004
  * (Highstock) When compare is `percent`, this option dictates whether to
96773
98005
  * use 0 or 100 as the base of comparison.
@@ -97618,7 +98850,7 @@ export interface PlotSplineOptions {
97618
98850
  * the development of the series against each other. Adds a `change` field
97619
98851
  * to every point object.
97620
98852
  */
97621
- compare?: string;
98853
+ compare?: OptionsCompareValue;
97622
98854
  /**
97623
98855
  * (Highstock) When compare is `percent`, this option dictates whether to
97624
98856
  * use 0 or 100 as the base of comparison.
@@ -98606,7 +99838,7 @@ export interface PlotStochasticOptions {
98606
99838
  * the development of the series against each other. Adds a `change` field
98607
99839
  * to every point object.
98608
99840
  */
98609
- compare?: string;
99841
+ compare?: OptionsCompareValue;
98610
99842
  /**
98611
99843
  * (Highstock) When compare is `percent`, this option dictates whether to
98612
99844
  * use 0 or 100 as the base of comparison.
@@ -99523,7 +100755,7 @@ export interface PlotStreamgraphOptions {
99523
100755
  * the development of the series against each other. Adds a `change` field
99524
100756
  * to every point object.
99525
100757
  */
99526
- compare?: string;
100758
+ compare?: OptionsCompareValue;
99527
100759
  /**
99528
100760
  * (Highstock) When compare is `percent`, this option dictates whether to
99529
100761
  * use 0 or 100 as the base of comparison.
@@ -100151,6 +101383,153 @@ export interface PlotSunburstAccessibilityPointOptions {
100151
101383
  export interface PlotSunburstAnimationOptions {
100152
101384
  defer?: number;
100153
101385
  }
101386
+ /**
101387
+ * (Highcharts) A collection of attributes for the buttons. The object takes SVG
101388
+ * attributes like `fill`, `stroke`, `stroke-width`, as well as `style`, a
101389
+ * collection of CSS properties for the text.
101390
+ *
101391
+ * The object can also be extended with states, so you can set presentational
101392
+ * options for `hover`, `select` or `disabled` button states.
101393
+ */
101394
+ export interface PlotSunburstBreadcrumbsButtonThemeOptions {
101395
+ style?: PlotSunburstBreadcrumbsButtonThemeStyleOptions;
101396
+ }
101397
+ export interface PlotSunburstBreadcrumbsButtonThemeStyleOptions {
101398
+ color?: string;
101399
+ }
101400
+ export interface PlotSunburstBreadcrumbsEventsOptions {
101401
+ /**
101402
+ * (Highcharts) Fires when clicking on the breadcrumbs button. Two arguments
101403
+ * are passed to the function. First breadcrumb button as an SVG element.
101404
+ * Second is the breadcrumbs class, containing reference to the chart,
101405
+ * series etc. (see online documentation for example)
101406
+ *
101407
+ * Return false to stop default buttons click action.
101408
+ */
101409
+ click?: BreadcrumbsClickCallbackFunction;
101410
+ }
101411
+ /**
101412
+ * (Highcharts) Options for the breadcrumbs, the navigation at the top leading
101413
+ * the way up through the traversed levels.
101414
+ */
101415
+ export interface PlotSunburstBreadcrumbsOptions {
101416
+ /**
101417
+ * (Highcharts) The default padding for each button and separator in each
101418
+ * direction.
101419
+ */
101420
+ buttonSpacing?: number;
101421
+ /**
101422
+ * (Highcharts) A collection of attributes for the buttons. The object takes
101423
+ * SVG attributes like `fill`, `stroke`, `stroke-width`, as well as `style`,
101424
+ * a collection of CSS properties for the text.
101425
+ *
101426
+ * The object can also be extended with states, so you can set
101427
+ * presentational options for `hover`, `select` or `disabled` button states.
101428
+ */
101429
+ buttonTheme?: (PlotSunburstBreadcrumbsButtonThemeOptions|SVGAttributes);
101430
+ events?: PlotSunburstBreadcrumbsEventsOptions;
101431
+ /**
101432
+ * (Highcharts) When the breadcrumbs are floating, the plot area will not
101433
+ * move to make space for it. By default, the chart will not make space for
101434
+ * the buttons. This property won't work when positioned in the middle.
101435
+ */
101436
+ floating?: boolean;
101437
+ /**
101438
+ * (Highcharts) A format string for the breadcrumbs button. Variables are
101439
+ * enclosed by curly brackets. Available values are passed in the declared
101440
+ * point options.
101441
+ */
101442
+ format?: (string|undefined);
101443
+ /**
101444
+ * (Highcharts) Callback function to format the breadcrumb text from
101445
+ * scratch.
101446
+ */
101447
+ formatter?: BreadcrumbsFormatterCallbackFunction;
101448
+ /**
101449
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
101450
+ * buttons will be aligned properly for the default chart layout (title,
101451
+ * subtitle, legend, range selector) for the custom chart layout set the
101452
+ * position properties.
101453
+ */
101454
+ position?: (BreadcrumbsAlignOptions|PlotSunburstBreadcrumbsPositionOptions);
101455
+ /**
101456
+ * (Highcharts, Highmaps) What box to align the button to. Can be either
101457
+ * `plotBox` or `spacingBox`.
101458
+ */
101459
+ relativeTo?: ButtonRelativeToValue;
101460
+ /**
101461
+ * (Highcharts) Options object for Breadcrumbs separator.
101462
+ */
101463
+ separator?: PlotSunburstBreadcrumbsSeparatorOptions;
101464
+ /**
101465
+ * (Highcharts) Show full path or only a single button.
101466
+ */
101467
+ showFullPath?: boolean;
101468
+ /**
101469
+ * (Highcharts) CSS styles for all breadcrumbs.
101470
+ *
101471
+ * In styled mode, the breadcrumbs buttons are styled by the
101472
+ * `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its
101473
+ * different states.
101474
+ */
101475
+ style?: SVGAttributes;
101476
+ /**
101477
+ * (Highcharts) Whether to use HTML to render the breadcrumbs items texts.
101478
+ */
101479
+ useHTML?: boolean;
101480
+ /**
101481
+ * (Highcharts) The z index of the breadcrumbs group.
101482
+ */
101483
+ zIndex?: number;
101484
+ }
101485
+ /**
101486
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
101487
+ * buttons will be aligned properly for the default chart layout (title,
101488
+ * subtitle, legend, range selector) for the custom chart layout set the
101489
+ * position properties.
101490
+ */
101491
+ export interface PlotSunburstBreadcrumbsPositionOptions {
101492
+ /**
101493
+ * (Highcharts, Highmaps) Horizontal alignment of the breadcrumbs buttons.
101494
+ */
101495
+ align?: AlignValue;
101496
+ /**
101497
+ * (Highcharts, Highmaps) Vertical alignment of the breadcrumbs buttons.
101498
+ */
101499
+ verticalAlign?: VerticalAlignValue;
101500
+ /**
101501
+ * (Highcharts, Highmaps) The X offset of the breadcrumbs button group.
101502
+ */
101503
+ x?: number;
101504
+ /**
101505
+ * (Highcharts, Highmaps) The Y offset of the breadcrumbs button group. When
101506
+ * `undefined`, and `floating` is `false`, the `y` position is adapted so
101507
+ * that the breadcrumbs are rendered outside the target area.
101508
+ */
101509
+ y?: (number|undefined);
101510
+ }
101511
+ /**
101512
+ * (Highcharts) Options object for Breadcrumbs separator.
101513
+ */
101514
+ export interface PlotSunburstBreadcrumbsSeparatorOptions {
101515
+ /**
101516
+ * (Highcharts) CSS styles for the breadcrumbs separator.
101517
+ *
101518
+ * In styled mode, the breadcrumbs separators are styled by the
101519
+ * `.highcharts-separator` rule with its different states.
101520
+ */
101521
+ style?: (CSSObject|PlotSunburstBreadcrumbsSeparatorStyleOptions);
101522
+ text?: string;
101523
+ }
101524
+ /**
101525
+ * (Highcharts) CSS styles for the breadcrumbs separator.
101526
+ *
101527
+ * In styled mode, the breadcrumbs separators are styled by the
101528
+ * `.highcharts-separator` rule with its different states.
101529
+ */
101530
+ export interface PlotSunburstBreadcrumbsSeparatorStyleOptions {
101531
+ color?: string;
101532
+ }
100154
101533
  /**
100155
101534
  * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
100156
101535
  * animation when a series is displayed for the `dataLabels`. The animation can
@@ -100350,6 +101729,11 @@ export interface PlotSunburstOptions {
100350
101729
  * `.highcharts-point` class.
100351
101730
  */
100352
101731
  borderWidth?: number;
101732
+ /**
101733
+ * (Highcharts) Options for the breadcrumbs, the navigation at the top
101734
+ * leading the way up through the traversed levels.
101735
+ */
101736
+ breadcrumbs?: PlotSunburstBreadcrumbsOptions;
100353
101737
  /**
100354
101738
  * (Highcharts) The center of the sunburst chart relative to the plot area.
100355
101739
  * Can be percentages or pixel values.
@@ -100615,11 +101999,6 @@ export interface PlotSunburstOptions {
100615
101999
  * following properties can be defined on a series level.
100616
102000
  */
100617
102001
  tooltip?: SeriesTooltipOptionsObject;
100618
- /**
100619
- * (Highcharts) Options for the button appearing when traversing down in a
100620
- * treemap.
100621
- */
100622
- traverseUpButton?: PlotSunburstTraverseUpButtonOptions;
100623
102002
  /**
100624
102003
  * (Highstock) The parameter allows setting line series type and use OHLC
100625
102004
  * indicators. Data in OHLC format is required.
@@ -100634,37 +102013,6 @@ export interface PlotSunburstOptions {
100634
102013
  */
100635
102014
  zIndex?: number;
100636
102015
  }
100637
- /**
100638
- * (Highcharts) Options for the button appearing when traversing down in a
100639
- * treemap.
100640
- */
100641
- export interface PlotSunburstTraverseUpButtonOptions {
100642
- /**
100643
- * (Highcharts) The position of the button.
100644
- */
100645
- position?: PlotSunburstTraverseUpButtonPositionOptions;
100646
- }
100647
- /**
100648
- * (Highcharts) The position of the button.
100649
- */
100650
- export interface PlotSunburstTraverseUpButtonPositionOptions {
100651
- /**
100652
- * (Highcharts) Horizontal alignment of the button.
100653
- */
100654
- align?: AlignValue;
100655
- /**
100656
- * (Highcharts) Vertical alignment of the button.
100657
- */
100658
- verticalAlign?: VerticalAlignValue;
100659
- /**
100660
- * (Highcharts) Horizontal offset of the button.
100661
- */
100662
- x?: number;
100663
- /**
100664
- * (Highcharts) Vertical offset of the button.
100665
- */
100666
- y?: number;
100667
- }
100668
102016
  /**
100669
102017
  * (Highstock) Point accessibility options for a series.
100670
102018
  */
@@ -101177,7 +102525,7 @@ export interface PlotSupertrendOptions {
101177
102525
  * the development of the series against each other. Adds a `change` field
101178
102526
  * to every point object.
101179
102527
  */
101180
- compare?: string;
102528
+ compare?: OptionsCompareValue;
101181
102529
  /**
101182
102530
  * (Highstock) When compare is `percent`, this option dictates whether to
101183
102531
  * use 0 or 100 as the base of comparison.
@@ -102875,7 +104223,7 @@ export interface PlotTilemapOptions {
102875
104223
  * the development of the series against each other. Adds a `change` field
102876
104224
  * to every point object.
102877
104225
  */
102878
- compare?: string;
104226
+ compare?: OptionsCompareValue;
102879
104227
  /**
102880
104228
  * (Highstock) When compare is `percent`, this option dictates whether to
102881
104229
  * use 0 or 100 as the base of comparison.
@@ -103138,11 +104486,11 @@ export interface PlotTilemapOptions {
103138
104486
  skipKeyboardNavigation?: boolean;
103139
104487
  states?: SeriesStatesOptionsObject;
103140
104488
  /**
103141
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
103142
- * `mouseOut` event on a series isn't triggered until the mouse moves over
103143
- * another series, or out of the plot area. When false, the `mouseOut` event
103144
- * on a series is triggered when the mouse leaves the area around the
103145
- * series' graph or markers. This also implies the tooltip. When
104489
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
104490
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
104491
+ * moves over another series, or out of the plot area. When false, the
104492
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
104493
+ * around the series' graph or markers. This also implies the tooltip. When
103146
104494
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
103147
104495
  * be hidden when moving the mouse between series.
103148
104496
  */
@@ -103436,7 +104784,7 @@ export interface PlotTimelineOptions {
103436
104784
  * the development of the series against each other. Adds a `change` field
103437
104785
  * to every point object.
103438
104786
  */
103439
- compare?: string;
104787
+ compare?: OptionsCompareValue;
103440
104788
  /**
103441
104789
  * (Highstock) When compare is `percent`, this option dictates whether to
103442
104790
  * use 0 or 100 as the base of comparison.
@@ -103836,193 +105184,152 @@ export interface PlotTreemapAccessibilityPointOptions {
103836
105184
  export interface PlotTreemapAnimationOptions {
103837
105185
  defer?: number;
103838
105186
  }
103839
- export interface PlotTreemapClusterEventsOptions {
105187
+ /**
105188
+ * (Highcharts) A collection of attributes for the buttons. The object takes SVG
105189
+ * attributes like `fill`, `stroke`, `stroke-width`, as well as `style`, a
105190
+ * collection of CSS properties for the text.
105191
+ *
105192
+ * The object can also be extended with states, so you can set presentational
105193
+ * options for `hover`, `select` or `disabled` button states.
105194
+ */
105195
+ export interface PlotTreemapBreadcrumbsButtonThemeOptions {
105196
+ style?: PlotTreemapBreadcrumbsButtonThemeStyleOptions;
105197
+ }
105198
+ export interface PlotTreemapBreadcrumbsButtonThemeStyleOptions {
105199
+ color?: string;
105200
+ }
105201
+ export interface PlotTreemapBreadcrumbsEventsOptions {
103840
105202
  /**
103841
- * (Highcharts, Highmaps) Fires when the cluster point is clicked and
103842
- * `drillToCluster` is enabled. One parameter, `event`, is passed to the
103843
- * function. The default action is to zoom to the cluster points range. This
103844
- * can be prevented by calling `event.preventDefault()`.
105203
+ * (Highcharts) Fires when clicking on the breadcrumbs button. Two arguments
105204
+ * are passed to the function. First breadcrumb button as an SVG element.
105205
+ * Second is the breadcrumbs class, containing reference to the chart,
105206
+ * series etc. (see online documentation for example)
105207
+ *
105208
+ * Return false to stop default buttons click action.
103845
105209
  */
103846
- drillToCluster?: MarkerClusterDrillCallbackFunction;
105210
+ click?: BreadcrumbsClickCallbackFunction;
103847
105211
  }
103848
105212
  /**
103849
- * (Highcharts, Highmaps) Options for layout algorithm. Inside there are options
103850
- * to change the type of the algorithm, gridSize, distance or iterations.
105213
+ * (Highcharts) Options for the breadcrumbs, the navigation at the top leading
105214
+ * the way up through the traversed levels.
103851
105215
  */
103852
- export interface PlotTreemapClusterLayoutAlgorithmOptions {
105216
+ export interface PlotTreemapBreadcrumbsOptions {
103853
105217
  /**
103854
- * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is a
103855
- * maximum distance between point and cluster center so that this point will
103856
- * be inside the cluster. The distance is either a number defining pixels or
103857
- * a percentage defining a percentage of the plot area width.
105218
+ * (Highcharts) The default padding for each button and separator in each
105219
+ * direction.
103858
105220
  */
103859
- distance?: (number|string);
103860
- /**
103861
- * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize` is a
103862
- * size of a grid square element either as a number defining pixels, or a
103863
- * percentage defining a percentage of the plot area width.
103864
- */
103865
- gridSize?: (number|string);
103866
- /**
103867
- * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations` are
103868
- * the number of iterations that this algorithm will be repeated to find
103869
- * clusters positions.
103870
- */
103871
- iterations?: number;
103872
- /**
103873
- * (Highcharts, Highmaps) When `type` is set to `undefined` and there are
103874
- * more visible points than the kmeansThreshold the `grid` algorithm is used
103875
- * to find clusters, otherwise `kmeans`. It ensures good performance on
103876
- * large datasets and better clusters arrangement after the zoom.
103877
- */
103878
- kmeansThreshold?: number;
105221
+ buttonSpacing?: number;
103879
105222
  /**
103880
- * (Highcharts, Highmaps) Type of the algorithm used to combine points into
103881
- * a cluster. There are three available algorithms:
103882
- *
103883
- * 1) `grid` - grid-based clustering technique. Points are assigned to
103884
- * squares of set size depending on their position on the plot area. Points
103885
- * inside the grid square are combined into a cluster. The grid size can be
103886
- * controlled by `gridSize` property (grid size changes at certain zoom
103887
- * levels).
103888
- *
103889
- * 2) `kmeans` - based on K-Means clustering technique. In the first step,
103890
- * points are divided using the grid method (distance property is a grid
103891
- * size) to find the initial amount of clusters. Next, each point is
103892
- * classified by computing the distance between each cluster center and that
103893
- * point. When the closest cluster distance is lower than distance property
103894
- * set by a user the point is added to this cluster otherwise is classified
103895
- * as `noise`. The algorithm is repeated until each cluster center not
103896
- * change its previous position more than one pixel. This technique is more
103897
- * accurate but also more time consuming than the `grid` algorithm,
103898
- * especially for big datasets.
105223
+ * (Highcharts) A collection of attributes for the buttons. The object takes
105224
+ * SVG attributes like `fill`, `stroke`, `stroke-width`, as well as `style`,
105225
+ * a collection of CSS properties for the text.
103899
105226
  *
103900
- * 3) `optimizedKmeans` - based on K-Means clustering technique. This
103901
- * algorithm uses k-means algorithm only on the chart initialization or when
103902
- * chart extremes have greater range than on initialization. When a chart is
103903
- * redrawn the algorithm checks only clustered points distance from the
103904
- * cluster center and rebuild it when the point is spaced enough to be
103905
- * outside the cluster. It provides performance improvement and more stable
103906
- * clusters position yet can be used rather on small and sparse datasets.
103907
- *
103908
- * By default, the algorithm depends on visible quantity of points and
103909
- * `kmeansThreshold`. When there are more visible points than the
103910
- * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
103911
- *
103912
- * The custom clustering algorithm can be added by assigning a callback
103913
- * function as the type property. This function takes an array of
103914
- * `processedXData`, `processedYData`, `processedXData` indexes and
103915
- * `layoutAlgorithm` options as arguments and should return an object with
103916
- * grouped data.
103917
- *
103918
- * The algorithm should return an object like that: (see online
103919
- * documentation for example)
103920
- *
103921
- * `clusterId` (example above - unique id of a cluster or noise) is an array
103922
- * of points belonging to a cluster. If the array has only one point or
103923
- * fewer points than set in `cluster.minimumClusterSize` it won't be
103924
- * combined into a cluster.
105227
+ * The object can also be extended with states, so you can set
105228
+ * presentational options for `hover`, `select` or `disabled` button states.
103925
105229
  */
103926
- type?: (string|Function);
103927
- }
103928
- /**
103929
- * (Highcharts, Highmaps) Options for marker clusters, the concept of sampling
103930
- * the data values into larger blocks in order to ease readability and increase
103931
- * performance of the JavaScript charts.
103932
- *
103933
- * Note: marker clusters module is not working with `boost` and
103934
- * `draggable-points` modules.
103935
- *
103936
- * The marker clusters feature requires the marker-clusters.js file to be
103937
- * loaded, found in the modules directory of the download package, or online at
103938
- * code.highcharts.com/modules/marker-clusters.js.
103939
- */
103940
- export interface PlotTreemapClusterOptions {
105230
+ buttonTheme?: (PlotTreemapBreadcrumbsButtonThemeOptions|SVGAttributes);
105231
+ events?: PlotTreemapBreadcrumbsEventsOptions;
103941
105232
  /**
103942
- * (Highcharts, Highmaps) When set to `false` prevent cluster overlapping -
103943
- * this option works only when `layoutAlgorithm.type = "grid"`.
105233
+ * (Highcharts) When the breadcrumbs are floating, the plot area will not
105234
+ * move to make space for it. By default, the chart will not make space for
105235
+ * the buttons. This property won't work when positioned in the middle.
103944
105236
  */
103945
- allowOverlap?: boolean;
105237
+ floating?: boolean;
103946
105238
  /**
103947
- * (Highcharts, Highmaps) Options for the cluster marker animation.
105239
+ * (Highcharts) A format string for the breadcrumbs button. Variables are
105240
+ * enclosed by curly brackets. Available values are passed in the declared
105241
+ * point options.
103948
105242
  */
103949
- animation?: (boolean|Partial<AnimationOptionsObject>);
105243
+ format?: (string|undefined);
103950
105244
  /**
103951
- * (Highcharts, Highmaps) Options for the cluster data labels.
105245
+ * (Highcharts) Callback function to format the breadcrumb text from
105246
+ * scratch.
103952
105247
  */
103953
- dataLabels?: DataLabelsOptions;
105248
+ formatter?: BreadcrumbsFormatterCallbackFunction;
103954
105249
  /**
103955
- * (Highcharts, Highmaps) Zoom the plot area to the cluster points range
103956
- * when a cluster is clicked.
105250
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
105251
+ * buttons will be aligned properly for the default chart layout (title,
105252
+ * subtitle, legend, range selector) for the custom chart layout set the
105253
+ * position properties.
103957
105254
  */
103958
- drillToCluster?: boolean;
105255
+ position?: (BreadcrumbsAlignOptions|PlotTreemapBreadcrumbsPositionOptions);
103959
105256
  /**
103960
- * (Highcharts, Highmaps) Whether to enable the marker-clusters module.
105257
+ * (Highcharts, Highmaps) What box to align the button to. Can be either
105258
+ * `plotBox` or `spacingBox`.
103961
105259
  */
103962
- enabled?: boolean;
103963
- events?: PlotTreemapClusterEventsOptions;
105260
+ relativeTo?: ButtonRelativeToValue;
103964
105261
  /**
103965
- * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
103966
- * options to change the type of the algorithm, gridSize, distance or
103967
- * iterations.
105262
+ * (Highcharts) Options object for Breadcrumbs separator.
103968
105263
  */
103969
- layoutAlgorithm?: PlotTreemapClusterLayoutAlgorithmOptions;
105264
+ separator?: PlotTreemapBreadcrumbsSeparatorOptions;
103970
105265
  /**
103971
- * (Highcharts, Highmaps) Options for the cluster marker.
105266
+ * (Highcharts) Show full path or only a single button.
103972
105267
  */
103973
- marker?: PointMarkerOptionsObject;
105268
+ showFullPath?: boolean;
103974
105269
  /**
103975
- * (Highcharts, Highmaps) The minimum amount of points to be combined into a
103976
- * cluster. This value has to be greater or equal to 2.
105270
+ * (Highcharts) CSS styles for all breadcrumbs.
105271
+ *
105272
+ * In styled mode, the breadcrumbs buttons are styled by the
105273
+ * `.highcharts-breadcrumbs-buttons .highcharts-button` rule with its
105274
+ * different states.
103977
105275
  */
103978
- minimumClusterSize?: number;
103979
- states?: PlotTreemapClusterStatesOptions;
105276
+ style?: SVGAttributes;
103980
105277
  /**
103981
- * (Highcharts, Highmaps) An array defining zones within marker clusters.
103982
- *
103983
- * In styled mode, the color zones are styled with the
103984
- * `.highcharts-cluster-zone-{n}` class, or custom classed from the
103985
- * `className` option.
105278
+ * (Highcharts) Whether to use HTML to render the breadcrumbs items texts.
103986
105279
  */
103987
- zones?: Array<PlotTreemapClusterZonesOptions>;
103988
- }
103989
- export interface PlotTreemapClusterStatesHoverOptions {
105280
+ useHTML?: boolean;
103990
105281
  /**
103991
- * (Highcharts, Highmaps) The fill color of the cluster marker in hover
103992
- * state. When `undefined`, the series' or point's fillColor for normal
103993
- * state is used.
105282
+ * (Highcharts) The z index of the breadcrumbs group.
103994
105283
  */
103995
- fillColor?: ColorType;
103996
- }
103997
- export interface PlotTreemapClusterStatesOptions {
103998
- hover?: PlotTreemapClusterStatesHoverOptions;
105284
+ zIndex?: number;
103999
105285
  }
104000
105286
  /**
104001
- * (Highcharts, Highmaps) An array defining zones within marker clusters.
104002
- *
104003
- * In styled mode, the color zones are styled with the
104004
- * `.highcharts-cluster-zone-{n}` class, or custom classed from the `className`
104005
- * option.
105287
+ * (Highcharts, Highmaps) Positioning for the button row. The breadcrumbs
105288
+ * buttons will be aligned properly for the default chart layout (title,
105289
+ * subtitle, legend, range selector) for the custom chart layout set the
105290
+ * position properties.
104006
105291
  */
104007
- export interface PlotTreemapClusterZonesOptions {
105292
+ export interface PlotTreemapBreadcrumbsPositionOptions {
104008
105293
  /**
104009
- * (Highcharts, Highmaps) Styled mode only. A custom class name for the
104010
- * zone.
105294
+ * (Highcharts, Highmaps) Horizontal alignment of the breadcrumbs buttons.
104011
105295
  */
104012
- className?: string;
105296
+ align?: AlignValue;
104013
105297
  /**
104014
- * (Highcharts, Highmaps) The value where the zone starts.
105298
+ * (Highcharts, Highmaps) Vertical alignment of the breadcrumbs buttons.
104015
105299
  */
104016
- from?: number;
105300
+ verticalAlign?: VerticalAlignValue;
104017
105301
  /**
104018
- * (Highcharts, Highmaps) Settings for the cluster marker belonging to the
104019
- * zone.
105302
+ * (Highcharts, Highmaps) The X offset of the breadcrumbs button group.
104020
105303
  */
104021
- marker?: PointMarkerOptionsObject;
105304
+ x?: number;
104022
105305
  /**
104023
- * (Highcharts, Highmaps) The value where the zone ends.
105306
+ * (Highcharts, Highmaps) The Y offset of the breadcrumbs button group. When
105307
+ * `undefined`, and `floating` is `false`, the `y` position is adapted so
105308
+ * that the breadcrumbs are rendered outside the target area.
104024
105309
  */
104025
- to?: number;
105310
+ y?: (number|undefined);
105311
+ }
105312
+ /**
105313
+ * (Highcharts) Options object for Breadcrumbs separator.
105314
+ */
105315
+ export interface PlotTreemapBreadcrumbsSeparatorOptions {
105316
+ /**
105317
+ * (Highcharts) CSS styles for the breadcrumbs separator.
105318
+ *
105319
+ * In styled mode, the breadcrumbs separators are styled by the
105320
+ * `.highcharts-separator` rule with its different states.
105321
+ */
105322
+ style?: (CSSObject|PlotTreemapBreadcrumbsSeparatorStyleOptions);
105323
+ text?: string;
105324
+ }
105325
+ /**
105326
+ * (Highcharts) CSS styles for the breadcrumbs separator.
105327
+ *
105328
+ * In styled mode, the breadcrumbs separators are styled by the
105329
+ * `.highcharts-separator` rule with its different states.
105330
+ */
105331
+ export interface PlotTreemapBreadcrumbsSeparatorStyleOptions {
105332
+ color?: string;
104026
105333
  }
104027
105334
  /**
104028
105335
  * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
@@ -104688,6 +105995,11 @@ export interface PlotTreemapOptions {
104688
105995
  * (Highmaps) The width of the border surrounding each tree map item.
104689
105996
  */
104690
105997
  borderWidth?: number;
105998
+ /**
105999
+ * (Highcharts) Options for the breadcrumbs, the navigation at the top
106000
+ * leading the way up through the traversed levels.
106001
+ */
106002
+ breadcrumbs?: PlotTreemapBreadcrumbsOptions;
104691
106003
  /**
104692
106004
  * (Highcharts) An additional class name to apply to the series' graphical
104693
106005
  * elements. This option does not replace default class names of the
@@ -104701,19 +106013,6 @@ export interface PlotTreemapOptions {
104701
106013
  * **Note:** Clipping should be always enabled when chart.zoomType is set
104702
106014
  */
104703
106015
  clip?: boolean;
104704
- /**
104705
- * (Highcharts, Highmaps) Options for marker clusters, the concept of
104706
- * sampling the data values into larger blocks in order to ease readability
104707
- * and increase performance of the JavaScript charts.
104708
- *
104709
- * Note: marker clusters module is not working with `boost` and
104710
- * `draggable-points` modules.
104711
- *
104712
- * The marker clusters feature requires the marker-clusters.js file to be
104713
- * loaded, found in the modules directory of the download package, or online
104714
- * at code.highcharts.com/modules/marker-clusters.js.
104715
- */
104716
- cluster?: PlotTreemapClusterOptions;
104717
106016
  /**
104718
106017
  * (Highcharts) The main color of the series. In line type series it applies
104719
106018
  * to the line and the point markers unless otherwise specified. In bar type
@@ -104770,7 +106069,7 @@ export interface PlotTreemapOptions {
104770
106069
  * the development of the series against each other. Adds a `change` field
104771
106070
  * to every point object.
104772
106071
  */
104773
- compare?: string;
106072
+ compare?: OptionsCompareValue;
104774
106073
  /**
104775
106074
  * (Highstock) When compare is `percent`, this option dictates whether to
104776
106075
  * use 0 or 100 as the base of comparison.
@@ -104786,17 +106085,6 @@ export interface PlotTreemapOptions {
104786
106085
  * calculated according to the previous point (`compareStart=false`).
104787
106086
  */
104788
106087
  compareStart?: boolean;
104789
- /**
104790
- * (Highcharts) Polar charts only. Whether to connect the ends of a line
104791
- * series plot across the extremes.
104792
- */
104793
- connectEnds?: boolean;
104794
- /**
104795
- * (Highcharts, Highstock) Whether to connect a graph line across null
104796
- * points, or render a gap between the two points on either side of the
104797
- * null.
104798
- */
104799
- connectNulls?: boolean;
104800
106088
  /**
104801
106089
  * (Gantt) Override Pathfinder connector options for a series. Requires
104802
106090
  * Highcharts Gantt to be loaded.
@@ -105202,11 +106490,11 @@ export interface PlotTreemapOptions {
105202
106490
  */
105203
106491
  step?: OptionsStepValue;
105204
106492
  /**
105205
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
105206
- * `mouseOut` event on a series isn't triggered until the mouse moves over
105207
- * another series, or out of the plot area. When false, the `mouseOut` event
105208
- * on a series is triggered when the mouse leaves the area around the
105209
- * series' graph or markers. This also implies the tooltip. When
106493
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
106494
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
106495
+ * moves over another series, or out of the plot area. When false, the
106496
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
106497
+ * around the series' graph or markers. This also implies the tooltip. When
105210
106498
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
105211
106499
  * be hidden when moving the mouse between series.
105212
106500
  */
@@ -105226,11 +106514,6 @@ export interface PlotTreemapOptions {
105226
106514
  * in the pointFormat.
105227
106515
  */
105228
106516
  tooltip?: SeriesTooltipOptionsObject;
105229
- /**
105230
- * (Highcharts) Options for the button appearing when traversing down in a
105231
- * treemap.
105232
- */
105233
- traverseUpButton?: PlotTreemapTraverseUpButtonOptions;
105234
106517
  /**
105235
106518
  * (Highcharts, Highstock, Gantt) When a series contains a data array that
105236
106519
  * is longer than this, only one dimensional arrays of numbers, or two
@@ -105267,37 +106550,6 @@ export interface PlotTreemapOptions {
105267
106550
  */
105268
106551
  zones?: Array<SeriesZonesOptionsObject>;
105269
106552
  }
105270
- /**
105271
- * (Highcharts) Options for the button appearing when traversing down in a
105272
- * treemap.
105273
- */
105274
- export interface PlotTreemapTraverseUpButtonOptions {
105275
- /**
105276
- * (Highcharts) The position of the button.
105277
- */
105278
- position?: PlotTreemapTraverseUpButtonPositionOptions;
105279
- }
105280
- /**
105281
- * (Highcharts) The position of the button.
105282
- */
105283
- export interface PlotTreemapTraverseUpButtonPositionOptions {
105284
- /**
105285
- * (Highcharts) Horizontal alignment of the button.
105286
- */
105287
- align?: AlignValue;
105288
- /**
105289
- * (Highcharts) Vertical alignment of the button.
105290
- */
105291
- verticalAlign?: VerticalAlignValue;
105292
- /**
105293
- * (Highcharts) Horizontal offset of the button.
105294
- */
105295
- x?: number;
105296
- /**
105297
- * (Highcharts) Vertical offset of the button.
105298
- */
105299
- y?: number;
105300
- }
105301
106553
  /**
105302
106554
  * (Highstock) Point accessibility options for a series.
105303
106555
  */
@@ -105784,7 +107036,7 @@ export interface PlotTrendlineOptions {
105784
107036
  * the development of the series against each other. Adds a `change` field
105785
107037
  * to every point object.
105786
107038
  */
105787
- compare?: string;
107039
+ compare?: OptionsCompareValue;
105788
107040
  /**
105789
107041
  * (Highstock) When compare is `percent`, this option dictates whether to
105790
107042
  * use 0 or 100 as the base of comparison.
@@ -107301,7 +108553,7 @@ export interface PlotVariablepieOptions {
107301
108553
  * the development of the series against each other. Adds a `change` field
107302
108554
  * to every point object.
107303
108555
  */
107304
- compare?: string;
108556
+ compare?: OptionsCompareValue;
107305
108557
  /**
107306
108558
  * (Highstock) When compare is `percent`, this option dictates whether to
107307
108559
  * use 0 or 100 as the base of comparison.
@@ -108201,7 +109453,7 @@ export interface PlotVariwideOptions {
108201
109453
  * the development of the series against each other. Adds a `change` field
108202
109454
  * to every point object.
108203
109455
  */
108204
- compare?: string;
109456
+ compare?: OptionsCompareValue;
108205
109457
  /**
108206
109458
  * (Highstock) When compare is `percent`, this option dictates whether to
108207
109459
  * use 0 or 100 as the base of comparison.
@@ -109162,7 +110414,7 @@ export interface PlotVbpOptions {
109162
110414
  * the development of the series against each other. Adds a `change` field
109163
110415
  * to every point object.
109164
110416
  */
109165
- compare?: string;
110417
+ compare?: OptionsCompareValue;
109166
110418
  /**
109167
110419
  * (Highstock) When compare is `percent`, this option dictates whether to
109168
110420
  * use 0 or 100 as the base of comparison.
@@ -110293,7 +111545,7 @@ export interface PlotVectorOptions {
110293
111545
  * the development of the series against each other. Adds a `change` field
110294
111546
  * to every point object.
110295
111547
  */
110296
- compare?: string;
111548
+ compare?: OptionsCompareValue;
110297
111549
  /**
110298
111550
  * (Highstock) When compare is `percent`, this option dictates whether to
110299
111551
  * use 0 or 100 as the base of comparison.
@@ -110600,11 +111852,11 @@ export interface PlotVectorOptions {
110600
111852
  softThreshold?: boolean;
110601
111853
  states?: SeriesStatesOptionsObject;
110602
111854
  /**
110603
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
110604
- * `mouseOut` event on a series isn't triggered until the mouse moves over
110605
- * another series, or out of the plot area. When false, the `mouseOut` event
110606
- * on a series is triggered when the mouse leaves the area around the
110607
- * series' graph or markers. This also implies the tooltip. When
111855
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
111856
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
111857
+ * moves over another series, or out of the plot area. When false, the
111858
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
111859
+ * around the series' graph or markers. This also implies the tooltip. When
110608
111860
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
110609
111861
  * be hidden when moving the mouse between series.
110610
111862
  */
@@ -111334,7 +112586,7 @@ export interface PlotVennOptions {
111334
112586
  * the development of the series against each other. Adds a `change` field
111335
112587
  * to every point object.
111336
112588
  */
111337
- compare?: string;
112589
+ compare?: OptionsCompareValue;
111338
112590
  /**
111339
112591
  * (Highstock) When compare is `percent`, this option dictates whether to
111340
112592
  * use 0 or 100 as the base of comparison.
@@ -111587,11 +112839,11 @@ export interface PlotVennOptions {
111587
112839
  */
111588
112840
  step?: OptionsStepValue;
111589
112841
  /**
111590
- * (Highcharts, Highstock) Sticky tracking of mouse events. When true, the
111591
- * `mouseOut` event on a series isn't triggered until the mouse moves over
111592
- * another series, or out of the plot area. When false, the `mouseOut` event
111593
- * on a series is triggered when the mouse leaves the area around the
111594
- * series' graph or markers. This also implies the tooltip. When
112842
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events. When
112843
+ * true, the `mouseOut` event on a series isn't triggered until the mouse
112844
+ * moves over another series, or out of the plot area. When false, the
112845
+ * `mouseOut` event on a series is triggered when the mouse leaves the area
112846
+ * around the series' graph or markers. This also implies the tooltip. When
111595
112847
  * `stickyTracking` is false and `tooltip.shared` is false, the tooltip will
111596
112848
  * be hidden when moving the mouse between series.
111597
112849
  */
@@ -112112,7 +113364,7 @@ export interface PlotVwapOptions {
112112
113364
  * the development of the series against each other. Adds a `change` field
112113
113365
  * to every point object.
112114
113366
  */
112115
- compare?: string;
113367
+ compare?: OptionsCompareValue;
112116
113368
  /**
112117
113369
  * (Highstock) When compare is `percent`, this option dictates whether to
112118
113370
  * use 0 or 100 as the base of comparison.
@@ -113037,7 +114289,7 @@ export interface PlotWaterfallOptions {
113037
114289
  * the development of the series against each other. Adds a `change` field
113038
114290
  * to every point object.
113039
114291
  */
113040
- compare?: string;
114292
+ compare?: OptionsCompareValue;
113041
114293
  /**
113042
114294
  * (Highstock) When compare is `percent`, this option dictates whether to
113043
114295
  * use 0 or 100 as the base of comparison.
@@ -114045,7 +115297,7 @@ export interface PlotWilliamsrOptions {
114045
115297
  * the development of the series against each other. Adds a `change` field
114046
115298
  * to every point object.
114047
115299
  */
114048
- compare?: string;
115300
+ compare?: OptionsCompareValue;
114049
115301
  /**
114050
115302
  * (Highstock) When compare is `percent`, this option dictates whether to
114051
115303
  * use 0 or 100 as the base of comparison.
@@ -114956,7 +116208,7 @@ export interface PlotWindbarbOptions {
114956
116208
  * the development of the series against each other. Adds a `change` field
114957
116209
  * to every point object.
114958
116210
  */
114959
- compare?: string;
116211
+ compare?: OptionsCompareValue;
114960
116212
  /**
114961
116213
  * (Highstock) When compare is `percent`, this option dictates whether to
114962
116214
  * use 0 or 100 as the base of comparison.
@@ -115917,7 +117169,7 @@ export interface PlotWmaOptions {
115917
117169
  * the development of the series against each other. Adds a `change` field
115918
117170
  * to every point object.
115919
117171
  */
115920
- compare?: string;
117172
+ compare?: OptionsCompareValue;
115921
117173
  /**
115922
117174
  * (Highstock) When compare is `percent`, this option dictates whether to
115923
117175
  * use 0 or 100 as the base of comparison.
@@ -117303,7 +118555,7 @@ export interface PlotXrangeOptions {
117303
118555
  * the development of the series against each other. Adds a `change` field
117304
118556
  * to every point object.
117305
118557
  */
117306
- compare?: string;
118558
+ compare?: OptionsCompareValue;
117307
118559
  /**
117308
118560
  * (Highstock) When compare is `percent`, this option dictates whether to
117309
118561
  * use 0 or 100 as the base of comparison.
@@ -118142,7 +119394,7 @@ export interface PlotZigzagOptions {
118142
119394
  * the development of the series against each other. Adds a `change` field
118143
119395
  * to every point object.
118144
119396
  */
118145
- compare?: string;
119397
+ compare?: OptionsCompareValue;
118146
119398
  /**
118147
119399
  * (Highstock) When compare is `percent`, this option dictates whether to
118148
119400
  * use 0 or 100 as the base of comparison.
@@ -118767,6 +120019,9 @@ export interface PointEventsOptionsObject {
118767
120019
  * (Highcharts, Highstock, Gantt) Fires when the mouse enters the area close
118768
120020
  * to the point. One parameter, `event`, is passed to the function,
118769
120021
  * containing common event information.
120022
+ *
120023
+ * Returning `false` cancels the default behavior, which is to show a
120024
+ * tooltip for the point.
118770
120025
  */
118771
120026
  mouseOver?: PointMouseOverCallbackFunction;
118772
120027
  /**
@@ -118802,7 +120057,7 @@ export interface PointInteractionEventObject extends Event {
118802
120057
  accumulate: boolean;
118803
120058
  }
118804
120059
  /**
118805
- * Configuration hash for the data label and tooltip formatters.
120060
+ * Configuration for the data label and tooltip formatters.
118806
120061
  */
118807
120062
  export interface PointLabelObject {
118808
120063
  /**
@@ -118845,7 +120100,7 @@ export interface PointLabelObject {
118845
120100
  /**
118846
120101
  * The y value of the point.
118847
120102
  */
118848
- y?: number;
120103
+ y?: (number|null);
118849
120104
  }
118850
120105
  /**
118851
120106
  * Information about the legend click event.
@@ -120066,8 +121321,8 @@ export interface SeriesAccessibilityOptionsObject {
120066
121321
  /**
120067
121322
  * (Highstock) Point accessibility options for a series.
120068
121323
  */
120069
- point?: (PlotAbandsAccessibilityPointOptions|PlotAdAccessibilityPointOptions|PlotAoAccessibilityPointOptions|PlotApoAccessibilityPointOptions|PlotAreaAccessibilityPointOptions|
120070
- PlotArearangeAccessibilityPointOptions|PlotAreasplineAccessibilityPointOptions|PlotAreasplinerangeAccessibilityPointOptions|PlotAroonAccessibilityPointOptions|
121324
+ point?: (PlotAbandsAccessibilityPointOptions|PlotAdAccessibilityPointOptions|PlotAoAccessibilityPointOptions|PlotApoAccessibilityPointOptions|PlotArcdiagramAccessibilityPointOptions|
121325
+ PlotAreaAccessibilityPointOptions|PlotArearangeAccessibilityPointOptions|PlotAreasplineAccessibilityPointOptions|PlotAreasplinerangeAccessibilityPointOptions|PlotAroonAccessibilityPointOptions|
120071
121326
  PlotAroonoscillatorAccessibilityPointOptions|PlotAtrAccessibilityPointOptions|PlotBarAccessibilityPointOptions|PlotBbAccessibilityPointOptions|PlotBellcurveAccessibilityPointOptions|
120072
121327
  PlotBoxplotAccessibilityPointOptions|PlotBubbleAccessibilityPointOptions|PlotBulletAccessibilityPointOptions|PlotCandlestickAccessibilityPointOptions|PlotCciAccessibilityPointOptions|
120073
121328
  PlotChaikinAccessibilityPointOptions|PlotCmfAccessibilityPointOptions|PlotCmoAccessibilityPointOptions|PlotColumnAccessibilityPointOptions|PlotColumnpyramidAccessibilityPointOptions|
@@ -120212,6 +121467,361 @@ export interface SeriesApoOptions extends PlotApoOptions, SeriesOptions {
120212
121467
  */
120213
121468
  type: "apo";
120214
121469
  }
121470
+ /**
121471
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the data labels
121472
+ * appearing on top of the nodes and links. For arc diagram charts, data labels
121473
+ * are visible for the nodes by default, but hidden for links. This is
121474
+ * controlled by modifying the `nodeFormat`, and the `format` that applies to
121475
+ * links and is an empty string by default.
121476
+ */
121477
+ export interface SeriesArcDiagramDataLabelsOptionsObject {
121478
+ /**
121479
+ * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data label
121480
+ * compared to the point. If `right`, the right side of the label should be
121481
+ * touching the point. For points with an extent, like columns, the
121482
+ * alignments also dictates how to align it inside the box, as given with
121483
+ * the inside option. Can be one of `left`, `center` or `right`.
121484
+ */
121485
+ align?: string;
121486
+ /**
121487
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels to
121488
+ * overlap. To make the labels less sensitive for overlapping, the
121489
+ * dataLabels.padding can be set to 0.
121490
+ */
121491
+ allowOverlap?: boolean;
121492
+ /**
121493
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
121494
+ * animation when a series is displayed for the `dataLabels`. The animation
121495
+ * can also be set as a configuration object. Please note that this option
121496
+ * only applies to the initial animation. For other animations, see
121497
+ * chart.animation and the animation parameter under the API methods. The
121498
+ * following properties are supported:
121499
+ *
121500
+ * - `defer`: The animation delay time in milliseconds.
121501
+ */
121502
+ animation?: (boolean|PlotArcdiagramDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
121503
+ /**
121504
+ * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
121505
+ * for the data label.
121506
+ */
121507
+ backgroundColor?: string;
121508
+ /**
121509
+ * (Highcharts, Highstock, Highmaps, Gantt) The border color for the data
121510
+ * label. Defaults to `undefined`.
121511
+ */
121512
+ borderColor?: (ColorString|GradientColorObject|PatternObject);
121513
+ /**
121514
+ * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels for
121515
+ * the data label.
121516
+ */
121517
+ borderRadius?: number;
121518
+ /**
121519
+ * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels for
121520
+ * the data label.
121521
+ */
121522
+ borderWidth?: number;
121523
+ /**
121524
+ * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data label.
121525
+ * Particularly in styled mode, this can be used to give each series' or
121526
+ * point's data label unique styling. In addition to this option, a default
121527
+ * color class name is added so that we can give the labels a contrast text
121528
+ * shadow.
121529
+ */
121530
+ className?: string;
121531
+ /**
121532
+ * (Highcharts, Highstock, Highmaps, Gantt) The text color for the data
121533
+ * labels. Defaults to `undefined`. For certain series types, like column or
121534
+ * map, the data labels can be drawn inside the points. In this case the
121535
+ * data label will be drawn with maximum contrast by default. Additionally,
121536
+ * it will be given a `text-outline` style with the opposite color, to
121537
+ * further increase the contrast. This can be overridden by setting the
121538
+ * `text-outline` style to `none` in the `dataLabels.style` option.
121539
+ */
121540
+ color?: (ColorString|GradientColorObject|PatternObject);
121541
+ /**
121542
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels that
121543
+ * are outside the plot area. By default, the data label is moved inside the
121544
+ * plot area according to the overflow option.
121545
+ */
121546
+ crop?: boolean;
121547
+ /**
121548
+ * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
121549
+ * labels until the initial series animation has finished. Setting to
121550
+ * `false` renders the data label immediately. If set to `true` inherits the
121551
+ * defer time set in plotOptions.series.animation. If set to a number, a
121552
+ * defer time is specified in milliseconds.
121553
+ */
121554
+ defer?: (boolean|number);
121555
+ /**
121556
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
121557
+ * labels.
121558
+ */
121559
+ enabled?: boolean;
121560
+ /**
121561
+ * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to control
121562
+ * of which data labels to display. The declarative filter is designed for
121563
+ * use when callback functions are not available, like when the chart
121564
+ * options require a pure JSON structure or for use with graphical editors.
121565
+ * For programmatic control, use the `formatter` instead, and return
121566
+ * `undefined` to disable a single data label.
121567
+ */
121568
+ filter?: DataLabelsFilterOptionsObject;
121569
+ /**
121570
+ * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
121571
+ * label. Available variables are the same as for `formatter`.
121572
+ */
121573
+ format?: string;
121574
+ /**
121575
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function to
121576
+ * format the data label. Note that if a `format` is defined, the format
121577
+ * takes precedence and the formatter is ignored.
121578
+ */
121579
+ formatter?: SeriesSankeyDataLabelsFormatterCallbackFunction;
121580
+ /**
121581
+ * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent, like
121582
+ * columns or map areas, whether to align the data label inside the box or
121583
+ * to the actual value point. Defaults to `false` in most cases, `true` in
121584
+ * stacked columns.
121585
+ */
121586
+ inside?: boolean;
121587
+ /**
121588
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for a _link_ label text
121589
+ * which should follow link connection. Border and background are disabled
121590
+ * for a label that follows a path.
121591
+ *
121592
+ * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
121593
+ * to true will disable this option.
121594
+ */
121595
+ linkTextPath?: (object|PlotArcdiagramDataLabelsLinkTextPathOptions);
121596
+ /**
121597
+ * (Highcharts, Highstock, Highmaps, Gantt) The format string specifying
121598
+ * what to show for _nodes_ in the sankey diagram. By default the
121599
+ * `nodeFormatter` returns `{point.name}`.
121600
+ */
121601
+ nodeFormat?: string;
121602
+ /**
121603
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback to format data labels
121604
+ * for _nodes_ in the sankey diagram. The `nodeFormat` option takes
121605
+ * precedence over the `nodeFormatter`.
121606
+ */
121607
+ nodeFormatter?: SeriesSankeyDataLabelsFormatterCallbackFunction;
121608
+ /**
121609
+ * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the value
121610
+ * of null. Works analogously to format. `nullFormat` can be applied only to
121611
+ * series which support displaying null points.
121612
+ */
121613
+ nullFormat?: (boolean|string);
121614
+ /**
121615
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
121616
+ * that defines formatting for points with the value of null. Works
121617
+ * analogously to formatter. `nullPointFormatter` can be applied only to
121618
+ * series which support displaying null points.
121619
+ */
121620
+ nullFormatter?: DataLabelsFormatterCallbackFunction;
121621
+ /**
121622
+ * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels that
121623
+ * flow outside the plot area. The default is `"justify"`, which aligns them
121624
+ * inside the plot area. For columns and bars, this means it will be moved
121625
+ * inside the bar. To display data labels outside the plot area, set `crop`
121626
+ * to `false` and `overflow` to `"allow"`.
121627
+ */
121628
+ overflow?: DataLabelsOverflowValue;
121629
+ /**
121630
+ * (Highcharts, Highstock, Highmaps, Gantt) When either the `borderWidth` or
121631
+ * the `backgroundColor` is set, this is the padding within the box.
121632
+ */
121633
+ padding?: number;
121634
+ /**
121635
+ * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative to
121636
+ * points. If `center` alignment is not possible, it defaults to `right`.
121637
+ */
121638
+ position?: AlignValue;
121639
+ /**
121640
+ * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees. Note
121641
+ * that due to a more complex structure, backgrounds, borders and padding
121642
+ * will be lost on a rotated data label.
121643
+ */
121644
+ rotation?: number;
121645
+ /**
121646
+ * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
121647
+ * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow can be
121648
+ * an object configuration containing `color`, `offsetX`, `offsetY`,
121649
+ * `opacity` and `width`.
121650
+ */
121651
+ shadow?: (boolean|ShadowOptionsObject);
121652
+ /**
121653
+ * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use for
121654
+ * the border around the label. Symbols are predefined functions on the
121655
+ * Renderer object.
121656
+ */
121657
+ shape?: string;
121658
+ /**
121659
+ * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
121660
+ * default `color` setting is `"contrast"`, which is a pseudo color that
121661
+ * Highcharts picks up and applies the maximum contrast to the underlying
121662
+ * point item, for example the bar in a bar chart.
121663
+ *
121664
+ * The `textOutline` is a pseudo property that applies an outline of the
121665
+ * given width with the given color, which by default is the maximum
121666
+ * contrast to the text. So a bright text color will result in a black text
121667
+ * outline for maximum readability on a mixed background. In some cases,
121668
+ * especially with grayscale text, the text outline doesn't work well, in
121669
+ * which cases it can be disabled by setting it to `"none"`. When `useHTML`
121670
+ * is true, the `textOutline` will not be picked up. In this, case, the same
121671
+ * effect can be acheived through the `text-shadow` CSS property.
121672
+ *
121673
+ * For some series types, where each point has an extent, like for example
121674
+ * tree maps, the data label may overflow the point. There are two
121675
+ * strategies for handling overflow. By default, the text will wrap to
121676
+ * multiple lines. The other strategy is to set `style.textOverflow` to
121677
+ * `ellipsis`, which will keep the text on one line plus it will break
121678
+ * inside long words.
121679
+ */
121680
+ style?: CSSObject;
121681
+ /**
121682
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text which
121683
+ * should follow marker's shape. Border and background are disabled for a
121684
+ * label that follows a path.
121685
+ *
121686
+ * **Note:** Only SVG-based renderer supports this option. Setting `useHTML`
121687
+ * to true will disable this option.
121688
+ */
121689
+ textPath?: DataLabelsTextPathOptionsObject;
121690
+ /**
121691
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to render
121692
+ * the labels.
121693
+ */
121694
+ useHTML?: boolean;
121695
+ /**
121696
+ * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a data
121697
+ * label. Can be one of `top`, `middle` or `bottom`. The default value
121698
+ * depends on the data, for instance in a column chart, the label is above
121699
+ * positive values and below negative values.
121700
+ */
121701
+ verticalAlign?: string;
121702
+ /**
121703
+ * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
121704
+ * label relative to the point in pixels.
121705
+ */
121706
+ x?: number;
121707
+ /**
121708
+ * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
121709
+ * label relative to the point in pixels.
121710
+ */
121711
+ y?: number;
121712
+ /**
121713
+ * (Highcharts, Highstock, Highmaps, Gantt) The Z index of the data labels.
121714
+ * The default Z index puts it above the series. Use a Z index of 2 to
121715
+ * display it behind the series.
121716
+ */
121717
+ z?: number;
121718
+ }
121719
+ /**
121720
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
121721
+ * animation when a series is displayed for the `dataLabels`. The animation can
121722
+ * also be set as a configuration object. Please note that this option only
121723
+ * applies to the initial animation. For other animations, see chart.animation
121724
+ * and the animation parameter under the API methods. The following properties
121725
+ * are supported:
121726
+ *
121727
+ * - `defer`: The animation delay time in milliseconds.
121728
+ */
121729
+ export interface SeriesArcdiagramNodesDataLabelsAnimationOptions {
121730
+ /**
121731
+ * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
121732
+ * milliseconds. Set to `0` renders dataLabel immediately. As `undefined`
121733
+ * inherits defer time from the series.animation.defer.
121734
+ */
121735
+ defer?: number;
121736
+ }
121737
+ /**
121738
+ * (Highcharts) An `arcdiagram` series. If the type option is not specified, it
121739
+ * is inherited from chart.type.
121740
+ *
121741
+ * In TypeScript the type option must always be set.
121742
+ *
121743
+ * Configuration options for the series are given in three levels:
121744
+ *
121745
+ * 1. Options for all series in a chart are defined in the plotOptions.series
121746
+ * object.
121747
+ *
121748
+ * 2. Options for all `arcdiagram` series are defined in plotOptions.arcdiagram.
121749
+ *
121750
+ * 3. Options for one single series are given in the series instance array. (see
121751
+ * online documentation for example)
121752
+ *
121753
+ * You have to extend the `SeriesArcdiagramOptions` via an interface to allow
121754
+ * custom properties: ``` declare interface SeriesArcdiagramOptions {
121755
+ * customProperty: string; }
121756
+ *
121757
+ */
121758
+ export interface SeriesArcdiagramOptions extends PlotArcdiagramOptions, SeriesOptions {
121759
+ /**
121760
+ * Not available
121761
+ */
121762
+ centerInCategory?: undefined;
121763
+ /**
121764
+ * Not available
121765
+ */
121766
+ curveFactor?: undefined;
121767
+ /**
121768
+ * (Highcharts) An array of data points for the series. For the `arcdiagram`
121769
+ * series type, points can be given in the following way:
121770
+ *
121771
+ * An array of objects with named values. The following snippet shows only a
121772
+ * few settings, see the complete options set below. If the total number of
121773
+ * data points exceeds the series' turboThreshold, this option is not
121774
+ * available. (see online documentation for example)
121775
+ */
121776
+ data?: Array<SeriesSankeyPointOptionsObject>;
121777
+ /**
121778
+ * (Highcharts) The radius of the link arc. If not set, series renders a
121779
+ * semi-circle between the nodes, except when overflowing the edge of the
121780
+ * plot area, in which case an arc touching the edge is rendered. If
121781
+ * `linkRadius` is set, an arc extending to the given value is rendered.
121782
+ */
121783
+ linkRadius?: number;
121784
+ /**
121785
+ * (Highcharts) The global link weight. If not set, width is calculated per
121786
+ * link, depending on the weight value.
121787
+ */
121788
+ linkWeight?: number;
121789
+ /**
121790
+ * Not available
121791
+ */
121792
+ nodePadding?: undefined;
121793
+ /**
121794
+ * (Highcharts) A collection of options for the individual nodes. The nodes
121795
+ * in an arc diagram are auto-generated instances of `Highcharts.Point`, but
121796
+ * options can be applied here and linked by the `id`.
121797
+ */
121798
+ nodes?: Array<SeriesSankeyNodesOptionsObject>;
121799
+ /**
121800
+ * (Highcharts) The offset of an arc diagram nodes column in relation to the
121801
+ * `plotArea`. The offset equal to 50% places nodes in the center of a
121802
+ * chart. By default the series is placed so that the biggest node is
121803
+ * touching the bottom border of the `plotArea`.
121804
+ */
121805
+ offset?: string;
121806
+ /**
121807
+ * Not available
121808
+ */
121809
+ stack?: undefined;
121810
+ /**
121811
+ * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
121812
+ * TypeScript non-optional and might be `undefined` in series objects from
121813
+ * unknown sources.
121814
+ */
121815
+ type: "arcdiagram";
121816
+ /**
121817
+ * Not available
121818
+ */
121819
+ xAxis?: undefined;
121820
+ /**
121821
+ * Not available
121822
+ */
121823
+ yAxis?: undefined;
121824
+ }
120215
121825
  /**
120216
121826
  * (Highcharts, Highstock, Gantt) Enable or disable the initial animation when a
120217
121827
  * series is displayed for the `dataLabels`. The animation can also be set as a
@@ -122335,7 +123945,8 @@ export interface SeriesDragDropOptionsObject {
122335
123945
  */
122336
123946
  draggableY?: boolean;
122337
123947
  /**
122338
- * (Highcharts, Highstock, Gantt) Options for the drag handles.
123948
+ * (Highcharts, Highstock, Gantt) Options for the drag handles available in
123949
+ * column series.
122339
123950
  */
122340
123951
  dragHandle?: DragDropHandleOptionsObject;
122341
123952
  /**
@@ -124118,10 +125729,6 @@ export interface SeriesLineDataDragDropOptions {
124118
125729
  * Gantt charts).
124119
125730
  */
124120
125731
  draggableY?: boolean;
124121
- /**
124122
- * (Highcharts, Highstock, Gantt) Options for the drag handles.
124123
- */
124124
- dragHandle?: DragDropHandleOptionsObject;
124125
125732
  /**
124126
125733
  * (Highcharts, Highstock, Gantt) Set the maximum X value the points can be
124127
125734
  * moved to.
@@ -124936,13 +126543,11 @@ export interface SeriesMappointDataOptions {
124936
126543
  */
124937
126544
  name?: string;
124938
126545
  /**
124939
- * (Highmaps) The x coordinate of the point in terms of the map path
124940
- * coordinates.
126546
+ * (Highmaps) The x coordinate of the point in terms of projected units.
124941
126547
  */
124942
126548
  x?: number;
124943
126549
  /**
124944
- * (Highmaps) The x coordinate of the point in terms of the map path
124945
- * coordinates.
126550
+ * (Highmaps) The x coordinate of the point in terms of projected units.
124946
126551
  */
124947
126552
  y?: (number|null);
124948
126553
  }
@@ -125664,11 +127269,12 @@ export interface SeriesOptions {
125664
127269
  */
125665
127270
  legendIndex?: number;
125666
127271
  /**
125667
- * (Highmaps) A map data object containing a `geometry` or `path` definition
125668
- * and optionally additional properties to join in the `data` as per the
125669
- * `joinBy` option.
127272
+ * (Highmaps) An array of objects containing a `geometry` or `path`
127273
+ * definition and optionally additional properties to join in the `data` as
127274
+ * per the `joinBy` option. GeoJSON and TopoJSON structures can also be
127275
+ * passed directly into `mapData`.
125670
127276
  */
125671
- mapData?: (Array<SeriesMapDataOptions>|any);
127277
+ mapData?: (GeoJSON|TopoJSON|Array<SeriesMapDataOptions>);
125672
127278
  /**
125673
127279
  * (Highcharts, Highstock, Highmaps, Gantt) The name of the series as shown
125674
127280
  * in the legend, tooltip etc.
@@ -125715,6 +127321,7 @@ export interface SeriesOptionsRegistry {
125715
127321
  SeriesAdOptions: SeriesAdOptions;
125716
127322
  SeriesAoOptions: SeriesAoOptions;
125717
127323
  SeriesApoOptions: SeriesApoOptions;
127324
+ SeriesArcdiagramOptions: SeriesArcdiagramOptions;
125718
127325
  SeriesAreaOptions: SeriesAreaOptions;
125719
127326
  SeriesArearangeOptions: SeriesArearangeOptions;
125720
127327
  SeriesAreasplineOptions: SeriesAreasplineOptions;
@@ -127631,9 +129238,9 @@ export interface SeriesSankeyDataLabelsOptionsObject {
127631
129238
  *
127632
129239
  * - `defer`: The animation delay time in milliseconds.
127633
129240
  */
127634
- animation?: (boolean|PlotDependencywheelDataLabelsAnimationOptions|PlotDependencywheelLevelsDataLabelsAnimationOptions|PlotOrganizationLevelsDataLabelsAnimationOptions|
127635
- PlotSankeyDataLabelsAnimationOptions|PlotSankeyLevelsDataLabelsAnimationOptions|SeriesDependencywheelNodesDataLabelsAnimationOptions|SeriesOrganizationNodesDataLabelsAnimationOptions|
127636
- SeriesSankeyNodesDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
129241
+ animation?: (boolean|PlotArcdiagramLevelsDataLabelsAnimationOptions|PlotDependencywheelDataLabelsAnimationOptions|PlotDependencywheelLevelsDataLabelsAnimationOptions|
129242
+ PlotOrganizationLevelsDataLabelsAnimationOptions|PlotSankeyDataLabelsAnimationOptions|PlotSankeyLevelsDataLabelsAnimationOptions|SeriesArcdiagramNodesDataLabelsAnimationOptions|
129243
+ SeriesDependencywheelNodesDataLabelsAnimationOptions|SeriesOrganizationNodesDataLabelsAnimationOptions|SeriesSankeyNodesDataLabelsAnimationOptions|Partial<AnimationOptionsObject>);
127637
129244
  /**
127638
129245
  * (Highcharts, Highstock, Highmaps, Gantt) The background color or gradient
127639
129246
  * for the data label.
@@ -127886,7 +129493,8 @@ export interface SeriesSankeyNodesOptionsObject {
127886
129493
  * (Highcharts, Highstock, Highmaps, Gantt) Individual data label for each
127887
129494
  * node. The options are the same as the ones for series.sankey.dataLabels.
127888
129495
  */
127889
- dataLabels?: (SeriesOrganizationDataLabelsOptionsObject|SeriesSankeyDataLabelsOptionsObject|Array<SeriesOrganizationDataLabelsOptionsObject>|Array<SeriesSankeyDataLabelsOptionsObject>);
129496
+ dataLabels?: (SeriesArcDiagramDataLabelsOptionsObject|SeriesOrganizationDataLabelsOptionsObject|SeriesSankeyDataLabelsOptionsObject|Array<SeriesArcDiagramDataLabelsOptionsObject>|
129497
+ Array<SeriesOrganizationDataLabelsOptionsObject>|Array<SeriesSankeyDataLabelsOptionsObject>);
127890
129498
  /**
127891
129499
  * (Highcharts) The job description for the node card, will be inserted by
127892
129500
  * the default `dataLabel.nodeFormatter`.
@@ -127906,6 +129514,9 @@ export interface SeriesSankeyNodesOptionsObject {
127906
129514
  * (Highcharts) Layout for the node's children. If `hanging`, this node's
127907
129515
  * children will hang below their parent, allowing a tighter packing of
127908
129516
  * nodes in the diagram.
129517
+ *
129518
+ * Note: Since @next version, the `hanging` layout is set by default for
129519
+ * children of a parent using `hanging` layout.
127909
129520
  */
127910
129521
  layout?: SeriesOrganizationNodesLayoutValue;
127911
129522
  /**
@@ -128080,8 +129691,8 @@ export interface SeriesSankeyPointOptionsObject {
128080
129691
  * (Highcharts) Individual data label for each point. The options are the
128081
129692
  * same as the ones for plotOptions.series.dataLabels.
128082
129693
  */
128083
- dataLabels?: (DataLabelsOptions|SeriesOrganizationDataLabelsOptionsObject|SeriesSankeyDataLabelsOptionsObject|Array<SeriesOrganizationDataLabelsOptionsObject>|
128084
- Array<SeriesSankeyDataLabelsOptionsObject>);
129694
+ dataLabels?: (DataLabelsOptions|SeriesArcDiagramDataLabelsOptionsObject|SeriesOrganizationDataLabelsOptionsObject|SeriesSankeyDataLabelsOptionsObject|
129695
+ Array<SeriesArcDiagramDataLabelsOptionsObject>|Array<SeriesOrganizationDataLabelsOptionsObject>|Array<SeriesSankeyDataLabelsOptionsObject>);
128085
129696
  /**
128086
129697
  * (Highcharts) A description of the point to add to the screen reader
128087
129698
  * information about the point.
@@ -131770,17 +133381,14 @@ export interface TitleOptions {
131770
133381
  */
131771
133382
  y?: number;
131772
133383
  }
131773
- export interface TooltipFormatterContextObject {
131774
- color: (ColorString|GradientColorObject|PatternObject);
131775
- colorIndex?: number;
131776
- key: number;
131777
- percentage?: number;
131778
- point: Point;
133384
+ /**
133385
+ * Configuration for the tooltip formatters.
133386
+ */
133387
+ export interface TooltipFormatterContextObject extends PointLabelObject {
133388
+ /**
133389
+ * Array of points in shared tooltips.
133390
+ */
131779
133391
  points?: Array<TooltipFormatterContextObject>;
131780
- series: Series;
131781
- total?: number;
131782
- x: number;
131783
- y: number;
131784
133392
  }
131785
133393
  /**
131786
133394
  * (Highcharts, Highstock, Highmaps, Gantt) Options for the tooltip that appears
@@ -137161,6 +138769,24 @@ export class AST {
137161
138769
  * harmful content from the chart configuration before adding to the DOM.
137162
138770
  */
137163
138771
  static allowedTags: any;
138772
+ /**
138773
+ * Allow all custom SVG and HTML attributes, references and tags (together
138774
+ * with potentially harmful ones) to be added to the DOM from the chart
138775
+ * configuration. In other words, disable the the allow-listing which is the
138776
+ * primary functionality of the AST.
138777
+ *
138778
+ * WARNING: Setting this property to `true` while allowing untrusted user
138779
+ * data in the chart configuration will expose your application to XSS
138780
+ * security risks!
138781
+ *
138782
+ * Note that in case you want to allow a known set of tags or attributes,
138783
+ * you should allow-list them instead of disabling the filtering totally.
138784
+ * See allowedAttributes, allowedReferences and allowedTags. The
138785
+ * `bypassHTMLFiltering` setting is intended only for those cases where
138786
+ * allow-listing is not practical, and the chart configuration already comes
138787
+ * from a secure source.
138788
+ */
138789
+ static bypassHTMLFiltering: any;
137164
138790
  /**
137165
138791
  * The AST class represents an abstract syntax tree of HTML or SVG content.
137166
138792
  * It can take HTML as an argument, parse it, optionally transform it to
@@ -138331,6 +139957,18 @@ export class Point {
138331
139957
  * The percentage for points in a stacked series or pies.
138332
139958
  */
138333
139959
  percentage?: number;
139960
+ /**
139961
+ * The translated X value for the point in terms of pixels. Relative to the
139962
+ * X axis position if the series has one, otherwise relative to the plot
139963
+ * area. Depending on the series type this value might not be defined.
139964
+ */
139965
+ plotX?: number;
139966
+ /**
139967
+ * The translated Y value for the point in terms of pixels. Relative to the
139968
+ * Y axis position if the series has one, otherwise relative to the plot
139969
+ * area. Depending on the series type this value might not be defined.
139970
+ */
139971
+ plotY?: number;
138334
139972
  /**
138335
139973
  * Whether the point is selected or not.
138336
139974
  */
@@ -138500,6 +140138,20 @@ export class Point {
138500
140138
  * @fires Highcharts.Point#afterSetState
138501
140139
  */
138502
140140
  setState(state?: (""|PointStateValue), move?: boolean): void;
140141
+ /**
140142
+ * Toggle the visibility of a pie slice or other data point. Note that this
140143
+ * method is available only for some series, like pie, treemap and sunburst.
140144
+ *
140145
+ * @param vis
140146
+ * True to show the pie slice or other data point, false to hide. If
140147
+ * undefined, the visibility is toggled.
140148
+ *
140149
+ * @param redraw
140150
+ * Whether to redraw the chart after the point is altered. If doing
140151
+ * more operations on the chart, it is a good idea to set redraw to
140152
+ * false and call chart.redraw() after.
140153
+ */
140154
+ setVisible(vis?: boolean, redraw?: boolean): void;
138503
140155
  /**
138504
140156
  * Extendable method for formatting each point's tooltip line.
138505
140157
  *
@@ -138609,6 +140261,9 @@ export class Pointer {
138609
140261
  * properties `chartX` and `chartY` in order to work on the internal
138610
140262
  * coordinate system.
138611
140263
  *
140264
+ * On map charts, the properties `lon` and `lat` are added to the event
140265
+ * object given that the chart has projection information.
140266
+ *
138612
140267
  * @param e
138613
140268
  * Event object in standard browsers.
138614
140269
  *
@@ -140212,8 +141867,11 @@ export class Tooltip {
140212
141867
  /**
140213
141868
  * In case no user defined formatter is given, this will be used. Note that
140214
141869
  * the context here is an object holding point, series, x, y etc.
141870
+ *
141871
+ * @return Returns a string (single tooltip and shared) or an array of
141872
+ * strings (split tooltip)
140215
141873
  */
140216
- defaultFormatter(): void;
141874
+ defaultFormatter(tooltip: Tooltip): (string|Array<string>);
140217
141875
  /**
140218
141876
  * Removes and destroys the tooltip and its elements.
140219
141877
  */
@@ -140360,7 +142018,7 @@ export function arrayMin(data: Array<any>): number;
140360
142018
  * @param elem
140361
142019
  * The DOM element to receive the attribute(s).
140362
142020
  *
140363
- * @param prop
142021
+ * @param keyOrAttribs
140364
142022
  * The property or an object of key-value pairs.
140365
142023
  *
140366
142024
  * @param value
@@ -140368,7 +142026,7 @@ export function arrayMin(data: Array<any>): number;
140368
142026
  *
140369
142027
  * @return When used as a getter, return the value.
140370
142028
  */
140371
- export function attr(elem: (HTMLDOMElement|SVGDOMElement), prop?: (string|HTMLAttributes|SVGAttributes), value?: (number|string)): (string|null|undefined);
142029
+ export function attr(elem: (HTMLDOMElement|SVGDOMElement), keyOrAttribs?: (string|HTMLAttributes|SVGAttributes), value?: (number|string)): (string|null|undefined);
140372
142030
  /**
140373
142031
  * Factory function for basic charts.
140374
142032
  *
@@ -140405,7 +142063,7 @@ export function chart(renderTo: (string|HTMLDOMElement), options: Options, callb
140405
142063
  * @param id
140406
142064
  * Id of a timeout.
140407
142065
  */
140408
- export function clearTimeout(id: number): void;
142066
+ export function clearTimeout(id: (number|undefined)): void;
140409
142067
  /**
140410
142068
  * Creates a color instance out of a color string.
140411
142069
  *