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

package/chart/pane.component.d.ts

@@ -9,7 +9,7 @@ import { Border, Margin, Padding } from '../common/property-types';
 import { Pane, PanesTitle } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The configuration component for a Chart pane.
+ * Represents the Kendo UI for Angular Chart Pane component.
  *
  * @example
  * ```html
@@ -23,25 +23,46 @@ import * as i0 from "@angular/core";
  *   </kendo-chart-panes>
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link PanesTitleComponent}.
  */
 export declare class PaneComponent extends CollectionItemComponent implements Pane {
     protected configurationService: ConfigurationService;
     protected collectionService: CollectionService;
+    /**
+     * Specifies the background color of the pane.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the pane.
+     */
     border: Border;
+    /**
+     * Determines whether to clip the content of the pane to its boundaries.
+     */
     clip: boolean;
+    /**
+     * Specifies the height of the pane in pixels.
+     */
     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;
+    /**
+     * Specifies the name of the pane.
+     */
     name: string;
     /**
-     * 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: string | PanesTitle;
     constructor(configurationService: ConfigurationService, collectionService: CollectionService);
     static ɵfac: i0.ɵɵFactoryDeclaration<PaneComponent, never>;

package/chart/panes.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 pane configuration components.
+ * Represents collection of one or more pane configuration components.
  *
  * @example
  * ```html
