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

package/esm2022/chart/subtitle.component.mjs

@@ -8,7 +8,7 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the Chart subtitle or text
+ * Represents the Kendo UI for Angular Chart Subtitle component
  * ([see example]({% slug title_chart_charts %})).
  *
  * @example
@@ -20,37 +20,52 @@ import * as i1 from "../common/configuration.service";
  */
 export class SubtitleComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the horizontal alignment of the subtitle.
+     */
     align;
     /**
-     * The background color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
      *
      * @default 'white'
      */
     background;
+    /**
+     * Specifies the border configuration of the subtitle.
+     */
     border;
+    /**
+     * Specifies the color of the subtitle text.
+     */
     color;
     /**
-     * The font of the subtitle.
+     * Specifies the font of the subtitle.
      *
      * @default '12px sans-serif'
      */
     font;
+    /**
+     * Specifies the margin configuration of the subtitle.
+     */
     margin;
     /**
-     * The padding of the subtitle. A numeric value sets all paddings.
+     * Specifies the padding of the subtitle. A numeric value sets all paddings.
      *
      * @default 5
      */
     padding;
     /**
-     * The position of the subtitle.
+     * Specifies the position of the subtitle.
      *
      * @default 'top'
      */
     position;
+    /**
+     * Specifies the text content of the subtitle.
+     */
     text;
     /**
-     * If set to `true`, the Chart displays the subtitle.
+     * Determines whether the Chart displays the subtitle.
      *
      * @default true
      */

package/esm2022/chart/title.component.mjs

@@ -8,7 +8,7 @@ import { SettingsComponent } from '../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 /**
- * The configuration options of the Chart title or text
+ * Represents the Kendo UI for Angular Chart Title configuration
  * ([see example]({% slug title_chart_charts %})).
  *
  * @example
