@progress/kendo-angular-charts 19.1.2-develop.4 → 19.1.2-develop.5

package/field-types/auto-base-unit-steps.interface.d.ts

@@ -3,9 +3,9 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The allowed time-interval steps when `baseUnit` is set to either `"fit"` or `"auto"`.
+ * Specifies the allowed time-interval steps when `baseUnit` is set to either `"fit"` or `"auto"`.
  *
- * The axis will divide the active period into the smallest possible intervals
+ * Divides the active period into the smallest possible intervals
  * that do not exceed the set `maxDateGroups` value.
  *
  *
@@ -24,35 +24,35 @@
  */
 export interface AutoBaseUnitSteps {
     /**
-     * The preferred interval steps when displaying milliseconds.
+     * Specifies the interval steps when displaying milliseconds.
      */
     milliseconds?: number[];
     /**
-     * The preferred interval steps when displaying seconds.
+     * Specifies the interval steps when displaying seconds.
      */
     seconds?: number[];
     /**
-     * The preferred interval steps when displaying minutes.
+     * Specifies the interval steps when displaying minutes.
      */
     minutes?: number[];
     /**
-     * The preferred interval steps when displaying hours.
+     * Specifies the interval steps when displaying hours.
      */
     hours?: number[];
     /**
-     * The preferred interval steps when displaying days.
+     * Specifies the interval steps when displaying days.
      */
     days?: number[];
     /**
-     * The preferred interval steps when displaying weeks.
+     * Specifies the interval steps when displaying weeks.
      */
     weeks?: number[];
     /**
-     * The preferred interval steps when displaying months.
+     * Specifies the interval steps when displaying months.
      */
     months?: number[];
     /**
-     * The preferred interval steps when displaying years.
+     * Specifies the interval steps when displaying years.
      */
     years?: number[];
 }

package/field-types/axis-labels-position.d.ts

@@ -3,13 +3,13 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The position of the axis labels.
+ * Specifies the position of the axis labels.
  *
  * The possible values are:
- * - `"start"`—The labels are positioned at the start of the axis.
- * - `"end"`—The labels are positioned at the end of the axis.
- * - `"onAxis"`—The labels are positioned on the axis.
- * - `""`—The labels are positioned based on the axis type.
+ * - `"start"`—Positions the labels at the start of the axis, typically located at the left or bottom end of the Chart, unless the crossing axis is reversed.
+ * - `"end"`—Positions the labels at the end of the axis, usually at the top or right end of the Chart, unless the crossing axis is reversed.
+ * - `"onAxis"`—Positions the labels on the axis.
+ * - `""`—Positions the labels based on the axis type.
  *
  * @example
  * ```ts

package/field-types/axis-line.interface.d.ts

@@ -4,27 +4,28 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the axis lines.
+ * Specifies the appearance settings for the axis lines.
  * Affects the major and minor axis ticks, but not the grid lines
  * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
  */
 export interface AxisLine {
     /**
-     * The color of the lines. Accepts a valid CSS color string, including hex and rgb.
-     * Setting the `color` option affects the major and minor axis ticks, but not the grid lines.
+     * Specifies the color of the lines.
+     * Accepts a valid CSS color string, including hex and rgb.
+     * The `color` option affects the major and minor axis ticks, but not the grid lines.
      */
     color?: string;
     /**
-     * The dash type of the line.
+     * Specifies the dash type of the line.
      */
     dashType?: DashType;
     /**
-     * If set to `true`, the Chart displays the axis lines.
+     * Determines whether to display the axis lines.
      * By default, the axis lines are visible.
      */
     visible?: boolean;
     /**
-     * The width of the line in pixels.
+     * Specifies the width of the line in pixels.
      * Affects the major and minor axis ticks, but not the grid lines.
      */
     width?: number;

package/field-types/axis-ticks.interface.d.ts

@@ -3,33 +3,33 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The appearance configuration for the major and minor axis ticks
+ * Specifies the appearance configuration for the major and minor axis ticks
  * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
  */
 export interface AxisTicks {
     /**
-     * The color of the tick lines. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the tick lines. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The length of the tick line in pixels.
+     * Specifies the length of the tick line in pixels.
      */
     size?: number;
     /**
-     * The tick-rendering step. Renders every n<sup>th</sup> tick, where `n` is the step.
+     * Specifies the tick-rendering step. Renders every n<sup>th</sup> tick, where `n` is the step.
      */
     step?: number;
     /**
-     * The number of ticks to skip at the beginning.
+     * Specifies the number of ticks to skip at the beginning.
      */
     skip?: number;
     /**
-     * If set to `true,` the Chart displays the axis ticks.
+     * Determines whether to display the axis ticks.
      * By default, only the major axis ticks are visible.
      */
     visible?: boolean;
     /**
-     * The width of the ticks in pixels.
+     * Specifies the width of the ticks in pixels.
      */
     width?: number;
 }

package/field-types/axis-title-position.d.ts

@@ -3,14 +3,14 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The position of an axis title.
+ * Specifies the position of an axis title.
  *
  * The possible values are:
- * - `"top"`—The title is positioned at the top of the axis.
- * - `"bottom"`—The title is positioned at the bottom of the axis.
- * - `"left"`—The title is positioned at the left of the axis.
- * - `"right"`—The title is positioned at the right of the axis.
- * - `"center"`—The title is positioned at the center of the axis.
+ * - `"top"`—Positions the title at the top of the axis.
+ * - `"bottom"`—Positions the title at the bottom of the axis.
+ * - `"left"`—Positions the title at the left of the axis.
+ * - `"right"`—Positions the title at the right of the axis.
+ * - `"center"`—Positions the title at the center of the axis.
  *
  * @example
  * ```ts

