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

package/chart.component.d.ts

@@ -54,42 +54,25 @@ import { SeriesComponent } from './chart/series.component';
 import { DrilldownEvent } from './events/drilldown-event';
 import * as i0 from "@angular/core";
 /**
- * The root Chart component.
+ * Represents the Kendo UI Chart component for Angular.
  *
  * @example
- * ```ts
- * import { Component } from '@angular/core';
- *
- * _@Component({
- *   selector: 'my-app',
- *   template: `
- *     <button kendoButton (click)="toggleLegend()">Toggle Legend</button>
- *     <button kendoButton (click)="toggleSeries()">Toggle Series</button>
- *     <kendo-chart>
- *       <kendo-chart-legend [visible]="legendVisible">
- *       </kendo-chart-legend>
- *       <kendo-chart-series>
- *         <kendo-chart-series-item *ngIf="seriesVisible" name="Series #1"
- *                                   type="line" [data]="[1, 2, 3]">
- *         </kendo-chart-series-item>
- *       </kendo-chart-series>
- *     </kendo-chart>
- *   `
- * })
- * class AppComponent {
- *   public legendVisible: boolean = true;
- *   public seriesVisible: boolean = true;
- *
- *   public toggleSeries(): void {
- *     this.seriesVisible = !this.seriesVisible;
- *   }
- *
- *   public toggleLegend(): void {
- *     this.legendVisible = !this.legendVisible;
- *   }
- * }
- *
+ * ```html
+ * <kendo-chart>
+ *   <kendo-chart-legend [visible]="legendVisible">
+ *   </kendo-chart-legend>
+ *   <kendo-chart-series>
+ *     <kendo-chart-series-item name="Series #1" type="line" [data]="[1, 2, 3]">
+ *     </kendo-chart-series-item>
+ *   </kendo-chart-series>
+ * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children are: {@link SeriesComponent}, {@link SeriesDefaultsComponent}, {@link PanesComponent}, {@link PaneDefaultsComponent},
+ * {@link CategoryAxisComponent}, {@link ValueAxisComponent}, {@link XAxisComponent}, {@link YAxisComponent}, {@link LegendComponent},
+ * {@link ChartAreaComponent}, {@link PlotAreaComponent}, {@link TooltipComponent}, {@link SubtitleComponent}, {@link TitleComponent},
+ * {@link ZoomableComponent}, {@link AxisDefaultsComponent}, {@link ChartCustomMessagesComponent} {@link PaneComponent}.
  */
 export declare class ChartComponent implements ChartOptions, OnChanges, OnInit, OnDestroy, AfterViewInit, AfterViewChecked {
     configurationService: ConfigurationService;
@@ -102,54 +85,113 @@ export declare class ChartComponent implements ChartOptions, OnChanges, OnInit,
     protected changeDetector: ChangeDetectorRef;
     protected renderer: Renderer2;
     /**
-     * Specifies if the Chart can be panned.
+     * Defines whether the Chart can be panned.
      * Panning is not available for the `Donut`, `Pie`, `Funnel`, `Pyramid`, `Polar`, and `Radar` series.
      * @default false
      */
     pannable: boolean | DragAction;
+    /**
+     * Defines the rendering mode of the Chart.
+     * @default 'svg'
+     */
     renderAs: 'svg' | 'canvas';
+    /**
+     * Defines the default colors for the Chart series.
+     */
     seriesColors: string[];
+    /**
+     * Defines the subtitle configuration of the Chart.
+     */
     subtitle: string | Subtitle;
+    /**
+     * Defines the title configuration of the Chart.
+     */
     title: string | Title;
+    /**
+     * Defines whether to show the no-data template when the Chart has no data.
+     * @default true
+     */
     noData: boolean;
     /**
-     * If set to `true`, the Chart plays animations when it displays the series.
+     * Defines whether the Chart plays animations when it displays the series.
      * By default, animations are enabled.
      * @default true
      */
     transitions: boolean;
+    /**
+     * Defines the zoom configuration of the Chart.
+     */
     zoomable: boolean | Zoomable;
+    /**
+     * Defines the default configuration for all axes.
+     */
     axisDefaults: AxisDefaults;
+    /**
+     * Defines the category axis configuration.
+     */
     categoryAxis: CategoryAxis | CategoryAxis[];
+    /**
+     * Defines the Chart area configuration.
+     */
     chartArea: ChartArea;
+    /**
+     * Defines the Chart legend configuration.
+     */
     legend: Legend;
+    /**
+     * Defines the Chart panes configuration.
+     */
     panes: Pane[];
+    /**
+     * Defines the default configuration for all panes.
+     */
     paneDefaults: PaneDefaults;
+    /**
+     * Defines the plot area configuration.
+     */
     plotArea: PlotArea;
+    /**
+     * Defines the Chart series configuration.
+     */
     series: Series[];
+    /**
+     * Defines the default configuration for all series.
+     */
     seriesDefaults: SeriesDefaults;
+    /**
+     * Defines the Chart tooltip configuration.
+     */
     tooltip: Tooltip;
+    /**
+     * Defines the value axis configuration.
+     */
     valueAxis: ValueAxis | ValueAxis[];
+    /**
+     * Defines the X axis configuration.
+     */
     xAxis: XAxis | XAxis[];
+    /**
+     * Defines the Y axis configuration.
+     */
     yAxis: YAxis | YAxis[];
     /**
-     * Fires when the user clicks an axis label ([see example](slug:events_chart)).
+     * Fires when you click an axis label ([see example](slug:events_chart)).
      */
     axisLabelClick: EventEmitter<AxisLabelClickEvent>;
     /**
-     * Fires as long as the user is dragging the Chart with the mouse or through swipe gestures.
+     * Fires as long as you drag the Chart with the mouse or through swipe gestures.
      */
     drag: EventEmitter<DragEvent>;
     /**
-     * Fires when the user stops dragging the Chart.
+     * Fires when you stop dragging the Chart.
      */
     dragEnd: EventEmitter<DragEndEvent>;
     /**
-     * Fires when the user starts dragging the Chart.
+     * Fires when you start dragging the Chart.
      */
     dragStart: EventEmitter<DragStartEvent>;
     /**
-     * Fires when the user hovers over a legend item ([see example](slug:events_chart)).
+     * Fires when you hover over a legend item ([see example](slug:events_chart)).
      */
     legendItemHover: EventEmitter<LegendItemHoverEvent>;
     /**
@@ -157,11 +199,11 @@ export declare class ChartComponent implements ChartOptions, OnChanges, OnInit,
      */
     legendItemLeave: EventEmitter<LegendItemLeaveEvent>;
     /**
-     * Fires when the user clicks a note.
+     * Fires when you click a note.
      */
     noteClick: EventEmitter<NoteClickEvent>;
     /**
-     * Fires when the user hovers over a note.
+     * Fires when you hover over a note.
      */
     noteHover: EventEmitter<NoteHoverEvent>;
     /**
@@ -174,13 +216,13 @@ export declare class ChartComponent implements ChartOptions, OnChanges, OnInit,
      */
     paneRender: EventEmitter<PaneRenderEvent>;
     /**
-     * Fires when the user clicks the plot area ([see example](slug:events_chart)).
+     * Fires when you click the plot area ([see example](slug:events_chart)).
      * The `click` event is triggered by the `tap` and `contextmenu` events.
      * To distinguish between the original events, inspect the `e.originalEvent.type` field.
      */
     plotAreaClick: EventEmitter<PlotAreaClickEvent>;
     /**
-     * Fires when the user hovers the plot area ([see example](slug:events_chart)).
+     * Fires when you hover the plot area ([see example](slug:events_chart)).
      */
     plotAreaHover: EventEmitter<PlotAreaHoverEvent>;
     /**
@@ -194,36 +236,36 @@ export declare class ChartComponent implements ChartOptions, OnChanges, OnInit,
      */
     render: EventEmitter<RenderEvent>;
     /**
-     * Fires when the user modifies the selection.
+     * Fires when you modify the selection.
      *
      * The range units include a generic axis category index (0-based) and a date axis represented by a date instance.
      */
     select: EventEmitter<SelectEvent>;
     /**
-     * Fires when the user completes the modification of the selection.
+     * Fires when you complete the modification of the selection.
      *
      * The range units include a generic axis category index (0-based) and a date axis represented by a date instance.
      */
     selectEnd: EventEmitter<SelectEndEvent>;
     /**
-     * Fires when the user starts modifying the axis selection.
+     * Fires when you start modifying the axis selection.
      *
      * The range units include a generic axis category index (0-based) and a date axis represented by a date instance.
      */
     selectStart: EventEmitter<SelectStartEvent>;
     /**
-     * Fires when the user clicks the Chart series.
+     * Fires when you click the Chart series.
      *
      * The `click` event will be triggered by the `tap` and `contextmenu` events ([see example](slug:events_chart)).
      * To distinguish between the original events, inspect the `e.originalEvent.type` field.
      */
     seriesClick: EventEmitter<SeriesClickEvent>;
     /**
-     * Fires when the user when the user wants to drill down on a specific point.
+     * Fires when you want to drill down on a specific point.
      */
     drilldown: EventEmitter<DrilldownEvent>;
     /**
-     * Fires when the user hovers the Chart series ([see example](slug:events_chart)).
+     * Fires when you hover the Chart series ([see example](slug:events_chart)).
      */
     seriesHover: EventEmitter<SeriesHoverEvent>;
     /**
@@ -235,20 +277,20 @@ export declare class ChartComponent implements ChartOptions, OnChanges, OnInit,
      */
     seriesLeave: EventEmitter<SeriesLeaveEvent>;
     /**
-     * Fires as long as the user is zooming the Chart by using the mousewheel operation.
+     * Fires as long as you zoom the Chart by using the mousewheel operation.
      */
     zoom: EventEmitter<ZoomEvent>;
     /**
-     * Fires when the user stops zooming the Chart.
+     * Fires when you stop zooming the Chart.
      */
     zoomEnd: EventEmitter<ZoomEndEvent>;
     /**
-     * Fires when the user uses the mousewheel to zoom the Chart.
+     * Fires when you use the mousewheel to zoom the Chart.
      */
     zoomStart: EventEmitter<ZoomStartEvent>;
     /**
      * Fires when a legend item is clicked before the selected series visibility is toggled.
-     * Can be prevented.
+     * You can prevent this event.
      */
     legendItemClick: EventEmitter<LegendItemClickEvent>;
     /**
@@ -258,27 +300,27 @@ export declare class ChartComponent implements ChartOptions, OnChanges, OnInit,
     /**
      * Limits the automatic resizing of the Chart. Sets the maximum number of times per second
      * that the component redraws its content when the size of its container changes.
-     * Defaults to `10`. To disable the automatic resizing, set it to `0`.
+     * To disable the automatic resizing, set it to `0`.
      *
      * @default 10
      */
     resizeRateLimit: number;
     /**
-     * The settings for the tooltip popup.
+     * Defines the settings for the tooltip popup.
      */
     popupSettings: PopupSettings;
     /**
      * Gets or sets the current drill-down level for [Drilldown Charts](slug:drilldown_chart_charts).
      *
      * To return to a previous level, set the value to a number less than the current level.
-     * To return to the root chart, set the value to 0.
+     * To return to the root chart, set the value to `0`.
      *
-     * Setting the value to a number greater than the current level will have no effect.
+     * Setting the value to a number greater than the current level has no effect.
      */
     get drilldownLevel(): number;
     set drilldownLevel(level: number);
     /**
-     * The Drawing `Surface` of the Chart.
+     * Represents the Drawing `Surface` of the Chart.
      */
     surface: Surface;
     seriesCollectionComponent: QueryList<SeriesComponent>;
@@ -339,54 +381,56 @@ export declare class ChartComponent implements ChartOptions, OnChanges, OnInit,
     /**
      * Exports the Chart as an image. The export operation is asynchronous and returns a promise.
      *
-     * @param {ImageExportOptions} options - The parameters for the exported image.
-     * @returns {Promise<string>} - A promise that will be resolved with a PNG image encoded as a Data URI.
+     * @param options - The parameters for the exported image.
+     * @returns A promise that resolves with a PNG image encoded as a Data URI.
      */
     exportImage(options?: ImageExportOptions): Promise<string>;
     /**
      * Exports the Chart as an SVG document. The export operation is asynchronous and returns a promise.
      *
      * @param options - The parameters for the exported file.
-     * @returns - A promise that will be resolved with an SVG document that is encoded as a Data URI.
+     * @returns A promise that resolves with an SVG document encoded as a Data URI.
      */
     exportSVG(options?: ChartSVGExportOptions): Promise<string>;
     /**
      * Exports the Chart as a Drawing `Scene`.
      *
      * @param options - The parameters for the export operation.
-     * @returns - The root Group of the scene.
+     * @returns The root `Group` of the scene.
      */
     exportVisual(options?: ChartVisualExportOptions | any): Group;
     /**
      * Returns the axis with the specified name.
      *
-     * @param {string} name - The axis name.
-     * @returns {ChartAxis} - The axis with a corresponding name.
+     * @param name - The axis name.
+     * @returns The axis with a corresponding name.
      */
     findAxisByName(name: string): ChartAxis;
     /**
      * Returns the pane at the specified index.
      *
-     * @param {number} index - The pane index.
-     * @returns {ChartPane} - The pane at the specified index.
+     * @param index - The pane index.
+     * @returns The pane at the specified index.
      */
     findPaneByIndex(index: number): ChartPane;
     /**
      * Returns the pane with the specified name.
      *
-     * @param {string} name - The name of the pane.
-     * @returns {ChartPane} - The pane with the provided name.
+     * @param name - The name of the pane.
+     * @returns The pane with the provided name.
      */
     findPaneByName(name: string): ChartPane;
     /**
      * Returns the plot area of the Chart.
-     * @returns {ChartPlotArea} - The plot area of the Chart.
+     *
+     * @returns The plot area of the Chart.
      */
     getPlotArea(): ChartPlotArea;
     /**
-     * Highlights the series points or the segments of a Pie, Donut, Funnel or Pyramid charts.
+     * Highlights the series points or the segments of a Pie, Donut, Funnel, or Pyramid Charts.
      *
      * See [Series Highlight]({% slug serieshighlight_chart_charts %}) for more details (with an [example](slug:serieshighlight_chart_charts#toc-toggling-the-highlight-with-code)).
+     *
      * @param show - A Boolean value that indicates whether the highlight is shown or hidden.
      * @param filter - A string that represents the series or category name, an object with the series and category name, or a function which will be called for each point. The function should return `true` for the points for which the highlight is toggled.
      */

package/chart.module.d.ts

@@ -97,11 +97,12 @@ import * as i91 from "./chart/value-axis-item/notes.icon.component";
 import * as i92 from "./chart/value-axis-item/notes.label.component";
 import * as i93 from "./chart/value-axis-item/title.component";
 /**
- * A [module](link:site.data.urls.angular['ngmoduleapi']) that includes the Chart component and directives.
+ * Represents the Kendo UI for Angular Chart module that includes the Chart component and directives.
  *
- * Imports the ChartModule into your application
+ * Import the `ChartModule` into your application
  * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity) or any other sub-module
- * that will use the Chart component.
+ * that uses the Chart component.
+ *
  * @example
  * ```ts
  * import { NgModule } from '@angular/core';
@@ -109,7 +110,7 @@ import * as i93 from "./chart/value-axis-item/title.component";
  * import { ChartModule } from '@progress/kendo-angular-charts';
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
+ * @NgModule({
  *     bootstrap:    [AppComponent],
  *     declarations: [AppComponent],
  *     imports:      [BrowserModule, ChartModule]

package/charts.module.d.ts

@@ -140,11 +140,11 @@ import * as i134 from "./sankey/nodes.component";
 import * as i135 from "./sankey/labels.component";
 import * as i136 from "./sankey/data-binding/flat-binding.directive";
 /**
- * A [module](link:site.data.urls.angular['ngmoduleapi']) that includes all Chart components and directives.
+ * Represents the Kendo UI for Angular Charts module that includes all Chart components and directives.
  *
- * Imports the ChartsModule into your application
+ * Import the `ChartsModule` into your application
  * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity) or any other sub-module
- * that will use the Charts components.
+ * that uses the Charts components.
  *
  * @example
  * ```ts
@@ -153,7 +153,7 @@ import * as i136 from "./sankey/data-binding/flat-binding.directive";
  * import { ChartsModule } from '@progress/kendo-angular-charts';
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
+ * @NgModule({
  *     bootstrap:    [AppComponent],
  *     declarations: [AppComponent],
  *     imports:      [BrowserModule, ChartsModule]

package/esm2022/chart/axis-defaults/crosshair.component.mjs

@@ -9,33 +9,42 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The crosshair configuration options ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
+ * Represents the available configuration options of the Chart crosshair ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
+ *
+ * @remarks
+ * Supported children components are: {@link AxisDefaultsCrosshairTooltipComponent}.
  */
 export class AxisDefaultsCrosshairComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the color of the crosshair.
+     */
     color;
     /**
-     * The dash type of the crosshair.
+     * Specifies the dash type of the crosshair.
      * @default 'solid'
      */
     dashType;
     /**
-     * The opacity of the crosshair. By default, the crosshair is opaque.
+     * Sets the opacity of the crosshair. By default, the crosshair is opaque.
      * @default 1
      */
     opacity;
     /**
-     * If set to `true`, the Chart displays the axis crosshair.
+     * Determines whether the Chart displays the axis crosshair.
      * By default, the axis crosshair is not visible.
      * @default false
      */
     visible;
     /**
-     * The width of the crosshair in pixels.
+     * Defines the width of the crosshair in pixels.
      * @default 1
      */
     width;
     // These options are also available as child components.
+    /**
+     * Specifies the tooltip configuration of the crosshair.
+     */
     tooltip;
     constructor(configurationService) {
         super('axisDefaults.crosshair', configurationService);

package/esm2022/chart/axis-defaults/crosshair.tooltip.component.mjs

@@ -9,33 +9,42 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The options of the crosshair tooltip ([see example]({% slug crosshairs_chart_charts %})).
+ * Represents the available options of the crosshair tooltip ([see example]({% slug crosshairs_chart_charts %})).
  * The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`]({% slug api_charts_axisdefaultscrosshairtooltipcomponent %}#toc-visible)
  * option is set to `true`.
  */
 export class AxisDefaultsCrosshairTooltipComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Sets the background color of the tooltip.
+     */
     background;
+    /**
+     * Specifies the border configuration of the tooltip.
+     */
     border;
+    /**
+     * Sets the text color of the tooltip.
+     */
     color;
     /**
-     * The tooltip font.
+     * Specifies the tooltip font.
      * @default '12px sans-serif'
      */
     font;
     /**
-     * The format for displaying the tooltip. Uses the [`format`](slug:api_intl_intlservice#toc-format) method of `IntlService`.
+     * Specifies the format for displaying the tooltip. Uses the [`format`](slug:api_intl_intlservice#toc-format) method of `IntlService`.
      * Contains one placeholder (`"{0}"`) which represents the category value.
      * @default '{0}'
      */
     format;
     /**
-     * The padding of the crosshair tooltip. A numeric value sets all paddings.
+     * Specifies the padding of the crosshair tooltip. A numeric value sets all paddings.
      * @default 0
      */
     padding;
     /**
-     * If set to `true`, the Chart displays the axis crosshair tooltip.
+     * Determines whether the Chart displays the axis crosshair tooltip.
      * By default, the axis crosshair tooltip is not visible.
      * @default false
      */

package/esm2022/chart/axis-defaults/labels.component.mjs

@@ -9,61 +9,67 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration of the axis labels ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
+ * Represents the configuration of the axis labels ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
  */
 export class AxisDefaultsLabelsComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies a `content` function that customizes the appearance of the labels.
+     */
     content;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      * @default '12px sans-serif'
      */
     font;
     /**
-     * The format for displaying the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * Specifies the format for displaying the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
      * Contains one placeholder (`"{0}"`) which represents the category value.
      * @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 0
      */
     margin;
     /**
-     * If set to `true`, the Chart mirrors the axis labels and ticks.
+     * Determines whether the Chart mirrors the axis labels and ticks.
      * If the labels are normally on the left side of the axis,
      * the mirroring of the axis renders them to the right.
      * @default false
      */
     mirror;
     /**
-     * The padding of the labels. A numeric value sets all paddings.
+     * Sets the padding of the labels. A numeric value sets all paddings.
      * @default 0
      */
     padding;
     /**
-     * The rotation angle of the labels. By default, the labels are not rotated.
-     * If the axis is horizontal, can be set to `"auto"`.
-     * In this case, the labels are rotated only if the slot size is not sufficient for the entire labels.
+     * Specifies the rotation angle of the labels. By default, the labels are not rotated.
+     *
+     * If the axis is horizontal, can be set to `"auto"`. In this case, the labels are rotated only if the slot size is not sufficient for the entire labels.
      * @default 0
      */
     rotation;
     /**
-     * The number of labels to skip. By default, no labels are skipped.
+     * Specifies the number of labels to skip. By default, no labels are skipped.
      * @default 0
      */
     skip;
     /**
-     * The label-rendering step&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     * Specifies the step for rendering the labels&mdash;renders every n<sup>th</sup> label. By default, each label is rendered.
      * @default 1
      */
     step;
     /**
-     * If set to `true`, the Chart displays the axis labels. By default, the axis labels are visible.
+     * Determines whether the Chart displays the axis labels. By default, the axis labels are visible.
      * @default true
      */
     visible;
+    /**
+     * Specifies a `visual` function that customizes the appearance of the labels.
+     */
     visual;
     constructor(configurationService) {
         super('axisDefaults.labels', configurationService);