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

package/esm2022/chart/series-item/extremes.component.mjs

@@ -8,24 +8,33 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration of the Chart series extremes.
+ * Represents the configuration of the Chart series extremes.
  * Applies to extreme outliers.
- * For more information, refer to [`series.outliers`]({% slug api_charts_seriesitemcomponent %}#toc-outliers).
+ * For more information, refer to the [`series.extremes`]({% slug api_charts_seriesitemcomponent %}#toc-extremes) option.
  */
 export class SeriesExtremesComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the extremes.
+     */
     background;
+    /**
+     * Specifies the border configuration of the extremes.
+     */
     border;
+    /**
+     * Specifies the rotation angle of the extremes.
+     */
     rotation;
     /**
-    * The extremes size in pixels.
-    * @default 6
-    */
+     * Specifies the extremes size in pixels.
+     * @default 6
+     */
     size;
     /**
-    * The shape of the series extremes.
-    * @default 'circle'
-    */
+     * Specifies the shape of the series extremes.
+     * @default 'circle'
+     */
     type;
     constructor(configurationService) {
         super('extremes', configurationService);

package/esm2022/chart/series-item/highlight.component.mjs

@@ -8,21 +8,42 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The Chart series highlighting configuration options.
+ * Represents the Chart series highlighting configuration options.
  */
 export class SeriesHighlightComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the border configuration of the highlight.
+     */
     border;
+    /**
+     * Specifies the color of the highlight.
+     */
     color;
+    /**
+     * Specifies the line configuration of the highlight.
+     */
     line;
+    /**
+     * Specifies the markers configuration of the highlight.
+     */
     markers;
+    /**
+     * Specifies the opacity of the highlight.
+     */
     opacity;
+    /**
+     * Specifies a function that handles the highlight toggle event.
+     */
     toggle;
     /**
-    * If set to `true`, the Chart highlights the series when the user hovers over it with the mouse.
-    * @default true
-    */
+     * Determines whether the Chart highlights the series when the user hovers over it with the mouse.
+     * @default true
+     */
     visible;
+    /**
+     * Specifies a function that creates a custom visual for the highlight.
+     */
     visual;
     constructor(configurationService) {
         super('highlight', configurationService);

package/esm2022/chart/series-item/labels.component.mjs

@@ -8,56 +8,101 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration of the Chart series label
+ * Represents the configuration of the Chart series labels
  * ([see example]({% slug labels_chart_charts %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-series>
+ *   <kendo-chart-series-item [data]="[1, 2, 3] type="line">
+ *    <kendo-chart-series-item-labels format="c">
+ *    </kendo-chart-series-item-labels>
+ *  </kendo-chart-series-item>
+ *  </kendo-chart-series>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesLabelsFromComponent} and {@link SeriesLabelsToComponent}.
  */
 export class SeriesLabelsComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the alignment of the labels.
+     */
     align;
+    /**
+     * Specifies the background color of the labels.
+     */
     background;
+    /**
+     * Specifies the border configuration of the labels.
+     */
     border;
+    /**
+     * Specifies the text color of the labels.
+     */
     color;
+    /**
+     * Specifies a function that returns the content of the labels.
+     */
     content;
+    /**
+     * Specifies a function that returns the ARIA content of the labels.
+     */
     ariaContent;
     /**
-     * The distance between the labels when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
+     * Specifies the distance between the labels when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
      * @default 35
      */
     distance;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      * @default '12px sans-serif'
      */
     font;
     /**
-     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of the `IntlService`.
+     * Specifies the format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of the `IntlService`.
      * @default '{0}'
      */
     format;
     /**
-     * The margin of the labels. A numeric value sets all margins.
+     * Specifies the margin of the labels. A numeric value sets all margins.
      * @default 5
      */
     margin;
     /**
-     * The padding of the labels. A numeric value sets all paddings.
+     * Specifies the padding of the labels. A numeric value sets all paddings.
      * Bar and Column series always apply full padding and ignore this setting.
      * @default 0
      */
     padding;
     /**
-     * The position of the labels.
+     * Specifies the position of the labels.
      */
     position;
+    /**
+     * Specifies the rotation angle of the labels.
+     */
     rotation;
     /**
-     * If set to `true`, the Chart displays the series labels.
+     * Determines whether the Chart displays the series labels.
      * @default false
      */
     visible;
+    /**
+     * Specifies a function that creates a custom visual for the labels.
+     */
     visual;
     // These options are also available as child components
+    /**
+     * Specifies the `from` labels configuration.
+     */
     from;
+    /**
+     * Specifies the `to` labels configuration.
+     */
     to;
     constructor(configurationService) {
         super('labels', configurationService);

package/esm2022/chart/series-item/labels.from.component.mjs

@@ -8,37 +8,52 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The `from` label configuration of the Chart series.
+ * Represents the `from` labels configuration of the Chart series.
  */
 export class SeriesLabelsFromComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the `from` labels.
+     */
     background;
+    /**
+     * Specifies the border configuration of the `from` labels.
+     */
     border;
+    /**
+     * Specifies the text color of the `from` labels.
+     */
     color;
+    /**
+     * Specifies a function that returns the content of the `from` labels.
+     */
     content;
     /**
-     * The font style of the `from` labels.
+     * Specifies the font style of the `from` labels.
      * @default '12px sans-serif'
      */
     font;
     /**
-     * The format of the `from` labels. Uses the `IntlService` [`format`]({% slug api_intl_intlservice %}#toc-format) method.
+     * Specifies the format of the `from` labels. Uses the `IntlService` [`format`]({% slug api_intl_intlservice %}#toc-format) method.
      * @default '{0}'
      */
     format;
     /**
-     * The margin of the `from` labels. A numeric value sets all margins.
+     * Specifies the margin of the `from` labels. A numeric value sets all margins.
      * @default 5
      */
     margin;
     /**
-     * The padding of the `from` labels. A numeric value sets all paddings.
+     * Specifies the padding of the `from` labels. A numeric value sets all paddings.
      * @default 0
      */
     padding;
+    /**
+     * Specifies the position of the `from` labels.
+     */
     position;
     /**
-     * If set to `true`, the Chart displays the series `from` labels.
+     * Determines whether the Chart displays the series `from` labels.
      * @default false
      */
     visible;

package/esm2022/chart/series-item/labels.to.component.mjs

@@ -8,37 +8,52 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The `to` label configuration of the Chart series.
+ * Represents the `to` labels configuration of the Chart series.
  */
 export class SeriesLabelsToComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the `to` labels.
+     */
     background;
+    /**
+     * Specifies the border configuration of the `to` labels.
+     */
     border;
+    /**
+     * Specifies the text color of the `to` labels.
+     */
     color;
+    /**
+     * Specifies a function that returns the content of the `to` labels.
+     */
     content;
     /**
-     * The font style of the `to` labels.
+     * Specifies the font style of the `to` labels.
      * @default '12px sans-serif'
      */
     font;
     /**
-     * The format of the `to` labels. Uses [IntlService format]({% slug api_intl_intlservice %}#toc-format).
+     * Specifies the format of the `to` labels. Uses [IntlService format]({% slug api_intl_intlservice %}#toc-format).
      * @default '{0}'
      */
     format;
     /**
-     * The margin of the `to` labels. A numeric value sets all margins.
+     * Specifies the margin of the `to` labels. A numeric value sets all margins.
      * @default 5
      */
     margin;
     /**
-     * The padding of the `to` labels. A numeric value sets all paddings.
+     * Specifies the padding of the `to` labels. A numeric value sets all paddings.
      * @default 0
      */
     padding;
+    /**
+     * Specifies the position of the `to` labels.
+     */
     position;
     /**
-     * If set to `true`, the Chart displays the series `to` labels.
+     * Determines whether the Chart displays the series `to` labels.
      * @default false
      */
     visible;

package/esm2022/chart/series-item/markers.component.mjs

@@ -8,7 +8,7 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration of the Chart series marker.
+ * Represents the configuration of the Chart series marker.
  *
  * @example
  * ```html
@@ -23,26 +23,44 @@ import * as i1 from "../../common/configuration.service";
  */
 export class SeriesMarkersComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the markers.
+     */
     background;
+    /**
+     * Specifies the border configuration of the markers.
+     */
     border;
+    /**
+     * Specifies the rotation angle of the markers.
+     */
     rotation;
     /**
-     * The marker size in pixels.
+     * Specifies the marker size in pixels.
      * @default 6
      */
     size;
     /**
-     * The shape of the series markers.
+     * Specifies the shape of the series markers.
      * @default 'cirlce'
      */
     type;
     /**
-     * If set to `true`, the Chart displays the series markers.
+     * Determines whether the Chart displays the series markers.
      * @default true
      */
     visible;
+    /**
+     * Specifies a function that creates a custom visual for the markers.
+     */
     visual;
+    /**
+     * Specifies the `from` markers configuration.
+     */
     from;
+    /**
+     * Specifies the `to` markers configuration.
+     */
     to;
     constructor(configurationService) {
         super('markers', configurationService);

package/esm2022/chart/series-item/notes.component.mjs

@@ -8,27 +8,45 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The series notes configuration
+ * Represents the Chart series notes configuration
  * ([see example]({% slug notes_chart_charts %})).
  *
  * @example
  * ```html
- * <kendo-chart ...>
+ * <kendo-chart
  *   <kendo-chart-series>
- *     <kendo-chart-series-item type="line" [data]="data"...>
+ *     <kendo-chart-series-item type="line" [data]="[1, 2, 3]">
  *       <kendo-chart-series-item-notes [icon]="{type: 'square'}"> </kendo-chart-series-item-notes>
  *     </kendo-chart-series-item>
  *   </kendo-chart-series>
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesNotesIconComponent} and {@link SeriesNotesLabelComponent}.
  */
 export class SeriesNotesComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the line configuration for the notes.
+     */
     line;
+    /**
+     * Specifies the position of the notes.
+     */
     position;
+    /**
+     * Specifies a function that creates a custom visual for the notes.
+     */
     visual;
     // These options are also available as child components
+    /**
+     * Specifies the icon configuration for the notes.
+     */
     icon;
+    /**
+     * Specifies the label configuration for the notes.
+     */
     label;
     constructor(configurationService) {
         super('notes', configurationService);

package/esm2022/chart/series-item/notes.icon.component.mjs

@@ -8,21 +8,30 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The icon of the notes.
+ * Represents the configuration of the Chart series notes icon.
  */
 export class SeriesNotesIconComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the notes icon.
+     */
     background;
+    /**
+     * Specifies the border configuration of the notes icon.
+     */
     border;
+    /**
+     * Specifies the size of the notes icon.
+     */
     size;
     /**
-     * The icon shape.
+     * Specifies the icon shape.
      *
      * @default 'circle'
      */
     type;
     /**
-     * The visibility of the notes icon.
+     * Determines whether the notes icon is visible.
      *
      * @default true
      */

package/esm2022/chart/series-item/notes.label.component.mjs

@@ -8,41 +8,53 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The label of the notes.
+ * Represents the configuration of the Chart series notes label.
  */
 export class SeriesNotesLabelComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the label.
+     */
     background;
+    /**
+     * Specifies the border of the label.
+     */
     border;
+    /**
+     * Specifies the color of the label.
+     */
     color;
+    /**
+     * Specifies the content of the note.
+     */
     content;
     /**
-     * The font style of the label.
+     * Specifies the font style of the label.
      *
      * @default '12px sans-serif'
      */
     font;
     /**
-     * The format for displaying the notes label. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * Specifies 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.
      *
      * @default '{0}'
      */
     format;
     /**
-     * The position of the labels.
+     * Specifies the position of the labels.
      *
      * @default 'inside'
      */
     position;
     /**
-     * The rotation angle of the label.
+     * Specifies the rotation angle of the label.
      *
      * @default 0
      */
     rotation;
     /**
-     * If set to `true`, the Chart displays the series notes label.
+     * Determines whether the Chart displays the series notes label.
      *
      * @default true
      */

package/esm2022/chart/series-item/outliers.component.mjs

@@ -8,23 +8,32 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration of the Chart series outliers.
+ * Represents the configuration of the Chart series outliers.
  * Applies to mild outliers.
- * For more information, refer to the [`series.extremes`]({% slug api_charts_seriesitemcomponent %}#toc-extremes) option.
+ * For more information, refer to [`series.outliers`]({% slug api_charts_seriesitemcomponent %}#toc-outliers).
  */
 export class SeriesOutliersComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the outliers.
+     */
     background;
+    /**
+     * Specifies the border configuration of the outliers.
+     */
     border;
+    /**
+     * Specifies the rotation angle of the outliers.
+     */
     rotation;
     /**
-     * The marker size in pixels.
+     * Specifies the marker size in pixels.
      *
      * @default 6
      */
     size;
     /**
-     * The outliers shape.
+     * Specifies the outliers shape.
      *
      * @default 'circle'
      */

package/esm2022/chart/series-item/tooltip.component.mjs

@@ -8,23 +8,38 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration options of the Chart series tooltip
+ * Represents the configuration options of the Chart series tooltip
  * ([see example]({% slug tooltips_chart_charts %})).
  */
 export class SeriesTooltipComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the tooltip.
+     */
     background;
+    /**
+     * Specifies the border configuration of the tooltip.
+     */
     border;
+    /**
+     * Specifies the text color of the tooltip.
+     */
     color;
     /**
-     * The font of the tooltip.
+     * Specifies the font of the tooltip.
      * @default '12px sans-serif'
      */
     font;
+    /**
+     * Specifies the format of the tooltip.
+     */
     format;
+    /**
+     * Specifies the padding of the tooltip.
+     */
     padding;
     /**
-     * If set to `true`, the Chart displays the series tooltip.
+     * Determines whether the Chart displays the series tooltip.
      * @default false
      */
     visible;

package/esm2022/chart/series-item/trendline.component.mjs

@@ -8,14 +8,48 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration options of the Chart trendline series
+ * Represents the configuration options of the Chart trendline series
  * ([see example]({% slug trendlines_chart_charts %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart [pannable]="{ lock: 'y' }" [zoomable]="{ mousewheel: { lock: 'y' } }">
+ *   <kendo-chart-series>
+ *     <kendo-chart-series-item
+ *       name="Sales By Quarter"
+ *       type="line"
+ *       [data]="salesByQuarter"
+ *       field="count"
+ *       categoryField="date">
+ *     </kendo-chart-series-item>
+ *     <kendo-chart-series-item
+ *       name="Sales Forecast"
+ *       type="linearTrendline"
+ *       for="Sales By Quarter">
+ *       <kendo-chart-series-item-trendline [forecast]="{ after: 10 }">
+ *       </kendo-chart-series-item-trendline>
+ *     </kendo-chart-series-item>
+ *   </kendo-chart-series>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link TrendlineForecastComponent}.
  */
 export class SeriesTrendlineComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the period for the trendline.
+     */
     period;
+    /**
+     * Specifies the order for the trendline.
+     */
     order;
     // These options are also available as child components
+    /**
+     * Specifies the forecast configuration for the trendline.
+     */
     forecast;
     constructor(configurationService) {
         super('trendline', configurationService);

package/esm2022/chart/series-item/trendline.forecast.component.mjs

@@ -8,15 +8,21 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration options of the Chart trendline forecast
+ * Represents the configuration options of the Chart trendline forecast
  * ([see example]({% slug trendlines_chart_charts %})).
  */
 export class SeriesTrendlineForecastComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the number of periods before the series.
+     */
     before;
+    /**
+     * Specifies the number of periods after the series.
+     */
     after;
     /**
-     * The series trendline forecast settings.
+     * Specifies the series trendline forecast settings.
      *
      * The `forecast` option is supported  when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"linearTrendline"` and the parent series are either date series, `"scatter"` or `"scatterLine"` series.
      */