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

package/dist/npm/field-types/note-position.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Specifies the position of a note.
+ *
+ * The possible values are:
+ * - `"top"`—Positions the note at the top of the axis.
+ * - `"bottom"`—Positions the note at the bottom of the axis.
+ * - `"left"`—Positions the note at the left of the axis.
+ * - `"right"`—Positions the note at the right of the axis.
+ *
+ * {% platform_content angular %}
+ * @example
+ * ```ts
+ * import { Component } from '@angular/core';
+ * import { NotePosition } from '@progress/kendo-angular-charts';
+ *
+ * _@Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-chart>
+ *       <kendo-chart-value-axis>
+ *         <kendo-chart-value-axis-item>
+ *           <kendo-chart-value-axis-item-notes [position]="position" [data]="[{ value: 1 }]">
+ *           </kendo-chart-value-axis-item-notes>
+ *         </kendo-chart-value-axis-item>
+ *       </kendo-chart-value-axis>
+ *     </kendo-chart>
+ *   `
+ * })
+ * class AppComponent {
+ *   public position: NotePosition = "right";
+ * }
+ *
+ * ```
+ * {% endplatform_content %}
+ * {% platform_content react %}
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartValueAxis,
+ *  ChartValueAxisItem
+ * } from '@progress/kendo-react-charts';
+ *
+ * const data = [{value: 1}];
+ * const position = "right";
+ *
+ * const ChartContainer = () => (
+ *  <Chart>
+ *    <ChartValueAxis>
+ *      <ChartValueAxisItem notes={{ data, position }} />
+ *    </ChartValueAxis>
+ *  </Chart>
+ * );
+ * ```
+ * {% endplatform_content %}
+ * {% platform_content vue %}
+ * @example
+ * ```jsx
+ *  <template>
+ *   <div>
+ *     <Chart>
+ *       <ChartValueAxis>
+ *         <ChartValueAxisItem :notes="valueNotes" />
+ *       </ChartValueAxis>
+ *     </Chart>
+ *   </div>
+ * </template>
+ *
+ * <script>
+ * import {
+ *   Chart,
+ *   ChartValueAxis,
+ *   ChartValueAxisItem,
+ * } from '@progress/kendo-vue-charts';
+ *
+ * export default {
+ *   components: {
+ *     Chart,
+ *     ChartValueAxis,
+ *     ChartValueAxisItem,
+ *   },
+ *   data: function () {
+ *     return {
+ *       valueNotes: {
+ *         data: [
+ *           {
+ *             value: 4,
+ *             text: 'Max',
+ *           },
+ *           {
+ *             value: 1,
+ *             text: 'Min',
+ *           },
+ *         ],
+ *         position: 'left',
+ *       },
+ *     };
+ *   },
+ * };
+ * </script>
+ * ```
+ * {% endplatform_content %}
+ */
+export type NotePosition = 'top' | 'bottom' | 'left' | 'right';

package/dist/npm/field-types/overlay.interface.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Specifies the appearance settings for the overlay of the series elements.
+ */
+export interface Overlay {
+  /**
+   * Specifies the gradient of the Chart series.
+   *
+   * The supported values are:
+   * * `"glass"`—Applicable for the Bar, Column, and Candlestick series.
+   * * `"none"`
+   * * `"roundedBevel"`—Applicable for the Donut and Pie series.
+   * * `"sharpBevel"`—Applicable for the Donut and Pie series.
+   */
+  gradient?: 'glass' | 'none' | 'roundedBevel' | 'sharpBevel';
+}

package/dist/npm/field-types/padding.interface.d.ts

@@ -1,7 +1,17 @@
 import { Margin } from './margin.interface';
+/* eslint-disable @typescript-eslint/no-empty-interface */
 
 /**
- * The padding size for each side.
+ * Specifies the padding configuration for each side of the element.
+ * {% platform_content angular %}
+ * See the [Labels](https://www.telerik.com/kendo-angular-ui/components/charts/elements/labels) example.
+ * {% endplatform_content %}
+ * {% platform_content react %}
+ * See the [Labels](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/labels) example.
+ * {% endplatform_content %}
+ * {% platform_content vue %}
+ * See the [Labels](https://www.telerik.com/kendo-vue-ui/components/charts/elements/labels) example.
+ * {% endplatform_content %}
  */
 export interface Padding extends Margin {
 }

package/dist/npm/field-types/plot-band-label.interface.d.ts