@@ -20,6 +20,9 @@ import * as i0 from "@angular/core";
  *   ...
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link PaneComponent}.
  */
 export declare class PanesComponent extends CollectionComponent {
     protected configurationService: ConfigurationService;

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

@@ -8,32 +8,35 @@ import { PlotArea } from '../common/property-types';
 import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration options of the plot area
+ * Represents the Kendo UI for Angular Chart Plot Area component
  * ([see example]({% slug plotarea_chart_charts %})).
  * The plot area is the area which displays the series.
  */
 export declare class PlotAreaComponent extends SettingsComponent implements PlotArea {
     configurationService: ConfigurationService;
     /**
-     * The background color of the Chart plot area.
+     * Specifies the background color of the Chart plot area.
      * Accepts a valid CSS color string, including HEX and RGB.
      * @default 'white'
      */
     background: string;
+    /**
+     * Specifies the border configuration of the plot area.
+     */
     border: Border;
     /**
-     * The margin of the plot area. A numeric value sets all margins.
+     * Specifies the margin of the plot area. A numeric value sets all margins.
      * @default 5
      */
     margin: Margin | number;
     /**
-     * The background opacity of the plot area. By default, the background is opaque.
+     * Specifies the background opacity of the plot area. By default, the background is opaque.
      * @default 1
      */
     opacity: number;
     /**
-     * The padding of the plot area. A numeric value sets all paddings.
-     * The default padding for the Pie, Donut, Radar, and Polar Charts is proportional of the Chart size.
+     * Specifies the padding of the plot area. A numeric value sets all paddings.
+     * Use proportional padding for the Pie, Donut, Radar, and Polar Charts based on the Chart size.
      * @default 5
      */
     padding: Padding | number;

package/chart/series-defaults/labels.component.d.ts

@@ -9,41 +9,75 @@ import { SeriesDefaultsLabels, SeriesDefaultsLabelsFrom, SeriesDefaultsLabelsTo
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the Chart series label.
+ * Represents the configuration of the Chart series labels.
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-series-defaults>
+ *   <kendo-chart-series-defaults-labels format="c">
+ *   </kendo-chart-series-defaults-labels>
+ *  </kendo-chart-series-defaults>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesDefaultsLabelsFromComponent} and {@link SeriesDefaultsLabelsToComponent}.
  */
 export declare class SeriesDefaultsLabelsComponent extends SettingsComponent implements SeriesDefaultsLabels {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the labels.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the labels.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the labels.
+     */
     color: string;
+    /**
+     * Specifies a function that returns the content of the labels.
+     */
     content: (e: SeriesLabelsContentArgs) => string;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      * @default '12px sans-serif'
      */
     font: string;
     /**
-     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * Specifies the format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
      * @default '{0}'
      */
     format: string;
     /**
-     * The margin of the labels. A numeric value sets all margins.
+     * Specifies the margin of the labels. A numeric value sets all margins.
      * @default 0
      */
     margin: Margin | number;
     /**
-     * The padding of the labels. A numeric value sets all paddings.
+     * Specifies the padding of the labels. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * If set to `true`, the Chart displays the series labels.
+     * Determines whether the Chart displays the series labels.
      * @default false
      */
     visible: boolean;
+    /**
+     * Specifies a function that creates a custom visual for the labels.
+     */
     visual: (e: SeriesLabelsVisualArgs) => drawing.Element;
+    /**
+     * Specifies the `from` labels configuration.
+     */
     from: SeriesDefaultsLabelsFrom;
+    /**
+     * Specifies the `to` labels configuration.
+     */
     to: SeriesDefaultsLabelsTo;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsLabelsComponent, never>;

package/chart/series-defaults/labels.from.component.d.ts

@@ -8,36 +8,48 @@ import { SeriesDefaultsLabelsFrom } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The `from` label configuration of the Chart series.
+ * Represents the `from` label configuration of the Chart series.
  */
 export declare class SeriesDefaultsLabelsFromComponent extends SettingsComponent implements SeriesDefaultsLabelsFrom {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the `from` labels.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the `from` labels.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the `from` labels.
+     */
     color: string;
+    /**
+     * Specifies a function that returns the content of the `from` labels.
+     */
     content: (e: SeriesLabelsContentArgs) => string;
     /**
-     * The font style of the from labels.
+     * Specifies the font style of the `from` labels.
      * @default '12px sans-serif'
      */
     font: string;
     /**
-     * The format of the `from` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) of `IntlService`.
+     * Specifies the format of the `from` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) of `IntlService`.
      * @default '{0}'
      */
     format: string;
     /**
-     * The margin of the `from` labels. A numeric value sets all margins.
+     * Specifies the margin of the `from` labels. A numeric value sets all margins.
      * @default 0
      */
     margin: Margin | number;
     /**
-     * The padding of the `from` labels. A numeric value sets all paddings.
+     * Specifies the padding of the `from` labels. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * If set to `true`, the Chart displays the series `from` labels.
+     * Determines whether the Chart displays the series `from` labels.
      * @default false
      */
     visible: boolean;

package/chart/series-defaults/labels.to.component.d.ts

@@ -8,36 +8,48 @@ import { SeriesDefaultsLabelsTo } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The `to` label configuration of the Chart series.
+ * Represents the `to` label configuration of the Chart series.
  */
 export declare class SeriesDefaultsLabelsToComponent extends SettingsComponent implements SeriesDefaultsLabelsTo {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the `to` labels.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the `to` labels.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the `to` labels.
+     */
     color: string;
+    /**
+     * Specifies a function that returns the content of the `to` labels.
+     */
     content: (e: SeriesLabelsContentArgs) => string;
     /**
-     * The font style of the `to` labels.
+     * Specifies the font style of the `to` labels.
      * @default '12px sans-serif"'
      */
     font: string;
     /**
-     * The format of the `to` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * Specifies the format of the `to` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
      * @default '{0}'
      */
     format: string;
     /**
-     * The margin of the `to` labels. A numeric value sets all margins.
+     * Specifies the margin of the `to` labels. A numeric value sets all margins.
      * @default 0
      */
     margin: Margin | number;
     /**
-     * The padding of the `to` labels. A numeric value sets all paddings.
+     * Specifies the padding of the `to` labels. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * If set to `true`, the Chart displays the `to` labels of the series.
+     * Determines whether the Chart displays the `to` labels of the series.
      * @default false
      */
     visible: boolean;

package/chart/series-defaults/notes.component.d.ts

@@ -9,13 +9,38 @@ import { SeriesDefaultsNotes, SeriesDefaultsNotesIcon, SeriesDefaultsNotesLabel
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the [`seriesDefaults`]({% slug api_charts_seriesdefaultscomponent %}) notes.
+ * Represents the configuration of the [`seriesDefaults`]({% slug api_charts_seriesdefaultscomponent %}) notes.
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ * <kendo-chart-series-defaults>
+ *   <kendo-chart-series-defaults-notes position="above">
+ *   </kendo-chart-series-defaults-notes>
+ *  </kendo-chart-series-defaults>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesDefaultsNotesIconComponent} and {@link SeriesDefaultsNotesLabelComponent}.
  */
 export declare class SeriesDefaultsNotesComponent extends SettingsComponent implements SeriesDefaultsNotes {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the line configuration for the notes.
+     */
     line: NoteLine;
+    /**
+     * Specifies a function that creates a custom visual for the notes.
+     */
     visual: (e: SeriesNoteVisualArgs) => drawing.Element;
+    /**
+     * Specifies the icon configuration for the notes.
+     */
     icon: SeriesDefaultsNotesIcon;
+    /**
+     * Specifies the label configuration for the notes.
+     */
     label: SeriesDefaultsNotesLabel;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsNotesComponent, never>;

package/chart/series-defaults/notes.icon.component.d.ts

@@ -8,20 +8,29 @@ import { SeriesDefaultsNotesIcon } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The icon of the notes.
+ * Represents the configuration of the Chart notes icon.
  */
 export declare class SeriesDefaultsNotesIconComponent extends SettingsComponent implements SeriesDefaultsNotesIcon {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the notes icon.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the notes icon.
+     */
     border: Border;
+    /**
+     * Specifies the size of the notes icon.
+     */
     size: number;
     /**
-     * The shape of the notes icon.
+     * Specifies the shape of the notes icon.
      * @default 'circle'
      */
     type: MarkerType;
     /**
-     * The visibility of the notes icon.
+     * Determines whether the notes icon is visible.
      * @default true
      */
     visible: boolean;

package/chart/series-defaults/notes.label.component.d.ts

@@ -8,37 +8,49 @@ import { Border, NoteLabelPosition, SeriesNoteContentArgs } from '../../common/p
 import { SeriesDefaultsNotesLabel } from '../../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The label of the notes.
+ * Represents the configuration of the Chart notes label.
  */
 export declare class SeriesDefaultsNotesLabelComponent extends SettingsComponent implements SeriesDefaultsNotesLabel {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the notes label.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the notes label.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the notes label.
+     */
     color: string;
+    /**
+     * Specifies a function that returns the content of the notes label.
+     */
     content: (e: SeriesNoteContentArgs) => string;
     /**
-     * The font style of the label.
+     * Specifies the font style of the label.
      * @default '12px sans-serif'
      */
     font: string;
     /**
-     * The format for displaying the notes label. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * Specifies the format for displaying the notes label. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
      * Contains one placeholder (`"{0}"`) which represents the axis value.
      * @default '{0}'
      */
     format: string;
     /**
-     * The position of the labels.
+     * Specifies the position of the labels.
      * @default 'inside'
      */
     position: NoteLabelPosition;
     /**
-     * The rotation angle of the label. By default, the label is not rotated.
+     * Specifies the rotation angle of the label. By default, the label is not rotated.
      * @default 0
      */
     rotation: number;
     /**
-     * If set to `true`, the Chart displays the [`seriesDefaults`]({% slug api_charts_seriesdefaults %}) notes label.
+     * Determines whether the Chart displays the [`seriesDefaults`]({% slug api_charts_seriesdefaults %}) notes label.
      * @default true
      */
     visible: boolean;

package/chart/series-defaults/tooltip.component.d.ts

@@ -8,26 +8,38 @@ import { SeriesDefaultsTooltip } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration options of the Chart series tooltip.
+ * Represents the configuration options of the Chart series tooltip.
  */
 export declare class SeriesDefaultsTooltipComponent extends SettingsComponent implements SeriesDefaultsTooltip {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the tooltip.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the tooltip.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the tooltip.
+     */
     color: string;
     /**
-     * The tooltip font.
+     * Specifies the tooltip font.
      * @default '12px sans serif'
      */
     font: string;
+    /**
+     * Specifies the format of the tooltip.
+     */
     format: string;
     /**
-     * The padding of the tooltip. A numeric value sets all paddings.
+     * Specifies the padding of the tooltip. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * If set to `true`, the Chart displays the series tooltip.
+     * Determines whether the Chart displays the series tooltip.
      * @default false
      */
     visible: boolean;

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

@@ -9,38 +9,79 @@ import { Border, FocusHighlight, Overlay, SeriesHighlight, SeriesStack, SeriesTy
 import { SeriesDefaultsLabels, SeriesDefaultsNotes, SeriesDefaultsTooltip, SeriesDefaults } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The default options for all series
+ * Represents the default options for all Chart series
  * ([see example]({% slug series_chart_charts %}#toc-default-series-configuration)).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-series-defaults type="line">
+ *   <kendo-chart-series-defaults-labels format="c"></kendo-chart-series-defaults-labels>
+ *   <kendo-chart-series-defaults-notes position="above"></kendo-chart-series-defaults-notes>
+ *   <kendo-chart-series-defaults-tooltip [visible]="true"></kendo-chart-series-defaults-tooltip>
+ *  </kendo-chart-series-defaults>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link SeriesDefaultsLabelsComponent}, {@link SeriesDefaultsNotesComponent}, and {@link SeriesDefaultsTooltipComponent}.
  */
 export declare class SeriesDefaultsComponent extends SettingsComponent implements SeriesDefaults {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the border configuration of the series.
+     */
     border: Border;
     /**
-     * The distance between category clusters.
+     * Specifies the distance between category clusters.
      * @default 1.5
      */
     gap: number;
+    /**
+     * Specifies the highlight configuration of the series.
+     */
     highlight: SeriesHighlight;
+    /**
+     * Specifies the overlay configuration of the series.
+     */
     overlay: Overlay;
     /**
-     * The space between the Chart series as a proportion of the series width.
-     * The `spacing` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
+     * Specifies the space between the Chart series as a proportion of the series width.
+     * Use this option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
      * and `"waterfall"`.
      * @default 0.4
      */
     spacing: number;
     /**
-     * A Boolean value which indicates if the series has to be stacked.
-     * The stack option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
+     * Determines whether the series has to be stacked.
+     * Use this option when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
      * `"verticalLine"`, `"verticalArea"`, `"radarLine"`, `"radarArea"`, and `"radarColumn"`.
      * @default false
      */
     stack: boolean | string | SeriesStack;
+    /**
+     * Specifies the type of the series.
+     */
     type: SeriesType;
+    /**
+     * Specifies a function that returns a visual element for the series.
+     */
     visual: (e: SeriesVisualArgs) => drawing.Element;
+    /**
+     * Specifies the labels configuration of the series.
+     */
     labels: SeriesDefaultsLabels;
+    /**
+     * Specifies the notes configuration of the series.
+     */
     notes: SeriesDefaultsNotes;
+    /**
+     * Specifies the tooltip configuration of the series.
+     */
     tooltip: SeriesDefaultsTooltip;
+    /**
+     * Specifies the focus highlight configuration of the series.
+     */
     focusHighlight?: FocusHighlight;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesDefaultsComponent, never>;

package/chart/series-drilldown-template.directive.d.ts

@@ -5,14 +5,14 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the series [template](link:site.data.urls.angular['templatesyntax'])
- * within the `<kendo-chart-series-item>` component for creating nested
+ * Represents the Kendo UI for Angular Chart Series Drilldown Template directive.
+ * Use this directive within the `<kendo-chart-series-item>` component to create nested
  * [Drilldown](slug:drilldown_chart_charts) series.
  *
- * When the user clicks on a data point with drilldown data,
- * the Chart will create a new series based on this template.
+ * When you click on a data point with drilldown data,
+ * the Chart creates a new series based on this template.
  *
- * The template context is passes through the following fields:
+ * The template context passes through the following fields:
  * - `drilldownValue`&mdash;The drilldown field value.
  * - `point`&mdash;The series point to drill down to.
  * - `series`&mdash;The series to drill down to.

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

@@ -9,21 +9,39 @@ import { SeriesErrorBars } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The error bars of the Chart series
+ * Represents the configuration of the Chart series error bars
  * ([see example]({% slug errorbars_chart_charts %})).
  */
 export declare class SeriesErrorBarsComponent extends SettingsComponent implements SeriesErrorBars {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the color of the error bars.
+     */
     color: string;
     /**
-    * If set to `false`, the caps of the error bars are not displayed. By default, the caps are visible.
-    * @default true
-    */
+     * Determines whether the caps of the error bars are displayed. By default, the caps are visible.
+     * @default true
+     */
     endCaps: boolean;
+    /**
+     * Specifies the line configuration of the error bars.
+     */
     line: ErrorBarLine;
+    /**
+     * Specifies the value for the error bars.
+     */
     value: string;
+    /**
+     * Specifies a function that creates a custom visual for the error bars.
+     */
     visual: (e: ErrorBarsVisualArgs) => drawing.Element;
+    /**
+     * Specifies the x-axis value for the error bars.
+     */
     xValue: string;
+    /**
+     * Specifies the y-axis value for the error bars.
+     */
     yValue: string;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<SeriesErrorBarsComponent, never>;