highcharts 13.0.2 → 13.1.1

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 (1166) hide show
  1. package/bower.json +1 -1
  2. package/css/highcharts.css +6 -2
  3. package/es-modules/Accessibility/Components/InfoRegionsComponent.js +10 -6
  4. package/es-modules/Accessibility/Components/SeriesComponent/SeriesComponent.js +2 -1
  5. package/es-modules/Accessibility/Components/SeriesComponent/SeriesDescriber.js +25 -1
  6. package/es-modules/Accessibility/KeyboardNavigation.js +1 -1
  7. package/es-modules/Accessibility/Utils/HTMLUtilities.js +13 -3
  8. package/es-modules/Core/Animation/AnimationUtilities.js +7 -2
  9. package/es-modules/Core/Animation/Fx.js +1 -0
  10. package/es-modules/Core/Axis/Axis.js +181 -211
  11. package/es-modules/Core/Axis/Axis3DComposition.js +13 -15
  12. package/es-modules/Core/Axis/AxisDefaults.js +9 -8
  13. package/es-modules/Core/Axis/BrokenAxis.js +5 -4
  14. package/es-modules/Core/Axis/Color/ColorAxis.js +66 -54
  15. package/es-modules/Core/Axis/Color/ColorAxisComposition.js +3 -0
  16. package/es-modules/Core/Axis/Color/ColorAxisDefaults.js +6 -4
  17. package/es-modules/Core/Axis/DateTimeAxis.js +4 -3
  18. package/es-modules/Core/Axis/GridAxis.js +17 -13
  19. package/es-modules/Core/Axis/LogarithmicAxis.js +4 -3
  20. package/es-modules/Core/Axis/NavigatorAxisComposition.js +3 -4
  21. package/es-modules/Core/Axis/OrdinalAxis.js +0 -15
  22. package/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js +135 -72
  23. package/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBandAxis.js +72 -124
  24. package/es-modules/Core/Axis/RadialAxis.js +50 -7
  25. package/es-modules/Core/Axis/ScrollbarAxis.js +3 -0
  26. package/es-modules/Core/Axis/Stacking/StackItem.js +49 -75
  27. package/es-modules/Core/Axis/Stacking/StackingAxis.js +34 -22
  28. package/es-modules/Core/Axis/Tick.js +95 -92
  29. package/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js +9 -13
  30. package/es-modules/Core/Axis/WaterfallAxis.js +1 -1
  31. package/es-modules/Core/Chart/Chart.js +13 -4
  32. package/es-modules/Core/Chart/StockChart.js +20 -26
  33. package/es-modules/Core/Defaults.js +18 -0
  34. package/es-modules/Core/Globals.js +9 -7
  35. package/es-modules/Core/Pointer.js +7 -8
  36. package/es-modules/Core/Renderer/HTML/AST.js +19 -12
  37. package/es-modules/Core/Renderer/HTML/HTMLElement.js +5 -1
  38. package/es-modules/Core/Renderer/SVG/SVGElement.js +1 -0
  39. package/es-modules/Core/Renderer/SVG/SVGRenderer.js +1 -1
  40. package/es-modules/Core/Renderer/SVG/Symbols.js +1 -1
  41. package/es-modules/Core/Renderer/SVG/TextBuilder.js +6 -2
  42. package/es-modules/Core/Series/OverlappingDataLabels.js +41 -32
  43. package/es-modules/Core/Series/Point.js +14 -11
  44. package/es-modules/Core/Series/Series.js +21 -10
  45. package/es-modules/Core/Tooltip.js +35 -40
  46. package/es-modules/Data/DataCursor.js +3 -2
  47. package/es-modules/Data/DataTable.js +21 -2
  48. package/es-modules/Data/DataTableCore.js +28 -4
  49. package/es-modules/Data/Formula/FormulaParser.js +30 -10
  50. package/es-modules/Extensions/Annotations/Annotation.js +5 -7
  51. package/es-modules/Extensions/Annotations/AnnotationChart.js +2 -1
  52. package/es-modules/Extensions/Boost/BoostSeries.js +4 -13
  53. package/es-modules/Extensions/Breadcrumbs/Breadcrumbs.js +6 -4
  54. package/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js +1 -1
  55. package/es-modules/Extensions/Data.js +4 -2
  56. package/es-modules/Extensions/DragPanes/DragPanes.js +6 -9
  57. package/es-modules/Extensions/Drilldown/Drilldown.js +9 -4
  58. package/es-modules/Extensions/ExportData/ExportData.js +24 -4
  59. package/es-modules/Extensions/Pane/Pane.js +1 -1
  60. package/es-modules/Extensions/ParallelCoordinates/ParallelAxis.js +5 -4
  61. package/es-modules/Extensions/StaticScale.js +13 -11
  62. package/es-modules/Series/Area/AreaSeriesDefaults.js +1 -1
  63. package/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js +1 -1
  64. package/es-modules/Series/AreaSpline/AreaSplineSeries.js +1 -1
  65. package/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js +1 -1
  66. package/es-modules/Series/Bar/BarSeries.js +1 -1
  67. package/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js +1 -1
  68. package/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js +1 -1
  69. package/es-modules/Series/Bubble/BubbleSeries.js +1 -1
  70. package/es-modules/Series/Bullet/BulletSeriesDefaults.js +1 -1
  71. package/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js +1 -1
  72. package/es-modules/Series/Column/ColumnSeriesDefaults.js +6 -3
  73. package/es-modules/Series/ColumnPyramid/ColumnPyramidSeriesDefaults.js +2 -3
  74. package/es-modules/Series/ColumnRange/ColumnRangeSeriesDefaults.js +1 -1
  75. package/es-modules/Series/Contour/ContourSeriesDefaults.js +12 -14
  76. package/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js +1 -1
  77. package/es-modules/Series/Flags/FlagsPoint.js +4 -2
  78. package/es-modules/Series/Flags/FlagsPointOptions.js +12 -0
  79. package/es-modules/Series/Flags/FlagsSeries.js +8 -7
  80. package/es-modules/Series/Flags/FlagsSeriesDefaults.js +7 -7
  81. package/es-modules/Series/Flags/FlagsSeriesOptions.js +12 -0
  82. package/es-modules/Series/Flags/FlagsSymbols.js +5 -3
  83. package/es-modules/Series/Funnel/FunnelSeriesDefaults.js +1 -1
  84. package/es-modules/Series/Gauge/GaugeSeries.js +1 -1
  85. package/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js +1 -1
  86. package/es-modules/Series/HLC/HLCSeriesDefaults.js +1 -7
  87. package/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js +1 -1
  88. package/es-modules/Series/HeikinAshi/HeikinAshiSeriesDefaults.js +1 -1
  89. package/es-modules/Series/Histogram/HistogramSeriesDefaults.js +1 -1
  90. package/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js +1 -1
  91. package/es-modules/Series/Item/ItemSeriesDefaults.js +1 -1
  92. package/es-modules/Series/Line/LineSeries.js +0 -1
  93. package/es-modules/Series/Map/MapSeriesDefaults.js +1 -1
  94. package/es-modules/Series/MapBubble/MapBubbleSeries.js +0 -1
  95. package/es-modules/Series/MapLine/MapLineSeriesDefaults.js +1 -1
  96. package/es-modules/Series/MapPoint/MapPointSeriesDefaults.js +0 -1
  97. package/es-modules/Series/Networkgraph/ReingoldFruchtermanLayout.js +5 -5
  98. package/es-modules/Series/OHLC/OHLCSeriesDefaults.js +0 -1
  99. package/es-modules/Series/PackedBubble/PackedBubbleChart.js +18 -0
  100. package/es-modules/Series/PackedBubble/PackedBubbleDataLabelOptions.js +12 -0
  101. package/es-modules/Series/PackedBubble/PackedBubbleIntegration.js +3 -3
  102. package/es-modules/Series/PackedBubble/PackedBubbleLayout.js +2 -2
  103. package/es-modules/Series/PackedBubble/PackedBubblePoint.js +1 -1
  104. package/es-modules/Series/PackedBubble/PackedBubblePointOptions.js +12 -0
  105. package/es-modules/Series/PackedBubble/PackedBubbleSeries.js +20 -20
  106. package/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js +2 -2
  107. package/es-modules/Series/PackedBubble/PackedBubbleSeriesOptions.js +12 -0
  108. package/es-modules/Series/ParetoSeries/ParetoPoint.js +17 -0
  109. package/es-modules/Series/ParetoSeries/ParetoPointOptions.js +12 -0
  110. package/es-modules/Series/ParetoSeries/ParetoSeries.js +3 -3
  111. package/es-modules/Series/ParetoSeries/ParetoSeriesDefaults.js +1 -1
  112. package/es-modules/Series/ParetoSeries/ParetoSeriesOptions.js +12 -0
  113. package/es-modules/Series/PathUtilities.js +3 -1
  114. package/es-modules/Series/Pictorial/PictorialPointOptions.js +12 -0
  115. package/es-modules/Series/Pictorial/PictorialSeries.js +5 -25
  116. package/es-modules/Series/Pictorial/PictorialSeriesDefaults.js +45 -0
  117. package/es-modules/Series/Pictorial/PictorialSeriesOptions.js +12 -0
  118. package/es-modules/Series/Pie/PieSeriesDefaults.js +1 -1
  119. package/es-modules/Series/Pie3D/Pie3DPoint.js +1 -1
  120. package/es-modules/Series/Pie3D/Pie3DSeries.js +6 -6
  121. package/es-modules/Series/PolarComposition.js +22 -21
  122. package/es-modules/Series/Polygon/PolygonPoint.js +17 -0
  123. package/es-modules/Series/Polygon/PolygonPointOptions.js +12 -0
  124. package/es-modules/Series/Polygon/PolygonSeriesDefaults.js +1 -1
  125. package/es-modules/Series/Polygon/PolygonSeriesOptions.js +12 -0
  126. package/es-modules/Series/Pyramid/PyramidPoint.js +19 -0
  127. package/es-modules/Series/Pyramid/PyramidPointOptions.js +14 -0
  128. package/es-modules/Series/Pyramid/PyramidSeries.js +1 -1
  129. package/es-modules/Series/Pyramid/PyramidSeriesDefaults.js +1 -1
  130. package/es-modules/Series/Pyramid/PyramidSeriesOptions.js +14 -0
  131. package/es-modules/Series/Pyramid3D/Pyramid3DPoint.js +19 -0
  132. package/es-modules/Series/Pyramid3D/Pyramid3DPointOptions.js +14 -0
  133. package/es-modules/Series/Pyramid3D/Pyramid3DSeries.js +1 -1
  134. package/es-modules/Series/Pyramid3D/Pyramid3DSeriesOptions.js +14 -0
  135. package/es-modules/Series/Renko/RenkoSeriesDefaults.js +1 -2
  136. package/es-modules/Series/Sankey/SankeySeriesDefaults.js +6 -7
  137. package/es-modules/Series/Scatter/ScatterSeriesDefaults.js +1 -1
  138. package/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js +1 -1
  139. package/es-modules/Series/Spline/SplineSeries.js +1 -1
  140. package/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js +1 -1
  141. package/es-modules/Series/Sunburst/SunburstSeriesDefaults.js +1 -1
  142. package/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js +2 -2
  143. package/es-modules/Series/Tilemap/TilemapSeriesDefaults.js +1 -1
  144. package/es-modules/Series/Timeline/TimelineSeriesDefaults.js +1 -1
  145. package/es-modules/Series/Treemap/TreemapSeriesDefaults.js +1 -1
  146. package/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js +1 -1
  147. package/es-modules/Series/Variwide/VariwideComposition.js +11 -8
  148. package/es-modules/Series/Vector/VectorSeriesDefaults.js +1 -1
  149. package/es-modules/Series/Venn/VennSeriesDefaults.js +1 -1
  150. package/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js +1 -1
  151. package/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js +1 -1
  152. package/es-modules/Shared/Utilities.js +7 -0
  153. package/es-modules/Stock/Indicators/ABands/ABandsIndicator.js +1 -1
  154. package/es-modules/Stock/Indicators/AD/ADIndicator.js +0 -1
  155. package/es-modules/Stock/Indicators/AO/AOIndicator.js +1 -1
  156. package/es-modules/Stock/Indicators/APO/APOIndicator.js +1 -1
  157. package/es-modules/Stock/Indicators/ATR/ATRIndicator.js +0 -1
  158. package/es-modules/Stock/Indicators/Aroon/AroonIndicator.js +1 -1
  159. package/es-modules/Stock/Indicators/AroonOscillator/AroonOscillatorIndicator.js +2 -2
  160. package/es-modules/Stock/Indicators/BB/BBIndicator.js +0 -1
  161. package/es-modules/Stock/Indicators/CCI/CCIIndicator.js +0 -1
  162. package/es-modules/Stock/Indicators/CMF/CMFIndicator.js +0 -1
  163. package/es-modules/Stock/Indicators/CMO/CMOIndicator.js +0 -1
  164. package/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js +1 -1
  165. package/es-modules/Stock/Indicators/DEMA/DEMAIndicator.js +1 -1
  166. package/es-modules/Stock/Indicators/DMI/DMIIndicator.js +3 -3
  167. package/es-modules/Stock/Indicators/DPO/DPOIndicator.js +1 -1
  168. package/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js +3 -3
  169. package/es-modules/Stock/Indicators/EMA/EMAIndicator.js +0 -1
  170. package/es-modules/Stock/Indicators/IKH/IKHIndicator.js +0 -1
  171. package/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js +1 -1
  172. package/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js +0 -1
  173. package/es-modules/Stock/Indicators/LinearRegressionAngle/LinearRegressionAngleIndicator.js +0 -1
  174. package/es-modules/Stock/Indicators/LinearRegressionIntercept/LinearRegressionInterceptIndicator.js +0 -1
  175. package/es-modules/Stock/Indicators/LinearRegressionSlopes/LinearRegressionSlopesIndicator.js +0 -1
  176. package/es-modules/Stock/Indicators/MACD/MACDIndicator.js +0 -1
  177. package/es-modules/Stock/Indicators/MFI/MFIIndicator.js +0 -1
  178. package/es-modules/Stock/Indicators/Momentum/MomentumIndicator.js +0 -1
  179. package/es-modules/Stock/Indicators/NATR/NATRIndicator.js +0 -1
  180. package/es-modules/Stock/Indicators/OBV/OBVIndicator.js +0 -1
  181. package/es-modules/Stock/Indicators/PC/PCIndicator.js +1 -1
  182. package/es-modules/Stock/Indicators/PPO/PPOIndicator.js +1 -1
  183. package/es-modules/Stock/Indicators/PSAR/PSARIndicator.js +0 -1
  184. package/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js +0 -1
  185. package/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js +0 -1
  186. package/es-modules/Stock/Indicators/ROC/ROCIndicator.js +0 -1
  187. package/es-modules/Stock/Indicators/RSI/RSIIndicator.js +0 -1
  188. package/es-modules/Stock/Indicators/SMA/SMAIndicator.js +1 -1
  189. package/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js +3 -3
  190. package/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js +1 -1
  191. package/es-modules/Stock/Indicators/TEMA/TEMAIndicator.js +1 -1
  192. package/es-modules/Stock/Indicators/TRIX/TRIXIndicator.js +1 -1
  193. package/es-modules/Stock/Indicators/TrendLine/TrendLineIndicator.js +0 -1
  194. package/es-modules/Stock/Indicators/VBP/VBPIndicator.js +1 -1
  195. package/es-modules/Stock/Indicators/VWAP/VWAPIndicator.js +0 -1
  196. package/es-modules/Stock/Indicators/WMA/WMAIndicator.js +0 -1
  197. package/es-modules/Stock/Indicators/WilliamsR/WilliamsRIndicator.js +1 -1
  198. package/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js +0 -1
  199. package/es-modules/Stock/Navigator/ChartNavigatorComposition.js +5 -5
  200. package/es-modules/Stock/Navigator/Navigator.js +1 -5
  201. package/es-modules/Stock/Navigator/StandaloneNavigator.js +38 -8
  202. package/es-modules/Stock/RangeSelector/RangeSelectorComposition.js +2 -2
  203. package/es-modules/Stock/Scrollbar/ScrollbarDefaults.js +1 -3
  204. package/es-modules/masters/highcharts-3d.src.js +1 -1
  205. package/es-modules/masters/highcharts-autoload.src.js +1 -1
  206. package/es-modules/masters/highcharts-gantt.src.js +1 -1
  207. package/es-modules/masters/highcharts-more.src.js +1 -1
  208. package/es-modules/masters/highcharts.src.js +1 -1
  209. package/es-modules/masters/highmaps.src.js +1 -1
  210. package/es-modules/masters/highstock.src.js +1 -1
  211. package/es-modules/masters/i18n/fr-FR.src.d.ts +1 -1
  212. package/es-modules/masters/i18n/fr-FR.src.js +1 -1
  213. package/es-modules/masters/i18n/nb-NO.src.d.ts +1 -1
  214. package/es-modules/masters/i18n/nb-NO.src.js +1 -1
  215. package/es-modules/masters/i18n/zh-CN.src.d.ts +1 -1
  216. package/es-modules/masters/i18n/zh-CN.src.js +1 -1
  217. package/es-modules/masters/indicators/acceleration-bands.src.js +1 -1
  218. package/es-modules/masters/indicators/accumulation-distribution.src.js +1 -1
  219. package/es-modules/masters/indicators/ao.src.js +1 -1
  220. package/es-modules/masters/indicators/apo.src.js +1 -1
  221. package/es-modules/masters/indicators/aroon-oscillator.src.js +1 -1
  222. package/es-modules/masters/indicators/aroon.src.js +1 -1
  223. package/es-modules/masters/indicators/atr.src.js +1 -1
  224. package/es-modules/masters/indicators/bollinger-bands.src.js +1 -1
  225. package/es-modules/masters/indicators/cci.src.js +1 -1
  226. package/es-modules/masters/indicators/chaikin.src.js +1 -1
  227. package/es-modules/masters/indicators/cmf.src.js +1 -1
  228. package/es-modules/masters/indicators/cmo.src.js +1 -1
  229. package/es-modules/masters/indicators/dema.src.js +1 -1
  230. package/es-modules/masters/indicators/disparity-index.src.js +1 -1
  231. package/es-modules/masters/indicators/dmi.src.js +1 -1
  232. package/es-modules/masters/indicators/dpo.src.js +1 -1
  233. package/es-modules/masters/indicators/ichimoku-kinko-hyo.src.js +1 -1
  234. package/es-modules/masters/indicators/indicators-all.src.js +1 -1
  235. package/es-modules/masters/indicators/indicators.src.js +1 -1
  236. package/es-modules/masters/indicators/keltner-channels.src.js +1 -1
  237. package/es-modules/masters/indicators/klinger.src.js +1 -1
  238. package/es-modules/masters/indicators/macd.src.js +1 -1
  239. package/es-modules/masters/indicators/mfi.src.js +1 -1
  240. package/es-modules/masters/indicators/momentum.src.js +1 -1
  241. package/es-modules/masters/indicators/natr.src.js +1 -1
  242. package/es-modules/masters/indicators/obv.src.js +1 -1
  243. package/es-modules/masters/indicators/pivot-points.src.js +1 -1
  244. package/es-modules/masters/indicators/ppo.src.js +1 -1
  245. package/es-modules/masters/indicators/price-channel.src.js +1 -1
  246. package/es-modules/masters/indicators/price-envelopes.src.js +1 -1
  247. package/es-modules/masters/indicators/psar.src.js +1 -1
  248. package/es-modules/masters/indicators/regressions.src.js +1 -1
  249. package/es-modules/masters/indicators/roc.src.js +1 -1
  250. package/es-modules/masters/indicators/rsi.src.js +1 -1
  251. package/es-modules/masters/indicators/slow-stochastic.src.js +1 -1
  252. package/es-modules/masters/indicators/stochastic.src.js +1 -1
  253. package/es-modules/masters/indicators/supertrend.src.js +1 -1
  254. package/es-modules/masters/indicators/tema.src.js +1 -1
  255. package/es-modules/masters/indicators/trendline.src.js +1 -1
  256. package/es-modules/masters/indicators/trix.src.js +1 -1
  257. package/es-modules/masters/indicators/volume-by-price.src.js +1 -1
  258. package/es-modules/masters/indicators/vwap.src.js +1 -1
  259. package/es-modules/masters/indicators/williams-r.src.js +1 -1
  260. package/es-modules/masters/indicators/wma.src.js +1 -1
  261. package/es-modules/masters/indicators/zigzag.src.js +1 -1
  262. package/es-modules/masters/modules/accessibility.src.js +1 -1
  263. package/es-modules/masters/modules/annotations-advanced.src.js +1 -1
  264. package/es-modules/masters/modules/annotations.src.js +1 -1
  265. package/es-modules/masters/modules/arc-diagram.src.js +1 -1
  266. package/es-modules/masters/modules/arrow-symbols.src.js +1 -1
  267. package/es-modules/masters/modules/boost-canvas.src.js +1 -1
  268. package/es-modules/masters/modules/boost.src.js +1 -1
  269. package/es-modules/masters/modules/broken-axis.src.js +1 -1
  270. package/es-modules/masters/modules/bullet.src.js +1 -1
  271. package/es-modules/masters/modules/coloraxis.src.js +1 -1
  272. package/es-modules/masters/modules/contour.src.js +1 -1
  273. package/es-modules/masters/modules/current-date-indicator.src.js +1 -1
  274. package/es-modules/masters/modules/cylinder.src.js +1 -1
  275. package/es-modules/masters/modules/data-sorting.src.js +1 -1
  276. package/es-modules/masters/modules/data-tools.src.js +1 -1
  277. package/es-modules/masters/modules/data.src.js +1 -1
  278. package/es-modules/masters/modules/datagrouping.src.js +1 -1
  279. package/es-modules/masters/modules/debugger.src.js +1 -1
  280. package/es-modules/masters/modules/dependency-wheel.src.js +1 -1
  281. package/es-modules/masters/modules/dotplot.src.js +1 -1
  282. package/es-modules/masters/modules/drag-panes.src.js +1 -1
  283. package/es-modules/masters/modules/draggable-points.src.js +1 -1
  284. package/es-modules/masters/modules/drilldown.src.js +1 -1
  285. package/es-modules/masters/modules/dumbbell.src.js +1 -1
  286. package/es-modules/masters/modules/export-data.src.js +1 -1
  287. package/es-modules/masters/modules/exporting.src.js +1 -1
  288. package/es-modules/masters/modules/flowmap.src.js +1 -1
  289. package/es-modules/masters/modules/full-screen.src.js +1 -1
  290. package/es-modules/masters/modules/funnel.src.js +1 -1
  291. package/es-modules/masters/modules/funnel3d.src.js +1 -1
  292. package/es-modules/masters/modules/gantt.src.js +1 -1
  293. package/es-modules/masters/modules/geoheatmap.src.js +1 -1
  294. package/es-modules/masters/modules/grid-axis.src.js +1 -1
  295. package/es-modules/masters/modules/heatmap.src.js +1 -1
  296. package/es-modules/masters/modules/heikinashi.src.js +1 -1
  297. package/es-modules/masters/modules/histogram-bellcurve.src.js +1 -1
  298. package/es-modules/masters/modules/hollowcandlestick.src.js +1 -1
  299. package/es-modules/masters/modules/item-series.src.js +1 -1
  300. package/es-modules/masters/modules/lollipop.src.js +1 -1
  301. package/es-modules/masters/modules/map.src.js +1 -1
  302. package/es-modules/masters/modules/marker-clusters.src.js +1 -1
  303. package/es-modules/masters/modules/mouse-wheel-zoom.src.js +1 -1
  304. package/es-modules/masters/modules/navigator.src.js +1 -1
  305. package/es-modules/masters/modules/networkgraph.src.js +1 -1
  306. package/es-modules/masters/modules/no-data-to-display.src.js +1 -1
  307. package/es-modules/masters/modules/non-cartesian-zoom.src.js +1 -1
  308. package/es-modules/masters/modules/offline-exporting.src.js +1 -1
  309. package/es-modules/masters/modules/organization.src.js +1 -1
  310. package/es-modules/masters/modules/parallel-coordinates.src.js +1 -1
  311. package/es-modules/masters/modules/pareto.src.js +1 -1
  312. package/es-modules/masters/modules/pathfinder.src.js +1 -1
  313. package/es-modules/masters/modules/pattern-fill.src.js +1 -1
  314. package/es-modules/masters/modules/pictorial.src.js +1 -1
  315. package/es-modules/masters/modules/pointandfigure.src.js +1 -1
  316. package/es-modules/masters/modules/price-indicator.src.js +1 -1
  317. package/es-modules/masters/modules/pyramid3d.src.js +1 -1
  318. package/es-modules/masters/modules/renko.src.js +1 -1
  319. package/es-modules/masters/modules/sankey.src.js +1 -1
  320. package/es-modules/masters/modules/series-label.src.js +1 -1
  321. package/es-modules/masters/modules/series-on-point.src.js +1 -1
  322. package/es-modules/masters/modules/solid-gauge.src.js +1 -1
  323. package/es-modules/masters/modules/sonification.src.js +1 -1
  324. package/es-modules/masters/modules/static-scale.src.js +1 -1
  325. package/es-modules/masters/modules/stock-tools.src.js +1 -1
  326. package/es-modules/masters/modules/stock.src.js +1 -1
  327. package/es-modules/masters/modules/streamgraph.src.js +1 -1
  328. package/es-modules/masters/modules/sunburst.src.js +1 -1
  329. package/es-modules/masters/modules/textpath.src.js +1 -1
  330. package/es-modules/masters/modules/tiledwebmap.src.js +1 -1
  331. package/es-modules/masters/modules/tilemap.src.js +1 -1
  332. package/es-modules/masters/modules/timeline.src.js +1 -1
  333. package/es-modules/masters/modules/treegraph.src.js +1 -1
  334. package/es-modules/masters/modules/treegrid.src.js +1 -1
  335. package/es-modules/masters/modules/treemap.src.js +1 -1
  336. package/es-modules/masters/modules/variable-pie.src.js +1 -1
  337. package/es-modules/masters/modules/variwide.src.js +1 -1
  338. package/es-modules/masters/modules/vector.src.js +1 -1
  339. package/es-modules/masters/modules/venn.src.js +1 -1
  340. package/es-modules/masters/modules/windbarb.src.js +1 -1
  341. package/es-modules/masters/modules/wordcloud.src.js +1 -1
  342. package/es-modules/masters/modules/xrange.src.js +1 -1
  343. package/es-modules/masters/standalone-navigator.src.js +1 -1
  344. package/es-modules/masters/themes/adaptive.src.js +1 -1
  345. package/es-modules/masters/themes/avocado.src.js +1 -1
  346. package/es-modules/masters/themes/dark-unica.src.js +1 -1
  347. package/es-modules/masters/themes/grid-light.src.js +1 -1
  348. package/es-modules/masters/themes/high-contrast.src.js +1 -1
  349. package/es-modules/masters/themes/sand-signika.src.js +1 -1
  350. package/es-modules/masters/themes/sunset.src.js +1 -1
  351. package/es-modules/tsconfig.tsbuildinfo +1 -1
  352. package/esm/highcharts-3d.js +2 -2
  353. package/esm/highcharts-3d.src.js +38 -61
  354. package/esm/highcharts-autoload.js +2 -2
  355. package/esm/highcharts-autoload.src.js +18 -39
  356. package/esm/highcharts-gantt.js +1 -1
  357. package/esm/highcharts-gantt.src.js +1 -1
  358. package/esm/highcharts-more.js +2 -2
  359. package/esm/highcharts-more.src.js +142 -120
  360. package/esm/highcharts.js +4 -4
  361. package/esm/highcharts.src.js +825 -751
  362. package/esm/highmaps.js +1 -1
  363. package/esm/highmaps.src.js +1 -1
  364. package/esm/highstock.js +1 -1
  365. package/esm/highstock.src.js +1 -1
  366. package/esm/i18n/fr-FR.js +2 -2
  367. package/esm/i18n/fr-FR.src.js +17 -38
  368. package/esm/i18n/nb-NO.js +2 -2
  369. package/esm/i18n/nb-NO.src.js +17 -38
  370. package/esm/i18n/zh-CN.js +2 -2
  371. package/esm/i18n/zh-CN.src.js +17 -38
  372. package/esm/indicators/acceleration-bands.js +2 -2
  373. package/esm/indicators/acceleration-bands.src.js +18 -39
  374. package/esm/indicators/accumulation-distribution.js +2 -2
  375. package/esm/indicators/accumulation-distribution.src.js +17 -39
  376. package/esm/indicators/ao.js +2 -2
  377. package/esm/indicators/ao.src.js +18 -39
  378. package/esm/indicators/apo.js +2 -2
  379. package/esm/indicators/apo.src.js +18 -39
  380. package/esm/indicators/aroon-oscillator.js +2 -2
  381. package/esm/indicators/aroon-oscillator.src.js +19 -40
  382. package/esm/indicators/aroon.js +2 -2
  383. package/esm/indicators/aroon.src.js +18 -39
  384. package/esm/indicators/atr.js +2 -2
  385. package/esm/indicators/atr.src.js +17 -39
  386. package/esm/indicators/bollinger-bands.js +2 -2
  387. package/esm/indicators/bollinger-bands.src.js +17 -39
  388. package/esm/indicators/cci.js +2 -2
  389. package/esm/indicators/cci.src.js +17 -39
  390. package/esm/indicators/chaikin.js +2 -2
  391. package/esm/indicators/chaikin.src.js +18 -40
  392. package/esm/indicators/cmf.js +2 -2
  393. package/esm/indicators/cmf.src.js +17 -39
  394. package/esm/indicators/cmo.js +2 -2
  395. package/esm/indicators/cmo.src.js +17 -39
  396. package/esm/indicators/dema.js +2 -2
  397. package/esm/indicators/dema.src.js +18 -39
  398. package/esm/indicators/disparity-index.js +2 -2
  399. package/esm/indicators/disparity-index.src.js +20 -41
  400. package/esm/indicators/dmi.js +2 -2
  401. package/esm/indicators/dmi.src.js +20 -41
  402. package/esm/indicators/dpo.js +2 -2
  403. package/esm/indicators/dpo.src.js +18 -39
  404. package/esm/indicators/ichimoku-kinko-hyo.js +2 -2
  405. package/esm/indicators/ichimoku-kinko-hyo.src.js +18 -40
  406. package/esm/indicators/indicators-all.js +2 -2
  407. package/esm/indicators/indicators-all.src.js +76 -99
  408. package/esm/indicators/indicators.js +2 -2
  409. package/esm/indicators/indicators.src.js +48 -46
  410. package/esm/indicators/keltner-channels.js +2 -2
  411. package/esm/indicators/keltner-channels.src.js +18 -39
  412. package/esm/indicators/klinger.js +2 -2
  413. package/esm/indicators/klinger.src.js +17 -38
  414. package/esm/indicators/macd.js +2 -2
  415. package/esm/indicators/macd.src.js +17 -39
  416. package/esm/indicators/mfi.js +2 -2
  417. package/esm/indicators/mfi.src.js +17 -39
  418. package/esm/indicators/momentum.js +2 -2
  419. package/esm/indicators/momentum.src.js +17 -39
  420. package/esm/indicators/natr.js +2 -2
  421. package/esm/indicators/natr.src.js +17 -39
  422. package/esm/indicators/obv.js +2 -2
  423. package/esm/indicators/obv.src.js +17 -39
  424. package/esm/indicators/pivot-points.js +2 -2
  425. package/esm/indicators/pivot-points.src.js +17 -39
  426. package/esm/indicators/ppo.js +2 -2
  427. package/esm/indicators/ppo.src.js +18 -39
  428. package/esm/indicators/price-channel.js +2 -2
  429. package/esm/indicators/price-channel.src.js +18 -39
  430. package/esm/indicators/price-envelopes.js +2 -2
  431. package/esm/indicators/price-envelopes.src.js +17 -39
  432. package/esm/indicators/psar.js +2 -2
  433. package/esm/indicators/psar.src.js +17 -39
  434. package/esm/indicators/regressions.js +2 -2
  435. package/esm/indicators/regressions.src.js +17 -42
  436. package/esm/indicators/roc.js +2 -2
  437. package/esm/indicators/roc.src.js +17 -39
  438. package/esm/indicators/rsi.js +2 -2
  439. package/esm/indicators/rsi.src.js +17 -39
  440. package/esm/indicators/slow-stochastic.js +2 -2
  441. package/esm/indicators/slow-stochastic.src.js +17 -38
  442. package/esm/indicators/stochastic.js +2 -2
  443. package/esm/indicators/stochastic.src.js +20 -41
  444. package/esm/indicators/supertrend.js +2 -2
  445. package/esm/indicators/supertrend.src.js +19 -40
  446. package/esm/indicators/tema.js +2 -2
  447. package/esm/indicators/tema.src.js +18 -39
  448. package/esm/indicators/trendline.js +2 -2
  449. package/esm/indicators/trendline.src.js +17 -39
  450. package/esm/indicators/trix.js +2 -2
  451. package/esm/indicators/trix.src.js +18 -39
  452. package/esm/indicators/volume-by-price.js +2 -2
  453. package/esm/indicators/volume-by-price.src.js +18 -39
  454. package/esm/indicators/vwap.js +2 -2
  455. package/esm/indicators/vwap.src.js +17 -39
  456. package/esm/indicators/williams-r.js +2 -2
  457. package/esm/indicators/williams-r.src.js +18 -39
  458. package/esm/indicators/wma.js +2 -2
  459. package/esm/indicators/wma.src.js +17 -39
  460. package/esm/indicators/zigzag.js +2 -2
  461. package/esm/indicators/zigzag.src.js +17 -39
  462. package/esm/modules/accessibility.js +2 -2
  463. package/esm/modules/accessibility.src.js +90 -76
  464. package/esm/modules/annotations-advanced.js +3 -3
  465. package/esm/modules/annotations-advanced.src.js +36 -58
  466. package/esm/modules/annotations.js +3 -3
  467. package/esm/modules/annotations.src.js +36 -58
  468. package/esm/modules/arc-diagram.js +2 -2
  469. package/esm/modules/arc-diagram.src.js +18 -39
  470. package/esm/modules/arrow-symbols.js +3 -3
  471. package/esm/modules/arrow-symbols.src.js +17 -38
  472. package/esm/modules/boost-canvas.js +2 -2
  473. package/esm/modules/boost-canvas.src.js +57 -63
  474. package/esm/modules/boost.js +2 -2
  475. package/esm/modules/boost.src.js +56 -62
  476. package/esm/modules/broken-axis.js +2 -2
  477. package/esm/modules/broken-axis.src.js +21 -41
  478. package/esm/modules/bullet.js +2 -2
  479. package/esm/modules/bullet.src.js +18 -39
  480. package/esm/modules/coloraxis.js +2 -2
  481. package/esm/modules/coloraxis.src.js +92 -96
  482. package/esm/modules/contour.js +3 -3
  483. package/esm/modules/contour.src.js +29 -52
  484. package/esm/modules/current-date-indicator.js +2 -2
  485. package/esm/modules/current-date-indicator.src.js +17 -38
  486. package/esm/modules/cylinder.js +2 -2
  487. package/esm/modules/cylinder.src.js +18 -39
  488. package/esm/modules/data-sorting.js +2 -2
  489. package/esm/modules/data-sorting.src.js +18 -39
  490. package/esm/modules/data-tools.js +2 -2
  491. package/esm/modules/data-tools.src.js +110 -67
  492. package/esm/modules/data.js +4 -4
  493. package/esm/modules/data.src.js +53 -48
  494. package/esm/modules/datagrouping.js +2 -2
  495. package/esm/modules/datagrouping.src.js +52 -48
  496. package/esm/modules/debugger.js +2 -2
  497. package/esm/modules/debugger.src.js +17 -38
  498. package/esm/modules/dependency-wheel.js +2 -2
  499. package/esm/modules/dependency-wheel.src.js +17 -38
  500. package/esm/modules/dotplot.js +2 -2
  501. package/esm/modules/dotplot.src.js +17 -38
  502. package/esm/modules/drag-panes.js +2 -2
  503. package/esm/modules/drag-panes.src.js +22 -46
  504. package/esm/modules/draggable-points.js +2 -2
  505. package/esm/modules/draggable-points.src.js +17 -38
  506. package/esm/modules/drilldown.js +2 -2
  507. package/esm/modules/drilldown.src.js +40 -54
  508. package/esm/modules/dumbbell.js +2 -2
  509. package/esm/modules/dumbbell.src.js +18 -39
  510. package/esm/modules/export-data.js +2 -2
  511. package/esm/modules/export-data.src.js +42 -43
  512. package/esm/modules/exporting.js +2 -2
  513. package/esm/modules/exporting.src.js +26 -47
  514. package/esm/modules/flowmap.js +2 -2
  515. package/esm/modules/flowmap.src.js +17 -38
  516. package/esm/modules/full-screen.js +2 -2
  517. package/esm/modules/full-screen.src.js +17 -38
  518. package/esm/modules/funnel.js +2 -2
  519. package/esm/modules/funnel.src.js +21 -42
  520. package/esm/modules/funnel3d.js +2 -2
  521. package/esm/modules/funnel3d.src.js +18 -39
  522. package/esm/modules/gantt.js +2 -2
  523. package/esm/modules/gantt.src.js +84 -104
  524. package/esm/modules/geoheatmap.js +2 -2
  525. package/esm/modules/geoheatmap.src.js +18 -39
  526. package/esm/modules/grid-axis.js +2 -2
  527. package/esm/modules/grid-axis.src.js +34 -51
  528. package/esm/modules/heatmap.js +2 -2
  529. package/esm/modules/heatmap.src.js +20 -41
  530. package/esm/modules/heikinashi.js +2 -2
  531. package/esm/modules/heikinashi.src.js +18 -39
  532. package/esm/modules/histogram-bellcurve.js +2 -2
  533. package/esm/modules/histogram-bellcurve.src.js +19 -40
  534. package/esm/modules/hollowcandlestick.js +2 -2
  535. package/esm/modules/hollowcandlestick.src.js +18 -39
  536. package/esm/modules/item-series.js +2 -2
  537. package/esm/modules/item-series.src.js +19 -40
  538. package/esm/modules/lollipop.js +2 -2
  539. package/esm/modules/lollipop.src.js +18 -39
  540. package/esm/modules/map.js +2 -2
  541. package/esm/modules/map.src.js +64 -63
  542. package/esm/modules/marker-clusters.js +2 -2
  543. package/esm/modules/marker-clusters.src.js +49 -46
  544. package/esm/modules/mouse-wheel-zoom.js +2 -2
  545. package/esm/modules/mouse-wheel-zoom.src.js +17 -38
  546. package/esm/modules/navigator.js +2 -2
  547. package/esm/modules/navigator.src.js +72 -67
  548. package/esm/modules/networkgraph.js +2 -2
  549. package/esm/modules/networkgraph.src.js +24 -45
  550. package/esm/modules/no-data-to-display.js +2 -2
  551. package/esm/modules/no-data-to-display.src.js +17 -38
  552. package/esm/modules/non-cartesian-zoom.js +2 -2
  553. package/esm/modules/non-cartesian-zoom.src.js +17 -38
  554. package/esm/modules/offline-exporting.js +2 -2
  555. package/esm/modules/offline-exporting.src.js +19 -40
  556. package/esm/modules/organization.js +2 -2
  557. package/esm/modules/organization.src.js +20 -39
  558. package/esm/modules/parallel-coordinates.js +2 -2
  559. package/esm/modules/parallel-coordinates.src.js +24 -44
  560. package/esm/modules/pareto.js +2 -2
  561. package/esm/modules/pareto.src.js +21 -42
  562. package/esm/modules/pathfinder.js +2 -2
  563. package/esm/modules/pathfinder.src.js +20 -39
  564. package/esm/modules/pattern-fill.js +2 -2
  565. package/esm/modules/pattern-fill.src.js +17 -38
  566. package/esm/modules/pictorial.js +2 -2
  567. package/esm/modules/pictorial.src.js +71 -65
  568. package/esm/modules/pointandfigure.js +2 -2
  569. package/esm/modules/pointandfigure.src.js +47 -44
  570. package/esm/modules/price-indicator.js +2 -2
  571. package/esm/modules/price-indicator.src.js +17 -38
  572. package/esm/modules/pyramid3d.js +2 -2
  573. package/esm/modules/pyramid3d.src.js +18 -39
  574. package/esm/modules/renko.js +2 -2
  575. package/esm/modules/renko.src.js +18 -40
  576. package/esm/modules/sankey.js +2 -2
  577. package/esm/modules/sankey.src.js +24 -46
  578. package/esm/modules/series-label.js +2 -2
  579. package/esm/modules/series-label.src.js +17 -38
  580. package/esm/modules/series-on-point.js +2 -2
  581. package/esm/modules/series-on-point.src.js +47 -44
  582. package/esm/modules/solid-gauge.js +2 -2
  583. package/esm/modules/solid-gauge.src.js +18 -39
  584. package/esm/modules/sonification.js +2 -2
  585. package/esm/modules/sonification.src.js +18 -39
  586. package/esm/modules/static-scale.js +2 -2
  587. package/esm/modules/static-scale.src.js +30 -49
  588. package/esm/modules/stock-tools.js +2 -2
  589. package/esm/modules/stock-tools.src.js +29 -50
  590. package/esm/modules/stock.js +2 -2
  591. package/esm/modules/stock.src.js +117 -141
  592. package/esm/modules/streamgraph.js +2 -2
  593. package/esm/modules/streamgraph.src.js +18 -39
  594. package/esm/modules/sunburst.js +2 -2
  595. package/esm/modules/sunburst.src.js +38 -57
  596. package/esm/modules/textpath.js +2 -2
  597. package/esm/modules/textpath.src.js +17 -38
  598. package/esm/modules/tiledwebmap.js +3 -3
  599. package/esm/modules/tiledwebmap.src.js +19 -40
  600. package/esm/modules/tilemap.js +2 -2
  601. package/esm/modules/tilemap.src.js +22 -40
  602. package/esm/modules/timeline.js +2 -2
  603. package/esm/modules/timeline.src.js +19 -40
  604. package/esm/modules/treegraph.js +2 -2
  605. package/esm/modules/treegraph.src.js +23 -42
  606. package/esm/modules/treegrid.js +2 -2
  607. package/esm/modules/treegrid.src.js +47 -67
  608. package/esm/modules/treemap.js +2 -2
  609. package/esm/modules/treemap.src.js +34 -53
  610. package/esm/modules/variable-pie.js +2 -2
  611. package/esm/modules/variable-pie.src.js +19 -40
  612. package/esm/modules/variwide.js +2 -2
  613. package/esm/modules/variwide.src.js +28 -46
  614. package/esm/modules/vector.js +2 -2
  615. package/esm/modules/vector.src.js +18 -39
  616. package/esm/modules/venn.js +2 -2
  617. package/esm/modules/venn.src.js +18 -39
  618. package/esm/modules/windbarb.js +2 -2
  619. package/esm/modules/windbarb.src.js +18 -39
  620. package/esm/modules/wordcloud.js +2 -2
  621. package/esm/modules/wordcloud.src.js +18 -39
  622. package/esm/modules/xrange.js +2 -2
  623. package/esm/modules/xrange.src.js +18 -39
  624. package/esm/standalone-navigator.js +4 -4
  625. package/esm/standalone-navigator.src.js +877 -777
  626. package/esm/themes/adaptive.js +2 -2
  627. package/esm/themes/adaptive.src.js +17 -38
  628. package/esm/themes/avocado.js +2 -2
  629. package/esm/themes/avocado.src.js +17 -38
  630. package/esm/themes/dark-unica.js +2 -2
  631. package/esm/themes/dark-unica.src.js +17 -38
  632. package/esm/themes/grid-light.js +2 -2
  633. package/esm/themes/grid-light.src.js +17 -38
  634. package/esm/themes/high-contrast.js +2 -2
  635. package/esm/themes/high-contrast.src.js +17 -38
  636. package/esm/themes/sand-signika.js +2 -2
  637. package/esm/themes/sand-signika.src.js +17 -38
  638. package/esm/themes/sunset.js +2 -2
  639. package/esm/themes/sunset.src.js +17 -38
  640. package/highcharts-3d.js +2 -2
  641. package/highcharts-3d.src.js +43 -66
  642. package/highcharts-autoload.d.ts +0 -1
  643. package/highcharts-autoload.js +4 -4
  644. package/highcharts-autoload.src.d.ts +0 -1
  645. package/highcharts-autoload.src.js +834 -779
  646. package/highcharts-gantt.js +4 -4
  647. package/highcharts-gantt.src.js +896 -840
  648. package/highcharts-more.d.ts +10 -0
  649. package/highcharts-more.js +2 -2
  650. package/highcharts-more.src.d.ts +10 -0
  651. package/highcharts-more.src.js +147 -125
  652. package/highcharts.d.ts +2785 -80144
  653. package/highcharts.js +4 -4
  654. package/highcharts.src.d.ts +2785 -80144
  655. package/highcharts.src.js +833 -778
  656. package/highmaps.js +4 -4
  657. package/highmaps.src.js +916 -846
  658. package/highstock.js +4 -4
  659. package/highstock.src.js +904 -875
  660. package/i18n/fr-FR.js +2 -2
  661. package/i18n/fr-FR.src.js +26 -37
  662. package/i18n/nb-NO.js +2 -2
  663. package/i18n/nb-NO.src.js +26 -37
  664. package/i18n/zh-CN.js +2 -2
  665. package/i18n/zh-CN.src.js +26 -37
  666. package/indicators/acceleration-bands.js +2 -2
  667. package/indicators/acceleration-bands.src.js +23 -44
  668. package/indicators/accumulation-distribution.js +2 -2
  669. package/indicators/accumulation-distribution.src.js +22 -44
  670. package/indicators/ao.js +2 -2
  671. package/indicators/ao.src.js +23 -44
  672. package/indicators/apo.js +2 -2
  673. package/indicators/apo.src.js +23 -44
  674. package/indicators/aroon-oscillator.js +2 -2
  675. package/indicators/aroon-oscillator.src.js +24 -45
  676. package/indicators/aroon.js +2 -2
  677. package/indicators/aroon.src.js +23 -44
  678. package/indicators/atr.js +2 -2
  679. package/indicators/atr.src.js +22 -44
  680. package/indicators/bollinger-bands.js +2 -2
  681. package/indicators/bollinger-bands.src.js +22 -44
  682. package/indicators/cci.js +2 -2
  683. package/indicators/cci.src.js +22 -44
  684. package/indicators/chaikin.js +2 -2
  685. package/indicators/chaikin.src.js +23 -45
  686. package/indicators/cmf.js +2 -2
  687. package/indicators/cmf.src.js +22 -44
  688. package/indicators/cmo.js +2 -2
  689. package/indicators/cmo.src.js +22 -44
  690. package/indicators/dema.js +2 -2
  691. package/indicators/dema.src.js +23 -44
  692. package/indicators/disparity-index.js +2 -2
  693. package/indicators/disparity-index.src.js +25 -46
  694. package/indicators/dmi.js +2 -2
  695. package/indicators/dmi.src.js +25 -46
  696. package/indicators/dpo.js +2 -2
  697. package/indicators/dpo.src.js +23 -44
  698. package/indicators/ichimoku-kinko-hyo.js +2 -2
  699. package/indicators/ichimoku-kinko-hyo.src.js +23 -45
  700. package/indicators/indicators-all.js +2 -2
  701. package/indicators/indicators-all.src.js +81 -104
  702. package/indicators/indicators.js +2 -2
  703. package/indicators/indicators.src.js +53 -51
  704. package/indicators/keltner-channels.js +2 -2
  705. package/indicators/keltner-channels.src.js +23 -44
  706. package/indicators/klinger.js +2 -2
  707. package/indicators/klinger.src.js +22 -43
  708. package/indicators/macd.js +2 -2
  709. package/indicators/macd.src.js +22 -44
  710. package/indicators/mfi.js +2 -2
  711. package/indicators/mfi.src.js +22 -44
  712. package/indicators/momentum.js +2 -2
  713. package/indicators/momentum.src.js +22 -44
  714. package/indicators/natr.js +2 -2
  715. package/indicators/natr.src.js +22 -44
  716. package/indicators/obv.js +2 -2
  717. package/indicators/obv.src.js +22 -44
  718. package/indicators/pivot-points.js +2 -2
  719. package/indicators/pivot-points.src.js +22 -44
  720. package/indicators/ppo.js +2 -2
  721. package/indicators/ppo.src.js +23 -44
  722. package/indicators/price-channel.js +2 -2
  723. package/indicators/price-channel.src.js +23 -44
  724. package/indicators/price-envelopes.js +2 -2
  725. package/indicators/price-envelopes.src.js +22 -44
  726. package/indicators/psar.js +2 -2
  727. package/indicators/psar.src.js +22 -44
  728. package/indicators/regressions.js +2 -2
  729. package/indicators/regressions.src.js +22 -47
  730. package/indicators/roc.js +2 -2
  731. package/indicators/roc.src.js +22 -44
  732. package/indicators/rsi.js +2 -2
  733. package/indicators/rsi.src.js +22 -44
  734. package/indicators/slow-stochastic.js +2 -2
  735. package/indicators/slow-stochastic.src.js +22 -43
  736. package/indicators/stochastic.js +2 -2
  737. package/indicators/stochastic.src.js +25 -46
  738. package/indicators/supertrend.js +2 -2
  739. package/indicators/supertrend.src.js +24 -45
  740. package/indicators/tema.js +2 -2
  741. package/indicators/tema.src.js +23 -44
  742. package/indicators/trendline.js +2 -2
  743. package/indicators/trendline.src.js +22 -44
  744. package/indicators/trix.js +2 -2
  745. package/indicators/trix.src.js +23 -44
  746. package/indicators/volume-by-price.js +2 -2
  747. package/indicators/volume-by-price.src.js +23 -44
  748. package/indicators/vwap.js +2 -2
  749. package/indicators/vwap.src.js +22 -44
  750. package/indicators/williams-r.js +2 -2
  751. package/indicators/williams-r.src.js +23 -44
  752. package/indicators/wma.js +2 -2
  753. package/indicators/wma.src.js +22 -44
  754. package/indicators/zigzag.js +2 -2
  755. package/indicators/zigzag.src.js +22 -44
  756. package/modules/accessibility.js +2 -2
  757. package/modules/accessibility.src.js +95 -81
  758. package/modules/annotations-advanced.js +9 -9
  759. package/modules/annotations-advanced.src.js +41 -63
  760. package/modules/annotations.js +3 -3
  761. package/modules/annotations.src.js +41 -63
  762. package/modules/arc-diagram.js +2 -2
  763. package/modules/arc-diagram.src.js +23 -44
  764. package/modules/arrow-symbols.js +2 -2
  765. package/modules/arrow-symbols.src.js +17 -38
  766. package/modules/boost-canvas.js +2 -2
  767. package/modules/boost-canvas.src.js +62 -68
  768. package/modules/boost.js +2 -2
  769. package/modules/boost.src.js +61 -67
  770. package/modules/broken-axis.js +2 -2
  771. package/modules/broken-axis.src.js +26 -46
  772. package/modules/bullet.js +2 -2
  773. package/modules/bullet.src.js +23 -44
  774. package/modules/coloraxis.js +2 -2
  775. package/modules/coloraxis.src.js +97 -101
  776. package/modules/contour.js +5 -5
  777. package/modules/contour.src.js +111 -117
  778. package/modules/current-date-indicator.js +2 -2
  779. package/modules/current-date-indicator.src.js +17 -38
  780. package/modules/cylinder.js +2 -2
  781. package/modules/cylinder.src.js +23 -44
  782. package/modules/data-sorting.js +2 -2
  783. package/modules/data-sorting.src.js +18 -39
  784. package/modules/data-tools.js +2 -2
  785. package/modules/data-tools.src.js +110 -67
  786. package/modules/data.js +4 -4
  787. package/modules/data.src.js +58 -53
  788. package/modules/datagrouping.js +2 -2
  789. package/modules/datagrouping.src.js +57 -53
  790. package/modules/debugger.js +2 -2
  791. package/modules/debugger.src.js +17 -38
  792. package/modules/dependency-wheel.js +2 -2
  793. package/modules/dependency-wheel.src.js +22 -43
  794. package/modules/dotplot.js +2 -2
  795. package/modules/dotplot.src.js +22 -43
  796. package/modules/drag-panes.js +2 -2
  797. package/modules/drag-panes.src.js +22 -46
  798. package/modules/draggable-points.js +2 -2
  799. package/modules/draggable-points.src.js +17 -38
  800. package/modules/drilldown.js +2 -2
  801. package/modules/drilldown.src.js +45 -59
  802. package/modules/dumbbell.js +2 -2
  803. package/modules/dumbbell.src.js +23 -44
  804. package/modules/export-data.js +2 -2
  805. package/modules/export-data.src.js +47 -48
  806. package/modules/exporting.js +2 -2
  807. package/modules/exporting.src.js +31 -52
  808. package/modules/flowmap.js +2 -2
  809. package/modules/flowmap.src.js +22 -43
  810. package/modules/full-screen.js +2 -2
  811. package/modules/full-screen.src.js +22 -43
  812. package/modules/funnel.js +2 -2
  813. package/modules/funnel.src.js +26 -47
  814. package/modules/funnel3d.js +2 -2
  815. package/modules/funnel3d.src.js +23 -44
  816. package/modules/gantt.js +8 -8
  817. package/modules/gantt.src.js +93 -113
  818. package/modules/geoheatmap.js +2 -2
  819. package/modules/geoheatmap.src.js +23 -44
  820. package/modules/grid-axis.js +2 -2
  821. package/modules/grid-axis.src.js +39 -56
  822. package/modules/heatmap.js +4 -4
  823. package/modules/heatmap.src.js +101 -105
  824. package/modules/heikinashi.js +2 -2
  825. package/modules/heikinashi.src.js +23 -44
  826. package/modules/histogram-bellcurve.js +2 -2
  827. package/modules/histogram-bellcurve.src.js +24 -45
  828. package/modules/hollowcandlestick.js +2 -2
  829. package/modules/hollowcandlestick.src.js +23 -44
  830. package/modules/item-series.js +2 -2
  831. package/modules/item-series.src.js +24 -45
  832. package/modules/lollipop.js +2 -2
  833. package/modules/lollipop.src.js +23 -44
  834. package/modules/map.js +4 -4
  835. package/modules/map.src.js +146 -128
  836. package/modules/marker-clusters.js +2 -2
  837. package/modules/marker-clusters.src.js +49 -46
  838. package/modules/mouse-wheel-zoom.js +2 -2
  839. package/modules/mouse-wheel-zoom.src.js +17 -38
  840. package/modules/navigator.js +2 -2
  841. package/modules/navigator.src.js +77 -72
  842. package/modules/networkgraph.js +2 -2
  843. package/modules/networkgraph.src.js +29 -50
  844. package/modules/no-data-to-display.js +2 -2
  845. package/modules/no-data-to-display.src.js +22 -43
  846. package/modules/non-cartesian-zoom.js +2 -2
  847. package/modules/non-cartesian-zoom.src.js +17 -38
  848. package/modules/offline-exporting.js +2 -2
  849. package/modules/offline-exporting.src.js +24 -45
  850. package/modules/organization.js +3 -3
  851. package/modules/organization.src.js +25 -44
  852. package/modules/parallel-coordinates.js +2 -2
  853. package/modules/parallel-coordinates.src.js +29 -49
  854. package/modules/pareto.js +2 -2
  855. package/modules/pareto.src.js +26 -47
  856. package/modules/pathfinder.js +2 -2
  857. package/modules/pathfinder.src.js +25 -44
  858. package/modules/pattern-fill.js +2 -2
  859. package/modules/pattern-fill.src.js +17 -38
  860. package/modules/pictorial.js +2 -2
  861. package/modules/pictorial.src.js +76 -70
  862. package/modules/pointandfigure.js +2 -2
  863. package/modules/pointandfigure.src.js +52 -49
  864. package/modules/price-indicator.js +2 -2
  865. package/modules/price-indicator.src.js +17 -38
  866. package/modules/pyramid3d.js +2 -2
  867. package/modules/pyramid3d.src.js +23 -44
  868. package/modules/renko.js +2 -2
  869. package/modules/renko.src.js +23 -45
  870. package/modules/sankey.js +2 -2
  871. package/modules/sankey.src.js +29 -51
  872. package/modules/series-label.js +2 -2
  873. package/modules/series-label.src.js +22 -43
  874. package/modules/series-on-point.js +2 -2
  875. package/modules/series-on-point.src.js +52 -49
  876. package/modules/solid-gauge.js +2 -2
  877. package/modules/solid-gauge.src.js +23 -44
  878. package/modules/sonification.js +2 -2
  879. package/modules/sonification.src.js +23 -44
  880. package/modules/static-scale.js +2 -2
  881. package/modules/static-scale.src.js +30 -49
  882. package/modules/stock-tools.js +2 -2
  883. package/modules/stock-tools.src.js +34 -55
  884. package/modules/stock.js +6 -6
  885. package/modules/stock.src.js +132 -154
  886. package/modules/streamgraph.js +2 -2
  887. package/modules/streamgraph.src.js +23 -44
  888. package/modules/sunburst.js +2 -2
  889. package/modules/sunburst.src.js +43 -62
  890. package/modules/textpath.js +2 -2
  891. package/modules/textpath.src.js +17 -38
  892. package/modules/tiledwebmap.js +3 -3
  893. package/modules/tiledwebmap.src.js +24 -45
  894. package/modules/tilemap.js +2 -2
  895. package/modules/tilemap.src.js +27 -45
  896. package/modules/timeline.js +2 -2
  897. package/modules/timeline.src.js +24 -45
  898. package/modules/treegraph.js +2 -2
  899. package/modules/treegraph.src.js +28 -47
  900. package/modules/treegrid.js +2 -2
  901. package/modules/treegrid.src.js +52 -72
  902. package/modules/treemap.js +2 -2
  903. package/modules/treemap.src.js +39 -58
  904. package/modules/variable-pie.js +2 -2
  905. package/modules/variable-pie.src.js +24 -45
  906. package/modules/variwide.js +2 -2
  907. package/modules/variwide.src.js +33 -51
  908. package/modules/vector.js +2 -2
  909. package/modules/vector.src.js +23 -44
  910. package/modules/venn.js +2 -2
  911. package/modules/venn.src.js +23 -44
  912. package/modules/windbarb.js +2 -2
  913. package/modules/windbarb.src.js +23 -44
  914. package/modules/wordcloud.js +2 -2
  915. package/modules/wordcloud.src.js +23 -44
  916. package/modules/xrange.js +2 -2
  917. package/modules/xrange.src.js +23 -44
  918. package/options/abands.d.ts +183 -8
  919. package/options/abands.src.d.ts +183 -8
  920. package/options/ad.d.ts +176 -5
  921. package/options/ad.src.d.ts +176 -5
  922. package/options/ao.d.ts +202 -0
  923. package/options/ao.src.d.ts +202 -0
  924. package/options/apo.d.ts +178 -8
  925. package/options/apo.src.d.ts +178 -8
  926. package/options/arcdiagram.d.ts +785 -0
  927. package/options/arcdiagram.src.d.ts +785 -0
  928. package/options/area.d.ts +226 -0
  929. package/options/area.src.d.ts +226 -0
  930. package/options/arearange.d.ts +229 -8
  931. package/options/arearange.src.d.ts +229 -8
  932. package/options/areaspline.d.ts +1344 -8
  933. package/options/areaspline.src.d.ts +1344 -8
  934. package/options/areasplinerange.d.ts +972 -8
  935. package/options/areasplinerange.src.d.ts +972 -8
  936. package/options/aroon.d.ts +219 -0
  937. package/options/aroon.src.d.ts +219 -0
  938. package/options/aroonoscillator.d.ts +1140 -8
  939. package/options/aroonoscillator.src.d.ts +1140 -8
  940. package/options/atr.d.ts +210 -0
  941. package/options/atr.src.d.ts +210 -0
  942. package/options/bar.d.ts +183 -10
  943. package/options/bar.src.d.ts +183 -10
  944. package/options/bb.d.ts +1232 -0
  945. package/options/bb.src.d.ts +1232 -0
  946. package/options/bellcurve.d.ts +1167 -8
  947. package/options/bellcurve.src.d.ts +1167 -8
  948. package/options/boxplot.d.ts +163 -10
  949. package/options/boxplot.src.d.ts +163 -10
  950. package/options/bubble.d.ts +1005 -8
  951. package/options/bubble.src.d.ts +1005 -8
  952. package/options/bullet.d.ts +953 -8
  953. package/options/bullet.src.d.ts +953 -8
  954. package/options/candlestick.d.ts +1309 -8
  955. package/options/candlestick.src.d.ts +1309 -8
  956. package/options/cci.d.ts +210 -0
  957. package/options/cci.src.d.ts +210 -0
  958. package/options/chaikin.d.ts +180 -8
  959. package/options/chaikin.src.d.ts +180 -8
  960. package/options/cmf.d.ts +211 -0
  961. package/options/cmf.src.d.ts +211 -0
  962. package/options/cmo.d.ts +175 -5
  963. package/options/cmo.src.d.ts +175 -5
  964. package/options/column.d.ts +252 -2
  965. package/options/column.src.d.ts +252 -2
  966. package/options/columnpyramid.d.ts +1296 -0
  967. package/options/columnpyramid.src.d.ts +1296 -0
  968. package/options/columnrange.d.ts +216 -2
  969. package/options/columnrange.src.d.ts +216 -2
  970. package/options/contour.d.ts +1148 -0
  971. package/options/contour.src.d.ts +1148 -0
  972. package/options/cylinder.d.ts +183 -2
  973. package/options/cylinder.src.d.ts +183 -2
  974. package/options/dema.d.ts +1181 -0
  975. package/options/dema.src.d.ts +1181 -0
  976. package/options/dependencywheel.d.ts +315 -0
  977. package/options/dependencywheel.src.d.ts +315 -0
  978. package/options/disparityindex.d.ts +1157 -8
  979. package/options/disparityindex.src.d.ts +1157 -8
  980. package/options/dmi.d.ts +1227 -0
  981. package/options/dmi.src.d.ts +1227 -0
  982. package/options/dpo.d.ts +1140 -8
  983. package/options/dpo.src.d.ts +1140 -8
  984. package/options/dumbbell.d.ts +286 -0
  985. package/options/dumbbell.src.d.ts +286 -0
  986. package/options/ema.d.ts +1156 -5
  987. package/options/ema.src.d.ts +1156 -5
  988. package/options/errorbar.d.ts +1286 -0
  989. package/options/errorbar.src.d.ts +1286 -0
  990. package/options/flags.d.ts +1269 -8
  991. package/options/flags.src.d.ts +1269 -8
  992. package/options/flowmap.d.ts +551 -0
  993. package/options/flowmap.src.d.ts +551 -0
  994. package/options/funnel.d.ts +728 -10
  995. package/options/funnel.src.d.ts +728 -10
  996. package/options/gantt.d.ts +1011 -0
  997. package/options/gantt.src.d.ts +1011 -0
  998. package/options/gauge.d.ts +675 -0
  999. package/options/gauge.src.d.ts +675 -0
  1000. package/options/geoheatmap.d.ts +585 -8
  1001. package/options/geoheatmap.src.d.ts +585 -8
  1002. package/options/heatmap.d.ts +1054 -8
  1003. package/options/heatmap.src.d.ts +1054 -8
  1004. package/options/heikinashi.d.ts +178 -10
  1005. package/options/heikinashi.src.d.ts +178 -10
  1006. package/options/histogram.d.ts +1226 -0
  1007. package/options/histogram.src.d.ts +1226 -0
  1008. package/options/hlc.d.ts +223 -2
  1009. package/options/hlc.src.d.ts +223 -2
  1010. package/options/hollowcandlestick.d.ts +1335 -0
  1011. package/options/hollowcandlestick.src.d.ts +1335 -0
  1012. package/options/ikh.d.ts +228 -5
  1013. package/options/ikh.src.d.ts +228 -5
  1014. package/options/item.d.ts +217 -8
  1015. package/options/item.src.d.ts +217 -8
  1016. package/options/keltnerchannels.d.ts +1220 -0
  1017. package/options/keltnerchannels.src.d.ts +1220 -0
  1018. package/options/klinger.d.ts +1162 -0
  1019. package/options/klinger.src.d.ts +1162 -0
  1020. package/options/line.d.ts +1377 -8
  1021. package/options/line.src.d.ts +1377 -8
  1022. package/options/linearregression.d.ts +199 -5
  1023. package/options/linearregression.src.d.ts +199 -5
  1024. package/options/linearregressionangle.d.ts +1157 -5
  1025. package/options/linearregressionangle.src.d.ts +1157 -5
  1026. package/options/linearregressionintercept.d.ts +240 -0
  1027. package/options/linearregressionintercept.src.d.ts +240 -0
  1028. package/options/linearregressionslope.d.ts +240 -0
  1029. package/options/linearregressionslope.src.d.ts +240 -0
  1030. package/options/lollipop.d.ts +949 -0
  1031. package/options/lollipop.src.d.ts +949 -0
  1032. package/options/macd.d.ts +254 -0
  1033. package/options/macd.src.d.ts +254 -0
  1034. package/options/map.d.ts +150 -8
  1035. package/options/map.src.d.ts +150 -8
  1036. package/options/mapbubble.d.ts +1016 -8
  1037. package/options/mapbubble.src.d.ts +1016 -8
  1038. package/options/mapline.d.ts +994 -0
  1039. package/options/mapline.src.d.ts +994 -0
  1040. package/options/mappoint.d.ts +1105 -1
  1041. package/options/mappoint.src.d.ts +1105 -1
  1042. package/options/mfi.d.ts +181 -5
  1043. package/options/mfi.src.d.ts +181 -5
  1044. package/options/momentum.d.ts +215 -0
  1045. package/options/momentum.src.d.ts +215 -0
  1046. package/options/natr.d.ts +170 -5
  1047. package/options/natr.src.d.ts +170 -5
  1048. package/options/networkgraph.d.ts +365 -0
  1049. package/options/networkgraph.src.d.ts +365 -0
  1050. package/options/obv.d.ts +170 -5
  1051. package/options/obv.src.d.ts +170 -5
  1052. package/options/ohlc.d.ts +183 -7
  1053. package/options/ohlc.src.d.ts +183 -7
  1054. package/options/organization.d.ts +808 -0
  1055. package/options/organization.src.d.ts +808 -0
  1056. package/options/packedbubble.d.ts +877 -8
  1057. package/options/packedbubble.src.d.ts +877 -8
  1058. package/options/pareto.d.ts +1028 -0
  1059. package/options/pareto.src.d.ts +1028 -0
  1060. package/options/pc.d.ts +183 -8
  1061. package/options/pc.src.d.ts +183 -8
  1062. package/options/pictorial.d.ts +202 -2
  1063. package/options/pictorial.src.d.ts +202 -2
  1064. package/options/pie.d.ts +196 -8
  1065. package/options/pie.src.d.ts +196 -8
  1066. package/options/pivotpoints.d.ts +1199 -0
  1067. package/options/pivotpoints.src.d.ts +1199 -0
  1068. package/options/pointandfigure.d.ts +980 -0
  1069. package/options/pointandfigure.src.d.ts +980 -0
  1070. package/options/polygon.d.ts +234 -0
  1071. package/options/polygon.src.d.ts +234 -0
  1072. package/options/ppo.d.ts +1156 -8
  1073. package/options/ppo.src.d.ts +1156 -8
  1074. package/options/priceenvelopes.d.ts +1229 -0
  1075. package/options/priceenvelopes.src.d.ts +1229 -0
  1076. package/options/psar.d.ts +1156 -5
  1077. package/options/psar.src.d.ts +1156 -5
  1078. package/options/pyramid.d.ts +837 -2
  1079. package/options/pyramid.src.d.ts +837 -2
  1080. package/options/renko.d.ts +247 -10
  1081. package/options/renko.src.d.ts +247 -10
  1082. package/options/roc.d.ts +1215 -0
  1083. package/options/roc.src.d.ts +1215 -0
  1084. package/options/rsi.d.ts +1157 -5
  1085. package/options/rsi.src.d.ts +1157 -5
  1086. package/options/sankey.d.ts +276 -8
  1087. package/options/sankey.src.d.ts +276 -8
  1088. package/options/scatter.d.ts +3043 -1018
  1089. package/options/scatter.src.d.ts +3043 -1018
  1090. package/options/series.d.ts +175 -0
  1091. package/options/series.src.d.ts +175 -0
  1092. package/options/slowstochastic.d.ts +183 -0
  1093. package/options/slowstochastic.src.d.ts +183 -0
  1094. package/options/sma.d.ts +211 -0
  1095. package/options/sma.src.d.ts +211 -0
  1096. package/options/solidgauge.d.ts +218 -0
  1097. package/options/solidgauge.src.d.ts +218 -0
  1098. package/options/spline.d.ts +230 -0
  1099. package/options/spline.src.d.ts +230 -0
  1100. package/options/stochastic.d.ts +1170 -8
  1101. package/options/stochastic.src.d.ts +1170 -8
  1102. package/options/streamgraph.d.ts +1345 -8
  1103. package/options/streamgraph.src.d.ts +1345 -8
  1104. package/options/sunburst.d.ts +286 -9
  1105. package/options/sunburst.src.d.ts +286 -9
  1106. package/options/supertrend.d.ts +1208 -0
  1107. package/options/supertrend.src.d.ts +1208 -0
  1108. package/options/tema.d.ts +1140 -8
  1109. package/options/tema.src.d.ts +1140 -8
  1110. package/options/tiledwebmap.d.ts +164 -0
  1111. package/options/tiledwebmap.src.d.ts +164 -0
  1112. package/options/tilemap.d.ts +687 -0
  1113. package/options/tilemap.src.d.ts +687 -0
  1114. package/options/timeline.d.ts +282 -0
  1115. package/options/timeline.src.d.ts +282 -0
  1116. package/options/treegraph.d.ts +982 -0
  1117. package/options/treegraph.src.d.ts +982 -0
  1118. package/options/treemap.d.ts +1396 -22
  1119. package/options/treemap.src.d.ts +1396 -22
  1120. package/options/trendline.d.ts +211 -0
  1121. package/options/trendline.src.d.ts +211 -0
  1122. package/options/trix.d.ts +178 -8
  1123. package/options/trix.src.d.ts +178 -8
  1124. package/options/variablepie.d.ts +686 -8
  1125. package/options/variablepie.src.d.ts +686 -8
  1126. package/options/variwide.d.ts +178 -2
  1127. package/options/variwide.src.d.ts +178 -2
  1128. package/options/vbp.d.ts +576 -0
  1129. package/options/vbp.src.d.ts +576 -0
  1130. package/options/vector.d.ts +660 -0
  1131. package/options/vector.src.d.ts +660 -0
  1132. package/options/venn.d.ts +654 -0
  1133. package/options/venn.src.d.ts +654 -0
  1134. package/options/vwap.d.ts +1157 -5
  1135. package/options/vwap.src.d.ts +1157 -5
  1136. package/options/waterfall.d.ts +1254 -8
  1137. package/options/waterfall.src.d.ts +1254 -8
  1138. package/options/williamsr.d.ts +209 -0
  1139. package/options/williamsr.src.d.ts +209 -0
  1140. package/options/windbarb.d.ts +222 -2
  1141. package/options/windbarb.src.d.ts +222 -2
  1142. package/options/wma.d.ts +1156 -5
  1143. package/options/wma.src.d.ts +1156 -5
  1144. package/options/wordcloud.d.ts +682 -0
  1145. package/options/wordcloud.src.d.ts +682 -0
  1146. package/options/xrange.d.ts +1168 -0
  1147. package/options/xrange.src.d.ts +1168 -0
  1148. package/options/zigzag.d.ts +1197 -0
  1149. package/options/zigzag.src.d.ts +1197 -0
  1150. package/package.json +1 -1
  1151. package/standalone-navigator.js +4 -4
  1152. package/standalone-navigator.src.js +885 -804
  1153. package/themes/adaptive.js +2 -2
  1154. package/themes/adaptive.src.js +22 -43
  1155. package/themes/avocado.js +2 -2
  1156. package/themes/avocado.src.js +17 -38
  1157. package/themes/dark-unica.js +2 -2
  1158. package/themes/dark-unica.src.js +17 -38
  1159. package/themes/grid-light.js +2 -2
  1160. package/themes/grid-light.src.js +17 -38
  1161. package/themes/high-contrast.js +2 -2
  1162. package/themes/high-contrast.src.js +17 -38
  1163. package/themes/sand-signika.js +2 -2
  1164. package/themes/sand-signika.src.js +17 -38
  1165. package/themes/sunset.js +2 -2
  1166. package/themes/sunset.src.js +17 -38
