@progress/kendo-angular-charts 13.2.0-develop.2 → 13.2.0-develop.4

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 (88) hide show
  1. package/README.md +1 -1
  2. package/api-types/chart-axis.interface.d.ts +8 -8
  3. package/api-types/chart-pane.interface.d.ts +2 -2
  4. package/argument-types/legend-item-visual-args.interface.d.ts +1 -1
  5. package/chart/axis-defaults/crosshair.component.d.ts +1 -1
  6. package/chart/axis-defaults/labels.component.d.ts +1 -1
  7. package/chart/axis-defaults/title.component.d.ts +1 -1
  8. package/chart/axis-defaults.component.d.ts +5 -108
  9. package/chart-options.interface.d.ts +0 -4
  10. package/esm2020/chart/axis-defaults/crosshair.component.mjs +1 -1
  11. package/esm2020/chart/axis-defaults/labels.component.mjs +1 -1
  12. package/esm2020/chart/axis-defaults/title.component.mjs +1 -1
  13. package/esm2020/chart/axis-defaults.component.mjs +5 -108
  14. package/esm2020/package-metadata.mjs +2 -2
  15. package/fesm2015/progress-kendo-angular-charts.mjs +10 -113
  16. package/fesm2020/progress-kendo-angular-charts.mjs +10 -113
  17. package/field-types/auto-base-unit-steps.interface.d.ts +12 -7
  18. package/field-types/axis-line.interface.d.ts +1 -1
  19. package/field-types/axis-ticks.interface.d.ts +1 -1
  20. package/field-types/border.interface.d.ts +1 -1
  21. package/field-types/grid-lines.interface.d.ts +1 -1
  22. package/field-types/mousewheel-select.interface.d.ts +1 -6
  23. package/field-types/mousewheel-zoom.interface.d.ts +0 -1
  24. package/field-types/overlay.interface.d.ts +1 -5
  25. package/field-types/plot-band-label.interface.d.ts +3 -17
  26. package/field-types/series-line.interface.d.ts +0 -6
  27. package/field-types/series-median.interface.d.ts +1 -1
  28. package/field-types/series-stack.interface.d.ts +1 -4
  29. package/option-types/axis-defaults/crosshair.interface.d.ts +2 -12
  30. package/option-types/axis-defaults/crosshair.tooltip.interface.d.ts +1 -1
  31. package/option-types/axis-defaults/labels.interface.d.ts +1 -13
  32. package/option-types/axis-defaults/title.interface.d.ts +1 -17
  33. package/option-types/axis-defaults.interface.d.ts +3 -3
  34. package/option-types/category-axis-item/crosshair.interface.d.ts +0 -10
  35. package/option-types/category-axis-item/labels.interface.d.ts +3 -16
  36. package/option-types/category-axis-item/notes.icon.interface.d.ts +0 -6
  37. package/option-types/category-axis-item/notes.interface.d.ts +0 -14
  38. package/option-types/category-axis-item/notes.label.interface.d.ts +0 -5
  39. package/option-types/category-axis-item/title.interface.d.ts +0 -16
  40. package/option-types/category-axis-item.interface.d.ts +9 -26
  41. package/option-types/legend/item.interface.d.ts +0 -7
  42. package/option-types/legend/legend-title.interface.d.ts +0 -9
  43. package/option-types/legend/markers.interface.d.ts +1 -17
  44. package/option-types/legend.interface.d.ts +2 -20
  45. package/option-types/pane/title.interface.d.ts +2 -6
  46. package/option-types/pane-defaults/title.interface.d.ts +1 -13
  47. package/option-types/series-defaults/labels.interface.d.ts +0 -8
  48. package/option-types/series-defaults/notes.icon.interface.d.ts +0 -6
  49. package/option-types/series-defaults/notes.interface.d.ts +0 -11
  50. package/option-types/series-defaults/notes.label.interface.d.ts +0 -5
  51. package/option-types/series-defaults/tooltip.interface.d.ts +9 -12
  52. package/option-types/series-defaults.interface.d.ts +0 -41
  53. package/option-types/series-item/error-bars.interface.d.ts +0 -9
  54. package/option-types/series-item/extremes.interface.d.ts +0 -6
  55. package/option-types/series-item/highlight.interface.d.ts +0 -30
  56. package/option-types/series-item/labels.from.interface.d.ts +8 -8
  57. package/option-types/series-item/labels.interface.d.ts +0 -8
  58. package/option-types/series-item/labels.to.interface.d.ts +8 -8
  59. package/option-types/series-item/markers.interface.d.ts +0 -19
  60. package/option-types/series-item/notes.icon.interface.d.ts +0 -6
  61. package/option-types/series-item/notes.interface.d.ts +0 -19
  62. package/option-types/series-item/notes.label.interface.d.ts +0 -4
  63. package/option-types/series-item/outliers.interface.d.ts +0 -6
  64. package/option-types/series-item/tooltip.interface.d.ts +8 -14
  65. package/option-types/series-item.interface.d.ts +15 -59
  66. package/option-types/subtitle.interface.d.ts +2 -7
  67. package/option-types/title.interface.d.ts +2 -9
  68. package/option-types/tooltip.interface.d.ts +6 -9
  69. package/option-types/value-axis-item/labels.interface.d.ts +2 -21
  70. package/option-types/value-axis-item/notes.icon.interface.d.ts +0 -6
  71. package/option-types/value-axis-item/notes.interface.d.ts +0 -12
  72. package/option-types/value-axis-item/notes.label.interface.d.ts +0 -3
  73. package/option-types/value-axis-item/title.interface.d.ts +0 -16
  74. package/option-types/value-axis-item.interface.d.ts +5 -7
  75. package/option-types/x-axis-item/labels.interface.d.ts +0 -14
  76. package/option-types/x-axis-item/notes.icon.interface.d.ts +0 -6
  77. package/option-types/x-axis-item/notes.interface.d.ts +0 -13
  78. package/option-types/x-axis-item/notes.label.interface.d.ts +0 -4
  79. package/option-types/x-axis-item/title.interface.d.ts +0 -16
  80. package/option-types/x-axis-item.interface.d.ts +2 -19
  81. package/option-types/y-axis-item/labels.interface.d.ts +0 -14
  82. package/option-types/y-axis-item/notes.icon.interface.d.ts +0 -6
  83. package/option-types/y-axis-item/notes.interface.d.ts +0 -12
  84. package/option-types/y-axis-item/notes.label.interface.d.ts +0 -4
  85. package/option-types/y-axis-item/title.interface.d.ts +0 -16
  86. package/option-types/y-axis-item.interface.d.ts +2 -19
  87. package/package.json +7 -7
  88. package/stock-chart/option-types/navigator/hint.interface.d.ts +2 -5
