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

package/option-types/series-item/markers.interface.d.ts

@@ -5,31 +5,31 @@
 import { drawing } from '@progress/kendo-drawing';
 import { Border, MarkersVisualArgs, MarkerType } from '../../common/property-types';
 /**
- * The configuration options of the series markers.
+ * Represents the configuration options of the series markers.
  */
 export interface SeriesMarkers {
     /**
-     * The background color of the series markers.
+     * Specifies the background color of the series markers.
      */
     background?: string;
     /**
-     * The border of the markers.
+     * Specifies the border of the markers.
      */
     border?: Border;
     /**
-     * The rotation angle of the markers.
+     * Specifies the rotation angle of the markers.
      */
     rotation?: number;
     /**
-     * The marker size in pixels.
+     * Specifies the marker size in pixels.
      */
     size?: number;
     /**
-     * The border radius in pixels when `type` is set to `"roundedRect"`. Defaults to 1/5 of the marker size.
+     * Specifies the border radius in pixels when `type` is set to `"roundedRect"`. Defaults to 1/5 of the marker size.
      */
     borderRadius?: number;
     /**
-     * The shape of the series markers.
+     * Specifies the shape of the series markers.
      */
     type?: MarkerType;
     /**
@@ -38,15 +38,15 @@ export interface SeriesMarkers {
      */
     visible?: boolean;
     /**
-     * A function for creating a custom visual for the markers.
+     * Specifies a function for creating a custom visual for the markers.
      */
     visual?: (e: MarkersVisualArgs) => drawing.Element;
     /**
-     * The Chart series marker configuration for the `from` point. Supported for the RangeArea and VerticalRangeArea series.
+     * Specifies the Chart series marker configuration for the `from` point. Supported for the RangeArea and VerticalRangeArea series.
      */
     from?: SeriesMarkers;
     /**
-     * The Chart series marker configuration for the `to` point. Supported for the RangeArea and VerticalRangeArea series.
+     * Specifies the Chart series marker configuration for the `to` point. Supported for the RangeArea and VerticalRangeArea series.
      */
     to?: SeriesMarkers;
 }

package/option-types/series-item/notes.icon.interface.d.ts

@@ -4,27 +4,27 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, MarkerType } from '../../common/property-types';
 /**
- * The configuration options of the series notes icon.
+ * Represents the series notes icon options.
  */
 export interface SeriesNotesIcon {
     /**
-     * The background color of the notes icon.
+     * Sets the background color of the notes icon.
      */
     background?: string;
     /**
-     * The border of the notes icon.
+     * Configures the border of the notes icon.
      */
     border?: Border;
     /**
-     * The size of the notes icon.
+     * Sets the size of the notes icon.
      */
     size?: number;
     /**
-     * The icon shape.
+     * Sets the icon shape.
      */
     type?: MarkerType;
     /**
-     * The visibility of the notes icon.
+     * Sets the visibility of the notes icon.
      */
     visible?: boolean;
 }

package/option-types/series-item/notes.interface.d.ts

@@ -7,27 +7,27 @@ import { NoteLine, NotePosition, SeriesNoteVisualArgs } from '../../common/prope
 import { SeriesNotesIcon } from './notes.icon.interface';
 import { SeriesNotesLabel } from './notes.label.interface';
 /**
- * The configuration options of the series notes.
+ * Represents the configuration options of the series notes.
  */
 export interface SeriesNotes {
     /**
-     * The line of the series notes.
+     * Specifies the line of the series notes.
      */
     line?: NoteLine;
     /**
-     * The position of the series note.
+     * Specifies the position of the series note.
      */
     position?: NotePosition;
     /**
-     * A function for creating a custom visual for the notes.
+     * Specifies a function for creating a custom visual for the notes.
      */
     visual?: (e: SeriesNoteVisualArgs) => drawing.Element;
     /**
-     * The icon of the notes.
+     * Specifies the icon of the notes.
      */
     icon?: SeriesNotesIcon;
     /**
-     * The label of the notes.
+     * Specifies the label of the notes.
      */
     label?: SeriesNotesLabel;
 }

package/option-types/series-item/notes.label.interface.d.ts

@@ -4,46 +4,49 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, NoteLabelPosition, SeriesNoteContentArgs } from '../../common/property-types';
 /**
- * The configuration options of the series notes label.
+ * Represents the series notes label options.
  */
 export interface SeriesNotesLabel {
     /**
-     * The background color of the label. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the background color of the label.
+     * Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the label.
+     * Configures the border of the label.
      */
     border?: Border;
     /**
-     * The text color of the label. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the text color of the label.
+     * Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The function which returns the label content.
+     * Sets the function which returns the label content.
      * You can split the text into multiple lines by using line feed characters (`"\n"`).
      */
     content?: (e: SeriesNoteContentArgs) => string;
     /**
-     * The font style of the label.
+     * Sets the font style of the label.
      */
     font?: string;
     /**
-     * The format for displaying the notes label. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
-     * Contains one placeholder (`"{0}"`) which represents the axis value.
+     * Sets the format for displaying the notes label.
+     * Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService` and contains one placeholder (`"{0}"`) which represents the axis value.
      */
     format?: string;
     /**
-     * The position of the labels.
+     * Sets the position of the labels.
      *
      */
     position?: NoteLabelPosition;
     /**
-     * The rotation angle of the label. By default, the label is not rotated.
+     * Sets the rotation angle of the label.
+     * By default, the label is not rotated.
      */
     rotation?: number;
     /**
-     * If set to `true`, the Chart displays the series notes label.
+     * Determines if the Chart displays the series notes label.
      * By default, the series notes label is visible.
      */
     visible?: boolean;

package/option-types/series-item/outliers.interface.d.ts

@@ -4,27 +4,27 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, MarkerType } from '../../common/property-types';
 /**
- * The configuration options of the series outliers.
+ * Represents the series outliers options.
  */
 export interface SeriesOutliers {
     /**
-     * The background color of the series outliers.
+     * Sets the background color of the series outliers.
      */
     background?: string;
     /**
-     * The border of the outliers.
+     * Configures the border of the outliers.
      */
     border?: Border;
     /**
-     * The rotation angle of the outliers.
+     * Sets the rotation angle of the outliers.
      */
     rotation?: number;
     /**
-     * The marker size in pixels.
+     * Sets the marker size in pixels.
      */
     size?: number;
     /**
-     * The outliers shape.
+     * Sets the outliers shape.
      */
     type?: MarkerType;
 }

