@progress/kendo-charts 2.12.3-develop.4 → 2.13.0-develop.1

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

@@ -0,0 +1,14 @@
+/**
+ * The axis range.
+ */
+export interface AxisRange {
+    /**
+     * The axis minimum value.
+     */
+    min: number | Date;
+
+    /**
+     * The axis maximum value.
+     */
+    max: number | Date;
+}

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

@@ -0,0 +1,50 @@
+import { geometry } from '@progress/kendo-drawing';
+import { AxisRange } from './axis-range.interface';
+
+/**
+ * An interface for the Chart axes API.
+ */
+export interface ChartAxisType {
+    /**
+     * Returns the axis range.
+     *
+     * @returns {AxisRange} - The axis range.
+     */
+    range(): AxisRange;
+
+    /**
+     * Returns a slot that is based on the specified `from` and `to` values.
+     *
+     * {% platform_content angular %}
+     * See [Custom Plot Bands](https://www.telerik.com/kendo-angular-ui/components/charts/elements/plot-bands#custom-plot-bands) example.
+     * {% endplatform_content %}
+     * {% platform_content react %}
+     * See [Custom Plot Bands](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-bands#toc-custom-plot-bands) example.
+     * {% endplatform_content %}
+     * {% platform_content vue %}
+     * See [Custom Plot Bands](https://www.telerik.com/kendo-vue-ui/components/charts/elements/plot-bands#custom-plot-bands) example.
+     * {% endplatform_content %}
+     *
+     * @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.
+     */
+    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.
+     * @returns {string | number | Date} - The value that corresponds to the point.
+     */
+    value(point: geometry.Point): string | number | Date;
+
+    /**
+     * Returns the axis range which is determined by the minimum and maximum point values that are associated with the axis.
+     *
+     * @returns {AxisRange} - The value range.
+     */
+    valueRange(): AxisRange;
+}

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

