@progress/kendo-charts 2.13.0-develop.1 → 2.13.0-develop.3

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 (54) hide show
  1. package/dist/cdn/js/kendo-charts.js +1 -1
  2. package/dist/cdn/main.js +1 -1
  3. package/dist/es/chart/plotarea/categorical-plotarea.js +9 -6
  4. package/dist/es2015/chart/plotarea/categorical-plotarea.js +9 -6
  5. package/dist/npm/api-types/axis-range.interface.d.ts +3 -3
  6. package/dist/npm/api-types/chart-axis.interface.d.ts +10 -11
  7. package/dist/npm/api-types/chart-pane.interface.d.ts +10 -1
  8. package/dist/npm/api-types/chart-plotarea.interface.d.ts +1 -1
  9. package/dist/npm/api-types/chart-svg-export-options.interface.d.ts +16 -0
  10. package/dist/npm/api-types/chart-visual-export-options.interface.d.ts +14 -0
  11. package/dist/npm/api-types/event-axis-options.interface.d.ts +1 -1
  12. package/dist/npm/api-types/series-point-marker.interface.d.ts +16 -0
  13. package/dist/npm/api-types/series-point.interface.d.ts +32 -11
  14. package/dist/npm/api-types.d.ts +4 -0
  15. package/dist/npm/field-types/line-style.d.ts +1 -6
  16. package/dist/npm/field-types/series-labels-alignment.d.ts +1 -1
  17. package/dist/npm/main.js +11 -6
  18. package/dist/npm/option-types/axis-crosshair-tooltip.interface.d.ts +6 -0
  19. package/dist/npm/option-types/axis-defaults/crosshair.interface.d.ts +1 -1
  20. package/dist/npm/option-types/axis-defaults/labels.interface.d.ts +13 -2
  21. package/dist/npm/option-types/axis-defaults/title.interface.d.ts +3 -0
  22. package/dist/npm/option-types/category-axis-item/crosshair.interface.d.ts +1 -1
  23. package/dist/npm/option-types/category-axis-item/highlight.interface.d.ts +28 -0
  24. package/dist/npm/option-types/category-axis-item/labels.interface.d.ts +29 -7
  25. package/dist/npm/option-types/category-axis-item/notes.label.interface.d.ts +10 -1
  26. package/dist/npm/option-types/category-axis-item.interface.d.ts +10 -1
  27. package/dist/npm/option-types/navigator/hint.interface.d.ts +1 -1
  28. package/dist/npm/option-types/navigator.interface.d.ts +2 -2
  29. package/dist/npm/option-types/pane/title.interface.d.ts +1 -1
  30. package/dist/npm/option-types/series-defaults/labels.from.interface.d.ts +10 -1
  31. package/dist/npm/option-types/series-defaults/labels.interface.d.ts +12 -3
  32. package/dist/npm/option-types/series-defaults/labels.to.interface.d.ts +6 -0
  33. package/dist/npm/option-types/series-defaults/notes.label.interface.d.ts +6 -0
  34. package/dist/npm/option-types/series-defaults/tooltip.interface.d.ts +10 -1
  35. package/dist/npm/option-types/series-item/error-bars.interface.d.ts +3 -3
  36. package/dist/npm/option-types/series-item/highlight.interface.d.ts +5 -5
  37. package/dist/npm/option-types/series-item/labels.from.interface.d.ts +9 -1
  38. package/dist/npm/option-types/series-item/labels.interface.d.ts +16 -7
  39. package/dist/npm/option-types/series-item/labels.to.interface.d.ts +10 -1
  40. package/dist/npm/option-types/series-item/notes.label.interface.d.ts +9 -1
  41. package/dist/npm/option-types/series-item/tooltip.interface.d.ts +9 -1
  42. package/dist/npm/option-types/tooltip.interface.d.ts +6 -0
  43. package/dist/npm/option-types/value-axis-item/crosshair.interface.d.ts +1 -1
  44. package/dist/npm/option-types/value-axis-item/labels.interface.d.ts +10 -1
  45. package/dist/npm/option-types/value-axis-item/notes.label.interface.d.ts +6 -0
  46. package/dist/npm/option-types/x-axis-item/crosshair.interface.d.ts +1 -1
  47. package/dist/npm/option-types/x-axis-item/labels.interface.d.ts +28 -6
  48. package/dist/npm/option-types/x-axis-item/notes.label.interface.d.ts +10 -1
  49. package/dist/npm/option-types/y-axis-item/crosshair.interface.d.ts +1 -1
  50. package/dist/npm/option-types/y-axis-item/labels.interface.d.ts +28 -6
  51. package/dist/npm/option-types/y-axis-item/notes.label.interface.d.ts +10 -1
  52. package/dist/npm/property-types.d.ts +3 -2
  53. package/dist/systemjs/kendo-charts.js +1 -1
  54. package/package.json +2 -2
