@progress/kendo-angular-charts 19.1.2-develop.4 → 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
@@ -4,31 +4,30 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { MousewheelSelect } from '../../common/property-types';
6
6
  /**
7
- * The configuration of the category axis selection options.
7
+ * Represents the configuration of the category axis selection options.
8
8
  */
9
9
  export interface CategoryAxisSelect {
10
10
  /**
11
- * The lower boundary of the selected range.
11
+ * Specifies the lower boundary of the selected range.
12
12
  */
13
13
  from?: any;
14
14
  /**
15
- * The maximum value which the user can select.
15
+ * Specifies the maximum value which the user can select.
16
16
  */
17
17
  max?: any;
18
18
  /**
19
- * The minimum value which the user can select.
19
+ * Specifies the minimum value which the user can select.
20
20
  */
21
21
  min?: any;
22
22
  /**
23
- * The mousewheel configuration of the selection.
24
- * If set to `false`, the mousewheel does not update the selection.
23
+ * Specifies the mousewheel configuration of the selection.
24
+ * When set to `false`, the mousewheel does not update the selection.
25
25
  */
26
26
  mousewheel?: boolean | MousewheelSelect;
27
27
  /**
28
- * The upper boundary of the selected range.
29
- * The category with the specified index (date) is not included in the selected range
30
- * unless the axis is justified. To select all categories, set
31
- * a value that is larger than the last category index (date).
28
+ * Specifies the upper boundary of the selected range.
29
+ * The category with the specified index (date) is not included in the selected range unless the axis is justified.
30
+ * To select all categories, set a value that is larger than the last category index (date).
32
31
  */
33
32
  to?: any;
34
33
  }
@@ -5,53 +5,53 @@
5
5
  import { drawing } from '@progress/kendo-drawing';