@@ -0,0 +1,16 @@
+import { Group } from '@progress/kendo-drawing';
+
+/**
+ * An interface for the Chart panes.
+ */
+export interface ChartPaneType {
+    /**
+     * The group which holds the Drawing elements of the Chart.
+     */
+    chartsVisual: Group;
+
+    /**
+     * The Drawing group that is used to draw the pane.
+     */
+    visual: Group;
+}

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * The axis options for the Chart events.
+ */
+export interface EventAxisOptions {
+    /**
+     * The axis name.
+     */
+    name: string;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * The series options for the Chart events.
+ */
+export interface EventSeriesOptions {
+    /**
+     * The series index.
+     */
+    index: number;
+
+    /**
+     * The series name.
+     */
+    name: string;
+
+    /**
+     * The series visibility.
+     */
+    visible: boolean;
+}

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

@@ -0,0 +1,46 @@
+import { drawing } from '@progress/kendo-drawing';
+
+/**
+ * A series point.
+ */
+export interface SeriesPointType {
+    /**
+     * The point category value. Available only for the Categorical points (Bar, Line, and other).
+     */
+    category?: string | Date | number;
+
+    /**
+     * The point `dataItem`.
+     */
+    dataItem?: any;
+
+    /**
+     * The point options.
+     */
+    options?: any;
+
+    /**
+     * The point value represented as a percentage value. Available only for the 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.
+     */
+    runningTotal?: number;
+
+    /**
+     * The sum of all previous series values. Available for the Waterfall series points.
+     */
+    total?: number;
+
+    /**
+     * The point value.
+     */
+    value?: any;
+
+    /**
+     * The Drawing element used to draw the point.
+     */
+    visual?: drawing.Element;
+}

package/dist/npm/api-types.d.ts

@@ -0,0 +1,7 @@
+export * from './api-types/axis-range.interface';
+export * from './api-types/chart-axis.interface';
+export * from './api-types/chart-pane.interface';
+export * from './api-types/chart-plotarea.interface';
+export * from './api-types/event-axis-options.interface';
+export * from './api-types/event-series-options.interface';
+export * from './api-types/series-point.interface';

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

@@ -0,0 +1,41 @@
+/**
+ * Represents the context for the axis label `content` function.
+ */
+export interface AxisLabelContentArgs {
+  /**
+   * Specifies the value associated with the axis label.
+   */
+  value: any;
+
+  /**
+   * Specifies the data item, if set.
+   *
+   * Available for category axis with set `categoryField`.
+   */
+  dataItem?: any;
+
+  /**
+   * Specifies the default label text.
+   */
+  text: string;
+
+  /**
+   * Specifies the index of the label.
+   */
+  index: number;
+
+  /**
+   * Specifies the total number of rendered labels.
+   */
+  count: number;
+
+  /**
+   * Specifies the default format string of the label.
+   */
+  format: string;
+
+  /**
+   * Specifies the default culture (if set) of the label.
+   */
+  culture: string;
+}

package/dist/npm/argument-types/axis-label-visual-args.interface.d.ts

@@ -0,0 +1,52 @@
+import { Chart } from '../chart';
+import { drawing, geometry } from '@progress/kendo-drawing';
+
+/**
+ * Represents the context for the axis label `visual` function.
+ */
+export interface AxisLabelVisualArgs<TChart = Chart> {
+  /**
+   * Specifies a function that gets the default visual.
+   */
+  createVisual: () => drawing.Element;
+
+  /**
+   * Specifies the default culture (if set) of the label.
+   */
+  culture: string;
+
+  /**
+   * Specifies the data item if a field is specified.
+   */
+  dataItem?: any;
+
+  /**
+   * Specifies the default format of the label.
+   */
+  format: string;
+
+  /**
+   * Specifies the label options.
+   */
+  options: any;
+
+  /**
+   * Specifies the rectangle that defines the normal position of the visual.
+   */
+  rect: geometry.Rect;
+
+  /**
+   * Specifies the instance of the Chart component.
+   */
+  sender: TChart;
+
+  /**
+   * Specifies the text of the label.
+   */
+  text: string;
+
+  /**
+   * Specifies the value of the label.
+   */
+  value: any;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * Represents the context for the axis note `content` function.
+ */
+export interface AxisNoteContentArgs {
+  /**
+   * Specifies the original data item for the note.
+   */
+  dataItem: any;
+
+  /**
+   * Specifies the text of the note.
+   */
+  text: string;
+
+  /**
+   * Specifies the value of the note.
+   */
+  value: string;
+}

package/dist/npm/argument-types/axis-note-visual-args.interface.d.ts

@@ -0,0 +1,32 @@
+import { Chart } from '../chart';
+import { drawing, geometry } from '@progress/kendo-drawing';
+
+/**
+ * Represents the context for the axis note `visual` function.
+ */
+export interface AxisNoteVisualArgs<TChart = Chart> {
+  /**
+   * Specifies a function that gets the default visual.
+   */
+  createVisual: () => drawing.Element;
+
+  /**
+   * Specifies the note options.
+   */
+  options: any;
+
+  /**
+   * Specifies the rectangle that defines the normal position of the visual.
+   */
+  rect: geometry.Rect;
+
+  /**
+   * Specifies the instance of the Chart component.
+   */
+  sender: TChart;
+
+  /**
+   * Specifies the value of the note.
+   */
+  value: string;
+}

package/dist/npm/argument-types/error-bars-value-args.interface.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Represents the context for the error bars `value` function.
+ */
+export interface ErrorBarsValueArgs {
+  /**
+   * Specifies the category of the point.
+   */
+  category: any;
+
+  /**
+   * Provides the data item associated with the point.
+   */
+  dataItem: any;
+
+  /**
+   * Specifies the series to which the point belongs.
+   */
+  series: any;
+
+  /**
+   * Specifies the value of the point.
+   */
+  value: any;
+
+  /**
+   * Defines the index of the point in the series.
+   */
+  index: number;
+}

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

@@ -0,0 +1,37 @@
+import { Chart } from '../chart';
+import { drawing, geometry } from '@progress/kendo-drawing';
+
+/**
+ * Represents the context for the error bars `visual` function.
+ */
+export interface ErrorBarsVisualArgs<TChart = Chart> {
+  /**
+   * Specifies a function that gets the default visual.
+   */
+  createVisual: () => drawing.Element;
+
+  /**
+   * Specifies the high value of the error bar.
+   */
+  high: number;
+
+  /**
+   * Specifies the low value of the error bar.
+   */
+  low: number;
+
+  /**
+   * Specifies the `options` object of the error bar.
+   */
+  options: any;
+
+  /**
+   * Specifies the rectangle that defines the normal position of the visual.
+   */
+  rect: geometry.Rect;
+
+  /**
+   * Specifies the instance of the Chart component.
+   */
+  sender: TChart;
+}

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

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

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

@@ -0,0 +1,63 @@
+import { Chart } from '../chart';
+import { drawing, geometry } from '@progress/kendo-drawing';
+
+/**
+ * Represents the context for the point highlight `visual` function.
+ */
+export interface HighlightVisualArgs<TChart = Chart> {
+  /**
+   * Specifies the category of the point.
+   */
+  category: any;
+
+  /**
+   * Specifies a function that gets the default visual element.
+   */
+  createVisual: () => drawing.Element;
+
+  /**
+   * Provides the data item associated with the point.
+   */
+  dataItem: any;
+
+  /**
+   * Defines the options for the point.
+   */
+  options: any;
+
+  /**
+   * Represents the value of the point as a percentage. Available only for the Donut, Pie, and 100% Stacked series.
+   */
+  percentage?: number;
+
+  /**
+   * Specifies the rectangle that defines the normal position of the visual.
+   */
+  rect: geometry.Rect;
+
+  /**
+   * Specifies the sum of point values since the last `runningTotal` summary point. Available for the Waterfall series.
+   */
+  runningTotal?: number;
+
+  /**
+   * Specifies the instance of the Chart component.
+   */
+  sender: TChart;
+
+  /**
+   * Specifies the series to which the point belongs.
+   */
+  series: any;
+
+  /**
+   * Specifies the sum of all previous series values.
+   * Available for the Waterfall series.
+   */
+  total?: number;
+
+  /**
+   * Represents the value of the point.
+   */
+  value: any;
+}

package/dist/npm/argument-types/legend-item-visual-args.interface.d.ts

@@ -0,0 +1,43 @@
+import { Chart } from '../chart';
+import { drawing } from '@progress/kendo-drawing';
+
+/**
+ * Represents the context for the legend item `visual` function.
+ * {% platform_content angular %}
+ * See the [Custom Marker Shapes](https://www.telerik.com/kendo-angular-ui/components/charts/elements/legend#custom-marker-shapes) example.
+ * {% endplatform_content %}
+ */
+export interface LegendItemVisualArgs<TChart = Chart> {
+
+  /**
+   * Indicates if the legend item is active.
+   * Depends on whether the associated point or series is visible.
+   */
+  active: boolean;
+
+  /**
+   * Specifies a function that gets the default visual.
+   */
+  createVisual: () => drawing.Element;
+
+  /**
+   * Specifies the options of the legend item.
+   */
+  options: any;
+
+  /**
+   * Specifies the index of the point in the series.
+   * Available for the Donut, Pie, and Funnel series.
+   */
+  pointIndex: any;
+
+  /**
+   * Specifies the instance of the Chart component.
+   */
+  sender: TChart;
+
+  /**
+   * Specifies the item series.
+   */
+  series: any;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Represents the context for the legend label `content` function.
+ */
+export interface LegendLabelsContentArgs {
+  /**
+   * Specifies the text of the legend item.
+   */
+  text: string;
+
+  /**
+   * Specifies the series configuration object.
+   */
+  series: any;
+
+  /**
+   * Specifies the point value of the Donut and Pie charts.
+   */
+  value?: any;
+
+  /**
+   * Specifies the point value represented as a percentage.
+   * Available only for the Donut, Pie, Funnel and Pyramid charts.
+   */
+  percentage?: number;
+
+  /**
+   * Specifies the data item associated with the point.
+   * Available only for the Donut, Pie, Funnel and Pyramid charts.
+   */
+  dataItem?: any;
+}

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

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

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

@@ -0,0 +1,32 @@
+import { Chart } from '../chart';
+import { drawing, geometry } from '@progress/kendo-drawing';
+
+/**
+ * Represents the context for the `visual` function of the plot bands label.
+ */
+export interface PlotBandLabelVisualArgs<TChart = Chart> {
+  /**
+   * Specifies a function that gets the default visual.
+   */
+  createVisual: () => drawing.Element;
+
+  /**
+   * Specifies the options of the label.
+   */
+  options: any;
+
+  /**
+   * Specifies the rectangle that defines the normal position of the visual.
+   */
+  rect: geometry.Rect;
+
+  /**
+   * Specifies the instance of the Chart component.
+   */
+  sender: TChart;
+
+  /**
+   * Specifies the text of the label.
+   */
+  text: string;
+}