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

package/esm2022/stock-chart/navigator/series-item/tooltip.component.mjs

@@ -8,8 +8,8 @@ import { SeriesTooltipComponent } from '../../../chart/series-item/tooltip.compo
 import * as i0 from "@angular/core";
 import * as i1 from "../../../common/configuration.service";
 /**
- * The tooltip configuration of the StockChart navigator series.
- * The StockChart navigator series tooltip is displayed when the `navigator.series.tooltip.visible` option is set to `true`.
+ * Represents the tooltip configuration of the StockChart navigator series.
+ * Displays when you set the `navigator.series.tooltip.visible` option to `true`.
  */
 export class NavigatorSeriesTooltipComponent extends SeriesTooltipComponent {
     configurationService;

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

@@ -10,8 +10,24 @@ import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 import * as i2 from "../../common/collection.service";
 /**
- * The configuration component of a navigator series item
+ * Represents a series item in the StockChart navigator
  * ([see example]({% slug overview_stockchart_charts %})).
+ *
+ * @example
+ * ```html
+ * <kendo-stockchart>
+ *  <kendo-chart-navigator>
+ *   <kendo-chart-navigator-series>
+ *    <kendo-chart-navigator-series-item type="area" [data]="data" field="value" categoryField="date">
+ *    </kendo-chart-navigator-series-item>
+ *   </kendo-chart-navigator-series>
+ *  </kendo-chart-navigator>
+ * <kendo-stockchart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorSeriesHighlightComponent}, {@link NavigatorSeriesErrorBarsComponent}, {@link NavigatorSeriesExtremesComponent},
+ * {@link NavigatorSeriesLabelsComponent}, {@link NavigatorSeriesMarkersComponent}, {@link NavigatorSeriesNotesComponent}, and {@link NavigatorSeriesTooltipComponent}.
  */
 export class NavigatorSeriesItemComponent extends SeriesItemComponent {
     configurationService;

package/esm2022/stock-chart/navigator/series.component.mjs

@@ -13,13 +13,13 @@ import * as i1 from "../../common/configuration.service";
 import * as i2 from "../../common/collection.service";
 import * as i3 from "../../common/tooltip-template.service";
 /**
- * A collection of one or more navigator series items.
+ * Represents a collection of one or more navigator series items.
  *
  * @example
  * ```ts
  * import { Component } from '@angular/core';
  *
- * _@Component({
+ *  @Component({
  *   selector: 'my-app',
  *   template: `
  *     <kendo-stockchart>
@@ -44,8 +44,10 @@ import * as i3 from "../../common/tooltip-template.service";
  *      }
  *   }
  * }
- *
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorSeriesItemComponent}.
  */
 export class NavigatorSeriesComponent extends SeriesComponent {
     configurationService;

package/esm2022/stock-chart/navigator.component.mjs

@@ -9,11 +9,10 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the navigator
- * ([see runnable example](slug:overview_stockchart_charts)).
+ * Represents the Kendo UI StockChart Navigator component for Angular ([see runnable example](slug:overview_stockchart_charts)).
  *
  * @example
- * ```ts-no-run
+ * ```ts
  * _@Component({
  *     selector: 'my-app',
  *       template: `
@@ -47,6 +46,9 @@ import * as i1 from "../common/configuration.service";
  *    `
  * })
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorSelectComponent}, {@link NavigatorSeriesComponent}, {@link NavigatorHintComponent}, {@link CategoryAxisComponent}, and {@link NavigatorPaneComponent}.
  */
 export class NavigatorComponent extends SettingsComponent {
     configurationService;

package/esm2022/stock-chart.component.mjs

@@ -31,25 +31,42 @@ const NAVIGATOR_DEFAULTS = {
     partialRedraw: true
 };
 /**
- * The root StockChart component.
+ * Represents the Kendo UI for Angular StockChart component.
+ *
+ * The StockChart displays financial data with a navigator for date range selection.
+ * It combines a main chart with a smaller navigator chart for easy data exploration.
  *
  * @example
- * ```html
- * <kendo-stockchart>
- *     <kendo-chart-series>
- *         <kendo-chart-series-item type="line" [data]="data" field="value" categoryField="date">
- *         </kendo-chart-series-item>
- *     </kendo-chart-series>
- *     <kendo-chart-navigator>
- *         <kendo-chart-navigator-select to="2017/02/01">
- *         </kendo-chart-navigator-select>
- *         <kendo-chart-navigator-series>
- *             <kendo-chart-navigator-series-item type="area" [data]="data" field="value" categoryField="date">
- *             </kendo-chart-navigator-series-item>
- *         </kendo-chart-navigator-series>
- *     </kendo-chart-navigator>
- * </kendo-stockchart>
+ * ```ts
+ * import { Component } from '@angular/core';
+ *
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *       <kendo-stockchart>
+ *           <kendo-chart-series>
+ *               <kendo-chart-series-item type="line" [data]="data" field="value" categoryField="date">
+ *               </kendo-chart-series-item>
+ *           </kendo-chart-series>
+ *           <kendo-chart-navigator>
+ *               <kendo-chart-navigator-select to="2017/02/01">
+ *               </kendo-chart-navigator-select>
+ *               <kendo-chart-navigator-series>
+ *                   <kendo-chart-navigator-series-item type="area" [data]="data" field="value" categoryField="date">
+ *                   </kendo-chart-navigator-series-item>
+ *               </kendo-chart-navigator-series>
+ *           </kendo-chart-navigator>
+ *       </kendo-stockchart>
+ *   `,
+ * })
+ * export class AppComponent {
+ * }
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesComponent}, {@link NavigatorComponent}, {@link TitleComponent}, {@link SubtitleComponent}, {@link AxisDefaultsComponent},
+ * {@link ChartAreaComponent}, {@link CategoryAxisComponent}, {@link LegendComponent}, {@link PaneDefaultsComponent}, {@link PanesComponent}, {@link PlotAreaComponent},
+ * {@link SeriesDefaultsComponent}, {@link ValueAxisComponent}, {@link TooltipComponent}, {@link XAxisComponent}, and {@link YAxisComponent}.
  */
 export class StockChartComponent extends ChartComponent {
     configurationService;
@@ -62,7 +79,9 @@ export class StockChartComponent extends ChartComponent {
     changeDetector;
     renderer;
     /**
-     * The configuration options for the data navigator.
+     * Specifies the configuration options for the data navigator.
+     *
+     * The navigator provides a way to select and filter data ranges.
      */
     navigator;
     /**
@@ -89,6 +108,8 @@ export class StockChartComponent extends ChartComponent {
     }
     /**
      * Fires when the navigator range is changed.
+     *
+     * Use this event to respond to user interactions with the navigator.
      */
     navigatorFilter = new EventEmitter();
     /**
@@ -112,8 +133,10 @@ export class StockChartComponent extends ChartComponent {
         this.showLicenseWatermark = shouldShowValidationUI(isValid);
     }
     /**
-     * If called, the navigator pane is not redrawn the next time the StockChart options are updated.
-     * The method is useful if you need to update only the main series data for the selected period.
+     * Prevents the navigator pane from redrawing when the StockChart options are updated.
+     *
+     * Use this method when you need to update only the main series data for the selected period.
+     * Call this method before updating the Chart options to improve performance.
      */
     skipNavigatorRedraw() {
         this.redrawSlaves = true;

package/esm2022/stock-chart.module.mjs

@@ -133,20 +133,20 @@ import * as i121 from "./chart/localization/custom-messages.component";
 import * as i122 from "./chart/localization/localized-messages.directive";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * A [module](link:site.data.urls.angular['ngmoduleapi']) that includes the StockChart component and directives.
+ * Represents the Kendo UI for Angular StockChart module that includes the StockChart component and directives.
  *
- * Imports the StockChartModule into your application
+ * Import the `StockChartModule` into your application
  * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity) or any other sub-module
- * that will use the StockChart component.
+ * that uses the StockChart component.
  *
  * @example
- * ```ts-no-run
+ * ```ts
  * import { NgModule } from '@angular/core';
  * import { BrowserModule } from '@angular/platform-browser';
  * import { StockChartModule } from '@progress/kendo-angular-charts';
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
+ * @NgModule({
  *     bootstrap:    [AppComponent],
  *     declarations: [AppComponent],
  *     imports:      [BrowserModule, StockChartModule]

package/events/axis-label-click-event.d.ts

@@ -6,28 +6,28 @@ import { ChartComponent } from '../chart.component';
 import { BaseEvent } from './base-event';
 import { EventAxisOptions } from '../api-types/event-axis-options.interface';
 /**
- * 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 declare class AxisLabelClickEvent extends BaseEvent {
     /**
-     * The axis options to which the label belongs.
+     * Specifies the axis options to which the label belongs.
      */
     axis: EventAxisOptions;
     /**
-     * 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: any;
     /**
-     * The label sequential or category index.
+     * Specifies the sequential or category index of the label.
      */
     index: number;
     /**
-     * The label text.
+     * Specifies the text of the label.
      */
     text: string;
     /**
-     * The label value or category name.
+     * Specifies the value or category name of the label.
      */
     value: any;
     /**

package/events/base-event.d.ts

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

package/events/drag-end-event.d.ts

@@ -6,18 +6,18 @@ import { ChartComponent } from '../chart.component';
 import { BaseEvent } from './base-event';
 import { AxisRange } from '../api-types/axis-range.interface';
 /**
- * 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 declare 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: {
         [name: string]: AxisRange;
     };
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the drag action.
      */
     originalEvent: any;
     /**

package/events/drag-event.d.ts

@@ -6,18 +6,18 @@ import { ChartComponent } from '../chart.component';
 import { PreventableEvent } from './preventable-event';
 import { AxisRange } from '../api-types/axis-range.interface';
 /**
- * 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 declare 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: {
         [name: string]: AxisRange;
     };
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the drag action.
      */
     originalEvent: any;
     /**

package/events/drag-start-event.d.ts

@@ -6,18 +6,18 @@ import { ChartComponent } from '../chart.component';
 import { PreventableEvent } from './preventable-event';
 import { AxisRange } from '../api-types/axis-range.interface';
 /**
- * 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 declare 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: {
         [name: string]: AxisRange;
     };
     /**
-     * The original user event that triggered the drag action.
+     * Specifies the original user event that triggered the drag action.
      */
     originalEvent: any;
     /**

package/events/drilldown-event.d.ts

@@ -7,21 +7,19 @@ import { PreventableEvent } from './preventable-event';
 import { EventSeriesOptions } from '../api-types/event-series-options.interface';
 import { SeriesPoint } from '../api-types/series-point.interface';
 /**
- * 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 declare class DrilldownEvent extends PreventableEvent {
     /**
-     * The drilldown field value.
+     * Specifies the drilldown field value.
      */
     value: any;
     /**
-     * The clicked series point.
+     * Specifies the clicked series point.
      */
     point: SeriesPoint;
     /**
-     * The clicked point series options.
+     * Specifies the clicked point series options.
      */
     series: EventSeriesOptions;
     /**

package/events/legend-event.d.ts

@@ -10,20 +10,20 @@ import { EventSeriesOptions } from '../api-types/event-series-options.interface'
  */
 export declare class LegendEvent extends PreventableEvent {
     /**
-     * An object which contains the series options.
+     * Specifies an object that contains the series options.
      */
     series: EventSeriesOptions;
     /**
-     * The index of the series in the parent Chart.
+     * Specifies the index of the series in the parent Chart.
      */
     seriesIndex: number;
     /**
-     * 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: number;
     /**
-     * The text of the legend item.
+     * Specifies the text of the legend item.
      */
     text: string;
     /**

package/events/legend-item-click-event.d.ts

@@ -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 declare 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(): void;
 }

package/events/legend-item-hover-event.d.ts

@@ -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 declare 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(): void;
 }

package/events/legend-item-leave-event.d.ts

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

package/events/note-click-event.d.ts

@@ -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 declare class NoteClickEvent extends NoteEvent {
 }

package/events/note-event.d.ts

@@ -10,23 +10,24 @@ import { EventSeriesOptions } from '../api-types/event-series-options.interface'
  */
 export declare 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: any;
     /**
-     * The data item of the point note.
+     * Specifies the data item of the point note.
      */
     dataItem: any;
     /**
-     * An object containing the note series options.
+     * Specifies an object containing the note series options.
      */
     series: EventSeriesOptions;
     /**
-     * The note value.
+     * Specifies the note value.
      */
     value: any;
     /**
-     * The note visual element.
+     * Specifies the note visual element.
      */
     visual: any;
     /**

package/events/note-hover-event.d.ts

@@ -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 declare class NoteHoverEvent extends NoteEvent {
 }

package/events/note-leave-event.d.ts

@@ -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 declare class NoteLeaveEvent extends NoteEvent {
 }

package/events/pane-render-event.d.ts

@@ -6,19 +6,19 @@ import { ChartComponent } from '../chart.component';
 import { BaseEvent } from './base-event';
 import { ChartPane } from '../api-types/chart-pane.interface';
 /**
- * Arguments for the `paneRender` event.
+ * Represents the arguments for the `paneRender` event of the Chart component.
  */
 export declare class PaneRenderEvent extends BaseEvent {
     /**
-     * The chart pane.
+     * Specifies the chart pane.
      */
     pane: ChartPane;
     /**
-     * The pane index.
+     * Specifies the index of the pane.
      */
     index: number;
     /**
-     * The pane name.
+     * Specifies the name of the pane.
      */
     name: string;
     /**

package/events/plot-area-click-event.d.ts

@@ -5,27 +5,29 @@
 import { ChartComponent } from '../chart.component';
 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 declare 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: any;
     /**
-     * The original browser event that triggered the click action.
+     * Specifies the original browser event that triggered the click action.
      */
     originalEvent: any;
     /**
-     * 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: any;
     /**
-     * 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: any;
     /**
-     * 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: any;
     /**

package/events/plot-area-hover-event.d.ts

@@ -5,27 +5,29 @@
 import { ChartComponent } from '../chart.component';
 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 declare 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: any;
     /**
-     * The original browser event that triggered the click action.
+     * Specifies the original browser event that triggered the hover action.
      */
     originalEvent: any;
     /**
-     * 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: any;
     /**
-     * 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: any;
     /**
-     * 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: any;
     /**

package/events/plot-area-leave-event.d.ts

@@ -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 declare class PlotAreaLeaveEvent extends BaseEvent {
 }

package/events/preventable-event.d.ts

@@ -11,13 +11,11 @@ export declare abstract class PreventableEvent extends BaseEvent {
     private prevented;
     /**
      * 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(): void;
     /**
-     * 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/events/render-event.d.ts

@@ -5,7 +5,7 @@
 import { ChartComponent } from '../chart.component';
 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 declare class RenderEvent extends BaseEvent {
     /**