@@ -2227,8 +2227,8 @@ const packageMetadata = {
2227
2227
  name: '@progress/kendo-angular-charts',
2228
2228
  productName: 'Kendo UI for Angular',
2229
2229
  productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
2230
- publishDate: 1688401208,
2231
- version: '13.2.0-develop.2',
2230
+ publishDate: 1688648231,
2231
+ version: '13.2.0-develop.4',
2232
2232
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
2233
2233
  };
2234
2234
 
@@ -3228,115 +3228,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
3228
3228
  }] } });
3229
3229
 
3230
3230
  /**
3231
- * The default options for all Chart axes.
3232
- * Accepts the options which are supported by [`categoryAxis`]({% slug api_charts_categoryaxisitemcomponent %}),
3233
- * [`valueAxis`]({% slug api_charts_valueaxisitemcomponent %}),
3234
- * [`xAxis`]({% slug api_charts_xaxisitemcomponent %}),
3235
- * and [`yAxis`]({% slug api_charts_yaxisitemcomponent %}).
3231
+ * The default options for all Chart axes ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
3232
+ * Accepts the options which are supported by [`categoryAxis`](slug:api_charts_categoryaxisitemcomponent),
3233
+ * [`valueAxis`](slug:api_charts_valueaxisitemcomponent),
3234
+ * [`xAxis`](slug:api_charts_xaxisitemcomponent),
3235
+ * and [`yAxis`](slug:api_charts_yaxisitemcomponent).
3236
3236
  *
3237
- * @example
3238
- * ```ts-preview
3239
- * import { Component } from '@angular/core';
3240
- *
3241
- * _@Component({
3242
- * selector: 'my-app',
3243
- * template: `
3244
- * <div style="height: 600px;">
3245
- * <kendo-chart [categoryAxis]="{ categories: categories }" [chartArea]="{height: 600}" >
3246
- * <kendo-chart-axis-defaults
3247
- * [background]="background"
3248
- * [color]="color"
3249
- * [crosshair]="crosshair"
3250
- * [labels]="labels"
3251
- * [line]="line"
3252
- * [majorGridLines]="majorGridLines"
3253
- * [minorGridLines]="minorGridLines"
3254
- * [majorTicks]="majorTicks"
3255
- * [minorTicks]="minorTicks"
3256
- * [title]="title"
3257
- * ></kendo-chart-axis-defaults>
3258
- * <kendo-chart-title text="Gross domestic product growth /GDP annual %/"></kendo-chart-title>
3259
- * <kendo-chart-legend position="bottom" orientation="horizontal"></kendo-chart-legend>
3260
- * <kendo-chart-tooltip format="{0}%"></kendo-chart-tooltip>
3261
- * <kendo-chart-series>
3262
- * <kendo-chart-series-item *ngFor="let item of series"
3263
- * type="line" style="smooth" [data]="item.data" [name]="item.name">
3264
- * </kendo-chart-series-item>
3265
- * </kendo-chart-series>
3266
- * </kendo-chart>
3267
- * </div>
3268
- * `
3269
- * })
3270
- * export class AppComponent {
3271
- * public series: any[] = [{
3272
- * name: "India",
3273
- * data: [4, 8, 8, 9, 9, 9, 3, 8, 9, 6]
3274
- * }, {
3275
- * name: "Russian Federation",
3276
- * data: [4, 7, 7, 6, 8, 8, 5, 8, 4, 4]
3277
- * }, {
3278
- * name: "Germany",
3279
- * data: [0, 0, 1, 1, 4, 3, 1, 5, 4, 3]
3280
- * },{
3281
- * name: "World",
3282
- * data: [2, 3, 4, 4, 4, 4, 1, 2, 4, 3]
3283
- * }];
3284
- *
3285
- * public categories: number[] = [2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011];
3286
- *
3287
- * public background = 'white';
3288
- * // public color = 'cyan'; // will override the line.color option
3289
- * public crosshair = {
3290
- * visible: true
3291
- * };
3292
- * public labels = {
3293
- * font: 'bold 12px/30px Helvetica, Arial, sans-serif',
3294
- * color: '#4CAF50',
3295
- * padding: 5,
3296
- * rotation: 45,
3297
- * background: 'white',
3298
- * border: {
3299
- * color: '#4CAF50',
3300
- * width: 2
3301
- * },
3302
- * };
3303
- * public line = {
3304
- * color: 'black',
3305
- * width: 3
3306
- * };
3307
- *
3308
- * public majorGridLines = {
3309
- * color: 'black',
3310
- * visible: true
3311
- * }
3312
- *
3313
- * public minorGridLines = {
3314
- * color: 'lightgray',
3315
- * visible: true
3316
- * }
3317
- *
3318
- * public majorTicks = {
3319
- * color: 'black',
3320
- * size: 15
3321
- * }
3322
- *
3323
- * public minorTicks = {
3324
- * color: 'lightgray',
3325
- * size: 10
3326
- * }
3327
- *
3328
- * public title = {
3329
- * text: 'Default Axis Title',
3330
- * color: 'black',
3331
- * background: 'white',
3332
- * border: {
3333
- * color: 'black',
3334
- * width: 2
3335
- * },
3336
- * padding: 10
3337
- * }
3338
- * }
3339
- * ```
3340
3237
  */
