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

package/api-types/axis-range.interface.d.ts

@@ -3,15 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The axis range.
+ * Represents the axis range with minimum and maximum values.
  */
 export interface AxisRange {
     /**
-     * The axis minimum value.
+     * Specifies the axis minimum value.
      */
     min: number | Date;
     /**
-     * The axis maximum value.
+     * Specifies the axis maximum value.
      */
     max: number | Date;
 }

package/api-types/chart-axis.interface.d.ts

@@ -5,7 +5,7 @@
 import { geometry } from '@progress/kendo-drawing';
 import { AxisRange } from './axis-range.interface';
 /**
- * An interface for the Chart axes API.
+ * Represents the Chart axes API interface.
  */
 export interface ChartAxis {
     /**
@@ -17,16 +17,16 @@ export interface ChartAxis {
     /**
      * Returns a slot based on the specified `from` and `to` values.
      *
-     * @param from The slot start value.
-     * @param to The end slot value. If not specified, the `from` value is used.
-     * @param limit The parameters for the exported image.
-     * @returns {Promise<string>} Indicates whether the slot is limited to the current range. By default, the range is limited.
+     * @param {string | number | Date} from The start value of the slot.
+     * @param {string | number | Date} to The end value of the slot. If not specified, the `from` value is used.
+     * @param {boolean} limit Indicates whether the slot is limited to the current range. By default, the range is limited.
+     * @returns {geometry.Rect | geometry.Arc} The slot rectangle or arc geometry.
      */
     slot(from: string | number | Date, to?: string | number | Date, limit?: boolean): geometry.Rect | geometry.Arc;
     /**
      * Returns the value that corresponds to the passed surface point.
      *
-     * @param { Point } point The surface point of the Chart.
+     * @param {geometry.Point} point The surface point of the Chart.
      * @returns {string | number | Date} The value that corresponds to the point.
      */
     value(point: geometry.Point): string | number | Date;

package/api-types/chart-pane.interface.d.ts

@@ -5,22 +5,22 @@
 import { Group } from '@progress/kendo-drawing';
 import { ChartAxis } from './chart-axis.interface';
 /**
- * An interface for the Chart panes.
+ * Represents the Chart panes interface.
  */
 export interface ChartPane {
     /**
-     * The group which holds the Drawing elements of the Chart.
+     * Specifies the `Group` which holds the Drawing elements of the Chart.
      */
     chartsVisual: Group;
     /**
-     * The Drawing group that is used to draw the pane.
+     * Specifies the Drawing `Group` that is used to draw the pane.
      */
     visual: Group;
     /**
      * Returns the axis from the pane with the specified name.
      *
-     * @param {string} name The axis name.
-     * @returns {ChartAxis} The axis with a corresponding name.
+     * @param {string} name The name of the axis.
+     * @returns {ChartAxis} The axis with the corresponding name.
      */
     findAxisByName(name: string): ChartAxis;
 }

package/api-types/chart-plotarea.interface.d.ts

@@ -4,15 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 import { MultiPath, Group } from '@progress/kendo-drawing';
 /**
- * An interface for the plot area of the Chart.
+ * Represents the plot area interface of the Chart.
  */
 export interface ChartPlotArea {
     /**
-     * The Drawing `MultiPath` that is used to draw the background.
+     * Specifies the Drawing `MultiPath` that is used to draw the background.
      */
     backgroundVisual: MultiPath;
     /**
-     * The Drawing `Group` that is used to draw the plot area.
+     * Specifies the Drawing `Group` that is used to draw the plot area.
      */
     visual: Group;
 }

package/api-types/chart-svg-export-options.interface.d.ts

@@ -4,9 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 import { SVGExportOptions } from '@progress/kendo-drawing';
 /**
- * The options for customizing the exported SVG.
+ * Represents the Kendo UI for Angular Chart SVG export options.
  */
 export interface ChartSVGExportOptions extends SVGExportOptions {
+    /**
+     * Specifies the width (in pixels) of the exported SVG. If not set, the width of the exported element will be used.
+     */
     width?: number;
+    /**
+     * Specifies the height (in pixels) of the exported SVG. If not set, the height of the exported element will be used.
+     */
     height?: number;
 }

package/api-types/chart-visual-export-options.interface.d.ts

@@ -3,9 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The options for customizing the exported visual.
+ * Represents the options for customizing the exported visual.
  */
 export interface ChartVisualExportOptions {
+    /**
+     * Specifies the width (in pixels) of the exported scene. Defaults to the width of the element.
+     */
     width?: number;
+    /**
+     * Specifies the height (in pixels) of the exported scene. Defaults to the height of the element.
+     */
     height?: number;
 }

package/api-types/event-axis-options.interface.d.ts

@@ -3,11 +3,11 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The axis options for the Chart events.
+ * Represents the axis options for the Chart events.
  */
 export interface EventAxisOptions {
     /**
-     * The axis name.
+     * Specifies the name of the axis.
      */
     name: string;
 }

package/api-types/event-series-options.interface.d.ts

@@ -3,19 +3,19 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The series options for the Chart events.
+ * Represents the series options for the Chart events.
  */
 export interface EventSeriesOptions {
     /**
-     * The series index.
+     * Specifies the index of the series.
      */
     index: number;
     /**
-     * The series name.
+     * Specifies the name of the series.
      */
     name: string;
     /**
-     * The series visibility.
+     * Specifies the visibility of the series.
      */
     visible: boolean;
 }

package/api-types/series-point-marker.interface.d.ts

@@ -8,11 +8,11 @@ import { drawing } from '@progress/kendo-drawing';
  */
 export interface SeriesPointMarker {
     /**
-     * The point marker options.
+     * Specifies the point marker options.
      */
     options?: any;
     /**
-     * The Drawing element used to draw the series point marker.
+     * Specifies the Drawing element used to draw the series point marker.
      */
     visual?: drawing.Element;
 }

package/api-types/series-point.interface.d.ts

@@ -5,55 +5,55 @@
 import { drawing } from '@progress/kendo-drawing';
 import { SeriesPointMarker } from './series-point-marker.interface';
 /**
- * A series point.
+ * Represents a series point in the Chart.
  */
 export interface SeriesPoint {
     /**
-     * The point category value. Available only for the Categorical points (Bar, Line, and other).
+     * Specifies the category value of the point. Available for Categorical points such as Bar and Line series.
      */
     category?: string | Date | number;
     /**
-     * The point `dataItem`.
+     * Specifies the `dataItem` associated with the point.
      */
     dataItem?: any;
     /**
-     * The point options.
+     * Specifies the options for the point.
      */
     options?: any;
     /**
-     * The point index in the series. Available only for categorical and Funnel charts.
+     * Defines the index of the point in the series. Available for Categorical and Funnel charts.
      */
     index?: number;
     /**
-     * The marker associated with the point, if any. Available only for Line and ScatterLine series.
+     * Specifies the marker associated with the point, if any. Available only for Line and ScatterLine series.
      */
     marker?: SeriesPointMarker;
     /**
-     * The point value represented as a percentage value. Available only for the Donut, Pie, and 100% Stacked chart points.
+     * Specifies the value of the point as a percentage. Available for Donut, Pie, and 100% Stacked Chart points.
      */
     percentage?: number;
     /**
-     * The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series points.
+     * Defines the sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series points.
      */
     runningTotal?: number;
     /**
-     * The sum of all previous series values. Available for the Waterfall series points.
+     * Specifies the sum of all previous series values. Available for the Waterfall series points.
      */
     total?: number;
     /**
-     * The minimum value for the series. Available for the Heatmap series points.
+     * Specifies the minimum value for the series. Available for the Heatmap series points.
      */
     min?: number;
     /**
-     * The maximum value for the series. Available for the Heatmap series points.
+     * Specifies the maximum value for the series. Available for the Heatmap series points.
      */
     max?: number;
     /**
-     * The point value.
+     * Represents the value of the point.
      */
     value?: any;
     /**
-     * The Drawing element used to draw the point.
+     * Provides the Drawing element used to draw the point.
      */
     visual?: drawing.Element;
 }

package/argument-types/axis-label-content-args.interface.d.ts

@@ -3,37 +3,37 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The context for the axis label content function.
+ * Represents the context for the axis label `content` function.
  */
 export interface AxisLabelContentArgs {
     /**
-     * The value associated with the axis label.
+     * Specifies the value associated with the axis label.
      */
     value: any;
     /**
-     * The data item, if set.
+     * Specifies the data item, if set.
      *
      * Available for category axis with set `categoryField`.
      */
     dataItem?: any;
     /**
-     * The default label text.
+     * Specifies the default label text.
      */
     text: string;
     /**
-     * The index of the label.
+     * Specifies the index of the label.
      */
     index: number;
     /**
-     * The total number of rendered labels.
+     * Specifies the total number of rendered labels.
      */
     count: number;
     /**
-     * The default format string of the label.
+     * Specifies the default format string of the label.
      */
     format: string;
     /**
-     * The default culture (if set) of the label.
+     * Specifies the default culture (if set) of the label.
      */
     culture: string;
 }

package/argument-types/axis-label-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 axis label visual function.
+ * Represents the context for the axis label `visual` function.
  */
 export interface AxisLabelVisualArgs {
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The default culture (if set) of the label.
+     * Specifies the default culture (if set) of the label.
      */
     culture: string;
     /**
-     * If a field is specified, represents the data item.
+     * Specifies the data item if a field is specified.
      */
     dataItem?: any;
     /**
-     * The default format of the label.
+     * Specifies the default format of the label.
      */
     format: string;
     /**
-     * The label options.
+     * Specifies the label 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 label text.
+     * Specifies the text of the label.
      */
     text: string;
     /**
-     * The label value.
+     * Specifies the value of the label.
      */
     value: any;
 }

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

@@ -3,19 +3,19 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The context for the axis highlight visual function.
+ * Represents the context for the axis note `content` function.
  */
 export interface AxisNoteContentArgs {
     /**
-     * The original data item for the note.
+     * Specifies the original data item for the note.
      */
     dataItem: any;
     /**
-     * The note text.
+     * Specifies the text of the note.
      */
     text: string;
     /**
-     * The note value.
+     * Specifies the value of the note.
      */
     value: string;
 }

package/argument-types/axis-note-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 axis note visual function.
+ * Represents the context for the axis note `visual` function.
  */
 export interface AxisNoteVisualArgs {
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The note options.
+     * Specifies the note 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 note value.
+     * Specifies the value of the note.
      */
     value: string;
 }

package/argument-types/error-bars-value-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 error bars value function.
+ * Represents the context for the error bars `value` function.
  */
 export interface ErrorBarsValueArgs {
     /**
-     * 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 series to which the point belongs.
      */
     series: any;
     /**
-     * The point value.
+     * Specifies the value of the point.
      */
     value: any;
     /**
-     * The point index.
+     * Defines the index of the point in the series.
      */
     index: number;
 }

package/argument-types/error-bars-visual-args.interface.d.ts

@@ -5,31 +5,31 @@
 import { ChartComponent } from '../chart.component';
 import { drawing, geometry } from '@progress/kendo-drawing';
 /**
- * The context for the error bars visual function.
+ * Represents the context for the error bars `visual` function.
  */
 export interface ErrorBarsVisualArgs {
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The high value of the error bar.
+     * Specifies the high value of the error bar.
      */
     high: number;
     /**
-     * The low value of the error bar.
+     * Specifies the low value of the error bar.
      */
     low: number;
     /**
-     * The `options` object of the error bar.
+     * Specifies the `options` object of the error bar.
      */
     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;
 }

package/argument-types/highlight-toggle-args.interface.d.ts

@@ -4,35 +4,35 @@
 *-------------------------------------------------------------------------------------------*/
 import { drawing } from '@progress/kendo-drawing';
 /**
- * The context for the highlight toggle function.
+ * Represents the context for the series highlight `toggle` function.
  */
 export interface HighlightToggleArgs {
     /**
-     * A function that can be used to prevent the showing of the default highlight overlay.
+     * Provides a function that prevents the default highlight overlay from appearing.
      */
     preventDefault: () => void;
     /**
-     * A Boolean value which indicates whether to show the highlight.
+     * Indicates whether the highlight should be displayed.
      */
     show: boolean;
     /**
-     * The visual element that needs to be highlighted.
+     * Specifies the visual element that needs to be highlighted.
      */
     visual: drawing.Element;
     /**
-     * The point category.
+     * Specifies the category of the point.
      */
     category: any;
     /**
-     * The point `dataItem`.
+     * Specifies the data item associated with the point.
      */
     dataItem?: any;
     /**
-     * The point value.
+     * Specifies the value of the point.
      */
     value: any;
     /**
-     * The point series.
+     * Specifies the series to which the point belongs.
      */
     series?: any;
 }

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

@@ -5,55 +5,52 @@
 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 point highlight `visual` function.
  */
 export interface HighlightVisualArgs {
     /**
-     * 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 element.
      */
     createVisual: () => drawing.Element;
     /**
-     * The point data item.
+     * Provides the data item associated with the point.
      */
     dataItem: any;
     /**
-     * The point options.
+     * Defines the options for the point.
      */
     options: any;
     /**
-     * The point value represented as a percentage value.
-     * Available only for the Donut, Pie, and 100% stacked series.
+     * Represents the value of the point as a percentage. Available only for the Donut, Pie, and 100% Stacked series.
      */
     percentage?: 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 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?: 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 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/legend-item-visual-args.interface.d.ts

@@ -5,33 +5,33 @@
 import { ChartComponent } from '../chart.component';
 import { drawing } from '@progress/kendo-drawing';
 /**
- * The context for the legend item visual function ([see example](slug:legend_chart_charts#toc-customizing-the-shape)).
+ * Represents the context for the legend item `visual` function ([see example](slug:legend_chart_charts#toc-customizing-the-shape)).
  */
 export interface LegendItemVisualArgs {
     /**
      * Indicates if the legend item is active.
-     * The item is inactive when the associated point or series in not visible.
+     * Depends on whether the associated point or series is visible.
      */
     active: boolean;
     /**
-     * A function that can be used to get the default visual.
+     * Specifies a function that gets the default visual.
      */
     createVisual: () => drawing.Element;
     /**
-     * The legend item options.
+     * Specifies the options of the legend item.
      */
     options: any;
     /**
-     * The index of the point in the series.
+     * Specifies the index of the point in the series.
      * Available for the Donut, Pie, and Funnel series.
      */
     pointIndex: any;
     /**
-     * The instance of the Chart component.
+     * Specifies the instance of the Chart component.
      */
     sender: ChartComponent;
     /**
-     * The item series.
+     * Specifies the item series.
      */
     series: any;
 }