@@ -33,6 +33,12 @@ export interface AxisCrosshairTooltip {
33
33
  * {% platform_content angular %}
34
34
  * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
35
35
  * {% endplatform_content %}
36
+ * {% platform_content react %}
37
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
38
+ * {% endplatform_content %}
39
+ * {% platform_content vue %}
40
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
41
+ * {% endplatform_content %}
36
42
  */
37
43
  format?: string;
38
44
 
@@ -36,7 +36,7 @@ export interface AxisDefaultsCrosshair {
36
36
 
37
37
  /**
38
38
  * Specifies the options of the crosshair tooltip.
39
- * The crosshair tooltip is displayed when the `axisDefaults.crosshair.tooltip.visible`
39
+ * The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`]({% slug api_charts_axisdefaultscrosshairtooltip %})
40
40
  * option is set to `true`.
41
41
  */
42
42
  tooltip?: AxisDefaultsCrosshairTooltip;
@@ -21,8 +21,19 @@ export interface AxisDefaultsLabels {
21
21
  font?: string;
22
22
 
23
23
  /**
24
- * Specifies the format for displaying the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting). Contains one placeholder (`"{0}"`) which represents the category value.
25
- */
24
+ * Specifies the format for displaying the labels.
25
+ *
26
+ * {% platform_content angular %}
27
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
28
+ * {% endplatform_content %}
29
+ * {% platform_content react %}
30
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
31
+ * {% endplatform_content %}
32
+ * {% platform_content vue %}
33
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
34
+ * {% endplatform_content %}
35
+ * Contains one placeholder (`"{0}"`) which represents the category value.
36
+ */
26
37
  format?: string;
27
38
 
28
39
  /**
@@ -3,6 +3,9 @@ import { AxisTitlePosition, Border, Margin, Padding, TitleVisualArgs } from '../
3
3
 
4
4
  /**
5
5
  * Specifies the configuration options for the axis title.
6
+ * {% platform_content angular %}
7
+ * See the [Default Axis Configuration example](https://www.telerik.com/kendo-angular-ui/components/charts/elements/axes#default-axis-configuration).
8
+ * {% endplatform_content %}
6
9
  */
7
10
  export interface AxisDefaultsTitle {
8
11
 
@@ -34,7 +34,7 @@ export interface CategoryAxisCrosshair {
34
34
 
35
35
  /**
36
36
  * Specifies the options of the crosshair tooltip.
37
- * The crosshair tooltip displays when the `categoryAxis.crosshair.tooltip.visible` option is set to `true`.
37
+ * The crosshair tooltip displays when the [`categoryAxis.crosshair.tooltip.visible`]({% slug api_charts_categoryaxiscrosshairtooltip %}) option is set to `true`.
38
38
  */
39
39
  tooltip?: CategoryAxisCrosshairTooltip;
40
40
  }
@@ -0,0 +1,28 @@
1
+ import { Border } from '../../field-types';
2
+
3
+ /**
4
+ * Represents the highlight configuration options of the category axis.
5
+ */
6
+ export interface CategoryAxisHighlight {
7
+ /**
8
+ * Determines if the highlight is visible.
9
+ */
10
+ visible?: boolean;
11
+
12
+ /**
13
+ * Sets the fill color of the highlight rectangle.
14
+ * Accepts a valid CSS color string, including HEX and RGB.
15
+ */
16
+ color?: string;
17
+
18
+ /**
19
+ * Sets the opacity of the highlight fill.
20
+ * The value ranges from `0` (fully transparent) to `1` (fully opaque).
21
+ */
22
+ opacity?: number;
23
+
24
+ /**
25
+ * Configures the border of the highlight rectangle.
26
+ */
27
+ border?: Border;
28
+ }
@@ -36,18 +36,31 @@ export interface CategoryAxisLabels {
36
36
  content?: (e: AxisLabelContentArgs) => string;
37
37
 
38
38
  /**
39
- * Specifies the culture to use when formatting date values..
39
+ * Specifies the culture to use when formatting date values.
40
+ * {% platform_content angular %}
41
+ * The specified culture must be loaded as demonstrated in the [Internationalization Overview](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization).
42
+ * {% endplatform_content %}
40
43
  */
41
44
  culture?: string;
42
45
 
43
46
  /**
44
47
  * Specifies the format for displaying the labels of the date category axis.
45
- * The `{0}` placeholder represents the category value.
46
- * The Chart selects the appropriate format for the current `categoryAxis.baseUnit` option.
47
- * Setting the `categoryAxis.labels.format` option overrides the date formats.
48
- * For more information, refer to the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
49
48
  *
50
- * For Radar Charts, the feature is not supported. Use `categoryAxis.labels.format` instead.
49
+ * {% platform_content angular %}
50
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
51
+ * {% endplatform_content %}
52
+ * {% platform_content react %}
53
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
54
+ * {% endplatform_content %}
55
+ * {% platform_content vue %}
56
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
57
+ * {% endplatform_content %}
58
+ * Contains one placeholder (`"{0}"`) which represents the category value.
59
+ *
60
+ * The Chart selects the appropriate format for the current [`categoryAxis.baseUnit`]({% slug api_charts_categoryaxis %}#baseunit) option.
61
+ * Setting the [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#format) option overrides the date formats.
62
+ *
63
+ * For Radar Charts, the feature is not supported. Use [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#format) instead.
51
64
  */
52
65
  dateFormats?: DateFormats;
53
66
 
@@ -57,7 +70,16 @@ export interface CategoryAxisLabels {
57
70
  font?: string;
58
71
 
59
72
  /**
60
- * Specifies the format for displaying the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
73
+ * Specifies the format for displaying the labels.
74
+ * {% platform_content angular %}
75
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
76
+ * {% endplatform_content %}
77
+ * {% platform_content react %}
78
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
79
+ * {% endplatform_content %}
80
+ * {% platform_content vue %}
81
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
82
+ * {% endplatform_content %}
61
83
  * Contains one placeholder (`"{0}"`) which represents the category value.
62
84
  */
63
85
  format?: string;
@@ -32,7 +32,16 @@ export interface CategoryAxisNotesLabel {
32
32
  font?: string;
33
33
 
34
34
  /**
35
- * Specifies the format for displaying the notes label. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
35
+ * Specifies the format for displaying the notes label.
36
+ * {% platform_content angular %}
37
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
38
+ * {% endplatform_content %}
39
+ * {% platform_content react %}
40
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
41
+ * {% endplatform_content %}
42
+ * {% platform_content vue %}
43
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
44
+ * {% endplatform_content %}
36
45
  * Contains one placeholder (`"{0}"`) which represents the category value.
37
46
  */
38
47
  format?: string;
@@ -1,10 +1,12 @@
1
1
  import { AutoBaseUnitSteps, AxisLine, AxisTicks, CategoryBaseUnit, GridLines, PlotBand, WeekStartDay } from '../property-types';
2
2
  import { CategoryAxisCrosshair } from './category-axis-item/crosshair.interface';
3
+ import { CategoryAxisHighlight } from './category-axis-item/highlight.interface';
3
4
  import { CategoryAxisLabels } from './category-axis-item/labels.interface';
4
5
  import { CategoryAxisRangeLabels } from './category-axis-item/range-labels.interface';
5
6
  import { CategoryAxisNotes } from './category-axis-item/notes.interface';
6
7
  import { CategoryAxisSelect } from './category-axis-item/select.interface';
7
8
  import { CategoryAxisTitle } from './category-axis-item/title.interface';
9
+
8
10
  /**
9
11
  * Represents the category axis configuration options.
10
12
  */
@@ -27,7 +29,9 @@ export interface CategoryAxis {
27
29
 
28
30
  /**
29
31
  * Sets the base time interval for the date axis.
30
- * The default base unit is automatically determined by the minimum difference between subsequent categories. Use `"fit"` to set a base unit and [`baseUnitStep`](#baseunitstep) so the total number of categories does not exceed [`categoryAxis.maxDateGroups`](#maxdategroups). Series data is aggregated for the specified base unit by using the [`series.aggregate`](#aggregate) function.
32
+ * The default base unit is automatically determined by the minimum difference between subsequent categories.
33
+ * Use `"fit"` to set a base unit and [`baseUnitStep`](#baseunitstep) so the total number of categories does not exceed [`maxDateGroups`](#maxdategroups).
34
+ * Series data is aggregated for the specified base unit by using the [`series.aggregate`]({% slug api_charts_series %}#aggregate) function.
31
35
  */
32
36
  baseUnit?: CategoryBaseUnit;
33
37
 
@@ -49,6 +53,11 @@ export interface CategoryAxis {
49
53
  */
50
54
  color?: string;
51
55
 
56
+ /**
57
+ * Configures the highlight options of the category axis.
58
+ */
59
+ highlight?: CategoryAxisHighlight;
60
+
52
61
  /**
53
62
  * Determines if the Chart positions categories and series points on major ticks.
54
63
  * 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` is set to `"bar"`, `"column"`, `"boxPlot"`, `"ohlc"`, `"candlestick"`, or `"waterfall"`.
@@ -3,7 +3,7 @@ import { NavigatorHintContentArgs } from './hint-content-args.interface';
3
3
  /**
4
4
  * Represents the `navigator.hint` options.
5
5
  */
6
- export interface NavigatorHintOptions {
6
+ export interface NavigatorHint {
7
7
  /**
8
8
  * Specifies a function that returns the content of the hint.
9
9
  */
@@ -1,13 +1,13 @@
1
1
  import { CategoryAxis } from './category-axis-item.interface';
2
2
  import { Pane } from './pane.interface';
3
3
  import { Series } from './series-item.interface';
4
- import { NavigatorHintOptions as NavigatorHint } from './navigator/hint.interface';
4
+ import { NavigatorHint } from './navigator/hint.interface';
5
5
  import { NavigatorSelect } from './navigator/select.interface';
6
6
 
7
7
  /**
8
8
  * Represents the configuration options of the navigator.
9
9
  */
10
- export interface NavigatorOptions {
10
+ export interface Navigator {
11
11
  /**
12
12
  * Specifies the visibility of the navigator.
13
13
  */
@@ -56,7 +56,7 @@ export interface PanesTitle {
56
56
  * The available argument fields are:
57
57
  *
58
58
  * - `text`—The label text.
59
- * - `rect`—The geometry `Rect` that defines where the visual has to be rendered.
59
+ * - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
60
60
  * - `sender`—The Chart instance (might be `undefined`).
61
61
  * - `options`—The label options.
62
62
  * - `createVisual`—A function that can be used to get the default visual.
@@ -32,7 +32,16 @@ export interface SeriesDefaultsLabelsFrom {
32
32
  font?: string;
33
33
 
34
34
  /**
35
- * Specifies the format of the `from` labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
35
+ * Specifies the format of the `from` labels.
36
+ * {% platform_content angular %}
37
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
38
+ * {% endplatform_content %}
39
+ * {% platform_content react %}
40
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
41
+ * {% endplatform_content %}
42
+ * {% platform_content vue %}
43
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
44
+ * {% endplatform_content %}
36
45
  */
37
46
  format?: string;
38
47
 
@@ -34,7 +34,16 @@ export interface SeriesDefaultsLabels {
34
34
  font?: string;
35
35
 
36
36
  /**
37
- * Specifies the format of the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
37
+ * Specifies the format of the labels.
38
+ * {% platform_content angular %}
39
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
40
+ * {% endplatform_content %}
41
+ * {% platform_content react %}
42
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
43
+ * {% endplatform_content %}
44
+ * {% platform_content vue %}
45
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
46
+ * {% endplatform_content %}
38
47
  */
39
48
  format?: string;
40
49
 
@@ -66,13 +75,13 @@ export interface SeriesDefaultsLabels {
66
75
 
67
76
  /**
68
77
  * Specifies the Chart series `from` label configuration.
69
- * Displays the series labels when either the `seriesDefaults.labels.visible` or the `seriesDefaults.labels.from.visible` option is set to `true`.
78
+ * Displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#visible) or the [`seriesDefaults.labels.from.visible`]({% slug api_charts_seriesdefaultslabelsfrom %}#visible) option is set to `true`.
70
79
  */
71
80
  from?: SeriesDefaultsLabelsFrom;
72
81
 
73
82
  /**
74
83
  * Specifies the Chart series `to` label configuration.
75
- * Displays the series labels when either the `seriesDefaults.labels.visible` or the `seriesDefaults.labels.to.visible` option is set to `true`.
84
+ * Displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#visible) or the [`seriesDefaults.labels.to.visible`]({% slug api_charts_seriesdefaultslabelsto %}#visible) option is set to `true`.
76
85
  */
77
86
  to?: SeriesDefaultsLabelsTo;
78
87
  }
@@ -36,6 +36,12 @@ export interface SeriesDefaultsLabelsTo {
36
36
  * {% platform_content angular %}
37
37
  * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
38
38
  * {% endplatform_content %}
39
+ * {% platform_content react %}
40
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
41
+ * {% endplatform_content %}
42
+ * {% platform_content vue %}
43
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
44
+ * {% endplatform_content %}
39
45
  */
40
46
  format?: string;
41
47
 
@@ -37,6 +37,12 @@ export interface SeriesDefaultsNotesLabel {
37
37
  * {% platform_content angular %}
38
38
  * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
39
39
  * {% endplatform_content %}
40
+ * {% platform_content react %}
41
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
42
+ * {% endplatform_content %}
43
+ * {% platform_content vue %}
44
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
45
+ * {% endplatform_content %}
40
46
  */
41
47
  format?: string;
42
48
 
@@ -26,7 +26,16 @@ export interface SeriesDefaultsTooltip {
26
26
  font?: string;
27
27
 
28
28
  /**
29
- * Specifies the format of the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
29
+ * Specifies the format of the labels.
30
+ * {% platform_content angular %}
31
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
32
+ * {% endplatform_content %}
33
+ * {% platform_content react %}
34
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
35
+ * {% endplatform_content %}
36
+ * {% platform_content vue %}
37
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
38
+ * {% endplatform_content %}
30
39
  *
31
40
  * Area, Bar, Column, Funnel, Pyramid, Line, and Pie charts are represented by `{0}` as the value placeholder.
32
41
  *
@@ -23,7 +23,7 @@ export interface SeriesErrorBars {
23
23
 
24
24
  /**
25
25
  * Specifies the error bars value.
26
- * Supports the value option when `series.type` is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
26
+ * Supports the value option when [`series.type`]({% slug api_charts_series %}#type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
27
27
  *
28
28
  * Supports the following value types:
29
29
  *
@@ -47,14 +47,14 @@ export interface SeriesErrorBars {
47
47
  /**
48
48
  * Specifies the value of the `xAxis` error bars. For a list of the supported value
49
49
  * types, refer to the `series.errorBars.value` option.
50
- * Supports the `xValue` option when `series.type` is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
50
+ * Supports the `xValue` option when [`series.type`]({% slug api_charts_series %}#type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
51
51
  */
52
52
  xValue?: string;
53
53
 
54
54
  /**
55
55
  * Specifies the value of the `yAxis` error bars. For a list of supported value types, refer
56
56
  * to the `series.errorBars.value` option.
57
- * Supports the `yValue` option when `series.type` is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
57
+ * Supports the `yValue` option when [`series.type`]({% slug api_charts_series %}#type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
58
58
  */
59
59
  yValue?: string;
60
60
  }
@@ -10,27 +10,27 @@ export interface SeriesHighlight {
10
10
  /**
11
11
  * Specifies the border of the highlighted Chart series.
12
12
  * Computes the color automatically from the base point color.
13
- * This option is supported when `series.type` is set to
13
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#type) is set to
14
14
  * `"donut"`, `"bubble"`, `"pie"`, `"candlestick"`, or `"ohlc"`.
15
15
  */
16
16
  border?: Border;
17
17
 
18
18
  /**
19
19
  * Specifies the highlight color. Accepts a valid CSS color string, including HEX and RGB.
20
- * This option is supported when `series.type` is set to `"donut"` or `"pie"`.
20
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#type) is set to `"donut"` or `"pie"`.
21
21
  */
22
22
  color?: string;
23
23
 
24
24
  /**
25
25
  * Specifies the line of the highlighted Chart series.
26
26
  * Computes the color automatically from the base point color.
27
- * This option is supported when `series.type` is set to `"candlestick"` or `"ohlc"`.
27
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#type) is set to `"candlestick"` or `"ohlc"`.
28
28
  */
29
29
  line?: HighlightLine;
30
30
 
31
31
  /**
32
32
  * Specifies the opacity of the highlighted points.
33
- * This option is supported when `series.type` is set to `"bubble"`, `"pie"`, or `"donut"`.
33
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#type) is set to `"bubble"`, `"pie"`, or `"donut"`.
34
34
  */
35
35
  opacity?: number;
36
36
 
@@ -41,7 +41,7 @@ export interface SeriesHighlight {
41
41
 
42
42
  /**
43
43
  * Specifies the appearance of the highlighted point markers.
44
- * This option is supported when `series.type` is set to `"line"`, `"area"`, `"scatter"`, `"scatterLine"`, or `"rangeArea"`.
44
+ * This option is supported when [`series.type`]({% slug api_charts_series %}#type) is set to `"line"`, `"area"`, `"scatter"`, `"scatterLine"`, or `"rangeArea"`.
45
45
  */
46
46
  markers?: MarkersHighlight;
47
47
 
@@ -35,7 +35,15 @@ export interface SeriesLabelsFrom {
35
35
 
36
36
  /**
37
37
  * Sets the format of the `from` labels.
38
- * Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
38
+ * {% platform_content angular %}
39
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
40
+ * {% endplatform_content %}
41
+ * {% platform_content react %}
42
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
43
+ * {% endplatform_content %}
44
+ * {% platform_content vue %}
45
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
46
+ * {% endplatform_content %}
39
47
  */
40
48
  format?: string;
41
49
 
@@ -11,7 +11,7 @@ import { SeriesLabelsTo } from './labels.to.interface';
11
11
  export interface SeriesLabels {
12
12
 
13
13
  /**
14
- * Specifies the alignment of the label when `series.type` is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
14
+ * Specifies the alignment of the label when [`series.type`]({% slug api_charts_series %}#type) is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
15
15
  */
16
16
  align?: SeriesLabelsAlignment;
17
17
 
@@ -42,7 +42,7 @@ export interface SeriesLabels {
42
42
  ariaContent?: (e: SeriesLabelsContentArgs) => string;
43
43
 
44
44
  /**
45
- * Specifies the distance between the labels when `series.type` is set to `"donut"` or `"pie"`.
45
+ * Specifies the distance between the labels when [`series.type`]({% slug api_charts_series %}#type) is set to `"donut"` or `"pie"`.
46
46
  */
47
47
  distance?: number;
48
48
 
@@ -52,7 +52,16 @@ export interface SeriesLabels {
52
52
  font?: string;
53
53
 
54
54
  /**
55
- * Specifies the format of the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
55
+ * Specifies the format of the labels.
56
+ * {% platform_content angular %}
57
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
58
+ * {% endplatform_content %}
59
+ * {% platform_content react %}
60
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
61
+ * {% endplatform_content %}
62
+ * {% platform_content vue %}
63
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
64
+ * {% endplatform_content %}
56
65
  */
57
66
  format?: string;
58
67
 
@@ -90,15 +99,15 @@ export interface SeriesLabels {
90
99
 
91
100
  /**
92
101
  * Specifies the `from` label configuration of the Chart series.
93
- * Displays the series from labels when either the `series.labels.visible` or
94
- * the `series.labels.from.visible` option is set to `true`.
102
+ * Displays the series from labels when either the [`series.labels.visible`]({% slug api_charts_serieslabels %}#visible) or
103
+ * the [`series.labels.from.visible`]({% slug api_charts_serieslabelsfrom %}#visible) option is set to `true`.
95
104
  */
96
105
  from?: SeriesLabelsFrom;
97
106
 
98
107
  /**
99
108
  * Specifies the `to` label configuration of the Chart series.
100
- * Displays the series to labels when either the `series.labels.visible` or
101
- * the `series.labels.to.visible` option is set to `true`.
109
+ * Displays the series to labels when either the [`series.labels.visible`]({% slug api_charts_serieslabels %}#visible) or
110
+ * the [`series.labels.to.visible`]({% slug api_charts_serieslabelsto %}#visible) option is set to `true`.
102
111
  */
103
112
  to?: SeriesLabelsTo;
104
113
  }
@@ -34,7 +34,16 @@ export interface SeriesLabelsTo {
34
34
  font?: string;
35
35
 
36
36
  /**
37
- * Sets the format of the `to` labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
37
+ * Sets the format of the `to` labels.
38
+ * {% platform_content angular %}
39
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
40
+ * {% endplatform_content %}
41
+ * {% platform_content react %}
42
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
43
+ * {% endplatform_content %}
44
+ * {% platform_content vue %}
45
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
46
+ * {% endplatform_content %}
38
47
  */
39
48
  format?: string;
40
49
 
@@ -35,7 +35,15 @@ export interface SeriesNotesLabel {
35
35
 
36
36
  /**
37
37
  * Sets the format for displaying the notes label.
38
- * Uses the [`format` method from `@progress/kendo-intl`]( https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting) and contains one placeholder (`"{0}"`) which represents the axis value.
38
+ * {% platform_content angular %}
39
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
40
+ * {% endplatform_content %}
41
+ * {% platform_content react %}
42
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
43
+ * {% endplatform_content %}
44
+ * {% platform_content vue %}
45
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
46
+ * {% endplatform_content %}
39
47
  */
40
48
  format?: string;
41
49
 
@@ -29,7 +29,15 @@ export interface SeriesTooltip {
29
29
 
30
30
  /**
31
31
  * Sets the format of the labels.
32
- * Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
32
+ * {% platform_content angular %}
33
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
34
+ * {% endplatform_content %}
35
+ * {% platform_content react %}
36
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
37
+ * {% endplatform_content %}
38
+ * {% platform_content vue %}
39
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
40
+ * {% endplatform_content %}
33
41
  *
34
42
  * Use different value placeholders depending on the Chart type.
35
43
  *
@@ -31,6 +31,12 @@ export interface Tooltip {
31
31
  * {% platform_content angular %}
32
32
  * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
33
33
  * {% endplatform_content %}
34
+ * {% platform_content react %}
35
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
36
+ * {% endplatform_content %}
37
+ * {% platform_content vue %}
38
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
39
+ * {% endplatform_content %}
34
40
  *
35
41
  * The Area, Bar, Column, Funnel, Pyramid, Line, and Pie are represented by `{0}` as the value placeholder.
36
42
  *
@@ -30,7 +30,7 @@ export interface ValueAxisCrosshair {
30
30
 
31
31
  /**
32
32
  * Configures the crosshair tooltip options.
33
- * The crosshair tooltip is displayed when the `valueAxis.crosshair.tooltip.visible` option is set to `true`.
33
+ * The crosshair tooltip is displayed when the [`valueAxis.crosshair.tooltip.visible`]({% slug api_charts_valueaxiscrosshairtooltip %}#visible) option is set to `true`.
34
34
  */
35
35
  tooltip?: ValueAxisCrosshairTooltip;
36
36
  }
@@ -42,7 +42,16 @@ export interface ValueAxisLabels {
42
42
  font?: string;
43
43
 
44
44
  /**
45
- * Specifies the format for displaying the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting). Contains one placeholder (`"{0}"`) which represents the category value.
45
+ * Specifies the format for displaying the labels.
46
+ * {% platform_content angular %}
47
+ * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
48
+ * {% endplatform_content %}
49
+ * {% platform_content react %}
50
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
51
+ * {% endplatform_content %}
52
+ * {% platform_content vue %}
53
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
54
+ * {% endplatform_content %}
46
55
  */
47
56
  format?: string;
48
57
 
@@ -38,6 +38,12 @@ export interface ValueAxisNotesLabel {
38
38
  * {% platform_content angular %}
39
39
  * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
40
40
  * {% endplatform_content %}
41
+ * {% platform_content react %}
42
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
43
+ * {% endplatform_content %}
44
+ * {% platform_content vue %}
45
+ * The value is formatted using the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
46
+ * {% endplatform_content %}
41
47
  */
42
48
  format?: string;
43
49
 
@@ -27,7 +27,7 @@ export interface XAxisCrosshair {
27
27
 
28
28
  /**
29
29
  * Specifies the options of the crosshair tooltip.
30
- * The crosshair tooltip is displayed when the `xAxis.crosshair.tooltip.visible` option is set to `true`.
30
+ * The crosshair tooltip is displayed when the [`xAxis.crosshair.tooltip.visible`]({% slug api_charts_xaxiscrosshairtooltip %}#visible) option is set to `true`.
31
31
  */
32
32
  tooltip?: XAxisCrosshairTooltip;
33
33
  }