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

package/stock-chart/navigator/category-axis/title.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { CategoryAxisTitleComponent } from '../../../chart/category-axis-item/title.component';
 import * as i0 from "@angular/core";
 /**
- * The title configuration of the navigator category axis.
+ * Represents the title configuration of the navigator category axis.
  */
 export declare class NavigatorCategoryAxisTitleComponent extends CategoryAxisTitleComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/category-axis.component.d.ts

@@ -7,11 +7,11 @@ import { ConfigurationService } from '../../common/configuration.service';
 import { CategoryAxisItemComponent } from '../../chart/category-axis-item.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration component of the navigator category axis.
+ * Represents the category axis of the navigator in a Kendo UI Stock Chart.
  *
  * @example
  *
- * ```html-no-run
+ * ```html
  * <kendo-stockchart>
  *   <kendo-chart-navigator>
  *     <kendo-chart-navigator-category-axis
@@ -21,6 +21,10 @@ import * as i0 from "@angular/core";
  *   </kendo-chart-navigator>
  * </kendo-stockchart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorCategoryAxisCrosshairComponent}, {@link NavigatorCategoryAxisLabelsComponent}, {@link NavigatorCategoryAxisNotesComponent},
+ * {@link NavigatorCategoryAxisSelectComponent}, and {@link NavigatorCategoryAxisTitleComponent} .
  */
 export declare class NavigatorCategoryAxisComponent extends CategoryAxisItemComponent {
     protected configurationService: ConfigurationService;

package/stock-chart/navigator/hint.component.d.ts

@@ -7,7 +7,7 @@ import { SettingsComponent } from '../../common/settings.component';
 import { NavigatorHint, NavigatorHintContentArgs } from '../option-types';
 import * as i0 from "@angular/core";
 /**
- * The default options of the navigator hint
+ * Represents the default options of the navigator hint
  * ([see example](slug:overview_stockchart_charts)).
  */
 export declare class NavigatorHintComponent extends SettingsComponent implements NavigatorHint {

package/stock-chart/navigator/pane/title.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { PanesTitleComponent } from '../../../chart/pane/title.component';
 import * as i0 from "@angular/core";
 /**
- * The title configuration of the StockChart navigator pane.
+ * Represents the title configuration of the navigator pane of the StockChart.
  */
 export declare class NavigatorPaneTitleComponent extends PanesTitleComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/pane.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../common/configuration.service';
 import { PaneComponent } from '../../chart/pane.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration component of the navigator pane
+ * Represents the navigator pane of the StockChart
  * ([see example](slug:overview_stockchart_charts)).
  */
 export declare class NavigatorPaneComponent extends PaneComponent {

package/stock-chart/navigator/series-item/error-bars.component.d.ts

@@ -6,7 +6,21 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesErrorBarsComponent } from '../../../chart/series-item/error-bars.component';
 import * as i0 from "@angular/core";
 /**
- * The error bars of the StockChart navigator series.
+ * Represents the error bars of the StockChart navigator series.
+ *
+ * @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-error-bars>
+ *     </kendo-chart-navigator-series-item-error-bars>
+ *    </kendo-chart-navigator-series-item>
+ *   </kendo-chart-navigator-series>
+ *  </kendo-chart-navigator>
+ * </kendo-stockchart>
+ * ```
  */
 export declare class NavigatorSeriesErrorBarsComponent extends SeriesErrorBarsComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/extremes.component.d.ts

@@ -6,7 +6,8 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesExtremesComponent } from '../../../chart/series-item/extremes.component';
 import * as i0 from "@angular/core";
 /**
- * The extremes configuration of the StockChart navigator series. Applies to extreme outliers.
+ * Represents the extremes configuration of the StockChart navigator series.
+ * Applies to extreme outliers.
  */
 export declare class NavigatorSeriesExtremesComponent extends SeriesExtremesComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/highlight.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesHighlightComponent } from '../../../chart/series-item/highlight.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration options of the StockChart series highlight.
+ * Represents the configuration options of the StockChart series highlight.
  */
 export declare class NavigatorSeriesHighlightComponent extends SeriesHighlightComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/labels.component.d.ts

