@progress/kendo-angular-gauges 19.1.2-develop.4 → 19.1.2-develop.6

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 (93) hide show
  1. package/arc-gauge/arc-center-template.directive.d.ts +10 -20
  2. package/arc-gauge/arc-gauge.component.d.ts +12 -10
  3. package/arc-gauge/arc-gauge.module.d.ts +5 -6
  4. package/arc-gauge/color.component.d.ts +36 -1
  5. package/arc-gauge/colors.component.d.ts +5 -3
  6. package/arc-gauge/gauge-area.component.d.ts +22 -2
  7. package/arc-gauge/labels.component.d.ts +23 -1
  8. package/arc-gauge/scale.component.d.ts +40 -1
  9. package/circular-gauge/center-template.directive.d.ts +9 -20
  10. package/circular-gauge/circular-gauge.component.d.ts +4 -2
  11. package/circular-gauge/circular-gauge.module.d.ts +6 -7
  12. package/circular-gauge/gauge-area.component.d.ts +16 -2
  13. package/circular-gauge/labels.component.d.ts +23 -1
  14. package/circular-gauge/scale.component.d.ts +18 -1
  15. package/directives.d.ts +5 -5
  16. package/esm2022/arc-gauge/arc-center-template.directive.mjs +10 -20
  17. package/esm2022/arc-gauge/arc-gauge.component.mjs +12 -10
  18. package/esm2022/arc-gauge/arc-gauge.module.mjs +5 -6
  19. package/esm2022/arc-gauge/color.component.mjs +36 -1
  20. package/esm2022/arc-gauge/colors.component.mjs +5 -3
  21. package/esm2022/arc-gauge/gauge-area.component.mjs +22 -2
  22. package/esm2022/arc-gauge/labels.component.mjs +23 -1
  23. package/esm2022/arc-gauge/scale.component.mjs +40 -1
  24. package/esm2022/circular-gauge/center-template.directive.mjs +9 -20
  25. package/esm2022/circular-gauge/circular-gauge.component.mjs +4 -2
  26. package/esm2022/circular-gauge/circular-gauge.module.mjs +6 -7
  27. package/esm2022/circular-gauge/gauge-area.component.mjs +16 -2
  28. package/esm2022/circular-gauge/labels.component.mjs +23 -1
  29. package/esm2022/circular-gauge/scale.component.mjs +18 -1
  30. package/esm2022/directives.mjs +5 -5
  31. package/esm2022/gauges.module.mjs +3 -3
  32. package/esm2022/linear-gauge/gauge-area.component.mjs +10 -2
  33. package/esm2022/linear-gauge/labels.component.mjs +11 -1
  34. package/esm2022/linear-gauge/linear-gauge.component.mjs +6 -4
  35. package/esm2022/linear-gauge/linear-gauge.module.mjs +4 -4
  36. package/esm2022/linear-gauge/pointer.component.mjs +32 -1
  37. package/esm2022/linear-gauge/pointers.component.mjs +5 -3
  38. package/esm2022/linear-gauge/range.component.mjs +13 -1
  39. package/esm2022/linear-gauge/ranges.component.mjs +8 -3
  40. package/esm2022/linear-gauge/scale.component.mjs +28 -1
  41. package/esm2022/package-metadata.mjs +2 -2
  42. package/esm2022/radial-gauge/gauge-area.component.mjs +17 -2
  43. package/esm2022/radial-gauge/labels.component.mjs +14 -1
  44. package/esm2022/radial-gauge/pointer.component.mjs +23 -1
  45. package/esm2022/radial-gauge/pointers.component.mjs +8 -3
  46. package/esm2022/radial-gauge/radial-gauge.component.mjs +9 -5
  47. package/esm2022/radial-gauge/radial-gauge.module.mjs +5 -5
  48. package/esm2022/radial-gauge/range.component.mjs +13 -1
  49. package/esm2022/radial-gauge/ranges.component.mjs +8 -3
  50. package/esm2022/radial-gauge/scale.component.mjs +27 -1
  51. package/fesm2022/progress-kendo-angular-gauges.mjs +480 -129
  52. package/gauges.module.d.ts +3 -3
  53. package/linear-gauge/gauge-area.component.d.ts +10 -2
  54. package/linear-gauge/labels.component.d.ts +11 -1
  55. package/linear-gauge/linear-gauge.component.d.ts +6 -4
  56. package/linear-gauge/linear-gauge.module.d.ts +4 -4
  57. package/linear-gauge/pointer.component.d.ts +32 -1
  58. package/linear-gauge/pointers.component.d.ts +5 -3
  59. package/linear-gauge/range.component.d.ts +13 -1
  60. package/linear-gauge/ranges.component.d.ts +8 -3
  61. package/linear-gauge/scale.component.d.ts +28 -1
  62. package/package.json +6 -6
  63. package/radial-gauge/gauge-area.component.d.ts +17 -2
  64. package/radial-gauge/labels.component.d.ts +14 -1
  65. package/radial-gauge/pointer.component.d.ts +23 -1
  66. package/radial-gauge/pointers.component.d.ts +8 -3
  67. package/radial-gauge/radial-gauge.component.d.ts +9 -5
  68. package/radial-gauge/radial-gauge.module.d.ts +5 -5
  69. package/radial-gauge/range.component.d.ts +13 -1
  70. package/radial-gauge/ranges.component.d.ts +8 -3
  71. package/radial-gauge/scale.component.d.ts +27 -1
  72. package/types/arc-scale.interface.d.ts +8 -8
  73. package/types/border.interface.d.ts +4 -4
  74. package/types/cap.interface.d.ts +3 -3
  75. package/types/circular-gauge-scale.interface.d.ts +1 -1
  76. package/types/color-range.interface.d.ts +5 -5
  77. package/types/dash-type.interface.d.ts +1 -1
  78. package/types/gauge-area.interface.d.ts +7 -7
  79. package/types/labels.interface.d.ts +10 -10
  80. package/types/line-cap.d.ts +1 -1
  81. package/types/line.interface.d.ts +5 -5
  82. package/types/linear-pointer-shape.d.ts +1 -1
  83. package/types/linear-pointer.interface.d.ts +9 -9
  84. package/types/linear-scale.interface.d.ts +5 -5
  85. package/types/margin.interface.d.ts +5 -5
  86. package/types/padding.interface.d.ts +5 -5
  87. package/types/radial-label-position.d.ts +1 -1
  88. package/types/radial-labels.interface.d.ts +5 -1
  89. package/types/radial-pointer.interface.d.ts +7 -7
  90. package/types/radial-scale.interface.d.ts +8 -8
  91. package/types/range.interface.d.ts +5 -5
  92. package/types/scale.interface.d.ts +10 -10
  93. package/types/ticks.interface.d.ts +5 -5
