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

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

@@ -13,7 +13,7 @@ import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 const toggle = (flag) => flag === undefined ? false : !flag;
 /**
- * The configuration component for a series item.
+ * Represents the Kendo UI for Angular Chart Series Item component.
  *
  * @example
  * ```html
@@ -23,15 +23,20 @@ const toggle = (flag) => flag === undefined ? false : !flag;
  *   </kendo-chart-series>
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesErrorBarsComponent}, {@link SeriesExtremesComponent},
+ * {@link SeriesHighlightComponent}, {@link SeriesLabelsComponent}, {@link SeriesMarkersComponent},
+ * {@link SeriesNotesComponent}, {@link SeriesOutliersComponent}, {@link SeriesTooltipComponent}, and {@link SeriesTrendlineComponent}.
  */
 export class SeriesItemComponent extends CollectionItemComponent {
     configurationService;
     collectionService;
     /**
-     * The aggregate function for the date series.
-     * The function is used when a category (year, month, or other) contains two or more points.
+     * Specifies the aggregate function for the date series.
+     * Use this function when a category (year, month, or other) contains two or more points.
      * The Chart displays the return value of the function instead of the individual points.
-     * The `aggregate` option is supported for categorical chart axis only.
+     * Use the `aggregate` option with categorical chart axis only.
      *
      * The supported values are:
      * - `"avg"`&mdash;The average of all values for the date period.
@@ -48,249 +53,307 @@ export class SeriesItemComponent extends CollectionItemComponent {
      */
     aggregate;
     /**
-     * If set to `true`, the Chart automatically scales down to fit the content area.
+     * Determines whether the Chart automatically scales down to fit the content area.
      * Applicable for the Pie and Donut series. ([See example](slug:donut_seriestypes_charts#displaying-labels-in-angular-donut-chart)).
      * @default false
      */
     autoFit;
     /**
-     * The name of the value axis.
-     * The axis option is supported for Scatter plots. For more information on Scatter plots, refer to
+     * Specifies the name of the value axis.
+     * Use this option for Scatter plots. For more information on Scatter plots, refer to
      * [`xAxis`]({% slug api_charts_xaxis %}) and [`yAxis`]({% slug api_charts_yaxis %}).
      * @default 'primary'
      */
     axis;
+    /**
+     * Specifies the border configuration of the series.
+     */
     border;
+    /**
+     * Specifies the name of the category axis.
+     */
     categoryAxis;
     /**
-     * The data item field which contains the category name or date.
+     * Specifies the data item field which contains the category name or date.
      * If the category is a date, the points are rendered in chronological order.
      * @default 'category'
      */
     categoryField;
     /**
-     * The data field that contains the `close` value.
-     * The `closeField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
+     * Specifies the data field that contains the `close` value.
+     * Use the `closeField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
      * @default 'close'
      */
     closeField;
+    /**
+     * Specifies the color of the series.
+     */
     color;
     /**
-    * The data item field which contains the series color.
-    * The `colorField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type)
+    * Specifies the data item field which contains the series color.
+    * Use the `colorField` option when [`series.type`]({% slug api_charts_series %}#toc-type)
     * is set to `"bar"`, `"column"`, `"rangeBar"`, `"rangeColumn"`, `"bubble"`, `"donut"`, `"pie"`, `"candlestick"`,
     * `"ohlc"`, or `"waterfall"`.
     * @default 'color'
     */
     colorField;
+    /**
+     * Specifies the connectors configuration for the labels.
+     */
     connectors;
     /**
-     * The data item field which contains the current value.
-     * The `currentField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bullet"` or `"verticalBullet"`.
+     * Specifies the data item field which contains the current value.
+     * Use the `currentField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bullet"` or `"verticalBullet"`.
      * @default 'current'
      */
     currentField;
     /**
-     * The dash type of line Chart.
-     * The `dashType` option is considered only if the [`series.type`]({% slug api_charts_series %}#toc-type) option is set to `"line"`.
+     * Specifies the dash type of line Chart.
+     * Use the `dashType` option only if the [`series.type`]({% slug api_charts_series %}#toc-type) option is set to `"line"`.
      * @default 'solid'
      */
     dashType;
+    /**
+     * Specifies the data source for the series.
+     */
     data;
+    /**
+     * Specifies the color that is applied when the `close` value is less than the `open` value.
+     */
     downColor;
     /**
-     * The data field which contains the color that is applied when the `open` value is greater than the `close` value.
-     * The `downColorField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"`.
+     * Specifies the data field which contains the color that is applied when the `open` value is greater than the `close` value.
+     * Use the `downColorField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"`.
      * @default 'downColor'
      */
     downColorField;
+    /**
+     * Specifies the field for the drilldown functionality.
+     */
     drilldownField;
     /**
-     * The `dynamicHeight` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
-     * When set to `false`, all segments become with the same height.
-     * Otherwise, the height of each segment is based on its value.
+     * Use the `dynamicHeight` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
+     * Determines whether all segments become with the same height.
+     * When set to `false`, all segments have the same height. Otherwise, the height of each segment is based on its value.
      * @default true
      */
     dynamicHeight;
     /**
-     * The option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`.
-     * When set to `true`, the ratio of the bases of each segment is calculated based on the ratio of
+     * Use this option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`.
+     * Determines whether the ratio of the bases of each segment is calculated based on the ratio of
      * `currentDataItem.value`/`nextDataItem.value`.
      * The last element is always created like a rectangle since there is no following element.
      * @default false
      */
     dynamicSlope;
     /**
-     * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) high value.
-     * The `errorHighField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
+     * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) `high` value.
+     * Use the `errorHighField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
      * @default 'errorHigh'
      */
     errorHighField;
     /**
-     * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) low value.
-     * The `errorLowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
+     * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) `low` value.
+     * Use the `errorLowField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
      * @default 'errorLow'
      */
     errorLowField;
     /**
-     * The data item field which contains a Boolean value indicating whether the sector is exploded.
-     * The `explodeField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
+     * Specifies the data item field which contains a Boolean value indicating whether the sector is exploded.
+     * Use the `explodeField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"donut"` or `"pie"`.
      * @default 'explode'
      */
     explodeField;
     /**
-     * The data item field which contains the series value.
+     * Specifies the data item field which contains the series value.
      * @default 'value'
      */
     field;
     /**
-     * The data item field which contains the series from value.
+     * Specifies the data item field which contains the series `from` value.
      * @default 'min'
      */
     fromField;
     /**
-     * The distance between the categories expressed as a percentage of the bar width.
-     * See the related spacing setting.
-     * The `gap` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
+     * Specifies the distance between the categories expressed as a percentage of the bar width.
+     * See the related `spacing` setting.
+     * Use the `gap` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
      * `"radarColumn"`, or `"waterfall"`.
      * @default 1.5
      */
     gap;
     /**
-     * The data field which contains the high value.
-     * The `highField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
-     * @default 'hight'
+     * Specifies the data field which contains the `high` value.
+     * Use the `highField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
+     * @default 'high'
      */
     highField;
+    /**
+     * Specifies the size of the hole in donut charts.
+     */
     holeSize;
+    /**
+     * Specifies the line configuration of the series.
+     */
     line;
     /**
-     * The data field containing the low value.
-     * The `lowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
+     * Specifies the data field containing the `low` value.
+     * Use the `lowField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"candlestick"` or `"ohlc"`.
      * @default 'low'
      */
     lowField;
     /**
-     * The data item field which contains the series lower value.
-     * The `lowerField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
+     * Specifies the data item field which contains the series `lower` value.
+     * Use the `lowerField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
      * @default 'lower'
      */
     lowerField;
     /**
-     * The margin around each donut series (ring). A numeric value sets all margins.
+     * Specifies the margin around each donut series (ring). A numeric value sets all margins.
      * @default 1
      */
     margin;
     /**
-     * The maximum size of the Chart bubble series marker.
+     * Specifies the maximum size of the Chart bubble series marker.
      * @default 100
      */
     maxSize;
+    /**
+     * Specifies the mean configuration of the series.
+     */
     mean;
     /**
-     * The data item field which contains the series mean value.
-     * The `meanField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
+     * Specifies the data item field which contains the series `mean` value.
+     * Use the `meanField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
      * @default 'mean'
      */
     meanField;
+    /**
+     * Specifies the median configuration of the series.
+     */
     median;
     /**
-     * The data item field which contains the series median value.
-     * The `medianField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
+     * Specifies the data item field which contains the series `median` value.
+     * Use the `medianField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
      * @default 'median'
      */
     medianField;
     /**
-     * The minimum size of the Chart bubble series marker.
+     * Specifies the minimum size of the Chart bubble series marker.
     * @default 5
      */
     minSize;
+    /**
+     * Specifies how to handle missing values in the series.
+     */
     missingValues;
+    /**
+     * Specifies the name of the series.
+     */
     name;
     /**
      * Specifies the top-base/bottom-base ratio of the whole Funnel Chart. If the `neckRatio` is set to `3`,
      * it means the top base is three times smaller than the bottom base.
-     * The `neckRatio` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` and `dynamicSlope` is set to `false`.
+     * Use the `neckRatio` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` and `dynamicSlope` is set to `false`.
      * @default 0.3
      */
     neckRatio;
+    /**
+     * Specifies the color for negative values.
+     */
     negativeColor;
+    /**
+     * Specifies the configuration for negative bubble values.
+     */
     negativeValues;
     /**
-     * The data item field which contains the series note text.
+     * Specifies the data item field which contains the series note text.
      * @default 'noteText'
      */
     noteTextField;
     /**
-     * The opacity of the series. By default, the series are opaque.
+     * Specifies the opacity of the series. By default, the series are opaque.
      * @default 1
      */
     opacity;
+    /**
+     * Specifies the data field that contains the `open` value.
+     */
     openField;
     /**
-     * The data item field which contains the series outliers value.
-     * The `outliersField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
+     * Specifies the data item field which contains the series `outliers` value.
+     * Use the `outliersField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
      * @default 'outliers'
      */
     outliersField;
+    /**
+     * Specifies the overlay configuration of the series.
+     */
     overlay;
+    /**
+     * Specifies the padding of the series.
+     */
     padding;
     /**
-     * The data item field which contains the series `q1` value.
-     * The `q1Field` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
+     * Specifies the data item field which contains the series `q1` value.
+     * Use the `q1Field` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
      * @default 'q1'
      */
     q1Field;
     /**
-     * The data item field which contains the series `q3` value.
-     * The `q3Field` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
+     * Specifies the data item field which contains the series `q3` value.
+     * Use the `q3Field` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
      * @default 'q3'
      */
     q3Field;
     /**
-     * The space in pixels between the different segments of the Funnel or Pyramid Chart.
-     * The `segmentSpacing` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
+     * Specifies the space in pixels between the different segments of the Funnel or Pyramid Chart.
+     * Use the `segmentSpacing` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"` or `"pyramid"`.
      * @default 0
      */
     segmentSpacing;
+    /**
+     * Specifies the size of the series.
+     */
     size;
     /**
-     * The data field which contains the bubble size value.
+     * Specifies the data field which contains the bubble size value.
      * @default 'size'
      */
     sizeField;
     /**
-     * The distance between series points within a category. Expressed as a percentage of the bar width.
+     * Specifies the distance between series points within a category. Expressed as a percentage of the bar width.
      * See the related `gap` setting.
-     * The spacing option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`, or
+     * Use the `spacing` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`, or
      * `"radarColumn"`.
      * @default 0.4
      */
     spacing;
     /**
-     * A Boolean value which indicates if the series have to be stacked.
+     * Determines whether the series have to be stacked.
      * A string value is interpreted as [`series.stack.group`]({% slug api_charts_seriesstack %}#toc-group).
      *
-     * The `stack` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
+     * Use the `stack` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
      * `"verticalLine"`, `"verticalArea"`, `"radarLine"`, `"radarArea"`, and `"radarColumn"`.
      * If not overridden, the stack settings of the first series are inherited as a default value by the rest of the series.
      * @default false
      */
     stack;
     /**
-     * The start angle (in degrees) of the first Donut or Pie segment.
-     * Angles increase clockwise with zero to the left. Negative values are acceptable.
+     * Specifies the start angle (in degrees) of the first Donut or Pie segment.
+     * Use positive values to increase angles clockwise with zero to the left. Negative values are acceptable.
      * @default 90
      */
     startAngle;
     /**
-     * The `style` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
+     * Specifies the line style configuration of the series.
+     * Use the `style` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
      * `"line"`, `"scatterLine"`, `"radarLine"`, or `"polarLine"`.
      * @default 'normal'
      */
     style;
     /**
-     * The data item field which contains the summary type for the Waterfall series.
+     * Specifies the data item field which contains the summary type for the Waterfall series.
      * The value (if any) of a data item marked as a summary point will be discarded.
      *
      * Summary columns are optional and can be one of two types:
@@ -300,122 +363,167 @@ export class SeriesItemComponent extends CollectionItemComponent {
      * @default 'summary'
      */
     summaryField;
+    /**
+     * Specifies the bullet target configuration.
+     */
     target;
     /**
-     * The data item field which contains the series to value.
+     * Specifies the data item field which contains the series `to` value.
      * @default 'max'
      */
     toField;
     /**
-     * The type of the series.
+     * Specifies the type of the series.
      * @default 'column'
      */
     type;
     /**
-     * The data item field which contains the series upper value.
-     * The `upperField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
+     * Specifies the data item field which contains the series `upper` value.
+     * Use the `upperField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"boxPlot"`.
      * @default 'upper'
      */
     upperField;
     /**
-     * Sets the visible property of a Chart series.
+     * Determines whether the Chart series is visible.
      * @default true
      */
     visible;
     /**
-     * A value which indicates whether to show the point category (for Funnel, Pyramid, Donut, and Pie series)
+     * Determines whether to show the point category (for Funnel, Pyramid, Donut, and Pie series)
      * or the series name (for other available series types) in the legend.
      * @default true
      */
     visibleInLegend;
+    /**
+     * Specifies the data item field which contains the visibility state in the legend.
+     */
     visibleInLegendField;
+    /**
+     * Specifies a function that returns a custom visual for the series.
+     */
     visual;
+    /**
+     * Specifies the width of the series.
+     */
     width;
+    /**
+     * Specifies the whiskers configuration of the series.
+     */
     whiskers;
     /**
-     * The name of the X axis.
-     * The [`xAxis`]({% slug api_charts_xaxis %}) option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or `"polar"` series.
+     * Specifies the name of the X axis.
+     * Use the [`xAxis`]({% slug api_charts_xaxis %}) option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or `"polar"` series.
      * For the Polar series, the [`xAxis`]({% slug api_charts_xaxis %}) range is expressed in degrees.
      * @default 'primary'
      */
     xAxis;
     /**
-     * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) xAxis low value.
-     * The `xErrorLowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
+     * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) xAxis `high` value.
+     * Use the `xErrorHighField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
      * `"bubble"`.
      * @default 'xErrorHigh'
      */
     xErrorHighField;
     /**
-     * The data item field containing the x value.
-     * The `xField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or
-     * `"polar"` series.
+     * Specifies the data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) xAxis `low` value.
+     * Use the `xErrorLowField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
+     * `"bubble"`.
      * @default 'xErrorLow'
      */
     xErrorLowField;
     /**
-     * The data item field containing the x value.
-     * The `xField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or
+     * Specifies the data item field containing the `x` value.
+     * Use the `xField` option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or
      * `"polar"` series.
      * @default 'x'
      */
     xField;
     /**
-     * The name of the Y axis to use.
+     * Specifies the name of the Y axis to use.
      * Available for the Bubble, Scatter, Scatter Line, and Polar series.
      * @default 'primary'
      */
     yAxis;
     /**
-      * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis high value.
+      * Specifies the data item field that contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis `high` value.
       * The `yErrorHighField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
       * `"bubble"`.
       * @default 'yErrorHigh'
       */
     yErrorHighField;
     /**
-     * The data item field which contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis low value.
+     * Specifies the data item field that contains the [`series.errorBars`]({% slug api_charts_series %}#toc-errorbars) yAxis `low` value.
      * The `yErrorLowField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or
      * `"bubble"`.
      * @default 'yErrorLow'
      */
     yErrorLowField;
     /**
-     * The data item field containing the y value.
+     * Specifies the data item field that contains the `y` value.
      * The `yField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bubble"`, `"scatter"`, or `"scatterLine"`.
      * @default 'y'
      */
     yField;
+    /**
+     * Specifies the z-index of the series.
+     */
     zIndex;
     /**
-     * The configuration options of the trendline series.
+     * Specifies the configuration options of the trendline series.
      *
      * The `trendline` option is supported  when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
      * "`linearTrendline`", "`exponentialTrendline`", "`logarithmicTrendline`", "`powerTrendline`", "`polynomialTrendline`" or "`movingAverageTrendline`".
      */
     trendline;
+    /**
+     * Specifies the name of the series for which the current series serves as a trendline.
+     */
     for;
     /**
-     * The configuration options of the series legend item.
+     * Specifies the configuration options of the series legend item.
      */
     legendItem;
     /**
-     * The configuration options of the series pattern.
+     * Specifies the configuration options of the series pattern.
      */
     pattern;
     /**
-     * The data item field which contains the series pattern.
+     * Specifies the data item field that contains the series pattern.
      * The `patternField` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"pie"`, `"donut"`, `"funnel"`, `"heatmap"`, or `"pyramid"`.
      */
     patternField;
     // These options are also available as child components
+    /**
+     * Specifies the configuration options of the series error bars.
+     */
     errorBars;
+    /**
+     * Specifies the configuration options of the series extremes.
+     */
     extremes;
+    /**
+     * Specifies the configuration options of the series highlight.
+     */
     highlight;
+    /**
+     * Specifies the configuration options of the series labels.
+     */
     labels;
+    /**
+     * Specifies the configuration options of the series markers.
+     */
     markers;
+    /**
+     * Specifies the configuration options of the series notes.
+     */
     notes;
+    /**
+     * Specifies the configuration options of the series outliers.
+     */
     outliers;
+    /**
+     * Specifies the configuration options of the series tooltip.
+     */
     tooltip;
     seriesTooltip;
     drilldownTemplate;
@@ -425,8 +533,7 @@ export class SeriesItemComponent extends CollectionItemComponent {
         this.collectionService = collectionService;
     }
     /**
-     * Toggles the series visibility and updates the parent Chart
-     * without animated transitions.
+     * Toggles the series visibility and updates the parent Chart without animated transitions.
      */
     toggleVisibility() {
         this.options.visible = toggle(this.options.visible);

package/esm2022/chart/series.component.mjs

@@ -14,7 +14,7 @@ import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 import * as i3 from "../common/tooltip-template.service";
 /**
- * A collection of one or more series items. [See example](slug:series_chart_charts).
+ * Represents collection of one or more series items ([see example](slug:series_chart_charts)).
  *
  * @example
  * ```html
@@ -25,6 +25,9 @@ import * as i3 from "../common/tooltip-template.service";
  *   </kendo-chart-series>
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesItemComponent}.
  */
 export class SeriesComponent extends CollectionComponent {
     configurationService;