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

package/esm2022/events/axis-label-click-event.mjs

@@ -4,28 +4,28 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `axisLabelClick` event([see example](slug:events_chart)).
+ * Represents the arguments for the `axisLabelClick` event of the Chart component ([see example](slug:events_chart)).
  */
 export class AxisLabelClickEvent extends BaseEvent {
     /**
-     * The axis options to which the label belongs.
+     * Specifies the axis options to which the label belongs.
      */
     axis;
     /**
-     * The original data item that is used to generate the label.
-     * Available only for category axes which are populated from the `categoryField` of the series.
+     * Specifies the original data item that generates the label.
+     * Available only for category axes that use the `categoryField` of the series.
      */
     dataItem;
     /**
-     * The label sequential or category index.
+     * Specifies the sequential or category index of the label.
      */
     index;
     /**
-     * The label text.
+     * Specifies the text of the label.
      */
     text;
     /**
-     * The label value or category name.
+     * Specifies the value or category name of the label.
      */
     value;
     /**

package/esm2022/events/base-event.mjs

@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
  */
 export class BaseEvent {
     /**
-     * The `ChartComponent` that triggered the event.
+     * Specifies the `ChartComponent` that triggered the event.
      */
     sender;
     /**

package/esm2022/events/drag-end-event.mjs

@@ -4,16 +4,16 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `dragEnd` event ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
+ * Represents the arguments for the `dragEnd` event of the Chart component ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
  */
 export class DragEndEvent extends BaseEvent {
     /**
-     * A dictionary which contains the range (min and max values) of named axes.
-     * The axis name is used as a key.
+     * Specifies a dictionary that contains the range of named axes.
+     * Use the axis name as a key to access the minimum and maximum values.
      */
     axisRanges;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the drag action.
      */
     originalEvent;
     /**

package/esm2022/events/drag-event.mjs

@@ -4,16 +4,16 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `drag` event ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
+ * Represents the arguments for the `drag` event of the Chart component ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
  */
 export class DragEvent extends PreventableEvent {
     /**
-     * A dictionary which contains the range (min and max values) of named axes.
-     * The axis name is used as a key.
+     * Specifies a dictionary that contains the range of named axes.
+     * Use the axis name as a key to access the minimum and maximum values.
      */
     axisRanges;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the drag action.
      */
     originalEvent;
     /**

package/esm2022/events/drag-start-event.mjs

@@ -4,16 +4,16 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `dragStart` event ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
+ * Represents the arguments for the `dragStart` event of the Chart component ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
  */
 export class DragStartEvent extends PreventableEvent {
     /**
-     * A dictionary which contains the range (min and max values) of named axes.
-     * The axis name is used as a key.
+     * Specifies a dictionary that contains the range of named axes.
+     * Use the axis name as a key to access the minimum and maximum values.
      */
     axisRanges;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the drag action.
      */
     originalEvent;
     /**

package/esm2022/events/drilldown-event.mjs

@@ -4,21 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `drilldown` event.
- *
- * See [Drilldown Charts](slug:drilldown_chart_charts).
+ * Represents the arguments for the `drilldown` event of the Chart component ([see example](slug:drilldown_chart_charts)).
  */
 export class DrilldownEvent extends PreventableEvent {
     /**
-     * The drilldown field value.
+     * Specifies the drilldown field value.
      */
     value;
     /**
-     * The clicked series point.
+     * Specifies the clicked series point.
      */
     point;
     /**
-     * The clicked point series options.
+     * Specifies the clicked point series options.
      */
     series;
     /**

package/esm2022/events/legend-event.mjs

@@ -8,20 +8,20 @@ import { PreventableEvent } from './preventable-event';
  */
 export class LegendEvent extends PreventableEvent {
     /**
-     * An object which contains the series options.
+     * Specifies an object that contains the series options.
      */
     series;
     /**
-     * The index of the series in the parent Chart.
+     * Specifies the index of the series in the parent Chart.
      */
     seriesIndex;
     /**
-     * The point index in the series.
-     * Applicable only for the Pie, Donut, Funnel and Pyramid series.
+     * Specifies the point index in the series.
+     * Applicable only for Pie, Donut, Funnel, and Pyramid series.
      */
     pointIndex;
     /**
-     * The text of the legend item.
+     * Specifies the text of the legend item.
      */
     text;
     /**

package/esm2022/events/legend-item-click-event.mjs

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { LegendEvent } from './legend-event';
 /**
- * Arguments for the `legendItemClick` event([see example](slug:events_chart)).
+ * Represents the arguments for the `legendItemClick` event of the Chart component ([see example](slug:events_chart)).
  */
 export class LegendItemClickEvent extends LegendEvent {
     /**
-     * If called, the series visibility is not toggled as a result of clicking the legend item.
+     * Prevents the series visibility from being toggled when you click the legend item.
      */
     preventDefault() {
         super.preventDefault();

package/esm2022/events/legend-item-hover-event.mjs

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { LegendEvent } from './legend-event';
 /**
- * Arguments for the `legendItemHover` event([see example](slug:events_chart)).
+ * Represents the the arguments for the `legendItemHover` event of the Chart component ([see example](slug:events_chart)).
  */
 export class LegendItemHoverEvent extends LegendEvent {
     /**
-     * If called, the series highlight is not shown as a result of hovering over the legend item.
+     * Prevents the series highlight from being shown when you hover over the legend item.
      */
     preventDefault() {
         super.preventDefault();

package/esm2022/events/legend-item-leave-event.mjs

@@ -5,7 +5,7 @@
 import { LegendEvent } from './legend-event';
 /* eslint-disable no-empty */
 /**
- * Arguments for the `legendItemLeave` event.
+ * Represents the arguments for the `legendItemLeave` event of the Chart component.
  */
 export class LegendItemLeaveEvent extends LegendEvent {
     /**

package/esm2022/events/note-click-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { NoteEvent } from './note-event';
 /**
- * Arguments for the `noteClick` event.
+ * Represents the arguments for the `noteClick` event of the Chart component.
  */
 export class NoteClickEvent extends NoteEvent {
 }

package/esm2022/events/note-event.mjs

@@ -8,23 +8,24 @@ import { BaseEvent } from './base-event';
  */
 export class NoteEvent extends BaseEvent {
     /**
-     * The data point category. Available only for the Categorical charts (Bar, Line, Area, and similar).
+     * Specifies the data point category.
+     * Available only for Categorical charts such as Bar, Line, and Area.
      */
     category;
     /**
-     * The data item of the point note.
+     * Specifies the data item of the point note.
      */
     dataItem;
     /**
-     * An object containing the note series options.
+     * Specifies an object containing the note series options.
      */
     series;
     /**
-     * The note value.
+     * Specifies the note value.
      */
     value;
     /**
-     * The note visual element.
+     * Specifies the note visual element.
      */
     visual;
     /**

package/esm2022/events/note-hover-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { NoteEvent } from './note-event';
 /**
- * Arguments for the `noteHover` event.
+ * Represents the arguments for the `noteHover` event of the Chart component.
  */
 export class NoteHoverEvent extends NoteEvent {
 }

package/esm2022/events/note-leave-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { NoteEvent } from './note-event';
 /**
- * Arguments for the `noteLeave` event.
+ * Represents the arguments for the `noteLeave` event of the Chart component.
  */
 export class NoteLeaveEvent extends NoteEvent {
 }

package/esm2022/events/pane-render-event.mjs

@@ -4,19 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `paneRender` event.
+ * Represents the arguments for the `paneRender` event of the Chart component.
  */
 export class PaneRenderEvent extends BaseEvent {
     /**
-     * The chart pane.
+     * Specifies the chart pane.
      */
     pane;
     /**
-     * The pane index.
+     * Specifies the index of the pane.
      */
     index;
     /**
-     * The pane name.
+     * Specifies the name of the pane.
      */
     name;
     /**

package/esm2022/events/plot-area-click-event.mjs

@@ -4,27 +4,29 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `plotAreaClick` event([see example](slug:events_chart)).
+ * Represents the arguments for the `plotAreaClick` event of the Chart component ([see example](slug:events_chart)).
  */
 export class PlotAreaClickEvent extends BaseEvent {
     /**
-     * The data point category. Available only for the Categorical charts (Bar, Line, Area, and similar).
+     * Specifies the data point category.
+     * Available only for Categorical charts such as Bar, Line, and Area.
      */
     category;
     /**
-     * The original browser event that triggered the click action.
+     * Specifies the original browser event that triggered the click action.
      */
     originalEvent;
     /**
-     * The data point value. Available only for the Categorical charts (Bar, Line, Area, and similar).
+     * Specifies the data point value.
+     * Available only for Categorical charts such as Bar, Line, and Area.
      */
     value;
     /**
-     * The X axis value or array of values for multi-axis charts.
+     * Specifies the X axis value or array of values for multi-axis charts.
      */
     x;
     /**
-     * The Y axis value or array of values for multi-axis charts.
+     * Specifies the Y axis value or array of values for multi-axis charts.
      */
     y;
     /**

package/esm2022/events/plot-area-hover-event.mjs

@@ -4,27 +4,29 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `plotAreaHover` event([see example](slug:events_chart)).
+ * Represents the arguments for the `plotAreaHover` event of the Chart component ([see example](slug:events_chart)).
  */
 export class PlotAreaHoverEvent extends BaseEvent {
     /**
-     * The data point category. Available only for the Categorical charts (Bar, Line, Area, and similar).
+     * Specifies the data point category.
+     * Available only for Categorical charts such as Bar, Line, and Area.
      */
     category;
     /**
-     * The original browser event that triggered the click action.
+     * Specifies the original browser event that triggered the hover action.
      */
     originalEvent;
     /**
-     * The data point value. Available only for the Categorical charts (Bar, Line, Area, and similar).
+     * Specifies the data point value.
+     * Available only for Categorical charts such as Bar, Line, and Area.
      */
     value;
     /**
-     * The X axis value or array of values for multi-axis charts.
+     * Specifies the X axis value or array of values for multi-axis charts.
      */
     x;
     /**
-     * The Y axis value or array of values for multi-axis charts.
+     * Specifies the Y axis value or array of values for multi-axis charts.
      */
     y;
     /**

package/esm2022/events/plot-area-leave-event.mjs

@@ -3,5 +3,8 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
+/**
+ * Represents the arguments for the `plotAreaLeave` event of the Chart component.
+ */
 export class PlotAreaLeaveEvent extends BaseEvent {
 }

package/esm2022/events/preventable-event.mjs

@@ -12,15 +12,13 @@ export class PreventableEvent extends BaseEvent {
     prevented = false;
     /**
      * Prevents the default action for a specified event.
-     * In this way, the source component suppresses
-     * the built-in behavior that follows the event.
+     * The source component suppresses the built-in behavior that follows the event.
      */
     preventDefault() {
         this.prevented = true;
     }
     /**
-     * Returns `true` if the event was prevented
-     * by any of its subscribers.
+     * Returns `true` if the event was prevented by any of its subscribers.
      *
      * @returns `true` if the default action was prevented.
      * Otherwise, returns `false`.

package/esm2022/events/render-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `render` event([see example](slug:events_chart)).
+ * Represents the arguments for the `render` event of the Chart component ([see example](slug:events_chart)).
  */
 export class RenderEvent extends BaseEvent {
     /**

package/esm2022/events/select-end-event.mjs

@@ -4,19 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `selectEnd` event.
+ * Represents the arguments for the `selectEnd` event of the Chart component.
  */
 export class SelectEndEvent extends BaseEvent {
     /**
-     * The target axis options.
+     * Specifies the target axis options.
      */
     axis;
     /**
-     * The lower boundary of the selected range.
+     * Specifies the lower boundary of the selected range.
      */
     from;
     /**
-     * The upper boundary of the selected range.
+     * Specifies the upper boundary of the selected range.
      */
     to;
     /**

package/esm2022/events/select-event.mjs

@@ -4,19 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `select` event.
+ * Represents the arguments for the `select` event of the Chart component.
  */
 export class SelectEvent extends PreventableEvent {
     /**
-     * The target axis options.
+     * Specifies the target axis options.
      */
     axis;
     /**
-     * The lower boundary of the selected range.
+     * Specifies the lower boundary of the selected range.
      */
     from;
     /**
-     * The upper boundary of the selected range.
+     * Specifies the upper boundary of the selected range.
      */
     to;
     /**

package/esm2022/events/select-start-event.mjs

@@ -4,19 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from './preventable-event';
 /**
- * Arguments for the `selectStart` event.
+ * Represents the arguments for the `selectStart` event of the Chart component.
  */
 export class SelectStartEvent extends PreventableEvent {
     /**
-     * The target axis options.
+     * Specifies the target axis options.
      */
     axis;
     /**
-     * The lower boundary of the selected range.
+     * Specifies the lower boundary of the selected range.
      */
     from;
     /**
-     * The upper boundary of the selected range.
+     * Specifies the upper boundary of the selected range.
      */
     to;
     /**

package/esm2022/events/series-click-event.mjs

@@ -4,40 +4,41 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `seriesClick` event([see example](slug:events_chart)).
+ * Represents the arguments for the `seriesClick` event of the Chart component ([see example](slug:events_chart)).
  */
 export class SeriesClickEvent extends BaseEvent {
     /**
-     * The data point category.
+     * Specifies the data point category.
      */
     category;
     /**
-     * The original data item.
+     * Specifies the original data item.
      */
     dataItem;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the click action.
      */
     originalEvent;
     /**
-     * The point value represented as a percentage value.
-     * Available only for the Donut, Pie, and 100% stacked charts.
+     * Specifies the point value represented as a percentage value.
+     * Available only for Donut, Pie, and 100% stacked charts.
      */
     percentage;
     /**
-     * The clicked series point.
+     * Specifies the clicked series point.
      */
     point;
     /**
-     * The clicked point series options.
+     * Specifies the clicked point series options.
      */
     series;
     /**
-     * The cumulative point value on the stack. Available only for the stackable series.
+     * Specifies the cumulative point value on the stack.
+     * Available only for stackable series.
      */
     stackValue;
     /**
-     * The data point value.
+     * Specifies the data point value.
      */
     value;
     /**

package/esm2022/events/series-event.mjs

@@ -8,35 +8,37 @@ import { PreventableEvent } from './preventable-event';
  */
 export class SeriesEvent extends PreventableEvent {
     /**
-     * The data point category.
+     * Specifies the data point category.
      */
     category;
     /**
-     * The original data item.
+     * Specifies the original data item.
      */
     dataItem;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the series action.
      */
     originalEvent;
     /**
-     * The point value represented as a percentage value. Available only for the Donut, Pie, and 100% stacked charts.
+     * Specifies the point value represented as a percentage value.
+     * Available only for Donut, Pie, and 100% stacked charts.
      */
     percentage;
     /**
-     * The hovered series point.
+     * Specifies the hovered series point.
      */
     point;
     /**
-     * The hovered point series options.
+     * Specifies the hovered point series options.
      */
     series;
     /**
-     * The cumulative point value on the stack. Available only for the stackable series.
+     * Specifies the cumulative point value on the stack.
+     * Available only for stackable series.
      */
     stackValue;
     /**
-     * The data point value.
+     * Specifies the data point value.
      */
     value;
     /**

package/esm2022/events/series-hover-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { SeriesEvent } from './series-event';
 /**
- * Arguments for the `seriesHover` event([see example](slug:events_chart)).
+ * Represents the arguments for the `seriesHover` event of the Chart component ([see example](slug:events_chart)).
  */
 export class SeriesHoverEvent extends SeriesEvent {
 }

package/esm2022/events/series-leave-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { SeriesEvent } from './series-event';
 /**
- * Arguments for the `seriesLeave` event.
+ * Represents the arguments for the `seriesLeave` event of the Chart component.
  */
 export class SeriesLeaveEvent extends SeriesEvent {
 }

package/esm2022/events/series-over-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { SeriesEvent } from './series-event';
 /**
- * Arguments for the `seriesOver` event.
+ * Represents the arguments for the `seriesOver` event of the Chart component.
  */
 export class SeriesOverEvent extends SeriesEvent {
 }

package/esm2022/events/zoom-end-event.mjs

@@ -4,19 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { BaseEvent } from './base-event';
 /**
- * Arguments for the `zoomEnd` event ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
+ * Represents the arguments for the `zoomEnd` event of the Chart component ([see example](slug:panzoom_chart_charts#toc-pan-and-zoom-events)).
  */
 export class ZoomEndEvent extends BaseEvent {
     /**
-     * A dictionary which contains the range (min and max values) of named axes.
-     * The axis name is used as a key.
+     * Specifies a dictionary that contains the range of named axes.
+     * Use the axis name as a key to access the minimum and maximum values.
      *
-     * > The dictionary includes only the affected axis ranges.
+     * The dictionary includes only the affected axis ranges.
      * If an axis is locked or its range is not modified, the axis will not be listed.
      */
     axisRanges;
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the zoom action.
      */
     originalEvent;
     /**