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

package/argument-types/legend-labels-content-args.interface.d.ts

@@ -3,28 +3,28 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The context for the legend label content function.
+ * Represents the context for the legend label `content` function.
  */
 export interface LegendLabelsContentArgs {
     /**
-     * The text of the legend item.
+     * Specifies the text of the legend item.
      */
     text: string;
     /**
-     * The series configuration object.
+     * Specifies the series configuration object.
      */
     series: any;
     /**
-     * The point value of the Donut and Pie charts.
+     * Specifies the point value of the Donut and Pie charts.
      */
     value?: any;
     /**
-     * The point value represented as a percentage value.
+     * Specifies the point value represented as a percentage.
      * Available only for the Donut, Pie, Funnel and Pyramid charts.
      */
     percentage?: number;
     /**
-     * The point dataItem.
+     * Specifies the data item associated with the point.
      * Available only for the Donut, Pie, Funnel and Pyramid charts.
      */
     dataItem?: any;

package/argument-types/markers-visual-args.interface.d.ts

@@ -5,39 +5,39 @@
 import { ChartComponent } from '../chart.component';
 import { drawing, geometry } from '@progress/kendo-drawing';
 /**
- * The context for the markers visual function.
+ * Represents the context for the markers `visual` function.
  */
 export interface MarkersVisualArgs {
     /**
-     * The point category.
+     * Specifies the category of the point.
      */
     category: any;
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The point data item.
+     * Specifies the data item associated with the point.
      */
     dataItem: any;
     /**
-     * The marker options.
+     * Specifies the options of the marker.
      */
     options: any;
     /**
-     * The rectangle that defines the normal position of the visual.
+     * Specifies the rectangle that defines the normal position of the visual.
      */
     rect: geometry.Rect;
     /**
-     * The instance of the Chart component.
+     * Specifies the instance of the Chart component.
      */
     sender: ChartComponent;
     /**
-     * The point series.
+     * Specifies the point series.
      */
     series: any;
     /**
-     * The point value.
+     * Specifies the value of the point.
      */
     value: any;
 }

package/argument-types/plot-band-label-visual-args.interface.d.ts

@@ -5,27 +5,27 @@
 import { ChartComponent } from '../chart.component';
 import { drawing, geometry } from '@progress/kendo-drawing';
 /**
- * The context for the function of the plot bands label visual.
+ * Represents the context for the `visual` function of the plot bands label.
  */
 export interface PlotBandLabelVisualArgs {
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The label options.
+     * Specifies the options of the label.
      */
     options: any;
     /**
-     * The rectangle that defines the normal position of the visual.
+     * Specifies the rectangle that defines the normal position of the visual.
      */
     rect: geometry.Rect;
     /**
-     * The instance of the Chart component.
+     * Specifies the instance of the Chart component.
      */
     sender: ChartComponent;
     /**
-     * The label text.
+     * Specifies the text of the label.
      */
     text: string;
 }

package/argument-types/series-labels-content-args.interface.d.ts

@@ -3,48 +3,48 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The context for the function of the series label visual.
+ * Represents the context for the `content` function of the series label.
  */
 export interface SeriesLabelsContentArgs {
     /**
-     * The label text.
+     * Specifies the text of the label.
      */
     text: string;
     /**
-     * The original data item used to construct the point. If binding to an array, it will be `null`.
+     * Specifies the original data item used to construct the point. If binding to an array, it will be `null`.
      */
     dataItem: any;
     /**
-     * The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie
+     * Specifies the category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie
      * series.
      */
     category: any;
     /**
-     * The point value. Can be a number or object containing each bound field.
+     * Specifies the value of the point. The value can be a number or object containing each bound field.
      */
     value: any;
     /**
-     * The point value that is represented as a percentage value.
-     * Available only for the Donut, Pie, and 100% stacked charts.
+     * Specifies the point value represented as a percentage.
+     * Available only for the Donut, Pie, and 100% Stacked charts.
      */
     percentage?: number;
     /**
-     * The cumulative point value on the stack.
+     * Specifies the cumulative point value on the stack.
      * Available only for the stackable series.
      */
     stackValue?: number;
     /**
-     * The sum of point values from the last `runningTotal` summary point onwards.
+     * Specifies the sum of point values from the last `"runningTotal"` summary point onwards.
      * Available for the Waterfall series.
      */
     runningTotal?: number;
     /**
-     * The sum of all previous series values.
+     * Specifies the sum of all previous series values.
      * Available for the Waterfall series.
      */
     total?: number;
     /**
-     * The data series configuration object.
+     * Specifies the data series configuration object.
      */
     series: any;
 }

package/argument-types/series-labels-visual-args.interface.d.ts

@@ -5,63 +5,63 @@
 import { ChartComponent } from '../chart.component';
 import { drawing, geometry } from '@progress/kendo-drawing';
 /**
- * The context for the function of the series label visual.
+ * Represents the context for the `visual` function of the series label.
  */
 export interface SeriesLabelsVisualArgs {
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The label options.
+     * Specifies the options of the label.
      */
     options: any;
     /**
-     * The rectangle that defines the normal position of the visual.
+     * Specifies the rectangle that defines the normal position of the visual.
      */
     rect: geometry.Rect;
     /**
-     * The instance of the Chart component.
+     * Specifies the instance of the Chart component.
      */
     sender: ChartComponent;
     /**
-     * The label text.
+     * Specifies the text of the label.
      */
     text: string;
     /**
-     * The point data item.
+     * Specifies the data item associated with the point.
      */
     dataItem: any;
     /**
-     * The point category.
+     * Specifies the category of the point.
      */
     category: any;
     /**
-     * The point value.
+     * Specifies the value of the point.
      */
     value: any;
     /**
-     * The point value that is represented as a percentage value.
+     * Specifies the point value represented as a percentage.
      * Available only for the Donut, Pie, and 100% stacked charts.
      */
     percentage?: number;
     /**
-     * The cumulative point value on the stack.
+     * Specifies the cumulative point value on the stack.
      * Available only for the stackable series.
      */
     stackValue?: number;
     /**
-     * The sum of point values from the last `runningTotal` summary point onwards.
+     * Specifies the sum of point values from the last `"runningTotal"` summary point onwards.
      * Available for the Waterfall series.
      */
     runningTotal?: number;
     /**
-     * The sum of all previous series values.
+     * Specifies the sum of all previous series values.
      * Available for the Waterfall series.
      */
     total?: number;
     /**
-     * The point series.
+     * Specifies the point series.
      */
     series: any;
 }

package/argument-types/series-note-content-args.interface.d.ts

@@ -3,27 +3,27 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The context for the series note content function.
+ * Represents the context for the series note `content` function.
  */
 export interface SeriesNoteContentArgs {
     /**
-     * The point category.
+     * Specifies the category of the point.
      */
     category: any;
     /**
-     * The point data item.
+     * Provides the data item associated with the point.
      */
     dataItem: any;
     /**
-     * The point series.
+     * Specifies the point series.
      */
     series: any;
     /**
-     * The point value.
+     * Represents the value of the point.
      */
     value: string;
     /**
-     * The note text.
+     * Defines the note text.
      */
     text: string;
 }

package/argument-types/series-note-visual-args.interface.d.ts

@@ -5,43 +5,43 @@
 import { ChartComponent } from '../chart.component';
 import { drawing, geometry } from '@progress/kendo-drawing';
 /**
- * The context for the point highlight visual function.
+ * Represents the context for the series note `visual` function.
  */
 export interface SeriesNoteVisualArgs {
     /**
-     * The point category.
+     * Specifies the category of the point.
      */
     category: any;
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The point data item.
+     * Provides the data item associated with the point.
      */
     dataItem: any;
     /**
-     * The note options.
+     * Defines the options for the note.
      */
     options: any;
     /**
-     * The rectangle that defines the normal position of the visual.
+     * Specifies the rectangle that defines the normal position of the visual.
      */
     rect: geometry.Rect;
     /**
-     * The instance of the Chart component.
+     * Specifies the instance of the Chart component.
      */
     sender: ChartComponent;
     /**
-     * The point series.
+     * Specifies the point series.
      */
     series: any;
     /**
-     * The point value.
+     * Represents the value of the point.
      */
     value: string;
     /**
-     * The note text.
+     * Defines the note text.
      */
     text: string;
 }

package/argument-types/series-visual-args.interface.d.ts

@@ -5,85 +5,78 @@
 import { ChartComponent } from '../chart.component';
 import { drawing, geometry } from '@progress/kendo-drawing';
 /**
- * The context for the function of the series point visual.
+ * Represents the context for the `visual` function of the series point.
  */
 export interface SeriesVisualArgs {
     /**
-     * The point category.
+     * Specifies the category of the point.
      */
     category: any;
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The center point of the segment.
-     * Available for the Donut and Pie series.
+     * Specifies the center point of the segment. Available for the Donut and Pie series.
      */
     center?: geometry.Point;
     /**
-     * The point data item.
+     * Provides the data item associated with the point.
      */
     dataItem: any;
     /**
-     * The end angle of the segment.
-     * Available for the Donut and Pie series.
+     * Specifies the end angle of the segment. Available for the Donut and Pie series.
      */
     endAngle?: number;
     /**
-     * The inner radius of the segment.
-     * Available for the Donut and Pie series.
+     * Specifies the inner radius of the segment. Available for the Donut and Pie series.
      */
     innerRadius?: number;
     /**
-     * The point options.
+     * Defines the options for the point.
      */
     options: any;
     /**
-     * The point value represented as a percentage value.
+     * Specifies the point value represented as a percentage.
      * Available only for the Donut, Pie, and 100% stacked charts.
      */
     percentage?: number;
     /**
-     * The segment points.
-     * Available for the Donut and Pie series.
+     * Specifies the segment points. Available for the Donut and Pie series.
      */
     points?: geometry.Point[];
     /**
-     * The segment radius.
-     * Available for the Donut and Pie series.
+     * Specifies the segment radius. Available for the Donut and Pie series.
      */
     radius?: number;
     /**
-     * The rectangle that defines the normal position of the visual.
+     * Specifies the rectangle that defines the normal position of the visual.
      */
     rect: geometry.Rect;
     /**
-     * The sum of point values from the last `runningTotal`
-     * summary point onwards.
+     * Specifies the sum of point values from the last `"runningTotal"` summary point onwards.
      * Available for the Waterfall series.
      */
     runningTotal?: number;
     /**
-     * The instance of the Chart component.
+     * Specifies the instance of the Chart component.
      */
     sender: ChartComponent;
     /**
-     * The point series.
+     * Specifies the series to which the point belongs.
      */
     series: any;
     /**
-     * The start angle of the segment.
-     * Available for the Donut and Pie series.
+     * Specifies the start angle of the segment. Available for the Donut and Pie series.
      */
     startAngle?: number;
     /**
-     * The sum of all previous series values.
+     * Specifies the sum of all previous series values.
      * Available for the Waterfall series.
      */
     total?: number;
     /**
-     * The point value.
+     * Represents the value of the point.
      */
     value: any;
 }

package/argument-types/title-visual-args.interface.d.ts

@@ -5,27 +5,27 @@
 import { ChartComponent } from '../chart.component';
 import { drawing, geometry } from '@progress/kendo-drawing';
 /**
- * The context for the title visual function.
+ * Represents the context for the title `visual` function.
  */
 export interface TitleVisualArgs {
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The title options.
+     * Specifies the title options.
      */
     options: any;
     /**
-     * The rectangle that defines the normal position of the visual.
+     * Specifies the rectangle that defines the normal position of the visual.
      */
     rect: geometry.Rect;
     /**
-     * The instance of the Chart component.
+     * Specifies the instance of the Chart component.
      */
     sender: ChartComponent;
     /**
-     * The text of the title.
+     * Specifies the text of the title.
      */
     text: string;
 }

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

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

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

@@ -8,33 +8,42 @@ import { AxisDefaultsCrosshairTooltip } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The options of the crosshair tooltip ([see example]({% slug crosshairs_chart_charts %})).
+ * Represents the available options of the crosshair tooltip ([see example]({% slug crosshairs_chart_charts %})).
  * The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`]({% slug api_charts_axisdefaultscrosshairtooltipcomponent %}#toc-visible)
  * option is set to `true`.
  */
 export declare class AxisDefaultsCrosshairTooltipComponent extends SettingsComponent implements AxisDefaultsCrosshairTooltip {
     configurationService: ConfigurationService;
+    /**
+     * Sets the background color of the tooltip.
+     */
     background: string;
+    /**
+     * Specifies the border configuration of the tooltip.
+     */
     border: Border;
+    /**
+     * Sets the text color of the tooltip.
+     */
     color: string;
     /**
-     * The tooltip font.
+     * Specifies the tooltip font.
      * @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 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 axis crosshair tooltip.
+     * Determines whether the Chart displays the axis crosshair tooltip.
      * By default, the axis crosshair tooltip is not visible.
      * @default false
      */

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

@@ -9,61 +9,67 @@ import { AxisDefaultsLabels } from '../../common/property-types';
 import { SettingsComponent } from '../../common/settings.component';
 import * as i0 from "@angular/core";
 /**
- * The configuration of the axis labels ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
+ * Represents the configuration of the axis labels ([see example](slug:axes_chart_charts#toc-default-axis-configuration)).
  */
 export declare class AxisDefaultsLabelsComponent extends SettingsComponent implements AxisDefaultsLabels {
     configurationService: ConfigurationService;
+    /**
+     * Specifies a `content` function that customizes the appearance of the labels.
+     */
     content: (e: AxisLabelContentArgs) => string;
     /**
-     * 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.
+     * 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.
+     * Sets the padding of the labels. A numeric value sets all paddings.
      * @default 0
      */
     padding: Padding | number;
     /**
-     * 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.
+     * 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 label-rendering step&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     * Specifies the step for rendering the labels&mdash;renders every n<sup>th</sup> label. By default, each label is rendered.
      * @default 1
      */
     step: number;
     /**
-     * If set to `true`, the Chart displays the axis labels. By default, the axis labels are visible.
+     * Determines whether the Chart displays the axis labels. By default, the axis labels are visible.
      * @default true
      */
     visible: boolean;
+    /**
+     * Specifies a `visual` function that customizes the appearance of the labels.
+     */
     visual: (e: AxisLabelVisualArgs) => drawing.Element;
     constructor(configurationService: ConfigurationService);
     static ɵfac: i0.ɵɵFactoryDeclaration<AxisDefaultsLabelsComponent, never>;