@@ -0,0 +1,100 @@
+import { drawing } from '@progress/kendo-drawing';
+import { PlotBandLabelVisualArgs } from '../property-types';
+import { Border } from './border.interface';
+import { Margin } from './margin.interface';
+import { Padding } from './padding.interface';
+
+/**
+ * Specifies the appearance configuration for the plot band label.
+ */
+export interface PlotBandLabel {
+    /**
+     * Specifies the horizontal alignment of the label text.
+     *
+     * By default, the label is aligned to the left.
+     *
+     * The supported values are:
+     * - `"center"`—The label is positioned in the center of the plot band.
+     * - `"right"`—The label is positioned on the right side of the plot band.
+     * - `"left"`—The label is positioned on the left side of the plot band.
+     */
+    align?: 'center' | 'right' | 'left';
+
+    /**
+     * Specifies the background color of the label. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+
+    /**
+     * Specifies the border of the label.
+     */
+    border?: Border;
+
+    /**
+     * Specifies the color of the plot band label text.
+     * Accepts a valid [CSS `color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
+     * configuration string, including hex and rgb.
+     */
+    color?: string;
+
+    /**
+     * Specifies the font of the plot band label text.
+     * Accepts a valid [CSS `font`](https://developer.mozilla.org/en-US/docs/Web/CSS/font)
+     * configuration string.
+     */
+    font?: string;
+
+    /**
+     * Specifies the margin of the label. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+
+    /**
+     * Specifies the padding of the label. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+
+    /**
+     * Specifies the vertical position of the label inside the plot band.
+     *
+     * By default, the label is aligned to the top.
+     *
+     * The supported values are:
+     * - `"bottom"`—The label is positioned on the bottom of the plot band.
+     * - `"center"`—The label is positioned in the center of the plot band.
+     * - `"top"`—The label is positioned on the top of the plot band.
+     */
+    position?: 'bottom' | 'center' | 'top';
+
+    /**
+     * Specifies the rotation angle of the label. By default, the label is not rotated.
+     */
+    rotation?: number;
+
+    /**
+     * Specifies the text of the label.
+     *
+     * You can split the text into multiple lines by using line feed characters ("\n").
+     */
+    text?: string;
+
+    /**
+     * Determines whether to display the plot band label.
+     * By default, the plot band labels are not displayed.
+     */
+    visible?: boolean;
+
+    /**
+     * Specifies a function that can be used to create a custom visual for the label.
+     *
+     * The available argument fields are:
+     *
+     * - `text`—The label text.
+     * - `rect`—The geometry rectangle that defines where the visual has to be rendered.
+     * - `options`—The label options.
+     * - `createVisual`—A function that can be used to get the default visual.
+     * - `sender`—A reference to the Chart instance.
+     */
+    visual?: (e: PlotBandLabelVisualArgs) => drawing.Element;
+}
+

package/dist/npm/field-types/plot-band.interface.d.ts

@@ -0,0 +1,53 @@
+import { PlotBandLabel } from './plot-band-label.interface';
+
+/**
+ * A plot band.
+ *
+ * {% platform_content angular %}
+ * See the [Plot Bands example](https://www.telerik.com/kendo-angular-ui/components/charts/elements/plot-bands).
+ * {% endplatform_content %}
+ * {% platform_content react %}
+ * See the [Plot Bands example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-bands).
+ * {% endplatform_content %}
+ * {% platform_content vue %}
+ * See the [Plot Bands example](https://www.telerik.com/kendo-vue-ui/components/charts/chart/elements/plot-bands).
+ * {% endplatform_content %}
+ */
+export interface PlotBand {
+    /**
+     * Specifies the color of the plot band.
+     */
+    color?: string;
+
+    /**
+     * Specifies the start position of the plot band in axis units.
+     */
+    from?: number | Date;
+
+    /**
+     * Specifies the opacity of the plot band.
+     */
+    opacity?: number;
+
+    /**
+     * Specifies the end position of the plot band in axis units.
+     */
+    to?: number | Date;
+
+    /**
+     * Specifies the label configuration of the plot band.
+     *
+     * To display a label, set the text option.
+     *
+     * {% platform_content angular %}
+     * See [Plot Bands - Labels](https://www.telerik.com/kendo-angular-ui/components/charts/elements/plot-bands#labels) for sample usage.
+     * {% endplatform_content %}
+     * {% platform_content react %}
+     * See [Plot Bands - Labels](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-bands#toc-labels) for sample usage.
+     * {% endplatform_content %}
+     * {% platform_content vue %}
+     * See [Plot Bands - Labels](https://www.telerik.com/kendo-vue-ui/components/charts/elements/plot-bands#labels) for sample usage.
+     * {% endplatform_content %}
+     */
+    label?: PlotBandLabel;
+}