@@ -6,7 +6,24 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesLabelsComponent } from '../../../chart/series-item/labels.component';
 import * as i0 from "@angular/core";
 /**
- * The label configuration of the StockChart navigator series.
+ * Represents the label configuration of the StockChart navigator series.
+ *
+ * @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-labels color="peachpuff">
+ *    </kendo-chart-navigator-series-item-labels>
+ *   </kendo-chart-navigator-series-item>
+ *   </kendo-chart-navigator-series>
+ *  </kendo-chart-navigator>
+ * </kendo-stockchart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorSeriesLabelsFromComponent} and {@link NavigatorSeriesLabelsToComponent}.
  */
 export declare class NavigatorSeriesLabelsComponent extends SeriesLabelsComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/labels.from.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesLabelsFromComponent } from '../../../chart/series-item/labels.from.component';
 import * as i0 from "@angular/core";
 /**
- * The `from` label configuration of the StockChart navigator series.
+ * Represents the `from` label configuration of the StockChart navigator series.
  */
 export declare class NavigatorSeriesLabelsFromComponent extends SeriesLabelsFromComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/labels.to.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesLabelsToComponent } from '../../../chart/series-item/labels.to.component';
 import * as i0 from "@angular/core";
 /**
- * The `to` label configuration of the StockChart navigator series.
+ * Represents the `to` label configuration of the StockChart navigator series.
  */
 export declare class NavigatorSeriesLabelsToComponent extends SeriesLabelsToComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/markers.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesMarkersComponent } from '../../../chart/series-item/markers.component';
 import * as i0 from "@angular/core";
 /**
- * The marker configuration of the StockChart navigator series.
+ * Represents the marker configuration of the StockChart navigator series.
  */
 export declare class NavigatorSeriesMarkersComponent extends SeriesMarkersComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/notes.component.d.ts

@@ -6,7 +6,24 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesNotesComponent } from '../../../chart/series-item/notes.component';
 import * as i0 from "@angular/core";
 /**
- * The notes configuration of the StockChart navigator series.
+ * Represents the notes configuration of the StockChart navigator series.
+ *
+ * @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-notes [visible]="true">
+ *     </kendo-chart-navigator-series-item-notes>
+ *   </kendo-chart-navigator-series-item>
+ *   </kendo-chart-navigator-series>
+ *  </kendo-chart-navigator>
+ * </kendo-stockchart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorSeriesNotesIconComponent} and {@link NavigatorSeriesNotesLabelComponent}.
  */
 export declare class NavigatorSeriesNotesComponent extends SeriesNotesComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/notes.icon.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesNotesIconComponent } from '../../../chart/series-item/notes.icon.component';
 import * as i0 from "@angular/core";
 /**
- * The icon of the notes.
+ * Represents the icon of the notes.
  */
 export declare class NavigatorSeriesNotesIconComponent extends SeriesNotesIconComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/notes.label.component.d.ts

@@ -6,7 +6,7 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesNotesLabelComponent } from '../../../chart/series-item/notes.label.component';
 import * as i0 from "@angular/core";
 /**
- * The label of the notes.
+ * Represents the label of the notes.
  */
 export declare class NavigatorSeriesNotesLabelComponent extends SeriesNotesLabelComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/outliers.component.d.ts