@@ -5,6 +5,83 @@
5
5
  *!*/
6
6
  import * as Highcharts from "../highcharts.src";
7
7
  declare module "../highcharts.src" {
8
+ /**
9
+ * (Highcharts) Point accessibility options for a series.
10
+ */
11
+ interface PlotScatter3dAccessibilityPointOptions {
12
+ /**
13
+ * (Highcharts) Date format to use for points on datetime axes when
14
+ * describing them to screen reader users.
15
+ *
16
+ * Defaults to the same format as in tooltip.
17
+ *
18
+ * For an overview of the replacement codes, see dateFormat.
19
+ */
20
+ dateFormat?: string;
21
+ /**
22
+ * (Highcharts) Formatter function to determine the date/time format
23
+ * used with points on datetime axes when describing them to screen
24
+ * reader users. Receives one argument, `point`, referring to the point
25
+ * to describe. Should return a date format string compatible with
26
+ * dateFormat.
27
+ */
28
+ dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
29
+ /**
30
+ * (Highcharts) Whether or not to describe points with the value `null`
31
+ * to assistive technology, such as screen readers.
32
+ */
33
+ describeNull?: boolean;
34
+ /**
35
+ * (Highcharts) A format string to use instead of the default for point
36
+ * descriptions.
37
+ *
38
+ * The context of the format string is the point instance.
39
+ *
40
+ * As opposed to accessibility.point.valueDescriptionFormat, this option
41
+ * replaces the whole description.
42
+ */
43
+ descriptionFormat?: string;
44
+ /**
45
+ * (Highcharts) Formatter function to use instead of the default for
46
+ * point descriptions. Same as
47
+ * `accessibility.point.descriptionFormatter`, but applies to a series
48
+ * instead of the whole chart.
49
+ *
50
+ * Note: Prefer using accessibility.point.valueDescriptionFormat instead
51
+ * if possible, as default functionality such as describing annotations
52
+ * will be preserved.
53
+ */
54
+ descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
55
+ /**
56
+ * (Highcharts) Decimals to use for the values in the point
57
+ * descriptions. Uses tooltip.valueDecimals if not defined.
58
+ */
59
+ valueDecimals?: number;
60
+ /**
61
+ * (Highcharts) Format to use for describing the values of data points
62
+ * to assistive technology - including screen readers. The point context
63
+ * is available as `{point}`.
64
+ *
65
+ * Other available context variables include `{index}`, `{value}`, and
66
+ * `{xDescription}`.
67
+ *
68
+ * Additionally, the series name, annotation info, and description added
69
+ * in `point.accessibility.description` is added by default if relevant.
70
+ * To override this, use the accessibility.point.descriptionFormatter
71
+ * option.
72
+ */
73
+ valueDescriptionFormat?: string;
74
+ /**
75
+ * (Highcharts) Prefix to add to the values in the point descriptions.
76
+ * Uses tooltip.valuePrefix if not defined.
77
+ */
78
+ valuePrefix?: string;
79
+ /**
80
+ * (Highcharts) Suffix to add to the values in the point descriptions.
81
+ * Uses tooltip.valueSuffix if not defined.
82
+ */
83
+ valueSuffix?: string;
84
+ }
8
85
  /**
9
86
  * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
10
87
  * animation when a series is displayed for the `dataLabels`. The animation
@@ -25,1326 +102,3085 @@ declare module "../highcharts.src" {
25
102
  defer?: number;
26
103
  }
27
104
  /**
28
- * (Highcharts, Highstock) Options for series data sorting.
105
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
106
+ * labels, appearing next to each data point.
107
+ *
108
+ * Since v6.2.0, multiple data labels can be applied to each single point by
109
+ * defining them as an array of configs.
110
+ *
111
+ * In styled mode, the data labels can be styled with the
112
+ * `.highcharts-data-label-box` and `.highcharts-data-label` class names
113
+ * (see example).
29
114
  */
30
- interface PlotScatter3dDataSortingOptions {
115
+ interface PlotScatter3dDataLabelsOptions {
31
116
  /**
32
- * (Highcharts, Highstock) Enable or disable data sorting for the
33
- * series. Use xAxis.reversed to change the sorting order.
117
+ * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data
118
+ * label compared to the point. If `right`, the right side of the label
119
+ * should be touching the point. For points with an extent, like
120
+ * columns, the alignments also dictates how to align it inside the box,
121
+ * as given with the inside option. Can be one of `left`, `center` or
122
+ * `right`.
34
123
  */
35
- enabled?: boolean;
124
+ align?: (Highcharts.AlignValue|null);
36
125
  /**
37
- * (Highcharts, Highstock) Whether to allow matching points by name in
38
- * an update. If this option is disabled, points will be matched by
39
- * order.
126
+ * (Highcharts, Highstock, Highmaps, Gantt) Alignment method for data
127
+ * labels. If set to `plotEdges`, the labels are aligned within the plot
128
+ * area in the direction of the y-axis. So in a regular column chart,
129
+ * the labels are aligned vertically according to the `verticalAlign`
130
+ * setting. In a bar chart, which is inverted, the labels are aligned
131
+ * horizontally according to the `align` setting. Applies to cartesian
132
+ * series only.
40
133
  */
41
- matchByName?: boolean;
134
+ alignTo?: string;
42
135
  /**
43
- * (Highcharts, Highstock) Determines what data value should be used to
44
- * sort by.
136
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels
137
+ * to overlap. To make the labels less sensitive for overlapping, the
138
+ * dataLabels.padding can be set to 0.
45
139
  */
46
- sortKey?: string;
47
- }
48
- /**
49
- * (Highcharts, Highstock, Gantt) Styles for the series label. The color
50
- * defaults to the series color, or a contrast color if `onArea`.
51
- */
52
- interface PlotScatter3dLabelStyleOptions {
53
- fontSize?: number;
54
- fontWeight?: string;
55
- }
56
- /**
57
- * (Highcharts) Animation when hovering over the marker.
58
- */
59
- interface PlotScatter3dMarkerStatesSelectAnimationOptions {
60
- duration?: number;
61
- }
62
- /**
63
- * (Highcharts) Options for the _Series on point_ feature. Only `pie` and
64
- * `sunburst` series are supported at this moment.
65
- */
66
- interface PlotScatter3dOnPointOptions {
140
+ allowOverlap?: boolean;
67
141
  /**
68
- * (Highcharts) Options for the connector in the _Series on point_
69
- * feature.
142
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the
143
+ * initial animation when a series is displayed for the `dataLabels`.
144
+ * The animation can also be set as a configuration object. Please note
145
+ * that this option only applies to the initial animation.
70
146
  *
71
- * In styled mode, the connector can be styled with the
72
- * `.highcharts-connector-seriesonpoint` class name.
147
+ * For other animations, see chart.animation and the animation parameter
148
+ * under the API methods. The following properties are supported:
149
+ *
150
+ * - `defer`: The animation delay time in milliseconds.
73
151
  */
74
- connectorOptions?: (Highcharts.PlotScatter3dOnPointConnectorOptions|Highcharts.SVGAttributes);
152
+ animation?: (boolean|Highcharts.PlotScatter3dDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
75
153
  /**
76
- * (Highcharts) The `id` of the point that we connect the series to.
77
- * Only points with a given `plotX` and `plotY` values and map points
78
- * are valid.
154
+ * (Highcharts, Highstock, Highmaps, Gantt) The background color or
155
+ * gradient for the data label. In addition to regular colors, there are
156
+ * two special setting for this option:
157
+ *
158
+ * - `auto` will set the background color the point's color.
159
+ *
160
+ * - `contrast` will set it to a contrast against the text color, with
161
+ * an opacity allowing to see the underlying content. The contrast is
162
+ * great enough to ensure readability for the text according to
163
+ * accessibility standards.
79
164
  */
80
- id?: string;
165
+ backgroundColor?: Highcharts.ColorType;
81
166
  /**
82
- * (Highcharts) Options allowing to set a position and an offset of the
83
- * series in the _Series on point_ feature.
167
+ * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
168
+ * data label. Setting it to `auto` will use the point's color. Defaults
169
+ * to `undefined`.
84
170
  */
85
- position?: (object|Highcharts.PlotScatter3dOnPointPositionOptions);
86
- }
87
- /**
88
- * (Highcharts) A 3D scatter plot uses x, y and z coordinates to display
89
- * values for three variables for a set of data.
90
- *
91
- * Configuration options for the series are given in three levels:
92
- *
93
- * 1. Options for all series in a chart are defined in the
94
- * plotOptions.series object.
95
- *
96
- * 2. Options for all `scatter3d` series are defined in
97
- * plotOptions.scatter3d.
98
- *
99
- * 3. Options for one single series are given in the series instance array.
100
- * (see online documentation for example)
101
- *
102
- * **TypeScript:**
103
- *
104
- * - type option should always be set, otherwise a broad set of unsupported
105
- * options is allowed.
106
- *
107
- * - when accessing an array of series, the combined set of all series types
108
- * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
109
- * specific type can be done by checking the `type` property. (see online
110
- * documentation for example)
111
- */
112
- interface PlotScatter3dOptions {
171
+ borderColor?: Highcharts.ColorType;
113
172
  /**
114
- * (Highcharts) Accessibility options for a series.
173
+ * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels
174
+ * for the data label.
115
175
  */
116
- accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
176
+ borderRadius?: number;
117
177
  /**
118
- * (Highcharts) Allow this series' points to be selected by clicking on
119
- * the graphic (columns, point markers, pie slices, map areas etc).
120
- *
121
- * The selected points can be handled by point select and unselect
122
- * events, or collectively by the getSelectedPoints function.
123
- *
124
- * And alternative way of selecting points is through dragging.
178
+ * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels
179
+ * for the data label.
125
180
  */
126
- allowPointSelect?: boolean;
181
+ borderWidth?: number;
127
182
  /**
128
- * (Highcharts) Enable or disable the initial animation when a series is
129
- * displayed. The animation can also be set as a configuration object.
130
- * Please note that this option only applies to the initial animation of
131
- * the series itself. For other animations, see chart.animation and the
132
- * animation parameter under the API methods. The following properties
133
- * are supported:
134
- *
135
- * - `defer`: The animation delay time in milliseconds.
136
- *
137
- * - `duration`: The duration of the animation in milliseconds.
138
- * (Defaults to `1000`)
183
+ * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data
184
+ * label. Particularly in styled mode, this can be used to give each
185
+ * series' or point's data label unique styling. In addition to this
186
+ * option, a default color class name is added so that we can give the
187
+ * labels a contrast text shadow.
188
+ */
189
+ className?: string;
190
+ /**
191
+ * (Highcharts, Highstock, Highmaps, Gantt) This options is deprecated.
192
+ * Use style.color instead.
139
193
  *
140
- * - `easing`: Can be a string reference to an easing function set on
141
- * the `Math` object or a function. See the _Custom easing function_
142
- * demo below. (Defaults to `easeInOutSine`)
194
+ * The text color for the data labels. Defaults to `undefined`. For
195
+ * certain series types, like column or map, the data labels can be
196
+ * drawn inside the points. In this case the data label will be drawn
197
+ * with maximum contrast by default. Additionally, it will be given a
198
+ * `text-outline` style with the opposite color, to further increase the
199
+ * contrast. This can be overridden by setting the `text-outline` style
200
+ * to `none` in the `dataLabels.style` option.
143
201
  *
144
- * Due to poor performance, animation is disabled in old IE browsers for
145
- * several chart types.
202
+ * @deprecated 10.3.0
146
203
  */
147
- animation?: (boolean|Highcharts.AnimationOptionsObject);
204
+ color?: Highcharts.ColorType;
148
205
  /**
149
- * (Highcharts) For some series, there is a limit that shuts down
150
- * animation by default when the total number of points in the chart is
151
- * too high. For example, for a column chart and its derivatives,
152
- * animation does not run if there is more than 250 points totally. To
153
- * disable this cap, set `animationLimit` to `Infinity`. This option
154
- * works if animation is fired on individual points, not on a group of
155
- * points like e.g. during the initial animation.
206
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels
207
+ * that are outside the plot area. By default, the data label is moved
208
+ * inside the plot area according to the overflow option.
156
209
  */
157
- animationLimit?: number;
210
+ crop?: boolean;
158
211
  /**
159
- * (Highcharts) An additional class name to apply to the series'
160
- * graphical elements. This option does not replace default class names
161
- * of the graphical element. Changes to the series' color will also be
162
- * reflected in a chart's legend and tooltip.
212
+ * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
213
+ * labels until the initial series animation has finished. Setting to
214
+ * `false` renders the data label immediately. If set to `true` inherits
215
+ * the defer time set in plotOptions.series.animation.
163
216
  */
164
- className?: string;
217
+ defer?: boolean;
165
218
  /**
166
- * (Highcharts) Disable this option to allow series rendering in the
167
- * whole plotting area.
168
- *
169
- * **Note:** Clipping should be always enabled when chart.zoomType is
170
- * set
219
+ * (Highcharts, Highstock, Gantt) The distance of the data label from
220
+ * the data point. Note that the `padding` setting also affects the
221
+ * rendered distance, but is not visible unless the data label has a
222
+ * border or background.
171
223
  */
172
- clip?: boolean;
224
+ distance?: number;
173
225
  /**
174
- * (Highcharts) The main color of the series. In line type series it
175
- * applies to the line and the point markers unless otherwise specified.
176
- * In bar type series it applies to the bars unless a color is specified
177
- * per point. The default value is pulled from the `options.colors`
178
- * array.
179
- *
180
- * In styled mode, the color can be defined by the colorIndex option.
181
- * Also, the series color can be set with the `.highcharts-series`,
182
- * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
183
- * `.highcharts-series-{n}` class, or individual classes given by the
184
- * `className` option.
226
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
227
+ * labels.
185
228
  */
186
- color?: Highcharts.ColorType;
229
+ enabled?: boolean;
187
230
  /**
188
- * (Highcharts, Highstock, Highmaps) When using dual or multiple color
189
- * axes, this number defines which colorAxis the particular series is
190
- * connected to. It refers to either the axis id or the index of the
191
- * axis in the colorAxis array, with 0 being the first. Set this option
192
- * to false to prevent a series from connecting to the default color
193
- * axis.
194
- *
195
- * Since v7.2.0 the option can also be an axis id or an axis index
196
- * instead of a boolean flag.
231
+ * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to
232
+ * control of which data labels to display. The declarative filter is
233
+ * designed for use when callback functions are not available, like when
234
+ * the chart options require a pure JSON structure or for use with
235
+ * graphical editors. For programmatic control, use the `formatter`
236
+ * instead, and return `undefined` to disable a single data label. (see
237
+ * online documentation for example)
197
238
  */
198
- colorAxis?: (boolean|number|string);
239
+ filter?: Highcharts.DataLabelsFilterOptionsObject;
199
240
  /**
200
- * (Highcharts) Styled mode only. A specific color index to use for the
201
- * series, so its graphic representations are given the class name
202
- * `highcharts-color-{n}`.
203
- *
204
- * Since v11, CSS variables on the form `--highcharts-color-{n}` make
205
- * changing the color scheme very convenient.
241
+ * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
242
+ * label. Available variables are the same as for `formatter`.
206
243
  */
207
- colorIndex?: number;
244
+ format?: string;
208
245
  /**
209
- * (Highcharts, Highstock, Highmaps) Determines what data value should
210
- * be used to calculate point color if `colorAxis` is used. Requires to
211
- * set `min` and `max` if some custom point property is used or if
212
- * approximation for data grouping is set to `'sum'`.
246
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
247
+ * to format the data label. Note that if a `format` is defined, the
248
+ * format takes precedence and the formatter is ignored.
213
249
  */
214
- colorKey?: string;
250
+ formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
215
251
  /**
216
- * (Highcharts) Polar charts only. Whether to connect the ends of a line
217
- * series plot across the extremes.
252
+ * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent,
253
+ * like columns or map areas, whether to align the data label inside the
254
+ * box or to the actual value point. Defaults to `false` in most cases,
255
+ * `true` in stacked columns.
218
256
  */
219
- connectEnds?: boolean;
257
+ inside?: boolean;
220
258
  /**
221
- * (Highcharts, Highstock) Whether to connect a graph line across null
222
- * points, or render a gap between the two points on either side of the
223
- * null.
224
- *
225
- * In stacked area chart, if `connectNulls` is set to true, null points
226
- * are interpreted as 0.
259
+ * (Highcharts, Highstock, Highmaps, Gantt) The rank for this point's
260
+ * data label in case of collision. If two data labels are about to
261
+ * overlap, only the one with the highest `labelrank` will be drawn.
227
262
  */
228
- connectNulls?: boolean;
263
+ labelrank?: number;
229
264
  /**
230
- * (Highcharts, Highstock, Gantt) When true, each point or column edge
231
- * is rounded to its nearest pixel in order to render sharp on screen.
232
- * In some cases, when there are a lot of densely packed columns, this
233
- * leads to visible difference in column widths or distance between
234
- * columns. In these cases, setting `crisp` to `false` may look better,
235
- * even though each column is rendered blurry.
265
+ * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the
266
+ * value of null. Works analogously to format. `nullFormat` can be
267
+ * applied only to series which support displaying null points.
268
+ * `heatmap` and `tilemap` supports `nullFormat` by default while the
269
+ * following series requires [#series.nullInteraction] set to `true`:
270
+ * `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
271
+ * `timeline`. Does not work with series that don't display null points,
272
+ * like `pie`.
236
273
  */
237
- crisp?: boolean;
274
+ nullFormat?: (boolean|string);
238
275
  /**
239
- * (Highcharts) You can set the cursor to "pointer" if you have click
240
- * events attached to the series, to signal to the user that the points
241
- * and lines can be clicked.
242
- *
243
- * In styled mode, the series cursor can be set with the same classes as
244
- * listed under series.color.
276
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
277
+ * that defines formatting for points with the value of null. Works
278
+ * analogously to formatter. `nullFormatter` can be applied only to
279
+ * series which support displaying null points. `heatmap` and `tilemap`
280
+ * supports `nullFormatter` by default while the following series
281
+ * requires (series.nullInteraction)[#series.nullInteraction] set to
282
+ * `true`: `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
283
+ * `timeline`. Does not work with series that don't display null points,
284
+ * like `pie`.
245
285
  */
246
- cursor?: (string|Highcharts.CursorValue);
286
+ nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
247
287
  /**
248
- * (Highcharts) A reserved subspace to store options and values for
249
- * customized functionality. Here you can add additional data for your
250
- * own event callbacks and formatter callbacks.
288
+ * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels
289
+ * that flow outside the plot area. The default is `"justify"`, which
290
+ * aligns them inside the plot area. For columns and bars, this means it
291
+ * will be moved inside the bar. To display data labels outside the plot
292
+ * area, set `crop` to `false` and `overflow` to `"allow"`.
251
293
  */
252
- custom?: Highcharts.Dictionary<any>;
294
+ overflow?: Highcharts.DataLabelsOverflowValue;
253
295
  /**
254
- * (Highcharts) Name of the dash style to use for the graph, or for some
255
- * series types the outline of each shape.
296
+ * (Highcharts, Highstock, Highmaps, Gantt) When either the
297
+ * `borderWidth` or the `backgroundColor` is set, this is the padding
298
+ * within the box.
256
299
  *
257
- * In styled mode, the stroke dash-array can be set with the same
258
- * classes as listed under series.color.
300
+ * An array of numbers sets padding for the respective sides. An array
301
+ * of two numbers repeats the values for the horizontal and vertical
302
+ * sides.
259
303
  */
260
- dashStyle?: Highcharts.DashStyleValue;
304
+ padding?: (number|Array<number>);
261
305
  /**
262
- * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
263
- * labels, appearing next to each data point.
264
- *
265
- * Since v6.2.0, multiple data labels can be applied to each single
266
- * point by defining them as an array of configs.
267
- *
268
- * In styled mode, the data labels can be styled with the
269
- * `.highcharts-data-label-box` and `.highcharts-data-label` class names
270
- * (see example).
306
+ * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
307
+ * to points. If `center` alignment is not possible, it defaults to
308
+ * `right`.
271
309
  */
272
- dataLabels?: (Highcharts.PlotScatter3dDataLabelsOptions|Array<Highcharts.PlotScatter3dDataLabelsOptions>);
310
+ position?: Highcharts.AlignValue;
273
311
  /**
274
- * (Highcharts) The mapping between the data table and the series data
275
- * points. This is used in conjunction with the `dataTable` option (on
276
- * chart or series level) to map columns from the data table to the
277
- * properties of the data points. The keys of the `dataMapping` object
278
- * correspond to the properties of the data points (e.g. `x`, `y`,
279
- * `name`), and the values are objects that specify which column from
280
- * which data table to use for that property.
281
- *
282
- * The keys can also be nested paths, for example `dataLabel.format`, to
283
- * map to nested properties of the data points.
284
- *
285
- * The values can also be strings, in which case they are interpreted as
286
- * column id's from the first data table.
287
- *
288
- * A typical use case is that multiple series share a common column,
289
- * like `name` or `x`. In this case, to avoid repetition, the common
290
- * column can be applied in `plotOptions.series.dataMapping` and the
291
- * individual series can specify only the columns that are unique to
292
- * them.
293
- *
294
- * The series name defaults to the column ID of the main data column in
295
- * the mapping. The main data column is typically the `y` data for
296
- * cartesian series, or `value` for map series. For example, if the
297
- * mapping is `{ y: 'Cost' }`, the series name will be `Cost`. (see
298
- * online documentation for example)
299
- *
300
- * If the columns of the DataTable have keys matching the series keys,
301
- * the data mapping is not necessary. For example, this DataTable will
302
- * connect directly to the series' `x` and `y` keys: (see online
303
- * documentation for example)
312
+ * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees.
313
+ * Note that due to a more complex structure, backgrounds, borders and
314
+ * padding will be lost on a rotated data label.
304
315
  */
305
- dataMapping?: Highcharts.DataMappingOptionsObject;
316
+ rotation?: number;
306
317
  /**
307
- * (Highcharts, Highstock) Options for series data sorting.
318
+ * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
319
+ * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow
320
+ * can be an object configuration containing `color`, `offsetX`,
321
+ * `offsetY`, `opacity` and `width`.
308
322
  */
309
- dataSorting?: Highcharts.PlotScatter3dDataSortingOptions;
323
+ shadow?: (boolean|Highcharts.ShadowOptionsObject);
310
324
  /**
311
- * (Highcharts) Options for a specific series-level data table or an
312
- * array of data tables. The `dataTable` option can be either a
313
- * configuration object or an instance of the `DataTable` class. If a
314
- * `DataTable` instance is passed, it will be used directly. If a
315
- * configuration object or an array is passed, a new `DataTable`
316
- * instance will be created based on the provided configuration.
325
+ * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use
326
+ * for the border around the label. Symbols are predefined functions on
327
+ * the Renderer object.
317
328
  */
318
- dataTable?: (Highcharts.DataTable|Highcharts.DataTableOptionsObject|Array<(Highcharts.DataTable|Highcharts.DataTableOptionsObject)>);
329
+ shape?: string;
319
330
  /**
320
- * (Highcharts) Deprecated. Use
321
- * plotOptions.series.accessibility.description instead.
331
+ * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
332
+ * default `color` setting is `"contrast"`, which is a pseudo color that
333
+ * Highcharts picks up and applies the maximum contrast to the
334
+ * underlying point item, for example the bar in a bar chart.
322
335
  *
323
- * A description of the series to add to the screen reader information
324
- * about the series.
336
+ * The `textOutline` is a pseudo property that applies an outline of the
337
+ * given width with the given color, which by default is the maximum
338
+ * contrast to the text. So a bright text color will result in a black
339
+ * text outline for maximum readability on a mixed background. In some
340
+ * cases, especially with grayscale text, the text outline doesn't work
341
+ * well, in which cases it can be disabled by setting it to `"none"`.
342
+ * When `useHTML` is true, the `textOutline` will not be picked up. In
343
+ * this, case, the same effect can be achieved through the `text-shadow`
344
+ * CSS property. As a complementary or alternative to the `textOutline`,
345
+ * a `dataLabels.backgroundColor` can be used. It provides a more calm
346
+ * impression and ensures readable text label, at the cost of a risk of
347
+ * overshadowing the underlying chart elements.
325
348
  *
326
- * @deprecated 8.0.0
349
+ * For some series types, where each point has an extent, like for
350
+ * example tree maps, the data label may overflow the point. There are
351
+ * two strategies for handling overflow. By default, the text will wrap
352
+ * to multiple lines. The other strategy is to set `style.textOverflow`
353
+ * to `ellipsis`, which will keep the text on one line plus it will
354
+ * break inside long words.
327
355
  */
328
- description?: string;
356
+ style?: Highcharts.CSSObject;
329
357
  /**
330
- * (Highcharts) Enable or disable the mouse tracking for a specific
331
- * series. This includes point tooltips and click events on graphs and
332
- * points. For large datasets it improves performance.
358
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text
359
+ * which should follow marker's shape. Border and background are
360
+ * disabled for a label that follows a path.
361
+ *
362
+ * **Note:** Only SVG-based renderer supports this option. Setting
363
+ * `useHTML` to true will disable this option.
364
+ *
365
+ * Text path support is not bundled into `highcharts.js`, and requires
366
+ * the `modules/textpath.js` file. However, it is included in the script
367
+ * files of those series types that use it by default.
333
368
  */
334
- enableMouseTracking?: boolean;
369
+ textPath?: Highcharts.DataLabelsTextPathOptionsObject;
335
370
  /**
336
- * (Highcharts) General event handlers for the series items. These event
337
- * hooks can also be attached to the series at run time using the
338
- * `Highcharts.addEvent` function.
371
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to
372
+ * render the labels.
339
373
  */
340
- events?: Highcharts.SeriesEventsOptionsObject;
374
+ useHTML?: boolean;
341
375
  /**
342
- * (Highcharts) Determines whether the series should look for the
343
- * nearest point in both dimensions or just the x-dimension when
344
- * hovering the series. Defaults to `'xy'` for scatter series and `'x'`
345
- * for most other series. If the data has duplicate x-values, it is
346
- * recommended to set this to `'xy'` to allow hovering over all points.
347
- *
348
- * Applies only to series types using nearest neighbor search (not
349
- * direct hover) for tooltip.
376
+ * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a
377
+ * data label. Can be one of `top`, `middle` or `bottom`. The default
378
+ * value depends on the data, for instance in a column chart, the label
379
+ * is above positive values and below negative values.
350
380
  */
351
- findNearestPointBy?: Highcharts.OptionsFindNearestPointByValue;
381
+ verticalAlign?: (Highcharts.VerticalAlignValue|null);
352
382
  /**
353
- * (Highcharts, Highstock) Defines when to display a gap in the graph,
354
- * together with the gapUnit option.
355
- *
356
- * In case when `dataGrouping` is enabled, points can be grouped into a
357
- * larger time span. This can make the grouped points to have a greater
358
- * distance than the absolute value of `gapSize` property, which will
359
- * result in disappearing graph completely. To prevent this situation
360
- * the mentioned distance between grouped points is used instead of
361
- * previously defined `gapSize`.
362
- *
363
- * In practice, this option is most often used to visualize gaps in time
364
- * series. In a stock chart, intraday data is available for daytime
365
- * hours, while gaps will appear in nights and weekends.
383
+ * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
384
+ * label relative to the point in pixels.
366
385
  */
367
- gapSize?: number;
386
+ x?: number;
368
387
  /**
369
- * (Highcharts, Highstock) Together with gapSize, this option defines
370
- * where to draw gaps in the graph.
371
- *
372
- * When the `gapUnit` is `"relative"` (default), a gap size of 5 means
373
- * that if the distance between two points is greater than 5 times that
374
- * of the two closest points, the graph will be broken.
375
- *
376
- * When the `gapUnit` is `"value"`, the gap is based on absolute axis
377
- * values, which on a datetime axis is milliseconds. This also applies
378
- * to the navigator series that inherits gap options from the base
379
- * series.
388
+ * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
389
+ * label relative to the point in pixels.
380
390
  */
381
- gapUnit?: Highcharts.OptionsGapUnitValue;
391
+ y?: number;
382
392
  /**
383
- * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the
384
- * total chart width or only the zoomed area when zooming in on parts of
385
- * the X axis. By default, the Y axis adjusts to the min and max of the
386
- * visible data. Cartesian series only.
393
+ * (Highcharts, Highstock, Highmaps, Gantt) The z index of the data
394
+ * labels group. Does not apply below series level options.
395
+ *
396
+ * Use a `zIndex` of 6 to display it above the series, or use a `zIndex`
397
+ * of 2 to display it behind the series.
387
398
  */
388
- getExtremesFromAll?: boolean;
399
+ zIndex?: number;
400
+ }
401
+ /**
402
+ * (Highcharts, Highstock) Options for series data sorting.
403
+ */
404
+ interface PlotScatter3dDataSortingOptions {
389
405
  /**
390
- * (Highcharts) Highlight only the hovered point and fade the remaining
391
- * points.
392
- *
393
- * Scatter-type series require enabling the 'inactive' marker state and
394
- * adjusting opacity. Note that this approach could affect performance
395
- * with large datasets.
406
+ * (Highcharts, Highstock) Enable or disable data sorting for the
407
+ * series. Use xAxis.reversed to change the sorting order.
396
408
  */
397
- inactiveOtherPoints?: boolean;
409
+ enabled?: boolean;
398
410
  /**
399
- * (Highcharts) When set to `false` will prevent the series data from
400
- * being included in any form of data export.
401
- *
402
- * Since version 6.0.0 until 7.1.0 the option was existing undocumented
403
- * as `includeInCSVExport`.
411
+ * (Highcharts, Highstock) Whether to allow matching points by name in
412
+ * an update. If this option is disabled, points will be matched by
413
+ * order.
404
414
  */
405
- includeInDataExport?: boolean;
415
+ matchByName?: boolean;
406
416
  /**
407
- * (Highcharts, Highstock) Apply a jitter effect for the rendered
408
- * markers. When plotting discrete values, a little random noise may
409
- * help telling the points apart. The jitter setting applies a random
410
- * displacement of up to `n` axis units in either direction. So for
411
- * example on a horizontal X axis, setting the `jitter.x` to 0.24 will
412
- * render the point in a random position between 0.24 units to the left
413
- * and 0.24 units to the right of the true axis position. On a category
414
- * axis, setting it to 0.5 will fill up the bin and make the data appear
415
- * continuous.
416
- *
417
- * When rendered on top of a box plot or a column series, a jitter value
418
- * of 0.24 will correspond to the underlying series' default
419
- * groupPadding and pointPadding settings.
420
- *
421
- * **Note:** With boost mode enabled, the jitter effect is not
422
- * supported.
417
+ * (Highcharts, Highstock) Determines what data value should be used to
418
+ * sort by.
423
419
  */
424
- jitter?: Highcharts.PlotScatter3dJitterOptions;
420
+ sortKey?: string;
421
+ }
422
+ /**
423
+ * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
424
+ * When plotting discrete values, a little random noise may help telling the
425
+ * points apart. The jitter setting applies a random displacement of up to
426
+ * `n` axis units in either direction. So for example on a horizontal X
427
+ * axis, setting the `jitter.x` to 0.24 will render the point in a random
428
+ * position between 0.24 units to the left and 0.24 units to the right of
429
+ * the true axis position. On a category axis, setting it to 0.5 will fill
430
+ * up the bin and make the data appear continuous.
431
+ *
432
+ * When rendered on top of a box plot or a column series, a jitter value of
433
+ * 0.24 will correspond to the underlying series' default groupPadding and
434
+ * pointPadding settings.
435
+ *
436
+ * **Note:** With boost mode enabled, the jitter effect is not supported.
437
+ */
438
+ interface PlotScatter3dJitterOptions {
425
439
  /**
426
- * (Highcharts) An array specifying which option maps to which key in
427
- * the data point array. This makes it convenient to work with
428
- * unstructured data arrays from different sources.
440
+ * (Highcharts, Highstock) The maximal X offset for the random jitter
441
+ * effect.
429
442
  */
430
- keys?: Array<string>;
443
+ x?: number;
431
444
  /**
432
- * (Highcharts, Highstock, Gantt) Series labels are placed as close to
433
- * the series as possible in a natural way, seeking to avoid other
434
- * series. The goal of this feature is to make the chart more easily
435
- * readable, like if a human designer placed the labels in the optimal
436
- * position.
437
- *
438
- * The series labels currently work with series types having a `graph`
439
- * or an `area`.
445
+ * (Highcharts, Highstock) The maximal Y offset for the random jitter
446
+ * effect.
440
447
  */
441
- label?: Highcharts.SeriesLabelOptionsObject;
448
+ y?: number;
449
+ }
450
+ /**
451
+ * (Highcharts, Highstock, Gantt) Styles for the series label. The color
452
+ * defaults to the series color, or a contrast color if `onArea`.
453
+ */
454
+ interface PlotScatter3dLabelStyleOptions {
455
+ fontSize?: number;
456
+ fontWeight?: string;
457
+ }
458
+ /**
459
+ * (Highcharts) Animation when hovering over the marker.
460
+ */
461
+ interface PlotScatter3dMarkerStatesHoverAnimationOptions {
462
+ duration?: number;
463
+ }
464
+ /**
465
+ * (Highcharts) Animation when hovering over the marker.
466
+ */
467
+ interface PlotScatter3dMarkerStatesSelectAnimationOptions {
468
+ duration?: number;
469
+ }
470
+ /**
471
+ * (Highcharts) Options for the connector in the _Series on point_ feature.
472
+ *
473
+ * In styled mode, the connector can be styled with the
474
+ * `.highcharts-connector-seriesonpoint` class name.
475
+ */
476
+ interface PlotScatter3dOnPointConnectorOptions {
442
477
  /**
443
- * (Highcharts) What type of legend symbol to render for this series.
444
- * Can be one of `areaMarker`, `lineMarker` or `rectangle`.
478
+ * (Highcharts) A name for the dash style to use for the connector.
445
479
  */
446
- legendSymbol?: Highcharts.OptionsLegendSymbolValue;
480
+ dashstyle?: string;
447
481
  /**
448
- * (Highcharts) The line cap used for line ends and line joins on the
449
- * graph.
482
+ * (Highcharts) Color of the connector line. By default it's the series'
483
+ * color.
450
484
  */
451
- linecap?: Highcharts.SeriesLinecapValue;
485
+ stroke?: string;
452
486
  /**
453
- * (Highcharts, Highstock) The width of the line connecting the data
454
- * points.
487
+ * (Highcharts) Pixel width of the connector line.
455
488
  */
456
- lineWidth?: number;
489
+ width?: number;
490
+ }
491
+ /**
492
+ * (Highcharts) Options for the _Series on point_ feature. Only `pie` and
493
+ * `sunburst` series are supported at this moment.
494
+ */
495
+ interface PlotScatter3dOnPointOptions {
457
496
  /**
458
- * (Highcharts, Highstock, Gantt) The id of another series to link to.
459
- * Additionally, the value can be ":previous" to link to the previous
460
- * series. When two series are linked, only the first one appears in the
461
- * legend. Toggling the visibility of this also toggles the linked
462
- * series.
463
- *
464
- * If master series uses data sorting and linked series does not have
465
- * its own sorting definition, the linked series will be sorted in the
466
- * same order as the master one.
497
+ * (Highcharts) Options for the connector in the _Series on point_
498
+ * feature.
467
499
  *
468
- * If a `compare` value is not set on a linked series, it will be
469
- * inherited from the parent series.
500
+ * In styled mode, the connector can be styled with the
501
+ * `.highcharts-connector-seriesonpoint` class name.
470
502
  */
471
- linkedTo?: string;
503
+ connectorOptions?: (Highcharts.PlotScatter3dOnPointConnectorOptions|Highcharts.SVGAttributes);
472
504
  /**
473
- * (Highcharts) Options for the point markers of line and scatter-like
474
- * series. Properties like `fillColor`, `lineColor` and `lineWidth`
475
- * define the visual appearance of the markers. The `symbol` option
476
- * defines the shape. Other series types, like column series, don't have
477
- * markers, but have visual options on the series level instead.
478
- *
479
- * In styled mode, the markers can be styled with the
480
- * `.highcharts-point`, `.highcharts-point-hover` and
481
- * `.highcharts-point-select` class names.
505
+ * (Highcharts) The `id` of the point that we connect the series to.
506
+ * Only points with a given `plotX` and `plotY` values and map points
507
+ * are valid.
482
508
  */
483
- marker?: Highcharts.PointMarkerOptionsObject;
509
+ id?: string;
484
510
  /**
485
- * (Highcharts) The color for the parts of the graph or points that are
486
- * below the threshold. Note that `zones` takes precedence over the
487
- * negative color. Using `negativeColor` is equivalent to applying a
488
- * zone with value of 0.
511
+ * (Highcharts) Options allowing to set a position and an offset of the
512
+ * series in the _Series on point_ feature.
489
513
  */
490
- negativeColor?: Highcharts.ColorType;
514
+ position?: (object|Highcharts.PlotScatter3dOnPointPositionOptions);
515
+ }
516
+ /**
517
+ * (Highcharts) Options allowing to set a position and an offset of the
518
+ * series in the _Series on point_ feature.
519
+ */
520
+ interface PlotScatter3dOnPointPositionOptions {
491
521
  /**
492
- * (Highcharts, Highstock) Whether or not data-points with the value of
493
- * `null` should be interactive. When this is set to `true`, tooltips
494
- * may highlight these points, and this option also enables keyboard
495
- * navigation for such points. Format options for such points include
496
- * `nullFormat` and `nullFormatter`. Works for these series: `line`,
497
- * `spline`, `area`, `area-spline`, `column`, `bar`, and `timeline`.
522
+ * (Highcharts) Series center offset from the original x position. If
523
+ * defined, the connector line is drawn connecting original position
524
+ * with new position.
498
525
  */
499
- nullInteraction?: (boolean|undefined);
526
+ offsetX?: number;
500
527
  /**
501
- * (Highcharts) Options for the _Series on point_ feature. Only `pie`
502
- * and `sunburst` series are supported at this moment.
528
+ * (Highcharts) Series center offset from the original y position. If
529
+ * defined, the connector line is drawn from original position to a new
530
+ * position.
503
531
  */
504
- onPoint?: (object|Highcharts.PlotScatter3dOnPointOptions);
532
+ offsetY?: number;
505
533
  /**
506
- * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
507
- * dataLabels.
534
+ * (Highcharts) X position of the series center. By default, the series
535
+ * is displayed on the point that it is connected to.
508
536
  */
509
- opacity?: number;
537
+ x?: number;
510
538
  /**
511
- * (Highcharts) Properties for each single point.
539
+ * (Highcharts) Y position of the series center. By default, the series
540
+ * is displayed on the point that it is connected to.
512
541
  */
513
- point?: Highcharts.PlotSeriesPointOptions;
542
+ y?: number;
543
+ }
544
+ /**
545
+ * (Highcharts) A 3D scatter plot uses x, y and z coordinates to display
546
+ * values for three variables for a set of data.
547
+ *
548
+ * Configuration options for the series are given in three levels:
549
+ *
550
+ * 1. Options for all series in a chart are defined in the
551
+ * plotOptions.series object.
552
+ *
553
+ * 2. Options for all `scatter3d` series are defined in
554
+ * plotOptions.scatter3d.
555
+ *
556
+ * 3. Options for one single series are given in the series instance array.
557
+ * (see online documentation for example)
558
+ *
559
+ * **TypeScript:**
560
+ *
561
+ * - type option should always be set, otherwise a broad set of unsupported
562
+ * options is allowed.
563
+ *
564
+ * - when accessing an array of series, the combined set of all series types
565
+ * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
566
+ * specific type can be done by checking the `type` property. (see online
567
+ * documentation for example)
568
+ */
569
+ interface PlotScatter3dOptions {
514
570
  /**
515
- * (Highcharts) Deprecated. Use
516
- * series.accessibility.point.descriptionFormat instead.
517
- *
518
- * Same as accessibility.point.descriptionFormat, but for an individual
519
- * series. Overrides the chart wide configuration.
520
- *
521
- * @deprecated 12.6.0
571
+ * (Highcharts) Accessibility options for a series.
522
572
  */
523
- pointDescriptionFormat?: Function;
573
+ accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
524
574
  /**
525
- * (Highcharts) Deprecated. Use
526
- * series.accessibility.point.descriptionFormatter instead.
575
+ * (Highcharts) Allow this series' points to be selected by clicking on
576
+ * the graphic (columns, point markers, pie slices, map areas etc).
527
577
  *
528
- * Same as accessibility.series.descriptionFormatter, but for an
529
- * individual series. Overrides the chart wide configuration.
578
+ * The selected points can be handled by point select and unselect
579
+ * events, or collectively by the getSelectedPoints function.
530
580
  *
531
- * @deprecated 8.0.0
581
+ * And alternative way of selecting points is through dragging.
532
582
  */
533
- pointDescriptionFormatter?: Function;
583
+ allowPointSelect?: boolean;
534
584
  /**
535
- * (Highcharts, Highstock, Gantt) If no x values are given for the
536
- * points in a series, `pointInterval` defines the interval of the x
537
- * values. For example, if a series contains one value every decade
538
- * starting from year 0, set `pointInterval` to `10`. In true `datetime`
539
- * axes, the `pointInterval` is set in milliseconds.
585
+ * (Highcharts) Enable or disable the initial animation when a series is
586
+ * displayed. The animation can also be set as a configuration object.
587
+ * Please note that this option only applies to the initial animation of
588
+ * the series itself. For other animations, see chart.animation and the
589
+ * animation parameter under the API methods. The following properties
590
+ * are supported:
540
591
  *
541
- * It can be also be combined with `pointIntervalUnit` to draw irregular
542
- * time intervals.
592
+ * - `defer`: The animation delay time in milliseconds.
543
593
  *
544
- * If combined with `relativeXValue`, an x value can be set on each
545
- * point, and the `pointInterval` is added x times to the `pointStart`
546
- * setting.
594
+ * - `duration`: The duration of the animation in milliseconds.
595
+ * (Defaults to `1000`)
547
596
  *
548
- * Please note that this options applies to the _series data_, not the
549
- * interval of the axis ticks, which is independent.
550
- */
551
- pointInterval?: number;
552
- /**
553
- * (Highcharts, Highstock, Gantt) On datetime series, this allows for
554
- * setting the pointInterval to irregular time units, `day`, `month` and
555
- * `year`. A day is usually the same as 24 hours, but
556
- * `pointIntervalUnit` also takes the DST crossover into consideration
557
- * when dealing with local time. Combine this option with
558
- * `pointInterval` to draw weeks, quarters, 6 months, 10 years etc.
597
+ * - `easing`: Can be a string reference to an easing function set on
598
+ * the `Math` object or a function. See the _Custom easing function_
599
+ * demo below. (Defaults to `easeInOutSine`)
559
600
  *
560
- * Please note that this options applies to the _series data_, not the
561
- * interval of the axis ticks, which is independent.
601
+ * Due to poor performance, animation is disabled in old IE browsers for
602
+ * several chart types.
562
603
  */
563
- pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue;
604
+ animation?: (boolean|Highcharts.AnimationOptionsObject);
564
605
  /**
565
- * (Highcharts, Highstock, Gantt) If no x values are given for the
566
- * points in a series, `pointStart` defines on what value to start. For
567
- * example, if a series contains one yearly value starting from 1945,
568
- * set `pointStart` to 1945.
569
- *
570
- * The `pointStart` setting can be a number, or a datetime string that
571
- * is parsed according to the `time.timezone` setting.
572
- *
573
- * If combined with `relativeXValue`, an x value can be set on each
574
- * point. The x value from the point options is multiplied by
575
- * `pointInterval` and added to `pointStart` to produce a modified x
576
- * value.
606
+ * (Highcharts) For some series, there is a limit that shuts down
607
+ * animation by default when the total number of points in the chart is
608
+ * too high. For example, for a column chart and its derivatives,
609
+ * animation does not run if there is more than 250 points totally. To
610
+ * disable this cap, set `animationLimit` to `Infinity`. This option
611
+ * works if animation is fired on individual points, not on a group of
612
+ * points like e.g. during the initial animation.
577
613
  */
578
- pointStart?: (number|string);
614
+ animationLimit?: number;
579
615
  /**
580
- * (Highcharts, Highstock) When true, X values in the data set are
581
- * relative to the current `pointStart`, `pointInterval` and
582
- * `pointIntervalUnit` settings. This allows compression of the data for
583
- * datasets with irregular X values.
584
- *
585
- * The real X values are computed on the formula `f(x) = ax + b`, where
586
- * `a` is the `pointInterval` (optionally with a time unit given by
587
- * `pointIntervalUnit`), and `b` is the `pointStart`.
616
+ * (Highcharts) An additional class name to apply to the series'
617
+ * graphical elements. This option does not replace default class names
618
+ * of the graphical element. Changes to the series' color will also be
619
+ * reflected in a chart's legend and tooltip.
588
620
  */
589
- relativeXValue?: boolean;
621
+ className?: string;
590
622
  /**
591
- * (Highcharts) Whether to select the series initially. If
592
- * `showCheckbox` is true, the checkbox next to the series name in the
593
- * legend will be checked for a selected series.
623
+ * (Highcharts) Disable this option to allow series rendering in the
624
+ * whole plotting area.
625
+ *
626
+ * **Note:** Clipping should be always enabled when chart.zoomType is
627
+ * set
594
628
  */
595
- selected?: boolean;
629
+ clip?: boolean;
596
630
  /**
597
- * (Highcharts) If true, a checkbox is displayed next to the legend item
598
- * to allow selecting the series. The state of the checkbox is
599
- * determined by the `selected` option.
631
+ * (Highcharts) The main color of the series. In line type series it
632
+ * applies to the line and the point markers unless otherwise specified.
633
+ * In bar type series it applies to the bars unless a color is specified
634
+ * per point. The default value is pulled from the `options.colors`
635
+ * array.
636
+ *
637
+ * In styled mode, the color can be defined by the colorIndex option.
638
+ * Also, the series color can be set with the `.highcharts-series`,
639
+ * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
640
+ * `.highcharts-series-{n}` class, or individual classes given by the
641
+ * `className` option.
600
642
  */
601
- showCheckbox?: boolean;
643
+ color?: Highcharts.ColorType;
602
644
  /**
603
- * (Highcharts) Whether to display this particular series or series type
604
- * in the legend. Standalone series are shown in legend by default, and
605
- * linked series are not. Since v7.2.0 it is possible to show series
606
- * that use colorAxis by setting this option to `true`.
645
+ * (Highcharts, Highstock, Highmaps) When using dual or multiple color
646
+ * axes, this number defines which colorAxis the particular series is
647
+ * connected to. It refers to either the axis id or the index of the
648
+ * axis in the colorAxis array, with 0 being the first. Set this option
649
+ * to false to prevent a series from connecting to the default color
650
+ * axis.
651
+ *
652
+ * Since v7.2.0 the option can also be an axis id or an axis index
653
+ * instead of a boolean flag.
607
654
  */
608
- showInLegend?: boolean;
655
+ colorAxis?: (boolean|number|string);
609
656
  /**
610
- * (Highcharts) Deprecated. Use series.accessibility.keyboardNavigation
611
- * instead.
612
- *
613
- * If set to `true`, the accessibility module will skip past the points
614
- * in this series for keyboard navigation.
657
+ * (Highcharts) Styled mode only. A specific color index to use for the
658
+ * series, so its graphic representations are given the class name
659
+ * `highcharts-color-{n}`.
615
660
  *
616
- * @deprecated 8.0.0
661
+ * Since v11, CSS variables on the form `--highcharts-color-{n}` make
662
+ * changing the color scheme very convenient.
617
663
  */
618
- skipKeyboardNavigation?: boolean;
664
+ colorIndex?: number;
619
665
  /**
620
- * (Highcharts, Highstock) When this is true, the series will not cause
621
- * the Y axis to cross the zero plane (or threshold option) unless the
622
- * data actually crosses the plane.
623
- *
624
- * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3
625
- * will make the Y axis show negative values according to the
626
- * `minPadding` option. If `softThreshold` is `true`, the Y axis starts
627
- * at 0.
666
+ * (Highcharts, Highstock, Highmaps) Determines what data value should
667
+ * be used to calculate point color if `colorAxis` is used. Requires to
668
+ * set `min` and `max` if some custom point property is used or if
669
+ * approximation for data grouping is set to `'sum'`.
628
670
  */
629
- softThreshold?: boolean;
671
+ colorKey?: string;
630
672
  /**
631
- * (Highcharts) Sonification/audio chart options for a series.
673
+ * (Highcharts) Polar charts only. Whether to connect the ends of a line
674
+ * series plot across the extremes.
632
675
  */
633
- sonification?: Highcharts.SeriesSonificationOptions;
676
+ connectEnds?: boolean;
634
677
  /**
635
- * (Highcharts, Highstock) Whether to stack the values of each series on
636
- * top of each other. Possible values are null to disable, `"normal"` to
637
- * stack by value or `"percent"`.
638
- *
639
- * When stacking is enabled, data must be sorted in ascending X order.
678
+ * (Highcharts, Highstock) Whether to connect a graph line across null
679
+ * points, or render a gap between the two points on either side of the
680
+ * null.
640
681
  *
641
- * Some stacking options are related to specific series types. In the
642
- * streamgraph series type, the stacking option is set to `"stream"`.
643
- * The second one is `"overlap"`, which only applies to waterfall
644
- * series.
682
+ * In stacked area chart, if `connectNulls` is set to true, null points
683
+ * are interpreted as 0.
645
684
  */
646
- stacking?: Highcharts.OptionsStackingValue;
685
+ connectNulls?: boolean;
647
686
  /**
648
- * (Highcharts) A collection of options for different series states.
649
- *
650
- * In addition to the options documented under each state, any option
651
- * from the parent series type can be set, with exception of `data` and
652
- * `states`.
687
+ * (Highcharts, Highstock, Gantt) When true, each point or column edge
688
+ * is rounded to its nearest pixel in order to render sharp on screen.
689
+ * In some cases, when there are a lot of densely packed columns, this
690
+ * leads to visible difference in column widths or distance between
691
+ * columns. In these cases, setting `crisp` to `false` may look better,
692
+ * even though each column is rendered blurry.
653
693
  */
654
- states?: Highcharts.SeriesStatesOptionsObject;
694
+ crisp?: boolean;
655
695
  /**
656
- * (Highcharts, Highstock) Whether to apply steps to the line. Possible
657
- * values are `left`, `center` and `right`.
696
+ * (Highcharts) You can set the cursor to "pointer" if you have click
697
+ * events attached to the series, to signal to the user that the points
698
+ * and lines can be clicked.
699
+ *
700
+ * In styled mode, the series cursor can be set with the same classes as
701
+ * listed under series.color.
658
702
  */
659
- step?: Highcharts.OptionsStepValue;
703
+ cursor?: (string|Highcharts.CursorValue);
660
704
  /**
661
- * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events.
662
- * When true, the `mouseOut` event on a series isn't triggered until the
663
- * mouse moves over another series, or out of the plot area. When false,
664
- * the `mouseOut` event on a series is triggered when the mouse leaves
665
- * the area around the series' graph or markers. This also implies the
666
- * tooltip. When `stickyTracking` is false and `tooltip.shared` is
667
- * false, the tooltip will be hidden when moving the mouse between
668
- * series.
705
+ * (Highcharts) A reserved subspace to store options and values for
706
+ * customized functionality. Here you can add additional data for your
707
+ * own event callbacks and formatter callbacks.
669
708
  */
670
- stickyTracking?: boolean;
709
+ custom?: Highcharts.Dictionary<any>;
671
710
  /**
672
- * (Highcharts, Highstock) The threshold, also called zero level or base
673
- * level. For line type series this is only used in conjunction with
674
- * negativeColor.
711
+ * (Highcharts) Name of the dash style to use for the graph, or for some
712
+ * series types the outline of each shape.
713
+ *
714
+ * In styled mode, the stroke dash-array can be set with the same
715
+ * classes as listed under series.color.
675
716
  */
676
- threshold?: (number|null);
717
+ dashStyle?: Highcharts.DashStyleValue;
677
718
  /**
678
- * (Highcharts, Highstock, Highmaps) A configuration object for the
679
- * tooltip rendering of each single series. Properties are inherited
680
- * from tooltip. Overridable properties are `headerFormat`,
681
- * `pointFormat`, `yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`.
682
- * Unlike other series, in a scatter plot the series.name by default
683
- * shows in the headerFormat and point.x and point.y in the pointFormat.
719
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
720
+ * labels, appearing next to each data point.
721
+ *
722
+ * Since v6.2.0, multiple data labels can be applied to each single
723
+ * point by defining them as an array of configs.
724
+ *
725
+ * In styled mode, the data labels can be styled with the
726
+ * `.highcharts-data-label-box` and `.highcharts-data-label` class names
727
+ * (see example).
684
728
  */
685
- tooltip?: Highcharts.SeriesTooltipOptionsObject;
729
+ dataLabels?: (Highcharts.PlotScatter3dDataLabelsOptions|Array<Highcharts.PlotScatter3dDataLabelsOptions>);
686
730
  /**
687
- * (Highcharts, Highstock, Gantt) When a series contains a `data` array
688
- * that is longer than this, the Series class looks for data
689
- * configurations of plain numbers or arrays of numbers. The first and
690
- * last valid points are checked. If found, the rest of the data is
691
- * assumed to be the same. This saves expensive data checking and
692
- * indexing in long series, and makes data-heavy charts render faster.
731
+ * (Highcharts) The mapping between the data table and the series data
732
+ * points. This is used in conjunction with the `dataTable` option (on
733
+ * chart or series level) to map columns from the data table to the
734
+ * properties of the data points. The keys of the `dataMapping` object
735
+ * correspond to the properties of the data points (e.g. `x`, `y`,
736
+ * `name`), and the values are objects that specify which column from
737
+ * which data table to use for that property.
693
738
  *
694
- * Set it to `0` disable.
739
+ * The keys can also be nested paths, for example `dataLabel.format`, to
740
+ * map to nested properties of the data points.
695
741
  *
696
- * Note:
742
+ * The values can also be strings, in which case they are interpreted as
743
+ * column id's from the first data table.
697
744
  *
698
- * - In boost mode turbo threshold is forced. Only array of numbers or
699
- * two dimensional arrays are allowed.
745
+ * A typical use case is that multiple series share a common column,
746
+ * like `name` or `x`. In this case, to avoid repetition, the common
747
+ * column can be applied in `plotOptions.series.dataMapping` and the
748
+ * individual series can specify only the columns that are unique to
749
+ * them.
700
750
  *
701
- * - In version 11.4.3 and earlier, if object configurations were passed
751
+ * The series name defaults to the column ID of the main data column in
752
+ * the mapping. The main data column is typically the `y` data for
753
+ * cartesian series, or `value` for map series. For example, if the
754
+ * mapping is `{ y: 'Cost' }`, the series name will be `Cost`. (see
755
+ * online documentation for example)
756
+ *
757
+ * If the columns of the DataTable have keys matching the series keys,
758
+ * the data mapping is not necessary. For example, this DataTable will
759
+ * connect directly to the series' `x` and `y` keys: (see online
760
+ * documentation for example)
761
+ */
762
+ dataMapping?: Highcharts.DataMappingOptionsObject;
763
+ /**
764
+ * (Highcharts, Highstock) Options for series data sorting.
765
+ */
766
+ dataSorting?: Highcharts.PlotScatter3dDataSortingOptions;
767
+ /**
768
+ * (Highcharts) Options for a specific series-level data table or an
769
+ * array of data tables. The `dataTable` option can be either a
770
+ * configuration object or an instance of the `DataTable` class. If a
771
+ * `DataTable` instance is passed, it will be used directly. If a
772
+ * configuration object or an array is passed, a new `DataTable`
773
+ * instance will be created based on the provided configuration.
774
+ */
775
+ dataTable?: (Highcharts.DataTable|Highcharts.DataTableOptionsObject|Array<(Highcharts.DataTable|Highcharts.DataTableOptionsObject)>);
776
+ /**
777
+ * (Highcharts) Deprecated. Use
778
+ * plotOptions.series.accessibility.description instead.
779
+ *
780
+ * A description of the series to add to the screen reader information
781
+ * about the series.
782
+ *
783
+ * @deprecated 8.0.0
784
+ */
785
+ description?: string;
786
+ /**
787
+ * (Highcharts) Enable or disable the mouse tracking for a specific
788
+ * series. This includes point tooltips and click events on graphs and
789
+ * points. For large datasets it improves performance.
790
+ */
791
+ enableMouseTracking?: boolean;
792
+ /**
793
+ * (Highcharts) General event handlers for the series items. These event
794
+ * hooks can also be attached to the series at run time using the
795
+ * `Highcharts.addEvent` function.
796
+ */
797
+ events?: Highcharts.SeriesEventsOptionsObject;
798
+ /**
799
+ * (Highcharts) Determines whether the series should look for the
800
+ * nearest point in both dimensions or just the x-dimension when
801
+ * hovering the series. Defaults to `'xy'` for scatter series and `'x'`
802
+ * for most other series. If the data has duplicate x-values, it is
803
+ * recommended to set this to `'xy'` to allow hovering over all points.
804
+ *
805
+ * Applies only to series types using nearest neighbor search (not
806
+ * direct hover) for tooltip.
807
+ */
808
+ findNearestPointBy?: Highcharts.OptionsFindNearestPointByValue;
809
+ /**
810
+ * (Highcharts, Highstock) Defines when to display a gap in the graph,
811
+ * together with the gapUnit option.
812
+ *
813
+ * In case when `dataGrouping` is enabled, points can be grouped into a
814
+ * larger time span. This can make the grouped points to have a greater
815
+ * distance than the absolute value of `gapSize` property, which will
816
+ * result in disappearing graph completely. To prevent this situation
817
+ * the mentioned distance between grouped points is used instead of
818
+ * previously defined `gapSize`.
819
+ *
820
+ * In practice, this option is most often used to visualize gaps in time
821
+ * series. In a stock chart, intraday data is available for daytime
822
+ * hours, while gaps will appear in nights and weekends.
823
+ */
824
+ gapSize?: number;
825
+ /**
826
+ * (Highcharts, Highstock) Together with gapSize, this option defines
827
+ * where to draw gaps in the graph.
828
+ *
829
+ * When the `gapUnit` is `"relative"` (default), a gap size of 5 means
830
+ * that if the distance between two points is greater than 5 times that
831
+ * of the two closest points, the graph will be broken.
832
+ *
833
+ * When the `gapUnit` is `"value"`, the gap is based on absolute axis
834
+ * values, which on a datetime axis is milliseconds. This also applies
835
+ * to the navigator series that inherits gap options from the base
836
+ * series.
837
+ */
838
+ gapUnit?: Highcharts.OptionsGapUnitValue;
839
+ /**
840
+ * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the
841
+ * total chart width or only the zoomed area when zooming in on parts of
842
+ * the X axis. By default, the Y axis adjusts to the min and max of the
843
+ * visible data. Cartesian series only.
844
+ */
845
+ getExtremesFromAll?: boolean;
846
+ /**
847
+ * (Highcharts) Highlight only the hovered point and fade the remaining
848
+ * points.
849
+ *
850
+ * Scatter-type series require enabling the 'inactive' marker state and
851
+ * adjusting opacity. Note that this approach could affect performance
852
+ * with large datasets.
853
+ */
854
+ inactiveOtherPoints?: boolean;
855
+ /**
856
+ * (Highcharts) When set to `false` will prevent the series data from
857
+ * being included in any form of data export.
858
+ *
859
+ * Since version 6.0.0 until 7.1.0 the option was existing undocumented
860
+ * as `includeInCSVExport`.
861
+ */
862
+ includeInDataExport?: boolean;
863
+ /**
864
+ * (Highcharts, Highstock) Apply a jitter effect for the rendered
865
+ * markers. When plotting discrete values, a little random noise may
866
+ * help telling the points apart. The jitter setting applies a random
867
+ * displacement of up to `n` axis units in either direction. So for
868
+ * example on a horizontal X axis, setting the `jitter.x` to 0.24 will
869
+ * render the point in a random position between 0.24 units to the left
870
+ * and 0.24 units to the right of the true axis position. On a category
871
+ * axis, setting it to 0.5 will fill up the bin and make the data appear
872
+ * continuous.
873
+ *
874
+ * When rendered on top of a box plot or a column series, a jitter value
875
+ * of 0.24 will correspond to the underlying series' default
876
+ * groupPadding and pointPadding settings.
877
+ *
878
+ * **Note:** With boost mode enabled, the jitter effect is not
879
+ * supported.
880
+ */
881
+ jitter?: Highcharts.PlotScatter3dJitterOptions;
882
+ /**
883
+ * (Highcharts) An array specifying which option maps to which key in
884
+ * the data point array. This makes it convenient to work with
885
+ * unstructured data arrays from different sources.
886
+ */
887
+ keys?: Array<string>;
888
+ /**
889
+ * (Highcharts, Highstock, Gantt) Series labels are placed as close to
890
+ * the series as possible in a natural way, seeking to avoid other
891
+ * series. The goal of this feature is to make the chart more easily
892
+ * readable, like if a human designer placed the labels in the optimal
893
+ * position.
894
+ *
895
+ * The series labels currently work with series types having a `graph`
896
+ * or an `area`.
897
+ */
898
+ label?: Highcharts.SeriesLabelOptionsObject;
899
+ /**
900
+ * (Highcharts) What type of legend symbol to render for this series.
901
+ * Can be one of `areaMarker`, `lineMarker` or `rectangle`.
902
+ */
903
+ legendSymbol?: Highcharts.OptionsLegendSymbolValue;
904
+ /**
905
+ * (Highcharts) The line cap used for line ends and line joins on the
906
+ * graph.
907
+ */
908
+ linecap?: Highcharts.SeriesLinecapValue;
909
+ /**
910
+ * (Highcharts, Highstock) The width of the line connecting the data
911
+ * points.
912
+ */
913
+ lineWidth?: number;
914
+ /**
915
+ * (Highcharts, Highstock, Gantt) The id of another series to link to.
916
+ * Additionally, the value can be ":previous" to link to the previous
917
+ * series. When two series are linked, only the first one appears in the
918
+ * legend. Toggling the visibility of this also toggles the linked
919
+ * series.
920
+ *
921
+ * If master series uses data sorting and linked series does not have
922
+ * its own sorting definition, the linked series will be sorted in the
923
+ * same order as the master one.
924
+ *
925
+ * If a `compare` value is not set on a linked series, it will be
926
+ * inherited from the parent series.
927
+ */
928
+ linkedTo?: string;
929
+ /**
930
+ * (Highcharts) Options for the point markers of line and scatter-like
931
+ * series. Properties like `fillColor`, `lineColor` and `lineWidth`
932
+ * define the visual appearance of the markers. The `symbol` option
933
+ * defines the shape. Other series types, like column series, don't have
934
+ * markers, but have visual options on the series level instead.
935
+ *
936
+ * In styled mode, the markers can be styled with the
937
+ * `.highcharts-point`, `.highcharts-point-hover` and
938
+ * `.highcharts-point-select` class names.
939
+ */
940
+ marker?: Highcharts.PointMarkerOptionsObject;
941
+ /**
942
+ * (Highcharts) The color for the parts of the graph or points that are
943
+ * below the threshold. Note that `zones` takes precedence over the
944
+ * negative color. Using `negativeColor` is equivalent to applying a
945
+ * zone with value of 0.
946
+ */
947
+ negativeColor?: Highcharts.ColorType;
948
+ /**
949
+ * (Highcharts, Highstock) Whether or not data-points with the value of
950
+ * `null` should be interactive. When this is set to `true`, tooltips
951
+ * may highlight these points, and this option also enables keyboard
952
+ * navigation for such points. Format options for such points include
953
+ * `nullFormat` and `nullFormatter`. Works for these series: `line`,
954
+ * `spline`, `area`, `area-spline`, `column`, `bar`, and `timeline`.
955
+ */
956
+ nullInteraction?: (boolean|undefined);
957
+ /**
958
+ * (Highcharts) Options for the _Series on point_ feature. Only `pie`
959
+ * and `sunburst` series are supported at this moment.
960
+ */
961
+ onPoint?: (object|Highcharts.PlotScatter3dOnPointOptions);
962
+ /**
963
+ * (Highcharts) Opacity of a series parts: line, fill (e.g. area) and
964
+ * dataLabels.
965
+ */
966
+ opacity?: number;
967
+ /**
968
+ * (Highcharts) Properties for each single point.
969
+ */
970
+ point?: Highcharts.PlotSeriesPointOptions;
971
+ /**
972
+ * (Highcharts) Deprecated. Use
973
+ * series.accessibility.point.descriptionFormat instead.
974
+ *
975
+ * Same as accessibility.point.descriptionFormat, but for an individual
976
+ * series. Overrides the chart wide configuration.
977
+ *
978
+ * @deprecated 12.6.0
979
+ */
980
+ pointDescriptionFormat?: Function;
981
+ /**
982
+ * (Highcharts) Deprecated. Use
983
+ * series.accessibility.point.descriptionFormatter instead.
984
+ *
985
+ * Same as accessibility.series.descriptionFormatter, but for an
986
+ * individual series. Overrides the chart wide configuration.
987
+ *
988
+ * @deprecated 8.0.0
989
+ */
990
+ pointDescriptionFormatter?: Function;
991
+ /**
992
+ * (Highcharts, Highstock, Gantt) If no x values are given for the
993
+ * points in a series, `pointInterval` defines the interval of the x
994
+ * values. For example, if a series contains one value every decade
995
+ * starting from year 0, set `pointInterval` to `10`. In true `datetime`
996
+ * axes, the `pointInterval` is set in milliseconds.
997
+ *
998
+ * It can be also be combined with `pointIntervalUnit` to draw irregular
999
+ * time intervals.
1000
+ *
1001
+ * If combined with `relativeXValue`, an x value can be set on each
1002
+ * point, and the `pointInterval` is added x times to the `pointStart`
1003
+ * setting.
1004
+ *
1005
+ * Please note that this options applies to the _series data_, not the
1006
+ * interval of the axis ticks, which is independent.
1007
+ */
1008
+ pointInterval?: number;
1009
+ /**
1010
+ * (Highcharts, Highstock, Gantt) On datetime series, this allows for
1011
+ * setting the pointInterval to irregular time units, `day`, `month` and
1012
+ * `year`. A day is usually the same as 24 hours, but
1013
+ * `pointIntervalUnit` also takes the DST crossover into consideration
1014
+ * when dealing with local time. Combine this option with
1015
+ * `pointInterval` to draw weeks, quarters, 6 months, 10 years etc.
1016
+ *
1017
+ * Please note that this options applies to the _series data_, not the
1018
+ * interval of the axis ticks, which is independent.
1019
+ */
1020
+ pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue;
1021
+ /**
1022
+ * (Highcharts, Highstock, Gantt) If no x values are given for the
1023
+ * points in a series, `pointStart` defines on what value to start. For
1024
+ * example, if a series contains one yearly value starting from 1945,
1025
+ * set `pointStart` to 1945.
1026
+ *
1027
+ * The `pointStart` setting can be a number, or a datetime string that
1028
+ * is parsed according to the `time.timezone` setting.
1029
+ *
1030
+ * If combined with `relativeXValue`, an x value can be set on each
1031
+ * point. The x value from the point options is multiplied by
1032
+ * `pointInterval` and added to `pointStart` to produce a modified x
1033
+ * value.
1034
+ */
1035
+ pointStart?: (number|string);
1036
+ /**
1037
+ * (Highcharts, Highstock) When true, X values in the data set are
1038
+ * relative to the current `pointStart`, `pointInterval` and
1039
+ * `pointIntervalUnit` settings. This allows compression of the data for
1040
+ * datasets with irregular X values.
1041
+ *
1042
+ * The real X values are computed on the formula `f(x) = ax + b`, where
1043
+ * `a` is the `pointInterval` (optionally with a time unit given by
1044
+ * `pointIntervalUnit`), and `b` is the `pointStart`.
1045
+ */
1046
+ relativeXValue?: boolean;
1047
+ /**
1048
+ * (Highcharts) Whether to select the series initially. If
1049
+ * `showCheckbox` is true, the checkbox next to the series name in the
1050
+ * legend will be checked for a selected series.
1051
+ */
1052
+ selected?: boolean;
1053
+ /**
1054
+ * (Highcharts) If true, a checkbox is displayed next to the legend item
1055
+ * to allow selecting the series. The state of the checkbox is
1056
+ * determined by the `selected` option.
1057
+ */
1058
+ showCheckbox?: boolean;
1059
+ /**
1060
+ * (Highcharts) Whether to display this particular series or series type
1061
+ * in the legend. Standalone series are shown in legend by default, and
1062
+ * linked series are not. Since v7.2.0 it is possible to show series
1063
+ * that use colorAxis by setting this option to `true`.
1064
+ */
1065
+ showInLegend?: boolean;
1066
+ /**
1067
+ * (Highcharts) Deprecated. Use series.accessibility.keyboardNavigation
1068
+ * instead.
1069
+ *
1070
+ * If set to `true`, the accessibility module will skip past the points
1071
+ * in this series for keyboard navigation.
1072
+ *
1073
+ * @deprecated 8.0.0
1074
+ */
1075
+ skipKeyboardNavigation?: boolean;
1076
+ /**
1077
+ * (Highcharts, Highstock) When this is true, the series will not cause
1078
+ * the Y axis to cross the zero plane (or threshold option) unless the
1079
+ * data actually crosses the plane.
1080
+ *
1081
+ * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3
1082
+ * will make the Y axis show negative values according to the
1083
+ * `minPadding` option. If `softThreshold` is `true`, the Y axis starts
1084
+ * at 0.
1085
+ */
1086
+ softThreshold?: boolean;
1087
+ /**
1088
+ * (Highcharts) Sonification/audio chart options for a series.
1089
+ */
1090
+ sonification?: Highcharts.SeriesSonificationOptions;
1091
+ /**
1092
+ * (Highcharts, Highstock) Whether to stack the values of each series on
1093
+ * top of each other. Possible values are null to disable, `"normal"` to
1094
+ * stack by value or `"percent"`.
1095
+ *
1096
+ * When stacking is enabled, data must be sorted in ascending X order.
1097
+ *
1098
+ * Some stacking options are related to specific series types. In the
1099
+ * streamgraph series type, the stacking option is set to `"stream"`.
1100
+ * The second one is `"overlap"`, which only applies to waterfall
1101
+ * series.
1102
+ */
1103
+ stacking?: Highcharts.OptionsStackingValue;
1104
+ /**
1105
+ * (Highcharts) A collection of options for different series states.
1106
+ *
1107
+ * In addition to the options documented under each state, any option
1108
+ * from the parent series type can be set, with exception of `data` and
1109
+ * `states`.
1110
+ */
1111
+ states?: Highcharts.SeriesStatesOptionsObject;
1112
+ /**
1113
+ * (Highcharts, Highstock) Whether to apply steps to the line. Possible
1114
+ * values are `left`, `center` and `right`.
1115
+ */
1116
+ step?: Highcharts.OptionsStepValue;
1117
+ /**
1118
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events.
1119
+ * When true, the `mouseOut` event on a series isn't triggered until the
1120
+ * mouse moves over another series, or out of the plot area. When false,
1121
+ * the `mouseOut` event on a series is triggered when the mouse leaves
1122
+ * the area around the series' graph or markers. This also implies the
1123
+ * tooltip. When `stickyTracking` is false and `tooltip.shared` is
1124
+ * false, the tooltip will be hidden when moving the mouse between
1125
+ * series.
1126
+ */
1127
+ stickyTracking?: boolean;
1128
+ /**
1129
+ * (Highcharts, Highstock) The threshold, also called zero level or base
1130
+ * level. For line type series this is only used in conjunction with
1131
+ * negativeColor.
1132
+ */
1133
+ threshold?: (number|null);
1134
+ /**
1135
+ * (Highcharts, Highstock, Highmaps) A configuration object for the
1136
+ * tooltip rendering of each single series. Properties are inherited
1137
+ * from tooltip. Overridable properties are `headerFormat`,
1138
+ * `pointFormat`, `yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`.
1139
+ * Unlike other series, in a scatter plot the series.name by default
1140
+ * shows in the headerFormat and point.x and point.y in the pointFormat.
1141
+ */
1142
+ tooltip?: Highcharts.SeriesTooltipOptionsObject;
1143
+ /**
1144
+ * (Highcharts, Highstock, Gantt) When a series contains a `data` array
1145
+ * that is longer than this, the Series class looks for data
1146
+ * configurations of plain numbers or arrays of numbers. The first and
1147
+ * last valid points are checked. If found, the rest of the data is
1148
+ * assumed to be the same. This saves expensive data checking and
1149
+ * indexing in long series, and makes data-heavy charts render faster.
1150
+ *
1151
+ * Set it to `0` disable.
1152
+ *
1153
+ * Note:
1154
+ *
1155
+ * - In boost mode turbo threshold is forced. Only array of numbers or
1156
+ * two dimensional arrays are allowed.
1157
+ *
1158
+ * - In version 11.4.3 and earlier, if object configurations were passed
702
1159
  * beyond the turbo threshold, a warning was logged in the console and
703
1160
  * the data series didn't render.
704
1161
  */
705
- turboThreshold?: number;
1162
+ turboThreshold?: number;
1163
+ /**
1164
+ * (Highcharts) Set the initial visibility of the series.
1165
+ */
1166
+ visible?: boolean;
1167
+ /**
1168
+ * (Highcharts, Highstock) Defines the Axis on which the zones are
1169
+ * applied.
1170
+ */
1171
+ zoneAxis?: string;
1172
+ /**
1173
+ * (Highcharts, Highstock) An array defining zones within a series.
1174
+ * Zones can be applied to the X axis, Y axis or Z axis for bubbles,
1175
+ * according to the `zoneAxis` option. The zone definitions have to be
1176
+ * in ascending order regarding to the value.
1177
+ *
1178
+ * In styled mode, the color zones are styled with the
1179
+ * `.highcharts-zone-{n}` class, or custom classed from the `className`
1180
+ * option (view live demo).
1181
+ */
1182
+ zones?: Array<Highcharts.SeriesZonesOptionsObject>;
1183
+ /**
1184
+ * (Highcharts) Whether to zoom non-cartesian series. If `chart.zooming`
1185
+ * is set, the option allows to disable zooming on an individual
1186
+ * non-cartesian series. By default zooming is enabled for all series.
1187
+ *
1188
+ * **Note**: This option works only for non-cartesian series.
1189
+ */
1190
+ zoomEnabled?: boolean;
1191
+ }
1192
+ /**
1193
+ * (Highcharts, Highstock) Animation setting for hovering the graph in
1194
+ * line-type series.
1195
+ */
1196
+ interface PlotScatter3dStatesHoverAnimationOptions {
1197
+ /**
1198
+ * (Highcharts, Highstock) The duration of the hover animation in
1199
+ * milliseconds. By default the hover state animates quickly in, and
1200
+ * slowly back to normal.
1201
+ */
1202
+ duration?: number;
1203
+ }
1204
+ /**
1205
+ * (Highcharts, Highstock) Animation when not hovering over the marker.
1206
+ */
1207
+ interface PlotScatter3dStatesInactiveAnimationOptions {
1208
+ /**
1209
+ * (Highcharts, Highstock) The duration of the hover animation in
1210
+ * milliseconds. By default the hover state animates quickly in, and
1211
+ * slowly back to normal.
1212
+ */
1213
+ duration?: number;
1214
+ }
1215
+ /**
1216
+ * (Highcharts, Highstock) Animation setting for hovering the graph in
1217
+ * line-type series.
1218
+ */
1219
+ interface PlotScatter3dStatesSelectAnimationOptions {
1220
+ /**
1221
+ * (Highcharts, Highstock) The duration of the hover animation in
1222
+ * milliseconds. By default the hover state animates quickly in, and
1223
+ * slowly back to normal.
1224
+ */
1225
+ duration?: number;
1226
+ }
1227
+ /**
1228
+ * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
1229
+ * format in the tooltip's header will by default be guessed based on the
1230
+ * closest data points. This member gives the default string representations
1231
+ * used for each unit. For an overview of the string or object
1232
+ * configuration, see dateFormat.
1233
+ */
1234
+ interface PlotScatter3dTooltipDateTimeLabelFormatsOptions {
1235
+ day?: string;
1236
+ hour?: string;
1237
+ millisecond?: string;
1238
+ minute?: string;
1239
+ month?: string;
1240
+ second?: string;
1241
+ week?: string;
1242
+ year?: string;
1243
+ }
1244
+ /**
1245
+ * (Highcharts, Highstock, Highmaps) Options for the tooltip header when
1246
+ * tooltip.split is enabled. The header is the box containing the X value in
1247
+ * a split tooltip.
1248
+ */
1249
+ interface PlotScatter3dTooltipHeaderOptions {
1250
+ /**
1251
+ * (Highcharts, Highstock, Highmaps) Background color for the tooltip
1252
+ * header when tooltip.split is enabled.
1253
+ */
1254
+ backgroundColor?: Highcharts.ColorType;
1255
+ /**
1256
+ * (Highcharts, Highstock, Highmaps) Border color for the tooltip header
1257
+ * when tooltip.split is enabled.
1258
+ */
1259
+ borderColor?: Highcharts.ColorType;
1260
+ /**
1261
+ * (Highcharts, Highstock, Highmaps) The width of the border for the
1262
+ * tooltip header when tooltip.split is enabled.
1263
+ */
1264
+ borderWidth?: number;
1265
+ /**
1266
+ * (Highcharts, Highstock, Highmaps) Distance between the plot area and
1267
+ * the header (except the chevron) in a split tooltip, in pixels. The
1268
+ * default value makes the header text align with the axis labels.
1269
+ */
1270
+ distance?: number;
1271
+ /**
1272
+ * (Highcharts, Highstock, Highmaps) The name of a symbol to use for the
1273
+ * border around the tooltip header. Applies only when tooltip.split is
1274
+ * enabled.
1275
+ *
1276
+ * Custom callbacks for symbol path generation can also be added to
1277
+ * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
1278
+ * series.marker.symbol.
1279
+ */
1280
+ shape?: string;
1281
+ /**
1282
+ * (Highcharts, Highstock, Highmaps) CSS styles for the tooltip header.
1283
+ * The default is `{ fontSize: '1em' }`, ensuring that the header text
1284
+ * is the same size as the axis labels.
1285
+ */
1286
+ style?: object;
1287
+ }
1288
+ /**
1289
+ * (Highcharts, Highstock, Highmaps) Positioning options for fixed tooltip,
1290
+ * taking effect only when tooltip.fixed is `true`.
1291
+ */
1292
+ interface PlotScatter3dTooltipPositionOptions {
1293
+ /**
1294
+ * (Highcharts, Highstock, Highmaps) The horizontal alignment of the
1295
+ * fixed tooltip.
1296
+ */
1297
+ align?: Highcharts.AlignValue;
1298
+ /**
1299
+ * (Highcharts, Highstock, Highmaps) What the fixed tooltip alignment
1300
+ * should be relative to.
1301
+ *
1302
+ * The default, `pane`, means that it is aligned within the plot area
1303
+ * for that given series. If the tooltip is split (as default in Stock
1304
+ * charts), each partial tooltip is aligned within the series' pane.
1305
+ */
1306
+ relativeTo?: Highcharts.OptionsRelativeToValue;
1307
+ /**
1308
+ * (Highcharts, Highstock, Highmaps) The vertical alignment of the fixed
1309
+ * tooltip.
1310
+ */
1311
+ verticalAlign?: Highcharts.VerticalAlignValue;
1312
+ /**
1313
+ * (Highcharts, Highstock, Highmaps) X pixel offset from the given
1314
+ * position. Can be used to shy away from axis lines, grid lines etc to
1315
+ * avoid the tooltip overlapping other elements.
1316
+ */
1317
+ x?: number;
1318
+ /**
1319
+ * (Highcharts, Highstock, Highmaps) Y pixel offset from the given
1320
+ * position. Can be used to shy away from axis lines, grid lines etc to
1321
+ * avoid the tooltip overlapping other elements.
1322
+ */
1323
+ y?: number;
1324
+ }
1325
+ /**
1326
+ * (Highcharts, Highstock) Point accessibility options for a series.
1327
+ */
1328
+ interface PlotScatterAccessibilityPointOptions {
1329
+ /**
1330
+ * (Highcharts, Highstock) Date format to use for points on datetime
1331
+ * axes when describing them to screen reader users.
1332
+ *
1333
+ * Defaults to the same format as in tooltip.
1334
+ *
1335
+ * For an overview of the replacement codes, see dateFormat.
1336
+ */
1337
+ dateFormat?: string;
1338
+ /**
1339
+ * (Highcharts, Highstock) Formatter function to determine the date/time
1340
+ * format used with points on datetime axes when describing them to
1341
+ * screen reader users. Receives one argument, `point`, referring to the
1342
+ * point to describe. Should return a date format string compatible with
1343
+ * dateFormat.
1344
+ */
1345
+ dateFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
1346
+ /**
1347
+ * (Highcharts, Highstock) Whether or not to describe points with the
1348
+ * value `null` to assistive technology, such as screen readers.
1349
+ */
1350
+ describeNull?: boolean;
1351
+ /**
1352
+ * (Highcharts, Highstock) A format string to use instead of the default
1353
+ * for point descriptions.
1354
+ *
1355
+ * The context of the format string is the point instance.
1356
+ *
1357
+ * As opposed to accessibility.point.valueDescriptionFormat, this option
1358
+ * replaces the whole description.
1359
+ */
1360
+ descriptionFormat?: string;
1361
+ /**
1362
+ * (Highcharts, Highstock) Formatter function to use instead of the
1363
+ * default for point descriptions. Same as
1364
+ * `accessibility.point.descriptionFormatter`, but applies to a series
1365
+ * instead of the whole chart.
1366
+ *
1367
+ * Note: Prefer using accessibility.point.valueDescriptionFormat instead
1368
+ * if possible, as default functionality such as describing annotations
1369
+ * will be preserved.
1370
+ */
1371
+ descriptionFormatter?: Highcharts.ScreenReaderFormatterCallbackFunction<Highcharts.Point>;
1372
+ /**
1373
+ * (Highcharts, Highstock) Decimals to use for the values in the point
1374
+ * descriptions. Uses tooltip.valueDecimals if not defined.
1375
+ */
1376
+ valueDecimals?: number;
1377
+ /**
1378
+ * (Highcharts, Highstock) Format to use for describing the values of
1379
+ * data points to assistive technology - including screen readers. The
1380
+ * point context is available as `{point}`.
1381
+ *
1382
+ * Other available context variables include `{index}`, `{value}`, and
1383
+ * `{xDescription}`.
1384
+ *
1385
+ * Additionally, the series name, annotation info, and description added
1386
+ * in `point.accessibility.description` is added by default if relevant.
1387
+ * To override this, use the accessibility.point.descriptionFormatter
1388
+ * option.
1389
+ */
1390
+ valueDescriptionFormat?: string;
1391
+ /**
1392
+ * (Highcharts, Highstock) Prefix to add to the values in the point
1393
+ * descriptions. Uses tooltip.valuePrefix if not defined.
1394
+ */
1395
+ valuePrefix?: string;
1396
+ /**
1397
+ * (Highcharts, Highstock) Suffix to add to the values in the point
1398
+ * descriptions. Uses tooltip.valueSuffix if not defined.
1399
+ */
1400
+ valueSuffix?: string;
1401
+ }
1402
+ /**
1403
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
1404
+ * animation when a series is displayed for the `dataLabels`. The animation
1405
+ * can also be set as a configuration object. Please note that this option
1406
+ * only applies to the initial animation.
1407
+ *
1408
+ * For other animations, see chart.animation and the animation parameter
1409
+ * under the API methods. The following properties are supported:
1410
+ *
1411
+ * - `defer`: The animation delay time in milliseconds.
1412
+ */
1413
+ interface PlotScatterClusterDataLabelsAnimationOptions {
1414
+ /**
1415
+ * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
1416
+ * milliseconds. Set to `0` to render the data labels immediately. As
1417
+ * `undefined` inherits defer time from the series.animation.defer.
1418
+ */
1419
+ defer?: number;
1420
+ }
1421
+ /**
1422
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the cluster data
1423
+ * labels.
1424
+ */
1425
+ interface PlotScatterClusterDataLabelsOptions {
1426
+ /**
1427
+ * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data
1428
+ * label compared to the point. If `right`, the right side of the label
1429
+ * should be touching the point. For points with an extent, like
1430
+ * columns, the alignments also dictates how to align it inside the box,
1431
+ * as given with the inside option. Can be one of `left`, `center` or
1432
+ * `right`.
1433
+ */
1434
+ align?: string;
1435
+ /**
1436
+ * (Highcharts, Highstock, Highmaps, Gantt) Alignment method for data
1437
+ * labels. If set to `plotEdges`, the labels are aligned within the plot
1438
+ * area in the direction of the y-axis. So in a regular column chart,
1439
+ * the labels are aligned vertically according to the `verticalAlign`
1440
+ * setting. In a bar chart, which is inverted, the labels are aligned
1441
+ * horizontally according to the `align` setting. Applies to cartesian
1442
+ * series only.
1443
+ */
1444
+ alignTo?: string;
1445
+ /**
1446
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels
1447
+ * to overlap. To make the labels less sensitive for overlapping, the
1448
+ * dataLabels.padding can be set to 0.
1449
+ */
1450
+ allowOverlap?: boolean;
1451
+ /**
1452
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the
1453
+ * initial animation when a series is displayed for the `dataLabels`.
1454
+ * The animation can also be set as a configuration object. Please note
1455
+ * that this option only applies to the initial animation.
1456
+ *
1457
+ * For other animations, see chart.animation and the animation parameter
1458
+ * under the API methods. The following properties are supported:
1459
+ *
1460
+ * - `defer`: The animation delay time in milliseconds.
1461
+ */
1462
+ animation?: (boolean|Highcharts.PlotScatterClusterDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
1463
+ /**
1464
+ * (Highcharts, Highstock, Highmaps, Gantt) The background color or
1465
+ * gradient for the data label. In addition to regular colors, there are
1466
+ * two special setting for this option:
1467
+ *
1468
+ * - `auto` will set the background color the point's color.
1469
+ *
1470
+ * - `contrast` will set it to a contrast against the text color, with
1471
+ * an opacity allowing to see the underlying content. The contrast is
1472
+ * great enough to ensure readability for the text according to
1473
+ * accessibility standards.
1474
+ */
1475
+ backgroundColor?: Highcharts.ColorType;
1476
+ /**
1477
+ * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
1478
+ * data label. Setting it to `auto` will use the point's color. Defaults
1479
+ * to `undefined`.
1480
+ */
1481
+ borderColor?: Highcharts.ColorType;
1482
+ /**
1483
+ * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels
1484
+ * for the data label.
1485
+ */
1486
+ borderRadius?: number;
1487
+ /**
1488
+ * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels
1489
+ * for the data label.
1490
+ */
1491
+ borderWidth?: number;
1492
+ /**
1493
+ * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data
1494
+ * label. Particularly in styled mode, this can be used to give each
1495
+ * series' or point's data label unique styling. In addition to this
1496
+ * option, a default color class name is added so that we can give the
1497
+ * labels a contrast text shadow.
1498
+ */
1499
+ className?: string;
1500
+ /**
1501
+ * (Highcharts, Highstock, Highmaps, Gantt) This options is deprecated.
1502
+ * Use style.color instead.
1503
+ *
1504
+ * The text color for the data labels. Defaults to `undefined`. For
1505
+ * certain series types, like column or map, the data labels can be
1506
+ * drawn inside the points. In this case the data label will be drawn
1507
+ * with maximum contrast by default. Additionally, it will be given a
1508
+ * `text-outline` style with the opposite color, to further increase the
1509
+ * contrast. This can be overridden by setting the `text-outline` style
1510
+ * to `none` in the `dataLabels.style` option.
1511
+ *
1512
+ * @deprecated 10.3.0
1513
+ */
1514
+ color?: Highcharts.ColorType;
1515
+ /**
1516
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels
1517
+ * that are outside the plot area. By default, the data label is moved
1518
+ * inside the plot area according to the overflow option.
1519
+ */
1520
+ crop?: boolean;
1521
+ /**
1522
+ * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
1523
+ * labels until the initial series animation has finished. Setting to
1524
+ * `false` renders the data label immediately. If set to `true` inherits
1525
+ * the defer time set in plotOptions.series.animation.
1526
+ */
1527
+ defer?: boolean;
1528
+ /**
1529
+ * (Highcharts, Highstock, Gantt) The distance of the data label from
1530
+ * the data point. Note that the `padding` setting also affects the
1531
+ * rendered distance, but is not visible unless the data label has a
1532
+ * border or background.
1533
+ */
1534
+ distance?: number;
1535
+ /**
1536
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
1537
+ * labels.
1538
+ */
1539
+ enabled?: boolean;
1540
+ /**
1541
+ * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to
1542
+ * control of which data labels to display. The declarative filter is
1543
+ * designed for use when callback functions are not available, like when
1544
+ * the chart options require a pure JSON structure or for use with
1545
+ * graphical editors. For programmatic control, use the `formatter`
1546
+ * instead, and return `undefined` to disable a single data label. (see
1547
+ * online documentation for example)
1548
+ */
1549
+ filter?: Highcharts.DataLabelsFilterOptionsObject;
1550
+ /**
1551
+ * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
1552
+ * label. Available variables are the same as for `formatter`.
1553
+ */
1554
+ format?: string;
1555
+ /**
1556
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
1557
+ * to format the data label. Note that if a `format` is defined, the
1558
+ * format takes precedence and the formatter is ignored.
1559
+ */
1560
+ formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
1561
+ /**
1562
+ * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent,
1563
+ * like columns or map areas, whether to align the data label inside the
1564
+ * box or to the actual value point. Defaults to `false` in most cases,
1565
+ * `true` in stacked columns.
1566
+ */
1567
+ inside?: boolean;
1568
+ /**
1569
+ * (Highcharts, Highstock, Highmaps, Gantt) The rank for this point's
1570
+ * data label in case of collision. If two data labels are about to
1571
+ * overlap, only the one with the highest `labelrank` will be drawn.
1572
+ */
1573
+ labelrank?: number;
1574
+ /**
1575
+ * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the
1576
+ * value of null. Works analogously to format. `nullFormat` can be
1577
+ * applied only to series which support displaying null points.
1578
+ * `heatmap` and `tilemap` supports `nullFormat` by default while the
1579
+ * following series requires [#series.nullInteraction] set to `true`:
1580
+ * `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
1581
+ * `timeline`. Does not work with series that don't display null points,
1582
+ * like `pie`.
1583
+ */
1584
+ nullFormat?: (boolean|string);
1585
+ /**
1586
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
1587
+ * that defines formatting for points with the value of null. Works
1588
+ * analogously to formatter. `nullFormatter` can be applied only to
1589
+ * series which support displaying null points. `heatmap` and `tilemap`
1590
+ * supports `nullFormatter` by default while the following series
1591
+ * requires (series.nullInteraction)[#series.nullInteraction] set to
1592
+ * `true`: `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
1593
+ * `timeline`. Does not work with series that don't display null points,
1594
+ * like `pie`.
1595
+ */
1596
+ nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
1597
+ /**
1598
+ * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels
1599
+ * that flow outside the plot area. The default is `"justify"`, which
1600
+ * aligns them inside the plot area. For columns and bars, this means it
1601
+ * will be moved inside the bar. To display data labels outside the plot
1602
+ * area, set `crop` to `false` and `overflow` to `"allow"`.
1603
+ */
1604
+ overflow?: Highcharts.DataLabelsOverflowValue;
1605
+ /**
1606
+ * (Highcharts, Highstock, Highmaps, Gantt) When either the
1607
+ * `borderWidth` or the `backgroundColor` is set, this is the padding
1608
+ * within the box.
1609
+ *
1610
+ * An array of numbers sets padding for the respective sides. An array
1611
+ * of two numbers repeats the values for the horizontal and vertical
1612
+ * sides.
1613
+ */
1614
+ padding?: (number|Array<number>);
1615
+ /**
1616
+ * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
1617
+ * to points. If `center` alignment is not possible, it defaults to
1618
+ * `right`.
1619
+ */
1620
+ position?: Highcharts.AlignValue;
1621
+ /**
1622
+ * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees.
1623
+ * Note that due to a more complex structure, backgrounds, borders and
1624
+ * padding will be lost on a rotated data label.
1625
+ */
1626
+ rotation?: number;
1627
+ /**
1628
+ * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
1629
+ * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow
1630
+ * can be an object configuration containing `color`, `offsetX`,
1631
+ * `offsetY`, `opacity` and `width`.
1632
+ */
1633
+ shadow?: (boolean|Highcharts.ShadowOptionsObject);
1634
+ /**
1635
+ * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use
1636
+ * for the border around the label. Symbols are predefined functions on
1637
+ * the Renderer object.
1638
+ */
1639
+ shape?: string;
1640
+ /**
1641
+ * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
1642
+ * default `color` setting is `"contrast"`, which is a pseudo color that
1643
+ * Highcharts picks up and applies the maximum contrast to the
1644
+ * underlying point item, for example the bar in a bar chart.
1645
+ *
1646
+ * The `textOutline` is a pseudo property that applies an outline of the
1647
+ * given width with the given color, which by default is the maximum
1648
+ * contrast to the text. So a bright text color will result in a black
1649
+ * text outline for maximum readability on a mixed background. In some
1650
+ * cases, especially with grayscale text, the text outline doesn't work
1651
+ * well, in which cases it can be disabled by setting it to `"none"`.
1652
+ * When `useHTML` is true, the `textOutline` will not be picked up. In
1653
+ * this, case, the same effect can be achieved through the `text-shadow`
1654
+ * CSS property. As a complementary or alternative to the `textOutline`,
1655
+ * a `dataLabels.backgroundColor` can be used. It provides a more calm
1656
+ * impression and ensures readable text label, at the cost of a risk of
1657
+ * overshadowing the underlying chart elements.
1658
+ *
1659
+ * For some series types, where each point has an extent, like for
1660
+ * example tree maps, the data label may overflow the point. There are
1661
+ * two strategies for handling overflow. By default, the text will wrap
1662
+ * to multiple lines. The other strategy is to set `style.textOverflow`
1663
+ * to `ellipsis`, which will keep the text on one line plus it will
1664
+ * break inside long words.
1665
+ */
1666
+ style?: (Highcharts.CSSObject|Highcharts.PlotScatterClusterDataLabelsStyleOptions);
1667
+ /**
1668
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text
1669
+ * which should follow marker's shape. Border and background are
1670
+ * disabled for a label that follows a path.
1671
+ *
1672
+ * **Note:** Only SVG-based renderer supports this option. Setting
1673
+ * `useHTML` to true will disable this option.
1674
+ *
1675
+ * Text path support is not bundled into `highcharts.js`, and requires
1676
+ * the `modules/textpath.js` file. However, it is included in the script
1677
+ * files of those series types that use it by default.
1678
+ */
1679
+ textPath?: Highcharts.DataLabelsTextPathOptionsObject;
1680
+ /**
1681
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to
1682
+ * render the labels.
1683
+ */
1684
+ useHTML?: boolean;
1685
+ /**
1686
+ * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a
1687
+ * data label. Can be one of `top`, `middle` or `bottom`. The default
1688
+ * value depends on the data, for instance in a column chart, the label
1689
+ * is above positive values and below negative values.
1690
+ */
1691
+ verticalAlign?: string;
1692
+ /**
1693
+ * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
1694
+ * label relative to the point in pixels.
1695
+ */
1696
+ x?: number;
1697
+ /**
1698
+ * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
1699
+ * label relative to the point in pixels.
1700
+ */
1701
+ y?: number;
1702
+ /**
1703
+ * (Highcharts, Highstock, Highmaps, Gantt) The z index of the data
1704
+ * labels group. Does not apply below series level options.
1705
+ *
1706
+ * Use a `zIndex` of 6 to display it above the series, or use a `zIndex`
1707
+ * of 2 to display it behind the series.
1708
+ */
1709
+ zIndex?: number;
1710
+ }
1711
+ /**
1712
+ * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
1713
+ * default `color` setting is `"contrast"`, which is a pseudo color that
1714
+ * Highcharts picks up and applies the maximum contrast to the underlying
1715
+ * point item, for example the bar in a bar chart.
1716
+ *
1717
+ * The `textOutline` is a pseudo property that applies an outline of the
1718
+ * given width with the given color, which by default is the maximum
1719
+ * contrast to the text. So a bright text color will result in a black text
1720
+ * outline for maximum readability on a mixed background. In some cases,
1721
+ * especially with grayscale text, the text outline doesn't work well, in
1722
+ * which cases it can be disabled by setting it to `"none"`. When `useHTML`
1723
+ * is true, the `textOutline` will not be picked up. In this, case, the same
1724
+ * effect can be achieved through the `text-shadow` CSS property. As a
1725
+ * complementary or alternative to the `textOutline`, a
1726
+ * `dataLabels.backgroundColor` can be used. It provides a more calm
1727
+ * impression and ensures readable text label, at the cost of a risk of
1728
+ * overshadowing the underlying chart elements.
1729
+ *
1730
+ * For some series types, where each point has an extent, like for example
1731
+ * tree maps, the data label may overflow the point. There are two
1732
+ * strategies for handling overflow. By default, the text will wrap to
1733
+ * multiple lines. The other strategy is to set `style.textOverflow` to
1734
+ * `ellipsis`, which will keep the text on one line plus it will break
1735
+ * inside long words.
1736
+ */
1737
+ interface PlotScatterClusterDataLabelsStyleOptions {
1738
+ color?: string;
1739
+ }
1740
+ interface PlotScatterClusterEventsOptions {
1741
+ /**
1742
+ * (Highcharts, Highmaps) Fires when the cluster point is clicked and
1743
+ * `drillToCluster` is enabled. One parameter, `event`, is passed to the
1744
+ * function. The default action is to zoom to the cluster points range.
1745
+ * This can be prevented by calling `event.preventDefault()`.
1746
+ */
1747
+ drillToCluster?: Highcharts.MarkerClusterDrillCallbackFunction;
1748
+ }
1749
+ /**
1750
+ * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
1751
+ * options to change the type of the algorithm, gridSize, distance or
1752
+ * iterations.
1753
+ */
1754
+ interface PlotScatterClusterLayoutAlgorithmOptions {
1755
+ /**
1756
+ * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is
1757
+ * a maximum distance between point and cluster center so that this
1758
+ * point will be inside the cluster. The distance is either a number
1759
+ * defining pixels or a percentage defining a percentage of the plot
1760
+ * area width.
1761
+ */
1762
+ distance?: (number|string);
1763
+ /**
1764
+ * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize`
1765
+ * is a size of a grid square element either as a number defining
1766
+ * pixels, or a percentage defining a percentage of the plot area width.
1767
+ */
1768
+ gridSize?: (number|string);
1769
+ /**
1770
+ * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations`
1771
+ * are the number of iterations that this algorithm will be repeated to
1772
+ * find clusters positions.
1773
+ */
1774
+ iterations?: number;
1775
+ /**
1776
+ * (Highcharts, Highmaps) When `type` is set to `undefined` and there
1777
+ * are more visible points than the kmeansThreshold the `grid` algorithm
1778
+ * is used to find clusters, otherwise `kmeans`. It ensures good
1779
+ * performance on large datasets and better clusters arrangement after
1780
+ * the zoom.
1781
+ */
1782
+ kmeansThreshold?: number;
1783
+ /**
1784
+ * (Highcharts, Highmaps) Type of the algorithm used to combine points
1785
+ * into a cluster. There are three available algorithms:
1786
+ *
1787
+ * 1) `grid` - grid-based clustering technique. Points are assigned to
1788
+ * squares of set size depending on their position on the plot area.
1789
+ * Points inside the grid square are combined into a cluster. The grid
1790
+ * size can be controlled by `gridSize` property (grid size changes at
1791
+ * certain zoom levels).
1792
+ *
1793
+ * 2) `kmeans` - based on K-Means clustering technique. In the first
1794
+ * step, points are divided using the grid method (distance property is
1795
+ * a grid size) to find the initial amount of clusters. Next, each point
1796
+ * is classified by computing the distance between each cluster center
1797
+ * and that point. When the closest cluster distance is lower than
1798
+ * distance property set by a user the point is added to this cluster
1799
+ * otherwise is classified as `noise`. The algorithm is repeated until
1800
+ * each cluster center not change its previous position more than one
1801
+ * pixel. This technique is more accurate but also more time consuming
1802
+ * than the `grid` algorithm, especially for big datasets.
1803
+ *
1804
+ * 3) `optimizedKmeans` - based on K-Means clustering technique. This
1805
+ * algorithm uses k-means algorithm only on the chart initialization or
1806
+ * when chart extremes have greater range than on initialization. When a
1807
+ * chart is redrawn the algorithm checks only clustered points distance
1808
+ * from the cluster center and rebuild it when the point is spaced
1809
+ * enough to be outside the cluster. It provides performance improvement
1810
+ * and more stable clusters position yet can be used rather on small and
1811
+ * sparse datasets.
1812
+ *
1813
+ * By default, the algorithm depends on visible quantity of points and
1814
+ * `kmeansThreshold`. When there are more visible points than the
1815
+ * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
1816
+ *
1817
+ * The custom clustering algorithm can be added by assigning a callback
1818
+ * function as the type property. This function takes an array of
1819
+ * `processedXData`, `processedYData`, `processedXData` indexes and
1820
+ * `layoutAlgorithm` options as arguments and should return an object
1821
+ * with grouped data.
1822
+ *
1823
+ * The algorithm should return an object like that: (see online
1824
+ * documentation for example)
1825
+ *
1826
+ * `clusterId` (example above - unique id of a cluster or noise) is an
1827
+ * array of points belonging to a cluster. If the array has only one
1828
+ * point or fewer points than set in `cluster.minimumClusterSize` it
1829
+ * won't be combined into a cluster.
1830
+ */
1831
+ type?: (string|Function);
1832
+ }
1833
+ /**
1834
+ * (Highcharts, Highmaps) Options for marker clusters, the concept of
1835
+ * sampling the data values into larger blocks in order to ease readability
1836
+ * and increase performance of the JavaScript charts.
1837
+ *
1838
+ * Note: marker clusters module is not working with `boost` and
1839
+ * `draggable-points` modules.
1840
+ *
1841
+ * The marker clusters feature requires the marker-clusters.js file to be
1842
+ * loaded, found in the modules directory of the download package, or online
1843
+ * at code.highcharts.com/modules/marker-clusters.js.
1844
+ */
1845
+ interface PlotScatterClusterOptions {
1846
+ /**
1847
+ * (Highcharts, Highmaps) When set to `false` prevent cluster
1848
+ * overlapping - this option works only when `layoutAlgorithm.type =
1849
+ * "grid"`.
1850
+ */
1851
+ allowOverlap?: boolean;
1852
+ /**
1853
+ * (Highcharts, Highmaps) Options for the cluster marker animation.
1854
+ */
1855
+ animation?: (boolean|Partial<Highcharts.AnimationOptionsObject>);
1856
+ /**
1857
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the cluster data
1858
+ * labels.
1859
+ */
1860
+ dataLabels?: (Highcharts.DataLabelsOptions|Highcharts.PlotScatterClusterDataLabelsOptions);
1861
+ /**
1862
+ * (Highcharts, Highmaps) Zoom the plot area to the cluster points range
1863
+ * when a cluster is clicked.
1864
+ */
1865
+ drillToCluster?: boolean;
1866
+ /**
1867
+ * (Highcharts, Highmaps) Whether to enable the marker-clusters module.
1868
+ */
1869
+ enabled?: boolean;
1870
+ events?: Highcharts.PlotScatterClusterEventsOptions;
1871
+ /**
1872
+ * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
1873
+ * options to change the type of the algorithm, gridSize, distance or
1874
+ * iterations.
1875
+ */
1876
+ layoutAlgorithm?: Highcharts.PlotScatterClusterLayoutAlgorithmOptions;
1877
+ /**
1878
+ * (Highcharts, Highmaps) Options for the cluster marker.
1879
+ */
1880
+ marker?: Highcharts.PointMarkerOptionsObject;
1881
+ /**
1882
+ * (Highcharts, Highmaps) The minimum amount of points to be combined
1883
+ * into a cluster. This value has to be greater or equal to 2.
1884
+ */
1885
+ minimumClusterSize?: number;
1886
+ states?: Highcharts.PlotScatterClusterStatesOptions;
1887
+ /**
1888
+ * (Highcharts, Highmaps) An array defining zones within marker
1889
+ * clusters.
1890
+ *
1891
+ * In styled mode, the color zones are styled with the
1892
+ * `.highcharts-cluster-zone-{n}` class, or custom classed from the
1893
+ * `className` option.
1894
+ */
1895
+ zones?: Array<Highcharts.PlotScatterClusterZonesOptions>;
1896
+ }
1897
+ interface PlotScatterClusterStatesHoverOptions {
1898
+ /**
1899
+ * (Highcharts, Highmaps) The fill color of the cluster marker in hover
1900
+ * state. When `undefined`, the series' or point's fillColor for normal
1901
+ * state is used.
1902
+ */
1903
+ fillColor?: Highcharts.ColorType;
1904
+ }
1905
+ interface PlotScatterClusterStatesOptions {
1906
+ hover?: Highcharts.PlotScatterClusterStatesHoverOptions;
1907
+ }
1908
+ /**
1909
+ * (Highcharts, Highmaps) An array defining zones within marker clusters.
1910
+ *
1911
+ * In styled mode, the color zones are styled with the
1912
+ * `.highcharts-cluster-zone-{n}` class, or custom classed from the
1913
+ * `className` option.
1914
+ */
1915
+ interface PlotScatterClusterZonesOptions {
1916
+ /**
1917
+ * (Highcharts, Highmaps) Styled mode only. A custom class name for the
1918
+ * zone.
1919
+ */
1920
+ className?: string;
1921
+ /**
1922
+ * (Highcharts, Highmaps) The value where the zone starts.
1923
+ */
1924
+ from?: number;
1925
+ /**
1926
+ * (Highcharts, Highmaps) Settings for the cluster marker belonging to
1927
+ * the zone.
1928
+ */
1929
+ marker?: Highcharts.PointMarkerOptionsObject;
1930
+ /**
1931
+ * (Highcharts, Highmaps) The value where the zone ends.
1932
+ */
1933
+ to?: number;
1934
+ }
1935
+ /**
1936
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
1937
+ * animation when a series is displayed for the `dataLabels`. The animation
1938
+ * can also be set as a configuration object. Please note that this option
1939
+ * only applies to the initial animation.
1940
+ *
1941
+ * For other animations, see chart.animation and the animation parameter
1942
+ * under the API methods. The following properties are supported:
1943
+ *
1944
+ * - `defer`: The animation delay time in milliseconds.
1945
+ */
1946
+ interface PlotScatterDataLabelsAnimationOptions {
1947
+ /**
1948
+ * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
1949
+ * milliseconds. Set to `0` to render the data labels immediately. As
1950
+ * `undefined` inherits defer time from the series.animation.defer.
1951
+ */
1952
+ defer?: number;
1953
+ }
1954
+ /**
1955
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
1956
+ * labels, appearing next to each data point.
1957
+ *
1958
+ * Since v6.2.0, multiple data labels can be applied to each single point by
1959
+ * defining them as an array of configs.
1960
+ *
1961
+ * In styled mode, the data labels can be styled with the
1962
+ * `.highcharts-data-label-box` and `.highcharts-data-label` class names
1963
+ * (see example).
1964
+ */
1965
+ interface PlotScatterDataLabelsOptions {
1966
+ /**
1967
+ * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data
1968
+ * label compared to the point. If `right`, the right side of the label
1969
+ * should be touching the point. For points with an extent, like
1970
+ * columns, the alignments also dictates how to align it inside the box,
1971
+ * as given with the inside option. Can be one of `left`, `center` or
1972
+ * `right`.
1973
+ */
1974
+ align?: (Highcharts.AlignValue|null);
1975
+ /**
1976
+ * (Highcharts, Highstock, Highmaps, Gantt) Alignment method for data
1977
+ * labels. If set to `plotEdges`, the labels are aligned within the plot
1978
+ * area in the direction of the y-axis. So in a regular column chart,
1979
+ * the labels are aligned vertically according to the `verticalAlign`
1980
+ * setting. In a bar chart, which is inverted, the labels are aligned
1981
+ * horizontally according to the `align` setting. Applies to cartesian
1982
+ * series only.
1983
+ */
1984
+ alignTo?: string;
1985
+ /**
1986
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels
1987
+ * to overlap. To make the labels less sensitive for overlapping, the
1988
+ * dataLabels.padding can be set to 0.
1989
+ */
1990
+ allowOverlap?: boolean;
1991
+ /**
1992
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the
1993
+ * initial animation when a series is displayed for the `dataLabels`.
1994
+ * The animation can also be set as a configuration object. Please note
1995
+ * that this option only applies to the initial animation.
1996
+ *
1997
+ * For other animations, see chart.animation and the animation parameter
1998
+ * under the API methods. The following properties are supported:
1999
+ *
2000
+ * - `defer`: The animation delay time in milliseconds.
2001
+ */
2002
+ animation?: (boolean|Highcharts.PlotScatterDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
2003
+ /**
2004
+ * (Highcharts, Highstock, Highmaps, Gantt) The background color or
2005
+ * gradient for the data label. In addition to regular colors, there are
2006
+ * two special setting for this option:
2007
+ *
2008
+ * - `auto` will set the background color the point's color.
2009
+ *
2010
+ * - `contrast` will set it to a contrast against the text color, with
2011
+ * an opacity allowing to see the underlying content. The contrast is
2012
+ * great enough to ensure readability for the text according to
2013
+ * accessibility standards.
2014
+ */
2015
+ backgroundColor?: Highcharts.ColorType;
2016
+ /**
2017
+ * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
2018
+ * data label. Setting it to `auto` will use the point's color. Defaults
2019
+ * to `undefined`.
2020
+ */
2021
+ borderColor?: Highcharts.ColorType;
2022
+ /**
2023
+ * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels
2024
+ * for the data label.
2025
+ */
2026
+ borderRadius?: number;
2027
+ /**
2028
+ * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels
2029
+ * for the data label.
2030
+ */
2031
+ borderWidth?: number;
2032
+ /**
2033
+ * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data
2034
+ * label. Particularly in styled mode, this can be used to give each
2035
+ * series' or point's data label unique styling. In addition to this
2036
+ * option, a default color class name is added so that we can give the
2037
+ * labels a contrast text shadow.
2038
+ */
2039
+ className?: string;
2040
+ /**
2041
+ * (Highcharts, Highstock, Highmaps, Gantt) This options is deprecated.
2042
+ * Use style.color instead.
2043
+ *
2044
+ * The text color for the data labels. Defaults to `undefined`. For
2045
+ * certain series types, like column or map, the data labels can be
2046
+ * drawn inside the points. In this case the data label will be drawn
2047
+ * with maximum contrast by default. Additionally, it will be given a
2048
+ * `text-outline` style with the opposite color, to further increase the
2049
+ * contrast. This can be overridden by setting the `text-outline` style
2050
+ * to `none` in the `dataLabels.style` option.
2051
+ *
2052
+ * @deprecated 10.3.0
2053
+ */
2054
+ color?: Highcharts.ColorType;
2055
+ /**
2056
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels
2057
+ * that are outside the plot area. By default, the data label is moved
2058
+ * inside the plot area according to the overflow option.
2059
+ */
2060
+ crop?: boolean;
2061
+ /**
2062
+ * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
2063
+ * labels until the initial series animation has finished. Setting to
2064
+ * `false` renders the data label immediately. If set to `true` inherits
2065
+ * the defer time set in plotOptions.series.animation.
2066
+ */
2067
+ defer?: boolean;
2068
+ /**
2069
+ * (Highcharts, Highstock, Gantt) The distance of the data label from
2070
+ * the data point. Note that the `padding` setting also affects the
2071
+ * rendered distance, but is not visible unless the data label has a
2072
+ * border or background.
2073
+ */
2074
+ distance?: number;
2075
+ /**
2076
+ * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
2077
+ * labels.
2078
+ */
2079
+ enabled?: boolean;
2080
+ /**
2081
+ * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to
2082
+ * control of which data labels to display. The declarative filter is
2083
+ * designed for use when callback functions are not available, like when
2084
+ * the chart options require a pure JSON structure or for use with
2085
+ * graphical editors. For programmatic control, use the `formatter`
2086
+ * instead, and return `undefined` to disable a single data label. (see
2087
+ * online documentation for example)
2088
+ */
2089
+ filter?: Highcharts.DataLabelsFilterOptionsObject;
2090
+ /**
2091
+ * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
2092
+ * label. Available variables are the same as for `formatter`.
2093
+ */
2094
+ format?: string;
2095
+ /**
2096
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
2097
+ * to format the data label. Note that if a `format` is defined, the
2098
+ * format takes precedence and the formatter is ignored.
2099
+ */
2100
+ formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
2101
+ /**
2102
+ * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent,
2103
+ * like columns or map areas, whether to align the data label inside the
2104
+ * box or to the actual value point. Defaults to `false` in most cases,
2105
+ * `true` in stacked columns.
2106
+ */
2107
+ inside?: boolean;
2108
+ /**
2109
+ * (Highcharts, Highstock, Highmaps, Gantt) The rank for this point's
2110
+ * data label in case of collision. If two data labels are about to
2111
+ * overlap, only the one with the highest `labelrank` will be drawn.
2112
+ */
2113
+ labelrank?: number;
2114
+ /**
2115
+ * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the
2116
+ * value of null. Works analogously to format. `nullFormat` can be
2117
+ * applied only to series which support displaying null points.
2118
+ * `heatmap` and `tilemap` supports `nullFormat` by default while the
2119
+ * following series requires [#series.nullInteraction] set to `true`:
2120
+ * `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
2121
+ * `timeline`. Does not work with series that don't display null points,
2122
+ * like `pie`.
2123
+ */
2124
+ nullFormat?: (boolean|string);
2125
+ /**
2126
+ * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
2127
+ * that defines formatting for points with the value of null. Works
2128
+ * analogously to formatter. `nullFormatter` can be applied only to
2129
+ * series which support displaying null points. `heatmap` and `tilemap`
2130
+ * supports `nullFormatter` by default while the following series
2131
+ * requires (series.nullInteraction)[#series.nullInteraction] set to
2132
+ * `true`: `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
2133
+ * `timeline`. Does not work with series that don't display null points,
2134
+ * like `pie`.
2135
+ */
2136
+ nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
2137
+ /**
2138
+ * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels
2139
+ * that flow outside the plot area. The default is `"justify"`, which
2140
+ * aligns them inside the plot area. For columns and bars, this means it
2141
+ * will be moved inside the bar. To display data labels outside the plot
2142
+ * area, set `crop` to `false` and `overflow` to `"allow"`.
2143
+ */
2144
+ overflow?: Highcharts.DataLabelsOverflowValue;
2145
+ /**
2146
+ * (Highcharts, Highstock, Highmaps, Gantt) When either the
2147
+ * `borderWidth` or the `backgroundColor` is set, this is the padding
2148
+ * within the box.
2149
+ *
2150
+ * An array of numbers sets padding for the respective sides. An array
2151
+ * of two numbers repeats the values for the horizontal and vertical
2152
+ * sides.
2153
+ */
2154
+ padding?: (number|Array<number>);
2155
+ /**
2156
+ * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
2157
+ * to points. If `center` alignment is not possible, it defaults to
2158
+ * `right`.
2159
+ */
2160
+ position?: Highcharts.AlignValue;
2161
+ /**
2162
+ * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees.
2163
+ * Note that due to a more complex structure, backgrounds, borders and
2164
+ * padding will be lost on a rotated data label.
2165
+ */
2166
+ rotation?: number;
2167
+ /**
2168
+ * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
2169
+ * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow
2170
+ * can be an object configuration containing `color`, `offsetX`,
2171
+ * `offsetY`, `opacity` and `width`.
2172
+ */
2173
+ shadow?: (boolean|Highcharts.ShadowOptionsObject);
2174
+ /**
2175
+ * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use
2176
+ * for the border around the label. Symbols are predefined functions on
2177
+ * the Renderer object.
2178
+ */
2179
+ shape?: string;
2180
+ /**
2181
+ * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
2182
+ * default `color` setting is `"contrast"`, which is a pseudo color that
2183
+ * Highcharts picks up and applies the maximum contrast to the
2184
+ * underlying point item, for example the bar in a bar chart.
2185
+ *
2186
+ * The `textOutline` is a pseudo property that applies an outline of the
2187
+ * given width with the given color, which by default is the maximum
2188
+ * contrast to the text. So a bright text color will result in a black
2189
+ * text outline for maximum readability on a mixed background. In some
2190
+ * cases, especially with grayscale text, the text outline doesn't work
2191
+ * well, in which cases it can be disabled by setting it to `"none"`.
2192
+ * When `useHTML` is true, the `textOutline` will not be picked up. In
2193
+ * this, case, the same effect can be achieved through the `text-shadow`
2194
+ * CSS property. As a complementary or alternative to the `textOutline`,
2195
+ * a `dataLabels.backgroundColor` can be used. It provides a more calm
2196
+ * impression and ensures readable text label, at the cost of a risk of
2197
+ * overshadowing the underlying chart elements.
2198
+ *
2199
+ * For some series types, where each point has an extent, like for
2200
+ * example tree maps, the data label may overflow the point. There are
2201
+ * two strategies for handling overflow. By default, the text will wrap
2202
+ * to multiple lines. The other strategy is to set `style.textOverflow`
2203
+ * to `ellipsis`, which will keep the text on one line plus it will
2204
+ * break inside long words.
2205
+ */
2206
+ style?: Highcharts.CSSObject;
2207
+ /**
2208
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text
2209
+ * which should follow marker's shape. Border and background are
2210
+ * disabled for a label that follows a path.
2211
+ *
2212
+ * **Note:** Only SVG-based renderer supports this option. Setting
2213
+ * `useHTML` to true will disable this option.
2214
+ *
2215
+ * Text path support is not bundled into `highcharts.js`, and requires
2216
+ * the `modules/textpath.js` file. However, it is included in the script
2217
+ * files of those series types that use it by default.
2218
+ */
2219
+ textPath?: Highcharts.DataLabelsTextPathOptionsObject;
2220
+ /**
2221
+ * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to
2222
+ * render the labels.
2223
+ */
2224
+ useHTML?: boolean;
2225
+ /**
2226
+ * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a
2227
+ * data label. Can be one of `top`, `middle` or `bottom`. The default
2228
+ * value depends on the data, for instance in a column chart, the label
2229
+ * is above positive values and below negative values.
2230
+ */
2231
+ verticalAlign?: (Highcharts.VerticalAlignValue|null);
2232
+ /**
2233
+ * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
2234
+ * label relative to the point in pixels.
2235
+ */
2236
+ x?: number;
2237
+ /**
2238
+ * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
2239
+ * label relative to the point in pixels.
2240
+ */
2241
+ y?: number;
2242
+ /**
2243
+ * (Highcharts, Highstock, Highmaps, Gantt) The z index of the data
2244
+ * labels group. Does not apply below series level options.
2245
+ *
2246
+ * Use a `zIndex` of 6 to display it above the series, or use a `zIndex`
2247
+ * of 2 to display it behind the series.
2248
+ */
2249
+ zIndex?: number;
2250
+ }
2251
+ /**
2252
+ * (Highcharts, Highstock) Options for series data sorting.
2253
+ */
2254
+ interface PlotScatterDataSortingOptions {
2255
+ /**
2256
+ * (Highcharts, Highstock) Enable or disable data sorting for the
2257
+ * series. Use xAxis.reversed to change the sorting order.
2258
+ */
2259
+ enabled?: boolean;
2260
+ /**
2261
+ * (Highcharts, Highstock) Whether to allow matching points by name in
2262
+ * an update. If this option is disabled, points will be matched by
2263
+ * order.
2264
+ */
2265
+ matchByName?: boolean;
2266
+ /**
2267
+ * (Highcharts, Highstock) Determines what data value should be used to
2268
+ * sort by.
2269
+ */
2270
+ sortKey?: string;
2271
+ }
2272
+ /**
2273
+ * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
2274
+ * When plotting discrete values, a little random noise may help telling the
2275
+ * points apart. The jitter setting applies a random displacement of up to
2276
+ * `n` axis units in either direction. So for example on a horizontal X
2277
+ * axis, setting the `jitter.x` to 0.24 will render the point in a random
2278
+ * position between 0.24 units to the left and 0.24 units to the right of
2279
+ * the true axis position. On a category axis, setting it to 0.5 will fill
2280
+ * up the bin and make the data appear continuous.
2281
+ *
2282
+ * When rendered on top of a box plot or a column series, a jitter value of
2283
+ * 0.24 will correspond to the underlying series' default groupPadding and
2284
+ * pointPadding settings.
2285
+ *
2286
+ * **Note:** With boost mode enabled, the jitter effect is not supported.
2287
+ */
2288
+ interface PlotScatterJitterOptions {
2289
+ /**
2290
+ * (Highcharts, Highstock) The maximal X offset for the random jitter
2291
+ * effect.
2292
+ */
2293
+ x?: number;
2294
+ /**
2295
+ * (Highcharts, Highstock) The maximal Y offset for the random jitter
2296
+ * effect.
2297
+ */
2298
+ y?: number;
2299
+ }
2300
+ /**
2301
+ * (Highcharts, Highstock, Gantt) Styles for the series label. The color
2302
+ * defaults to the series color, or a contrast color if `onArea`.
2303
+ */
2304
+ interface PlotScatterLabelStyleOptions {
2305
+ fontSize?: number;
2306
+ fontWeight?: string;
2307
+ }
2308
+ /**
2309
+ * (Highcharts, Highstock) Animation when hovering over the marker.
2310
+ */
2311
+ interface PlotScatterMarkerStatesHoverAnimationOptions {
2312
+ duration?: number;
2313
+ }
2314
+ /**
2315
+ * (Highcharts, Highstock) Animation when hovering over the marker.
2316
+ */
2317
+ interface PlotScatterMarkerStatesSelectAnimationOptions {
2318
+ duration?: number;
2319
+ }
2320
+ /**
2321
+ * (Highcharts, Highstock) Options for the connector in the _Series on
2322
+ * point_ feature.
2323
+ *
2324
+ * In styled mode, the connector can be styled with the
2325
+ * `.highcharts-connector-seriesonpoint` class name.
2326
+ */
2327
+ interface PlotScatterOnPointConnectorOptions {
2328
+ /**
2329
+ * (Highcharts, Highstock) A name for the dash style to use for the
2330
+ * connector.
2331
+ */
2332
+ dashstyle?: string;
2333
+ /**
2334
+ * (Highcharts, Highstock) Color of the connector line. By default it's
2335
+ * the series' color.
2336
+ */
2337
+ stroke?: string;
2338
+ /**
2339
+ * (Highcharts, Highstock) Pixel width of the connector line.
2340
+ */
2341
+ width?: number;
2342
+ }
2343
+ /**
2344
+ * (Highcharts, Highstock) Options for the _Series on point_ feature. Only
2345
+ * `pie` and `sunburst` series are supported at this moment.
2346
+ */
2347
+ interface PlotScatterOnPointOptions {
2348
+ /**
2349
+ * (Highcharts, Highstock) Options for the connector in the _Series on
2350
+ * point_ feature.
2351
+ *
2352
+ * In styled mode, the connector can be styled with the
2353
+ * `.highcharts-connector-seriesonpoint` class name.
2354
+ */
2355
+ connectorOptions?: (Highcharts.PlotScatterOnPointConnectorOptions|Highcharts.SVGAttributes);
2356
+ /**
2357
+ * (Highcharts, Highstock) The `id` of the point that we connect the
2358
+ * series to. Only points with a given `plotX` and `plotY` values and
2359
+ * map points are valid.
2360
+ */
2361
+ id?: string;
2362
+ /**
2363
+ * (Highcharts, Highstock) Options allowing to set a position and an
2364
+ * offset of the series in the _Series on point_ feature.
2365
+ */
2366
+ position?: (object|Highcharts.PlotScatterOnPointPositionOptions);
2367
+ }
2368
+ /**
2369
+ * (Highcharts, Highstock) Options allowing to set a position and an offset
2370
+ * of the series in the _Series on point_ feature.
2371
+ */
2372
+ interface PlotScatterOnPointPositionOptions {
2373
+ /**
2374
+ * (Highcharts, Highstock) Series center offset from the original x
2375
+ * position. If defined, the connector line is drawn connecting original
2376
+ * position with new position.
2377
+ */
2378
+ offsetX?: number;
2379
+ /**
2380
+ * (Highcharts, Highstock) Series center offset from the original y
2381
+ * position. If defined, the connector line is drawn from original
2382
+ * position to a new position.
2383
+ */
2384
+ offsetY?: number;
2385
+ /**
2386
+ * (Highcharts, Highstock) X position of the series center. By default,
2387
+ * the series is displayed on the point that it is connected to.
2388
+ */
2389
+ x?: number;
2390
+ /**
2391
+ * (Highcharts, Highstock) Y position of the series center. By default,
2392
+ * the series is displayed on the point that it is connected to.
2393
+ */
2394
+ y?: number;
2395
+ }
2396
+ /**
2397
+ * (Highcharts, Highstock) A scatter plot uses cartesian coordinates to
2398
+ * display values for two variables for a set of data.
2399
+ *
2400
+ * Configuration options for the series are given in three levels:
2401
+ *
2402
+ * 1. Options for all series in a chart are defined in the
2403
+ * plotOptions.series object.
2404
+ *
2405
+ * 2. Options for all `scatter` series are defined in plotOptions.scatter.
2406
+ *
2407
+ * 3. Options for one single series are given in the series instance array.
2408
+ * (see online documentation for example)
2409
+ *
2410
+ * **TypeScript:**
2411
+ *
2412
+ * - type option should always be set, otherwise a broad set of unsupported
2413
+ * options is allowed.
2414
+ *
2415
+ * - when accessing an array of series, the combined set of all series types
2416
+ * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
2417
+ * specific type can be done by checking the `type` property. (see online
2418
+ * documentation for example)
2419
+ */
2420
+ interface PlotScatterOptions {
2421
+ /**
2422
+ * (Highcharts, Highstock) Accessibility options for a series.
2423
+ */
2424
+ accessibility?: Highcharts.SeriesAccessibilityOptionsObject;
2425
+ /**
2426
+ * (Highcharts, Highstock) Allow this series' points to be selected by
2427
+ * clicking on the graphic (columns, point markers, pie slices, map
2428
+ * areas etc).
2429
+ *
2430
+ * The selected points can be handled by point select and unselect
2431
+ * events, or collectively by the getSelectedPoints function.
2432
+ *
2433
+ * And alternative way of selecting points is through dragging.
2434
+ */
2435
+ allowPointSelect?: boolean;
2436
+ /**
2437
+ * (Highcharts, Highstock) Enable or disable the initial animation when
2438
+ * a series is displayed. The animation can also be set as a
2439
+ * configuration object. Please note that this option only applies to
2440
+ * the initial animation of the series itself. For other animations, see
2441
+ * chart.animation and the animation parameter under the API methods.
2442
+ * The following properties are supported:
2443
+ *
2444
+ * - `defer`: The animation delay time in milliseconds.
2445
+ *
2446
+ * - `duration`: The duration of the animation in milliseconds.
2447
+ * (Defaults to `1000`)
2448
+ *
2449
+ * - `easing`: Can be a string reference to an easing function set on
2450
+ * the `Math` object or a function. See the _Custom easing function_
2451
+ * demo below. (Defaults to `easeInOutSine`)
2452
+ *
2453
+ * Due to poor performance, animation is disabled in old IE browsers for
2454
+ * several chart types.
2455
+ */
2456
+ animation?: (boolean|Highcharts.AnimationOptionsObject);
706
2457
  /**
707
- * (Highcharts) Set the initial visibility of the series.
2458
+ * (Highcharts, Highstock) For some series, there is a limit that shuts
2459
+ * down animation by default when the total number of points in the
2460
+ * chart is too high. For example, for a column chart and its
2461
+ * derivatives, animation does not run if there is more than 250 points
2462
+ * totally. To disable this cap, set `animationLimit` to `Infinity`.
2463
+ * This option works if animation is fired on individual points, not on
2464
+ * a group of points like e.g. during the initial animation.
708
2465
  */
709
- visible?: boolean;
2466
+ animationLimit?: number;
710
2467
  /**
711
- * (Highcharts, Highstock) Defines the Axis on which the zones are
712
- * applied.
2468
+ * (Highcharts, Highstock) Sets the color blending in the boost module.
713
2469
  */
714
- zoneAxis?: string;
2470
+ boostBlending?: Highcharts.OptionsBoostBlendingValue;
715
2471
  /**
716
- * (Highcharts, Highstock) An array defining zones within a series.
717
- * Zones can be applied to the X axis, Y axis or Z axis for bubbles,
718
- * according to the `zoneAxis` option. The zone definitions have to be
719
- * in ascending order regarding to the value.
2472
+ * (Highcharts, Highstock) Set the point threshold for when a series
2473
+ * should enter boost mode.
720
2474
  *
721
- * In styled mode, the color zones are styled with the
722
- * `.highcharts-zone-{n}` class, or custom classed from the `className`
723
- * option (view live demo).
2475
+ * Setting it to e.g. 2000 will cause the series to enter boost mode
2476
+ * when there are 2000 or more points in the series.
2477
+ *
2478
+ * To disable boosting on the series, set the `boostThreshold` to 0.
2479
+ * Setting it to 1 will force boosting.
2480
+ *
2481
+ * Note that the cropThreshold also affects this setting. When zooming
2482
+ * in on a series that has fewer points than the `cropThreshold`, all
2483
+ * points are rendered although outside the visible plot area, and the
2484
+ * `boostThreshold` won't take effect.
724
2485
  */
725
- zones?: Array<Highcharts.SeriesZonesOptionsObject>;
2486
+ boostThreshold?: number;
726
2487
  /**
727
- * (Highcharts) Whether to zoom non-cartesian series. If `chart.zooming`
728
- * is set, the option allows to disable zooming on an individual
729
- * non-cartesian series. By default zooming is enabled for all series.
2488
+ * (Highcharts, Highstock) An additional class name to apply to the
2489
+ * series' graphical elements. This option does not replace default
2490
+ * class names of the graphical element. Changes to the series' color
2491
+ * will also be reflected in a chart's legend and tooltip.
2492
+ */
2493
+ className?: string;
2494
+ /**
2495
+ * (Highcharts, Highstock) Disable this option to allow series rendering
2496
+ * in the whole plotting area.
730
2497
  *
731
- * **Note**: This option works only for non-cartesian series.
2498
+ * **Note:** Clipping should be always enabled when chart.zoomType is
2499
+ * set
732
2500
  */
733
- zoomEnabled?: boolean;
734
- }
735
- /**
736
- * (Highcharts, Highstock) Animation when not hovering over the marker.
737
- */
738
- interface PlotScatter3dStatesInactiveAnimationOptions {
2501
+ clip?: boolean;
739
2502
  /**
740
- * (Highcharts, Highstock) The duration of the hover animation in
741
- * milliseconds. By default the hover state animates quickly in, and
742
- * slowly back to normal.
2503
+ * (Highcharts, Highmaps) Options for marker clusters, the concept of
2504
+ * sampling the data values into larger blocks in order to ease
2505
+ * readability and increase performance of the JavaScript charts.
2506
+ *
2507
+ * Note: marker clusters module is not working with `boost` and
2508
+ * `draggable-points` modules.
2509
+ *
2510
+ * The marker clusters feature requires the marker-clusters.js file to
2511
+ * be loaded, found in the modules directory of the download package, or
2512
+ * online at code.highcharts.com/modules/marker-clusters.js.
743
2513
  */
744
- duration?: number;
745
- }
746
- /**
747
- * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
748
- * format in the tooltip's header will by default be guessed based on the
749
- * closest data points. This member gives the default string representations
750
- * used for each unit. For an overview of the string or object
751
- * configuration, see dateFormat.
752
- */
753
- interface PlotScatter3dTooltipDateTimeLabelFormatsOptions {
754
- day?: string;
755
- hour?: string;
756
- millisecond?: string;
757
- minute?: string;
758
- month?: string;
759
- second?: string;
760
- week?: string;
761
- year?: string;
762
- }
763
- /**
764
- * (Highcharts, Highstock, Highmaps) Positioning options for fixed tooltip,
765
- * taking effect only when tooltip.fixed is `true`.
766
- */
767
- interface PlotScatter3dTooltipPositionOptions {
2514
+ cluster?: Highcharts.PlotScatterClusterOptions;
768
2515
  /**
769
- * (Highcharts, Highstock, Highmaps) The horizontal alignment of the
770
- * fixed tooltip.
2516
+ * (Highcharts, Highstock) The main color of the series. In line type
2517
+ * series it applies to the line and the point markers unless otherwise
2518
+ * specified. In bar type series it applies to the bars unless a color
2519
+ * is specified per point. The default value is pulled from the
2520
+ * `options.colors` array.
2521
+ *
2522
+ * In styled mode, the color can be defined by the colorIndex option.
2523
+ * Also, the series color can be set with the `.highcharts-series`,
2524
+ * `.highcharts-color-{n}`, `.highcharts-{type}-series` or
2525
+ * `.highcharts-series-{n}` class, or individual classes given by the
2526
+ * `className` option.
771
2527
  */
772
- align?: Highcharts.AlignValue;
2528
+ color?: Highcharts.ColorType;
773
2529
  /**
774
- * (Highcharts, Highstock, Highmaps) What the fixed tooltip alignment
775
- * should be relative to.
2530
+ * (Highcharts, Highstock, Highmaps) When using dual or multiple color
2531
+ * axes, this number defines which colorAxis the particular series is
2532
+ * connected to. It refers to either the axis id or the index of the
2533
+ * axis in the colorAxis array, with 0 being the first. Set this option
2534
+ * to false to prevent a series from connecting to the default color
2535
+ * axis.
776
2536
  *
777
- * The default, `pane`, means that it is aligned within the plot area
778
- * for that given series. If the tooltip is split (as default in Stock
779
- * charts), each partial tooltip is aligned within the series' pane.
2537
+ * Since v7.2.0 the option can also be an axis id or an axis index
2538
+ * instead of a boolean flag.
780
2539
  */
781
- relativeTo?: Highcharts.OptionsRelativeToValue;
2540
+ colorAxis?: (boolean|number|string);
782
2541
  /**
783
- * (Highcharts, Highstock, Highmaps) The vertical alignment of the fixed
784
- * tooltip.
2542
+ * (Highcharts, Highstock) Styled mode only. A specific color index to
2543
+ * use for the series, so its graphic representations are given the
2544
+ * class name `highcharts-color-{n}`.
2545
+ *
2546
+ * Since v11, CSS variables on the form `--highcharts-color-{n}` make
2547
+ * changing the color scheme very convenient.
785
2548
  */
786
- verticalAlign?: Highcharts.VerticalAlignValue;
2549
+ colorIndex?: number;
787
2550
  /**
788
- * (Highcharts, Highstock, Highmaps) X pixel offset from the given
789
- * position. Can be used to shy away from axis lines, grid lines etc to
790
- * avoid the tooltip overlapping other elements.
2551
+ * (Highcharts, Highstock, Highmaps) Determines what data value should
2552
+ * be used to calculate point color if `colorAxis` is used. Requires to
2553
+ * set `min` and `max` if some custom point property is used or if
2554
+ * approximation for data grouping is set to `'sum'`.
791
2555
  */
792
- x?: number;
2556
+ colorKey?: string;
793
2557
  /**
794
- * (Highcharts, Highstock, Highmaps) Y pixel offset from the given
795
- * position. Can be used to shy away from axis lines, grid lines etc to
796
- * avoid the tooltip overlapping other elements.
2558
+ * (Highstock) Compare the values of the series against the first
2559
+ * non-null, non- zero value in the visible range. The y axis will show
2560
+ * percentage or absolute change depending on whether `compare` is set
2561
+ * to `"percent"` or `"value"`. When this is applied to multiple series,
2562
+ * it allows comparing the development of the series against each other.
2563
+ * Adds a `change` field to every point object. If a `compare` value is
2564
+ * not set on a linked series, it will be inherited from the parent
2565
+ * series.
797
2566
  */
798
- y?: number;
799
- }
800
- /**
801
- * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the initial
802
- * animation when a series is displayed for the `dataLabels`. The animation
803
- * can also be set as a configuration object. Please note that this option
804
- * only applies to the initial animation.
805
- *
806
- * For other animations, see chart.animation and the animation parameter
807
- * under the API methods. The following properties are supported:
808
- *
809
- * - `defer`: The animation delay time in milliseconds.
810
- */
811
- interface PlotScatterClusterDataLabelsAnimationOptions {
2567
+ compare?: Highcharts.OptionsCompareValue;
812
2568
  /**
813
- * (Highcharts, Highstock, Highmaps, Gantt) The animation delay time in
814
- * milliseconds. Set to `0` to render the data labels immediately. As
815
- * `undefined` inherits defer time from the series.animation.defer.
2569
+ * (Highstock) When compare is `percent`, this option dictates whether
2570
+ * to use 0 or 100 as the base of comparison.
816
2571
  */
817
- defer?: number;
818
- }
819
- /**
820
- * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
821
- * default `color` setting is `"contrast"`, which is a pseudo color that
822
- * Highcharts picks up and applies the maximum contrast to the underlying
823
- * point item, for example the bar in a bar chart.
824
- *
825
- * The `textOutline` is a pseudo property that applies an outline of the
826
- * given width with the given color, which by default is the maximum
827
- * contrast to the text. So a bright text color will result in a black text
828
- * outline for maximum readability on a mixed background. In some cases,
829
- * especially with grayscale text, the text outline doesn't work well, in
830
- * which cases it can be disabled by setting it to `"none"`. When `useHTML`
831
- * is true, the `textOutline` will not be picked up. In this, case, the same
832
- * effect can be achieved through the `text-shadow` CSS property. As a
833
- * complementary or alternative to the `textOutline`, a
834
- * `dataLabels.backgroundColor` can be used. It provides a more calm
835
- * impression and ensures readable text label, at the cost of a risk of
836
- * overshadowing the underlying chart elements.
837
- *
838
- * For some series types, where each point has an extent, like for example
839
- * tree maps, the data label may overflow the point. There are two
840
- * strategies for handling overflow. By default, the text will wrap to
841
- * multiple lines. The other strategy is to set `style.textOverflow` to
842
- * `ellipsis`, which will keep the text on one line plus it will break
843
- * inside long words.
844
- */
845
- interface PlotScatterClusterDataLabelsStyleOptions {
846
- color?: string;
847
- }
848
- /**
849
- * (Highcharts, Highmaps) Options for layout algorithm. Inside there are
850
- * options to change the type of the algorithm, gridSize, distance or
851
- * iterations.
852
- */
853
- interface PlotScatterClusterLayoutAlgorithmOptions {
2572
+ compareBase?: (0|100);
854
2573
  /**
855
- * (Highcharts, Highmaps) When `type` is set to `kmeans`, `distance` is
856
- * a maximum distance between point and cluster center so that this
857
- * point will be inside the cluster. The distance is either a number
858
- * defining pixels or a percentage defining a percentage of the plot
859
- * area width.
2574
+ * (Highstock) Defines if comparison should start from the first point
2575
+ * within the visible range or should start from the last point
2576
+ * **before** the range.
2577
+ *
2578
+ * In other words, this flag determines if first point within the
2579
+ * visible range will have 0% (`compareStart=true`) or should have been
2580
+ * already calculated according to the previous point
2581
+ * (`compareStart=false`).
860
2582
  */
861
- distance?: (number|string);
2583
+ compareStart?: boolean;
862
2584
  /**
863
- * (Highcharts, Highmaps) When `type` is set to the `grid`, `gridSize`
864
- * is a size of a grid square element either as a number defining
865
- * pixels, or a percentage defining a percentage of the plot area width.
2585
+ * (Highcharts) Polar charts only. Whether to connect the ends of a line
2586
+ * series plot across the extremes.
866
2587
  */
867
- gridSize?: (number|string);
2588
+ connectEnds?: boolean;
868
2589
  /**
869
- * (Highcharts, Highmaps) When `type` is set to `kmeans`, `iterations`
870
- * are the number of iterations that this algorithm will be repeated to
871
- * find clusters positions.
2590
+ * (Highcharts, Highstock) Whether to connect a graph line across null
2591
+ * points, or render a gap between the two points on either side of the
2592
+ * null.
2593
+ *
2594
+ * In stacked area chart, if `connectNulls` is set to true, null points
2595
+ * are interpreted as 0.
872
2596
  */
873
- iterations?: number;
2597
+ connectNulls?: boolean;
874
2598
  /**
875
- * (Highcharts, Highmaps) When `type` is set to `undefined` and there
876
- * are more visible points than the kmeansThreshold the `grid` algorithm
877
- * is used to find clusters, otherwise `kmeans`. It ensures good
878
- * performance on large datasets and better clusters arrangement after
879
- * the zoom.
2599
+ * (Highcharts, Highstock, Gantt) When true, each point or column edge
2600
+ * is rounded to its nearest pixel in order to render sharp on screen.
2601
+ * In some cases, when there are a lot of densely packed columns, this
2602
+ * leads to visible difference in column widths or distance between
2603
+ * columns. In these cases, setting `crisp` to `false` may look better,
2604
+ * even though each column is rendered blurry.
880
2605
  */
881
- kmeansThreshold?: number;
2606
+ crisp?: boolean;
882
2607
  /**
883
- * (Highcharts, Highmaps) Type of the algorithm used to combine points
884
- * into a cluster. There are three available algorithms:
2608
+ * (Highstock) Cumulative Sum feature replaces points' values with the
2609
+ * following formula: `sum of all previous points' values + current
2610
+ * point's value`. Works only for points in a visible range. Adds the
2611
+ * `cumulativeSum` field to each point object that can be accessed e.g.
2612
+ * in the tooltip.pointFormat.
885
2613
  *
886
- * 1) `grid` - grid-based clustering technique. Points are assigned to
887
- * squares of set size depending on their position on the plot area.
888
- * Points inside the grid square are combined into a cluster. The grid
889
- * size can be controlled by `gridSize` property (grid size changes at
890
- * certain zoom levels).
2614
+ * With `dataGrouping` enabled, default grouping approximation is set to
2615
+ * `sum`.
2616
+ */
2617
+ cumulative?: boolean;
2618
+ /**
2619
+ * (Highstock) Defines if cumulation should start from the first point
2620
+ * within the visible range or should start from the last point
2621
+ * **before** the range.
891
2622
  *
892
- * 2) `kmeans` - based on K-Means clustering technique. In the first
893
- * step, points are divided using the grid method (distance property is
894
- * a grid size) to find the initial amount of clusters. Next, each point
895
- * is classified by computing the distance between each cluster center
896
- * and that point. When the closest cluster distance is lower than
897
- * distance property set by a user the point is added to this cluster
898
- * otherwise is classified as `noise`. The algorithm is repeated until
899
- * each cluster center not change its previous position more than one
900
- * pixel. This technique is more accurate but also more time consuming
901
- * than the `grid` algorithm, especially for big datasets.
2623
+ * In other words, this flag determines if first point within the
2624
+ * visible range will start at 0 (`cumulativeStart=true`) or should have
2625
+ * been already calculated according to the previous point
2626
+ * (`cumulativeStart=false`).
2627
+ */
2628
+ cumulativeStart?: boolean;
2629
+ /**
2630
+ * (Highcharts, Highstock) You can set the cursor to "pointer" if you
2631
+ * have click events attached to the series, to signal to the user that
2632
+ * the points and lines can be clicked.
902
2633
  *
903
- * 3) `optimizedKmeans` - based on K-Means clustering technique. This
904
- * algorithm uses k-means algorithm only on the chart initialization or
905
- * when chart extremes have greater range than on initialization. When a
906
- * chart is redrawn the algorithm checks only clustered points distance
907
- * from the cluster center and rebuild it when the point is spaced
908
- * enough to be outside the cluster. It provides performance improvement
909
- * and more stable clusters position yet can be used rather on small and
910
- * sparse datasets.
2634
+ * In styled mode, the series cursor can be set with the same classes as
2635
+ * listed under series.color.
2636
+ */
2637
+ cursor?: (string|Highcharts.CursorValue);
2638
+ /**
2639
+ * (Highcharts, Highstock) A reserved subspace to store options and
2640
+ * values for customized functionality. Here you can add additional data
2641
+ * for your own event callbacks and formatter callbacks.
2642
+ */
2643
+ custom?: Highcharts.Dictionary<any>;
2644
+ /**
2645
+ * (Highcharts, Highstock) Name of the dash style to use for the graph,
2646
+ * or for some series types the outline of each shape.
911
2647
  *
912
- * By default, the algorithm depends on visible quantity of points and
913
- * `kmeansThreshold`. When there are more visible points than the
914
- * `kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.
2648
+ * In styled mode, the stroke dash-array can be set with the same
2649
+ * classes as listed under series.color.
2650
+ */
2651
+ dashStyle?: Highcharts.DashStyleValue;
2652
+ /**
2653
+ * (Highstock) Data grouping is the concept of sampling the data values
2654
+ * into larger blocks in order to ease readability and increase
2655
+ * performance of the JavaScript charts. Highcharts Stock by default
2656
+ * applies data grouping when the points become closer than a certain
2657
+ * pixel value, determined by the `groupPixelWidth` option.
915
2658
  *
916
- * The custom clustering algorithm can be added by assigning a callback
917
- * function as the type property. This function takes an array of
918
- * `processedXData`, `processedYData`, `processedXData` indexes and
919
- * `layoutAlgorithm` options as arguments and should return an object
920
- * with grouped data.
2659
+ * If data grouping is applied, the grouping information of grouped
2660
+ * points can be read from the Point.dataGroup. If point options other
2661
+ * than the data itself are set, for example `name` or `color` or custom
2662
+ * properties, the grouping logic doesn't know how to group it. In this
2663
+ * case the options of the first point instance are copied over to the
2664
+ * group point. This can be altered through a custom `approximation`
2665
+ * callback function.
2666
+ */
2667
+ dataGrouping?: Highcharts.DataGroupingOptionsObject;
2668
+ /**
2669
+ * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
2670
+ * labels, appearing next to each data point.
921
2671
  *
922
- * The algorithm should return an object like that: (see online
923
- * documentation for example)
2672
+ * Since v6.2.0, multiple data labels can be applied to each single
2673
+ * point by defining them as an array of configs.
924
2674
  *
925
- * `clusterId` (example above - unique id of a cluster or noise) is an
926
- * array of points belonging to a cluster. If the array has only one
927
- * point or fewer points than set in `cluster.minimumClusterSize` it
928
- * won't be combined into a cluster.
2675
+ * In styled mode, the data labels can be styled with the
2676
+ * `.highcharts-data-label-box` and `.highcharts-data-label` class names
2677
+ * (see example).
929
2678
  */
930
- type?: (string|Function);
931
- }
932
- interface PlotScatterClusterStatesHoverOptions {
2679
+ dataLabels?: (Highcharts.PlotScatterDataLabelsOptions|Array<Highcharts.PlotScatterDataLabelsOptions>);
933
2680
  /**
934
- * (Highcharts, Highmaps) The fill color of the cluster marker in hover
935
- * state. When `undefined`, the series' or point's fillColor for normal
936
- * state is used.
2681
+ * (Highcharts, Highstock) The mapping between the data table and the
2682
+ * series data points. This is used in conjunction with the `dataTable`
2683
+ * option (on chart or series level) to map columns from the data table
2684
+ * to the properties of the data points. The keys of the `dataMapping`
2685
+ * object correspond to the properties of the data points (e.g. `x`,
2686
+ * `y`, `name`), and the values are objects that specify which column
2687
+ * from which data table to use for that property.
2688
+ *
2689
+ * The keys can also be nested paths, for example `dataLabel.format`, to
2690
+ * map to nested properties of the data points.
2691
+ *
2692
+ * The values can also be strings, in which case they are interpreted as
2693
+ * column id's from the first data table.
2694
+ *
2695
+ * A typical use case is that multiple series share a common column,
2696
+ * like `name` or `x`. In this case, to avoid repetition, the common
2697
+ * column can be applied in `plotOptions.series.dataMapping` and the
2698
+ * individual series can specify only the columns that are unique to
2699
+ * them.
2700
+ *
2701
+ * The series name defaults to the column ID of the main data column in
2702
+ * the mapping. The main data column is typically the `y` data for
2703
+ * cartesian series, or `value` for map series. For example, if the
2704
+ * mapping is `{ y: 'Cost' }`, the series name will be `Cost`. (see
2705
+ * online documentation for example)
2706
+ *
2707
+ * If the columns of the DataTable have keys matching the series keys,
2708
+ * the data mapping is not necessary. For example, this DataTable will
2709
+ * connect directly to the series' `x` and `y` keys: (see online
2710
+ * documentation for example)
937
2711
  */
938
- fillColor?: Highcharts.ColorType;
939
- }
940
- /**
941
- * (Highcharts, Highmaps) An array defining zones within marker clusters.
942
- *
943
- * In styled mode, the color zones are styled with the
944
- * `.highcharts-cluster-zone-{n}` class, or custom classed from the
945
- * `className` option.
946
- */
947
- interface PlotScatterClusterZonesOptions {
2712
+ dataMapping?: Highcharts.DataMappingOptionsObject;
948
2713
  /**
949
- * (Highcharts, Highmaps) Styled mode only. A custom class name for the
950
- * zone.
2714
+ * (Highcharts, Highstock) Options for series data sorting.
951
2715
  */
952
- className?: string;
2716
+ dataSorting?: Highcharts.PlotScatterDataSortingOptions;
953
2717
  /**
954
- * (Highcharts, Highmaps) The value where the zone starts.
2718
+ * (Highcharts, Highstock) Options for a specific series-level data
2719
+ * table or an array of data tables. The `dataTable` option can be
2720
+ * either a configuration object or an instance of the `DataTable`
2721
+ * class. If a `DataTable` instance is passed, it will be used directly.
2722
+ * If a configuration object or an array is passed, a new `DataTable`
2723
+ * instance will be created based on the provided configuration.
955
2724
  */
956
- from?: number;
2725
+ dataTable?: (Highcharts.DataTable|Highcharts.DataTableOptionsObject|Array<(Highcharts.DataTable|Highcharts.DataTableOptionsObject)>);
957
2726
  /**
958
- * (Highcharts, Highmaps) Settings for the cluster marker belonging to
959
- * the zone.
2727
+ * (Highcharts, Highstock) Deprecated. Use
2728
+ * plotOptions.series.accessibility.description instead.
2729
+ *
2730
+ * A description of the series to add to the screen reader information
2731
+ * about the series.
2732
+ *
2733
+ * @deprecated 8.0.0
960
2734
  */
961
- marker?: Highcharts.PointMarkerOptionsObject;
2735
+ description?: string;
962
2736
  /**
963
- * (Highcharts, Highmaps) The value where the zone ends.
2737
+ * (Highcharts, Highstock) The draggable-points module allows points to
2738
+ * be moved around or modified in the chart. In addition to the options
2739
+ * mentioned under the `dragDrop` API structure, the module fires three
2740
+ * events, point.dragStart, point.drag and point.drop.
964
2741
  */
965
- to?: number;
966
- }
967
- /**
968
- * (Highcharts, Highstock, Highmaps, Gantt) Options for the series data
969
- * labels, appearing next to each data point.
970
- *
971
- * Since v6.2.0, multiple data labels can be applied to each single point by
972
- * defining them as an array of configs.
973
- *
974
- * In styled mode, the data labels can be styled with the
975
- * `.highcharts-data-label-box` and `.highcharts-data-label` class names
976
- * (see example).
977
- */
978
- interface PlotScatterDataLabelsOptions {
2742
+ dragDrop?: Highcharts.SeriesDragDropOptionsObject;
979
2743
  /**
980
- * (Highcharts, Highstock, Highmaps, Gantt) The alignment of the data
981
- * label compared to the point. If `right`, the right side of the label
982
- * should be touching the point. For points with an extent, like
983
- * columns, the alignments also dictates how to align it inside the box,
984
- * as given with the inside option. Can be one of `left`, `center` or
985
- * `right`.
2744
+ * (Highcharts, Highstock) Enable or disable the mouse tracking for a
2745
+ * specific series. This includes point tooltips and click events on
2746
+ * graphs and points. For large datasets it improves performance.
986
2747
  */
987
- align?: (Highcharts.AlignValue|null);
2748
+ enableMouseTracking?: boolean;
988
2749
  /**
989
- * (Highcharts, Highstock, Highmaps, Gantt) Alignment method for data
990
- * labels. If set to `plotEdges`, the labels are aligned within the plot
991
- * area in the direction of the y-axis. So in a regular column chart,
992
- * the labels are aligned vertically according to the `verticalAlign`
993
- * setting. In a bar chart, which is inverted, the labels are aligned
994
- * horizontally according to the `align` setting. Applies to cartesian
995
- * series only.
2750
+ * (Highcharts, Highstock) General event handlers for the series items.
2751
+ * These event hooks can also be attached to the series at run time
2752
+ * using the `Highcharts.addEvent` function.
996
2753
  */
997
- alignTo?: string;
2754
+ events?: Highcharts.SeriesEventsOptionsObject;
998
2755
  /**
999
- * (Highcharts, Highstock, Highmaps, Gantt) Whether to allow data labels
1000
- * to overlap. To make the labels less sensitive for overlapping, the
1001
- * dataLabels.padding can be set to 0.
2756
+ * (Highcharts, Highstock) Determines whether the series should look for
2757
+ * the nearest point in both dimensions or just the x-dimension when
2758
+ * hovering the series. Defaults to `'xy'` for scatter series and `'x'`
2759
+ * for most other series. If the data has duplicate x-values, it is
2760
+ * recommended to set this to `'xy'` to allow hovering over all points.
2761
+ *
2762
+ * Applies only to series types using nearest neighbor search (not
2763
+ * direct hover) for tooltip.
1002
2764
  */
1003
- allowOverlap?: boolean;
2765
+ findNearestPointBy?: Highcharts.OptionsFindNearestPointByValue;
1004
2766
  /**
1005
- * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the
1006
- * initial animation when a series is displayed for the `dataLabels`.
1007
- * The animation can also be set as a configuration object. Please note
1008
- * that this option only applies to the initial animation.
2767
+ * (Highcharts, Highstock) Defines when to display a gap in the graph,
2768
+ * together with the gapUnit option.
1009
2769
  *
1010
- * For other animations, see chart.animation and the animation parameter
1011
- * under the API methods. The following properties are supported:
2770
+ * In case when `dataGrouping` is enabled, points can be grouped into a
2771
+ * larger time span. This can make the grouped points to have a greater
2772
+ * distance than the absolute value of `gapSize` property, which will
2773
+ * result in disappearing graph completely. To prevent this situation
2774
+ * the mentioned distance between grouped points is used instead of
2775
+ * previously defined `gapSize`.
1012
2776
  *
1013
- * - `defer`: The animation delay time in milliseconds.
2777
+ * In practice, this option is most often used to visualize gaps in time
2778
+ * series. In a stock chart, intraday data is available for daytime
2779
+ * hours, while gaps will appear in nights and weekends.
1014
2780
  */
1015
- animation?: (boolean|Highcharts.PlotScatterDataLabelsAnimationOptions|Partial<Highcharts.AnimationOptionsObject>);
2781
+ gapSize?: number;
1016
2782
  /**
1017
- * (Highcharts, Highstock, Highmaps, Gantt) The background color or
1018
- * gradient for the data label. In addition to regular colors, there are
1019
- * two special setting for this option:
2783
+ * (Highcharts, Highstock) Together with gapSize, this option defines
2784
+ * where to draw gaps in the graph.
1020
2785
  *
1021
- * - `auto` will set the background color the point's color.
2786
+ * When the `gapUnit` is `"relative"` (default), a gap size of 5 means
2787
+ * that if the distance between two points is greater than 5 times that
2788
+ * of the two closest points, the graph will be broken.
1022
2789
  *
1023
- * - `contrast` will set it to a contrast against the text color, with
1024
- * an opacity allowing to see the underlying content. The contrast is
1025
- * great enough to ensure readability for the text according to
1026
- * accessibility standards.
2790
+ * When the `gapUnit` is `"value"`, the gap is based on absolute axis
2791
+ * values, which on a datetime axis is milliseconds. This also applies
2792
+ * to the navigator series that inherits gap options from the base
2793
+ * series.
1027
2794
  */
1028
- backgroundColor?: Highcharts.ColorType;
2795
+ gapUnit?: Highcharts.OptionsGapUnitValue;
1029
2796
  /**
1030
- * (Highcharts, Highstock, Highmaps, Gantt) The border color for the
1031
- * data label. Setting it to `auto` will use the point's color. Defaults
1032
- * to `undefined`.
2797
+ * (Highcharts, Highstock, Gantt) Whether to use the Y extremes of the
2798
+ * total chart width or only the zoomed area when zooming in on parts of
2799
+ * the X axis. By default, the Y axis adjusts to the min and max of the
2800
+ * visible data. Cartesian series only.
1033
2801
  */
1034
- borderColor?: Highcharts.ColorType;
2802
+ getExtremesFromAll?: boolean;
1035
2803
  /**
1036
- * (Highcharts, Highstock, Highmaps, Gantt) The border radius in pixels
1037
- * for the data label.
2804
+ * (Highcharts, Highstock) Highlight only the hovered point and fade the
2805
+ * remaining points.
2806
+ *
2807
+ * Scatter-type series require enabling the 'inactive' marker state and
2808
+ * adjusting opacity. Note that this approach could affect performance
2809
+ * with large datasets.
1038
2810
  */
1039
- borderRadius?: number;
2811
+ inactiveOtherPoints?: boolean;
1040
2812
  /**
1041
- * (Highcharts, Highstock, Highmaps, Gantt) The border width in pixels
1042
- * for the data label.
2813
+ * (Highcharts, Highstock) When set to `false` will prevent the series
2814
+ * data from being included in any form of data export.
2815
+ *
2816
+ * Since version 6.0.0 until 7.1.0 the option was existing undocumented
2817
+ * as `includeInCSVExport`.
1043
2818
  */
1044
- borderWidth?: number;
2819
+ includeInDataExport?: boolean;
1045
2820
  /**
1046
- * (Highcharts, Highstock, Highmaps, Gantt) A class name for the data
1047
- * label. Particularly in styled mode, this can be used to give each
1048
- * series' or point's data label unique styling. In addition to this
1049
- * option, a default color class name is added so that we can give the
1050
- * labels a contrast text shadow.
2821
+ * (Highcharts, Highstock) Apply a jitter effect for the rendered
2822
+ * markers. When plotting discrete values, a little random noise may
2823
+ * help telling the points apart. The jitter setting applies a random
2824
+ * displacement of up to `n` axis units in either direction. So for
2825
+ * example on a horizontal X axis, setting the `jitter.x` to 0.24 will
2826
+ * render the point in a random position between 0.24 units to the left
2827
+ * and 0.24 units to the right of the true axis position. On a category
2828
+ * axis, setting it to 0.5 will fill up the bin and make the data appear
2829
+ * continuous.
2830
+ *
2831
+ * When rendered on top of a box plot or a column series, a jitter value
2832
+ * of 0.24 will correspond to the underlying series' default
2833
+ * groupPadding and pointPadding settings.
2834
+ *
2835
+ * **Note:** With boost mode enabled, the jitter effect is not
2836
+ * supported.
1051
2837
  */
1052
- className?: string;
2838
+ jitter?: Highcharts.PlotScatterJitterOptions;
1053
2839
  /**
1054
- * (Highcharts, Highstock, Highmaps, Gantt) This options is deprecated.
1055
- * Use style.color instead.
1056
- *
1057
- * The text color for the data labels. Defaults to `undefined`. For
1058
- * certain series types, like column or map, the data labels can be
1059
- * drawn inside the points. In this case the data label will be drawn
1060
- * with maximum contrast by default. Additionally, it will be given a
1061
- * `text-outline` style with the opposite color, to further increase the
1062
- * contrast. This can be overridden by setting the `text-outline` style
1063
- * to `none` in the `dataLabels.style` option.
2840
+ * (Highcharts, Highstock) An array specifying which option maps to
2841
+ * which key in the data point array. This makes it convenient to work
2842
+ * with unstructured data arrays from different sources.
2843
+ */
2844
+ keys?: Array<string>;
2845
+ /**
2846
+ * (Highcharts, Highstock, Gantt) Series labels are placed as close to
2847
+ * the series as possible in a natural way, seeking to avoid other
2848
+ * series. The goal of this feature is to make the chart more easily
2849
+ * readable, like if a human designer placed the labels in the optimal
2850
+ * position.
1064
2851
  *
1065
- * @deprecated 10.3.0
2852
+ * The series labels currently work with series types having a `graph`
2853
+ * or an `area`.
1066
2854
  */
1067
- color?: Highcharts.ColorType;
2855
+ label?: Highcharts.SeriesLabelOptionsObject;
1068
2856
  /**
1069
- * (Highcharts, Highstock, Highmaps, Gantt) Whether to hide data labels
1070
- * that are outside the plot area. By default, the data label is moved
1071
- * inside the plot area according to the overflow option.
2857
+ * (Highstock) The line marks the last price from all points.
1072
2858
  */
1073
- crop?: boolean;
2859
+ lastPrice?: Highcharts.SeriesLastPriceOptionsObject;
1074
2860
  /**
1075
- * (Highcharts, Highstock, Gantt) Whether to defer displaying the data
1076
- * labels until the initial series animation has finished. Setting to
1077
- * `false` renders the data label immediately. If set to `true` inherits
1078
- * the defer time set in plotOptions.series.animation.
2861
+ * (Highstock) The line marks the last price from visible range of
2862
+ * points.
1079
2863
  */
1080
- defer?: boolean;
2864
+ lastVisiblePrice?: Highcharts.SeriesLastVisiblePriceOptionsObject;
1081
2865
  /**
1082
- * (Highcharts, Highstock, Gantt) The distance of the data label from
1083
- * the data point. Note that the `padding` setting also affects the
1084
- * rendered distance, but is not visible unless the data label has a
1085
- * border or background.
2866
+ * (Highcharts, Highstock) What type of legend symbol to render for this
2867
+ * series. Can be one of `areaMarker`, `lineMarker` or `rectangle`.
1086
2868
  */
1087
- distance?: number;
2869
+ legendSymbol?: Highcharts.OptionsLegendSymbolValue;
1088
2870
  /**
1089
- * (Highcharts, Highstock, Highmaps, Gantt) Enable or disable the data
1090
- * labels.
2871
+ * (Highcharts, Highstock) The line cap used for line ends and line
2872
+ * joins on the graph.
1091
2873
  */
1092
- enabled?: boolean;
2874
+ linecap?: Highcharts.SeriesLinecapValue;
1093
2875
  /**
1094
- * (Highcharts, Highstock, Highmaps, Gantt) A declarative filter to
1095
- * control of which data labels to display. The declarative filter is
1096
- * designed for use when callback functions are not available, like when
1097
- * the chart options require a pure JSON structure or for use with
1098
- * graphical editors. For programmatic control, use the `formatter`
1099
- * instead, and return `undefined` to disable a single data label. (see
1100
- * online documentation for example)
2876
+ * (Highcharts, Highstock) The width of the line connecting the data
2877
+ * points.
2878
+ */
2879
+ lineWidth?: number;
2880
+ /**
2881
+ * (Highcharts, Highstock, Gantt) The id of another series to link to.
2882
+ * Additionally, the value can be ":previous" to link to the previous
2883
+ * series. When two series are linked, only the first one appears in the
2884
+ * legend. Toggling the visibility of this also toggles the linked
2885
+ * series.
2886
+ *
2887
+ * If master series uses data sorting and linked series does not have
2888
+ * its own sorting definition, the linked series will be sorted in the
2889
+ * same order as the master one.
2890
+ *
2891
+ * If a `compare` value is not set on a linked series, it will be
2892
+ * inherited from the parent series.
1101
2893
  */
1102
- filter?: Highcharts.DataLabelsFilterOptionsObject;
2894
+ linkedTo?: string;
1103
2895
  /**
1104
- * (Highcharts, Highstock, Highmaps, Gantt) A format string for the data
1105
- * label. Available variables are the same as for `formatter`.
2896
+ * (Highcharts, Highstock) Options for the point markers of line and
2897
+ * scatter-like series. Properties like `fillColor`, `lineColor` and
2898
+ * `lineWidth` define the visual appearance of the markers. The `symbol`
2899
+ * option defines the shape. Other series types, like column series,
2900
+ * don't have markers, but have visual options on the series level
2901
+ * instead.
2902
+ *
2903
+ * In styled mode, the markers can be styled with the
2904
+ * `.highcharts-point`, `.highcharts-point-hover` and
2905
+ * `.highcharts-point-select` class names.
1106
2906
  */
1107
- format?: string;
2907
+ marker?: Highcharts.PointMarkerOptionsObject;
1108
2908
  /**
1109
- * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
1110
- * to format the data label. Note that if a `format` is defined, the
1111
- * format takes precedence and the formatter is ignored.
2909
+ * (Highstock) Options for the corresponding navigator series if
2910
+ * `showInNavigator` is `true` for this series. Available options are
2911
+ * the same as any series, documented at plotOptions and series.
2912
+ *
2913
+ * These options are merged with options in navigator.series, and will
2914
+ * take precedence if the same option is defined both places.
1112
2915
  */
1113
- formatter?: Highcharts.DataLabelsFormatterCallbackFunction;
2916
+ navigatorOptions?: Highcharts.PlotSeriesOptions;
1114
2917
  /**
1115
- * (Highcharts, Highstock, Highmaps, Gantt) For points with an extent,
1116
- * like columns or map areas, whether to align the data label inside the
1117
- * box or to the actual value point. Defaults to `false` in most cases,
1118
- * `true` in stacked columns.
2918
+ * (Highcharts, Highstock) The color for the parts of the graph or
2919
+ * points that are below the threshold. Note that `zones` takes
2920
+ * precedence over the negative color. Using `negativeColor` is
2921
+ * equivalent to applying a zone with value of 0.
1119
2922
  */
1120
- inside?: boolean;
2923
+ negativeColor?: Highcharts.ColorType;
1121
2924
  /**
1122
- * (Highcharts, Highstock, Highmaps, Gantt) The rank for this point's
1123
- * data label in case of collision. If two data labels are about to
1124
- * overlap, only the one with the highest `labelrank` will be drawn.
2925
+ * (Highcharts, Highstock) Whether or not data-points with the value of
2926
+ * `null` should be interactive. When this is set to `true`, tooltips
2927
+ * may highlight these points, and this option also enables keyboard
2928
+ * navigation for such points. Format options for such points include
2929
+ * `nullFormat` and `nullFormatter`. Works for these series: `line`,
2930
+ * `spline`, `area`, `area-spline`, `column`, `bar`, and `timeline`.
1125
2931
  */
1126
- labelrank?: number;
2932
+ nullInteraction?: (boolean|undefined);
1127
2933
  /**
1128
- * (Highcharts, Highstock, Highmaps, Gantt) Format for points with the
1129
- * value of null. Works analogously to format. `nullFormat` can be
1130
- * applied only to series which support displaying null points.
1131
- * `heatmap` and `tilemap` supports `nullFormat` by default while the
1132
- * following series requires [#series.nullInteraction] set to `true`:
1133
- * `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
1134
- * `timeline`. Does not work with series that don't display null points,
1135
- * like `pie`.
2934
+ * (Highcharts, Highstock) Options for the _Series on point_ feature.
2935
+ * Only `pie` and `sunburst` series are supported at this moment.
1136
2936
  */
1137
- nullFormat?: (boolean|string);
2937
+ onPoint?: (object|Highcharts.PlotScatterOnPointOptions);
1138
2938
  /**
1139
- * (Highcharts, Highstock, Highmaps, Gantt) Callback JavaScript function
1140
- * that defines formatting for points with the value of null. Works
1141
- * analogously to formatter. `nullFormatter` can be applied only to
1142
- * series which support displaying null points. `heatmap` and `tilemap`
1143
- * supports `nullFormatter` by default while the following series
1144
- * requires (series.nullInteraction)[#series.nullInteraction] set to
1145
- * `true`: `line`, `spline`, `area`, `area-spline`, `column`, `bar`, and
1146
- * `timeline`. Does not work with series that don't display null points,
1147
- * like `pie`.
2939
+ * (Highcharts, Highstock) Opacity of a series parts: line, fill (e.g.
2940
+ * area) and dataLabels.
1148
2941
  */
1149
- nullFormatter?: Highcharts.DataLabelsFormatterCallbackFunction;
2942
+ opacity?: number;
1150
2943
  /**
1151
- * (Highcharts, Highstock, Highmaps, Gantt) How to handle data labels
1152
- * that flow outside the plot area. The default is `"justify"`, which
1153
- * aligns them inside the plot area. For columns and bars, this means it
1154
- * will be moved inside the bar. To display data labels outside the plot
1155
- * area, set `crop` to `false` and `overflow` to `"allow"`.
2944
+ * (Highcharts, Highstock) Properties for each single point.
1156
2945
  */
1157
- overflow?: Highcharts.DataLabelsOverflowValue;
2946
+ point?: Highcharts.PlotSeriesPointOptions;
1158
2947
  /**
1159
- * (Highcharts, Highstock, Highmaps, Gantt) When either the
1160
- * `borderWidth` or the `backgroundColor` is set, this is the padding
1161
- * within the box.
2948
+ * (Highcharts, Highstock) Deprecated. Use
2949
+ * series.accessibility.point.descriptionFormat instead.
1162
2950
  *
1163
- * An array of numbers sets padding for the respective sides. An array
1164
- * of two numbers repeats the values for the horizontal and vertical
1165
- * sides.
2951
+ * Same as accessibility.point.descriptionFormat, but for an individual
2952
+ * series. Overrides the chart wide configuration.
2953
+ *
2954
+ * @deprecated 12.6.0
1166
2955
  */
1167
- padding?: (number|Array<number>);
2956
+ pointDescriptionFormat?: Function;
1168
2957
  /**
1169
- * (Highcharts, Highstock, Highmaps, Gantt) Aligns data labels relative
1170
- * to points. If `center` alignment is not possible, it defaults to
1171
- * `right`.
2958
+ * (Highcharts, Highstock) Deprecated. Use
2959
+ * series.accessibility.point.descriptionFormatter instead.
2960
+ *
2961
+ * Same as accessibility.series.descriptionFormatter, but for an
2962
+ * individual series. Overrides the chart wide configuration.
2963
+ *
2964
+ * @deprecated 8.0.0
1172
2965
  */
1173
- position?: Highcharts.AlignValue;
2966
+ pointDescriptionFormatter?: Function;
1174
2967
  /**
1175
- * (Highcharts, Highstock, Highmaps, Gantt) Text rotation in degrees.
1176
- * Note that due to a more complex structure, backgrounds, borders and
1177
- * padding will be lost on a rotated data label.
2968
+ * (Highcharts, Highstock, Gantt) If no x values are given for the
2969
+ * points in a series, `pointInterval` defines the interval of the x
2970
+ * values. For example, if a series contains one value every decade
2971
+ * starting from year 0, set `pointInterval` to `10`. In true `datetime`
2972
+ * axes, the `pointInterval` is set in milliseconds.
2973
+ *
2974
+ * It can be also be combined with `pointIntervalUnit` to draw irregular
2975
+ * time intervals.
2976
+ *
2977
+ * If combined with `relativeXValue`, an x value can be set on each
2978
+ * point, and the `pointInterval` is added x times to the `pointStart`
2979
+ * setting.
2980
+ *
2981
+ * Please note that this options applies to the _series data_, not the
2982
+ * interval of the axis ticks, which is independent.
1178
2983
  */
1179
- rotation?: number;
2984
+ pointInterval?: number;
1180
2985
  /**
1181
- * (Highcharts, Highstock, Highmaps, Gantt) The shadow of the box. Works
1182
- * best with `borderWidth` or `backgroundColor`. Since 2.3 the shadow
1183
- * can be an object configuration containing `color`, `offsetX`,
1184
- * `offsetY`, `opacity` and `width`.
2986
+ * (Highcharts, Highstock, Gantt) On datetime series, this allows for
2987
+ * setting the pointInterval to irregular time units, `day`, `month` and
2988
+ * `year`. A day is usually the same as 24 hours, but
2989
+ * `pointIntervalUnit` also takes the DST crossover into consideration
2990
+ * when dealing with local time. Combine this option with
2991
+ * `pointInterval` to draw weeks, quarters, 6 months, 10 years etc.
2992
+ *
2993
+ * Please note that this options applies to the _series data_, not the
2994
+ * interval of the axis ticks, which is independent.
1185
2995
  */
1186
- shadow?: (boolean|Highcharts.ShadowOptionsObject);
2996
+ pointIntervalUnit?: Highcharts.OptionsPointIntervalUnitValue;
1187
2997
  /**
1188
- * (Highcharts, Highstock, Highmaps, Gantt) The name of a symbol to use
1189
- * for the border around the label. Symbols are predefined functions on
1190
- * the Renderer object.
2998
+ * (Highstock) The width of each point on the x axis. For example in a
2999
+ * column chart with one value each day, the pointRange would be 1 day
3000
+ * (= 24 * 3600
3001
+ *
3002
+ * * 1000 milliseconds). This is normally computed automatically, but
3003
+ * this option can be used to override the automatic value.
1191
3004
  */
1192
- shape?: string;
3005
+ pointRange?: number;
1193
3006
  /**
1194
- * (Highcharts, Highstock, Highmaps, Gantt) Styles for the label. The
1195
- * default `color` setting is `"contrast"`, which is a pseudo color that
1196
- * Highcharts picks up and applies the maximum contrast to the
1197
- * underlying point item, for example the bar in a bar chart.
3007
+ * (Highcharts, Highstock, Gantt) If no x values are given for the
3008
+ * points in a series, `pointStart` defines on what value to start. For
3009
+ * example, if a series contains one yearly value starting from 1945,
3010
+ * set `pointStart` to 1945.
1198
3011
  *
1199
- * The `textOutline` is a pseudo property that applies an outline of the
1200
- * given width with the given color, which by default is the maximum
1201
- * contrast to the text. So a bright text color will result in a black
1202
- * text outline for maximum readability on a mixed background. In some
1203
- * cases, especially with grayscale text, the text outline doesn't work
1204
- * well, in which cases it can be disabled by setting it to `"none"`.
1205
- * When `useHTML` is true, the `textOutline` will not be picked up. In
1206
- * this, case, the same effect can be achieved through the `text-shadow`
1207
- * CSS property. As a complementary or alternative to the `textOutline`,
1208
- * a `dataLabels.backgroundColor` can be used. It provides a more calm
1209
- * impression and ensures readable text label, at the cost of a risk of
1210
- * overshadowing the underlying chart elements.
3012
+ * The `pointStart` setting can be a number, or a datetime string that
3013
+ * is parsed according to the `time.timezone` setting.
1211
3014
  *
1212
- * For some series types, where each point has an extent, like for
1213
- * example tree maps, the data label may overflow the point. There are
1214
- * two strategies for handling overflow. By default, the text will wrap
1215
- * to multiple lines. The other strategy is to set `style.textOverflow`
1216
- * to `ellipsis`, which will keep the text on one line plus it will
1217
- * break inside long words.
3015
+ * If combined with `relativeXValue`, an x value can be set on each
3016
+ * point. The x value from the point options is multiplied by
3017
+ * `pointInterval` and added to `pointStart` to produce a modified x
3018
+ * value.
1218
3019
  */
1219
- style?: Highcharts.CSSObject;
3020
+ pointStart?: (number|string);
1220
3021
  /**
1221
- * (Highcharts, Highstock, Highmaps, Gantt) Options for a label text
1222
- * which should follow marker's shape. Border and background are
1223
- * disabled for a label that follows a path.
1224
- *
1225
- * **Note:** Only SVG-based renderer supports this option. Setting
1226
- * `useHTML` to true will disable this option.
3022
+ * (Highcharts, Highstock) When true, X values in the data set are
3023
+ * relative to the current `pointStart`, `pointInterval` and
3024
+ * `pointIntervalUnit` settings. This allows compression of the data for
3025
+ * datasets with irregular X values.
1227
3026
  *
1228
- * Text path support is not bundled into `highcharts.js`, and requires
1229
- * the `modules/textpath.js` file. However, it is included in the script
1230
- * files of those series types that use it by default.
3027
+ * The real X values are computed on the formula `f(x) = ax + b`, where
3028
+ * `a` is the `pointInterval` (optionally with a time unit given by
3029
+ * `pointIntervalUnit`), and `b` is the `pointStart`.
1231
3030
  */
1232
- textPath?: Highcharts.DataLabelsTextPathOptionsObject;
3031
+ relativeXValue?: boolean;
1233
3032
  /**
1234
- * (Highcharts, Highstock, Highmaps, Gantt) Whether to use HTML to
1235
- * render the labels.
3033
+ * (Highcharts, Highstock) Whether to select the series initially. If
3034
+ * `showCheckbox` is true, the checkbox next to the series name in the
3035
+ * legend will be checked for a selected series.
1236
3036
  */
1237
- useHTML?: boolean;
3037
+ selected?: boolean;
1238
3038
  /**
1239
- * (Highcharts, Highstock, Highmaps, Gantt) The vertical alignment of a
1240
- * data label. Can be one of `top`, `middle` or `bottom`. The default
1241
- * value depends on the data, for instance in a column chart, the label
1242
- * is above positive values and below negative values.
3039
+ * (Highcharts, Highstock) If true, a checkbox is displayed next to the
3040
+ * legend item to allow selecting the series. The state of the checkbox
3041
+ * is determined by the `selected` option.
1243
3042
  */
1244
- verticalAlign?: (Highcharts.VerticalAlignValue|null);
3043
+ showCheckbox?: boolean;
1245
3044
  /**
1246
- * (Highcharts, Highstock, Highmaps, Gantt) The x position offset of the
1247
- * label relative to the point in pixels.
3045
+ * (Highcharts, Highstock) Whether to display this particular series or
3046
+ * series type in the legend. Standalone series are shown in legend by
3047
+ * default, and linked series are not. Since v7.2.0 it is possible to
3048
+ * show series that use colorAxis by setting this option to `true`.
1248
3049
  */
1249
- x?: number;
3050
+ showInLegend?: boolean;
1250
3051
  /**
1251
- * (Highcharts, Highstock, Highmaps, Gantt) The y position offset of the
1252
- * label relative to the point in pixels.
3052
+ * (Highstock) Whether or not to show the series in the navigator. Takes
3053
+ * precedence over navigator.baseSeries if defined.
1253
3054
  */
1254
- y?: number;
3055
+ showInNavigator?: boolean;
1255
3056
  /**
1256
- * (Highcharts, Highstock, Highmaps, Gantt) The z index of the data
1257
- * labels group. Does not apply below series level options.
3057
+ * (Highcharts, Highstock) Deprecated. Use
3058
+ * series.accessibility.keyboardNavigation instead.
1258
3059
  *
1259
- * Use a `zIndex` of 6 to display it above the series, or use a `zIndex`
1260
- * of 2 to display it behind the series.
3060
+ * If set to `true`, the accessibility module will skip past the points
3061
+ * in this series for keyboard navigation.
3062
+ *
3063
+ * @deprecated 8.0.0
1261
3064
  */
1262
- zIndex?: number;
1263
- }
1264
- /**
1265
- * (Highcharts, Highstock) Apply a jitter effect for the rendered markers.
1266
- * When plotting discrete values, a little random noise may help telling the
1267
- * points apart. The jitter setting applies a random displacement of up to
1268
- * `n` axis units in either direction. So for example on a horizontal X
1269
- * axis, setting the `jitter.x` to 0.24 will render the point in a random
1270
- * position between 0.24 units to the left and 0.24 units to the right of
1271
- * the true axis position. On a category axis, setting it to 0.5 will fill
1272
- * up the bin and make the data appear continuous.
1273
- *
1274
- * When rendered on top of a box plot or a column series, a jitter value of
1275
- * 0.24 will correspond to the underlying series' default groupPadding and
1276
- * pointPadding settings.
1277
- *
1278
- * **Note:** With boost mode enabled, the jitter effect is not supported.
1279
- */
1280
- interface PlotScatterJitterOptions {
3065
+ skipKeyboardNavigation?: boolean;
3066
+ /**
3067
+ * (Highcharts, Highstock) When this is true, the series will not cause
3068
+ * the Y axis to cross the zero plane (or threshold option) unless the
3069
+ * data actually crosses the plane.
3070
+ *
3071
+ * For example, if `softThreshold` is `false`, a series of 0, 1, 2, 3
3072
+ * will make the Y axis show negative values according to the
3073
+ * `minPadding` option. If `softThreshold` is `true`, the Y axis starts
3074
+ * at 0.
3075
+ */
3076
+ softThreshold?: boolean;
3077
+ /**
3078
+ * (Highcharts, Highstock) Sonification/audio chart options for a
3079
+ * series.
3080
+ */
3081
+ sonification?: Highcharts.SeriesSonificationOptions;
3082
+ /**
3083
+ * (Highcharts, Highstock) Whether to stack the values of each series on
3084
+ * top of each other. Possible values are null to disable, `"normal"` to
3085
+ * stack by value or `"percent"`.
3086
+ *
3087
+ * When stacking is enabled, data must be sorted in ascending X order.
3088
+ *
3089
+ * Some stacking options are related to specific series types. In the
3090
+ * streamgraph series type, the stacking option is set to `"stream"`.
3091
+ * The second one is `"overlap"`, which only applies to waterfall
3092
+ * series.
3093
+ */
3094
+ stacking?: Highcharts.OptionsStackingValue;
1281
3095
  /**
1282
- * (Highcharts, Highstock) The maximal X offset for the random jitter
1283
- * effect.
3096
+ * (Highcharts, Highstock) A collection of options for different series
3097
+ * states.
3098
+ *
3099
+ * In addition to the options documented under each state, any option
3100
+ * from the parent series type can be set, with exception of `data` and
3101
+ * `states`.
1284
3102
  */
1285
- x?: number;
3103
+ states?: Highcharts.SeriesStatesOptionsObject;
1286
3104
  /**
1287
- * (Highcharts, Highstock) The maximal Y offset for the random jitter
1288
- * effect.
3105
+ * (Highcharts, Highstock) Whether to apply steps to the line. Possible
3106
+ * values are `left`, `center` and `right`.
1289
3107
  */
1290
- y?: number;
1291
- }
1292
- /**
1293
- * (Highcharts, Highstock) Animation when hovering over the marker.
1294
- */
1295
- interface PlotScatterMarkerStatesHoverAnimationOptions {
1296
- duration?: number;
1297
- }
1298
- /**
1299
- * (Highcharts, Highstock) Options for the connector in the _Series on
1300
- * point_ feature.
1301
- *
1302
- * In styled mode, the connector can be styled with the
1303
- * `.highcharts-connector-seriesonpoint` class name.
1304
- */
1305
- interface PlotScatterOnPointConnectorOptions {
3108
+ step?: Highcharts.OptionsStepValue;
1306
3109
  /**
1307
- * (Highcharts, Highstock) A name for the dash style to use for the
1308
- * connector.
3110
+ * (Highcharts, Highstock, Highmaps) Sticky tracking of mouse events.
3111
+ * When true, the `mouseOut` event on a series isn't triggered until the
3112
+ * mouse moves over another series, or out of the plot area. When false,
3113
+ * the `mouseOut` event on a series is triggered when the mouse leaves
3114
+ * the area around the series' graph or markers. This also implies the
3115
+ * tooltip. When `stickyTracking` is false and `tooltip.shared` is
3116
+ * false, the tooltip will be hidden when moving the mouse between
3117
+ * series.
1309
3118
  */
1310
- dashstyle?: string;
3119
+ stickyTracking?: boolean;
1311
3120
  /**
1312
- * (Highcharts, Highstock) Color of the connector line. By default it's
1313
- * the series' color.
3121
+ * (Highcharts, Highstock) The threshold, also called zero level or base
3122
+ * level. For line type series this is only used in conjunction with
3123
+ * negativeColor.
1314
3124
  */
1315
- stroke?: string;
3125
+ threshold?: (number|null);
1316
3126
  /**
1317
- * (Highcharts, Highstock) Pixel width of the connector line.
3127
+ * (Highcharts, Highstock, Highmaps) A configuration object for the
3128
+ * tooltip rendering of each single series. Properties are inherited
3129
+ * from tooltip. Overridable properties are `headerFormat`,
3130
+ * `pointFormat`, `yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`.
3131
+ * Unlike other series, in a scatter plot the series.name by default
3132
+ * shows in the headerFormat and point.x and point.y in the pointFormat.
1318
3133
  */
1319
- width?: number;
1320
- }
1321
- /**
1322
- * (Highcharts, Highstock) Options allowing to set a position and an offset
1323
- * of the series in the _Series on point_ feature.
1324
- */
1325
- interface PlotScatterOnPointPositionOptions {
3134
+ tooltip?: Highcharts.SeriesTooltipOptionsObject;
1326
3135
  /**
1327
- * (Highcharts, Highstock) Series center offset from the original x
1328
- * position. If defined, the connector line is drawn connecting original
1329
- * position with new position.
3136
+ * (Highcharts, Highstock, Gantt) When a series contains a `data` array
3137
+ * that is longer than this, the Series class looks for data
3138
+ * configurations of plain numbers or arrays of numbers. The first and
3139
+ * last valid points are checked. If found, the rest of the data is
3140
+ * assumed to be the same. This saves expensive data checking and
3141
+ * indexing in long series, and makes data-heavy charts render faster.
3142
+ *
3143
+ * Set it to `0` disable.
3144
+ *
3145
+ * Note:
3146
+ *
3147
+ * - In boost mode turbo threshold is forced. Only array of numbers or
3148
+ * two dimensional arrays are allowed.
3149
+ *
3150
+ * - In version 11.4.3 and earlier, if object configurations were passed
3151
+ * beyond the turbo threshold, a warning was logged in the console and
3152
+ * the data series didn't render.
1330
3153
  */
1331
- offsetX?: number;
3154
+ turboThreshold?: number;
1332
3155
  /**
1333
- * (Highcharts, Highstock) Series center offset from the original y
1334
- * position. If defined, the connector line is drawn from original
1335
- * position to a new position.
3156
+ * (Highcharts, Highstock) Set the initial visibility of the series.
1336
3157
  */
1337
- offsetY?: number;
3158
+ visible?: boolean;
1338
3159
  /**
1339
- * (Highcharts, Highstock) X position of the series center. By default,
1340
- * the series is displayed on the point that it is connected to.
3160
+ * (Highcharts, Highstock) Defines the Axis on which the zones are
3161
+ * applied.
1341
3162
  */
1342
- x?: number;
3163
+ zoneAxis?: string;
1343
3164
  /**
1344
- * (Highcharts, Highstock) Y position of the series center. By default,
1345
- * the series is displayed on the point that it is connected to.
3165
+ * (Highcharts, Highstock) An array defining zones within a series.
3166
+ * Zones can be applied to the X axis, Y axis or Z axis for bubbles,
3167
+ * according to the `zoneAxis` option. The zone definitions have to be
3168
+ * in ascending order regarding to the value.
3169
+ *
3170
+ * In styled mode, the color zones are styled with the
3171
+ * `.highcharts-zone-{n}` class, or custom classed from the `className`
3172
+ * option (view live demo).
1346
3173
  */
1347
- y?: number;
3174
+ zones?: Array<Highcharts.SeriesZonesOptionsObject>;
3175
+ /**
3176
+ * (Highcharts, Highstock) Whether to zoom non-cartesian series. If
3177
+ * `chart.zooming` is set, the option allows to disable zooming on an
3178
+ * individual non-cartesian series. By default zooming is enabled for
3179
+ * all series.
3180
+ *
3181
+ * **Note**: This option works only for non-cartesian series.
3182
+ */
3183
+ zoomEnabled?: boolean;
1348
3184
  }
1349
3185
  /**
1350
3186
  * (Highcharts, Highstock) Animation setting for hovering the graph in
@@ -1358,6 +3194,17 @@ declare module "../highcharts.src" {
1358
3194
  */
1359
3195
  duration?: number;
1360
3196
  }
3197
+ /**
3198
+ * (Highcharts, Highstock) Animation when not hovering over the marker.
3199
+ */
3200
+ interface PlotScatterStatesInactiveAnimationOptions {
3201
+ /**
3202
+ * (Highcharts, Highstock) The duration of the hover animation in
3203
+ * milliseconds. By default the hover state animates quickly in, and
3204
+ * slowly back to normal.
3205
+ */
3206
+ duration?: number;
3207
+ }
1361
3208
  /**
1362
3209
  * (Highcharts, Highstock) Animation setting for hovering the graph in
1363
3210
  * line-type series.
@@ -1370,6 +3217,23 @@ declare module "../highcharts.src" {
1370
3217
  */
1371
3218
  duration?: number;
1372
3219
  }
3220
+ /**
3221
+ * (Highcharts, Highstock, Gantt) For series on datetime axes, the date
3222
+ * format in the tooltip's header will by default be guessed based on the
3223
+ * closest data points. This member gives the default string representations
3224
+ * used for each unit. For an overview of the string or object
3225
+ * configuration, see dateFormat.
3226
+ */
3227
+ interface PlotScatterTooltipDateTimeLabelFormatsOptions {
3228
+ day?: string;
3229
+ hour?: string;
3230
+ millisecond?: string;
3231
+ minute?: string;
3232
+ month?: string;
3233
+ second?: string;
3234
+ week?: string;
3235
+ year?: string;
3236
+ }
1373
3237
  /**
1374
3238
  * (Highcharts, Highstock, Highmaps) Options for the tooltip header when
1375
3239
  * tooltip.split is enabled. The header is the box containing the X value in
@@ -1414,6 +3278,43 @@ declare module "../highcharts.src" {
1414
3278
  */
1415
3279
  style?: object;
1416
3280
  }
3281
+ /**
3282
+ * (Highcharts, Highstock, Highmaps) Positioning options for fixed tooltip,
3283
+ * taking effect only when tooltip.fixed is `true`.
3284
+ */
3285
+ interface PlotScatterTooltipPositionOptions {
3286
+ /**
3287
+ * (Highcharts, Highstock, Highmaps) The horizontal alignment of the
3288
+ * fixed tooltip.
3289
+ */
3290
+ align?: Highcharts.AlignValue;
3291
+ /**
3292
+ * (Highcharts, Highstock, Highmaps) What the fixed tooltip alignment
3293
+ * should be relative to.
3294
+ *
3295
+ * The default, `pane`, means that it is aligned within the plot area
3296
+ * for that given series. If the tooltip is split (as default in Stock
3297
+ * charts), each partial tooltip is aligned within the series' pane.
3298
+ */
3299
+ relativeTo?: Highcharts.OptionsRelativeToValue;
3300
+ /**
3301
+ * (Highcharts, Highstock, Highmaps) The vertical alignment of the fixed
3302
+ * tooltip.
3303
+ */
3304
+ verticalAlign?: Highcharts.VerticalAlignValue;
3305
+ /**
3306
+ * (Highcharts, Highstock, Highmaps) X pixel offset from the given
3307
+ * position. Can be used to shy away from axis lines, grid lines etc to
3308
+ * avoid the tooltip overlapping other elements.
3309
+ */
3310
+ x?: number;
3311
+ /**
3312
+ * (Highcharts, Highstock, Highmaps) Y pixel offset from the given
3313
+ * position. Can be used to shy away from axis lines, grid lines etc to
3314
+ * avoid the tooltip overlapping other elements.
3315
+ */
3316
+ y?: number;
3317
+ }
1417
3318
  /**
1418
3319
  * (Highcharts, Highstock, Gantt) Enable or disable the initial animation
1419
3320
  * when a series is displayed for the `dataLabels`. The animation can also
@@ -1433,12 +3334,71 @@ declare module "../highcharts.src" {
1433
3334
  */
1434
3335
  defer?: number;
1435
3336
  }
3337
+ /**
3338
+ * (Highcharts, Highstock) Animation when hovering over the marker.
3339
+ */
3340
+ interface SeriesScatter3dDataMarkerStatesHoverAnimationOptions {
3341
+ duration?: number;
3342
+ }
1436
3343
  /**
1437
3344
  * (Highcharts, Highstock) Animation when hovering over the marker.
1438
3345
  */
1439
3346
  interface SeriesScatter3dDataMarkerStatesSelectAnimationOptions {
1440
3347
  duration?: number;
1441
3348
  }
3349
+ /**
3350
+ * (Highcharts) A `scatter3d` series. If the type option is not specified,
3351
+ * it is inherited from chart.type.
3352
+ *
3353
+ * Configuration options for the series are given in three levels:
3354
+ *
3355
+ * 1. Options for all series in a chart are defined in the
3356
+ * plotOptions.series object.
3357
+ *
3358
+ * 2. Options for all `scatter3d` series are defined in
3359
+ * plotOptions.scatter3d.
3360
+ *
3361
+ * 3. Options for one single series are given in the series instance array.
3362
+ * (see online documentation for example)
3363
+ *
3364
+ * **TypeScript:**
3365
+ *
3366
+ * - type option should always be set, otherwise a broad set of unsupported
3367
+ * options is allowed.
3368
+ *
3369
+ * - when accessing an array of series, the combined set of all series types
3370
+ * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
3371
+ * specific type can be done by checking the `type` property. (see online
3372
+ * documentation for example)
3373
+ *
3374
+ * You have to extend the `SeriesScatter3dOptions` via an interface to allow
3375
+ * custom properties: ``` declare interface SeriesScatter3dOptions {
3376
+ * customProperty: string; }
3377
+ *
3378
+ */
3379
+ interface SeriesScatter3dOptions extends Highcharts.PlotScatter3dOptions, Highcharts.SeriesOptions {
3380
+ /**
3381
+ * (Highcharts) An array of data points for the series. For the
3382
+ * `scatter3d` series type, points can be given in the following ways:
3383
+ *
3384
+ * 1. An array of arrays with 3 values. In this case, the values
3385
+ * correspond to `x,y,z`. If the first value is a string, it is applied
3386
+ * as the name of the point, and the `x` value is inferred. (see online
3387
+ * documentation for example)
3388
+ *
3389
+ * 3. An array of objects with named values. The following snippet shows
3390
+ * only a few settings, see the complete options set below. If the total
3391
+ * number of data points exceeds the series' turboThreshold, this option
3392
+ * is not available. (see online documentation for example)
3393
+ */
3394
+ data?: Array<(Array<number>|Highcharts.PointOptionsObject)>;
3395
+ /**
3396
+ * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
3397
+ * TypeScript non-optional and might be `undefined` in series objects
3398
+ * from unknown sources.
3399
+ */
3400
+ type: "scatter3d";
3401
+ }
1442
3402
  /**
1443
3403
  * (Highcharts, Highstock, Gantt) Enable or disable the initial animation
1444
3404
  * when a series is displayed for the `dataLabels`. The animation can also
@@ -1458,10 +3418,75 @@ declare module "../highcharts.src" {
1458
3418
  */
1459
3419
  defer?: number;
1460
3420
  }
