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

package/esm2022/chart/y-axis-item.component.mjs

@@ -10,60 +10,136 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 /**
- * The configuration component for the Y axis
+ * Represents the Kendo UI for Angular Chart Y Axis Item component
  * ([see example]({% slug api_charts_yaxiscomponent %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-y-axis>
+ *   <kendo-chart-y-axis-item color="indigo" [line]="{ width: 2 }">
+ *   </kendo-chart-y-axis-item>
+ * </kendo-chart-y-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link YAxisCrosshairComponent}, {@link YAxisLabelsComponent}, {@link YAxisNotesComponent}, and {@link YAxisTitleComponent}.
  */
 export class YAxisItemComponent extends CollectionItemComponent {
     configurationService;
     collectionService;
+    /**
+     * Specifies the value or array of values at which the axis crosses with another axis.
+     */
     axisCrossingValue;
+    /**
+     * Specifies the background color of the axis.
+     */
     background;
+    /**
+     * Specifies the base time unit for the axis.
+     */
     baseUnit;
+    /**
+     * Specifies the categories for the axis.
+     */
     categories;
+    /**
+     * Specifies the color of the axis.
+     */
     color;
+    /**
+     * Specifies the configuration of the axis line.
+     */
     line;
+    /**
+     * Specifies the configuration of the major grid lines.
+     */
     majorGridLines;
+    /**
+     * Specifies the configuration of the major ticks.
+     */
     majorTicks;
+    /**
+     * Specifies the interval between major divisions.
+     */
     majorUnit;
+    /**
+     * Specifies the maximum value of the axis.
+     */
     max;
+    /**
+     * Specifies the minimum value of the axis.
+     */
     min;
+    /**
+     * Specifies the configuration of the minor grid lines.
+     */
     minorGridLines;
+    /**
+     * Specifies the configuration of the minor ticks.
+     */
     minorTicks;
+    /**
+     * Specifies the interval between minor divisions.
+     */
     minorUnit;
+    /**
+     * Specifies the unique name of the axis.
+     */
     name;
     /**
-     * If set to `true`, the Chart prevents the automatic axis range from snapping to zero.
-     * Setting it to `false` forces the automatic axis range to snap to zero.
+     * Determines whether the Chart prevents the automatic axis range from snapping to zero.
+     * Set to `false` to force the automatic axis range to snap to zero.
      * @default false
      */
     narrowRange;
+    /**
+     * Specifies the name of the pane that the axis renders in.
+     */
     pane;
+    /**
+     * Specifies the plot bands configuration.
+     */
     plotBands;
     /**
-     * If set to `true`, the value axis direction is reversed.
+     * Determines whether the value axis direction is reversed.
      * By default, the values increase from left to right and from bottom to top.
      * @default false
      */
     reverse;
     /**
-     * The axis type.
+     * Specifies the axis type.
      *
      * The options are `numeric` for a numeric axis, `date` for a specialized axis for displaying chronological data, and `log` for a logarithmic axis.
      *
-     * If the series Y value is of the `date` type, the Chart automatically switches to a date axis.
+     * When the series Y value is of the `date` type, the Chart automatically switches to a date axis.
      * To avoid this behavior, set the `type`.
      * @default 'numeric'
      */
     type;
     /**
-     * If set to `true`, the Chart displays the Y axis. By default, the Y axis is visible.
+     * Determines whether the Chart displays the Y axis. By default, the Y axis is visible.
      * @default true
      */
     visible;
     // These options are also available as child components
+    /**
+     * Specifies the configuration of the crosshair.
+     */
     crosshair;
+    /**
+     * Specifies the configuration of the labels.
+     */
     labels;
+    /**
+     * Specifies the configuration of the notes.
+     */
     notes;
+    /**
+     * Specifies the configuration of the title.
+     */
     title;
     constructor(configurationService, collectionService) {
         super(configurationService, collectionService);

package/esm2022/chart/y-axis.component.mjs

@@ -12,7 +12,7 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 /**
- * A collection of one or more Y-axis configuration components.
+ * Represents a collection of one or more Y-axis configuration components.
  *
  * @example
  * ```html
@@ -29,6 +29,9 @@ import * as i2 from "../common/collection.service";
  *     </kendo-chart-y-axis>
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link YAxisItemComponent}.
  */
 export class YAxisComponent extends CollectionComponent {
     configurationService;

package/esm2022/chart/zoomable.component.mjs

@@ -8,7 +8,8 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * Specifies if the Chart can be zoomed.
+ * Represents the Kendo UI for Angular Chart Zoomable component.
+ * Use this component to enable zooming functionality for Charts.
  * Zooming is not available for the `Donut`, `Pie`, `Funnel`, `Pyramid`, `Polar`, and `Radar` series.
  *
  * @example
@@ -21,7 +22,13 @@ import * as i1 from "../common/configuration.service";
  */
 export class ZoomableComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the mousewheel zoom configuration.
+     */
     mousewheel;
+    /**
+     * Specifies the selection zoom configuration.
+     */
     selection;
     constructor(configurationService) {
         super('zoomable', configurationService);

package/esm2022/chart-breadcrumb.component.mjs

@@ -9,22 +9,20 @@ import { Subscription } from 'rxjs';
 import { homeIcon } from '@progress/kendo-svg-icons';
 import * as i0 from "@angular/core";
 /**
- * Navigation Breadcrumb component for Drilldown Charts.
+ * Represents the Kendo UI Chart Breadcrumb component for Angular.
  *
  * Use this component to implement navigation for [Drilldown Charts](slug:drilldown_chart_charts).
  * Use the `chart` input to link the Breadcrumb to the Chart instance.
- *
  */
 export class ChartBreadcrumbComponent {
     /**
-     * The Chart instance to link to.
+     * Defines the Chart instance to link to.
      */
     chart;
     /**
-     * The definition of the breadcrumb root item.
+     * Defines the breadcrumb root item.
      *
-     * The default value is `{ icon: 'home', svgIcon: homeIcon, title: 'Home' }`.
-     * (homeIcon is imported from '@progress/kendo-svg-icons')
+     * @default "{ icon: 'home', svgIcon: homeIcon, title: 'Home' }"
      */
     rootItem = { icon: 'home', svgIcon: homeIcon, title: 'Home' };
     /**

package/esm2022/chart.component.mjs

@@ -40,42 +40,25 @@ import * as i3 from "@progress/kendo-angular-intl";
 import * as i4 from "@progress/kendo-angular-l10n";
 import * as i5 from "./events/instance-event.service";
 /**
- * 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 class ChartComponent {
     configurationService;
@@ -88,54 +71,113 @@ export class ChartComponent {
     changeDetector;
     renderer;
     /**
-     * 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;
+    /**
+     * Defines the rendering mode of the Chart.
+     * @default 'svg'
+     */
     renderAs;
+    /**
+     * Defines the default colors for the Chart series.
+     */
     seriesColors;
+    /**
+     * Defines the subtitle configuration of the Chart.
+     */
     subtitle;
+    /**
+     * Defines the title configuration of the Chart.
+     */
     title;
+    /**
+     * Defines whether to show the no-data template when the Chart has no data.
+     * @default true
+     */
     noData = true;
     /**
-     * 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;
+    /**
+     * Defines the zoom configuration of the Chart.
+     */
     zoomable;
+    /**
+     * Defines the default configuration for all axes.
+     */
     axisDefaults;
+    /**
+     * Defines the category axis configuration.
+     */
     categoryAxis;
+    /**
+     * Defines the Chart area configuration.
+     */
     chartArea;
+    /**
+     * Defines the Chart legend configuration.
+     */
     legend;
+    /**
+     * Defines the Chart panes configuration.
+     */
     panes;
+    /**
+     * Defines the default configuration for all panes.
+     */
     paneDefaults;
+    /**
+     * Defines the plot area configuration.
+     */
     plotArea;
+    /**
+     * Defines the Chart series configuration.
+     */
     series;
+    /**
+     * Defines the default configuration for all series.
+     */
     seriesDefaults;
+    /**
+     * Defines the Chart tooltip configuration.
+     */
     tooltip;
+    /**
+     * Defines the value axis configuration.
+     */
     valueAxis;
+    /**
+     * Defines the X axis configuration.
+     */
     xAxis;
+    /**
+     * Defines the Y axis configuration.
+     */
     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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * Fires when the user stops dragging the Chart.
+     * Fires when you stop dragging the Chart.
      */
     dragEnd = new EventEmitter();
     /**
-     * Fires when the user starts dragging the Chart.
+     * Fires when you start dragging the Chart.
      */
     dragStart = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
@@ -143,11 +185,11 @@ export class ChartComponent {
      */
     legendItemLeave = new EventEmitter();
     /**
-     * Fires when the user clicks a note.
+     * Fires when you click a note.
      */
     noteClick = new EventEmitter();
     /**
-     * Fires when the user hovers over a note.
+     * Fires when you hover over a note.
      */
     noteHover = new EventEmitter();
     /**
@@ -160,13 +202,13 @@ export class ChartComponent {
      */
     paneRender = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
@@ -180,36 +222,36 @@ export class ChartComponent {
      */
     render = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
@@ -221,20 +263,20 @@ export class ChartComponent {
      */
     seriesLeave = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * Fires when the user stops zooming the Chart.
+     * Fires when you stop zooming the Chart.
      */
     zoomEnd = new EventEmitter();
     /**
-     * Fires when the user uses the mousewheel to zoom the Chart.
+     * Fires when you use the mousewheel to zoom the Chart.
      */
     zoomStart = new EventEmitter();
     /**
      * Fires when a legend item is clicked before the selected series visibility is toggled.
-     * Can be prevented.
+     * You can prevent this event.
      */
     legendItemClick = new EventEmitter();
     /**
@@ -244,22 +286,22 @@ export class ChartComponent {
     /**
      * 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 = 10;
     /**
-     * The settings for the tooltip popup.
+     * Defines the settings for the tooltip popup.
      */
     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() {
         return this.drilldownState.length;
@@ -280,7 +322,7 @@ export class ChartComponent {
         this.drilldownLevelChange.emit(level);
     }
     /**
-     * The Drawing `Surface` of the Chart.
+     * Represents the Drawing `Surface` of the Chart.
      */
     surface;
     seriesCollectionComponent;
@@ -438,8 +480,8 @@ export class ChartComponent {
     /**
      * 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 = {}) {
         return exportImage(this.exportVisual(options), options);
@@ -448,7 +490,7 @@ export class ChartComponent {
      * 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 = {}) {
         return exportSVG(this.exportVisual(options), options);
@@ -457,7 +499,7 @@ export class ChartComponent {
      * 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 = {}) {
         return this.instance.exportVisual(options);
@@ -465,8 +507,8 @@ export class ChartComponent {
     /**
      * 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) {
         if (this.instance) {
@@ -476,8 +518,8 @@ export class ChartComponent {
     /**
      * 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) {
         if (this.instance) {
@@ -487,8 +529,8 @@ export class ChartComponent {
     /**
      * 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) {
         if (this.instance) {
@@ -497,7 +539,8 @@ export class ChartComponent {
     }
     /**
      * Returns the plot area of the Chart.
-     * @returns {ChartPlotArea} - The plot area of the Chart.
+     *
+     * @returns The plot area of the Chart.
      */
     getPlotArea() {
         if (this.instance) {
@@ -505,9 +548,10 @@ export class ChartComponent {
         }
     }
     /**
-     * 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/esm2022/chart.module.mjs

@@ -104,11 +104,12 @@ import * as i92 from "./chart/value-axis-item/notes.label.component";
 import * as i93 from "./chart/value-axis-item/title.component";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * 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';
@@ -116,7 +117,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/esm2022/charts.module.mjs

@@ -147,11 +147,11 @@ import * as i135 from "./sankey/labels.component";
 import * as i136 from "./sankey/data-binding/flat-binding.directive";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * 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
@@ -160,7 +160,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]