package/dist/npm/field-types/series-labels-alignment.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Specifies the alignment of the label when series type is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
+ *
+ * The supported values for `"donut"` and `"pie"` are:
+ *
+ * - `"circle"`—Positions the labels in circle around the Chart.
+ * - `"column"`—Positions the labels in columns to the left and right of the Chart.
+ *
+ * The supported values for `"funnel"` and `"pyramid"` are:
+ *
+ * - `"center"`—Positions the labels in the center over the segment.
+ * - `"right"`—Positions the labels on the right side of the Chart and, if there is enough space, do not overlap the segments.
+ * - `"left"`—Positions the labels on the left side of the Chart and, if there is enough space, do not overlap the segments.
+ *
+ */
+export type SeriesLabelsAlignment = 'circle' | 'column' | 'center' | 'right' | 'left';

package/dist/npm/field-types/series-labels-position.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Specifies the position of the series labels.
+ *
+ * - `"above"`—Positions the label at the top of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"below"`—Positions the label at the bottom of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"center"`—Positions the label at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, Pyramid, RadarColumn, and Waterfall series.
+ * - `"insideBase"`—Positions the label inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
+ * - `"insideEnd"`—Positions the label inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
+ * - `"left"`—Positions the label to the left of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"outsideEnd"`—Positions the label outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
+ * - `"right"`—Positions the label to the right of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"top"`—Positions the label at the top of the segment. Applicable for the Funnel and Pyramid series.
+ * - `"bottom"`—Positions the label at the bottom of the segment. Applicable for the Funnel and Pyramid series.
+ * - `"auto"`—Positions the from and to labels at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
+ *
+ */
+export type SeriesLabelsPosition =
+    | 'auto'
+    | 'above'
+    | 'below'
+    | 'center'
+    | 'insideBase'
+    | 'insideEnd'
+    | 'left'
+    | 'outsideEnd'
+    | 'right'
+    | 'top'
+    | 'bottom';

package/dist/npm/field-types/series-line.interface.d.ts

@@ -0,0 +1,32 @@
+import { LineStyle } from './line-style';
+
+/**
+ * The appearance settings for the line of the Area, Candlestick, OHLC, and Waterfall series.
+ */
+export interface SeriesLine {
+    /**
+     * The color of the line. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+
+    /**
+     * The line opacity. By default, the line is opaque (`opacity: 1`).
+     */
+    opacity?: number;
+
+    /**
+     * The drawing style of the line. Applicable for the Area, Range Area, Polar Area, and Radar Area series.
+     *
+     * The supported values are:
+     * * `"normal" (default)`—The values are connected with a straight line.
+     * * `"step"`—The values are connected with a right-angled line. Supported only for the Area and Range Area series.
+     * * `"smooth"`—The values are connected with a smooth line.
+     */
+    style?: LineStyle;
+
+    /**
+     * The line width in pixels.
+     * By default, the width is set to `0` and the line is not visible.
+     */
+    width?: number;
+}

package/dist/npm/field-types/series-mean.interface.d.ts

@@ -0,0 +1,26 @@
+import { DashType } from './dash-type';
+
+/**
+ * Specifies the appearance settings for the BoxPlot mean value indicator (line).
+ */
+export interface SeriesMean {
+    /**
+     * Specifies the color of the line. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+
+    /**
+     * Specifies the dash type of the line. By default, the line is dashed (`dashType: "dash"`).
+     */
+    dashType?: DashType;
+
+    /**
+     * Specifies the line opacity. By default, the line is opaque (`opacity: "1"`).
+     */
+    opacity?: number;
+
+    /**
+     * Specifies the width (in pixels) of the line. By default, the line is 2px wide.
+     */
+    width?: number;
+}

package/dist/npm/field-types/series-median.interface.d.ts

@@ -0,0 +1,26 @@
+import { DashType } from './dash-type';
+
+/**
+ * Specifies the appearance settings for the BoxPlot median value indicator (line).
+ */
+export interface SeriesMedian {
+    /**
+     * Specifies the color of the line. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+
+    /**
+     * Specifies the dash type of the line. By default, the line is dashed (`dashType: "dash"`).
+     */
+    dashType?: DashType;
+
+    /**
+     * Specifies the line opacity. By default, the line is opaque (`opacity: "1"`).
+     */
+    opacity?: number;
+
+    /**
+     * Specifies the width (in pixels) of the line. By default, the line is 2px wide.
+     */
+    width?: number;
+}

package/dist/npm/field-types/series-pattern.interface.d.ts

