@progress/kendo-angular-charts 19.1.2-develop.3 → 19.1.2-develop.5

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 (504) hide show
  1. package/api-types/axis-range.interface.d.ts +3 -3
  2. package/api-types/chart-axis.interface.d.ts +6 -6
  3. package/api-types/chart-pane.interface.d.ts +5 -5
  4. package/api-types/chart-plotarea.interface.d.ts +3 -3
  5. package/api-types/chart-svg-export-options.interface.d.ts +7 -1
  6. package/api-types/chart-visual-export-options.interface.d.ts +7 -1
  7. package/api-types/event-axis-options.interface.d.ts +2 -2
  8. package/api-types/event-series-options.interface.d.ts +4 -4
  9. package/api-types/series-point-marker.interface.d.ts +2 -2
  10. package/api-types/series-point.interface.d.ts +13 -13
  11. package/argument-types/axis-label-content-args.interface.d.ts +8 -8
  12. package/argument-types/axis-label-visual-args.interface.d.ts +10 -10
  13. package/argument-types/axis-note-content-args.interface.d.ts +4 -4
  14. package/argument-types/axis-note-visual-args.interface.d.ts +6 -6
  15. package/argument-types/error-bars-value-args.interface.d.ts +6 -6
  16. package/argument-types/error-bars-visual-args.interface.d.ts +7 -7
  17. package/argument-types/highlight-toggle-args.interface.d.ts +8 -8
  18. package/argument-types/highlight-visual-args.interface.d.ts +12 -15
  19. package/argument-types/legend-item-visual-args.interface.d.ts +7 -7
  20. package/argument-types/legend-labels-content-args.interface.d.ts +6 -6
  21. package/argument-types/markers-visual-args.interface.d.ts +9 -9
  22. package/argument-types/plot-band-label-visual-args.interface.d.ts +6 -6
  23. package/argument-types/series-labels-content-args.interface.d.ts +11 -11
  24. package/argument-types/series-labels-visual-args.interface.d.ts +14 -14
  25. package/argument-types/series-note-content-args.interface.d.ts +6 -6
  26. package/argument-types/series-note-visual-args.interface.d.ts +10 -10
  27. package/argument-types/series-visual-args.interface.d.ts +18 -25
  28. package/argument-types/title-visual-args.interface.d.ts +6 -6
  29. package/chart/axis-defaults/crosshair.component.d.ts +14 -5
  30. package/chart/axis-defaults/crosshair.tooltip.component.d.ts +14 -5
  31. package/chart/axis-defaults/labels.component.d.ts +18 -12
  32. package/chart/axis-defaults/title.component.d.ts +22 -7
  33. package/chart/axis-defaults.component.d.ts +57 -8
  34. package/chart/category-axis-item/crosshair.component.d.ts +14 -5
  35. package/chart/category-axis-item/crosshair.tooltip.component.d.ts +14 -5
  36. package/chart/category-axis-item/labels.component.d.ts +35 -15
  37. package/chart/category-axis-item/notes.component.d.ts +19 -1
  38. package/chart/category-axis-item/notes.icon.component.d.ts +16 -1
  39. package/chart/category-axis-item/notes.label.component.d.ts +18 -6
  40. package/chart/category-axis-item/range-labels.component.d.ts +1 -1
  41. package/chart/category-axis-item/select.component.d.ts +16 -6
  42. package/chart/category-axis-item/title.component.d.ts +22 -7
  43. package/chart/category-axis-item.component.d.ts +88 -12
  44. package/chart/category-axis.component.d.ts +5 -2
  45. package/chart/chart-area.component.d.ts +17 -6
  46. package/chart/donut-center-template.directive.d.ts +8 -1
  47. package/chart/legend/inactive-items.component.d.ts +5 -2
  48. package/chart/legend/item.component.d.ts +23 -2
  49. package/chart/legend.component.d.ts +52 -10
  50. package/chart/localization/custom-messages.component.d.ts +4 -2
  51. package/chart/no-data-template.directive.d.ts +8 -1
  52. package/chart/pane/title.component.d.ts +20 -7
  53. package/chart/pane-defaults/title.component.d.ts +17 -5
  54. package/chart/pane-defaults.component.d.ts +30 -3
  55. package/chart/pane.component.d.ts +24 -3
  56. package/chart/panes.component.d.ts +4 -1
  57. package/chart/plot-area.component.d.ts +9 -6
  58. package/chart/series-defaults/labels.component.d.ts +40 -6
  59. package/chart/series-defaults/labels.from.component.d.ts +18 -6
  60. package/chart/series-defaults/labels.to.component.d.ts +18 -6
  61. package/chart/series-defaults/notes.component.d.ts +26 -1
  62. package/chart/series-defaults/notes.icon.component.d.ts +12 -3
  63. package/chart/series-defaults/notes.label.component.d.ts +18 -6
  64. package/chart/series-defaults/tooltip.component.d.ts +16 -4
  65. package/chart/series-defaults.component.d.ts +47 -6
  66. package/chart/series-drilldown-template.directive.d.ts +5 -5
  67. package/chart/series-item/error-bars.component.d.ts +22 -4
  68. package/chart/series-item/extremes.component.d.ts +17 -8
  69. package/chart/series-item/highlight.component.d.ts +25 -4
  70. package/chart/series-item/labels.component.d.ts +53 -8
  71. package/chart/series-item/labels.from.component.d.ts +21 -6
  72. package/chart/series-item/labels.to.component.d.ts +21 -6
  73. package/chart/series-item/markers.component.d.ts +22 -4
  74. package/chart/series-item/notes.component.d.ts +21 -3
  75. package/chart/series-item/notes.icon.component.d.ts +12 -3
  76. package/chart/series-item/notes.label.component.d.ts +18 -6
  77. package/chart/series-item/outliers.component.d.ts +13 -4
  78. package/chart/series-item/tooltip.component.d.ts +18 -3
  79. package/chart/series-item/trendline.component.d.ts +35 -1
  80. package/chart/series-item/trendline.forecast.component.d.ts +8 -2
  81. package/chart/series-item.component.d.ts +200 -93
  82. package/chart/series.component.d.ts +4 -1
  83. package/chart/subtitle.component.d.ts +21 -6
  84. package/chart/title.component.d.ts +22 -7
  85. package/chart/tooltip/popup-settings.interface.d.ts +2 -2
  86. package/chart/tooltip/series-tooltip-template.directive.d.ts +1 -1
  87. package/chart/tooltip/shared-tooltip-template.directive.d.ts +2 -2
  88. package/chart/tooltip/tooltip-template-point.d.ts +15 -15
  89. package/chart/tooltip.component.d.ts +20 -5
  90. package/chart/value-axis-item/crosshair.component.d.ts +26 -4
  91. package/chart/value-axis-item/crosshair.tooltip.component.d.ts +16 -4
  92. package/chart/value-axis-item/labels.component.d.ts +13 -1
  93. package/chart/value-axis-item/notes.component.d.ts +34 -1
  94. package/chart/value-axis-item/notes.icon.component.d.ts +12 -3
  95. package/chart/value-axis-item/notes.label.component.d.ts +18 -6
  96. package/chart/value-axis-item/title.component.d.ts +22 -7
  97. package/chart/value-axis-item.component.d.ts +72 -10
  98. package/chart/value-axis.component.d.ts +4 -2
  99. package/chart/x-axis-item/crosshair.component.d.ts +26 -4
  100. package/chart/x-axis-item/crosshair.tooltip.component.d.ts +14 -5
  101. package/chart/x-axis-item/labels.component.d.ts +38 -8
  102. package/chart/x-axis-item/notes.component.d.ts +36 -3
  103. package/chart/x-axis-item/notes.icon.component.d.ts +12 -3
  104. package/chart/x-axis-item/notes.label.component.d.ts +18 -6
  105. package/chart/x-axis-item/title.component.d.ts +22 -7
  106. package/chart/x-axis-item.component.d.ts +92 -3
  107. package/chart/x-axis.component.d.ts +4 -1
  108. package/chart/y-axis-item/crosshair.component.d.ts +32 -1
  109. package/chart/y-axis-item/crosshair.tooltip.component.d.ts +22 -1
  110. package/chart/y-axis-item/labels.component.d.ts +32 -11
  111. package/chart/y-axis-item/notes.component.d.ts +34 -1
  112. package/chart/y-axis-item/notes.icon.component.d.ts +12 -3
  113. package/chart/y-axis-item/notes.label.component.d.ts +18 -6
  114. package/chart/y-axis-item/title.component.d.ts +22 -7
  115. package/chart/y-axis-item.component.d.ts +83 -7
  116. package/chart/y-axis.component.d.ts +4 -1
  117. package/chart/zoomable.component.d.ts +8 -1
  118. package/chart-breadcrumb.component.d.ts +4 -6
  119. package/chart-options.interface.d.ts +28 -28
  120. package/chart.component.d.ts +115 -71
  121. package/chart.module.d.ts +5 -4
  122. package/charts.module.d.ts +4 -4
  123. package/esm2022/chart/axis-defaults/crosshair.component.mjs +14 -5
  124. package/esm2022/chart/axis-defaults/crosshair.tooltip.component.mjs +14 -5
  125. package/esm2022/chart/axis-defaults/labels.component.mjs +18 -12
  126. package/esm2022/chart/axis-defaults/title.component.mjs +22 -7
  127. package/esm2022/chart/axis-defaults.component.mjs +57 -8
  128. package/esm2022/chart/category-axis-item/crosshair.component.mjs +14 -5
  129. package/esm2022/chart/category-axis-item/crosshair.tooltip.component.mjs +14 -5
  130. package/esm2022/chart/category-axis-item/labels.component.mjs +35 -15
  131. package/esm2022/chart/category-axis-item/notes.component.mjs +19 -1
  132. package/esm2022/chart/category-axis-item/notes.icon.component.mjs +16 -1
  133. package/esm2022/chart/category-axis-item/notes.label.component.mjs +18 -6
  134. package/esm2022/chart/category-axis-item/range-labels.component.mjs +1 -1
  135. package/esm2022/chart/category-axis-item/select.component.mjs +16 -6
  136. package/esm2022/chart/category-axis-item/title.component.mjs +22 -7
  137. package/esm2022/chart/category-axis-item.component.mjs +88 -12
  138. package/esm2022/chart/category-axis.component.mjs +5 -2
  139. package/esm2022/chart/chart-area.component.mjs +17 -6
  140. package/esm2022/chart/donut-center-template.directive.mjs +8 -1
  141. package/esm2022/chart/legend/inactive-items.component.mjs +5 -2
  142. package/esm2022/chart/legend/item.component.mjs +23 -2
  143. package/esm2022/chart/legend.component.mjs +52 -10
  144. package/esm2022/chart/localization/custom-messages.component.mjs +4 -2
  145. package/esm2022/chart/no-data-template.directive.mjs +8 -1
  146. package/esm2022/chart/pane/title.component.mjs +20 -7
  147. package/esm2022/chart/pane-defaults/title.component.mjs +17 -5
  148. package/esm2022/chart/pane-defaults.component.mjs +30 -3
  149. package/esm2022/chart/pane.component.mjs +24 -3
  150. package/esm2022/chart/panes.component.mjs +4 -1
  151. package/esm2022/chart/plot-area.component.mjs +9 -6
  152. package/esm2022/chart/series-defaults/labels.component.mjs +40 -6
  153. package/esm2022/chart/series-defaults/labels.from.component.mjs +18 -6
  154. package/esm2022/chart/series-defaults/labels.to.component.mjs +18 -6
  155. package/esm2022/chart/series-defaults/notes.component.mjs +26 -1
  156. package/esm2022/chart/series-defaults/notes.icon.component.mjs +12 -3
  157. package/esm2022/chart/series-defaults/notes.label.component.mjs +18 -6
  158. package/esm2022/chart/series-defaults/tooltip.component.mjs +16 -4
  159. package/esm2022/chart/series-defaults.component.mjs +47 -6
  160. package/esm2022/chart/series-drilldown-template.directive.mjs +5 -5
  161. package/esm2022/chart/series-item/error-bars.component.mjs +22 -4
  162. package/esm2022/chart/series-item/extremes.component.mjs +17 -8
  163. package/esm2022/chart/series-item/highlight.component.mjs +25 -4
  164. package/esm2022/chart/series-item/labels.component.mjs +53 -8
  165. package/esm2022/chart/series-item/labels.from.component.mjs +21 -6
  166. package/esm2022/chart/series-item/labels.to.component.mjs +21 -6
  167. package/esm2022/chart/series-item/markers.component.mjs +22 -4
  168. package/esm2022/chart/series-item/notes.component.mjs +21 -3
  169. package/esm2022/chart/series-item/notes.icon.component.mjs +12 -3
  170. package/esm2022/chart/series-item/notes.label.component.mjs +18 -6
  171. package/esm2022/chart/series-item/outliers.component.mjs +13 -4
  172. package/esm2022/chart/series-item/tooltip.component.mjs +18 -3
  173. package/esm2022/chart/series-item/trendline.component.mjs +35 -1
  174. package/esm2022/chart/series-item/trendline.forecast.component.mjs +8 -2
  175. package/esm2022/chart/series-item.component.mjs +200 -93
  176. package/esm2022/chart/series.component.mjs +4 -1
  177. package/esm2022/chart/subtitle.component.mjs +21 -6
  178. package/esm2022/chart/title.component.mjs +22 -7
  179. package/esm2022/chart/tooltip/series-tooltip-template.directive.mjs +1 -1
  180. package/esm2022/chart/tooltip/shared-tooltip-template.directive.mjs +2 -2
  181. package/esm2022/chart/tooltip/tooltip-template-point.mjs +15 -15
  182. package/esm2022/chart/tooltip.component.mjs +20 -5
  183. package/esm2022/chart/value-axis-item/crosshair.component.mjs +26 -4
  184. package/esm2022/chart/value-axis-item/crosshair.tooltip.component.mjs +16 -4
  185. package/esm2022/chart/value-axis-item/labels.component.mjs +13 -1
  186. package/esm2022/chart/value-axis-item/notes.component.mjs +34 -1
  187. package/esm2022/chart/value-axis-item/notes.icon.component.mjs +12 -3
  188. package/esm2022/chart/value-axis-item/notes.label.component.mjs +18 -6
  189. package/esm2022/chart/value-axis-item/title.component.mjs +22 -7
  190. package/esm2022/chart/value-axis-item.component.mjs +72 -10
  191. package/esm2022/chart/value-axis.component.mjs +4 -2
  192. package/esm2022/chart/x-axis-item/crosshair.component.mjs +26 -4
  193. package/esm2022/chart/x-axis-item/crosshair.tooltip.component.mjs +14 -5
  194. package/esm2022/chart/x-axis-item/labels.component.mjs +38 -8
  195. package/esm2022/chart/x-axis-item/notes.component.mjs +36 -3
  196. package/esm2022/chart/x-axis-item/notes.icon.component.mjs +12 -3
  197. package/esm2022/chart/x-axis-item/notes.label.component.mjs +18 -6
  198. package/esm2022/chart/x-axis-item/title.component.mjs +22 -7
  199. package/esm2022/chart/x-axis-item.component.mjs +92 -3
  200. package/esm2022/chart/x-axis.component.mjs +4 -1
  201. package/esm2022/chart/y-axis-item/crosshair.component.mjs +32 -1
  202. package/esm2022/chart/y-axis-item/crosshair.tooltip.component.mjs +22 -1
  203. package/esm2022/chart/y-axis-item/labels.component.mjs +32 -11
  204. package/esm2022/chart/y-axis-item/notes.component.mjs +34 -1
  205. package/esm2022/chart/y-axis-item/notes.icon.component.mjs +12 -3
  206. package/esm2022/chart/y-axis-item/notes.label.component.mjs +18 -6
  207. package/esm2022/chart/y-axis-item/title.component.mjs +22 -7
  208. package/esm2022/chart/y-axis-item.component.mjs +83 -7
  209. package/esm2022/chart/y-axis.component.mjs +4 -1
  210. package/esm2022/chart/zoomable.component.mjs +8 -1
  211. package/esm2022/chart-breadcrumb.component.mjs +4 -6
  212. package/esm2022/chart.component.mjs +115 -71
  213. package/esm2022/chart.module.mjs +5 -4
  214. package/esm2022/charts.module.mjs +4 -4
  215. package/esm2022/events/axis-label-click-event.mjs +7 -7
  216. package/esm2022/events/base-event.mjs +1 -1
  217. package/esm2022/events/drag-end-event.mjs +4 -4
  218. package/esm2022/events/drag-event.mjs +4 -4
  219. package/esm2022/events/drag-start-event.mjs +4 -4
  220. package/esm2022/events/drilldown-event.mjs +4 -6
  221. package/esm2022/events/legend-event.mjs +5 -5
  222. package/esm2022/events/legend-item-click-event.mjs +2 -2
  223. package/esm2022/events/legend-item-hover-event.mjs +2 -2
  224. package/esm2022/events/legend-item-leave-event.mjs +1 -1
  225. package/esm2022/events/note-click-event.mjs +1 -1
  226. package/esm2022/events/note-event.mjs +6 -5
  227. package/esm2022/events/note-hover-event.mjs +1 -1
  228. package/esm2022/events/note-leave-event.mjs +1 -1
  229. package/esm2022/events/pane-render-event.mjs +4 -4
  230. package/esm2022/events/plot-area-click-event.mjs +8 -6
  231. package/esm2022/events/plot-area-hover-event.mjs +8 -6
  232. package/esm2022/events/plot-area-leave-event.mjs +3 -0
  233. package/esm2022/events/preventable-event.mjs +2 -4
  234. package/esm2022/events/render-event.mjs +1 -1
  235. package/esm2022/events/select-end-event.mjs +4 -4
  236. package/esm2022/events/select-event.mjs +4 -4
  237. package/esm2022/events/select-start-event.mjs +4 -4
  238. package/esm2022/events/series-click-event.mjs +11 -10
  239. package/esm2022/events/series-event.mjs +10 -8
  240. package/esm2022/events/series-hover-event.mjs +1 -1
  241. package/esm2022/events/series-leave-event.mjs +1 -1
  242. package/esm2022/events/series-over-event.mjs +1 -1
  243. package/esm2022/events/zoom-end-event.mjs +5 -5
  244. package/esm2022/events/zoom-event.mjs +4 -4
  245. package/esm2022/events/zoom-start-event.mjs +4 -4
  246. package/esm2022/package-metadata.mjs +2 -2
  247. package/esm2022/sankey/data-binding/flat-binding.directive.mjs +5 -5
  248. package/esm2022/sankey/data-binding/flat-binding.event.mjs +4 -4
  249. package/esm2022/sankey/events/sankey-base-event.mjs +2 -2
  250. package/esm2022/sankey/events/sankey-link-event.mjs +2 -2
  251. package/esm2022/sankey/events/sankey-node-event.mjs +2 -2
  252. package/esm2022/sankey/labels.component.mjs +1 -1
  253. package/esm2022/sankey/legend.component.mjs +12 -12
  254. package/esm2022/sankey/links.component.mjs +1 -1
  255. package/esm2022/sankey/localization/custom-messages.component.mjs +4 -1
  256. package/esm2022/sankey/localization/messages.mjs +1 -1
  257. package/esm2022/sankey/nodes.component.mjs +5 -6
  258. package/esm2022/sankey/title.component.mjs +9 -9
  259. package/esm2022/sankey/tooltip/link-tooltip-template-context.mjs +4 -4
  260. package/esm2022/sankey/tooltip/link-tooltip-template.directive.mjs +10 -55
  261. package/esm2022/sankey/tooltip/node-tooltip-template-context.mjs +4 -4
  262. package/esm2022/sankey/tooltip/node-tooltip-template.directive.mjs +2 -2
  263. package/esm2022/sankey/tooltip.component.mjs +5 -5
  264. package/esm2022/sankey.component.mjs +60 -32
  265. package/esm2022/sankey.module.mjs +7 -7
  266. package/esm2022/sparkline.component.mjs +22 -7
  267. package/esm2022/sparkline.module.mjs +5 -5
  268. package/esm2022/stock-chart/navigator/category-axis/crosshair.component.mjs +4 -1
  269. package/esm2022/stock-chart/navigator/category-axis/crosshair.tooltip.component.mjs +2 -2
  270. package/esm2022/stock-chart/navigator/category-axis/labels.component.mjs +1 -1
  271. package/esm2022/stock-chart/navigator/category-axis/notes.component.mjs +16 -1
  272. package/esm2022/stock-chart/navigator/category-axis/notes.icon.component.mjs +1 -1
  273. package/esm2022/stock-chart/navigator/category-axis/notes.label.component.mjs +1 -1
  274. package/esm2022/stock-chart/navigator/category-axis/select.component.mjs +10 -4
  275. package/esm2022/stock-chart/navigator/category-axis/title.component.mjs +1 -1
  276. package/esm2022/stock-chart/navigator/category-axis.component.mjs +6 -2
  277. package/esm2022/stock-chart/navigator/hint.component.mjs +1 -1
  278. package/esm2022/stock-chart/navigator/pane/title.component.mjs +1 -1
  279. package/esm2022/stock-chart/navigator/pane.component.mjs +1 -1
  280. package/esm2022/stock-chart/navigator/series-item/error-bars.component.mjs +15 -1
  281. package/esm2022/stock-chart/navigator/series-item/extremes.component.mjs +2 -1
  282. package/esm2022/stock-chart/navigator/series-item/highlight.component.mjs +1 -1
  283. package/esm2022/stock-chart/navigator/series-item/labels.component.mjs +18 -1
  284. package/esm2022/stock-chart/navigator/series-item/labels.from.component.mjs +1 -1
  285. package/esm2022/stock-chart/navigator/series-item/labels.to.component.mjs +1 -1
  286. package/esm2022/stock-chart/navigator/series-item/markers.component.mjs +1 -1
  287. package/esm2022/stock-chart/navigator/series-item/notes.component.mjs +18 -1
  288. package/esm2022/stock-chart/navigator/series-item/notes.icon.component.mjs +1 -1
  289. package/esm2022/stock-chart/navigator/series-item/notes.label.component.mjs +1 -1
  290. package/esm2022/stock-chart/navigator/series-item/outliers.component.mjs +2 -1
  291. package/esm2022/stock-chart/navigator/series-item/tooltip.component.mjs +2 -2
  292. package/esm2022/stock-chart/navigator/series-item.component.mjs +17 -1
  293. package/esm2022/stock-chart/navigator/series.component.mjs +5 -3
  294. package/esm2022/stock-chart/navigator.component.mjs +5 -3
  295. package/esm2022/stock-chart.component.mjs +42 -19
  296. package/esm2022/stock-chart.module.mjs +5 -5
  297. package/events/axis-label-click-event.d.ts +7 -7
  298. package/events/base-event.d.ts +1 -1
  299. package/events/drag-end-event.d.ts +4 -4
  300. package/events/drag-event.d.ts +4 -4
  301. package/events/drag-start-event.d.ts +4 -4
  302. package/events/drilldown-event.d.ts +4 -6
  303. package/events/legend-event.d.ts +5 -5
  304. package/events/legend-item-click-event.d.ts +2 -2
  305. package/events/legend-item-hover-event.d.ts +2 -2
  306. package/events/legend-item-leave-event.d.ts +1 -1
  307. package/events/note-click-event.d.ts +1 -1
  308. package/events/note-event.d.ts +6 -5
  309. package/events/note-hover-event.d.ts +1 -1
  310. package/events/note-leave-event.d.ts +1 -1
  311. package/events/pane-render-event.d.ts +4 -4
  312. package/events/plot-area-click-event.d.ts +8 -6
  313. package/events/plot-area-hover-event.d.ts +8 -6
  314. package/events/plot-area-leave-event.d.ts +3 -0
  315. package/events/preventable-event.d.ts +2 -4
  316. package/events/render-event.d.ts +1 -1
  317. package/events/select-end-event.d.ts +4 -4
  318. package/events/select-event.d.ts +4 -4
  319. package/events/select-start-event.d.ts +4 -4
  320. package/events/series-click-event.d.ts +11 -10
  321. package/events/series-event.d.ts +10 -8
  322. package/events/series-hover-event.d.ts +1 -1
  323. package/events/series-leave-event.d.ts +1 -1
  324. package/events/series-over-event.d.ts +1 -1
  325. package/events/zoom-end-event.d.ts +5 -5
  326. package/events/zoom-event.d.ts +4 -4
  327. package/events/zoom-start-event.d.ts +4 -4
  328. package/fesm2022/progress-kendo-angular-charts.mjs +2728 -925
  329. package/field-types/auto-base-unit-steps.interface.d.ts +10 -10
  330. package/field-types/axis-labels-position.d.ts +5 -5
  331. package/field-types/axis-line.interface.d.ts +7 -6
  332. package/field-types/axis-ticks.interface.d.ts +7 -7
  333. package/field-types/axis-title-position.d.ts +6 -6
  334. package/field-types/base-unit.d.ts +9 -9
  335. package/field-types/border.interface.d.ts +5 -5
  336. package/field-types/bullet-target-line.interface.d.ts +2 -2
  337. package/field-types/bullet-target.interface.d.ts +4 -4
  338. package/field-types/category-base-unit.d.ts +4 -4
  339. package/field-types/dash-type.d.ts +8 -8
  340. package/field-types/date-formats.interface.d.ts +10 -10
  341. package/field-types/drag-action.interface.d.ts +1 -1
  342. package/field-types/error-bar-line.interface.d.ts +3 -3
  343. package/field-types/grid-lines.interface.d.ts +7 -7
  344. package/field-types/highlight-line.interface.d.ts +6 -6
  345. package/field-types/label-connectors.interface.d.ts +4 -4
  346. package/field-types/label-rotation.interface.d.ts +8 -8
  347. package/field-types/legend-labels.interface.d.ts +6 -6
  348. package/field-types/line-style.d.ts +4 -4
  349. package/field-types/lock-axis.d.ts +3 -3
  350. package/field-types/margin.interface.d.ts +5 -5
  351. package/field-types/marker-type.d.ts +6 -6
  352. package/field-types/modifier-key.d.ts +4 -4
  353. package/field-types/mousewheel-select.interface.d.ts +4 -4
  354. package/field-types/mousewheel-zoom.interface.d.ts +2 -2
  355. package/field-types/negative-bubble-values.interface.d.ts +3 -3
  356. package/field-types/note-label-position.d.ts +3 -3
  357. package/field-types/note-line.interface.d.ts +5 -5
  358. package/field-types/note-position.d.ts +4 -4
  359. package/field-types/overlay.interface.d.ts +3 -3
  360. package/field-types/padding.interface.d.ts +1 -1
  361. package/field-types/plot-band-label.interface.d.ts +16 -16
  362. package/field-types/plot-band.interface.d.ts +6 -6
  363. package/field-types/series-labels-alignment.d.ts +7 -7
  364. package/field-types/series-labels-position.d.ts +12 -12
  365. package/field-types/series-line.interface.d.ts +5 -5
  366. package/field-types/series-mean.interface.d.ts +5 -5
  367. package/field-types/series-median.interface.d.ts +5 -5
  368. package/field-types/series-stack.interface.d.ts +5 -5
  369. package/field-types/series-type.d.ts +39 -39
  370. package/field-types/series-whiskers.interface.d.ts +5 -5
  371. package/field-types/trendline-forecast.interface.d.ts +3 -3
  372. package/option-types/axis-defaults/crosshair.interface.d.ts +7 -7
  373. package/option-types/axis-defaults/crosshair.tooltip.interface.d.ts +1 -1
  374. package/option-types/axis-defaults/labels.interface.d.ts +15 -17
  375. package/option-types/axis-defaults/title.interface.d.ts +12 -12
  376. package/option-types/axis-defaults.interface.d.ts +21 -18
  377. package/option-types/category-axis-item/crosshair.interface.d.ts +9 -10
  378. package/option-types/category-axis-item/crosshair.tooltip.interface.d.ts +1 -1
  379. package/option-types/category-axis-item/labels.interface.d.ts +23 -24
  380. package/option-types/category-axis-item/notes.icon.interface.d.ts +6 -6
  381. package/option-types/category-axis-item/notes.interface.d.ts +7 -7
  382. package/option-types/category-axis-item/notes.label.interface.d.ts +11 -11
  383. package/option-types/category-axis-item/range-labels.interface.d.ts +3 -3
  384. package/option-types/category-axis-item/select.interface.d.ts +9 -10
  385. package/option-types/category-axis-item/title.interface.d.ts +13 -13
  386. package/option-types/category-axis-item.interface.d.ts +49 -65
  387. package/option-types/chart-area.interface.d.ts +7 -7
  388. package/option-types/legend/inactive-items.interface.d.ts +2 -2
  389. package/option-types/legend/item.interface.d.ts +19 -19
  390. package/option-types/legend/legend-title.interface.d.ts +13 -12
  391. package/option-types/legend/markers.interface.d.ts +7 -7
  392. package/option-types/legend.interface.d.ts +22 -22
  393. package/option-types/pane/title.interface.d.ts +12 -11
  394. package/option-types/pane-defaults/title.interface.d.ts +11 -10
  395. package/option-types/pane-defaults.interface.d.ts +7 -7
  396. package/option-types/pane.interface.d.ts +12 -9
  397. package/option-types/plot-area.interface.d.ts +7 -7
  398. package/option-types/series-defaults/labels.from.interface.d.ts +11 -11
  399. package/option-types/series-defaults/labels.interface.d.ts +17 -19
  400. package/option-types/series-defaults/labels.to.interface.d.ts +11 -11
  401. package/option-types/series-defaults/notes.icon.interface.d.ts +6 -6
  402. package/option-types/series-defaults/notes.interface.d.ts +5 -5
  403. package/option-types/series-defaults/notes.label.interface.d.ts +11 -11
  404. package/option-types/series-defaults/tooltip.interface.d.ts +14 -14
  405. package/option-types/series-defaults.interface.d.ts +15 -15
  406. package/option-types/series-item/error-bars.interface.d.ts +11 -11
  407. package/option-types/series-item/extremes.interface.d.ts +6 -6
  408. package/option-types/series-item/highlight.interface.d.ts +18 -17
  409. package/option-types/series-item/labels.from.interface.d.ts +17 -12
  410. package/option-types/series-item/labels.interface.d.ts +19 -19
  411. package/option-types/series-item/labels.to.interface.d.ts +20 -15
  412. package/option-types/series-item/markers-highlight.interface.d.ts +5 -4
  413. package/option-types/series-item/markers.interface.d.ts +10 -10
  414. package/option-types/series-item/notes.icon.interface.d.ts +6 -6
  415. package/option-types/series-item/notes.interface.d.ts +6 -6
  416. package/option-types/series-item/notes.label.interface.d.ts +14 -11
  417. package/option-types/series-item/outliers.interface.d.ts +6 -6
  418. package/option-types/series-item/tooltip.interface.d.ts +19 -13
  419. package/option-types/series-item/trendline.interface.d.ts +12 -14
  420. package/option-types/series-item.interface.d.ts +181 -200
  421. package/option-types/subtitle.interface.d.ts +14 -14
  422. package/option-types/title.interface.d.ts +16 -16
  423. package/option-types/tooltip-border.interface.d.ts +1 -1
  424. package/option-types/tooltip.interface.d.ts +10 -10
  425. package/option-types/value-axis-item/crosshair.interface.d.ts +9 -8
  426. package/option-types/value-axis-item/crosshair.tooltip.interface.d.ts +1 -1
  427. package/option-types/value-axis-item/labels.interface.d.ts +16 -16
  428. package/option-types/value-axis-item/notes.icon.interface.d.ts +6 -6
  429. package/option-types/value-axis-item/notes.interface.d.ts +7 -7
  430. package/option-types/value-axis-item/notes.label.interface.d.ts +15 -12
  431. package/option-types/value-axis-item/title.interface.d.ts +11 -11
  432. package/option-types/value-axis-item.interface.d.ts +37 -34
  433. package/option-types/x-axis-item/crosshair.interface.d.ts +6 -6
  434. package/option-types/x-axis-item/crosshair.tooltip.interface.d.ts +1 -1
  435. package/option-types/x-axis-item/labels.interface.d.ts +20 -19
  436. package/option-types/x-axis-item/notes.icon.interface.d.ts +6 -6
  437. package/option-types/x-axis-item/notes.interface.d.ts +7 -7
  438. package/option-types/x-axis-item/notes.label.interface.d.ts +15 -13
  439. package/option-types/x-axis-item/title.interface.d.ts +11 -11
  440. package/option-types/x-axis-item.interface.d.ts +4 -4
  441. package/option-types/y-axis-item/crosshair.interface.d.ts +8 -6
  442. package/option-types/y-axis-item/crosshair.tooltip.interface.d.ts +1 -1
  443. package/option-types/y-axis-item/labels.interface.d.ts +18 -18
  444. package/option-types/y-axis-item/notes.icon.interface.d.ts +6 -6
  445. package/option-types/y-axis-item/notes.interface.d.ts +7 -7
  446. package/option-types/y-axis-item/notes.label.interface.d.ts +15 -12
  447. package/option-types/y-axis-item/title.interface.d.ts +11 -11
  448. package/option-types/y-axis-item.interface.d.ts +3 -3
  449. package/option-types/zoomable.interface.d.ts +3 -3
  450. package/package.json +9 -9
  451. package/sankey/data-binding/flat-binding.directive.d.ts +5 -5
  452. package/sankey/data-binding/flat-binding.event.d.ts +4 -4
  453. package/sankey/events/sankey-base-event.d.ts +2 -2
  454. package/sankey/events/sankey-link-event.d.ts +2 -2
  455. package/sankey/events/sankey-node-event.d.ts +2 -2
  456. package/sankey/labels.component.d.ts +1 -1
  457. package/sankey/legend.component.d.ts +12 -12
  458. package/sankey/links.component.d.ts +1 -1
  459. package/sankey/localization/custom-messages.component.d.ts +4 -1
  460. package/sankey/localization/messages.d.ts +1 -1
  461. package/sankey/nodes.component.d.ts +5 -6
  462. package/sankey/title.component.d.ts +9 -9
  463. package/sankey/tooltip/link-tooltip-template-context.d.ts +4 -4
  464. package/sankey/tooltip/link-tooltip-template.directive.d.ts +10 -55
  465. package/sankey/tooltip/node-tooltip-template-context.d.ts +4 -4
  466. package/sankey/tooltip/node-tooltip-template.directive.d.ts +2 -2
  467. package/sankey/tooltip.component.d.ts +5 -5
  468. package/sankey.component.d.ts +60 -32
  469. package/sankey.module.d.ts +7 -7
  470. package/sparkline.component.d.ts +22 -7
  471. package/sparkline.module.d.ts +5 -5
  472. package/stock-chart/navigator/category-axis/crosshair.component.d.ts +4 -1
  473. package/stock-chart/navigator/category-axis/crosshair.tooltip.component.d.ts +2 -2
  474. package/stock-chart/navigator/category-axis/labels.component.d.ts +1 -1
  475. package/stock-chart/navigator/category-axis/notes.component.d.ts +16 -1
  476. package/stock-chart/navigator/category-axis/notes.icon.component.d.ts +1 -1
  477. package/stock-chart/navigator/category-axis/notes.label.component.d.ts +1 -1
  478. package/stock-chart/navigator/category-axis/select.component.d.ts +10 -4
  479. package/stock-chart/navigator/category-axis/title.component.d.ts +1 -1
  480. package/stock-chart/navigator/category-axis.component.d.ts +6 -2
  481. package/stock-chart/navigator/hint.component.d.ts +1 -1
  482. package/stock-chart/navigator/pane/title.component.d.ts +1 -1
  483. package/stock-chart/navigator/pane.component.d.ts +1 -1
  484. package/stock-chart/navigator/series-item/error-bars.component.d.ts +15 -1
  485. package/stock-chart/navigator/series-item/extremes.component.d.ts +2 -1
  486. package/stock-chart/navigator/series-item/highlight.component.d.ts +1 -1
  487. package/stock-chart/navigator/series-item/labels.component.d.ts +18 -1
  488. package/stock-chart/navigator/series-item/labels.from.component.d.ts +1 -1
  489. package/stock-chart/navigator/series-item/labels.to.component.d.ts +1 -1
  490. package/stock-chart/navigator/series-item/markers.component.d.ts +1 -1
  491. package/stock-chart/navigator/series-item/notes.component.d.ts +18 -1
  492. package/stock-chart/navigator/series-item/notes.icon.component.d.ts +1 -1
  493. package/stock-chart/navigator/series-item/notes.label.component.d.ts +1 -1
  494. package/stock-chart/navigator/series-item/outliers.component.d.ts +2 -1
  495. package/stock-chart/navigator/series-item/tooltip.component.d.ts +2 -2
  496. package/stock-chart/navigator/series-item.component.d.ts +17 -1
  497. package/stock-chart/navigator/series.component.d.ts +5 -3
  498. package/stock-chart/navigator.component.d.ts +5 -3
  499. package/stock-chart/option-types/navigator/hint-content-args.interface.d.ts +3 -3
  500. package/stock-chart/option-types/navigator/hint.interface.d.ts +5 -4
  501. package/stock-chart/option-types/navigator/select.interface.d.ts +5 -5
  502. package/stock-chart/option-types/navigator.interface.d.ts +6 -6
  503. package/stock-chart.component.d.ts +42 -19
  504. package/stock-chart.module.d.ts +5 -5
