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

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

@@ -9,44 +9,59 @@ import { AxisDefaultsTitle } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the axis title ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
+ * Represents the configuration of the axis title ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
  */
 export declare class AxisDefaultsTitleComponent extends SettingsComponent implements AxisDefaultsTitle {
     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 'bold 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 padding of the title. A numeric value sets all paddings.
+     * Specifies the padding of the title. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * The position of the title.
+     * Specifies the position of the title.
      * @default 'center'
      */
     position: AxisTitlePosition;
     /**
-     * The rotation angle of the title. By default, the title is not rotated.
+     * Specifies the rotation angle of the title. By default, the title is not rotated.
      * @default 0
      */
     rotation: number;
+    /**
+     * Specifies the text content of the title.
+     */
     text: string;
     /**
-     * If set to `true`, the Chart displays the axis title. By default, the axis title is visible.
+     * Determines whether the Chart displays the axis title. By default, the axis title is visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies a `visual` function that customizes the appearance of the title.
+     */
     visual: (e: TitleVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<AxisDefaultsTitleComponent, never>;

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

@@ -8,49 +8,98 @@ import { AxisDefaults, AxisDefaultsCrosshair, AxisDefaultsLabels, AxisDefaultsTi
 import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The default options for all Chart axes ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
+ * Represents the default options for all Chart axes ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
  * Accepts the options which are supported by [`categoryAxis`](slug:api_charts_categoryaxisitemcomponent),
  * [`valueAxis`](slug:api_charts_valueaxisitemcomponent),
  * [`xAxis`](slug:api_charts_xaxisitemcomponent),
  * and [`yAxis`](slug:api_charts_yaxisitemcomponent).
  *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-axis-defaults>
+ *   <kendo-chart-axis-defaults-crosshair [color]="'red'"></kendo-chart-axis-defaults-crosshair>
+ *  <kendo-chart-axis-defaults-labels [color]="'blue'"></kendo-chart-axis-defaults-labels>
+ *  <kendo-chart-axis-defaults-title text="My Axis Title"></kendo-chart-axis-defaults-title>
+ * </kendo-chart-axis-defaults>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link AxisDefaultsCrosshairComponent}, {@link AxisDefaultsLabelsComponent}, and {@link AxisDefaultsTitleComponent}.
  */
 export declare class AxisDefaultsComponent extends SettingsComponent implements AxisDefaults {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the axis.
+     */
     background: string;
+    /**
+     * Specifies the color of the axis.
+     */
     color: string;
+    /**
+     * 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 minor grid lines configuration of the axis.
+     */
     minorGridLines: GridLines;
+    /**
+     * Specifies the minor ticks configuration of the axis.
+     */
     minorTicks: AxisTicks;
     /**
-     * If set to `true`, the Chart prevents the axis range from snapping to zero.
-     * Setting it to `false`, forces the axis range to snap to zero.
+     * Determines whether the Chart prevents the axis range from snapping to zero.
+     * Set it to `false` to force the axis range to snap to zero.
      * @default false
      */
     narrowRange: boolean;
+    /**
+     * Specifies the pane of the axis.
+     */
     pane: string;
+    /**
+     * Specifies the plot bands configuration of the axis.
+     */
     plotBands: PlotBand[];
     /**
-     * If set to `true`, the axis direction is reversed. By default, categories are listed from left to
-     * right and from bottom to top.
+     * Determines whether the axis direction is reversed. Categories are listed from left to
+     * right and from bottom to top by default.
      * @default false
      */
     reverse: 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;
     /**
-     * If set to `true`, the Chart displays the axis.
+     * Determines whether the Chart displays the axis.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies the crosshair configuration of the axis.
+     */
     crosshair: AxisDefaultsCrosshair;
+    /**
+     * Specifies the labels configuration of the axis.
+     */
     labels: AxisDefaultsLabels;
+    /**
+     * Specifies the title configuration of the axis.
+     */
     title: AxisDefaultsTitle;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<AxisDefaultsComponent, never>;

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

@@ -8,32 +8,41 @@ import { CategoryAxisCrosshair, CategoryAxisCrosshairTooltip } from '../../commo
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The crosshair configuration options ([see example]({% slug crosshairs_chart_charts %})).
+ * Configures the crosshair for the category axis in the Chart ([see example]({% slug crosshairs_chart_charts %})).
+ *
+ * @remarks
+ * Supported children components are: {@link CategoryAxisCrosshairTooltipComponent}.
  */
 export declare class CategoryAxisCrosshairComponent extends SettingsComponent implements CategoryAxisCrosshair {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the color of the crosshair.
+     */
     color: string;
     /**
-     * The dash type of the crosshair.
+     * Defines the dash type of the crosshair.
      * @default 'solid'
      */
     dashType: DashType;
     /**
-     * The opacity of the crosshair. By default, the crosshair is opaque.
+     * Specifies the opacity of the crosshair. By default, the crosshair is opaque.
      * @default 1
      */
     opacity: number;
     /**
-     * If set to `true`, the Chart displays the category axis crosshair.
+     * Determines whether the Chart displays the category axis crosshair.
      * By default, the category axis crosshair is not visible.
      * @default false
      */
     visible: boolean;
     /**
-     * The width of the crosshair in pixels.
+     * Sets the width of the crosshair in pixels.
      * @default 1
      */
     width: number;
+    /**
+     * Configures the tooltip configuration of the crosshair.
+     */
     tooltip: CategoryAxisCrosshairTooltip;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisCrosshairComponent, never>;

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

@@ -8,32 +8,41 @@ import { Border, Padding } from '../../common/property-types';
 import { CategoryAxisCrosshairTooltip } from '../../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The options of the crosshair tooltip ([see example]({% slug crosshairs_chart_charts %})).
+ * Represents the configuration options of the crosshair tooltip for the category axis of the Chart ([see example]({% slug crosshairs_chart_charts %})).
  * The crosshair tooltip is displayed when the `visible` option is set to `true`.
  */
 export declare class CategoryAxisCrosshairTooltipComponent extends SettingsComponent implements CategoryAxisCrosshairTooltip {
     configurationService: ConfigurationService;
+    /**
+     * Sets the background color of the tooltip.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the tooltip.
+     */
     border: Border;
+    /**
+     * Defines the text color of the tooltip.
+     */
     color: string;
     /**
-     * The tooltip font.
+     * Sets the font of the tooltip.
      * @default '12px sans-serif'
      */
     font: string;
     /**
-     * The format used to display the tooltip. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     * Specifies the format used to display the tooltip. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
      * Contains one placeholder (`"{0}"`) which represents the category value.
      * @default '{0}'
      */
     format: string;
     /**
-     * The padding of the crosshair tooltip. A numeric value sets all paddings.
+     * Specifies the padding of the crosshair tooltip. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * If set to `true`, the Chart displays the category axis crosshair tooltip.
+     * Determines whether the Chart displays the category axis crosshair tooltip.
      * By default, the category axis crosshair tooltip is not visible.
      * @default false
      */

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

@@ -11,74 +11,94 @@ import { Margin, Padding } from '../../common/property-types';
 import { CategoryAxisLabels } from '../../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the axis labels ([see example]({% slug labels_chart_charts %})).
+ * Represents the labels configuration for the category axis of the Chart ([see example]({% slug labels_chart_charts %})).
  */
 export declare class CategoryAxisLabelsComponent extends SettingsComponent implements CategoryAxisLabels {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the labels.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the labels.
+     */
     border: Border;
+    /**
+     * Sets the text color of the labels.
+     */
     color: string;
+    /**
+     * Specifies a function that creates the content of the label.
+     */
     content: (e: AxisLabelContentArgs) => string;
+    /**
+     * Defines the culture info used for formatting the dates.
+     */
     culture: string;
+    /**
+     * Specifies the format for different date parts.
+     */
     dateFormats: DateFormats;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      * @default '12px sans-serif'
      */
     font: string;
     /**
-     * The format for displaying the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     * Specifies the format for displaying the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
      * Contains one placeholder (`"{0}"`) which represents the category value.
      * @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;
     /**
-     * If set to `true`, the Chart mirrors the axis labels and ticks. If the labels are normally on the
+     * Determines whether the Chart mirrors the axis labels and ticks. If the labels are normally on the
      * left side of the axis, the mirroring of the axis renders them to the right.
      * @default false
      */
     mirror: boolean;
     /**
-     * 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;
     /**
-     * The position of the axis labels. By default, labels are positioned next to the axis.
-     * When `position` is set to `end`, the labels are placed at the end of the crossing axis, usually at the top or right end of the Chart unless the crossing axis has been reversed.
-     * Alternatively, when the `position` property is set to `start`, the axis labels will be positioned at the beginning of the crossing axis, typically located at the left or bottom end of the Chart, unless the crossing axis has been reversed.
+     * Specifies the position of the axis labels. By default, the labels are positioned next to the axis.
+     *
      * @default 'onAxis'
      */
     position: AxisLabelsPosition;
     /**
-     * The rotation angle of the labels. By default, the labels are not rotated.
-     * If the axis is horizontal, can be set to `"auto"`.
-     * In this case, the labels are rotated
+     * Specifies the rotation angle of the labels. By default, the labels are not rotated.
+     *
+     * If the axis is horizontal, can be set to `"auto"`. In this case, the labels are rotated
      * only if the slot size is not sufficient for the entire labels.
      * @default 0
      */
     rotation: LabelRotation | number | 'auto';
     /**
-     * The number of labels to skip. By default, no labels are skipped.
+     * Specifies the number of labels to skip. By default, no labels are skipped.
      * @default 0
      */
     skip: number;
     /**
-     * The rendering step of the label&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     * Specifies the rendering step of the label&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
      * @default 1
      */
     step: number;
     /**
-     * If set to `true`, the Chart displays the category axis labels.
+     * Determines whether the Chart displays the category axis labels.
      * By default, the category axis labels are visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies a function that creates a visual for the label.
+     */
     visual: (e: AxisLabelVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisLabelsComponent, never>;

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

@@ -9,15 +9,33 @@ import { CategoryAxisNotes, CategoryAxisNotesIcon, CategoryAxisNotesLabel } from
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the category axis notes ([see example]({% slug notes_chart_charts %}#toc-axis-notes)).
+ * Configures the notes for the category axis in the Chart ([see example]({% slug notes_chart_charts %}#toc-axis-notes))
  */
 export declare class CategoryAxisNotesComponent extends SettingsComponent implements CategoryAxisNotes {
     configurationService: ConfigurationService;
+    /**
+     * Defines the data items for the notes.
+     */
     data: any[];
+    /**
+     * Specifies the line configuration of the notes.
+     */
     line: NoteLine;
+    /**
+     * Sets the position of the notes.
+     */
     position: NotePosition;
+    /**
+     * Provides a function that creates a custom visual for the notes.
+     */
     visual: (e: AxisNoteVisualArgs) => drawing.Element;
+    /**
+     * Specifies the icon configuration of the notes.
+     */
     icon: CategoryAxisNotesIcon;
+    /**
+     * Specifies the label configuration of the notes.
+     */
     label: CategoryAxisNotesLabel;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisNotesComponent, never>;

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

@@ -8,14 +8,29 @@ import { Border, MarkerType } from '../../common/property-types';
 import { CategoryAxisNotesIcon } from '../../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The icon of the notes.
+ * Represents the icon configuration for the category axis notes in the Chart.
  */
 export declare class CategoryAxisNotesIconComponent extends SettingsComponent implements CategoryAxisNotesIcon {
     configurationService: ConfigurationService;
+    /**
+     * Sets the background color of the icon.
+     */
     background: string;
+    /**
+     * Configures the border of the icon.
+     */
     border: Border;
+    /**
+     * Specifies the size of the icon.
+     */
     size: number;
+    /**
+     * Sets the type of the icon.
+     */
     type: MarkerType;
+    /**
+     * Determines whether the icon is visible.
+     */
     visible: boolean;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisNotesIconComponent, never>;

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

@@ -8,37 +8,49 @@ import { CategoryAxisNotesLabel } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The label of the notes.
+ * Represents the label configuration for the category axis notes in the Chart.
  */
 export declare class CategoryAxisNotesLabelComponent extends SettingsComponent implements CategoryAxisNotesLabel {
     configurationService: ConfigurationService;
+    /**
+     * Sets the background color of the label.
+     */
     background: string;
+    /**
+     * Configures the border of the label.
+     */
     border: Border;
+    /**
+     * Sets the text color of the label.
+     */
     color: string;
+    /**
+     * Provides a function that creates the content of the label.
+     */
     content: (e: AxisNoteContentArgs) => 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 category value.
      * @default '{0}'
      */
     format: string;
     /**
-     * The position of the label.
+     * Specifies the position of the label.
      * @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 category notes label.
+     * Determines whether the Chart displays the category notes label.
      * By default, the category notes label is visible.
      * @default true
      */

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

@@ -7,7 +7,7 @@ import { CategoryAxisRangeLabels } from '../../common/property-types';
 import { CategoryAxisLabelsComponent } from './labels.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the axis date range labels ([see example]({% slug labels_chart_charts %})).
+ * Represents the range labels configuration for the category axis in the Chart ([see example]({% slug labels_chart_charts %})).
  */
 export declare class CategoryAxisRangeLabelsComponent extends CategoryAxisLabelsComponent implements CategoryAxisRangeLabels {
     configurationService: ConfigurationService;

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

@@ -8,19 +8,29 @@ import { CategoryAxisSelect } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The selected axis range. If set, the axis selection is enabled. The range is index-based and starts from zero.
- * Categories with indexes in the
- * ([`select.from`]({% slug api_charts_categoryaxisselectcomponent %}#toc-from)
- * —[`select.to`]({% slug api_charts_categoryaxisselectcomponent %}#toc-to)) range will be selected.
- * This means that the last category in the range will not be included in the selection.
- * If the categories are dates, the range has to be also specified with date values.
+ * Configures the selection for the category axis in the Chart. When set, axis selection is enabled and the range is index-based, starting from zero. You can specify the lower and upper boundaries, minimum and maximum values, and mousewheel configuration. If the categories are dates, specify the range with date values.
  */
 export declare class CategoryAxisSelectComponent extends SettingsComponent implements CategoryAxisSelect {
     configurationService: ConfigurationService;
+    /**
+     * Sets the lower boundary of the selected range.
+     */
     from: any;
+    /**
+     * Sets the maximum value for the selection.
+     */
     max: any;
+    /**
+     * Sets the minimum value for the selection.
+     */
     min: any;
+    /**
+     * Specifies the mousewheel configuration for the selection.
+     */
     mousewheel: boolean | MousewheelSelect;
+    /**
+     * Specifies the upper boundary of the selected range.
+     */
     to: any;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisSelectComponent, never>;

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

@@ -9,45 +9,60 @@ import { CategoryAxisTitle } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the category axis title.
+ * Represents the title configuration for the category axis in the Chart.
  */
 export declare class CategoryAxisTitleComponent extends SettingsComponent implements CategoryAxisTitle {
     configurationService: ConfigurationService;
+    /**
+     * Sets the background color of the title.
+     */
     background: string;
+    /**
+     * Configures the border of the title.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the title.
+     */
     color: string;
     /**
-     * The font style of the title.
+     * Sets the font style of the title.
      * @default 'bold 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 padding of the title. A numeric value sets all paddings.
+     * Specifies the padding of the title. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * The position of the title.
+     * Sets the position of the title.
      * @default 'center'
      */
     position: AxisTitlePosition;
     /**
-     * The rotation angle of the title. By default, the title is not rotated.
+     * Specifies the rotation angle of the title. By default, the title is not rotated.
      * @default 0
      */
     rotation: number;
+    /**
+     * Specifies the text of the title.
+     */
     text: string;
     /**
-     * If set to `true`, the Chart displays the category axis title.
+     * Determines whether the Chart displays the category axis title.
      * By default, the category axis title is visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Provides a function that creates a custom visual for the title.
+     */
     visual: (e: TitleVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CategoryAxisTitleComponent, never>;