@@ -6,7 +6,8 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesOutliersComponent } from '../../../chart/series-item/outliers.component';
 import * as i0 from "@angular/core";
 /**
- * The outliers configuration of the StockChart navigator series. Applies to mild outliers.
+ * Represents the outliers configuration of the StockChart navigator series.
+ * Applies to mild outliers.
  */
 export declare class NavigatorSeriesOutliersComponent extends SeriesOutliersComponent {
     configurationService: ConfigurationService;

package/stock-chart/navigator/series-item/tooltip.component.d.ts

@@ -6,8 +6,8 @@ import { ConfigurationService } from '../../../common/configuration.service';
 import { SeriesTooltipComponent } from '../../../chart/series-item/tooltip.component';
 import * as i0 from "@angular/core";
 /**
- * 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 declare class NavigatorSeriesTooltipComponent extends SeriesTooltipComponent {
     configurationService: ConfigurationService;

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

@@ -7,8 +7,24 @@ import { ConfigurationService } from '../../common/configuration.service';
 import { SeriesItemComponent } from '../../chart/series-item.component';
 import * as i0 from "@angular/core";
 /**
- * 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 declare class NavigatorSeriesItemComponent extends SeriesItemComponent {
     protected configurationService: ConfigurationService;

package/stock-chart/navigator/series.component.d.ts

@@ -9,13 +9,13 @@ import { TooltipTemplateService } from "../../common/tooltip-template.service";
 import { SeriesComponent } from '../../chart/series.component';
 import * as i0 from "@angular/core";
 /**
- * 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>
@@ -40,8 +40,10 @@ import * as i0 from "@angular/core";
  *      }
  *   }
  * }
- *
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorSeriesItemComponent}.
  */
 export declare class NavigatorSeriesComponent extends SeriesComponent {
     protected configurationService: ConfigurationService;

package/stock-chart/navigator.component.d.ts

@@ -8,11 +8,10 @@ import { CategoryAxis, Pane, Series } from '../common/property-types';
 import { Navigator, NavigatorHint, NavigatorSelect } from './option-types';
 import * as i0 from "@angular/core";
 /**
- * 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: `
@@ -46,6 +45,9 @@ import * as i0 from "@angular/core";
  *    `
  * })
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link NavigatorSelectComponent}, {@link NavigatorSeriesComponent}, {@link NavigatorHintComponent}, {@link CategoryAxisComponent}, and {@link NavigatorPaneComponent}.
  */
 export declare class NavigatorComponent extends SettingsComponent implements Navigator {
     configurationService: ConfigurationService;

package/stock-chart/option-types/navigator/hint-content-args.interface.d.ts

@@ -3,15 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The navigator hint content function arguments.
+ * Represents the navigator hint content function arguments.
  */
 export interface NavigatorHintContentArgs {
     /**
-     * The lower boundary of the selected range.
+     * Specifies the lower boundary of the selected range.
      */
     from?: Date;
     /**
-     * The upper boundary of the selected range.
+     * Specifies the upper boundary of the selected range.
      */
     to?: Date;
 }

package/stock-chart/option-types/navigator/hint.interface.d.ts

@@ -4,21 +4,22 @@
 *-------------------------------------------------------------------------------------------*/
 import { NavigatorHintContentArgs } from './hint-content-args.interface';
 /**
- * The `navigator.hint` options.
+ * Represents the `navigator.hint` options.
  */
 export interface NavigatorHint {
     /**
-     * The function that returns the content of the hint.
+     * Specifies a function that returns the content of the hint.
      */
     content?: (e: NavigatorHintContentArgs) => string;
     /**
-     * The format of the hint.
+     * Specifies the format of the hint.
+     *
      * By default, the format is set to `"{0} - {1}"`, where `"{0}"` represents the start value of the selected range, and `"{1}"` represents the end value.
      * Example of usage: `[hint]="{format:'{0:dd.MM.yyyy} {1:yyyy.dd.MM}'}"`
      */
     format?: string;
     /**
-     * The visibility of the hint.
+     * Specifies the visibility of the hint.
      */
     visible?: boolean;
 }

package/stock-chart/option-types/navigator/select.interface.d.ts

@@ -4,20 +4,20 @@
 *-------------------------------------------------------------------------------------------*/
 import { MousewheelSelect } from '../../../common/property-types';
 /**
- * The `navigator.select` options.
+ * Represents the `navigator.select` options.
  */
 export interface NavigatorSelect {
     /**
-     * The lower boundary of the selected range.
+     * Specifies the lower boundary of the selected range.
      */
     from?: Date;
     /**
-     * The configuration of the mousewheel selection.
-     * If set to `false`, the mousewheel does not update the selection.
+     * Specifies the configuration of the mousewheel selection.
+     * When set to `false`, the mousewheel does not update the selection.
      */
     mousewheel?: boolean | MousewheelSelect;
     /**
-     * The upper boundary of the selected range.
+     * Specifies the upper boundary of the selected range.
      */
     to?: Date;
 }

package/stock-chart/option-types/navigator.interface.d.ts

@@ -6,27 +6,27 @@ import { CategoryAxis, Pane, Series } from '../../common/property-types';
 import { NavigatorHint } from './navigator/hint.interface';
 import { NavigatorSelect } from './navigator/select.interface';
 /**
- * The configuration options of the navigator.
+ * Represents the configuration options of the navigator.
  */
 export interface Navigator {
     /**
-     * The visibility of the navigator.
+     * Specifies the visibility of the navigator.
      */
     visible?: boolean;
     /**
-     * The configuration options of the category axis.
+     * Specifies the configuration options of the category axis.
      */
     categoryAxis?: CategoryAxis;
     /**
-     * The default options of the navigator hint.
+     * Specifies the default options of the navigator hint.
      */
     hint?: NavigatorHint;
     /**
-     * The navigator pane configuration.
+     * Specifies the navigator pane configuration.
      */
     pane?: Pane;
     /**
-     * The position of the navigator.
+     * Specifies the position of the navigator.
      * By default, the navigator is positioned at the bottom.
      */
     position?: 'top' | 'bottom';

package/stock-chart.component.d.ts

@@ -16,25 +16,42 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { DrilldownEvent } from './events/drilldown-event';
 import * as i0 from "@angular/core";
 /**
- * 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 declare class StockChartComponent extends ChartComponent {
     configurationService: ConfigurationService;
@@ -47,7 +64,9 @@ export declare class StockChartComponent extends ChartComponent {
     protected changeDetector: ChangeDetectorRef;
     protected renderer: Renderer2;
     /**
-     * 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: StockNavigator;
     /**
@@ -72,6 +91,8 @@ export declare class StockChartComponent extends ChartComponent {
     get drilldownLevel(): number;
     /**
      * Fires when the navigator range is changed.
+     *
+     * Use this event to respond to user interactions with the navigator.
      */
     navigatorFilter: EventEmitter<NavigatorFilterEvent>;
     /**
@@ -82,8 +103,10 @@ export declare class StockChartComponent extends ChartComponent {
     protected hostClasses: string[];
     constructor(configurationService: ConfigurationService, themeService: ThemeService, element: ElementRef, intl: IntlService, localizationService: LocalizationService, ngZone: NgZone, instanceEventService: StockInstanceEventService, changeDetector: ChangeDetectorRef, renderer: Renderer2);
     /**
-     * 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(): void;
     protected createInstance(element: any, observer: ChartInstanceObserver): void;

package/stock-chart.module.d.ts

@@ -126,20 +126,20 @@ import * as i120 from "./chart/zoomable.component";
 import * as i121 from "./chart/localization/custom-messages.component";
 import * as i122 from "./chart/localization/localized-messages.directive";
 /**
- * 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]