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

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

@@ -12,81 +12,157 @@ import { AutoBaseUnitSteps, AxisLine, AxisTicks, CategoryBaseUnit, GridLines, Pl
 import { CategoryAxis, CategoryAxisCrosshair, CategoryAxisLabels, CategoryAxisNotes, CategoryAxisSelect, CategoryAxisTitle } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The configuration component for a category axis ([see example]({% slug axes_chart_charts %})).
+ * Represents the configuration component for a category axis ([see example]({% slug axes_chart_charts %})).
+ *
+ * @remarks
+ * Supported children components are: {@link CategoryAxisCrosshairComponent}, {@link CategoryAxisLabelsComponent},
+ * {@link CategoryAxisNotesComponent}, {@link CategoryAxisSelectComponent}, {@link CategoryAxisTitleComponent}, and {@link CategoryAxisRangeLabelsComponent}.
  */
 export declare class CategoryAxisItemComponent extends CollectionItemComponent implements CategoryAxis, OnDestroy {
     protected configurationService: ConfigurationService;
     protected collectionService: CollectionService;
     private intl;
+    /**
+     * Specifies the automatic base unit steps configuration.
+     */
     autoBaseUnitSteps: AutoBaseUnitSteps;
+    /**
+     * Specifies the axis crossing value or values.
+     */
     axisCrossingValue: any | any[];
+    /**
+     * Specifies the background color of the axis.
+     */
     background: string;
+    /**
+     * Specifies the base unit of the axis.
+     */
     baseUnit: CategoryBaseUnit;
+    /**
+     * Specifies the base unit step of the axis.
+     */
     baseUnitStep: number | 'auto';
+    /**
+     * Specifies the categories for the axis.
+     */
     categories: any[];
+    /**
+     * Specifies the color of the axis.
+     */
     color: string;
+    /**
+     * Determines whether the axis is justified.
+     */
     justified: boolean;
+    /**
+     * Specifies the line configuration of the axis.
+     */
     line: AxisLine;
+    /**
+     * Specifies the major grid lines configuration of the axis.
+     */
     majorGridLines: GridLines;
+    /**
+     * Specifies the major ticks configuration of the axis.
+     */
     majorTicks: AxisTicks;
+    /**
+     * Specifies the maximum value of the axis.
+     */
     max: any;
     /**
-     * The maximum number of groups (categories) to display when
+     * Specifies the maximum number of groups (categories) to display when
      * [`categoryAxis.baseUnit`]({% slug api_charts_categoryaxis %}#toc-baseunit) is set to `"fit"` or
      * [`categoryAxis.baseUnitStep`]({% slug api_charts_categoryaxis %}#toc-baseunitstep) is set to `"auto"`.
      * @default 10
      */
     maxDateGroups: number;
+    /**
+     * Specifies the maximum divisions of the axis.
+     */
     maxDivisions: number;
+    /**
+     * Specifies the minimum value of the axis.
+     */
     min: any;
+    /**
+     * Specifies the minor grid lines configuration of the axis.
+     */
     minorGridLines: GridLines;
+    /**
+     * Specifies the minor ticks configuration of the axis.
+     */
     minorTicks: AxisTicks;
     /**
-     * The unique axis name. Used to associate a series with a category axis,
+     * Specifies the unique axis name. Use it to associate a series with a category axis,
      * which utilizes the [`series.categoryAxis`]({% slug api_charts_series %}#toc-categoryaxis) option.
      * @default 'primary'
      */
     name: string;
+    /**
+     * Specifies the pane of the axis.
+     */
     pane: string;
+    /**
+     * Specifies the plot bands configuration of the axis.
+     */
     plotBands: PlotBand[];
     /**
-     * If set to `true`, the category axis direction is reversed.
-     * By default, categories are listed from left to right and from bottom to top.
+     * Determines whether the category axis direction is reversed.
+     * Categories are listed from left to right and from bottom to top by default.
      * @default false
      */
     reverse: boolean;
     /**
-     * If set to `true`, the Chart rounds the first and last date to the nearest base unit.
+     * Determines whether the Chart rounds the first and last date to the nearest base unit.
      * @default true
      */
     roundToBaseUnit: boolean;
     /**
-     * The angle (degrees) of the first category on the axis.
-     * Angles increase clockwise with zero to the left. Negative values are acceptable.
+     * Specifies the angle (degrees) of the first category on the axis.
+     * Use positive values to increase the angle clockwise with zero to the left. Negative values are acceptable.
      * @default 90
      */
     startAngle: number;
     /**
-     * The category axis type.
-     * The supported values include `category` for a discrete category axis and `date` for a specialized axis for displaying chronological data.
+     * Specifies the category axis type.
+     * Use `category` for a discrete category axis and `date` for a specialized axis for displaying chronological data.
      * @default 'category'
      */
     type: 'category' | 'date';
     /**
-     * If set to `true`, the Chart displays the category axis. By default, the category axis is visible.
+     * Determines whether the Chart displays the category axis. The category axis is visible by default.
      * @default true
      */
     visible: boolean;
     /**
-     * The week start day when the `baseUnit` is set to `"weeks"`.
+     * Specifies the week start day when the `baseUnit` is set to `"weeks"`.
      * @default 'Sunday'
      */
     weekStartDay: WeekStartDay;
+    /**
+     * Specifies the crosshair configuration of the axis.
+     */
     crosshair: CategoryAxisCrosshair;
+    /**
+     * Specifies the labels configuration of the axis.
+     */
     labels: CategoryAxisLabels;
+    /**
+     * Specifies the notes configuration of the axis.
+     */
     notes: CategoryAxisNotes;
+    /**
+     * Specifies the selection configuration of the axis.
+     */
     select: CategoryAxisSelect;
+    /**
+     * Specifies the title configuration of the axis.
+     */
     title: CategoryAxisTitle;
+    /**
+     * Specifies the range labels configuration of the axis.
+     */
     rangeLabels: CategoryAxisRangeLabels;
     private intlSubscription;
     constructor(configurationService: ConfigurationService, collectionService: CollectionService, intl: IntlService, localeId: string);

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

@@ -8,13 +8,13 @@ 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 category axis items.
+ * Represents a collection of one or more category axis items.
  *
  * @example
  * ```ts
  * import { Component } from '@angular/core';
  *
- * _@Component({
+ *  @Component({
  *   selector: 'my-app',
  *   template: `
  *     <kendo-chart>
@@ -32,6 +32,9 @@ import * as i0 from "@angular/core";
  * class AppComponent {
  * }
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link CategoryAxisItemComponent}.
  */
 export declare class CategoryAxisComponent extends CollectionComponent {
     protected configurationService: ConfigurationService;

package/chart/chart-area.component.d.ts

@@ -8,35 +8,46 @@ import { ChartArea } from '../common/property-types';
 import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration options of the Chart area.
+ * Represents the Kendo UI for Angular Chart Area configuration.
  * Represents the entire visible area of the Chart
  * ([see example]({% slug chartarea_chart_charts %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-area background="#f0f0f0" [border]="{ color: '#ccc', width: 1 }">
+ *  </kendo-chart-area>
+ * </kendo-chart>
+ * ```
  */
 export declare class ChartAreaComponent extends SettingsComponent implements ChartArea {
     configurationService: ConfigurationService;
     /**
-     * The background color of the Chart area. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the background color of the Chart area. Accepts a valid CSS color string, including hex and rgb.
      * @default 'white'
      */
     background: string;
+    /**
+     * Specifies the border configuration of the Chart area.
+     */
     border: Border;
     /**
-     * The height of the Chart area.
+     * Specifies the height of the Chart area.
      * @default 400
      */
     height: number;
     /**
-     * The margin of the Chart area. A numeric value sets all margins.
+     * Specifies the margin of the Chart area. A numeric value sets all margins.
      * @default 5
      */
     margin: Margin | number;
     /**
-     * The background opacity of the Chart area. By default, the background is opaque.
+     * Specifies the background opacity of the Chart area. By default, the background is opaque.
      * @default 1
      */
     opacity: number;
     /**
-     * The width of the Chart area.
+     * Specifies the width of the Chart area.
      * @default 600
      */
     width: number;

package/chart/donut-center-template.directive.d.ts

@@ -5,9 +5,16 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * A directive which selects a [template](link:site.data.urls.angular['templatesyntax'])
+ * Represents a directive which selects a [template](link:site.data.urls.angular['templatesyntax'])
  * within the `<kendo-chart>` component for the
  * [Donut center template](slug:donut_seriestypes_charts#toc-using-the-center-template).
+ *
+ * @example
+ * <kendo-chart>
+ *   <ng-template kendoChartDonutCenterTemplate>
+ *     <span>Center Content</span>
+ *   </ng-template>
+ * </kendo-chart>
  */
 export declare class DonutCenterTemplateDirective {
     templateRef: TemplateRef<any>;

package/chart/legend/inactive-items.component.d.ts

@@ -8,11 +8,11 @@ import { LegendInactiveItems } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the inactive Chart legend items.
+ * Represents the Kendo UI for Angular Chart Legend Inactive Items configuration.
  *
  * @example
  *
- * ```html-no-run
+ * ```html
  * <kendo-chart>
  *   <kendo-chart-legend>
  *      <kendo-chart-legend-inactive-items [labels]="{color: 'pink'}"></kendo-chart-legend-inactive-items>
@@ -22,6 +22,9 @@ import * as i0 from "@angular/core";
  */
 export declare class LegendInactiveItemsComponent extends SettingsComponent implements LegendInactiveItems {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the labels configuration for inactive legend items.
+     */
     labels: LegendLabels;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<LegendInactiveItemsComponent, never>;

package/chart/legend/item.component.d.ts

@@ -10,11 +10,11 @@ import { SettingsComponent } from '../../common/settings.component';
 import { LegendItemArea, LegendItemHighlight, LegendItemLine, LegendItemMarkers, LegendItemType } from '../../option-types/legend/item.interface';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the Chart legend item.
+ * Represents the Kendo UI for Angular Chart Legend Item configuration.
  *
  * @example
  *
- * ```html-no-run
+ * ```html
  * <kendo-chart>
  *   <kendo-chart-legend>
  *      <kendo-chart-legend-item cursor="crosshair"></kendo-chart-legend-item>
@@ -24,12 +24,33 @@ import * as i0 from "@angular/core";
  */
 export declare class LegendItemComponent extends SettingsComponent implements LegendItem {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the cursor style for legend items.
+     */
     cursor: string;
+    /**
+     * Specifies the type of the legend item.
+     */
     type: LegendItemType;
+    /**
+     * Specifies the line configuration for the legend item.
+     */
     line: LegendItemLine;
+    /**
+     * Specifies the area configuration for the legend item.
+     */
     area: LegendItemArea;
+    /**
+     * Specifies the markers configuration for the legend item.
+     */
     markers: LegendItemMarkers;
+    /**
+     * Specifies the highlight configuration for the legend item.
+     */
     highlight: LegendItemHighlight;
+    /**
+     * Specifies a function that creates a custom visual for the legend item.
+     */
     visual: (e: LegendItemVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<LegendItemComponent, never>;

package/chart/legend.component.d.ts

@@ -7,76 +7,118 @@ import { SettingsComponent } from '../common/settings.component';
 import { Border, LegendLabels, Margin, Padding, LegendMarkers, LegendInactiveItems, LegendItem, Legend, LegendTitle, FocusHighlight } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The configuration options of the Chart legend
+ * Represents the Kendo UI for Angular Chart Legend configuration
  * ([see example]({% slug legend_chart_charts %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-legend position="top" [visible]="true">
+ *  </kendo-chart-legend>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link LegendInactiveItemsComponent} and {@link LegendItemComponent}.
  */
 export declare class LegendComponent extends SettingsComponent implements Legend {
     configurationService: ConfigurationService;
     /**
+     * Specifies the alignment of the legend.
      * The legend is horizontally aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"top"` or `"bottom"`.
      * The legend is vertically aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"left"` or `"right"`.
      * @default 'center'
      */
     align: 'start' | 'center' | 'end';
     /**
-     * The background color of the legend. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the background color of the legend. Accepts a valid CSS color string, including hex and rgb.
      * @default 'white'
      */
     background: string;
+    /**
+     * Specifies the border configuration of the legend.
+     */
     border: Border;
+    /**
+     * Specifies the height of the legend.
+     */
     height: number;
+    /**
+     * Specifies the labels configuration of the legend.
+     */
     labels: LegendLabels;
     /**
-     * The margin of the Chart legend. A numeric value sets all paddings.
+     * Specifies the margin of the Chart legend. A numeric value sets all paddings.
      * @default 5
      */
     margin: Margin | number;
     /**
-     * The X offset of the Chart legend. The offset is relative to the default position of the legend.
+     * Specifies the X offset of the Chart legend. The offset is relative to the default position of the legend.
      * For example, a value of `20` moves the legend 20 pixels to the right of its initial position.
      * Negative values move the legend to the left of its current position.
      * @default 0
      */
     offsetX: number;
     /**
-     * The Y offset of the chart legend. The offset is relative to the current position of the legend.
+     * Specifies the Y offset of the chart legend. The offset is relative to the current position of the legend.
      * For example, a value of `20` moves the legend 20 pixels down from its initial position.
      * Negative values move the legend upwards from its current position.
      * @default 0
      */
     offsetY: number;
     /**
-     * The orientation of the legend items.
+     * Specifies the orientation of the legend items.
      * @default 'vertical'
      */
     orientation: 'vertical' | 'horizontal';
     /**
-     * The padding of the Chart legend. A numeric value sets all paddings.
+     * Specifies the padding of the Chart legend. A numeric value sets all paddings.
      * @default 5
      */
     padding: Padding | number;
     /**
-     * The positions of the Chart legend.
+     * Specifies the positions of the Chart legend.
      * Setting the legend position to `custom` allows you to position the legend using the [`legend.offsetX`](slug:api_charts_legend#toc-offsetx) and [`legend.offsetY`](slug:api_charts_legend#toc-offsety) options.
      * @default 'right'
      */
     position: 'top' | 'bottom' | 'left' | 'right' | 'custom';
     /**
-     * If set to `true`, the legend items are reversed.
+     * Determines whether the legend items are reversed.
      * @default false
      */
     reverse: boolean;
     /**
-     * If set to `true`, the Chart displays the legend. By default, the Chart legend is visible.
+     * Determines whether the Chart displays the legend. By default, the Chart legend is visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies the width of the legend.
+     */
     width: number;
+    /**
+     * Specifies the markers configuration of the legend.
+     */
     markers: LegendMarkers;
+    /**
+     * Specifies the spacing between legend items.
+     */
     spacing: number;
+    /**
+     * Specifies the inactive items configuration of the legend.
+     */
     inactiveItems: LegendInactiveItems;
+    /**
+     * Specifies the item configuration of the legend.
+     */
     item: LegendItem;
+    /**
+     * Specifies the title configuration of the legend.
+     */
     title: LegendTitle;
+    /**
+     * Specifies the focus highlight configuration of the legend.
+     */
     focusHighlight?: FocusHighlight;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<LegendComponent, never>;

package/chart/localization/custom-messages.component.d.ts

@@ -6,11 +6,13 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { ChartMessages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages.
+ * Represents the custom messages component of the Kendo UI for Angular Chart.
+ * This component allows you to customize the messages displayed in the Chart, such as the "No data available" message.
+ *
  * @example
  * ```html
  * <kendo-chart [data]="data">
- *     <kendo-chart-messages noData='No data available'></kendo-chart-messages>
+ *     <kendo-chart-messages noData='No data'></kendo-chart-messages>
  * </kendo-chart>
  * ```
  */

package/chart/no-data-template.directive.d.ts

@@ -5,9 +5,16 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * A directive which selects a [template](link:site.data.urls.angular['templatesyntax'])
+ * Represents a directive which selects a [template](link:site.data.urls.angular['templatesyntax'])
  * within the `<kendo-chart>` component for the
  * [No Data Overlay](slug:databinding_chart_charts#toc-no-data-overlay).
+ *
+ * @example
+ * <kendo-chart>
+ *   <ng-template kendoChartNoDataTemplate>
+ *     <span>No data available</span>
+ *   </ng-template>
+ * </kendo-chart>
  */
 export declare class NoDataTemplateDirective {
     templateRef: TemplateRef<any>;

package/chart/pane/title.component.d.ts

@@ -9,36 +9,49 @@ import { Border, Margin } from '../../common/property-types';
 import { PanesTitle } from '../../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the Chart pane title.
+ * Represents the title configuration for the Chart panes.
  */
 export declare class PanesTitleComponent extends SettingsComponent implements PanesTitle {
     configurationService: ConfigurationService;
+    /**
+     * Sets the background color of the title.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the title.
+     */
     border: Border;
+    /**
+     * Sets the text color of the title.
+     */
     color: string;
     /**
-     * The font style of the title.
+     * Defines the font style of the title.
      * @default '700 18px sans-serif'
      */
     font: string;
     /**
-     * The margin of the title. A numeric value sets all margins.
+     * Specifies the margin of the title. A numeric value sets all margins.
      * @default 5
      */
     margin: Margin | number;
     /**
-     * The position of the title.
-     *
-     * The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
+     * Specifies the position of the title.
      * @default 'center'
      */
     position: 'left' | 'right' | 'center';
+    /**
+     * Sets the text content of the title.
+     */
     text: string;
     /**
-     * If set to `true`, the Chart displays the pane title.
+     * Determines whether the Chart displays the pane title.
      * @default true
      */
     visible: boolean;
+    /**
+     * Provides a function that creates a custom visual for the title.
+     */
     visual: (e: any) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<PanesTitleComponent, never>;

package/chart/pane-defaults/title.component.d.ts

@@ -8,35 +8,47 @@ import { SettingsComponent } from '../../common/settings.component';
 import { Border, Margin, PaneDefaultsTitle } from '../../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the pane default title.
+ * Represents the default title configuration of all Chart panes.
  */
 export declare class PaneDefaultsTitleComponent extends SettingsComponent implements PaneDefaultsTitle {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the title.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the title.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the title.
+     */
     color: string;
     /**
-     * The font style of the title.
+     * Specifies the font style of the title.
      * @default '16px sans-serif'
      */
     font: string;
     /**
-     * The margin of the title. A numeric value sets all margins.
+     * Specifies the margin of the title. A numeric value sets all margins.
      * @default 5
      */
     margin: Margin | number;
     /**
-     * The position of the title.
+     * Specifies the position of the title.
      *
      * The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
      * @default 'center'
      */
     position: 'left' | 'right' | 'center';
     /**
-     * If set to `true`, the Chart displays the pane title.
+     * Determines whether the Chart displays the pane title.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies a function that creates a custom visual for the title.
+     */
     visual: (e: any) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<PaneDefaultsTitleComponent, never>;

package/chart/pane-defaults.component.d.ts

@@ -7,25 +7,52 @@ import { SettingsComponent } from '../common/settings.component';
 import { Border, Margin, Padding, PaneDefaults, PaneDefaultsTitle } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The default options for all chart panes,
+ * Represents the default options for all Chart panes
  * ([see example](slug:panes_chart_charts#toc-default-settings)).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-pane-defaults background="#f0f0f0" [border]="{ color: '#ccc', width: 1 }">
+ *   <kendo-chart-pane-defaults-title [visible]="true"></kendo-chart-pane-defaults-title>
+ *  </kendo-chart-pane-defaults>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link PaneDefaultsTitleComponent}.
  */
 export declare class PaneDefaultsComponent extends SettingsComponent implements PaneDefaults {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the pane.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the pane.
+     */
     border: Border;
+    /**
+     * Determines whether the pane clips its content.
+     */
     clip: boolean;
+    /**
+     * Specifies the height of the pane.
+     */
     height: number;
     /**
-     * The margin of the pane. A numeric value sets all margins.
+     * Specifies the margin of the pane. A numeric value sets all margins.
      * @default 0
      */
     margin: Margin | number;
     /**
-     * The padding of the pane. A numeric value sets all paddings.
+     * Specifies the padding of the pane. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
+    /**
+     * Specifies the title configuration of the pane.
+     */
     title: PaneDefaultsTitle;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<PaneDefaultsComponent, never>;