@@ -17,528 +17,509 @@ import { LineStyle, SeriesStack, SeriesVisualArgs } from '../common/property-typ
17
17
  import { SeriesMedian } from '../field-types/series-median.interface';
18
18
  import { SeriesPattern } from '@progress/kendo-charts';
19
19
  /**
20
- * The configuration options of the series.
20
+ * Represents the configuration options of the series.
21
21
  */
22
22
  export interface Series {
23
23
  /**
24
- * The aggregate function for the date series.
25
- * The function is used when a category (year, month, or other) contains two or more points.
24
+ * Specifies the aggregate function for the date series.
25
+ * Apply this function when a category (year, month, or other) contains two or more points.
26
26
  * The Chart displays the return value of the function instead of the individual points.
27
- * The `aggregate` option is supported for categorical chart axis only.
27
+ * This option is supported for Categorical Chart axis only.
28
28
  *
29
- * The supported values are:
30
- * - `"avg"`—The average of all values for the date period.
31
- * - `"count"`—The number of values for the date period.
32
- * - `"max"`—The highest value for the date period.
33
- * - `"min"`—The lowest value for the date period.
34
- * - `"sum"`—The sum of all values for the date period. Defaults to `0` if no data points are defined.
35
- * - `"sumOrNull"`—The sum of all values for the date period. Defaults to `null` if no data points are
29
+ * Aggregate functions support the following values:
30
+ * - `"avg"`—Calculates the average of all values for the date period.
31
+ * - `"count"`—Counts the number of values for the date period.
32
+ * - `"max"`—Finds the highest value for the date period.
33
+ * - `"min"`—Finds the lowest value for the date period.
34
+ * - `"sum"`—Sums all values for the date period. Uses `0` when no data points are defined.
35
+ * - `"sumOrNull"`—Sums all values for the date period. Uses `null` when no data points are
36
36
  * defined.
37
- * - `"first"`—The first value.
38
- * - function (values, series, dataItems, category)—A user-defined aggregate function. Returns a single
37
+ * - `"first"`—Uses the first value.
38
+ * - function (values, series, dataItems, category)—A user-defined aggregate function that returns a single
39
39
  * value or a data item.
40
- * - object (compound aggregate)—Applicable to the Candlestick, Box Plot, and OHLC series.
41
- * Specifies the aggregate for each data item field.
40
+ * - object (compound aggregate)—Applies to the Candlestick, Box Plot, and OHLC series.
41
+ * Sets the aggregate for each data item field.
42
42
  */
43
43
  aggregate?: any;
44
44
  /**
45
- * If set to `true`, the Chart automatically scales down to fit the content area.
45
+ * Determines whether the Chart automatically scales down to fit the content area.
46
46
  * Applicable for the Pie and Donut series. ([See example](slug:donut_seriestypes_charts#displaying-labels-in-angular-donut-chart))
47
47
  */
48
48
  autoFit?: boolean;
49
49
  /**
50
- * The name of the value axis.
51
- * The axis option is supported for Scatter plots. For more information on Scatter plots, refer to
50
+ * Specifies the name of the value axis.
51
+ * This option is supported for Scatter plots. For more information on Scatter plots, refer to
52
52
  * [`xAxis`]({% slug api_charts_xaxis %}) and [`yAxis`]({% slug api_charts_yaxis %}).
53
53
  */
54
54
  axis?: string;
55
55
  /**
56
- * The border of the Chart series.
57
- * The border option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
56
+ * Specifies the border of the Chart series.
57
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
58
58
  * `"bar"`, `"column"`, `"donut"`, `"pie"`, `"bubble"`, `"boxPlot"`, `"candlestick"`, or `"ohlc"`.
59
59
  */
60
60
  border?: Border;
61
61
  /**
62
- * The name of the category axis that will be used for the series.
63
- * If no [`categoryAxis`]({% slug api_charts_categoryaxis %}) is specified, the first axis is used.
62
+ * Specifies the name of the category axis that the series uses.
63
+ * If you do not specify a [`categoryAxis`]({% slug api_charts_categoryaxis %}), the Chart uses the first axis.
64
64
  */
65
65
  categoryAxis?: string;
66
66
  /**
67
- * The data item field which contains the category name or date.
68
- * If the category is a date, the points are rendered in chronological order.
67
+ * Specifies the data item field which contains the category name or date.
68
+ * When the category is a date, renders the points in chronological order.
69
69
  */
70
70
  categoryField?: string;
71
71
  /**
72
- * The data field that contains the `close` value.
73
- * The `closeField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
72
+ * Specifies the data field that contains the `close` value.
73
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
74
74
  */
75
75
  closeField?: string;
76
76
  /**
77
- * The series base color.
77
+ * Specifies the series base color.
78
78
  *
79
- * The supported values are CSS color string (including HEX and RGB) and function (point). The function, which is user-defined and evaluated for each point, assumes the default series color when it returns `undefined`.
79
+ * Accepts CSS color string (including HEX and RGB) and function (point). The function, which is user-defined and evaluated for each point, assumes the default series color when it returns `undefined`.
80
80
  */
81
81
  color?: any;
82
82
  /**
83
- * The data item field which contains the series color.
84
- * The `colorField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type)
83
+ * Specifies the data item field which contains the series color.
84
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type)
85
85
  * is set to `"bar"`, `"column"`, `"rangeBar"`, `"rangeColumn"`, `"bubble"`, `"donut"`, `"pie"`, `"candlestick"`,
86
86
  * `"ohlc"`, or `"waterfall"`.
87
87
  */
88
88
  colorField?: string;
89
89
  /**
90
- * The label connectors options.
91
- * The connectors option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"` and
90
+ * Specifies the label connectors options.
91
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"` and
92
92
  * [`series.labels.visible`]({% slug api_charts_serieslabels %}#toc-visible) is set to `true`.
93
93
  */
94
94
  connectors?: LabelConnectors;
95
95
  /**
96
- * The data item field which contains the current value.
97
- * The `currentField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bullet"` or `"verticalBullet"`.
96
+ * Specifies the data item field which contains the current value.
97
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bullet"` or `"verticalBullet"`.
98
98
  */
99
99
  currentField?: string;
100
100
  /**
101
- * The dash type of line Chart.
102
- * The `dashType` option is considered only if the [`series.type`]({% slug api_charts_series %}#toc-type) option is set to `"line"`.
101
+ * Specifies the dash type of line Chart.
102
+ * Use this option only when the [`series.type`]({% slug api_charts_series %}#toc-type) option is set to `"line"`.
103
103
  */
104
104
  dashType?: DashType;
105
105
  /**
106
- * The array of data items which represent the series data.
106
+ * Specifies the array of data items which represent the series data.
107
107
  *
108
108
  * You can set it to:
109
109
  * - Array of objects. Each point is bound to the field specified through the [`series.field`]({% slug api_charts_series %}#toc-field) option.
110
110
  * - Array of numbers. Supported when the [`series.type`]({% slug api_charts_series %}#toc-type) option is set to `"area"`, `"bar"`, `"column"`, `"donut"`, `"pie"`, `"line"`, or `"waterfall"`.
111
111
  * - Array of arrays of numbers. Supported when the [`series.type`]({% slug api_charts_series %}#toc-type) option is set to `"bubble"`, `"scatter"`, `"scatterLine"`, `"ohlc"`, `"polar"`, `"rangeBar"`, or `"rangeArea"`.
112
112
  *
113
- * The Bubble series need arrays of three values—X value, Y value, and Size value—for example, `[1, 1, 10]`.
113
+ * Bubble series need arrays of three values—X value, Y value, and Size value—for example, `[1, 1, 10]`.
114
114
  *
115
- * The Scatter and ScatterLine series need arrays of two values—X value and Y value.
115
+ * Scatter and ScatterLine series need arrays of two values—X value and Y value.
116
116
  *
117
- * The OHLC and Candlestick series need arrays of four values—open, high, low, and close.
117
+ * OHLC and Candlestick series need arrays of four values—open, high, low, and close.
118
118
  *
119
- * The RangeBar and RangeArea series need arrays of two values—the from and to value.
119
+ * RangeBar and RangeArea series need arrays of two values—the from and to value.
120
120
  */
121
121
  data?: any[];
122
122
  /**
123
- * The series color when the open value is greater than the close value.
124
- * The `downColor` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"`.
123
+ * Specifies the series color when the open value is greater than the close value.
124
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"`.
125
125
  */
126
126
  downColor?: string;
127
127
  /**
128
- * The data field which contains the color that is applied when the `open` value is greater than the `close` value.
129
- * The `downColorField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"`.
128
+ * Specifies the data field which contains the color that applies when the `open` value is greater than the `close` value.
129
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"`.
130
130
  */
131
131
  downColorField?: string;
132
132
  /**
133
- * The data field which contains the value to use to [drill down]({% slug drilldown_chart_charts %}) into detailed data for the point.
133
+ * Specifies the data field which contains the value to use to [drill down]({% slug drilldown_chart_charts %}) into detailed data for the point.
134
134
  */
135
135
  drilldownField?: string;
136
136
  /**
137
- * The `dynamicHeight` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
138
- * When set to `false`, all segments become with the same height.
139
- * Otherwise, the height of each segment is based on its value.
137
+ * Determines whether the segments have the same height.
138
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
139
+ * Setting it to `false` makes all segments have the same height.
140
+ * Setting it to `true` bases the height of each segment on its value.
140
141
  */
141
142
  dynamicHeight?: boolean;
142
143
  /**
143
- * The `dynamicSlope` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`.
144
- * When set to `true`, the ratio of the bases of each segment is calculated based on the ratio of
144
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`.
145
+ * Setting it to `true` makes the ratio of the bases of each segment calculate based on the ratio of
145
146
  * `currentDataItem.value`/`nextDataItem.value`.
146
- * The last element is always created like a rectangle since there is no following element.
147
+ * Charts always create the last element as a rectangle since there is no following element.
147
148
  */
148
149
  dynamicSlope?: boolean;
149
150
  /**
150
- * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) high value.
151
- * The `errorHighField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
151
+ * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) high value.
152
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
152
153
  */
153
154
  errorHighField?: string;
154
155
  /**
155
- * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) low value.
156
- * The `errorLowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
156
+ * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) low value.
157
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
157
158
  */
158
159
  errorLowField?: string;
159
160
  /**
160
- * The data item field which contains a Boolean value indicating whether the sector is exploded.
161
- * The `explodeField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
161
+ * Specifies the data item field which contains a Boolean value indicating whether the sector is exploded.
162
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
162
163
  */
163
164
  explodeField?: string;
164
165
  /**
165
- * The data item field which contains the series value.
166
+ * Specifies the data item field which contains the series value.
166
167
  */
167
168
  field?: string;
168
169
  /**
169
- * The name of the parent series of the trendline.
170
+ * Specifies the name of the parent series of the trendline.
170
171
  *
171
- * The `for` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
172
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
172
173
  * "`linearTrendline`", "`exponentialTrendline`", "`logarithmicTrendline`", "`powerTrendline`", "`polynomialTrendline`" or "`movingAverageTrendline`".
173
174
  */
174
175
  for?: string;
175
176
  /**
176
- * The data item field which contains the series from value.
177
+ * Specifies the data item field which contains the series from value.
177
178
  */
178
179
  fromField?: string;
179
180
  /**
180
- * The distance between the categories expressed as a percentage of the bar width.
181
+ * Specifies the distance between the categories expressed as a percentage of the bar width.
181
182
  * See the related spacing setting.
182
- * The `gap` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
183
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
183
184
  * `"radarColumn"`, or `"waterfall"`.
184
185
  */
185
186
  gap?: number;
186
187
  /**
187
- * The data field which contains the high value.
188
- * The `highField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
188
+ * Specifies the data field which contains the high value.
189
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
189
190
  */
190
191
  highField?: string;
191
192
  /**
192
- * The diameter of the donut hole in pixels.
193
- * The `holeSize` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"`.
193
+ * Specifies the diameter of the donut hole in pixels.
194
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"`.
194
195
  */
195
196
  holeSize?: number;
196
197
  /**
197
- * The Chart line configuration options.
198
- * The line option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"area"`, `"candlestick"`, `"ohlc"`, or
198
+ * Specifies the Chart line configuration options.
199
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"area"`, `"candlestick"`, `"ohlc"`, or
199
200
  * `"waterfall"`.
200
201
  */
201
202
  line?: SeriesLine;
202
203
  /**
203
- * The data field containing the low value.
204
- * The `lowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
204
+ * Specifies the data field containing the low value.
205
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
205
206
  */
206
207
  lowField?: string;
207
208
  /**
208
- * The data item field which contains the series lower value.
209
- * The `lowerField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
209
+ * Specifies the data item field which contains the series lower value.
210
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
210
211
  */
211
212
  lowerField?: string;
212
213
  /**
213
- * The margin around each donut series (ring). A numeric value sets all margins.
214
+ * Specifies the margin around each donut series (ring). A numeric value sets all margins.
214
215
  */
215
216
  margin?: Margin | number;
216
217
  /**
217
- * The maximum size of the Chart bubble series marker.
218
+ * Specifies the maximum size of the Chart bubble series marker.
218
219
  */
219
220
  maxSize?: number;
220
221
  /**
221
- * The configuration of the mean value indicator (line) for [Box Plot series]({% slug boxplot_seriestypes_charts %}).
222
- * The `mean` option is not supported by other series types.
222
+ * Specifies the configuration of the mean value indicator (line) for [Box Plot series]({% slug boxplot_seriestypes_charts %}).
223
+ * This option is not supported by other series types.
223
224
  */
224
225
  mean?: SeriesMedian;
225
226
  /**
226
- * The data item field which contains the series mean value.
227
- * The `meanField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
227
+ * Specifies the data item field which contains the series mean value.
228
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
228
229
  */
229
230
  meanField?: string;
230
231
  /**
231
- * The configuration of the median value indicator (line) for [Box Plot series]({% slug boxplot_seriestypes_charts %}).
232
- * The `median` option is not supported by other series types.
232
+ * Specifies the configuration of the median value indicator (line) for [Box Plot series]({% slug boxplot_seriestypes_charts %}).
233
+ * This option is not supported by other series types.
233
234
  */
234
235
  median?: SeriesMedian;
235
236
  /**
236
- * The data item field which contains the series median value.
237
- * The `medianField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
237
+ * Specifies the data item field which contains the series median value.
238
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
238
239
  */
239
240
  medianField?: string;
240
241
  /**
241
- * The minimum size of the Chart bubble series marker.
242
+ * Specifies the minimum size of the Chart bubble series marker.
242
243
  */
243
244
  minSize?: number;
244
245
  /**
245
- * The behavior for handling missing values.
246
- * The `missingValues` option is available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatterLine"`,
246
+ * Specifies the behavior for handling missing values.
247
+ * This option is available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatterLine"`,
247
248
  * `"radarLine"`, `"radarArea"`, `"polarLine"`, or `"polarArea"`.
248
249
  *
249
- * The supported values are:
250
+ * Supports the following values:
250
251
  * - `"gap"`—The plot stops before the missing point and continues after it.
251
- * - `"interpolate"`—The value is interpolated from neighboring points. Represents the default value for all series except for the `"area"` and stacked series. Area and stacked series default to `"zero"`.
252
- * - `"zero"`—The value is assumed to be zero.
252
+ * - `"interpolate"`—Interpolates the value from neighboring points. Represents the default value for all series except for the `"area"` and stacked series. Area and stacked series default to `"zero"`.
253
+ * - `"zero"`—Assumes the value to be zero.
253
254
  */
254
255
  missingValues?: 'gap' | 'interpolate' | 'zero';
255
256
  /**
256
- * The name of the Chart series which is visible in the legend.
257
+ * Specifies the name of the Chart series which is visible in the legend.
257
258
  */
258
259
  name?: string;
259
260
  /**
260
261
  * Specifies the top-base/bottom-base ratio of the whole Funnel Chart. If the `neckRatio` is set to `3`,
261
262
  * it means the top base is three times smaller than the bottom base.
262
- * The `neckRatio` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` and `dynamicSlope` is set to `false`.
263
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` and `dynamicSlope` is set to `false`.
263
264
  */
264
265
  neckRatio?: number;
265
266
  /**
266
- * The color to use for the Bar, Column, or Waterfall series with negative values.
267
- * Accepts a valid CSS color string, including HEX and RGB.
267
+ * Specifies the color to use for the Bar, Column, or Waterfall series with negative values.
268
+ * Accepts valid CSS color string, including HEX and RGB.
268
269
  */
269
270
  negativeColor?: string;
270
271
  /**
271
- * The options for displaying the Chart negative bubble values.
272
+ * Specifies the options for displaying the Chart negative bubble values.
272
273
  */
273
274
  negativeValues?: NegativeBubbleValues;
274
275
  /**
275
- * The data item field which contains the series note text.
276
+ * Specifies the data item field which contains the series note text.
276
277
  */
277
278
  noteTextField?: string;
278
279
  /**
279
- * The opacity of the series. By default, the series are opaque.
280
+ * Specifies the opacity of the series. Series are opaque by default.
280
281
  */
281
282
  opacity?: number;
282
283
  /**
283
- * The data field which contains the open value.
284
- * The `openField` option is available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
284
+ * Specifies the data field which contains the open value.
285
+ * This option is available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
285
286
  */
286
287
  openField?: string;
287
288
  /**
288
- * The data item field which contains the series outliers value.
289
- * The `outliersField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
289
+ * Specifies the data item field which contains the series outliers value.
290
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
290
291
  */
291
292
  outliersField?: string;
292
293
  /**
293
- * The overlay options of the Chart series.
294
+ * Specifies the overlay options of the Chart series.
294
295
  */
295
296
  overlay?: Overlay;
296
297
  /**
297
- * The padding around the Chart (equal on all sides).
298
- * The padding option is available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
298
+ * Specifies the padding around the Chart (equal on all sides).
299
+ * This option is available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
299
300
  */
300
301
  padding?: number;
301
302
  /**
302
- * The data item field which contains the series `q1` value.
303
- * The `q1Field` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
303
+ * Specifies the data item field which contains the series `q1` value.
304
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
304
305
  */
305
306
  q1Field?: string;
306
307
  /**
307
- * The data item field which contains the series `q3` value.
308
- * The `q3Field` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
308
+ * Specifies the data item field which contains the series `q3` value.
309
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
309
310
  */
310
311
  q3Field?: string;
311
312
  /**
312
- * The space in pixels between the different segments of the Funnel or Pyramid Chart.
313
- * The `segmentSpacing` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
313
+ * Specifies the space in pixels between the different segments of the Funnel or Pyramid Chart.
314
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
314
315
  */
315
316
  segmentSpacing?: number;
316
317
  /**
317
- * The radius of the Chart Donut series in pixels. If not set, the available space is split evenly
318
+ * Specifies the radius of the Chart Donut series in pixels. When not set, Charts split the available space evenly
318
319
  * between the series.
319
320
  */
320
321
  size?: number;
321
322
  /**
322
- * The data field which contains the bubble size value.
323
+ * Specifies the data field which contains the bubble size value.
323
324
  */
324
325
  sizeField?: string;
325
326
  /**
326
- * The distance between series points within a category. Expressed as a percentage of the bar width.
327
+ * Specifies the distance between series points within a category expressed as a percentage of the bar width.
327
328
  * See the related `gap` setting.
328
- * The spacing option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`, or
329
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`, or
329
330
  * `"radarColumn"`.
330
331
  */
331
332
  spacing?: number;
332
333
  /**
333
- * A Boolean value which indicates if the series have to be stacked.
334
- * A string value is interpreted as [`series.stack.group`]({% slug api_charts_seriesstack %}#toc-group).
334
+ * Determines whether the series stacks.
335
+ * Interprets a string value as [`series.stack.group`]({% slug api_charts_seriesstack %}#toc-group).
335
336
  *
336
- * The `stack` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
337
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
337
338
  * `"verticalLine"`, `"verticalArea"`, `"radarLine"`, `"radarArea"`, and `"radarColumn"`.
338
- * If not overridden, the stack settings of the first series are inherited as a default value by the rest of the series.
339
+ * If not overridden, inherits the stack settings of the first series as a default value for the rest of the series.
339
340
  */
340
341
  stack?: boolean | string | SeriesStack;
341
342
  /**
342
- * The start angle (in degrees) of the first Donut or Pie segment.
343
- * Angles increase clockwise with zero to the left. Negative values are acceptable.
343
+ * Specifies the start angle (in degrees) of the first Donut or Pie segment.
344
+ * Increases clockwise with zero to the left. You can use negative values.
344
345
  */
345
346
  startAngle?: number;
346
347
  /**
347
- * The `style` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
348
+ * Specifies the style options for the series.
349
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
348
350
  * `"line"`, `"scatterLine"`, `"radarLine"`, or `"polarLine"`.
349
351
  */
350
352
  style?: LineStyle;
351
353
  /**
352
- * The data item field which contains the summary type for the Waterfall series.
353
- * The value (if any) of a data item marked as a summary point will be discarded.
354
+ * Specifies the data item field which contains the summary type for the Waterfall series.
355
+ * Discards the value (if any) of a data item marked as a summary point.
354
356
  *
355
- * Summary columns are optional and can be one of two types:
357
+ * Summary columns are optional and take one of two types:
356
358
  *
357
359
  * `"runningTotal"`—Displays the sum of all items since the last `"runningTotal"` point.
358
360
  * `"total"`—Displays the sum of all previous items.
359
361
  */
360
362
  summaryField?: string;
361
363
  /**
362
- * The configuration options of the target.
363
- * The `target` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bullet"` or `"verticalBullet"`.
364
+ * Specifies the configuration options of the target.
365
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bullet"` or `"verticalBullet"`.
364
366
  */
365
367
  target?: BulletTarget;
366
368
  /**
367
- * The data item field which contains the series to value.
369
+ * Specifies the data item field which contains the series to value.
368
370
  */
369
371
  toField?: string;
370
372
  /**
371
- * The type of the series.
373
+ * Specifies the type of the series.
372
374
  */
373
375
  type?: SeriesType;
374
376
  /**
375
- * The data item field which contains the series upper value.
376
- * The `upperField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
377
+ * Specifies the data item field which contains the series upper value.
378
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
377
379
  */
378
380
  upperField?: string;
379
381
  /**
380
- * Sets the visible property of a Chart series.
382
+ * Specifies the visible property of a Chart series.
381
383
  */
382
384
  visible?: boolean;
383
385
  /**
384
- * A value which indicates whether to show the point category (for Funnel, Pyramid, Donut, and Pie series)
386
+ * Determines whether to show the point category (for Funnel, Pyramid, Donut, and Pie series)
385
387
  * or the series name (for other available series types) in the legend.
386
388
  */
387
389
  visibleInLegend?: boolean;
388
390
  /**
389
- * The data item field which indicates whether to show the point category name in the legend.
390
- * The `visibleInLegendField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`, `"pyramid"`, `"donut"`, or `"pie"`.
391
+ * Specifies the data item field which indicates whether to show the point category name in the legend.
392
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`, `"pyramid"`, `"donut"`, or `"pie"`.
391
393
  */
392
394
  visibleInLegendField?: string;
393
395
  /**
394
- * A function that can be used to create a custom visual for the points. Applicable for the Bar, Column,
396
+ * Specifies a function that creates a custom visual for the points. Applicable for the Bar, Column,
395
397
  * Pie, Donut, Funnel, Pyramid, Range Bar, Range Column, Line, ScatterLine, and Waterfall series.
396
- *
397
- * The available argument fields are:
398
- *
399
- * - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
400
- * - `options`—The point options.
401
- * - `createVisual`—A function that can be used to get the default visual.
402
- * - `category`—The point category.
403
- * - `dataItem`—The point `dataItem`.
404
- * - `value`—The point value.
405
- * - `stackValue`—The cumulative point value on the stack. Available only for the stackable series.
406
- * - `sender`—The Chart instance.
407
- * - `series`—The point series.
408
- * - `percentage`—The point value represented as a percentage value. Available only for the Donut, Pie, and 100% Stacked Charts.
409
- * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
410
- * - `total`—The sum of all previous series values. Available for the Waterfall series.
411
- * - `radius`—The segment radius. Available for the Donut and Pie series.
412
- * - `innerRadius`—The segment inner radius. Available for the Donut series.
413
- * - `startAngle`—The segment start angle. Available for the Donut and Pie series.
414
- * - `endAngle`—The segment end angle. Available for the Donut and Pie series.
415
- * - `center`—The segment center point. Available for the Donut and Pie series.
416
- * - `points`—The segment points. Available for the Funnel and Pyramid series.
417
398
  */
418
399
  visual?: (e: SeriesVisualArgs) => drawing.Element;
419
400
  /**
420
- * The line width.
421
- * The `width` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"line"`, `"scatterLine"`, `"radarLine"`, or
401
+ * Specifies the line width.
402
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"line"`, `"scatterLine"`, `"radarLine"`, or
422
403
  * `"polarLine"`.
423
404
  */
424
405
  width?: number;
425
406
  /**
426
- * The name of the X axis.
427
- * The [`xAxis`]({% slug api_charts_xaxis %}) option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or `"polar"` series.
428
- * For the Polar series, the [`xAxis`]({% slug api_charts_xaxis %}) range is expressed in degrees.
407
+ * Specifies the name of the X axis.
408
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or `"polar"` series.
409
+ * For the Polar series, Charts express the [`xAxis`]({% slug api_charts_xaxis %}) range in degrees.
429
410
  */
430
411
  xAxis?: string;
431
412
  /**
432
- * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) xAxis high value.
433
- * The `xErrorHighField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
413
+ * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) xAxis high value.
414
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
434
415
  * `"bubble"`.
435
416
  */
436
417
  xErrorHighField?: string;
437
418
  /**
438
- * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) xAxis low value.
439
- * The `xErrorLowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
419
+ * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) xAxis low value.
420
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
440
421
  * `"bubble"`.
441
422
  */
442
423
  xErrorLowField?: string;
443
424
  /**
444
- * The data item field containing the x value.
445
- * The `xField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or
425
+ * Specifies the data item field containing the x value.
426
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or
446
427
  * `"polar"` series.
447
428
  */
448
429
  xField?: string;
449
430
  /**
450
- * The name of the Y axis to use.
431
+ * Specifies the name of the Y axis to use.
451
432
  * Available for the Bubble, Scatter, Scatter Line, and Polar series.
452
433
  */
453
434
  yAxis?: string;
454
435
  /**
455
- * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis high value.
456
- * The `yErrorHighField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
436
+ * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis high value.
437
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
457
438
  * `"bubble"`.
458
439
  */
459
440
  yErrorHighField?: string;
460
441
  /**
461
- * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis low value.
462
- * The `yErrorLowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
442
+ * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis low value.
443
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
463
444
  * `"bubble"`.
464
445
  */
465
446
  yErrorLowField?: string;
466
447
  /**
467
- * The data item field containing the y value.
468
- * The `yField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, or `"scatterLine"`.
448
+ * Specifies the data item field containing the y value.
449
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, or `"scatterLine"`.
469
450
  */
470
451
  yField?: string;
471
452
  /**
472
- * An optional Z-index that can be used to change the default stacking order of series.
473
- * The series with the highest Z-index are placed on top.
453
+ * Specifies an optional Z-index that changes the default stacking order of series.
454
+ * Series with the highest Z-index appear on top.
474
455
  * Series with no Z-index use the default stacking order based on the series type.
475
- * For example, Line series will be on top with the Bar and Area following after.
456
+ * For example, Line series appear on top with the Bar and Area following after.
476
457
  */
477
458
  zIndex?: number;
478
459
  /**
479
- * The error bars of the Chart series.
480
- * The `errorBars` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
460
+ * Specifies the error bars of the Chart series.
461
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
481
462
  * `"scatter"`, `"scatterLine"`, or `"bubble"`.
482
463
  */
483
464
  errorBars?: SeriesErrorBars;
484
465
  /**
485
- * The configuration of the Chart series extremes. Applies to extreme outliers.
486
- * The `extremes` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
466
+ * Specifies the configuration of the Chart series extremes. Applies to extreme outliers.
467
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
487
468
  */
488
469
  extremes?: SeriesExtremes;
489
470
  /**
490
- * The configuration of the Chart series highlight.
471
+ * Specifies the configuration of the Chart series highlight.
491
472
  */
492
473
  highlight?: SeriesHighlight;
493
474
  /**
494
- * The configuration of the Chart series label.
495
- * The Chart displays the series labels when the [`series.labels.visible`]({% slug api_charts_serieslabels %}#toc-visible) option is set to `true`.
475
+ * Specifies the configuration of the Chart series label.
476
+ * Displays the series labels when the [`series.labels.visible`]({% slug api_charts_serieslabels %}#toc-visible) option is set to `true`.
496
477
  */
497
478
  labels?: SeriesLabels;
498
479
  /**
499
- * The configuration of the Chart series marker.
500
- * The Chart displays the series labels when the [`series.markers.visible`]({% slug api_charts_seriesmarkers %}#toc-visible) option is set to `true`.
501
- * The markers option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatter"`, `"scatterLine"`,
480
+ * Specifies the configuration of the Chart series marker.
481
+ * Displays the series labels when the [`series.markers.visible`]({% slug api_charts_seriesmarkers %}#toc-visible) option is set to `true`.
482
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatter"`, `"scatterLine"`,
502
483
  * `"radarLine"`, `"radarArea"`, `"polarLine"`, `"polarScatter"`, or `"polarArea"`.
503
484
  */
504
485
  markers?: SeriesMarkers;
505
486
  /**
506
- * The configuration of the Chart legend item.
507
- * By default, the Legend item type and markers are inherited from the series.
487
+ * Specifies the configuration of the Chart legend item.
488
+ * Inherits the Legend item type and markers from the series by default.
508
489
  */
509
490
  legendItem?: LegendItem;
510
491
  /**
511
- * The configuration of the series notes.
492
+ * Specifies the configuration of the series notes.
512
493
  */
513
494
  notes?: SeriesNotes;
514
495
  /**
515
- * The configuration of the Chart series outliers. Applies to mild outliers.
516
- * The `outliers` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
496
+ * Specifies the configuration of the Chart series outliers. Applies to mild outliers.
497
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
517
498
  */
518
499
  outliers?: SeriesOutliers;
519
500
  /**
520
- * The configuration options of the Chart series tooltip.
501
+ * Specifies the configuration options of the Chart series tooltip.
521
502
  */
522
503
  tooltip?: SeriesTooltip;
523
504
  /**
524
- * The trendline configuration options.
505
+ * Specifies the trendline configuration options.
525
506
  *
526
- * The `trendline` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
507
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
527
508
  * "`linearTrendline`", "`exponentialTrendline`", "`logarithmicTrendline`", "`powerTrendline`", "`polynomialTrendline`" or "`movingAverageTrendline`".
528
509
  */
529
510
  trendline?: SeriesTrendline;
530
511
  /**
531
- * The configuration of the whiskers for the Chart series.
532
- * The `whiskers` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
512
+ * Specifies the configuration of the whiskers for the Chart series.
513
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
533
514
  */
534
515
  whiskers?: SeriesWhiskers;
535
516
  /**
536
- * The configuration options of the series pattern.
517
+ * Specifies the configuration options of the series pattern.
537
518
  */
538
519
  pattern?: SeriesPattern | ((point: any) => SeriesPattern);
539
520
  /**
540
- * The data item field which contains the series pattern.
541
- * The `patternField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"pie"`, `"donut"`, `"funnel"`, `"heatmap"`, or `"pyramid"`.
521
+ * Specifies the data item field which contains the series pattern.
522
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"pie"`, `"donut"`, `"funnel"`, `"heatmap"`, or `"pyramid"`.
542
523
  */
543
524
  patternField?: string;
544
525
  }