3421
+ /**
3422
+ * (Highcharts, Highstock) Animation when hovering over the marker.
3423
+ */
3424
+ interface SeriesScatterDataMarkerStatesHoverAnimationOptions {
3425
+ duration?: number;
3426
+ }
1461
3427
  /**
1462
3428
  * (Highcharts, Highstock) Animation when hovering over the marker.
1463
3429
  */
1464
3430
  interface SeriesScatterDataMarkerStatesSelectAnimationOptions {
1465
3431
  duration?: number;
1466
3432
  }
3433
+ /**
3434
+ * (Highcharts, Highstock) A `scatter` series. If the type option is not
3435
+ * specified, it is inherited from chart.type.
3436
+ *
3437
+ * Configuration options for the series are given in three levels:
3438
+ *
3439
+ * 1. Options for all series in a chart are defined in the
3440
+ * plotOptions.series object.
3441
+ *
3442
+ * 2. Options for all `scatter` series are defined in plotOptions.scatter.
3443
+ *
3444
+ * 3. Options for one single series are given in the series instance array.
3445
+ * (see online documentation for example)
3446
+ *
3447
+ * **TypeScript:**
3448
+ *
3449
+ * - type option should always be set, otherwise a broad set of unsupported
3450
+ * options is allowed.
3451
+ *
3452
+ * - when accessing an array of series, the combined set of all series types
3453
+ * is represented by Highcharts.SeriesOptionsType . Narrowing down to the
3454
+ * specific type can be done by checking the `type` property. (see online
3455
+ * documentation for example)
3456
+ *
3457
+ * You have to extend the `SeriesScatterOptions` via an interface to allow
3458
+ * custom properties: ``` declare interface SeriesScatterOptions {
3459
+ * customProperty: string; }
3460
+ *
3461
+ */
3462
+ interface SeriesScatterOptions extends Highcharts.PlotScatterOptions, Highcharts.SeriesOptions {
3463
+ /**
3464
+ * (Highcharts, Highstock) An array of data points for the series. For
3465
+ * the `scatter` series type, points can be given in the following ways:
3466
+ *
3467
+ * 1. An array of numerical values. In this case, the numerical values
3468
+ * will be interpreted as `y` options. The `x` values will be
3469
+ * automatically calculated, either starting at 0 and incremented by 1,
3470
+ * or from `pointStart` and `pointInterval` given in the series options.
3471
+ * If the axis has categories, these will be used. Example: (see online
3472
+ * documentation for example)
3473
+ *
3474
+ * 2. An array of arrays with 2 values. In this case, the values
3475
+ * correspond to `x,y`. If the first value is a string, it is applied as
3476
+ * the name of the point, and the `x` value is inferred. (see online
3477
+ * documentation for example)
3478
+ *
3479
+ * 3. An array of objects with named values. The following snippet shows
3480
+ * only a few settings, see the complete options set below. If the total
3481
+ * number of data points exceeds the series' turboThreshold, this option
3482
+ * is not available. (see online documentation for example)
3483
+ */
3484
+ data?: Array<(number|[(number|string), (number|null)]|null|Highcharts.PointOptionsObject)>;
3485
+ /**
3486
+ * (Highcharts, Highstock, Highmaps, Gantt) This property is only in
3487
+ * TypeScript non-optional and might be `undefined` in series objects
3488
+ * from unknown sources.
3489
+ */
3490
+ type: "scatter";
3491
+ }
1467
3492
  }