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

package/types/border.interface.d.ts

@@ -4,20 +4,20 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type.interface';
 /**
- * The appearance settings for the border lines.
+ * Represents the appearance settings for the border lines.
  */
 export interface Border {
     /**
-     * The color of the border line.
+     * Sets the color of the border line.
      * Accepts valid CSS color strings, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the border line.
+     * Sets the dash type of the border line.
      */
     dashType?: DashType;
     /**
-     * The width of the border line in pixels.
+     * Sets the width of the border line in pixels.
      */
     width?: number;
 }

package/types/cap.interface.d.ts

@@ -3,16 +3,16 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The configuration options for the RadialGauge pointer cap.
+ * Represents the configuration options for the RadialGauge pointer cap.
  */
 export interface Cap {
     /**
-     * The color of the cap.
+     * Sets the color of the cap.
      * Accepts valid CSS color strings, including hex and rgb.
      */
     color?: string;
     /**
-     * The size of the cap in percent (from 0 to 1).
+     * Sets the size of the cap as a percentage from 0 to 1.
      */
     size?: number;
 }

package/types/circular-gauge-scale.interface.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { ArcScale } from './arc-scale.interface';
 /**
- * The scale options of the Gauge.
+ * Represents the scale options of the Gauge.
  */
 export interface CircularGaugeScale extends ArcScale {
     /**

package/types/color-range.interface.d.ts

@@ -3,23 +3,23 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The color range configuration.
+ * Represents the color range configuration.
  */
 export interface ColorRange {
     /**
-     * The color of the range. Accepts valid CSS color strings, including hex and rgb.
+     * Sets the color of the range. Accepts valid CSS color strings, including hex and rgb.
      */
     color?: string;
     /**
-     * The opacity of the range.
+     * Sets the opacity of the range.
      */
     opacity?: number;
     /**
-     * The range start value.
+     * Sets the range start value.
      */
     from?: number;
     /**
-     * The range end value.
+     * Sets the range end value.
      */
     to?: number;
 }

package/types/dash-type.interface.d.ts

@@ -3,6 +3,6 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The dash type of a line.
+ * Represents the dash type of a line.
  */
 export type DashType = 'dash' | 'dashDot' | 'dot' | 'longDash' | 'longDashDot' | 'longDashDotDot' | 'solid';

package/types/gauge-area.interface.d.ts

@@ -5,28 +5,28 @@
 import { Border } from './border.interface';
 import { Margin } from './margin.interface';
 /**
- * The configuration options for the Gauge area.
- * Represents the entire visible area of the Gauge.
+ * Represents the configuration options for the Gauge area.
+ * Controls the entire visible area of the Gauge.
  */
 export interface GaugeArea {
     /**
-     * The background of the Gauge area. Accepts valid CSS color strings, including hex and rgb.
+     * Sets the background of the Gauge area. Accepts valid CSS color strings, including hex and rgb.
      */
     background?: string;
     /**
-     * The border of the Gauge area.
+     * Sets the border of the Gauge area.
      */
     border?: Border;
     /**
-     * The height of the Gauge area.
+     * Sets the height of the Gauge area in pixels.
      */
     height?: number;
     /**
-     * The margin of the Gauge area.
+     * Sets the margin of the Gauge area.
      */
     margin?: number | Margin;
     /**
-     * The width of the Gauge area.
+     * Sets the width of the Gauge area in pixels.
      */
     width?: number;
 }

package/types/labels.interface.d.ts

@@ -6,42 +6,42 @@ import { Border } from './border.interface';
 import { Margin } from './margin.interface';
 import { Padding } from './padding.interface';
 /**
- * The configuration of the scale labels.
+ * Represents the configuration of the scale labels.
  */
 export interface Labels {
     /**
-     * The background of the labels.
+     * Sets the background of the labels.
      * Accepts valid CSS color strings, including hex and rgb.
      */
     background?: string;
     /**
-     * The border of the labels.
+     * Sets the border of the labels.
      */
     border?: Border;
     /**
-     * The color of the labels.
+     * Sets the color of the labels.
      * Accepts valid CSS color strings, including hex and rgb.
      */
     color?: string;
     /**
-     * The font of the labels.
+     * Sets the font of the labels.
      */
     font?: string;
     /**
-     * The format that is used to display the labels.
+     * Sets the format that displays the labels.
      * Uses the IntlService [`format`]({% slug api_intl_intlservice %}#toc-format) method.
      */
     format?: string;
     /**
-     * The margin of the labels.
+     * Sets the margin of the labels.
      */
     margin?: number | Margin;
     /**
-     * The padding of the labels.
+     * Sets the padding of the labels.
      */
     padding?: number | Padding;
     /**
-     * The function which returns the label content.
+     * Sets the function which returns the label content.
      *
      * The available fields in the function argument are:
      *
@@ -51,7 +51,7 @@ export interface Labels {
      */
     content?: (e: any) => string;
     /**
-     * The visibility of the labels.
+     * Sets the visibility of the labels.
      */
     visible?: boolean;
 }

package/types/line-cap.d.ts

@@ -3,6 +3,6 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The cap style of a line.
+ * Represents the cap style of a line.
  */
 export type LineCap = 'butt' | 'round' | 'square';

package/types/line.interface.d.ts

@@ -4,24 +4,24 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type.interface';
 /**
- * The scale line options.
+ * Represents the scale line options.
  */
 export interface Line {
     /**
-     * The color of the lines.
+     * Sets the color of the lines.
      * Accepts valid CSS color strings, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the line.
+     * Sets the dash type of the line.
      */
     dashType?: DashType;
     /**
-     * The visibility of the lines.
+     * Sets the visibility of the lines.
      */
     visible?: boolean;
     /**
-     * The width of the line.
+     * Sets the width of the line in pixels.
      */
     width?: number;
 }

package/types/linear-pointer-shape.d.ts

@@ -3,6 +3,6 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The shape of the pointer.
+ * Represents the shape of the pointer.
  */
 export type LinearPointerShape = 'barIndicator' | 'arrow';

package/types/linear-pointer.interface.d.ts

@@ -6,36 +6,36 @@ import { Border } from './border.interface';
 import { Margin } from './margin.interface';
 import { LinearPointerShape } from './linear-pointer-shape';
 /**
- * The configuration options for the LinearGauge pointer.
+ * Represents the configuration options for the LinearGauge pointer.
  */
 export interface LinearPointer {
     /**
-     * The border of the Gauge area.
+     * Sets the border of the Gauge area.
      */
     border?: Border;
     /**
-     * The color of the pointer.
-     * Accepts valid CSS color strings, including hex and rgb.
+     * Sets the color of the pointer.
+     * Accepts valid CSS color strings, including `hex` and `rgb`.
      */
     color?: string;
     /**
-     * The margin of the pointer.
+     * Specifies the margin of the pointer.
      */
     margin?: number | Margin;
     /**
-     * The opacity of the pointer.
+     * Sets the opacity of the pointer.
      */
     opacity?: number;
     /**
-     * The shape of the pointer.
+     * Sets the shape of the pointer.
      */
     shape?: LinearPointerShape;
     /**
-     * The size of the pointer.
+     * Specifies the size of the pointer.
      */
     size?: number;
     /**
-     * The value of the pointer.
+     * Sets the value of the pointer.
      */
     value?: number;
 }

package/types/linear-scale.interface.d.ts

@@ -6,25 +6,25 @@ import { Scale } from './scale.interface';
 import { Line } from './line.interface';
 import { Range } from './range.interface';
 /**
- * The scale options of the Gauge
+ * Represents the scale options of the Gauge.
  */
 export interface LinearScale extends Scale {
     /**
-     * Configures the scale line.
+     * Sets up the scale line.
      */
     line?: Line;
     /**
-     * The ranges of the scale.
+     * Defines the ranges of the scale.
      */
     ranges?: Range[];
     /**
      * Mirrors the scale labels and ticks.
      * If the labels are normally on the left side of the scale,
-     * the mirroring of the scale will render them to the right.
+     * mirroring the scale renders them to the right.
      */
     mirror?: boolean;
     /**
-     * Specifies if the scale will be vertical
+     * Determines if the scale is vertical
      * ([see example]({% slug orientation_lineargauge %})).
      * @default true
      */

package/types/margin.interface.d.ts

@@ -3,23 +3,23 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The margin configuration for each side.
+ * Represents the margin settings for each side.
  */
 export interface Margin {
     /**
-     * The top margin in pixels.
+     * Sets the top margin in pixels.
      */
     top?: number;
     /**
-     * The right margin in pixels.
+     * Sets the right margin in pixels.
      */
     right?: number;
     /**
-     * The bottom margin in pixels.
+     * Sets the bottom margin in pixels.
      */
     bottom?: number;
     /**
-     * The left margin in pixels.
+     * Sets the left margin in pixels.
      */
     left?: number;
 }

package/types/padding.interface.d.ts

@@ -3,23 +3,23 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The padding configuration for each side.
+ * Represents the padding settings for each side.
  */
 export interface Padding {
     /**
-     * The top padding in pixels.
+     * Sets the top padding in pixels.
      */
     top?: number;
     /**
-     * The right padding in pixels.
+     * Sets the right padding in pixels.
      */
     right?: number;
     /**
-     * The bottom padding in pixels.
+     * Sets the bottom padding in pixels.
      */
     bottom?: number;
     /**
-     * The left padding in pixels.
+     * Sets the left padding in pixels.
      */
     left?: number;
 }

package/types/radial-label-position.d.ts

@@ -3,6 +3,6 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The position of the RadialGauge labels.
+ * Represents the possible positions of the RadialGauge labels.
  */
 export type RadialLabelPosition = 'inside' | 'outside';

package/types/radial-labels.interface.d.ts

@@ -4,9 +4,13 @@
 *-------------------------------------------------------------------------------------------*/
 import { Labels } from './labels.interface';
 import { RadialLabelPosition } from './radial-label-position';
+/**
+ * Represents the labels configuration of the Gauge.
+ */
 export interface RadialLabels extends Labels {
     /**
-     * The position of the labels.
+     * Sets the position of the labels.
+     * This property determines where the labels will be placed relative to the radial gauge.
      */
     position?: RadialLabelPosition;
 }

package/types/radial-pointer.interface.d.ts

@@ -4,26 +4,26 @@
 *-------------------------------------------------------------------------------------------*/
 import { Cap } from './cap.interface';
 /**
- * The configuration options for the RadialGauge pointer.
+ * Represents the configuration options for the RadialGauge pointer.
  */
 export interface RadialPointer {
     /**
-     * The configuration options for the cap.
+     * Defines the settings for the cap.
      */
     cap?: Cap;
     /**
-     * The color of the pointer.
-     * Accepts valid CSS color strings, including hex and rgb.
+     * Sets the color of the pointer.
+     * Accepts valid CSS color strings, including `hex` and `rgb`.
      */
     color?: string;
     /**
-     * The pointer length (in percent) that is based on the distance to the scale.
-     * The default length of `1` indicates that the pointer exactly reaches the scale.
+     * Sets the pointer length in percent based on the distance to the scale.
+     * The default length of `1` means that the pointer exactly reaches the scale.
      * Accepts values between `0.1` and `1.5`.
      */
     length?: number;
     /**
-     * The pointer value.
+     * Sets the pointer value.
      */
     value?: number;
 }

package/types/radial-scale.interface.d.ts

@@ -6,29 +6,29 @@ import { RadialLabels } from './radial-labels.interface';
 import { Scale } from './scale.interface';
 import { Range } from './range.interface';
 /**
- * The scale options of the Gauge.
+ * Represents the scale options of the Gauge.
  */
 export interface RadialScale extends Scale {
     /**
-     * Configures the scale labels.
+     * Sets up the scale labels.
      */
     labels?: RadialLabels;
     /**
-     * The distance between the range indicators and the ticks.
+     * Defines the distance between the range indicators and the ticks.
      */
     rangeDistance?: number;
     /**
-     * The ranges of the scale.
+     * Defines the ranges of the scale.
      */
     ranges?: Range[];
     /**
-     * The starting angle of the Gauge.
-     * The Gauge is rendered clockwise (0 degrees equal 180 degrees in the polar coordinate system).
+     * Sets the starting angle of the gauge.
+     * The Gauge renders clockwise where 0 degrees equals 180 degrees in the polar coordinate system.
      */
     startAngle?: number;
     /**
-     * The ending angle of the Gauge.
-     * The Gauge is rendered clockwise (0 degrees equal to 180 degrees in the polar coordinate system).
+     * Sets the ending angle of the gauge.
+     * The Gauge renders clockwise where 0 degrees equals 180 degrees in the polar coordinate system.
      */
     endAngle?: number;
 }

package/types/range.interface.d.ts

@@ -3,23 +3,23 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The configuration for the scale ranges.
+ * Represents the configuration for the scale ranges.
  */
 export interface Range {
     /**
-     * The start position of the range.
+     * Sets the start position of the range.
      */
     from?: number;
     /**
-     * The end position of the range.
+     * Sets the end position of the range.
      */
     to?: number;
     /**
-     * The range opacity.
+     * Sets the range opacity.
      */
     opacity?: number;
     /**
-     * The color of the range. Accepts valid CSS color strings, including hex and rgb.
+     * Sets the color of the range. Accepts valid CSS color strings, including hex and rgb.
      */
     color?: string;
 }

package/types/scale.interface.d.ts

@@ -5,35 +5,35 @@
 import { Labels } from './labels.interface';
 import { Ticks } from './ticks.interface';
 /**
- * The scale options of the Gauge.
+ * Represents the scale options of the Gauge.
  */
 export interface Scale {
     /**
-     * Configures the scale labels.
+     * Sets the scale labels.
      */
     labels?: Labels;
     /**
-     * Configures the major scale ticks.
+     * Sets the major scale ticks.
      */
     majorTicks?: Ticks;
     /**
-     * Configures the minor scale ticks.
+     * Sets the minor scale ticks.
      */
     minorTicks?: Ticks;
     /**
-     * The minimum value of the scale.
+     * Specifies the minimum value of the scale.
      */
     min?: number;
     /**
-     * The maximum value of the scale.
+     * Specifies the maximum value of the scale.
      */
     max?: number;
     /**
-     * The interval between minor divisions.
+     * Defines the interval between minor divisions.
      */
     minorUnit?: number;
     /**
-     * The interval between major divisions.
+     * Defines the interval between major divisions.
      */
     majorUnit?: number;
     /**
@@ -41,11 +41,11 @@ export interface Scale {
      */
     reverse?: boolean;
     /**
-     * The width of the range indicators.
+     * Specifies the width of the range indicators.
      */
     rangeSize?: number;
     /**
-     * The default color of the ranges.
+     * Sets the default color of the ranges.
      */
     rangePlaceholderColor?: string;
 }

package/types/ticks.interface.d.ts

@@ -3,23 +3,23 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The options for the scale ticks.
+ * Represents the options for the scale ticks.
  */
 export interface Ticks {
     /**
-     * The color of the ticks. Accepts a valid CSS color string, including hex and rgb.
+     * Defines the color of the ticks. Accepts a valid CSS color string, including `hex` and `rgb`.
      */
     color?: string;
     /**
-     * The size of the ticks. Represents the length of the line (in pixels) that is drawn to indicate the tick on the scale.
+     * Sets the size of the ticks. This sets the length of the line in pixels that shows the tick on the scale.
      */
     size?: number;
     /**
-     * The visibility of the ticks.
+     * Determines if the ticks are visible.
      */
     visible?: boolean;
     /**
-     * The ticks width (in pixels).
+     * Sets the width of the ticks in pixels.
      */
     width?: number;
 }