6
6
  import { AxisTitlePosition, Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types';
7
7
  /**
8
- * The configuration options of the category axis title.
8
+ * Represents the configuration options of the category axis title.
9
9
  */
10
10
  export interface CategoryAxisTitle {
11
11
  /**
12
- * The background color of the title. Accepts a valid CSS color string, including hex and rgb.
12
+ * Specifies the background color of the title. Accepts a valid CSS color string, including hex and rgb.
13
13
  */
14
14
  background?: string;
15
15
  /**
16
- * The border of the title.
16
+ * Specifies the border of the title.
17
17
  */
18
18
  border?: Border;
19
19
  /**
20
- * The text color of the title. Accepts a valid CSS color string, including hex and rgb.
20
+ * Specifies the text color of the title. Accepts a valid CSS color string, including hex and rgb.
21
21
  */
22
22
  color?: string;
23
23
  /**
24
- * The font style of the title.
24
+ * Specifies the font style of the title.
25
25
  */
26
26
  font?: string;
27
27
  /**
28
- * The margin of the title. A numeric value sets all margins.
28
+ * Specifies the margin of the title. A numeric value sets all margins.
29
29
  */
30
30
  margin?: Margin | number;
31
31
  /**
32
- * The padding of the title. A numeric value sets all paddings.
32
+ * Specifies the padding of the title. A numeric value sets all paddings.
33
33
  */
34
34
  padding?: Padding | number;
35
35
  /**
36
- * The position of the title.
36
+ * Specifies the position of the title.
37
37
  */
38
38
  position?: AxisTitlePosition;
39
39
  /**
40
- * The rotation angle of the title. By default, the title is not rotated.
40
+ * Specifies the rotation angle of the title. By default, the title is not rotated.
41
41
  */
42
42
  rotation?: number;
43
43
  /**
44
- * The text of the title.
44
+ * Specifies the text of the title.
45
45
  * The text can be split into multiple lines by using the line feed characters (`"\n"`).
46
46
  */
47
47
  text?: string;
48
48
  /**
49
- * If set to `true`, the Chart displays the category axis title.
50
- * By default, the category axis title is visible.
49
+ * Determines whether the Chart displays the category axis title.
50
+ * When set to `true`, the title is visible. By default, the category axis title is visible.
51
51
  */
52
52
  visible?: boolean;
53
53
  /**
54
- * A function that can be used to create a custom visual for the title.
54
+ * Specifies a function that can be used to create a custom visual for the title.
55
55
  */
56
56
  visual?: (e: TitleVisualArgs) => drawing.Element;
57
57
  }
@@ -10,172 +10,156 @@ import { CategoryAxisNotes } from './category-axis-item/notes.interface';
10
10
  import { CategoryAxisSelect } from './category-axis-item/select.interface';
11
11
  import { CategoryAxisTitle } from './category-axis-item/title.interface';
12
12
  /**
13
- * The configuration options of the category axis.
13
+ * Represents the category axis configuration options.
14
14
  */
15
15
  export interface CategoryAxis {
16
16
  /**
17
- * The time-interval steps when `baseUnit` is set either to `"fit"` or `"auto"`.
18
- * The axis will try to divide the active period into the smallest possible units
19
- * that yield `maxDateGroups` or less discrete intervals.
17
+ * Sets the time-interval steps when `baseUnit` is set to `"fit"` or `"auto"`.
18
+ * The axis tries to divide the active period into the smallest possible units that yield `maxDateGroups` or less discrete intervals.
20
19
  */
21
20
  autoBaseUnitSteps?: AutoBaseUnitSteps;
22
21
  /**
23
- * The category index or the date (for date category axis) at which the first value axis crosses this axis.
24
- * The category indices or the date (for date category axis) at which the value axes cross the category axis (when set as an array).
25
- * To denote the far end of the axis, set an index greater than or equal to the number of categories.
22
+ * Sets the category index or date at which the first value axis crosses this axis.
23
+ * Use an array to set the category indices or dates at which the value axes cross the category axis. To denote the far end of the axis, set an index greater than or equal to the number of categories.
26
24
  */
27
25
  axisCrossingValue?: any | any[];
28
26
  /**
29
- * The background color of the axis.
27
+ * Sets the background color of the axis.
30
28
  */
31
29
  background?: string;
32
30
  /**
33
- * The base time interval for the date axis. The default base unit is automatically determined by the
34
- * minimum difference between subsequent categories.
35
- * Setting `baseUnit` to `"fit"` sets such a base unit and [`categoryAxis.baseUnitStep`](slug:api_charts_categoryaxis#toc-baseunitstep)
36
- * that the total number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups).
37
- *
38
- * Series data is aggregated for the specified base unit by using the [`series.aggregate`](slug:api_charts_series#toc-aggregate) function.
31
+ * Sets the base time interval for the date axis.
32
+ * The default base unit is automatically determined by the minimum difference between subsequent categories. Use `"fit"` to set a base unit and [`categoryAxis.baseUnitStep`](slug:api_charts_categoryaxis#toc-baseunitstep) so the total number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups). Series data is aggregated for the specified base unit by using the [`series.aggregate`](slug:api_charts_series#toc-aggregate) function.
39
33
  */
40
34
  baseUnit?: CategoryBaseUnit;
41
35
  /**
42
- * The step (interval) between the categories in base units. Setting it to `"auto"` sets the step to such
43
- * a value that the total number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups).
44
- * The option is ignored if [`categoryAxis.baseUnit`](slug:api_charts_categoryaxis#toc-baseunit) is set to `"fit"`.
36
+ * Sets the step (interval) between categories in base units.
37
+ * Use `"auto"` to set the step so the total number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups). This option is ignored if [`categoryAxis.baseUnit`](slug:api_charts_categoryaxis#toc-baseunit) is set to `"fit"`.
45
38
  */
46
39
  baseUnitStep?: number | 'auto';
47
40
  /**
48
- * The category names. The Chart creates a category for every item of the array.
41
+ * Sets the category names.
42
+ * The Chart creates a category for every item of the array.
49
43
  */
50
44
  categories?: any[];
51
45
  /**
52
- * The color to apply to all axis elements. Accepts a valid CSS color string, including HEX and RGB.
53
- * Can be overridden by [`categoryAxis.labels.color`](slug:api_charts_categoryaxislabels#toc-color) and [`categoryAxis.line.color`](slug:api_charts_axisline#toc-color).
46
+ * Sets the color to apply to all axis elements.
47
+ * Accepts a valid CSS color string, including HEX and RGB and can be overridden by [`categoryAxis.labels.color`](slug:api_charts_categoryaxislabels#toc-color) and [`categoryAxis.line.color`](slug:api_charts_axisline#toc-color).
54
48
  */
55
49
  color?: string;
56
50
  /**
57
- * If set to `true`, the Chart positions categories and series points on major ticks.
58
- * This removes the empty space before and after the series.
59
- * The default value is `false` except for `"area"`, `"verticalArea"`, `"rangeArea"`, and `"verticalRangeArea"`.
60
- * The option is ignored if the [`series.type`](slug:api_charts_series#toc-type) option is set to `"bar"`, `"column"`, `"boxPlot"`, `"ohlc"`,
61
- * `"candlestick"`, or `"waterfall"`.
51
+ * Determines if the Chart positions categories and series points on major ticks.
52
+ * This removes the empty space before and after the series. The default value is `false` except for `"area"`, `"verticalArea"`, `"rangeArea"`, and `"verticalRangeArea"`. This option is ignored if [`series.type`](slug:api_charts_series#toc-type) is set to `"bar"`, `"column"`, `"boxPlot"`, `"ohlc"`, `"candlestick"`, or `"waterfall"`.
62
53
  */
63
54
  justified?: boolean;
64
55
  /**
65
- * The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.
56
+ * Configures the axis lines.
57
+ * Also affects the major and minor ticks, but not the grid lines.
66
58
  */
67
59
  line?: AxisLine;
68
60
  /**
69
- * The configuration of the major grid lines.
61
+ * Configures the major grid lines.
70
62
  * These are the lines that are an extension of the major ticks through the body of the Chart.
71
63
  */
72
64
  majorGridLines?: GridLines;
73
65
  /**
74
- * The configuration of the category axis major ticks.
66
+ * Configures the category axis major ticks.
75
67
  */
76
68
  majorTicks?: AxisTicks;
77
69
  /**
78
- * The last date displayed on a date category axis or the index of the last category displayed on a category axis.
79
- * By default, the max value is the same as the last category.
80
- * This is often used in combination with the [`categoryAxis.min`]({% slug api_charts_categoryaxis %}#toc-min) and
81
- * [`categoryAxis.roundToBaseUnit`]({% slug api_charts_categoryaxis %}#toc-roundtobaseunit) options to set up a fixed date range.
70
+ * Sets the last date displayed on a date category axis or the index of the last category displayed on a category axis.
71
+ * By default, the max value is the same as the last category. This is often used in combination with [`categoryAxis.min`]({% slug api_charts_categoryaxis %}#toc-min) and [`categoryAxis.roundToBaseUnit`]({% slug api_charts_categoryaxis %}#toc-roundtobaseunit) to set up a fixed date range.
82
72
  */
83
73
  max?: any;
84
74
  /**
85
- * The maximum number of groups (categories) to display when
86
- * [`categoryAxis.baseUnit`]({% slug api_charts_categoryaxis %}#toc-baseunit) is set to `"fit"` or
87
- * [`categoryAxis.baseUnitStep`]({% slug api_charts_categoryaxis %}#toc-baseunitstep) is set to `"auto"`.
75
+ * Sets the maximum number of groups (categories) to display when [`categoryAxis.baseUnit`]({% slug api_charts_categoryaxis %}#toc-baseunit) is set to `"fit"` or [`categoryAxis.baseUnitStep`]({% slug api_charts_categoryaxis %}#toc-baseunitstep) is set to `"auto"`.
88
76
  */
89
77
  maxDateGroups?: number;
90
78
  /**
91
- * The maximum number of ticks and labels to display. Applicable for date category axis.
79
+ * Sets the maximum number of ticks and labels to display.
80
+ * Applicable for date category axis.
92
81
  */
93
82
  maxDivisions?: number;
94
83
  /**
95
- * The first date which is displayed on a date category axis or the index of the first category which is displayed on a category axis.
96
- * By default, the min value is the same as the first category.
97
- * This is often used in combination with the [`categoryAxis.max`]({% slug api_charts_categoryaxis %}#toc-max) and
98
- * [`categoryAxis.roundToBaseUnit`]({% slug api_charts_categoryaxis %}#toc-roundtobaseunit) options to set up a fixed date range.
84
+ * Sets the first date displayed on a date category axis or the index of the first category displayed on a category axis.
85
+ * By default, the min value is the same as the first category. This is often used in combination with [`categoryAxis.max`]({% slug api_charts_categoryaxis %}#toc-max) and [`categoryAxis.roundToBaseUnit`]({% slug api_charts_categoryaxis %}#toc-roundtobaseunit) to set up a fixed date range.
99
86
  */
100
87
  min?: any;
101
88
  /**
102
- * The configuration of the minor grid lines.
89
+ * Configures the minor grid lines.
103
90
  * These are the lines that are an extension of the minor ticks through the body of the Chart.
104
91
  */
105
92
  minorGridLines?: GridLines;
106
93
  /**
107
- * The configuration of the category axis minor ticks.
94
+ * Configures the category axis minor ticks.
108
95
  */
109
96
  minorTicks?: AxisTicks;
110
97
  /**
111
- * The unique axis name. Used to associate a series with a category axis,
112
- * which utilizes the [`series.categoryAxis`]({% slug api_charts_series %}#toc-categoryaxis) option.
98
+ * Sets the unique axis name.
99
+ * Used to associate a series with a category axis, which utilizes the [`series.categoryAxis`]({% slug api_charts_series %}#toc-categoryaxis) option.
113
100
  */
114
101
  name?: string;
115
102
  /**
116
- * The configuration of the date axis date range labels.
103
+ * Configures the date axis date range labels.
117
104
  */
118
105
  rangeLabels?: CategoryAxisRangeLabels;
119
106
  /**
120
- * The name of the pane in which the category axis has to be rendered.
107
+ * Sets the name of the pane in which the category axis has to be rendered.
121
108
  * If not set, the axis will be rendered in the first (default) pane.
122
109
  */
123
110
  pane?: string;
124
111
  /**
125
- * The plot bands of the category axis.
112
+ * Sets the plot bands of the category axis.
126
113
  */
127
114
  plotBands?: PlotBand[];
128
115
  /**
129
- * If set to `true`, the category axis direction is reversed.
116
+ * Determines if the category axis direction is reversed.
130
117
  * By default, categories are listed from left to right and from bottom to top.
131
118
  */
132
119
  reverse?: boolean;
133
120
  /**
134
- * If set to `true`, the Chart rounds the first and last date to the nearest base unit.
121
+ * Determines if the Chart rounds the first and last date to the nearest base unit.
135
122
  */
136
123
  roundToBaseUnit?: boolean;
137
124
  /**
138
- * The angle (degrees) of the first category on the axis.
139
- * Angles increase clockwise with zero to the left. Negative values are acceptable.
125
+ * Sets the angle (degrees) of the first category on the axis.
126
+ * Angles increase clockwise with zero to the left and negative values are acceptable.
140
127
  */
141
128
  startAngle?: number;
142
129
  /**
143
- * The category axis type.
144
- * The supported values include `category` for a discrete category axis and `date` for a specialized axis for displaying chronological data.
130
+ * Sets the category axis type.
131
+ * Use `"category"` for a discrete category axis or `"date"` for a specialized axis for displaying chronological data.
145
132
  */
146
133
  type?: 'category' | 'date';
147
134
  /**
148
- * If set to `true`, the Chart displays the category axis. By default, the category axis is visible.
135
+ * Determines if the Chart displays the category axis.
136
+ * By default, the category axis is visible.
149
137
  */
150
138
  visible?: boolean;
151
139
  /**
152
- * The week start day when the `baseUnit` is set to `"weeks"`.
140
+ * Sets the week start day when the `baseUnit` is set to `"weeks"`.
153
141
  */
154
142
  weekStartDay?: WeekStartDay;
155
143
  /**
156
- * The configuration options of the crosshair.
144
+ * Configures the crosshair options.
157
145
  * The crosshair is displayed when the [`categoryAxis.crosshair.visible`]({% slug api_charts_categoryaxiscrosshair %}#toc-visible) option is set to `true`.
158
146
  */
159
147
  crosshair?: CategoryAxisCrosshair;
160
148
  /**
161
- * The configuration of the axis labels.
149
+ * Configures the axis labels.
162
150
  */
163
151
  labels?: CategoryAxisLabels;
164
152
  /**
165
- * The configuration of the category axis notes.
153
+ * Configures the category axis notes.
166
154
  */
167
155
  notes?: CategoryAxisNotes;
168
156
  /**
169
- * The selected axis range. If set, the axis selection is enabled.
170
- * The range is index-based, starting from zero.
171
- * Categories with indexes in the range (`select.from`, `select.to`) will be selected.
172
- * That is, the last category in the range will not be included in the selection.
173
- * If the categories are dates, the range has to be also specified with date values.
174
- * Selection is only supported if the axis is horizontal.
157
+ * Configures the selected axis range.
158
+ * Setting this option enables axis selection and the range is index-based, starting from zero. Categories with indexes in the range (`select.from`, `select.to`) will be selected, but the last category in the range will not be included in the selection. If the categories are dates, specify the range with date values. Selection is only supported if the axis is horizontal.
175
159
  */
176
160
  select?: CategoryAxisSelect;
177
161
  /**
178
- * The title configuration of the category axis.
162
+ * Configures the title of the category axis.
179
163
  * To display the title, set the [`categoryAxis.title.text`]({% slug api_charts_categoryaxistitle %}#toc-text) option.
180
164
  */
181
165
  title?: CategoryAxisTitle;
@@ -4,31 +4,31 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { Border, Margin } from '../common/property-types';
6
6
  /**
7
- * The configuration options of the Chart area.
7
+ * Specifies the configuration options of the Chart area.
8
8
  */
9
9
  export interface ChartArea {
10
10
  /**
11
- * The background color of the Chart area. Accepts a valid CSS color string, including hex and rgb.
11
+ * Specifies the background color of the Chart area. Accepts a valid CSS color string, including hex and rgb.
12
12
  */
13
13
  background?: string;
14
14
  /**
15
- * The border of the Chart area.
15
+ * Specifies the border of the Chart area.
16
16
  */
17
17
  border?: Border;
18
18
  /**
19
- * The height of the Chart area.
19
+ * Specifies the height of the Chart area.
20
20
  */
21
21
  height?: number;
22
22
  /**
23
- * The margin of the Chart area. A numeric value sets all margins.
23
+ * Specifies the margin of the Chart area. A numeric value sets all margins.
24
24
  */
25
25
  margin?: Margin | number;
26
26
  /**
27
- * The background opacity of the Chart area. By default, the background is opaque.
27
+ * Specifies the background opacity of the Chart area. By default, the background is opaque.
28
28
  */
29
29
  opacity?: number;
30
30
  /**
31
- * The width of the Chart area.
31
+ * Specifies the width of the Chart area.
32
32
  */
33
33
  width?: number;
34
34
  }
@@ -4,11 +4,11 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { LegendLabels } from '../../common/property-types';
6
6
  /**
7
- * The configuration options of the inactive legend items.
7
+ * Represents the configuration options of the inactive legend items.
8
8
  */
9
9
  export interface LegendInactiveItems {
10
10
  /**
11
- * The label configuration of the Chart legend.
11
+ * Specifies the label configuration of the Chart legend.
12
12
  */
13
13
  labels?: LegendLabels;
14
14
  }
@@ -6,39 +6,39 @@ import { drawing } from '@progress/kendo-drawing';
6
6
  import { Border, DashType, LegendItemVisualArgs } from '../../common/property-types';
7
7
  import { SeriesMarkers } from './../series-item/markers.interface';
8
8
  /**
9
- * The configuration options of the legend item.
9
+ * Represents the configuration options of the legend item.
10
10
  */
11
11
  export interface LegendItem {
12
12
  /**
13
- * The cursor style of the legend item.
13
+ * Specifies the cursor style of the legend item.
14
14
  */
15
15
  cursor?: string;
16
16
  /**
17
- * Sets the type of the legend item.
17
+ * Specifies the type of the legend item.
18
18
  * The default value is based on the series type.
19
19
  */
20
20
  type?: LegendItemType;
21
21
  /**
22
- * Sets the configuration of the legend items of type `line`.
22
+ * Specifies the configuration of the legend items of type `line`.
23
23
  * This is the default legend item type for all line and scatter series.
24
24
  */
25
25
  line?: LegendItemLine;
26
26
  /**
27
- * Sets the configuration of the legend items of type `area`.
27
+ * Specifies the configuration of the legend items of type `area`.
28
28
  * By default, all series except line and scatter use this legend type.
29
29
  */
30
30
  area?: LegendItemArea;
31
31
  /**
32
- * The markers configuration of the legend item.
32
+ * Specifies the markers configuration of the legend item.
33
33
  * Defaults to the series options.
34
34
  */
35
35
  markers?: LegendItemMarkers;
36
36
  /**
37
- * The highlight configuration of the legend item.
37
+ * Specifies the highlight configuration of the legend item.
38
38
  */
39
39
  highlight?: LegendItemHighlight;
40
40
  /**
41
- * A function for creating a custom visual for the legend items.
41
+ * Specifies a function for creating a custom visual for the legend items.
42
42
  */
43
43
  visual?: (e: LegendItemVisualArgs) => drawing.Element;
44
44
  }
@@ -52,7 +52,7 @@ export interface LegendItemMarkersBorder extends Omit<Border, 'width'> {
52
52
  */
53
53
  export interface LegendItemMarkers extends Omit<SeriesMarkers, 'size' | 'border' | 'rotation' | 'from' | 'to'> {
54
54
  /**
55
- * The border of the markers.
55
+ * Specifies the border of the markers.
56
56
  */
57
57
  border?: LegendItemMarkersBorder;
58
58
  }
@@ -61,11 +61,12 @@ export interface LegendItemMarkers extends Omit<SeriesMarkers, 'size' | 'border'
61
61
  */
62
62
  export interface LegendItemHighlight {
63
63
  /**
64
- * If set to `false`, the hover effect of the legend item is disabled.
64
+ * Determines whether the hover effect of the legend item is disabled.
65
+ * When set to `false`, the hover effect is disabled.
65
66
  */
66
67
  visible?: boolean;
67
68
  /**
68
- * The `markers` configuration of the legend item when it is hovered.
69
+ * Specifies the `markers` configuration of the legend item when it is hovered.
69
70
  */
70
71
  markers?: LegendItemMarkers;
71
72
  }
@@ -75,17 +76,17 @@ export interface LegendItemHighlight {
75
76
  */
76
77
  export interface LegendItemLine {
77
78
  /**
78
- * The color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
79
+ * Specifies the color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
79
80
  * Defaults to the series color.
80
81
  */
81
82
  color?: string;
82
83
  /**
83
- * The opacity of the legend item.
84
+ * Specifies the opacity of the legend item.
84
85
  * Defaults to the series opacity.
85
86
  */
86
87
  opacity?: number;
87
88
  /**
88
- * The dash type of the legend item.
89
+ * Specifies the dash type of the legend item.
89
90
  * Defaults to the series dash type.
90
91
  */
91
92
  dashType?: DashType;
@@ -96,20 +97,19 @@ export interface LegendItemLine {
96
97
  */
97
98
  export interface LegendItemArea {
98
99
  /**
99
- * The background color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
100
+ * Specifies the background color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
100
101
  * Defaults to the series color.
101
102
  */
102
103
  background?: string;
103
104
  /**
104
- * The opacity of the legend item.
105
+ * Specifies the opacity of the legend item.
105
106
  * Defaults to the series opacity.
106
107
  */
107
108
  opacity?: number;
108
109
  }
109
110
  /**
110
- * The type of the Chart legend item.
111
+ * Specifies the type of the Chart legend item.
111
112
  *
112
- * - `"line"`&mdash;the legend items are rendered as a line. This is the default value for line charts.
113
- * - `"area"`&mdash;the legend items are rendered as a filled rectangle. This is the default value for area charts.
113
+ * The options are `"line"` for rendering legend items as a line (default for line charts) and `"area"` for rendering legend items as a filled rectangle (default for area charts).
114
114
  */
115
115
  export type LegendItemType = 'line' | 'area';
@@ -5,53 +5,54 @@
5
5
  import { Element } from '@progress/kendo-drawing';
6
6
  import { Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types';
7
7
  /**
8
- * The configuration options for the Legend title
8
+ * Represents the configuration options for the Legend title
9
9
  * ([see example]({% slug legend_chart_charts %}#toc-setting-a-title)).
10
10
  */
11
11
  export interface LegendTitle {
12
12
  /**
13
- * The alignment of the title.
13
+ * Specifies the alignment of the title.
14
14
  */
15
15
  align?: 'center' | 'left' | 'right';
16
16
  /**
17
- * The background color of the title. Accepts a valid CSS color string, including hex and rgb.
17
+ * Specifies the background color of the title. Accepts a valid CSS color string, including hex and rgb.
18
18
  */
19
19
  background?: string;
20
20
  /**
21
- * The border of the title.
21
+ * Specifies the border of the title.
22
22
  */
23
23
  border?: Border;
24
24
  /**
25
- * The text color of the title. Accepts a valid CSS color string, including hex and rgb.
25
+ * Specifies the text color of the title. Accepts a valid CSS color string, including hex and rgb.
26
26
  */
27
27
  color?: string;
28
28
  /**
29
- * The font of the title.
29
+ * Specifies the font of the title.
30
30
  */
31
31
  font?: string;
32
32
  /**
33
- * The margin of the title. A numeric value sets all margins.
33
+ * Specifies the margin of the title. A numeric value sets all margins.
34
34
  */
35
35
  margin?: Margin | number;
36
36
  /**
37
- * The padding of the title. A numeric value sets all margins.
37
+ * Specifies the padding of the title. A numeric value sets all margins.
38
38
  */
39
39
  padding?: Padding | number;
40
40
  /**
41
- * The position of the title.
41
+ * Specifies the position of the title.
42
42
  */
43
43
  position?: 'top' | 'bottom';
44
44
  /**
45
- * The text of the title.
45
+ * Specifies the text of the title.
46
46
  * You can split the text into multiple lines by using the line feed characters ("\n").
47
47
  */
48
48
  text?: string;
49
49
  /**
50
- * If set to `true`, the Chart displays the Legend title. By default, the title is displayed.
50
+ * Determines whether the Chart displays the Legend title.
51
+ * When set to `true`, the title is visible. By default, the title is displayed.
51
52
  */
52
53
  visible?: boolean;
53
54
  /**
54
- * A function for creating a custom visual for the title.
55
+ * Specifies a function for creating a custom visual for the title.
55
56
  */
56
57
  visual?: (args: TitleVisualArgs) => Element;
57
58
  }
@@ -5,28 +5,28 @@
5
5
  import { drawing } from '@progress/kendo-drawing';
6
6
  import { MarkersVisualArgs, MarkerType } from '../../common/property-types';
7
7
  /**
8
- * The configuration options of the legend markers.
8
+ * Represents the configuration options of the legend markers.
9
9
  */
10
10
  export interface LegendMarkers {
11
11
  /**
12
- * The width (in pixels) of the markers. Defaults to `15`.
12
+ * Specifies the width (in pixels) of the markers. Defaults to `15`.
13
13
  */
14
14
  width?: number;
15
15
  /**
16
- * The height (in pixels) of the markers. Defaults to `3`.
16
+ * Specifies the height (in pixels) of the markers. Defaults to `3`.
17
17
  */
18
18
  height?: number;
19
19
  /**
20
- * The shape of the legend item markers. Defaults to `circle`.
20
+ * Specifies the shape of the legend item markers. Defaults to `circle`.
21
21
  */
22
22
  type?: MarkerType;
23
23
  /**
24
- * If set to `true`, the Chart displays the markers.
25
- * By default, the legend item markers are displayed.
24
+ * Determines whether the Chart displays the markers.
25
+ * When set to `true`, the markers are visible. By default, the legend item markers are displayed.
26
26
  */
27
27
  visible?: boolean;
28
28
  /**
29
- * A function for creating a custom visual for the markers.
29
+ * Specifies a function for creating a custom visual for the markers.
30
30
  */
31
31
  visual?: (e: MarkersVisualArgs) => drawing.Element;
32
32
  }