@@ -1,67 +1,77 @@
-import {
-	VerticalStripesPatternOptions,
-	DiagonalStripesPatternOptions,
-	CrosshatchPatternOptions,
-	GridPatternOptions,
-	DotsPatternOptions
-} from '@progress/kendo-drawing';
-
-/**
- * Represents the VerticalStripesPattern of the series.
- */
-export interface VerticalStripesPattern extends VerticalStripesPatternOptions {
-	/**
-	 * The type of the pattern.
-	 */
-	type: 'verticalStripes';
-}
-
-/**
- * Represents the CrosshatchPattern of the series.
- */
-export interface CrosshatchPattern extends CrosshatchPatternOptions {
-	/**
-	 * The type of the pattern.
-	 */
-	type: 'crosshatch';
-}
-
-/**
- * Represents the DiagonalStripesPattern of the series.
- */
-export interface DiagonalStripesPattern extends DiagonalStripesPatternOptions {
-	/**
-	 * The type of the pattern.
-	 */
-	type: 'diagonalStripes';
-}
-
-/**
- * Represents the GridPattern of the series.
- */
-export interface GridPattern extends GridPatternOptions {
-	/**
-	 * The type of the pattern.
-	 */
-	type: 'grid';
-}
-
-/**
- * Represents the DotsPattern of the series.
- */
-export interface DotsPattern extends DotsPatternOptions {
-	/**
-	 * The type of the pattern.
-	 */
-	type: 'dots';
-}
-
-/**
- * Represents the pattern option of the series.
- */
-export type SeriesPattern =
-	| VerticalStripesPattern
-	| CrosshatchPattern
-	| DiagonalStripesPattern
-	| GridPattern
-	| DotsPattern;
+import {
+    VerticalStripesPatternOptions,
+    DiagonalStripesPatternOptions,
+    CrosshatchPatternOptions,
+    GridPatternOptions,
+    DotsPatternOptions,
+} from '@progress/kendo-drawing';
+
+/**
+ * Represents the VerticalStripesPattern of the series.
+ */
+export interface VerticalStripesPattern extends VerticalStripesPatternOptions {
+    /**
+     * The type of the pattern.
+     */
+    type: 'verticalStripes';
+}
+
+/**
+ * Represents the CrosshatchPattern of the series.
+ */
+export interface CrosshatchPattern extends CrosshatchPatternOptions {
+    /**
+     * The type of the pattern.
+     */
+    type: 'crosshatch';
+}
+
+/**
+ * Represents the DiagonalStripesPattern of the series.
+ */
+export interface DiagonalStripesPattern extends DiagonalStripesPatternOptions {
+    /**
+     * The type of the pattern.
+     */
+    type: 'diagonalStripes';
+}
+
+/**
+ * Represents the GridPattern of the series.
+ */
+export interface GridPattern extends GridPatternOptions {
+    /**
+     * The type of the pattern.
+     */
+    type: 'grid';
+}
+
+/**
+ * Represents the DotsPattern of the series.
+ */
+export interface DotsPattern extends DotsPatternOptions {
+    /**
+     * The type of the pattern.
+     */
+    type: 'dots';
+}
+
+/**
+ * Represents the pattern option of the series.
+ *
+ * {% platform_content angular %}
+ * See the [Using Pattern Fills](https://www.telerik.com/kendo-angular-ui/components/charts/styling#using-pattern-fills) example.
+ * {% endplatform_content %}
+ * {% platform_content react %}
+ * See the [Using Pattern Fills](https://www.telerik.com/kendo-react-ui/components/charts/chart/styling#using-pattern-fills) example.
+ * {% endplatform_content %}
+ * {% platform_content vue %}
+ * See the [Using Pattern Fills](https://www.telerik.com/kendo-vue-ui/components/charts/chart/styling#using-pattern-fills) example.
+ * {% endplatform_content %}
+ */
+export type SeriesPattern =
+    | VerticalStripesPattern
+    | CrosshatchPattern
+    | DiagonalStripesPattern
+    | GridPattern
+    | DotsPattern;

package/dist/npm/field-types/series-stack.interface.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Specifies the configuration for Stacked series.
+ */
+export interface SeriesStack {
+    /**
+     * Specifies the optional stack group name.
+     * Use this option for the Bar and Column series.
+     */
+    group?: string;
+
+    /**
+     * Specifies the type of stack to plot.
+     *
+     * The supported types are:
+     * * `"normal"`—The value of the stack is the sum of all points in the category (or group).
+     * * `"100%"`—The value of the stack is always 100% (1.00). Points within the category (or group) are represented in percentage.
+     */
+    type?: 'normal' | '100%';
+}