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

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

@@ -9,46 +9,96 @@ import { AxisLine, AxisTicks, GridLines, PlotBand } from '../common/property-typ
 import { ValueAxis, ValueAxisCrosshair, ValueAxisLabels, ValueAxisNotes, ValueAxisTitle } from '../common/property-types';
 import * as i0 from "@angular/core";
 /**
- * The configuration component for a value axis.
+ * Represents the Kendo UI for Angular Chart Value Axis Item component.
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-value-axis>
+ *   <kendo-chart-value-axis-item>
+ *     <kendo-chart-value-axis-item-title text="Value Axis Title"></kendo-chart-value-axis-item-title>
+ *   </kendo-chart-value-axis-item>
+ *  </kendo-chart-value-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link ValueAxisCrosshairComponent}, {@link ValueAxisLabelsComponent}, {@link ValueAxisNotesComponent}, and {@link ValueAxisTitleComponent}.
  */
 export declare class ValueAxisItemComponent extends CollectionItemComponent implements ValueAxis {
     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 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;
     /**
-     * The maximum value of the axis.
+     * Specifies the maximum value of the axis.
      * @default 1
      */
     max: any;
     /**
-     * The minimum value of the axis.
+     * Specifies the minimum value of the axis.
      * @default 0
      */
     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;
     /**
-     * The unique axis name. Used to associate a series with a value axis by using the [`series.axis`]({% slug api_charts_series %}#toc-axis) option.
+     * Specifies the unique axis name. Use this name to associate a series with a value axis by using the [`series.axis`]({% slug api_charts_series %}#toc-axis) option.
      * @default 'primary'
      */
     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 true
      */
     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 categories are listed from left to right and from bottom to top.
      *
      * Radar and Polar Charts do not support reverse value axes.
@@ -56,21 +106,33 @@ export declare class ValueAxisItemComponent extends CollectionItemComponent impl
      */
     reverse: boolean;
     /**
-     * The axis type.
+     * Specifies the axis type.
      *
-     * The "numeric" value refers to a numeric axis, while "log" represents a logarithmic axis.
+     * The `numeric` value refers to a numeric axis, while `log` represents a logarithmic axis.
      * @default 'numeric'
      *
      */
     type: 'numeric' | 'log';
     /**
-     * If set to `true`, the Chart displays the value axis. By default, the value axis is visible.
+     * Determines whether the Chart displays the value axis. By default, the value axis is visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies the configuration of the crosshair.
+     */
     crosshair: ValueAxisCrosshair;
+    /**
+     * Specifies the configuration of the labels.
+     */
     labels: ValueAxisLabels;
+    /**
+     * Specifies the configuration of the notes.
+     */
     notes: ValueAxisNotes;
+    /**
+     * Specifies the configuration of the title.
+     */
     title: ValueAxisTitle;
     constructor(configurationService: ConfigurationService, collectionService: CollectionService);
     static ɵfac: i0.ɵɵFactoryDeclaration<ValueAxisItemComponent, never>;

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

@@ -8,16 +8,18 @@ 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 value axis configuration components.
+ * Represents a collection of one or more value axis configuration components.
  *
  * @example
  * ```html
  * <kendo-chart>
  *     <kendo-chart-value-axis>
- *         ....
  *     </kendo-chart-value-axis>
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link ValueAxisItemComponent}.
  */
 export declare class ValueAxisComponent extends CollectionComponent {
     protected configurationService: ConfigurationService;

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

@@ -7,27 +7,49 @@ import { XAxisCrosshair, XAxisCrosshairTooltip } from '../../common/property-typ
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The crosshair configuration options
+ * Represents the crosshair configuration options of the X axis
  * ([see example]({% slug api_charts_xaxiscomponent %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-x-axis>
+ *   <kendo-chart-x-axis-item>
+ *    <kendo-chart-x-axis-item-crosshair [visible]="true" color="#ff0000" [width]="2">
+ *     <kendo-chart-x-axis-item-crosshair-tooltip format="c"></kendo-chart-x-axis-item-crosshair-tooltip>
+ *    </kendo-chart-x-axis-item-crosshair>
+ *   </kendo-chart-x-axis-item>
+ *  </kendo-chart-x-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link XAxisCrosshairTooltipComponent}.
  */
 export declare class XAxisCrosshairComponent extends SettingsComponent implements XAxisCrosshair {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the color of the crosshair.
+     */
     color: string;
     /**
-     * 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 X-axis crosshair of the Scatter Chart.
+     * Determines whether the Chart displays the X-axis crosshair of the Scatter Chart.
      * @default false
      */
     visible: boolean;
     /**
-     * The width of the crosshair in pixels.
+     * Specifies the width of the crosshair in pixels.
      * @default 1
      */
     width: number;
+    /**
+     * Specifies the tooltip configuration of the crosshair.
+     */
     tooltip: XAxisCrosshairTooltip;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<XAxisCrosshairComponent, never>;

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

@@ -8,32 +8,41 @@ import { XAxisCrosshairTooltip } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration options of the crosshair tooltip.
+ * Represents the configuration options of the crosshair tooltip in the X axis.
  * The crosshair tooltip is displayed when the `visible` option is set to `true`.
  */
 export declare class XAxisCrosshairTooltipComponent extends SettingsComponent implements XAxisCrosshairTooltip {
     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 font of the tooltip.
+     * Specifies the font of the tooltip.
      * @default '12px sans-serif'
      */
     font: string;
     /**
-     * The format for displaying the tooltip. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
+     * Specifies the format for displaying the tooltip. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService`.
      * Contains one placeholder (`"{0}"`) which represents the 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 crosshair tooltip of the Scatter chart X axis.
+     * Determines whether the Chart displays the crosshair tooltip of the Scatter chart X axis.
      * By default, the crosshair tooltip of the Scatter chart X axis is not visible.
      * @default false
      */

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

@@ -10,55 +10,85 @@ import { XAxisLabels } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The axis labels configuration.
+ * Represents the labels configuration of the X axis.
  */
 export declare class XAxisLabelsComponent extends SettingsComponent implements XAxisLabels {
     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: AxisLabelContentArgs) => string;
+    /**
+     * Specifies the culture information for the labels.
+     */
     culture: string;
+    /**
+     * Specifies the date formats for the labels.
+     */
     dateFormats: DateFormats;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      * @default '12px sans-serif'
      */
     font: string;
+    /**
+     * Specifies the format of the labels.
+     */
     format: string;
+    /**
+     * Specifies the margin of the labels.
+     */
     margin: Margin | number;
+    /**
+     * Specifies whether the labels are mirrored.
+     */
     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.
+     * Specifies the position of the axis labels. By default, labels are positioned next to the axis.
      * @default 'onAxis'
      */
     position: AxisLabelsPosition;
     /**
-     * The rotation angle of the labels. By default, the labels are not rotated. Can be set to `"auto"`.
+     * Specifies the rotation angle of the labels. By default, the labels are not rotated. 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.
+     * Specifies the number of labels to skip.
      * @default 1
      */
     skip: number;
     /**
-     * The label rendering step&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     * Specifies the label rendering step&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 X-axis labels. By default, the X-axis labels are visible.
+     * Determines whether the Chart displays the X-axis labels. By default, the X-axis labels are visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies a function that returns a custom visual for the labels.
+     */
     visual: (e: AxisLabelVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<XAxisLabelsComponent, never>;

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

@@ -9,19 +9,52 @@ import { XAxisNotes, XAxisNotesIcon, XAxisNotesLabel } from '../../common/proper
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the X-axis notes.
- * For an example on the basic usage of the XAxisNotesComponent,
- * refer to the [demo on the XAxisComponent]({% slug api_charts_xaxiscomponent %})
+ * Represents the configuration of the X-axis notes.
+ * For an example on the basic usage of the `XAxisNotesComponent`,
+ * refer to the [demo on the `XAxisComponent`]({% slug api_charts_xaxiscomponent %})
  * or to the documentation about the
  * [axis notes]({% slug notes_chart_charts %}#toc-axis-notes).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-x-axis>
+ *   <kendo-chart-x-axis-item>
+ *    <kendo-chart-x-axis-item-notes>
+ *    </kendo-chart-x-axis-item-notes>
+ *  </kendo-chart-x-axis-item>
+ *  </kendo-chart-x-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link XAxisNotesIconComponent} and {@link XAxisNotesLabelComponent}.
  */
 export declare class XAxisNotesComponent extends SettingsComponent implements XAxisNotes {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the data for the notes.
+     */
     data: any[];
+    /**
+     * Specifies the line configuration of the notes.
+     */
     line: NoteLine;
+    /**
+     * Specifies the position of the notes.
+     */
     position: NotePosition;
+    /**
+     * Specifies a function that returns a custom visual for the notes.
+     */
     visual: (e: AxisNoteVisualArgs) => drawing.Element;
+    /**
+     * Specifies the icon configuration of the notes.
+     */
     icon: XAxisNotesIcon;
+    /**
+     * Specifies the label configuration of the notes.
+     */
     label: XAxisNotesLabel;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<XAxisNotesComponent, never>;

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

@@ -8,20 +8,29 @@ import { XAxisNotesIcon } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The icon of the notes.
+ * Represents the notes icon configuration of the X axis.
  */
 export declare class XAxisNotesIconComponent extends SettingsComponent implements XAxisNotesIcon {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the icon.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the icon.
+     */
     border: Border;
+    /**
+     * Specifies the size of the 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/x-axis-item/notes.label.component.d.ts

@@ -8,37 +8,49 @@ import { XAxisNotesLabel } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The label of the notes.
+ * Represents the notes label configuration of the X axis.
  */
 export declare class XAxisNotesLabelComponent extends SettingsComponent implements XAxisNotesLabel {
     configurationService: ConfigurationService;
+    /**
+     * Specifies the background color of the label.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the label.
+     */
     border: Border;
+    /**
+     * Specifies the text color of the label.
+     */
     color: string;
+    /**
+     * Specifies a function that returns the content of the notes 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 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 X-axis notes label.
+     * Determines whether the Chart displays the X-axis notes label.
      * By default, the X-axis notes label is visible.
      * @default true
      */

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

@@ -9,45 +9,60 @@ import { XAxisTitle } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The title configuration of the Scatter Chart X axis.
+ * Represents the title configuration of the Scatter Chart X axis.
  */
 export declare class XAxisTitleComponent extends SettingsComponent implements XAxisTitle {
     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 5
      */
     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 of the title.
+     */
     text: string;
     /**
-     * If set to `true`, the Chart displays the X axis title of the Scatter Chart.
+     * Determines whether the Chart displays the X axis title of the Scatter Chart.
      * By default, the X-axis title of the Scatter Chart is visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies a function that returns a custom visual for the title.
+     */
     visual: (e: TitleVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<XAxisTitleComponent, never>;