3341
3238
  class AxisDefaultsComponent extends SettingsComponent {
3342
3239
  constructor(configurationService) {
@@ -3388,7 +3285,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
3388
3285
  }] } });
3389
3286
 
3390
3287
  /**
3391
- * The crosshair configuration options ([see example]({% slug api_charts_axisdefaultscomponent %})).
3288
+ * The crosshair configuration options ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
3392
3289
  */
3393
3290
  class AxisDefaultsCrosshairComponent extends SettingsComponent {
3394
3291
  constructor(configurationService) {
@@ -3458,7 +3355,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
3458
3355
  }] } });
3459
3356
 
3460
3357
  /**
3461
- * The configuration of the axis labels ([see example]({% slug api_charts_axisdefaultscomponent %})).
3358
+ * The configuration of the axis labels ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
3462
3359
  */
3463
3360
  class AxisDefaultsLabelsComponent extends SettingsComponent {
3464
3361
  constructor(configurationService) {
@@ -3500,7 +3397,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
3500
3397
  }] } });
3501
3398
 
3502
3399
  /**
3503
- * The configuration of the axis title ([see example]({% slug api_charts_axisdefaultscomponent %})).
3400
+ * The configuration of the axis title ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
3504
3401
  */
3505
3402
  class AxisDefaultsTitleComponent extends SettingsComponent {
3506
3403
  constructor(configurationService) {
@@ -8,14 +8,19 @@
8
8
  * The axis will divide the active period into the smallest possible intervals
9
9
  * that do not exceed the set `maxDateGroups` value.
10
10
  *
11
- * {% meta height:450 %}
12
- * {% embed_file stock/zoom-steps/app.component.ts preview %}
13
- * {% embed_file stock/zoom-steps/app.module.ts %}
14
- * {% embed_file stock/zoom-steps/stock-data.service.ts %}
15
- * {% embed_file shared/stock-data.ts %}
16
- * {% embed_file shared/main.ts hidden %}
17
- * {% endmeta %}
18
11
  *
12
+ * ```html
13
+ * <kendo-chart-category-axis>
14
+ * <kendo-chart-category-axis-item [autoBaseUnitSteps]="baseUnitSteps">
15
+ * </kendo-chart-category-axis-item>
16
+ * </kendo-chart-category-axis>
17
+ * ```
18
+ * ```ts
19
+ * public baseUnitSteps: AutoBaseUnitSteps = {
20
+ * // Do not allow zooming into hours
21
+ * weeks: [],
22
+ * };
23
+ * ```
19
24
  */
20
25
  export interface AutoBaseUnitSteps {
21
26
  /**
@@ -6,7 +6,7 @@ import { DashType } from './dash-type';
6
6
  /**
7
7
  * The appearance settings for the axis lines.
8
8
  * Affects the major and minor axis ticks, but not the grid lines
9
- * ([see example]({% slug api_charts_axisdefaultscomponent %})).
9
+ * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
10
10
  */
11
11
  export interface AxisLine {
12
12
  /**
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * The appearance configuration for the major and minor axis ticks
7
- * ([see example]({% slug api_charts_axisdefaultscomponent %})).
7
+ * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
8
8
  */
9
9
  export interface AxisTicks {
10
10
  /**
@@ -5,7 +5,7 @@
5
5
  import { DashType } from './dash-type';
6
6
  /**
7
7
  * The appearance settings for the border lines
8
- * ([see example]({% slug api_charts_titlecomponent %})).
8
+ * ([see example](slug:title_chart_charts#toc-basics)).
9
9
  */
10
10
  export interface Border {
11
11
  /**
@@ -5,7 +5,7 @@
5
5
  import { DashType } from './dash-type';
6
6
  /**
7
7
  * The appearance configuration for the major and minor axis grid lines
8
- * ([see example]({% slug api_charts_axisdefaultscomponent %})).
8
+ * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
9
9
  */
10
10
  export interface GridLines {
11
11
  /**
@@ -14,12 +14,7 @@ export interface MousewheelSelect {
14
14
  reverse?: boolean;
15
15
  /**
16
16
  * The zoom direction of the selection.
17
- *
18
- * The supported values are:
19
- *
20
- * * `"both"`&mdash;Zooming expands and contracts the selection on both sides.
21
- * * `"left"`&mdash;Zooming expands and contracts the selection on the left side only.
22
- * * `"right"`&mdash;Zooming expands and contracts the selection on the right side only.
17
+ * The `both` option enables zooming to expand and contract the selection on both sides, while the `left` option allows zooming on the left side only, and the `right` option permits zooming on the right side only.
23
18
  */
24
19
  zoom?: 'both' | 'left' | 'right';
25
20
  }
@@ -16,7 +16,6 @@ export interface MousewheelZoom {
16
16
  *
17
17
  * The accepted range is from 0.01 to 0.9 (1% to 90%).
18
18
  *
19
- * @default 0.3
20
19
  */
21
20
  rate?: number;
22
21
  }
@@ -9,11 +9,7 @@ export interface Overlay {
9
9
  /**
10
10
  * The gradient of the Chart series.
11
11
  *
12
- * The supported values are:
13
- * * `"glass"`&mdash;Applicable for the Bar, Column, and Candlestick series.
14
- * * `"none"`
15
- * * `"roundedBevel"`&mdash;Applicable for the Donut and Pie series.
16
- * * `"sharpBevel"`&mdash;Applicable for the Donut and Pie series.
12
+ * The `glass` is applicable for Bar, Column and Candlestick. The `roundedBevel` and `sharpBevel` are applicable to Donut and Pie series.
17
13
  */
18
14
  gradient?: 'glass' | 'none' | 'roundedBevel' | 'sharpBevel';
19
15
  }
@@ -16,10 +16,7 @@ export interface PlotBandLabel {
16
16
  *
17
17
  * By default, the label is aligned to the left.
18
18
  *
19
- * The supported values are:
20
- * - `"center"`&mdash;The label is positioned in the center of the plot band.
21
- * - `"right"`&mdash;The label is positioned on the right side of the plot band.
22
- * - `"left"`&mdash;The label is positioned on the left side of the plot band.
19
+ * The positioning of the label within a plot band can be set to `center` for center positioning, `right` for positioning on the right side, or `left` for positioning on the left side.
23
20
  */
24
21
  align?: 'center' | 'right' | 'left';
25
22
  /**
@@ -55,10 +52,7 @@ export interface PlotBandLabel {
55
52
  *
56
53
  * By default, the label is aligned to the top.
57
54
  *
58
- * The supported values are:
59
- * - `"bottom"`&mdash;The label is positioned on the bottom of the plot band.
60
- * - `"center"`&mdash;The label is positioned in the center of the plot band.
61
- * - `"top"`&mdash;The label is positioned on the top of the plot band.
55
+ * The positioning of the label within a plot band can be set to `bottom` for positioning at the bottom, `center` for center positioning, or `top` for positioning at the top.
62
56
  */
63
57
  position?: 'bottom' | 'center' | 'top';
64
58
  /**
@@ -68,7 +62,7 @@ export interface PlotBandLabel {
68
62
  /**
69
63
  * The text of the label.
70
64
  *
71
- * > The text can be split into multiple lines by using line feed characters ("\n").
65
+ * The text can be split into multiple lines by using line feed characters ("\n").
72
66
  */
73
67
  text?: string;
74
68
  /**
@@ -78,14 +72,6 @@ export interface PlotBandLabel {
78
72
  visible?: boolean;
79
73
  /**
80
74
  * A function that can be used to create a custom visual for the label.
81
- *
82
- * The available argument fields are:
83
- *
84
- * - `text`&mdash;The label text.
85
- * - `rect`&mdash;The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
86
- * - `options`&mdash;The label options.
87
- * - `createVisual`&mdash;A function that can be used to get the default visual.
88
- * - `sender`&mdash;A reference to the Chart instance.
89
75
  */
90
76
  visual?: (e: PlotBandLabelVisualArgs) => drawing.Element;
91
77
  }
@@ -18,12 +18,6 @@ export interface SeriesLine {
18
18
  /**
19
19
  * The drawing style of the line.
20
20
  * Applicable for the Area, Range Area, Polar Area, and Radar Area series.
21
- *
22
- * The supported values are:
23
- *
24
- * * `"normal" (default)`&mdash;The values are connected with a straight line.
25
- * * `"step"`&mdash;The values are connected with a right-angled line. Supported only for the Area and Range Area series.
26
- * * `"smooth"`&mdash;The values are connected with a smooth line.
27
21
  */
28
22
  style?: LineStyle;
29
23
  /**
@@ -12,7 +12,7 @@ export interface SeriesMedian {
12
12
  */
13
13
  color?: string;
14
14
  /**
15
- * The dash type of the line. By default, the line is not dashed (`[dashType]="solid"`).
15
+ * The dash type of the line. By default, the line is solid (`[dashType]="solid"`).
16
16
  */
17
17
  dashType?: DashType;
18
18
  /**
@@ -14,10 +14,7 @@ export interface SeriesStack {
14
14
  /**
15
15
  * The type of stack to plot.
16
16
  *
17
- * The following types are supported:
18
- *
19
- * * `"normal"`&mdash;The value of the stack is the sum of all points in the category (or group).
20
- * * `"100%"`&mdash;The value of the stack is always 100% (1.00). Points within the category (or group) are represented in percentage.
17
+ * The `normal` option sums up all the points within the category or group to determine the stack value. On the other hand, the `100%` option always sets the stack value to 100% (1.00), with individual points represented as percentages within the category or group.
21
18
  */
22
19
  type?: 'normal' | '100%';
23
20
  }
@@ -6,7 +6,7 @@ import { DashType } from '../../common/property-types';
6
6
  import { AxisDefaultsCrosshairTooltip } from './crosshair.tooltip.interface';
7
7
  /**
8
8
  * The configuration options of the axis crosshair
9
- * ([see example]({% slug api_charts_axisdefaultscomponent %})).
9
+ * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
10
10
  */
11
11
  export interface AxisDefaultsCrosshair {
12
12
  /**
@@ -15,16 +15,6 @@ export interface AxisDefaultsCrosshair {
15
15
  color?: string;
16
16
  /**
17
17
  * The dash type of the crosshair.
18
- *
19
- * The following dash types are supported:
20
- *
21
- * - `"dash"`&mdash;A line which consists of dashes.
22
- * - `"dashDot"`&mdash;A line which consists of a repeating pattern of dash-dot.
23
- * - `"dot"`&mdash;A line which consists of dots.
24
- * - `"longDash"`&mdash;A line which consists of a repeating pattern of long-dash.
25
- * - `"longDashDot"`&mdash;A line which consists of a repeating pattern of long-dash-dot.
26
- * - `"longDashDotDot"`&mdash;A line which consists of a repeating pattern of long-dash-dot-dot.
27
- * - `"solid"`&mdash;A solid line.
28
18
  */
29
19
  dashType?: DashType;
30
20
  /**
@@ -42,7 +32,7 @@ export interface AxisDefaultsCrosshair {
42
32
  width?: number;
43
33
  /**
44
34
  * The options of the crosshair tooltip.
45
- * The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`]({% slug api_charts_axisdefaultscrosshairtooltip %}#toc-visible)
35
+ * The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`](slug:api_charts_axisdefaultscrosshairtooltip#toc-visible)
46
36
  * option is set to `true`.
47
37
  */
48
38
  tooltip?: AxisDefaultsCrosshairTooltip;
@@ -24,7 +24,7 @@ export interface AxisDefaultsCrosshairTooltip {
24
24
  */
25
25
  font?: string;
26
26
  /**
27
- * The format for displaying the tooltip. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
27
+ * The format for displaying the tooltip. Uses the [`format`](slug:api_intl_intlservice#toc-format) method of `IntlService`.
28
28
  * Contains one placeholder (`"{0}"`) which represents the category value.
29
29
  */
30
30
  format?: string;
@@ -6,7 +6,7 @@ import { drawing } from '@progress/kendo-drawing';
6
6
  import { AxisLabelContentArgs, AxisLabelVisualArgs, LabelRotation, Margin, Padding } from '../../common/property-types';
7
7
  /**
8
8
  * The configuration options for the axis label
9
- * ([see example]({% slug api_charts_axisdefaultscomponent %})).
9
+ * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
10
10
  */
11
11
  export interface AxisDefaultsLabels {
12
12
  /**
@@ -57,18 +57,6 @@ export interface AxisDefaultsLabels {
57
57
  visible?: boolean;
58
58
  /**
59
59
  * A function that for creating a custom visual for the labels.
60
- *
61
- * The available argument fields are:
62
- *
63
- * - `createVisual`&mdash;A function for getting the default visual.
64
- * - `culture`&mdash;The default culture (if set) of the label.
65
- * - `dataItem`&mdash;The data item if a field has been specified.
66
- * - `format`&mdash;The default format of the label.
67
- * - `options`&mdash;The label options.
68
- * - `rect`&mdash;The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
69
- * - `sender`&mdash;The Chart instance (can be `undefined`).
70
- * - `text`&mdash;The label text.
71
- * - `value`&mdash;The category value.
72
60
  */
73
61
  visual?: (e: AxisLabelVisualArgs) => drawing.Element;
74
62
  }
@@ -6,7 +6,7 @@ import { drawing } from '@progress/kendo-drawing';
6
6
  import { AxisTitlePosition, Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types';
7
7
  /**
8
8
  * The configuration options for the axis title
9
- * ([see example]({% slug api_charts_axisdefaultscomponent %})).
9
+ * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
10
10
  */
11
11
  export interface AxisDefaultsTitle {
12
12
  /**
@@ -35,14 +35,6 @@ export interface AxisDefaultsTitle {
35
35
  padding?: Padding | number;
36
36
  /**
37
37
  * The position of the title.
38
- *
39
- * The supported values are:
40
- *
41
- * - `"top"`&mdash;The axis title is positioned on the top (applicable for the vertical axis).
42
- * - `"bottom"`&mdash;The axis title is positioned on the bottom (applicable for the vertical axis).
43
- * - `"left"`&mdash;The axis title is positioned on the left (applicable for the horizontal axis).
44
- * - `"right"`&mdash;The axis title is positioned on the right (applicable for the horizontal axis).
45
- * - `"center"`&mdash;The axis title is positioned in the center.
46
38
  */
47
39
  position?: AxisTitlePosition;
48
40
  /**
@@ -59,14 +51,6 @@ export interface AxisDefaultsTitle {
59
51
  visible?: boolean;
60
52
  /**
61
53
  * A function that can be used to create a custom visual for the title.
62
- *
63
- * The available argument fields are:
64
- *
65
- * - `text`&mdash;The label text.
66
- * - `rect`&mdash;The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
67
- * - `sender`&mdash;The Chart instance (can be `undefined`).
68
- * - `options`&mdash;The label options.
69
- * - `createVisual`&mdash;A function for getting the default visual.
70
54
  */
71
55
  visual?: (e: TitleVisualArgs) => drawing.Element;
72
56
  }
@@ -15,7 +15,7 @@ export interface AxisDefaults {
15
15
  */
16
16
  background?: string;
17
17
  /**
18
- * The color to apply to all axis elements. Accepts a valid CSS color string, including hex and rgb.
18
+ * The color to apply to all axis elements. Accepts a valid CSS color string, including HEX and RGB.
19
19
  */
20
20
  color?: string;
21
21
  /**
@@ -70,7 +70,7 @@ export interface AxisDefaults {
70
70
  visible?: boolean;
71
71
  /**
72
72
  * The crosshair configuration options.
73
- * The crosshair is displayed when the [`axisDefaults.crosshair.visible`]({% slug api_charts_axisdefaultscrosshair %}#toc-visible) option is set to `true`.
73
+ * The crosshair is displayed when the [`axisDefaults.crosshair.visible`](slug:api_charts_axisdefaultscrosshair#toc-visible) option is set to `true`.
74
74
  */
75
75
  crosshair?: AxisDefaultsCrosshair;
76
76
  /**
@@ -79,7 +79,7 @@ export interface AxisDefaults {
79
79
  labels?: AxisDefaultsLabels;
80
80
  /**
81
81
  * The title configuration of the axis.
82
- * To display the title, set the [`axisDefaults.title.text`]({% slug api_charts_axisdefaultstitle %}#toc-text) option.
82
+ * To display the title, set the [`axisDefaults.title.text`](slug:api_charts_axisdefaultstitle#toc-text) option.
83
83
  */
84
84
  title?: AxisDefaultsTitle;
85
85
  }
@@ -14,16 +14,6 @@ export interface CategoryAxisCrosshair {
14
14
  color?: string;
15
15
  /**
16
16
  * The dash type of the crosshair.
17
- *
18
- * The following dash types are supported:
19
- *
20
- * - `"dash"`&mdash;A line consisting of dashes.
21
- * - `"dashDot"`&mdash;A line consisting of a repeating pattern of dash-dot.
22
- * - `"dot"`&mdash;A line consisting of dots.
23
- * - `"longDash"`&mdash;A line consisting of a repeating pattern of long-dash.
24
- * - `"longDashDot"`&mdash;A line consisting of a repeating pattern of long-dash-dot.
25
- * - `"longDashDotDot"`&mdash;A line consisting of a repeating pattern of long-dash-dot-dot.
26
- * - `"solid"`&mdash;A solid line.
27
17
  */
28
18
  dashType?: DashType;
29
19
  /**
@@ -38,7 +38,7 @@ export interface CategoryAxisLabels {
38
38
  * Setting the [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#toc-format) option overrides the date formats.
39
39
  * For more information, refer to the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
40
40
  *
41
- * > Not supported for Radar Charts. Use [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#toc-format) instead.
41
+ * For Radar Charts, the feature is not supported. Use [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#toc-format) instead.
42
42
  */
43
43
  dateFormats?: DateFormats;
44
44
  /**
@@ -65,10 +65,8 @@ export interface CategoryAxisLabels {
65
65
  padding?: Padding | number;
66
66
  /**
67
67
  * The position of the axis labels. By default, labels are positioned next to the axis.
68
- * * When `position` is set to `end`, the labels are placed at the end of the crossing axis&mdash;
69
- * typically, at the top or right end of the Chart unless the crossing axis was reversed.
70
- * * When `position` is set to `start`, the labels are placed at the start of the crossing axis&mdash;
71
- * typically, at the left or bottom end of the Chart unless the crossing axis was reversed.
68
+ * When `position` is set to `end`, the labels are placed at the end of the crossing axis, usually at the top or right end of the Chart unless the crossing axis has been reversed.
69
+ * Alternatively, when the `position` property is set to `start`, the axis labels will be positioned at the beginning of the crossing axis, typically located at the left or bottom end of the Chart, unless the crossing axis has been reversed.
72
70
  */
73
71
  position?: AxisLabelsPosition;
74
72
  /**
@@ -93,17 +91,6 @@ export interface CategoryAxisLabels {
93
91
  visible?: boolean;
94
92
  /**
95
93
  * A function for creating a custom visual for the labels.
96
- *
97
- * The available argument fields are:
98
- * - `createVisual`&mdash;A function for getting the default visual.
99
- * - `culture`&mdash;The default culture (if set) on the label.
100
- * - `dataItem`&mdash;The data item if a field is specified.
101
- * - `format`&mdash;The default format of the label.
102
- * - `options`&mdash;The label options.
103
- * - `rect`&mdash;The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
104
- * - `sender`&mdash;The Chart instance (might be `undefined`).
105
- * - `text`&mdash;The label text.
106
- * - `value`&mdash;The category value.
107
94
  */
108
95
  visual?: (e: AxisLabelVisualArgs) => drawing.Element;
109
96
  }
@@ -21,12 +21,6 @@ export interface CategoryAxisNotesIcon {
21
21
  size?: number;
22
22
  /**
23
23
  * The shape of the notes icon.
24
- *
25
- * The supported values are:
26
- * * `"circle"`&mdash;The marker shape is a circle.
27
- * * `"square"`&mdash;The marker shape is a square.
28
- * * `"triangle"`&mdash;The marker shape is a triangle.
29
- * * `"cross"`&mdash;The marker shape is a cross.
30
24
  */
31
25
  type?: MarkerType;
32
26
  /**
@@ -20,24 +20,10 @@ export interface CategoryAxisNotes {
20
20
  line?: NoteLine;
21
21
  /**
22
22
  * The position of the category axis note.
23
- *
24
- * The available options are:
25
- *
26
- * - `"top"`&mdash;The note is positioned on the top.
27
- * - `"bottom"`&mdash;The note is positioned on the bottom.
28
- * - `"left"`&mdash;The note is positioned on the left.
29
- * - `"right"`&mdash;The note is positioned on the right.
30
23
  */
31
24
  position?: NotePosition;
32
25
  /**
33
26
  * A function that can be used to create a custom visual for the notes.
34
- *
35
- * The available argument fields are:
36
- *
37
- * - `rect`&mdash;The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines the note target rect.
38
- * - `options`&mdash;The note options.
39
- * - `createVisual`&mdash;A function for getting the default visual.
40
- * - `value`&mdash;The note value.
41
27
  */
42
28
  visual?: (e: AxisNoteVisualArgs) => drawing.Element;
43
29
  /**
@@ -35,11 +35,6 @@ export interface CategoryAxisNotesLabel {
35
35
  format?: string;
36
36
  /**
37
37
  * The position of the label.
38
- *
39
- * The available options are:
40
- *
41
- * - `"inside"`&mdash;The label is positioned inside the icon.
42
- * - `"outside"`&mdash;The label is positioned outside the icon.
43
38
  */
44
39
  position?: NoteLabelPosition;
45
40
  /**
@@ -34,14 +34,6 @@ export interface CategoryAxisTitle {
34
34
  padding?: Padding | number;
35
35
  /**
36
36
  * The position of the title.
37
- *
38
- * The supported values are:
39
- *
40
- * - `"top"`&mdash;The axis title is positioned on the top (applicable to the vertical axis).
41
- * - `"bottom"`&mdash;The axis title is positioned on the bottom (applicable to the vertical axis).
42
- * - `"left"`&mdash;The axis title is positioned on the left (applicable to the horizontal axis).
43
- * - `"right"`&mdash;The axis title is positioned on the right (applicable to the horizontal axis).
44
- * - `"center"`&mdash;The axis title is positioned in the center.
45
37
  */
46
38
  position?: AxisTitlePosition;
47
39
  /**
@@ -60,14 +52,6 @@ export interface CategoryAxisTitle {
60
52
  visible?: boolean;
61
53
  /**
62
54
  * A function that can be used to create a custom visual for the title.
63
- *
64
- * The available argument fields are:
65
- *
66
- * - `text`&mdash;The label text.
67
- * - `rect`&mdash;The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
68
- * - `sender`&mdash;The Chart instance (can be `undefined`).
69
- * - `options`&mdash;The label options.
70
- * - `createVisual`&mdash;A function for getting the default visual.
71
55
  */
72
56
  visual?: (e: TitleVisualArgs) => drawing.Element;
73
57
  }