@@ -9,14 +9,17 @@ import { CollectionChangesService, ConfigurationService } from '../services';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "../services";
11
11
  /**
12
- * A collection of one or more LinearGauge scale ranges
12
+ * Represents a collection of one or more LinearGauge scale ranges
13
13
  * ([more information and example]({% slug scaleranghes_lineargauge %})).
14
14
  *
15
+ * You can use this component to define multiple ranges on your LinearGauge scale. Each range displays a colored segment
16
+ * that highlights specific value intervals on the LinearGauge.
17
+ *
15
18
  * @example
16
19
  * ```ts
17
20
  * import { Component } from '@angular/core';
18
21
  *
19
- * _@Component({
22
+ * @Component({
20
23
  * selector: 'my-app',
21
24
  * template: `
22
25
  * <kendo-lineargauge>
@@ -45,8 +48,10 @@ import * as i1 from "../services";
45
48
  * color: '#78d237'
46
49
  * }];
47
50
  * }
48
- *
49
51
  * ```
52
+ *
53
+ * @remarks
54
+ * Supported children components are: {@link LinearRangeComponent}
50
55
  */
51
56
  export class LinearRangesComponent extends CollectionComponent {
52
57
  children;
@@ -8,14 +8,41 @@ import { ConfigurationService } from '../services';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../services";
10
10
  /**
11
- * The configuration options for the scale of the LinearGauge
11
+ * Represents the configuration options for the scale of the LinearGauge
12
12
  * ([see example]({% slug scaleoptions_lineargauge %})).
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-lineargauge>
17
+ * <kendo-lineargauge-scale [mirror]="true" [vertical]="false">
18
+ * </kendo-lineargauge-scale>
19
+ * </kendo-lineargauge>
20
+ * ```
21
+ *
22
+ * @remarks
23
+ * Supported children components are: {@link LinearLabelsComponent}, {@link LinearRangesComponent}.
13
24
  */
14
25
  export class LinearScaleComponent extends ScaleComponent {
15
26
  configurationService;
27
+ /**
28
+ * Configures the appearance of the scale line.
29
+ */
16
30
  line;
31
+ /**
32
+ * Configures the ranges that are displayed on the scale.
33
+ */
17
34
  ranges;
35
+ /**
36
+ * Mirrors the scale labels and ticks. When you set this option to `true`, the labels and ticks appear on the opposite side of the scale.
37
+ *
38
+ * @default false
39
+ */
18
40
  mirror;
41
+ /**
42
+ * Sets the orientation of the scale. When you set this option to `false`, the scale displays horizontally.
43
+ *
44
+ * @default true
45
+ */
19
46
  vertical;
20
47
  constructor(configurationService) {
21
48
  super('scale', configurationService);
@@ -10,7 +10,7 @@ export const packageMetadata = {
10
10
  productName: 'Kendo UI for Angular',
11
11
  productCode: 'KENDOUIANGULAR',
12
12
  productCodes: ['KENDOUIANGULAR'],
13
- publishDate: 1750157245,
14
- version: '19.1.2-develop.4',
13
+ publishDate: 1750433978,
14
+ version: '19.1.2-develop.6',
15
15
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
16
16
  };
@@ -8,8 +8,23 @@ import { ConfigurationService } from '../services';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../services";
10
10
  /**
11
- * The configuration options for the RadialGauge area.
12
- * Represents the entire visible area of the RadialGauge.
11
+ * Represents the configuration options for the RadialGauge area.
12
+ * This component controls the entire visible area of the RadialGauge.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * import { Component } from '@angular/core';
17
+ *
18
+ * @Component({
19
+ * selector: 'my-app',
20
+ * template: `
21
+ * <kendo-radialgauge-area background="lightblue">
22
+ * </kendo-radialgauge-area>
23
+ * `
24
+ * })
25
+ * class AppComponent {
26
+ * }
27
+ * ```
13
28
  */
14
29
  export class RadialGaugeAreaComponent extends GaugeAreaComponent {
15
30
  configurationService;
@@ -8,10 +8,23 @@ import { ConfigurationService } from '../services';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../services";
10
10
  /**
11
- * The configuration options for the scale labels of the RadialGauge.
11
+ * Configures the configuration options for the scale labels of the RadialGauge.
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-radialgauge>
16
+ * <kendo-radialgauge-scale>
17
+ * <kendo-radialgauge-scale-labels [visible]="true" [format]="'N0'">
18
+ * </kendo-radialgauge-scale-labels>
19
+ * </kendo-radialgauge-scale>
20
+ * </kendo-radialgauge>
21
+ * ```
12
22
  */
13
23
  export class RadialLabelsComponent extends LabelsComponent {
14
24
  configurationService;
25
+ /**
26
+ * Sepcifies rhe position of the labels relative to the scale.
27
+ */
15
28
  position;
16
29
  constructor(configurationService) {
17
30
  super('scale.labels', configurationService);
@@ -8,12 +8,34 @@ import { CollectionItemComponent } from '../base-components';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../services";
10
10
  /**
11
- * The configuration options for a pointer item of a RadialGauge.
11
+ * Represents the configuration options for a pointer in the RadialGauge.
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-radialgauge>
16
+ * <kendo-radialgauge-pointers>
17
+ * <kendo-radialgauge-pointer [value]="35" color="#ff4500" shape="barIndicator">
18
+ * </kendo-radialgauge-pointer>
19
+ * </kendo-radialgauge-pointers>
20
+ * </kendo-radialgauge>
21
+ * ```
12
22
  */
13
23
  export class RadialPointerComponent extends CollectionItemComponent {
24
+ /**
25
+ * Configures the pointer cap.
26
+ */
14
27
  cap;
28
+ /**
29
+ * Specifies the color of the pointer.
30
+ */
15
31
  color;
32
+ /**
33
+ * Sets the length of the pointer as a percentage of the scale radius.
34
+ */
16
35
  length;
36
+ /**
37
+ * Sets the value of the pointer.
38
+ */
17
39
  value;
18
40
  constructor(configurationService, collectionChangesService) {
19
41
  super(configurationService, collectionChangesService);
@@ -9,14 +9,17 @@ import { CollectionChangesService, ConfigurationService } from '../services';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "../services";
11
11
  /**
12
- * A collection of one or more RadialGauge pointers
12
+ * Represents a collection of one or more RadialGauge pointers
13
13
  * ([more information and example]({% slug multiplepointers_radialgauge %})).
14
14
  *
15
+ * Use this component to group multiple pointer components within a RadialGauge.
16
+ * Each pointer displays a specific value on the gauge.
17
+ *
15
18
  * @example
16
19
  * ```ts
17
20
  * import { Component } from '@angular/core';
18
21
  *
19
- * _@Component({
22
+ * @Component({
20
23
  * selector: 'my-app',
21
24
  * template: `
22
25
  * <kendo-radialgauge>
@@ -40,8 +43,10 @@ import * as i1 from "../services";
40
43
  * color: '#78d237'
41
44
  * }];
42
45
  * }
43
- *
44
46
  * ```
47
+ *
48
+ * @remarks
49
+ * Supported children components are: {@link RadialPointerComponent}
45
50
  */
46
51
  export class RadialPointersComponent extends CollectionComponent {
47
52
  children;
@@ -20,26 +20,30 @@ import * as i3 from "@progress/kendo-angular-l10n";
20
20
  * ```ts
21
21
  * import { Component } from '@angular/core';
22
22
  *
23
- * _@Component({
23
+ * @Component({
24
24
  * selector: 'my-app',
25
25
  * template: `
26
26
  * <kendo-radialgauge [pointer]="{ value: value }">
27
27
  * </kendo-radialgauge>
28
28
  * `
29
29
  * })
30
- * class AppComponent {
30
+ * export class AppComponent {
31
31
  * public value: number = 10;
32
32
  * }
33
- *
34
33
  * ```
34
+ *
35
+ * @remarks
36
+ * Supported children components are: {@link RadialGaugeAreaComponent}, {@link RadialLabelsComponent}, {@link RadialPointersComponent}, {@link RadialRangesComponent}, {@link RadialScaleComponent}.
35
37
  */
36
38
  export class RadialGaugeComponent extends GaugeComponent {
37
39
  /**
38
- * The configuration of the pointers.
40
+ * Sets the configuration of the pointers.
41
+ * You can configure single or multiple pointers for the RadialGauge.
39
42
  */
40
43
  pointer;
41
44
  /**
42
- * The configuration of the scale.
45
+ * Sets the configuration of the scale.
46
+ * The scale defines the range, appearance, and behavior of the gauge.
43
47
  */
44
48
  scale;
45
49
  constructor(configurationService, themeService, intlService, localizationService, element, renderer, ngZone) {
@@ -16,19 +16,19 @@ import * as i7 from "./range.component";
16
16
  import * as i8 from "./ranges.component";
17
17
  // IMPORTANT: NgModule export kept for backwards compatibility
18
18
  /**
19
- * A [module](link:site.data.urls.angular['ngmodules']) that includes the RadialGauge component and its directives.
20
- * Imports the `RadialGaugeModule` into your application
19
+ * Represents the [NgModule](link:site.data.urls.angular['ngmodules']) definition that includes the RadialGauge component and its directives.
20
+ * Import the RadialGaugeModule into your application
21
21
  * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity) or any other sub-module
22
- * that will use the RadialGauge component.
22
+ * that uses the RadialGauge component.
23
23
  *
24
24
  * @example
25
- * ```ts-no-run
25
+ * ```ts
26
26
  * import { NgModule } from '@angular/core';
27
27
  * import { BrowserModule } from '@angular/platform-browser';
28
28
  * import { RadialGaugeModule } from '@progress/kendo-angular-gauges';
29
29
  * import { AppComponent } from './app.component';
30
30
  *
31
- * _@NgModule({
31
+ * @NgModule({
32
32
  * bootstrap: [AppComponent],
33
33
  * declarations: [AppComponent],
34
34
  * imports: [BrowserModule, RadialGaugeModule]
@@ -8,7 +8,19 @@ import { RangeComponent } from '../base-components';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../services";
10
10
  /**
11
- * The configuration options for a scale range item of a RadialGauge.
11
+ * Represents the configuration options for a range in the RadialGauge scale.
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-radialgauge>
16
+ * <kendo-radialgauge-scale>
17
+ * <kendo-radialgauge-scale-ranges>
18
+ * <kendo-radialgauge-scale-range [from]="0" [to]="50" color="red">
19
+ * </kendo-radialgauge-scale-range>
20
+ * </kendo-radialgauge-scale-ranges>
21
+ * </kendo-radialgauge-scale>
22
+ * </kendo-radialgauge>
23
+ * ```
12
24
  */
13
25
  export class RadialRangeComponent extends RangeComponent {
14
26
  constructor(configurationService, collectionChangesService) {
@@ -9,14 +9,17 @@ import { CollectionChangesService, ConfigurationService } from '../services';
9
9
  import * as i0 from "@angular/core";
10
10
  import * as i1 from "../services";
11
11
  /**
12
- * A collection of one or more RadialGauge scale ranges
12
+ * Represents a collection of one or more RadialGauge scale ranges
13
13
  * ([more information and example]({% slug scaleranghes_radialgauge %})).
14
14
  *
15
+ * Use this component to define multiple ranges on your RadialGauge scale.
16
+ * Each range displays a colored segment that highlights specific value intervals.
17
+ *
15
18
  * @example
16
19
  * ```ts
17
20
  * import { Component } from '@angular/core';
18
21
  *
19
- * _@Component({
22
+ * @Component({
20
23
  * selector: 'my-app',
21
24
  * template: `
22
25
  * <kendo-radialgauge>
@@ -45,8 +48,10 @@ import * as i1 from "../services";
45
48
  * color: '#78d237'
46
49
  * }];
47
50
  * }
48
- *
49
51
  * ```
52
+ *
53
+ * @remarks
54
+ * Supported children components are: {@link RadialRangeComponent}
50
55
  */
51
56
  export class RadialRangesComponent extends CollectionComponent {
52
57
  children;
@@ -8,15 +8,41 @@ import { ConfigurationService } from '../services';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "../services";
10
10
  /**
11
- * The configuration options for the scale of the RadialGauge
11
+ * Represents the configuration options for the scale of a RadialGauge
12
12
  * ([more information and example]({% slug scaleoptions_radialgauge %})).
13
+ *
14
+ * @example
15
+ * ```html
16
+ * <kendo-radialgauge>
17
+ * <kendo-radialgauge-scale [startAngle]="0" [endAngle]="180">
18
+ * </kendo-radialgauge-scale>
19
+ * </kendo-radialgauge>
20
+ * ```
21
+ *
22
+ * @remarks
23
+ * Supported children components are: {@link RadialLabelsComponent}, {@link RadialRangesComponent}
13
24
  */
14
25
  export class RadialScaleComponent extends ScaleComponent {
15
26
  configurationService;
27
+ /**
28
+ * Configures the scale labels.
29
+ */
16
30
  labels;
31
+ /**
32
+ * Specifies the distance between the scale ranges and the ticks.
33
+ */
17
34
  rangeDistance;
35
+ /**
36
+ * Sets the ranges of the scale.
37
+ */
18
38
  ranges;
39
+ /**
40
+ * Specifies the start angle of the Gauge in degrees.
41
+ */
19
42
  startAngle;
43
+ /**
44
+ * Specifies the end angle of the Gauge in degrees.
45
+ */
20
46
  endAngle;
21
47
  constructor(configurationService) {
22
48
  super('scale', configurationService);