package/option-types/series-item/tooltip.interface.d.ts

@@ -4,45 +4,51 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Padding } from '../../common/property-types';
 /**
- * The configuration options of the series tooltip.
+ * Represents the series tooltip options.
  */
 export interface SeriesTooltip {
     /**
-     * The background color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the background color of the tooltip.
+     * Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border configuration options.
+     * Configures the border options.
      */
     border?: Border;
     /**
-     * The text color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the text color of the tooltip.
+     * Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The font of the tooltip.
+     * Sets the font of the tooltip.
      */
     font?: string;
     /**
-     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * Sets the format of the labels.
+     * Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
      *
-     * The Area, Bar, Column, Funnel, Pyramid, Line, and Pie are represented by `{0}` as the value placeholder.
+     * Use different value placeholders depending on the Chart type.
      *
-     * The Bubble chart type uses the following value placeholders: `{0}` - x value, `{1}` - y value, `{2}` - size value, and `{3}` - category name.
+     * The Area, Bar, Column, Funnel, Pyramid, Line, and Pie Charts use `{0}` as the value placeholder.
      *
-     * The Scatter and ScatterLine chart types use the following value placeholders: `{0}` - x value and `{1}` - y value.
+     * The Bubble Chart uses `{0}` for x value, `{1}` for y value, `{2}` for size value, and `{3}` for category name.
      *
-     * The Candlestick and OHLC chart types use the following value placeholders: `{0}` - open value, `{1}` - high value, `{2}` - low value, `{3}` - close value, and `{4}` - category name.
+     * The Scatter and ScatterLine Charts use `{0}` for x value and `{1}` for y value.
      *
-     * The RangeArea, RangeBar, and RangeColumn chart types utilize the following value placeholders: `{0}` - from value and `{1}` - to value.
+     * The Candlestick and OHLC Charts use `{0}` for open value, `{1}` for high value, `{2}` for low value, `{3}` for close value, and `{4}` for category name.
+     *
+     * The RangeArea, RangeBar, and RangeColumn Charts use `{0}` for from value and `{1}` for to value.
      */
     format?: string;
     /**
-     * The padding of the tooltip. A numeric value sets all paddings.
+     * Sets the padding of the tooltip.
+     * A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * If set to `true`, the Chart displays the series tooltip.
+     * Determines if the Chart displays the series tooltip.
      * By default, the series tooltip is not displayed.
      */
     visible?: boolean;

package/option-types/series-item/trendline.interface.d.ts

@@ -4,31 +4,29 @@
 *-------------------------------------------------------------------------------------------*/
 import { TrendlineForecast } from "../../common/property-types";
 /**
- * The configuration options of the series trendlines.
+ * Represents the series trendlines options.
  */
 export interface SeriesTrendline {
     /**
-     * The trendline forecast settings. By default, the trendline does not display a forecast.
-     *
-     * The forecast setting is supported for Linear Trendlines on date and scatter series.
+     * Configures the trendline forecast settings.
+     * By default, the trendline does not display a forecast and this setting is supported for Linear Trendlines on date and scatter series.
      */
     forecast?: TrendlineForecast;
     /**
-     * The number of intervals to take when calculating averages. The value should be an integer greater than 2.
-     *
-     * The period setting is supported only for Moving Average trendlines.
+     * Sets the number of intervals to take when calculating averages.
+     * The value should be an integer greater than 2 and this setting is supported only for Moving Average trendlines.
      */
     period?: number;
     /**
-     * The order (degree) of the Polynomial trendline. The default value is 2.
-     *
+     * Sets the order (degree) of the Polynomial trendline.
      * Accepted values are from 2 to 6:
-     * * 2: a Quadratic polynomial trendline with a single extreme point (minimum or maximum) point.
-     * * 3: a Cubic polynomial trendline with up to 2 extreme points.
-     * * 4: a polynomial trendline of 4th degree with up to 3 extreme points.
-     * * 5: a polynomial trendline of 5th degree with up to 4 extreme points.
-     * * 6: a polynomial trendline of 6th degree with up to 5 extreme points.
+     * * 2—Creates a Quadratic polynomial trendline with a single extreme point (minimum or maximum) point.
+     * * 3—Creates a Cubic polynomial trendline with up to 2 extreme points.
+     * * 4—Creates a polynomial trendline of 4th degree with up to 3 extreme points.
+     * * 5—Creates a polynomial trendline of 5th degree with up to 4 extreme points.
+     * * 6—Creates a polynomial trendline of 6th degree with up to 5 extreme points.
      *
+     * @default 2
      */
     order?: number;
 }