@@ -22,44 +22,59 @@ import * as i1 from "../common/configuration.service";
 export class TitleComponent extends SettingsComponent {
     configurationService;
     /**
-     * The alignment of the title.
+     * Specifies the alignment of the title.
      * The alignment options for text include `center` for middle alignment, `left` for left alignment, and `right` for right alignment, allowing for flexible positioning of the title.
      *
      * @default 'center'
      */
     align;
     /**
-     * The background color of the title. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the title. Accepts a valid CSS color string, including HEX and RGB.
      *
      * @default 'white'
      */
     background;
+    /**
+     * Specifies the border configuration of the title.
+     */
     border;
+    /**
+     * Specifies the text color of the title.
+     */
     color;
     /**
-     * The font of the title.
+     * Specifies the font of the title.
      *
      * @default '16px sans-serif'
      */
     font;
+    /**
+     * Specifies the margin of the title. A numeric value sets all margins.
+     */
     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 5
      */
     padding;
     /**
-     * The position of the title.
+     * Specifies the position of the title.
      * The positioning options for titles include `bottom` for positioning at the bottom and `top` for positioning at the top, providing flexibility in title placement.
      *
      * @default 'top'
      */
     position;
+    /**
+     * Specifies the text of the title.
+     */
     text;
+    /**
+     * Specifies the description of the title.
+     */
     description;
     /**
-     * If set to `true`, the Chart displays the title.
+     * Determines whether the Chart displays the title.
      *
      * @default true
      */

package/esm2022/chart/tooltip/series-tooltip-template.directive.mjs

@@ -5,7 +5,7 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * A directive that selects a [template](link:site.data.urls.angular['templatesyntax'])
+ * Represents a directive that selects a [template](link:site.data.urls.angular['templatesyntax'])
  * within the `<kendo-chart-tooltip>` component for the
  * [series tooltip](slug:tooltips_chart_charts#toc-specifying-a-template).
  * The following context fields are frequently utilized:

package/esm2022/chart/tooltip/shared-tooltip-template.directive.mjs

@@ -5,14 +5,14 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * A directive that selects a [template](link:site.data.urls.angular['templatesyntax'])
+ * Represents a directive that selects a [template](link:site.data.urls.angular['templatesyntax'])
  * within the `<kendo-chart-tooltip>` component for the
  * [shared series tooltip](slug:tooltips_chart_charts#toc-shared-tooltip-customization).
  * The available fields in the template context are:
  * - `let-points="points"`&mdash;An array of the [`TooltipTemplatePoints`](slug:api_charts_tooltiptemplatepoint) category.
  * - `let-category="category"`&mdash;The category name.
  * - `let-categoryText="categoryText"`&mdash;The category name as text.
- * - `let-nameColumn="nameColumn"`&mdash;Returns a Boolean [`value`](slug:api_charts_seriesitemcomponent#toc-name) indicating whether the name property of the `SeriesItemComponent` is defined.
+ * - `let-nameColumn="nameColumn"`&mdash;Returns a Boolean [`value`](slug:api_charts_seriesitemcomponent#toc-name) indicating whether the `name` property of the `SeriesItemComponent` is defined.
  * - `let-colorMarker="colorMarker"`&mdash;Returns a Boolean value indicating whether one or more series colors are specified in the Chart. If the Chart contains only one `SeriesItemComponent`, the context field will return `false`.
  * - `let-colSpan="colSpan"`&mdash;Specifies the number of columns covered by the tooltip. The default value is `1` and increases by `1` if `nameColumn` and `colorMarker` are set to `true`.
  *

package/esm2022/chart/tooltip/tooltip-template-point.mjs

@@ -3,63 +3,63 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The point that is passed to the tooltip template.
+ * Represents the point that is passed to the tooltip template.
  */
 export class TooltipTemplatePoint {
     /**
-     * The point value.
+     * Specifies the point value.
      */
     value;
     /**
-     * The point category. Available only for the Categorical series.
+     * Specifies the point category. Available only for the Categorical series.
      */
     category;
     /**
-     * The point category index. Available only for the Categorical series.
+     * Specifies the point category index. Available only for the Categorical series.
      */
     categoryIndex;
     /**
-     * The point series options.
+     * Specifies the point series options.
      */
     series;
     /**
-     * The point `dataItem`.
+     * Specifies the point `dataItem`.
      */
     dataItem;
     /**
-     * The point value represented as a percentage value. Available only for the Donut, Pie, and 100% Stacked charts.
+     * Specifies the point value represented as a percentage value. Available only for the Donut, Pie, and 100% Stacked charts.
      */
     percentage;
     /**
-     * The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
+     * Specifies the sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
      */
     runningTotal;
     /**
-     * The sum of all previous series values. Available for the Waterfall series.
+     * Specifies the sum of all previous series values. Available for the Waterfall series.
      */
     total;
     /**
-     * The low value of the point error bar. Available for the Categorical series with error bars.
+     * Specifies the low value of the point error bar. Available for the Categorical series with error bars.
      */
     low;
     /**
-     * The high value of the point error bar. Available for the Categorical series with error bars.
+     * Specifies the high value of the point error bar. Available for the Categorical series with error bars.
      */
     high;
     /**
-     * The x low value of the point error bar. Available for the Scatter series with error bars.
+     * Specifies the x low value of the point error bar. Available for the Scatter series with error bars.
      */
     xLow;
     /**
-     * The x high value of the point error bar. Available for the Scatter series with error bars.
+     * Specifies the x high value of the point error bar. Available for the Scatter series with error bars.
      */
     xHigh;
     /**
-     * The y low value of the point error bar. Available for the Scatter series with error bars.
+     * Specifies the y low value of the point error bar. Available for the Scatter series with error bars.
      */
     yLow;
     /**
-     * The y low value of the point error bar. Available for the Scatter series with error bars.
+     * Specifies the y high value of the point error bar. Available for the Scatter series with error bars.
      */
     yHigh;
     /**

package/esm2022/chart/tooltip.component.mjs

@@ -12,34 +12,49 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/configuration.service";
 import * as i2 from "../common/tooltip-template.service";
 /**
- * The configuration options of the Chart series tooltip
+ * Represents the Kendo UI for Angular Chart Tooltip configuration
  * ([see example]({% slug tooltips_chart_charts %})).
  */
 export class TooltipComponent extends SettingsComponent {
     configurationService;
     templateService;
+    /**
+     * Specifies the background color of the tooltip.
+     */
     background;
+    /**
+     * Specifies the border configuration of the tooltip.
+     */
     border;
+    /**
+     * Specifies the text color of the tooltip.
+     */
     color;
     /**
-     * The font of the tooltip.
+     * Specifies the font of the tooltip.
      * @default '12px sans-serif'
      */
     font;
+    /**
+     * Specifies the format of the tooltip.
+     */
     format;
     /**
-     * The opacity of the tooltip.
+     * Specifies the opacity of the tooltip.
      * @default 1
      */
     opacity;
+    /**
+     * Specifies the padding of the tooltip. A numeric value sets all paddings.
+     */
     padding;
     /**
-     * If set to `true`, the Chart displays a single tooltip for every category.
+     * Determines whether the Chart displays a single tooltip for every category.
      * @default false
      */
     shared;
     /**
-     * If set to `true`, the Chart displays the series tooltip.
+     * Determines whether the Chart displays the series tooltip.
      * @default false
      */
     visible;

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

@@ -8,30 +8,52 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The crosshair configuration options ([see example]({% slug crosshairs_chart_charts %})).
+ * Represents the crosshair configuration options of the Chart value axis ([see example]({% slug crosshairs_chart_charts %})).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-value-axis>
+ *   <kendo-chart-value-axis-item>
+ *    <kendo-chart-value-axis-item-crosshair [visible]="true" color="#ff0000" [width]="2">
+ *     <kendo-chart-value-axis-item-crosshair-tooltip format="c"></kendo-chart-value-axis-item-crosshair-tooltip>
+ *    </kendo-chart-value-axis-item-crosshair>
+ *   </kendo-chart-value-axis-item>
+ *  </kendo-chart-value-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link ValueAxisCrosshairTooltipComponent}.
  */
 export class ValueAxisCrosshairComponent extends SettingsComponent {
     configurationService;
+    /**
+     * Specifies the color of the crosshair.
+     */
     color;
     /**
-     * The opacity of the crosshair.
+     * Specifies the opacity of the crosshair.
      *
      * @default 1
      */
     opacity;
     /**
-     * If set to `true`, the Chart displays the value axis crosshair.
+     * Determines whether the Chart displays the value axis crosshair.
      *
      * @default false
      */
     visible;
     /**
-     * The width of the crosshair in pixels.
+     * Specifies the width of the crosshair in pixels.
      *
      * @default 1
      */
     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/value-axis-item/crosshair.tooltip.component.mjs

@@ -8,30 +8,42 @@ 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 ([see example]({% slug crosshairs_chart_charts %})).
+ * Represents the configuration options of the crosshair tooltip in the Chart value axis ([see example]({% slug crosshairs_chart_charts %})).
  * The crosshair tooltip is displayed when the `visible` option is set to `true`.
  */
 export class ValueAxisCrosshairTooltipComponent 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;
     /**
-     * The font of the tooltip.
+     * Specifies the font of the tooltip.
      *
      * @default '12px sans-serif'
      */
     font;
     /**
-   * 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;
+    /**
+     * Specifies the padding of the tooltip. A numeric value sets all paddings.
+     */
     padding;
     /**
-     * If set to `true`, the chart displays the value axis crosshair tooltip.
+     * Determines whether the chart displays the value axis crosshair tooltip.
      *
      * @default false
      */

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

@@ -8,13 +8,25 @@ 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 value axis labels configuration.
  */
 export class ValueAxisLabelsComponent 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 creates the content of the label.
+     */
     content;
     /**
      * The font style of the labels.

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

@@ -8,16 +8,49 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The configuration of the value axis notes ([see example]({% slug notes_chart_charts %}#toc-axis-notes)).
+ * Represents the configuration of the value axis notes ([see example]({% slug notes_chart_charts %}#toc-axis-notes)).
+ *
+ * @example
+ * ```html
+ * <kendo-chart>
+ *  <kendo-chart-value-axis>
+ *   <kendo-chart-value-axis-item>
+ *    <kendo-chart-value-axis-item-notes>
+ *    </kendo-chart-value-axis-item-notes>
+ *  </kendo-chart-value-axis-item>
+ *  </kendo-chart-value-axis>
+ * </kendo-chart>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link ValueAxisNotesIconComponent} and {@link ValueAxisNotesLabelComponent}.
  */
 export class ValueAxisNotesComponent 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/value-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 Chart value axis.
  */
 export class ValueAxisNotesIconComponent 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/value-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 Chart value axis.
  */
 export class ValueAxisNotesLabelComponent 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 used to display the notes label. Uses the IntlService [`format`]({% slug api_intl_intlservice %}#toc-format) method.
+     * Specifies the format used to display the notes label. Uses the IntlService [`format`]({% slug api_intl_intlservice %}#toc-format) method.
      * 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 value axis notes label.
+     * Determines whether the Chart displays the value axis notes label.
      * @default true
      */
     visible;

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

@@ -8,44 +8,59 @@ import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/configuration.service";
 /**
- * The title configuration of the value axis.
+ * Represents the title configuration of the Chart value axis.
  */
 export class ValueAxisTitleComponent 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 '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 value axis title.
+     * Determines whether the Chart displays the value axis title.
      * @default true
      */
     visible;
+    /**
+     * Specifies a function that returns a custom visual for the title.
+     */
     visual;
     constructor(configurationService) {
         super('title', configurationService);