@progress/kendo-angular-charts 13.2.0-develop.5 → 13.2.0-develop.7

package/chart/series-item.component.d.ts

@@ -17,80 +17,367 @@ import * as i0 from "@angular/core";
 export declare class SeriesItemComponent extends CollectionItemComponent implements Series {
     protected configurationService: ConfigurationService;
     protected collectionService: CollectionService;
+    /**
+     * The aggregate function for the date series.
+     * The function is used 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.
+     *
+     * The supported values are:
+     * - `"avg"`—The average of all values for the date period.
+     * - `"count"`—The number of values for the date period.
+     * - `"max"`—The highest value for the date period.
+     * - `"min"`—The lowest value for the date period.
+     * - `"sum"`—The sum of all values for the date period. Defaults to `0` if no data points are defined.
+     * - `"sumOrNull"`—The sum of all values for the date period. Defaults to `null` if no data points are
+     * defined.
+     * - `"first"`—The first value.
+     * - function (values, series, dataItems, category)—A user-defined aggregate function. Returns a single
+     * value or a data item.
+     * - object (compound aggregate)—Applicable to the Candlestick, Box Plot, and OHLC series.
+     * Specifies the aggregate for each data item field..
+     *
+     * @default 'max'
+     */
     aggregate: any;
+    /**
+     * If set to `true`, the Chart automatically scales down to fit the content area.
+     * Applicable for the Pie and Donut series. ([See example]({% slug donut_seriestypes_charts %}#toc-displaying-labels))
+     * @default false
+     */
     autoFit: boolean;
+    /**
+     * The name of the value axis.
+     * The axis option is supported 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: string;
     border: Border;
     categoryAxis: string;
+    /**
+     * 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: string;
+    /**
+     * 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"`.
+     * @default 'close'
+     */
     closeField: string;
     color: any;
+    /**
+    * The data item field which contains the series color.
+    * The `colorField` option is supported 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: string;
     connectors: LabelConnectors;
+    /**
+     * 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"`.
+     * @default 'current'
+     */
     currentField: string;
+    /**
+     * 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"`.
+     * @default 'solid'
+     */
     dashType: DashType;
     data: any[];
     downColor: string;
+    /**
+     * 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"`.
+     * @default 'downColor'
+     */
     downColorField: string;
     drilldownField: string;
+    /**
+     * The `dynamicHeight` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`.
+     * When set to `false`, all segments become with the same height.
+     * Otherwise, the height of each segment is based on its value.
+     * @default true
+     */
     dynamicHeight: boolean;
+    /**
+     * 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
+     * `currentDataItem.value`/`nextDataItem.value`.
+     * The last element is always created like a rectangle since there is no following element.
+     * @default false
+     */
     dynamicSlope: boolean;
+    /**
+     * 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"`.
+     * @default 'errorHigh'
+     */
     errorHighField: string;
+    /**
+     * 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"`.
+     * @default 'errorLow'
+     */
     errorLowField: string;
+    /**
+     * 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"`.
+     * @default 'explode'
+     */
     explodeField: string;
+    /**
+     * The data item field which contains the series value.
+     * @default 'value'
+     */
     field: string;
+    /**
+     * The data item field which contains the series from value.
+     * @default 'min'
+     */
     fromField: string;
+    /**
+     * 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"`,
+     * `"radarColumn"`, or `"waterfall"`.
+     * @default 1.5
+     */
     gap: number;
+    /**
+     * 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'
+     */
     highField: string;
     holeSize: number;
     line: SeriesLine;
+    /**
+     * 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"`.
+     * @default 'low'
+     */
     lowField: string;
+    /**
+     * 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"`.
+     * @default 'lower'
+     */
     lowerField: string;
+    /**
+     * The margin around each donut series (ring). A numeric value sets all margins.
+     * @default 1
+     */
     margin: Margin | number;
+    /**
+     * The maximum size of the Chart bubble series marker.
+     * @default 100
+     */
     maxSize: number;
     mean: SeriesMean;
+    /**
+     * 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"`.
+     * @default 'mean'
+     */
     meanField: string;
     median: SeriesMedian;
+    /**
+     * 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"`.
+     * @default 'median'
+     */
     medianField: string;
+    /**
+     * The minimum size of the Chart bubble series marker.
+    * @default 5
+     */
     minSize: number;
     missingValues: 'gap' | 'interpolate' | 'zero';
     name: string;
+    /**
+     * Specifies the top-base/bottom-base ratio of the whole 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`.
+     * @default 0.3
+     */
     neckRatio: number;
     negativeColor: string;
     negativeValues: NegativeBubbleValues;
+    /**
+     * The data item field which contains the series note text.
+     * @default 'noteText'
+     */
     noteTextField: string;
+    /**
+     * The opacity of the series. By default, the series are opaque.
+     * @default 1
+     */
     opacity: number;
     openField: string;
+    /**
+     * 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"`.
+     * @default 'outliers'
+     */
     outliersField: string;
     overlay: Overlay;
     padding: number;
+    /**
+     * 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"`.
+     * @default 'q1'
+     */
     q1Field: string;
+    /**
+     * 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"`.
+     * @default 'q3'
+     */
     q3Field: string;
+    /**
+     * The space in pixels between the different segments of the Funnel Chart.
+     * The `segmentSpacing` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"funnel"`.
+     * @default 0
+     */
     segmentSpacing: number;
     size: number;
+    /**
+     * The data field which contains the bubble size value.
+     * @default 'size'
+     */
     sizeField: string;
+    /**
+     * 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
+     * `"radarColumn"`.
+     * @default 0.4
+     */
     spacing: number;
+    /**
+     * A Boolean value which indicates if 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"`,
+     * `"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: boolean | string | SeriesStack;
+    /**
+     * The start angle (in degrees) of the first Donut or Pie segment.
+     * Angles increase clockwise with zero to the left. Negative values are acceptable.
+     * @default 90
+     */
     startAngle: number;
+    /**
+     * The `style` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to
+     * `"line"`, `"scatterLine"`, `"radarLine"`, or `"polarLine"`.
+     * @default 'normal'
+     */
     style: LineStyle;
+    /**
+     * 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:
+     *
+     * `"runningTotal"`—Displays the sum of all items since the last `"runningTotal"` point.
+     * `"total"`—Displays the sum of all previous items.
+     * @default 'summary'
+     */
     summaryField: string;
     target: BulletTarget;
+    /**
+     * The data item field which contains the series to value.
+     * @default 'max'
+     */
     toField: string;
+    /**
+     * The type of the series.
+     * @default 'column'
+     */
     type: SeriesType;
+    /**
+     * 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"`.
+     * @default 'upper'
+     */
     upperField: string;
+    /**
+     * Sets the visible property of a Chart series.
+     * @default true
+     */
     visible: boolean;
+    /**
+     * A value which indicates whether to show the point category (for Funnel, Donut, and Pie series)
+     * or the series name (for other available series types) in the legend.
+     * @default true
+     */
     visibleInLegend: boolean;
     visibleInLegendField: string;
     visual: (e: SeriesVisualArgs) => drawing.Element;
     width: number;
     whiskers: SeriesWhiskers;
+    /**
+     * 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.
+     * For the Polar series, the [`xAxis`]({% slug api_charts_xaxis %}) range is expressed in degrees.
+     * @default 'primary'
+     */
     xAxis: string;
+    /**
+     * 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
+     * `"bubble"`.
+     * @default 'xErrorHigh'
+     */
     xErrorHighField: string;
+    /**
+     * 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.
+     * @default 'xErrorLow'
+     */
     xErrorLowField: string;
+    /**
+     * 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.
+     * @default 'x'
+     */
     xField: string;
+    /**
+     * The name of the Y axis to use.
+     * Available for the Bubble, Scatter, Scatter Line, and Polar series.
+     * @default 'primary'
+     */
     yAxis: string;
+    /**
+      * The data item field which 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: string;
+    /**
+     * The data item field which 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: string;
+    /**
+     * The data item field containing 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: string;
     zIndex: number;
     errorBars: SeriesErrorBars;

package/chart/series.component.d.ts

@@ -10,26 +10,16 @@ import { ConfigurationService } from '../common/configuration.service';
 import { TooltipTemplateService } from '../common/tooltip-template.service';
 import * as i0 from "@angular/core";
 /**
- * A collection of one or more series items.
+ * A collection of one or more series items. [See example](slug:series_chart_charts).
  *
  * @example
- * ```ts
- * import { Component } from '@angular/core';
- *
- * _@Component({
- *   selector: 'my-app',
- *   template: `
- *     <kendo-chart>
- *       <kendo-chart-series>
- *         <kendo-chart-series-item type="line" [data]="[1, 2, 3]">
- *         </kendo-chart-series-item>
- *       </kendo-chart-series>
- *     </kendo-chart>
- *   `
- * })
- * class AppComponent {
- * }
- *
+ * ```html
+ * <kendo-chart>
+ *   <kendo-chart-series>
+ *     <kendo-chart-series-item type="line" [data]="[1, 2, 3]">
+ *     </kendo-chart-series-item>
+ *   </kendo-chart-series>
+ * </kendo-chart>
  * ```
  */
 export declare class SeriesComponent extends CollectionComponent implements AfterContentChecked {

package/chart/subtitle.component.d.ts

@@ -12,76 +12,43 @@ import * as i0 from "@angular/core";
  * ([see example]({% slug title_chart_charts %})).
  *
  * @example
- * ```ts-preview
- * import { Component } from '@angular/core';
- *
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-chart [categoryAxis]="{ categories: categories }">
- *            <kendo-chart-title text="Gross domestic product growth"></kendo-chart-title>
- *            <kendo-chart-subtitle text="/GDP annual %/"></kendo-chart-subtitle>
- *            <kendo-chart-legend
- *              position="bottom"
- *              orientation="horizontal"
- *              align="end"
- *              background="rgba(255, 0, 0, 0.1)"
- *              [border]="borderOptions"
- *              [margin]="10"
- *              [padding]="10"
- *              [width]="150"
- *              [offsetX]="11"
- *              [offsetY]="-103"
- *              [reverse]="true"
- *              [visible]="isVisible"
- *              ></kendo-chart-legend>
- *            <kendo-chart-tooltip format="{0}%"></kendo-chart-tooltip>
- *            <kendo-chart-series>
- *                <kendo-chart-series-item *ngFor="let item of series"
- *                    type="line" style="smooth" [data]="item.data" [name]="item.name">
- *                </kendo-chart-series-item>
- *            </kendo-chart-series>
- *        </kendo-chart>
- *        <br /><br />
- *        <button kendoButton (click)="isVisible=!isVisible">Toggle Legend</button>
- *    `
- * })
- * export class AppComponent {
- *  public isVisible = true;
- *  public borderOptions = {
- *    color: "rgba(255, 0, 0, 0.8)",
- *    dashType: 'dash',
- *    width: 2
- *  };
- *
- * public series: any[] = [{
- *   name: "India",
- *   data: [3.907, 7.943, 7.848, 9.284, 9.263, 9.801, 3.890, 8.238, 9.552, 6.855]
- * }, {
- *   name: "Russian Federation",
- *   data: [4.743, 7.295, 7.175, 6.376, 8.153, 8.535, 5.247, -7.832, 4.3, 4.3]
- * }, {
- *   name: "Germany",
- *   data: [0.010, -0.375, 1.161, 0.684, 3.7, 3.269, 1.083, -5.127, 3.690, 2.995]
- * },{
- *   name: "World",
- *   data: [1.988, 2.733, 3.994, 3.464, 4.001, 3.939, 1.333, -2.245, 4.339, 2.727]
- * }];
- *  public categories: number[] = [2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011];
- * }
+ * ```html
+ * <kendo-chart [categoryAxis]="{ categories: categories }">
+ *     <kendo-chart-subtitle text="/GDP annual %/"></kendo-chart-subtitle>
+ * </kendo-chart>
  * ```
  */
 export declare class SubtitleComponent extends SettingsComponent implements Subtitle {
     configurationService: ConfigurationService;
     align: 'center' | 'left' | 'right';
+    /**
+     * The background color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
+     *
+     * @default 'white'
+     */
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font of the subtitle.
+     *
+     * @default '12px sans-serif'
+     */
     font: string;
     margin: Margin | number;
     padding: Padding | number;
+    /**
+     * The position of the subtitle.
+     *
+     * @default 'top'
+     */
     position: 'top' | 'bottom';
     text: string;
+    /**
+     * If set to `true`, the Chart displays the subtitle.
+     *
+     * @default true
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SubtitleComponent, never>;

package/chart/title.component.d.ts

@@ -12,75 +12,56 @@ import * as i0 from "@angular/core";
  * ([see example]({% slug title_chart_charts %})).
  *
  * @example
- * ```ts-preview
- * import { Component } from '@angular/core';
- *
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-chart [categoryAxis]="{ categories: categories }">
- *            <kendo-chart-title text="Gross domestic product growth /GDP annual %/"></kendo-chart-title>
- *            <kendo-chart-legend
- *              position="bottom"
- *              orientation="horizontal"
- *              align="end"
- *              background="rgba(255, 0, 0, 0.1)"
- *              [border]="borderOptions"
- *              [margin]="10"
- *              [padding]="10"
- *              [width]="150"
- *              [offsetX]="11"
- *              [offsetY]="-103"
- *              [reverse]="true"
- *              [visible]="isVisible"
- *              ></kendo-chart-legend>
- *            <kendo-chart-tooltip format="{0}%"></kendo-chart-tooltip>
- *            <kendo-chart-series>
- *                <kendo-chart-series-item *ngFor="let item of series"
- *                    type="line" style="smooth" [data]="item.data" [name]="item.name">
- *                </kendo-chart-series-item>
- *            </kendo-chart-series>
- *        </kendo-chart>
- *        <br /><br />
- *        <button kendoButton (click)="isVisible=!isVisible">Toggle Legend</button>
- *    `
- * })
- * export class AppComponent {
- *  public isVisible = true;
- *  public borderOptions = {
- *    color: "rgba(255, 0, 0, 0.8)",
- *    dashType: 'dash',
- *    width: 2
- *  };
- *
- * public series: any[] = [{
- *   name: "India",
- *   data: [3.907, 7.943, 7.848, 9.284, 9.263, 9.801, 3.890, 8.238, 9.552, 6.855]
- * }, {
- *   name: "Russian Federation",
- *   data: [4.743, 7.295, 7.175, 6.376, 8.153, 8.535, 5.247, -7.832, 4.3, 4.3]
- * }, {
- *   name: "Germany",
- *   data: [0.010, -0.375, 1.161, 0.684, 3.7, 3.269, 1.083, -5.127, 3.690, 2.995]
- * },{
- *   name: "World",
- *   data: [1.988, 2.733, 3.994, 3.464, 4.001, 3.939, 1.333, -2.245, 4.339, 2.727]
- * }];
- *  public categories: number[] = [2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011];
- * }
+ * ```html
+ * <kendo-chart [categoryAxis]="{ categories: categories }">
+ *     <kendo-chart-title text="Gross domestic product growth /GDP annual %/"></kendo-chart-title>
+ *     ...
+ * </kendo-chart>
  * ```
  */
 export declare class TitleComponent extends SettingsComponent implements Title {
     configurationService: ConfigurationService;
+    /**
+     * The alignment of the title.
+     * The alignment options for text include `center` for middle alignment, `left` for left alignment, and `right` for right alignment, allowing for flexible positioning of the title.
+     *
+     * @default 'center'
+     */
     align: 'center' | 'left' | 'right';
+    /**
+     * The background color of the title. Accepts a valid CSS color string, including HEX and RGB.
+     *
+     * @default 'white'
+     */
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font of the title.
+     *
+     * @default '16px sans-serif'
+     */
     font: string;
     margin: Margin | number;
+    /**
+     * The padding of the title. A numeric value sets all paddings.
+     *
+     * @default 5
+     */
     padding: Padding | number;
+    /**
+     * The position of the title.
+     * The positioning options for titles include `bottom` for positioning at the bottom and `top` for positioning at the top, providing flexibility in title placement.
+     *
+     * @default 'top'
+     */
     position: 'top' | 'bottom';
     text: string;
+    /**
+     * If set to `true`, the Chart displays the title.
+     *
+     * @default true
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<TitleComponent, never>;

package/chart/tooltip.component.d.ts

@@ -21,11 +21,27 @@ export declare class TooltipComponent extends SettingsComponent implements Toolt
     background: string;
     border: Border;
     color: string;
+    /**
+     * The font of the tooltip.
+     * @default '12px sans-serif'
+     */
     font: string;
     format: string;
+    /**
+     * The opacity of the tooltip.
+     * @default 1
+     */
     opacity: number;
     padding: Padding | number;
+    /**
+     * If set to `true`, the Chart displays a single tooltip for every category.
+     * @default false
+     */
     shared: boolean;
+    /**
+     * If set to `true`, the Chart displays the series tooltip.
+     * @default false
+     */
     visible: boolean;
     seriesTooltipTemplate: SeriesTooltipTemplateDirective;
     sharedTooltipTemplate: SharedTooltipTemplateDirective;

package/chart/value-axis-item/crosshair.component.d.ts

@@ -12,8 +12,23 @@ import * as i0 from "@angular/core";
 export declare class ValueAxisCrosshairComponent extends SettingsComponent implements ValueAxisCrosshair {
     configurationService: ConfigurationService;
     color: string;
+    /**
+     * The opacity of the crosshair.
+     *
+     * @default 1
+     */
     opacity: number;
+    /**
+     * If set to `true`, the Chart displays the value axis crosshair.
+     *
+     * @default false
+     */
     visible: boolean;
+    /**
+     * The width of the crosshair in pixels.
+     *
+     * @default 1
+     */
     width: number;
     tooltip: ValueAxisCrosshairTooltip;
     constructor(configurationService: ConfigurationService);