@progress/kendo-vue-charts 3.5.0 → 3.5.1-dev.202208150613

package/dist/esm/field-types/auto-base-unit-steps.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/axis-labels-position.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The position of the axis labels.
+ *
+ * @example
+ * ```jsx
+ *  <Chart>
+ *    <ChartValueAxis>
+ *      <ChartValueAxisItem :labels="{ position: 'end' }"/>
+ *    </ChartValueAxis>
+ *  </Chart>
+ * );
+ *
+ * ```
+ */
+export declare type AxisLabelsPosition = 'start' | 'end' | 'onAxis' | '';

package/dist/esm/field-types/axis-labels-position.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/axis-line.interface.d.ts

@@ -0,0 +1,22 @@
+import { DashType } from './dash-type';
+/**
+ * The appearance settings for the axis lines. Affects the major and minor axis ticks, but not the grid lines (see the [basic usage example]({% slug api_charts_chartaxisdefaultsprops %})).
+ */
+export interface AxisLine {
+    /**
+     * The color of the lines. Accepts a valid CSS color string, including hex and rgb. Setting the `color` option affects the major and minor axis ticks, but not the grid lines.
+     */
+    color?: string;
+    /**
+     * The dash type of the line.
+     */
+    dashType?: DashType;
+    /**
+     * If set to `true`, the Chart displays the axis lines. By default, the axis lines are visible.
+     */
+    visible?: boolean;
+    /**
+     * The width of the line in pixels. Affects the major and minor axis ticks, but not the grid lines.
+     */
+    width?: number;
+}

package/dist/esm/field-types/axis-line.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/axis-ticks.interface.d.ts