package/field-types/base-unit.d.ts

@@ -3,17 +3,17 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The `baseUnit` type of a X or Y axis.
+ * Specifies the `baseUnit` type of a X or Y axis.
  *
  * The possible values are:
- * - `"milliseconds"`—The base unit is milliseconds.
- * - `"seconds"`—The base unit is seconds.
- * - `"minutes"`—The base unit is minutes.
- * - `"hours"`—The base unit is hours.
- * - `"days"`—The base unit is days.
- * - `"weeks"`—The base unit is weeks.
- * - `"months"`—The base unit is months.
- * - `"years"`—The base unit is years.
+ * - `"milliseconds"`—Sets the base unit to milliseconds.
+ * - `"seconds"`—Sets the base unit to seconds.
+ * - `"minutes"`—Sets the base unit to minutes.
+ * - `"hours"`—Sets the base unit to hours.
+ * - `"days"`—Sets the base unit to days.
+ * - `"weeks"`—Sets the base unit to weeks.
+ * - `"months"`—Sets the base unit to months.
+ * - `"years"`—Sets the base unit to years.
  *
  * @example
  * ```ts

package/field-types/border.interface.d.ts

@@ -4,24 +4,24 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the border lines
+ * Specifies the appearance settings for the border lines
  * ([see example](slug:title_chart_charts#toc-basics)).
  */
 export interface Border {
     /**
-     * The color of the border line. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the border line. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the border line.
+     * Specifies the dash type of the border line.
      */
     dashType?: DashType;
     /**
-     * The width of the border line in pixels.
+     * Specifies the width of the border line in pixels.
      */
     width?: number;
     /**
-     * The border opacity.
+     * Specifies the border opacity.
      */
     opacity?: number;
 }

package/field-types/bullet-target-line.interface.d.ts

@@ -3,11 +3,11 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The appearance settings for the target line of the Bullet series.
+ * Specifies the appearance settings for the target line of the Bullet series.
  */
 export interface BulletTargetLine {
     /**
-     * The width of the Bullet target line in pixels.
+     * Specifies the width of the Bullet target line in pixels.
      */
     width?: number;
 }

package/field-types/bullet-target.interface.d.ts

@@ -5,20 +5,20 @@
 import { Border } from './border.interface';
 import { BulletTargetLine } from './bullet-target-line.interface';
 /**
- * The appearance settings for the target of the Bullet series.
+ * Specifies the appearance settings for the target of the Bullet series.
  */
 export interface BulletTarget {
     /**
-     * The width of the border in pixels.
+     * Specifies the width of the border in pixels.
      * By default, the border width is set to `zero`, which means that the border is not visible.
      */
     border?: Border;
     /**
-     * The target color.
+     * Specifies the target color.
      */
     color?: string;
     /**
-     * The appearance settings for the target line of the Bullet series.
+     * Specifies the appearance settings for the target line of the Bullet series.
      */
     line?: BulletTargetLine;
 }

package/field-types/category-base-unit.d.ts

@@ -4,12 +4,12 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseUnit } from './base-unit';
 /**
- * The `baseUnit` type of the category axis.
+ * Specifies the `baseUnit` type of the category axis.
  *
  * The possible values are:
- * - [`BaseUnit`](slug:api_charts_baseunit)—The base time interval for the axis labels.
- * - `"auto"`—The base unit is automatically determined by the minimum difference between subsequent categories.
- * - `"fit"`—The [`categoryAxis.baseUnitStep`](slug:api_charts_categoryaxis#toc-baseunitstep) and base unit are adjusted so that the number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups), and the [`series.aggregate`](slug:api_charts_series#toc-aggregate) function is used to aggregate data based on the selected base unit.
+ * - [`BaseUnit`](slug:api_charts_baseunit)—Sets the base time interval for the axis labels.
+ * - `"auto"`—Automatically determines the base unit by the minimum difference between subsequent categories.
+ * - `"fit"`—Adjusts the [`categoryAxis.baseUnitStep`](slug:api_charts_categoryaxis#toc-baseunitstep) and base unit so that the number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups), and uses the [`series.aggregate`](slug:api_charts_series#toc-aggregate) function to aggregate data based on the selected base unit.
  *
  * @example
  * ```ts

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

