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

package/chart/y-axis-item.component.d.ts

@@ -9,59 +9,135 @@ import { AxisLine, AxisTicks, BaseUnit, GridLines, PlotBand } from '../common/pr
 import { YAxis, YAxisCrosshair, YAxisLabels, YAxisNotes, YAxisTitle } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * 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 declare class YAxisItemComponent extends CollectionItemComponent implements YAxis {
     protected configurationService: ConfigurationService;
     protected collectionService: CollectionService;
+    /**
+     * Specifies the value or array of values at which the axis crosses with another axis.
+     */
     axisCrossingValue: any | any[];
+    /**
+     * Specifies the background color of the axis.
+     */
     background: string;
+    /**
+     * Specifies the base time unit for the axis.
+     */
     baseUnit: BaseUnit;
+    /**
+     * Specifies the categories for the axis.
+     */
     categories?: any[];
+    /**
+     * Specifies the color of the axis.
+     */
     color: string;
+    /**
+     * Specifies the configuration of the axis line.
+     */
     line: AxisLine;
+    /**
+     * Specifies the configuration of the major grid lines.
+     */
     majorGridLines: GridLines;
+    /**
+     * Specifies the configuration of the major ticks.
+     */
     majorTicks: AxisTicks;
+    /**
+     * Specifies the interval between major divisions.
+     */
     majorUnit: number;
+    /**
+     * Specifies the maximum value of the axis.
+     */
     max: any;
+    /**
+     * Specifies the minimum value of the axis.
+     */
     min: any;
+    /**
+     * Specifies the configuration of the minor grid lines.
+     */
     minorGridLines: GridLines;
+    /**
+     * Specifies the configuration of the minor ticks.
+     */
     minorTicks: AxisTicks;
+    /**
+     * Specifies the interval between minor divisions.
+     */
     minorUnit: number;
+    /**
+     * Specifies the unique name of the axis.
+     */
     name: string;
     /**
-     * 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: boolean;
+    /**
+     * Specifies the name of the pane that the axis renders in.
+     */
     pane: string;
+    /**
+     * Specifies the plot bands configuration.
+     */
     plotBands: PlotBand[];
     /**
-     * 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: boolean;
     /**
-     * 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: 'numeric' | 'log' | 'date';
     /**
-     * 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: boolean;
+    /**
+     * Specifies the configuration of the crosshair.
+     */
     crosshair: YAxisCrosshair;
+    /**
+     * Specifies the configuration of the labels.
+     */
     labels: YAxisLabels;
+    /**
+     * Specifies the configuration of the notes.
+     */
     notes: YAxisNotes;
+    /**
+     * Specifies the configuration of the title.
+     */
     title: YAxisTitle;
     constructor(configurationService: ConfigurationService, collectionService: CollectionService);
     static ɵfac: i0.ɵɵFactoryDeclaration<YAxisItemComponent, never>;

package/chart/y-axis.component.d.ts

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

package/chart/zoomable.component.d.ts

@@ -8,7 +8,8 @@ import { DragAction, MousewheelZoom } from '../common/property-types';
 import { Zoomable } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * 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 i0 from "@angular/core";
  */
 export declare class ZoomableComponent extends SettingsComponent implements Zoomable {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the mousewheel zoom configuration.
+     */
     mousewheel: boolean | MousewheelZoom;
+    /**
+     * Specifies the selection zoom configuration.
+     */
     selection: boolean | DragAction;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<ZoomableComponent, never>;

package/chart-breadcrumb.component.d.ts

@@ -7,22 +7,20 @@ import { BreadCrumbComponent, BreadCrumbItem } from '@progress/kendo-angular-nav
 import { ChartComponent } from './index';
 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 declare class ChartBreadcrumbComponent implements OnInit, OnChanges, OnDestroy {
     /**
-     * The Chart instance to link to.
+     * Defines the Chart instance to link to.
      */
     chart: ChartComponent;
     /**
-     * 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: BreadCrumbItem;
     /**

package/chart-options.interface.d.ts

@@ -4,44 +4,44 @@
 *-------------------------------------------------------------------------------------------*/
 import { AxisDefaults, CategoryAxis, ChartArea, DragAction, Legend, Pane, PaneDefaults, PlotArea, Series, SeriesDefaults, Title, Tooltip, ValueAxis, XAxis, YAxis, Zoomable } from './common/property-types';
 /**
- * A configuration object that groups all root-level Chart options.
+ * Represents a configuration object that groups all root-level Chart options.
  */
 export interface ChartOptions {
     /**
-     * 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.
      */
     pannable?: boolean | DragAction;
     /**
-     * Sets the preferred rendering engine.
-     * If not supported by the browser, the Chart switches to the first available mode.
+     * Defines the preferred rendering engine.
+     * If the browser does not support it, the Chart switches to the first available mode.
      */
     renderAs?: 'svg' | 'canvas';
     /**
-     * The default colors for the Chart series.
+     * Defines the default colors for the Chart series.
      * When all colors are used, new colors are pulled from the start again.
      */
     seriesColors?: string[];
     /**
-     * The configuration options or the text of the Chart subtitle.
+     * Defines the configuration options or the text of the Chart subtitle.
      */
     subtitle?: string | Title;
     /**
-     * The configuration options or the text of the Chart title.
+     * Defines the configuration options or the text of the Chart title.
      */
     title?: string | Title;
     /**
-     * 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.
      */
     transitions?: boolean;
     /**
-     * Specifies if the Chart can be zoomed.
+     * Defines whether the Chart can be zoomed.
      * Zooming is not available for the `Donut`, `Pie`, `Funnel`, `Pyramid`, `Polar`, and `Radar` series.
      */
     zoomable?: boolean | Zoomable;
     /**
-     * The default options for all Chart axes. Accepts the options which are supported by
+     * Defines the default options for all Chart axes. Accepts the options which are supported by
      * [`categoryAxis`]({% slug api_charts_categoryaxisitemcomponent %}),
      * [`valueAxis`]({% slug api_charts_valueaxisitemcomponent %}),
      * [`xAxis`]({% slug api_charts_xaxisitemcomponent %}),
@@ -49,46 +49,46 @@ export interface ChartOptions {
      */
     axisDefaults?: AxisDefaults;
     /**
-     * The configuration options of the category axis.
+     * Defines the configuration options of the category axis.
      */
     categoryAxis?: CategoryAxis | CategoryAxis[];
     /**
-     * The configuration options of the Chart area.
+     * Defines the configuration options of the Chart area.
      * Represents the entire visible area of the Chart.
      */
     chartArea?: ChartArea;
     /**
-     * The configuration options of the Chart legend.
+     * Defines the configuration options of the Chart legend.
      */
     legend?: Legend;
     /**
      * If no series are defined, or all series are empty, a [No Data Overlay](slug:databinding_chart_charts#toc-no-data-overlay) will be displayed.
-     * The overlay will be automatically cleared if the series receive data.
+     * It clears automatically when the series receive data.
      *
      * To disable the No Data Overlay, set this option to `false`.
      */
     noData?: boolean;
     /**
-     * The configuration of the Chart panes.
+     * Defines the configuration of the Chart panes.
      * Panes are used to split the Chart into two or more parts. The panes are ordered from top to bottom.
      * To associate each axis with a pane, set its `pane` option to the name of the desired pane.
-     * Axis that do not have a specified pane are placed in the top (default) pane.
+     * Axes that do not have a specified pane are placed in the top (default) pane.
      * To move a series to the desired pane, associate them with an axis.
      */
     panes?: Pane[];
     /**
-     * The default options of all panes.
+     * Defines the default options of all panes.
      */
     paneDefaults?: PaneDefaults;
     /**
-     * The configuration options of the plot area.
-     * The plot area is the area which displays the series.
+     * Defines the configuration options of the plot area.
+     * Specifies the area which displays the series.
      */
     plotArea?: PlotArea;
     /**
-     * The configuration of the Chart series.
-     * The series type is determined by the value of the type field.
-     * If a type value is missing, the Chart renders the type that is
+     * Defines the configuration of the Chart series.
+     * Determines the series type by the value of the `type` field.
+     * If a `type` value is missing, the Chart renders the type that is
      * specified in [`seriesDefaults`]({% slug api_charts_seriesdefaultscomponent %}).
      * Some options accept functions as arguments. These arguments are evaluated for each point
      * which is supplied as a parameter. If no value is returned, the Chart uses the `theme` or
@@ -96,26 +96,26 @@ export interface ChartOptions {
      */
     series?: Series[];
     /**
-     * The default options of all series.
+     * Defines the default options of all series.
      */
     seriesDefaults?: SeriesDefaults;
     /**
-     * The configuration options of the Chart series tooltips.
-     * The tooltip of the Chart series is displayed when the
+     * Defines the configuration options of the Chart series tooltips.
+     * Displays the tooltip when the
      * [`tooltip.visible`]({% slug api_charts_tooltipcomponent %}#toc-visible) option is set to `true`.
      */
     tooltip?: Tooltip;
     /**
-     * The configuration options of the value axis.
+     * Defines the configuration options of the value axis.
      */
     valueAxis?: ValueAxis | ValueAxis[];
     /**
-     * The configuration options of the Scatter Chart X-axis.
+     * Defines the configuration options of the Scatter Chart X-axis.
      * Supports all [`valueAxis`]({% slug api_charts_valueaxisitemcomponent %}) options.
      */
     xAxis?: XAxis | XAxis[];
     /**
-     * The configuration options of the Scatter Chart Y-axis.
+     * Defines the configuration options of the Scatter Chart Y-axis.
      * Supports all [`valueAxis`]({% slug api_charts_valueaxisitemcomponent %}) options.
      */
     yAxis?: YAxis | YAxis[];