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

package/esm2022/chart/x-axis-item.component.mjs

@@ -13,35 +13,109 @@ import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 import * as i3 from "@progress/kendo-angular-intl";
 /**
- * The configuration component for an X axis
+ * Represents the Kendo UI for Angular Chart X Axis Item component
  * ([see example]({% slug api_charts_xaxiscomponent %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-x-axis>
+ *   <kendo-chart-x-axis-item>
+ *    <kendo-chart-x-axis-item-title text="X Axis Title"></kendo-chart-x-axis-item-title>
+ *  </kendo-chart-x-axis-item>
+ *  </kendo-chart-x-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link XAxisCrosshairComponent}, {@link XAxisLabelsComponent}, {@link XAxisNotesComponent}, and {@link XAxisTitleComponent}.
  */
 export class XAxisItemComponent extends CollectionItemComponent {
     configurationService;
     collectionService;
     intl;
+    /**
+     * Specifies the value or array of values at which the axis crosses with another axis.
+     */
     axisCrossingValue;
+    /**
+     * Specifies the background color of the axis.
+     */
     background;
+    /**
+     * Specifies the base time unit for the axis.
+     */
     baseUnit;
+    /**
+     * Specifies the categories for the axis.
+     */
     categories;
+    /**
+     * Specifies the color of the axis.
+     */
     color;
+    /**
+     * Specifies the configuration of the axis line.
+     */
     line;
+    /**
+     * Specifies the configuration of the major grid lines.
+     */
     majorGridLines;
+    /**
+     * Specifies the configuration of the major ticks.
+     */
     majorTicks;
+    /**
+     * Specifies the interval between major divisions.
+     */
     majorUnit;
+    /**
+     * Specifies the maximum value of the axis.
+     */
     max;
+    /**
+     * Specifies the minimum value of the axis.
+     */
     min;
+    /**
+     * Specifies the configuration of the minor grid lines.
+     */
     minorGridLines;
+    /**
+     * Specifies the configuration of the minor ticks.
+     */
     minorTicks;
+    /**
+     * Specifies the interval between minor divisions.
+     */
     minorUnit;
+    /**
+     * Specifies the unique name of the axis.
+     */
     name;
+    /**
+     * Determines whether the Chart prevents the automatic axis range from snapping to zero.
+     */
     narrowRange;
+    /**
+     * Specifies the name of the pane that the axis renders in.
+     */
     pane;
+    /**
+     * Specifies the plot bands configuration.
+     */
     plotBands;
+    /**
+     * Determines whether the axis direction is reversed.
+     */
     reverse;
+    /**
+     * Specifies the start angle for radar and polar axes.
+     */
     startAngle;
     /**
-     * The axis type.
+     * Specifies the axis type.
      *
      * The options are `numeric` for a numeric axis, `date` for a specialized axis for displaying chronological data, and `log` for a logarithmic axis.
      *
@@ -51,15 +125,30 @@ export class XAxisItemComponent extends CollectionItemComponent {
      */
     type;
     /**
-     * If set to `true`, the Chart displays the X axis. By default, the X axis is visible.
+     * Determines whether the Chart displays the X axis. By default, the X axis is visible.
      * @default true
      */
     visible;
+    /**
+     * Specifies the first day of the week.
+     */
     weekStartDay;
     // These options are also available as child components
+    /**
+     * Specifies the configuration of the crosshair.
+     */
     crosshair;
+    /**
+     * Specifies the configuration of the labels.
+     */
     labels;
+    /**
+     * Specifies the configuration of the notes.
+     */
     notes;
+    /**
+     * Specifies the configuration of the title.
+     */
     title;
     intlSubscription;
     constructor(configurationService, collectionService, intl, localeId) {

package/esm2022/chart/x-axis.component.mjs

@@ -12,7 +12,7 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/collection.service";
 /**
- * A collection of one or more X-axis configuration components.
+ * Represents a collection of one or more X-axis configuration components.
  *
  * @example
  * ```html
@@ -29,6 +29,9 @@ import * as i2 from "../common/collection.service";
  *     </kendo-chart-x-axis>
  * </kendo-chart>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link XAxisItemComponent}.
  */
 export class XAxisComponent extends CollectionComponent {
     configurationService;

package/esm2022/chart/y-axis-item/crosshair.component.mjs

@@ -8,16 +8,47 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The crosshair configuration options
+ * Represents the crosshair configuration options of the Y axis
  * ([see example]({% slug api_charts_yaxiscomponent %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-y-axis>
+ *   <kendo-chart-y-axis-item>
+ *    <kendo-chart-y-axis-item-crosshair [visible]="true" color="#ff0000" [width]="2">
+ *     <kendo-chart-y-axis-item-crosshair-tooltip format="c"></kendo-chart-y-axis-item-crosshair-tooltip>
+ *    </kendo-chart-y-axis-item-crosshair>
+ *   </kendo-chart-y-axis-item>
+ *  </kendo-chart-y-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link YAxisCrosshairTooltipComponent}.
  */
 export class YAxisCrosshairComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the color of the crosshair.
+     */
     color;
+    /**
+     * Specifies the opacity of the crosshair.
+     */
     opacity;
+    /**
+     * Determines whether the crosshair is visible.
+     */
     visible;
+    /**
+     * Specifies the width of the crosshair.
+     */
     width;
     // These options are also available as child components.
+    /**
+     * Specifies the tooltip configuration of the crosshair.
+     */
     tooltip;
     constructor(configurationService) {
         super('crosshair', configurationService);

package/esm2022/chart/y-axis-item/crosshair.tooltip.component.mjs

@@ -8,17 +8,38 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration options of the crosshair tooltip.
+ * Represents the configuration options of the crosshair tooltip in the Y axis.
  * The crosshair tooltip is displayed when the `visible` option is set to `true`.
  */
 export class YAxisCrosshairTooltipComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the tooltip.
+     */
     background;
+    /**
+     * Specifies the border configuration of the tooltip.
+     */
     border;
+    /**
+     * Specifies the text color of the tooltip.
+     */
     color;
+    /**
+     * Specifies the font style of the tooltip.
+     */
     font;
+    /**
+     * Specifies the format of the tooltip.
+     */
     format;
+    /**
+     * Specifies the padding of the tooltip. A numeric value sets all paddings.
+     */
     padding;
+    /**
+     * Determines whether the tooltip is visible.
+     */
     visible;
     constructor(configurationService) {
         super('crosshair.tooltip', configurationService);

package/esm2022/chart/y-axis-item/labels.component.mjs

@@ -8,68 +8,89 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The axis labels configuration.
+ * Represents the Y-axis labels configuration.
  */
 export class YAxisLabelsComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the labels.
+     */
     background;
+    /**
+     * Specifies the border configuration of the labels.
+     */
     border;
+    /**
+     * Specifies the text color of the labels.
+     */
     color;
+    /**
+     * Specifies a function that returns the content of the labels.
+     */
     content;
+    /**
+     * Specifies the culture used for formatting the labels.
+     */
     culture;
+    /**
+     * Specifies the date formats for displaying the labels.
+     */
     dateFormats;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      * @default '12px sans-serif'
      */
     font;
     /**
-     * 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;
     /**
-     * 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;
     /**
-     * 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;
     /**
-     * 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;
     /**
-     * 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;
     /**
-     * The rotation angle of the labels. By default, the labels are not rotated.
+     * Specifies the rotation angle of the labels. By default, the labels are not rotated.
      * @default 0
      */
     rotation;
     /**
-     * The number of labels to skip.
+     * Specifies the number of labels to skip.
      * @default 0
      */
     skip;
     /**
-     * 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;
     /**
-     * If set to `true`, the Chart displays the Y-axis labels. By default, the Y-axis labels are visible.
+     * Determines whether the Chart displays the Y-axis labels. By default, the Y-axis labels are visible.
      * @default true
      */
     visible;
+    /**
+     * Specifies a function that returns a custom visual for the labels.
+     */
     visual;
     constructor(configurationService) {
         super('labels', configurationService);

package/esm2022/chart/y-axis-item/notes.component.mjs

@@ -8,17 +8,50 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration of the Y axis notes
+ * Represents the configuration of the Y-axis notes
  * ([see example]({% slug api_charts_yaxiscomponent %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-y-axis>
+ *   <kendo-chart-y-axis-item>
+ *    <kendo-chart-y-axis-item-notes [visible]="true" position="top">
+ *    </kendo-chart-y-axis-item-notes>
+ *   </kendo-chart-y-axis-item>
+ *  </kendo-chart-y-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link YAxisNotesIconComponent} and {@link YAxisNotesLabelComponent}.
  */
 export class YAxisNotesComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the data for the notes.
+     */
     data;
+    /**
+     * Specifies the line configuration of the notes.
+     */
     line;
+    /**
+     * Specifies the position of the notes.
+     */
     position;
+    /**
+     * Specifies a function that returns a custom visual for the notes.
+     */
     visual;
     // These options are also available as child components
+    /**
+     * Specifies the icon configuration of the notes.
+     */
     icon;
+    /**
+     * Specifies the label configuration of the notes.
+     */
     label;
     constructor(configurationService) {
         super('notes', configurationService);

package/esm2022/chart/y-axis-item/notes.icon.component.mjs

@@ -8,20 +8,29 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The icon of the notes.
+ * Represents the configuration of the notes icon in the Y axis.
  */
 export class YAxisNotesIconComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the icon.
+     */
     background;
+    /**
+     * Specifies the border configuration of the icon.
+     */
     border;
+    /**
+     * Specifies the size of the icon.
+     */
     size;
     /**
-     * The shape of the notes icon.
+     * Specifies the shape of the notes icon.
      * @default 'circle'
      */
     type;
     /**
-     * The visibility of the notes icon.
+     * Determines whether the notes icon is visible.
      * @default true
      */
     visible;

package/esm2022/chart/y-axis-item/notes.label.component.mjs

@@ -8,37 +8,49 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The label of the notes.
+ * Represents the configuration of the notes label in the Y axis.
  */
 export class YAxisNotesLabelComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the label.
+     */
     background;
+    /**
+     * Specifies the border configuration of the label.
+     */
     border;
+    /**
+     * Specifies the text color of the label.
+     */
     color;
+    /**
+     * Specifies a function that returns the content of the notes label.
+     */
     content;
     /**
-     * The font style of the label.
+     * Specifies the font style of the label.
      * @default '12px sans-serif'
      */
     font;
     /**
-     * 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;
     /**
-     * The position of the labels.
+     * Specifies the position of the labels.
      * @default 'inside'
      */
     position;
     /**
-     * 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;
     /**
-     * If set to `true`, the Chart displays the Y-axis notes label.
+     * Determines whether the Chart displays the Y-axis notes label.
      * By default, the Y-axis notes label is visible.
      * @default true
      */

package/esm2022/chart/y-axis-item/title.component.mjs

@@ -8,45 +8,60 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The title configuration of the Scatter Chart Y axis.
+ * Represents the title configuration of the Scatter Chart Y axis.
  */
 export class YAxisTitleComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the background color of the title.
+     */
     background;
+    /**
+     * Specifies the border configuration of the title.
+     */
     border;
+    /**
+     * Specifies the text color of the title.
+     */
     color;
     /**
-     * The font style of the title.
+     * Specifies the font style of the title.
      * @default 'bold 16px sans-serif'
      */
     font;
     /**
-     * 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;
     /**
-     * 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;
     /**
-     * The position of the title.
+     * Specifies the position of the title.
      * @default 'center'
      */
     position;
     /**
-     * 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;
+    /**
+     * Specifies the text of the title.
+     */
     text;
     /**
-     * If set to `true`, the Chart displays the Scatter Chart Y-axis title.
+     * Determines whether the Chart displays the Scatter Chart Y-axis title.
      * By default, the Scatter Chart Y-axis title is visible.
      * @default true
      */
     visible;
+    /**
+     * Specifies a function that returns a custom visual for the title.
+     */
     visual;
     constructor(configurationService) {
         super('title', configurationService);