@@ -3,16 +3,16 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The dash line type.
+ * Specifies the dash line type.
  *
  * The possible values are:
- * - `"dash"`—A line that consists of dashes.
- * - `"dashDot"`—A line that consists of a repeating dash-dot pattern.
- * - `"dot"`—A line that consists of dots.
- * - `"longDash"`—A line that consists of a repeating long-dash pattern.
- * - `"longDashDot"`—A line that consists of a repeating long-dash-dot pattern.
- * - `"longDashDotDot"`—A line that consists of a repeating long-dash-dot-dot pattern.
- * - `"solid"`—A solid line.
+ * - `"dash"`—Creates a line that consists of dashes.
+ * - `"dashDot"`—Creates a line that consists of a repeating dash-dot pattern.
+ * - `"dot"`—Creates a line that consists of dots.
+ * - `"longDash"`—Creates a line that consists of a repeating long-dash pattern.
+ * - `"longDashDot"`—Creates a line that consists of a repeating long-dash-dot pattern.
+ * - `"longDashDotDot"`—Creates a line that consists of a repeating long-dash-dot-dot pattern.
+ * - `"solid"`—Creates a solid line.
  *
  * @example
  * ```ts

package/field-types/date-formats.interface.d.ts

@@ -3,42 +3,42 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The format that is used to display the labels when they are dates.
+ * Specifies the format that displays the labels when they are dates.
  *
- * The Chart selects the appropriate format for the current `baseUnit`.
+ * Selects the appropriate format for the current `baseUnit`.
  * Setting the `format` option of the labels overrides the date formats.
  */
 export interface DateFormats {
     /**
-     * The provided format when the axis `baseUnit` is set to `"milliseconds"`.
+     * Specifies the format when the axis `baseUnit` is set to `"milliseconds"`.
      */
     milliseconds?: string;
     /**
-     * The provided format when the axis `baseUnit` is set to `"seconds"`.
+     * Specifies the format when the axis `baseUnit` is set to `"seconds"`.
      */
     seconds?: string;
     /**
-     * The provided format when the axis `baseUnit` is set to `"minutes"`.
+     * Specifies the format when the axis `baseUnit` is set to `"minutes"`.
      */
     minutes?: string;
     /**
-     * The provided format when the axis `baseUnit` is set to `"hours"`.
+     * Specifies the format when the axis `baseUnit` is set to `"hours"`.
      */
     hours?: string;
     /**
-     * The provided format when the axis `baseUnit` is set to `"days"`.
+     * Specifies the format when the axis `baseUnit` is set to `"days"`.
      */
     days?: string;
     /**
-     * The provided format when the axis `baseUnit` is set to `"weeks"`.
+     * Specifies the format when the axis `baseUnit` is set to `"weeks"`.
      */
     weeks?: string;
     /**
-     * The provided format when the axis `baseUnit` is set to `"months"`.
+     * Specifies the format when the axis `baseUnit` is set to `"months"`.
      */
     months?: string;
     /**
-     * The provided format when the axis `baseUnit` is set to `"years"`.
+     * Specifies the format when the axis `baseUnit` is set to `"years"`.
      */
     years?: string;
 }

package/field-types/drag-action.interface.d.ts

@@ -5,7 +5,7 @@
 import { LockAxis } from './lock-axis';
 import { ModifierKey } from './modifier-key';
 /**
- * Configures the drag behavior during the pan and zoom operations.
+ * Specifies the drag behavior during the pan and zoom operations.
  */
 export interface DragAction {
     /**

package/field-types/error-bar-line.interface.d.ts

@@ -4,15 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the error bar lines.
+ * Specifies the appearance settings for the error bar lines.
  */
 export interface ErrorBarLine {
     /**
-     * The dash type of the line.
+     * Specifies the dash type of the line.
      */
     dashType?: DashType;
     /**
-     * The width of the line in pixels.
+     * Specifies the width of the line in pixels.
      */
     width?: number;
 }

package/field-types/grid-lines.interface.d.ts

@@ -4,33 +4,33 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance configuration for the major and minor axis grid lines
+ * Specifies the appearance configuration for the major and minor axis grid lines
  * ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
  */
 export interface GridLines {
     /**
-     * The color of the grid lines. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the grid lines. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the grid lines.
+     * Specifies the dash type of the grid lines.
      */
     dashType?: DashType;
     /**
-     * The number of lines to skip at the beginning.
+     * Specifies the number of lines to skip at the beginning.
      */
     skip?: number;
     /**
-     * The tick-rendering step. Renders every n<sup>th</sup> line, where `n` is the step.
+     * Specifies the tick-rendering step. Renders every n<sup>th</sup> line, where `n` is the step.
      */
     step?: number;
     /**
-     * If set to `true`, the Chart displays the lines.
+     * Determines whether to display the lines.
      * By default, only the major axis grid lines are visible.
      */
     visible?: boolean;
     /**
-     * The width of the lines in pixels.
+     * Specifies the width of the lines in pixels.
      */
     width?: number;
 }

package/field-types/highlight-line.interface.d.ts

@@ -4,24 +4,24 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the highlight line of the Candlestick and OHLC series.
+ * Specifies the appearance settings for the highlight line of the Candlestick and OHLC series.
  */
 export interface HighlightLine {
     /**
-     * The color of the highlighted line. Accepts a valid CSS color string, including hex and rgb.
-     * The default color is computed from the base-point color.
+     * Specifies the color of the highlighted line. Accepts a valid CSS color string, including hex and rgb.
+     * By default, the color is computed from the base-point color.
      */
     color?: string;
     /**
-     * The dash type of the line.
+     * Specifies the dash type of the line.
      */
     dashType?: DashType;
     /**
-     * The opacity of the line. By default, the border is opaque (`opacity = 1`).
+     * Specifies the opacity of the line. By default, the border is opaque (`opacity = 1`).
      */
     opacity?: number;
     /**
-     * The width of the line in pixels.
+     * Specifies the width of the line in pixels.
      */
     width?: number;
 }

package/field-types/label-connectors.interface.d.ts

@@ -3,19 +3,19 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The appearance settings for the label connectors on the Donut and Pie series.
+ * Specifies the appearance settings for the label connectors on the Donut and Pie series.
  */
 export interface LabelConnectors {
     /**
-     * The color of the connecting line. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the connecting line. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The distance between the connector line and the main chart.
+     * Specifies the distance between the connector line and the main chart.
      */
     padding?: number;
     /**
-     * The width of the connector line in pixels.
+     * Specifies the width of the connector line in pixels.
      */
     width?: number;
 }

package/field-types/label-rotation.interface.d.ts

@@ -3,20 +3,20 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The rotation configuration for the axis labels.
+ * Specifies the rotation configuration for the axis labels.
  */
 export interface LabelRotation {
     /**
-     * The alignment of the rotated labels relative to the slot center.
-     * The supported values are `"end"` and `"center"`.
-     * By default, the Charts align the closest end of the label to the center.
-     * If set to `"center"`, the center of the rotated label will be aligned instead.
+     * Specifies the alignment of the rotated labels relative to the slot center.
+     * Supports the values `"end"` and `"center"`.
+     * By default, Charts align the closest end of the label to the center.
+     * If set to `"center"`, Charts align the center of the rotated label instead.
      */
     align?: 'end' | 'center';
     /**
-     * The rotation angle of the labels.
-     * By default, the labels are not rotated.
-     * Can be set to `"auto"`. In this case, the labels will be rotated
+     * Specifies the rotation angle of the labels.
+     * By default, labels are not rotated.
+     * Can be set to `"auto"`. In this case, labels rotate
      * only if the slot size is not sufficient for the entire labels.
      */
     angle?: number | 'auto';

package/field-types/legend-labels.interface.d.ts

@@ -6,31 +6,31 @@ import { LegendLabelsContentArgs } from '../argument-types/legend-labels-content
 import { Margin } from './margin.interface';
 import { Padding } from './padding.interface';
 /**
- * The appearance configuration for the legend labels.
+ * Specifies the appearance configuration for the legend labels.
  */
 export interface LegendLabels {
     /**
-     * The color of the legend label text.
+     * Specifies the color of the legend label text.
      * Accepts a valid [CSS `color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
      * configuration string, including hex and rgb.
      */
     color?: string;
     /**
-     * The font of the legend label text.
+     * Specifies the font of the legend label text.
      * Accepts a valid [CSS `font`](https://developer.mozilla.org/en-US/docs/Web/CSS/font)
      * configuration string.
      */
     font?: string;
     /**
-     * The margin of the labels. A numeric value sets all margins.
+     * Specifies the margin of the labels. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The padding of the labels. A numeric value sets all paddings.
+     * Specifies the padding of the labels. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * A function used to generate the content of each label.
+     * Specifies a function used to generate the content of each label.
      */
     content?: (e: LegendLabelsContentArgs) => string;
 }