@@ -0,0 +1,29 @@
+/**
+ * The appearance configuration for the major and minor axis ticks (see the [basic usage example]({% slug api_charts_chartaxisdefaultsprops %})).
+ */
+export interface AxisTicks {
+    /**
+     * The color of the tick lines. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The length of the tick line in pixels.
+     */
+    size?: number;
+    /**
+     * The number of ticks to skip at the beginning.
+     */
+    skip?: number;
+    /**
+     * The tick-rendering step. Renders every n<sup>th</sup> tick, where `n` is the step.
+     */
+    step?: number;
+    /**
+     * If set to `true,` the Chart displays the axis ticks. By default, only the major axis ticks are visible.
+     */
+    visible?: boolean;
+    /**
+     * The width of the ticks in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/axis-ticks.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/axis-title-position.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The position of an axis title.
+ *
+ * @example
+ * ```jsx
+ *  <Chart>
+ *    <ChartValueAxis>
+ *      <ChartValueAxisItem :title="{ text: 'Title', position: 'top' }"/>
+ *    </ChartValueAxis>
+ *  </Chart>
+ *
+ * ```
+ */
+export declare type AxisTitlePosition = 'top' | 'bottom' | 'left' | 'right' | 'center';

package/dist/esm/field-types/axis-title-position.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/base-unit.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The `baseUnit` type of an X or Y axis.
+ *
+ * @example
+ * ```jsx
+ *  <Chart>
+ *    <ChartXAxis>
+ *     <ChartXAxisItem :base-unit="baseUnit" />
+ *    </ChartXAxis>
+ *    <ChartSeries>
+ *      <ChartSeriesItem :type="'scatter'" :data-items="data" />
+ *    </ChartSeries>
+ *  </Chart>
+ * ```
+ */
+export declare type BaseUnit = 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';

package/dist/esm/field-types/base-unit.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/border.interface.d.ts

@@ -0,0 +1,18 @@
+import { DashType } from './dash-type';
+/**
+ * The appearance settings for the border lines (see the [basic usage example]({% slug  api_charts_charttitleprops %})).
+ */
+export interface Border {
+    /**
+     * The color of the border line. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The dash type of the border line.
+     */
+    dashType?: DashType;
+    /**
+     * The width of the border line in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/border.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/bullet-target-line.interface.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The appearance settings for the target line of the Bullet series.
+ */
+export interface BulletTargetLine {
+    /**
+     * The width of the Bullet target line in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/bullet-target-line.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/bullet-target.interface.d.ts

@@ -0,0 +1,19 @@
+import { Border } from './border.interface';
+import { BulletTargetLine } from './bullet-target-line.interface';
+/**
+ * The appearance settings for the target of the Bullet series.
+ */
+export interface BulletTarget {
+    /**
+     * The width of the border in pixels. By default, the border width is set to `zero`, which means that the border is not visible.
+     */
+    border?: Border;
+    /**
+     * The target color.
+     */
+    color?: string;
+    /**
+     * The appearance settings for the target line of the Bullet series.
+     */
+    line?: BulletTargetLine;
+}

package/dist/esm/field-types/bullet-target.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/category-base-unit.d.ts

@@ -0,0 +1,47 @@
+import { BaseUnit } from './base-unit';
+/**
+ * The `baseUnit` type of the category axis.
+ *
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartCategoryAxis,
+ *  ChartCategoryAxisItem,
+ *  ChartSeries,
+ *  ChartSeriesItem
+ * } from '@progress/kendo-vue-charts';
+ *
+ * <template>
+ *  <Chart>
+ *    <ChartCategoryAxis>
+ *     <ChartCategoryAxisItem :base-unit="baseUnit" />
+ *    </ChartCategoryAxis>
+ *    <ChartSeries>
+ *      <ChartSeriesItem :category-field="category" :data-items="dataItems" />
+ *    </ChartSeries>
+ *  </Chart>
+ * </template>
+ * <script>
+ * export default {
+ *   components: {
+ *       Chart,
+ *       ChartCategoryAxis,
+ *       ChartCategoryAxisItem,
+ *       ChartSeries,
+ *       ChartSeriesItem
+ *   },
+ *   data () {
+ *       return {
+ *          baseUnit: "months",
+ *          dataItems: [
+ *              { category: new Date(2000, 0, 1), value: 1 },
+ *              { category: new Date(2001, 0, 1), value: 1}
+ *          ]
+ *       };
+ *   }
+ * }
+ * </script>
+ * ```
+ */
+export declare type CategoryBaseUnit = BaseUnit | 'auto' | 'fit';

package/dist/esm/field-types/category-base-unit.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/dash-type.d.ts

@@ -0,0 +1,35 @@
+/**
+ * The dash line type.
+ *
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartSeries,
+ *  ChartSeriesItem
+ * } from '@progress/kendo-vue-charts';
+ *
+ * <template>
+ *  <Chart>
+ *    <ChartSeries>
+ *      <ChartSeriesItem :type="'line'" :data-items="dataItems" :dash-type="'dot'" />
+ *    </ChartSeries>
+ *  </Chart>
+ *  </template>
+ * <script>
+ * export default {
+ *   components: {
+ *      Chart,
+ *      ChartSeries,
+ *      ChartSeriesItem
+ *   },
+ *   data () {
+ *       return {
+ *          data: [1, 2, 3]
+ *       };
+ *   }
+ * }
+ * </script>
+ * ```
+ */
+export declare type DashType = 'dash' | 'dashDot' | 'dot' | 'longDash' | 'longDashDot' | 'longDashDotDot' | 'solid';

package/dist/esm/field-types/dash-type.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/date-formats.interface.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The format that is used to display the labels when they are dates.
+ *
+ * The Chart selects the appropriate format for the current `baseUnit`. Setting the `format` option of the labels overrides the date formats.
+ */
+export interface DateFormats {
+    /**
+     * The provided format when the axis `baseUnit` is set to `"milliseconds"`.
+     */
+    milliseconds?: string;
+    /**
+     * The provided format when the axis `baseUnit` is set to `"seconds"`.
+     */
+    seconds?: string;
+    /**
+     * The provided format when the axis `baseUnit` is set to `"minutes"`.
+     */
+    minutes?: string;
+    /**
+     * The provided format when the axis `baseUnit` is set to `"hours"`.
+     */
+    hours?: string;
+    /**
+     * The provided format when the axis `baseUnit` is set to `"days"`.
+     */
+    days?: string;
+    /**
+     * The provided format when the axis `baseUnit` is set to `"weeks"`.
+     */
+    weeks?: string;
+    /**
+     * The provided format when the axis `baseUnit` is set to `"months"`.
+     */
+    months?: string;
+    /**
+     * The provided format when the axis `baseUnit` is set to `"years"`.
+     */
+    years?: string;
+}

package/dist/esm/field-types/date-formats.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/drag-action.interface.d.ts

@@ -0,0 +1,15 @@
+import { LockAxis } from './lock-axis';
+import { ModifierKey } from './modifier-key';
+/**
+ * Configures the drag behavior during the pan and zoom operations.
+ */
+export interface DragAction {
+    /**
+     * Specifies a keyboard key that has to be pressed to activate the gesture.
+     */
+    key?: ModifierKey;
+    /**
+     * Specifies an axis that will not be panned or zoomed.
+     */
+    lock?: LockAxis;
+}

package/dist/esm/field-types/drag-action.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/error-bar-line.interface.d.ts

@@ -0,0 +1,14 @@
+import { DashType } from './dash-type';
+/**
+ * The appearance settings for the error bar lines.
+ */
+export interface ErrorBarLine {
+    /**
+     * The dash type of the line.
+     */
+    dashType?: DashType;
+    /**
+     * The width of the line in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/error-bar-line.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/grid-lines.interface.d.ts

@@ -0,0 +1,30 @@
+import { DashType } from './dash-type';
+/**
+ * The appearance configuration for the major and minor axis grid lines (see the [basic usage example]({% slug api_charts_chartaxisdefaultsprops %})).
+ */
+export interface GridLines {
+    /**
+     * The color of the grid lines. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The dash type of the grid lines.
+     */
+    dashType?: DashType;
+    /**
+     * The number of lines to skip at the beginning.
+     */
+    skip?: number;
+    /**
+     * The tick-rendering step. Renders every n<sup>th</sup> line, where `n` is the step.
+     */
+    step?: number;
+    /**
+     * If set to `true`, the Chart displays the lines. By default, only the major axis grid lines are visible.
+     */
+    visible?: boolean;
+    /**
+     * The width of the lines in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/grid-lines.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/highlight-line.interface.d.ts

@@ -0,0 +1,22 @@
+import { DashType } from './dash-type';
+/**
+ * The appearance settings for the highlight line of the Candlestick and OHLC series.
+ */
+export interface HighlightLine {
+    /**
+     * The color of the highlighted line. Accepts a valid CSS color string, including hex and rgb. The default color is computed from the base-point color.
+     */
+    color?: string;
+    /**
+     * The dash type of the line.
+     */
+    dashType?: DashType;
+    /**
+     * The opacity of the line. By default, the border is opaque (`opacity = 1`).
+     */
+    opacity?: number;
+    /**
+     * The width of the line in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/highlight-line.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/label-connectors.interface.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The appearance settings for the label connectors on the Donut and Pie series.
+ */
+export interface LabelConnectors {
+    /**
+     * The color of the connecting line. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The distance between the connector line and the main chart.
+     */
+    padding?: number;
+    /**
+     * The width of the connector line in pixels.
+     */
+    width?: number;
+}

package/dist/esm/field-types/label-connectors.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/label-rotation.interface.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The rotation configuration for the axis labels.
+ */
+export interface LabelRotation {
+    /**
+     * The alignment of the rotated labels relative to the slot center.
+     *
+     * The supported values are:
+     * * `"end"`
+     * * `"center"`
+     *
+     * By default, the Charts align the closest end of the label to the center. If set to `"center"`, the center of the rotated label will be aligned instead.
+     */
+    align?: 'end' | 'center';
+    /**
+     * The rotation angle of the labels. By default, the labels are not rotated. Can be set to `"auto"`. In this case, the labels will be rotated only if the slot size is not sufficient for the entire labels.
+     */
+    angle?: number | 'auto';
+}

package/dist/esm/field-types/label-rotation.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/legend-labels.interface.d.ts

@@ -0,0 +1,28 @@
+import { LegendLabelsContentArgs } from '../argument-types/legend-labels-content-args.interface';
+import { Margin } from './margin.interface';
+import { Padding } from './padding.interface';
+/**
+ * The appearance configuration for the legend labels.
+ */
+export interface LegendLabels {
+    /**
+     * The color of the legend 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;
+    /**
+     * The font of the legend label text. Accepts a valid [CSS `font`](https://developer.mozilla.org/en-US/docs/Web/CSS/font) configuration string.
+     */
+    font?: string;
+    /**
+     * The margin of the labels. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The padding of the labels. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * A function used to generate the content of each label.
+     */
+    content?: (e: LegendLabelsContentArgs) => string;
+}

package/dist/esm/field-types/legend-labels.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/line-style.d.ts

@@ -0,0 +1,35 @@
+/**
+ * The line style of the series.
+ *
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartSeries,
+ *  ChartSeriesItem
+ * } from '@progress/kendo-vue-charts';
+ *
+ * <template>
+ *  <Chart>
+ *    <ChartSeries>
+ *      <ChartSeriesItem :type="'line'" :data-items="dataItems" :item-style="'smooth'" />
+ *    </ChartSeries>
+ *  </Chart>
+ *  </template>
+ * <script>
+ * export default {
+ *   components: {
+ *      Chart,
+ *      ChartSeries,
+ *      ChartSeriesItem
+ *   },
+ *   data () {
+ *       return {
+ *          dataItems: [1, 2, 3]
+ *       };
+ *   }
+ * }
+ * </script>
+ * ```
+ */
+export declare type LineStyle = 'normal' | 'step' | 'smooth';

package/dist/esm/field-types/line-style.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/lock-axis.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Specifies an axis for locking during the pan and zoom operations.
+ */
+export declare type LockAxis = 'none' | 'x' | 'y';

package/dist/esm/field-types/lock-axis.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/margin.interface.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The margin configuration for each side.
+ */
+export interface Margin {
+    /**
+     * The top margin in pixels.
+     */
+    top?: number;
+    /**
+     * The right margin in pixels.
+     */
+    right?: number;
+    /**
+     * The bottom margin in pixels.
+     */
+    bottom?: number;
+    /**
+     * The left margin in pixels.
+     */
+    left?: number;
+}

package/dist/esm/field-types/margin.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/marker-type.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Specifies the marker type.
+ *
+ * @example
+ * ```jsx
+ * import {
+ *  Chart,
+ *  ChartSeries,
+ *  ChartSeriesItem
+ * } from '@progress/kendo-vue-charts';
+ *
+ * <template>
+ *  <Chart>
+ *    <ChartSeries>
+ *      <ChartSeriesItem :type="'line'" :data-items="dataItems" :markers="markerType" />
+ *    </ChartSeries>
+ *  </Chart>
+ *  </template>
+ * <script>
+ * export default {
+ *   components: {
+ *      Chart,
+ *      ChartSeries,
+ *      ChartSeriesItem
+ *   },
+ *   data () {
+ *       return {
+ *          dataItems: [1, 2, 3],
+ *          markerType: { type: "cross" }
+ *       };
+ *   }
+ * }
+ * </script>
+ * ```
+ */
+export declare type MarkerType = 'square' | 'circle' | 'triangle' | 'cross';

package/dist/esm/field-types/marker-type.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/modifier-key.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Specifies a modifier key.
+ */
+export declare type ModifierKey = 'none' | 'ctrl' | 'shift' | 'alt';

package/dist/esm/field-types/modifier-key.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/field-types/mousewheel-select.interface.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Configuration of the mousewheel action for selection.
+ */
+export interface MousewheelSelect {
+    /**
+     * If set to `true`, the option reverses the mousewheel direction. For `"zoom out"`, the regular direction is down. For `"zoom in"`, the regular direction is up.
+     */
+    reverse?: boolean;
+    /**
+     * The zoom direction of the selection.
+     *
+     * The supported values are:
+     * * `"both"`—Zooming expands and contracts the selection on both sides.
+     * * `"left"`—Zooming expands and contracts the selection on the left side only.
+     * * `"right"`—Zooming expands and contracts the selection on the right side only.
+     */
+    zoom?: 'both' | 'left' | 'right';
+}

package/dist/esm/field-types/mousewheel-select.interface.js

@@ -0,0 +1,2 @@
+export {};
+// tslint:enable:max-line-length

package/dist/esm/field-types/mousewheel-zoom.interface.d.ts

@@ -0,0 +1,10 @@
+import { LockAxis } from './lock-axis';
+/**
+ * The configuration of the mousewheel action for zooming.
+ */
+export interface MousewheelZoom {
+    /**
+     * Specifies an axis that will not be zoomed.
+     */
+    lock?: LockAxis;
+}