package/field-types/line-style.d.ts

@@ -3,12 +3,12 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The line style of the series.
+ * Specifies the line style of the series.
  *
  * The possible values are:
- * - `"normal"`—The values are connected with a straight line.
- * - `"step"`—The values are connected with a right-angled line. Available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"line"`.
- * - `"smooth"`—The values are connected with a smooth line. Not supported for stacked area series with missing values.
+ * - `"normal"`—Connects the values with a straight line.
+ * - `"step"`—Connects the values with a right-angled line. Available when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"line"`.
+ * - `"smooth"`—Connects the values with a smooth line. Not supported for stacked area series with missing values.
  *
  * @example
  * ```ts

package/field-types/lock-axis.d.ts

@@ -6,9 +6,9 @@
  * Specifies an axis for locking during the pan and zoom operations ([see example](slug:panzoom_chart_charts#toc-disabling-pan-and-zoom-directions)).
  *
  * The possible values are:
- * - `"none"`—No axis is locked.
- * - `"x"`—The X axis is locked.
- * - `"y"`—The Y axis is locked.
+ * - `"none"`—Locks no axis.
+ * - `"x"`—Locks the X axis.
+ * - `"y"`—Locks the Y axis.
  *
  */
 export type LockAxis = 'none' | 'x' | 'y';

package/field-types/margin.interface.d.ts

@@ -3,24 +3,24 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The margin configuration for each side
+ * Specifies the margin configuration for each side
  * ([see example]({% slug api_charts_titlecomponent %})).
  */
 export interface Margin {
     /**
-     * The top margin in pixels.
+     * Specifies the top margin in pixels.
      */
     top?: number;
     /**
-     * The right margin in pixels.
+     * Specifies the right margin in pixels.
      */
     right?: number;
     /**
-     * The bottom margin in pixels.
+     * Specifies the bottom margin in pixels.
      */
     bottom?: number;
     /**
-     * The left margin in pixels.
+     * Specifies the left margin in pixels.
      */
     left?: number;
 }