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

package/dist/esm/option-types/category-axis-item/title.interface.d.ts

@@ -0,0 +1,65 @@
+import { drawing } from '@progress/kendo-drawing';
+import { AxisTitlePosition, Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface CategoryAxisTitle {
+    /**
+     * The background color of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the title.
+     */
+    border?: Border;
+    /**
+     * The text color of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The font style of the title.
+     */
+    font?: string;
+    /**
+     * The margin of the title. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The padding of the title. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * The position of the title.
+     *
+     * The supported values are:
+     * - `"top"`—The axis title is positioned on the top (applicable to the vertical axis).
+     * - `"bottom"`—The axis title is positioned on the bottom (applicable to the vertical axis).
+     * - `"left"`—The axis title is positioned on the left (applicable to the horizontal axis).
+     * - `"right"`—The axis title is positioned on the right (applicable to the horizontal axis).
+     * - `"center"`—The axis title is positioned in the center.
+     */
+    position?: AxisTitlePosition | string;
+    /**
+     * The rotation angle of the title. By default, the title is not rotated.
+     */
+    rotation?: number;
+    /**
+     * The text of the title. The text can be split into multiple lines by using the line feed characters (`"\n"`).
+     */
+    text?: string;
+    /**
+     * If set to `true`, the Chart displays the category axis title. By default, the category axis title is visible.
+     */
+    visible?: boolean;
+    /**
+     * A function that can be used to create a custom visual for the title.
+     *
+     * The available argument fields are:
+     * - `text`—The label text.
+     * - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
+     * - `sender`—The Chart instance (can be `undefined`).
+     * - `options`—The label options.
+     * - `createVisual`—A function for getting the default visual.
+     */
+    visual?: (e: TitleVisualArgs) => drawing.Element;
+}

package/dist/esm/option-types/category-axis-item/title.interface.js

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

package/dist/esm/option-types/category-axis-item.interface.d.ts

@@ -0,0 +1,159 @@
+import { AutoBaseUnitSteps, AxisLine, AxisTicks, CategoryBaseUnit, GridLines, PlotBand, WeekStartDay } from '../common/property-types';
+import { CategoryAxisCrosshair } from './category-axis-item/crosshair.interface';
+import { CategoryAxisLabels } from './category-axis-item/labels.interface';
+import { CategoryAxisNotes } from './category-axis-item/notes.interface';
+import { CategoryAxisRangeLabels } from './category-axis-item/range-labels.interface';
+import { CategoryAxisSelect } from './category-axis-item/select.interface';
+import { CategoryAxisTitle } from './category-axis-item/title.interface';
+/**
+ * @hidden
+ */
+export interface CategoryAxis {
+    /**
+     * The time-interval steps when `baseUnit` is set either to `"fit"` or `"auto"`. The axis will try to divide the active period into the smallest possible units that yield `maxDateGroups` or less discrete intervals.
+     */
+    autoBaseUnitSteps?: AutoBaseUnitSteps;
+    /**
+     * The category index or the date (for date category axis) at which the first value axis crosses this axis. The category indices or the date (for date category axis) at which the value axes cross the category axis (when set as an array). To denote the far end of the axis, set an index greater than or equal to the number of categories.
+     */
+    axisCrossingValue?: any | any[];
+    /**
+     * The background color of the axis.
+     */
+    background?: string;
+    /**
+     * The base time interval for the date axis ([see example]({% slug axes_chart_charts %}#toc-selecting-time-intervals)). The default base unit is automatically determined by the minimum difference between subsequent categories.
+     *
+     * The supported values are:
+     * - `"fit"`
+     * - `"milliseconds"`
+     * - `"seconds"`
+     * - `"minutes"`
+     * - `"hours"`
+     * - `"days"`
+     * - `"weeks"`
+     * - `"months"`
+     * - `"years"`
+     *
+     * Setting `baseUnit` to `"fit"` sets such a base unit and [`categoryAxis.baseUnitStep`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-baseunitstep) that the total number of categories does not exceed [`categoryAxis.maxDateGroups`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-maxdategroups).
+     *
+     * Series data is aggregated for the specified base unit by using the [`series.aggregate`]({% slug api_charts_chartseriesitemprops %}#toc-aggregate) function.
+     */
+    baseUnit?: string | CategoryBaseUnit;
+    /**
+     * The step (interval) between the categories in base units ([see example]({% slug axes_chart_charts %}#toc-selecting-time-intervals)). Setting it to `"auto"` sets the step to such a value that the total number of categories does not exceed [`categoryAxis.maxDateGroups`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-maxdategroups). The option is ignored if [`categoryAxis.baseUnit`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-baseunit) is set to `"fit"`.
+     */
+    baseUnitStep?: number | string;
+    /**
+     * The category names. The Chart creates a category for every item of the array.
+     */
+    categories?: any[];
+    /**
+     * The color to apply to all axis elements. Accepts a valid CSS color string, including hex and rgb. Can be overridden by [`categoryAxis.labels.color`]({% slug api_charts_chartcategoryaxislabelsprops %}#toc-color) and [`categoryAxis.line.color`]({% slug api_charts_axisline %}#toc-color).
+     */
+    color?: string;
+    /**
+     * If set to `true`, the Chart positions categories and series points on major ticks. This removes the empty space before and after the series. The default value is `false` except for `"area"`, `"verticalArea"`, `"rangeArea"`, and `"verticalRangeArea"`. The option is ignored if the [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) option is set to `"bar"`, `"column"`, `"boxPlot"`, `"ohlc"`, `"candlestick"`, or `"waterfall"`.
+     */
+    justified?: boolean;
+    /**
+     * The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.
+     */
+    line?: AxisLine;
+    /**
+     * The configuration of the major grid lines. These are the lines that are an extension of the major ticks through the body of the Chart.
+     */
+    majorGridLines?: GridLines;
+    /**
+     * The configuration of the category axis major ticks.
+     */
+    majorTicks?: AxisTicks;
+    /**
+     * The last date displayed on a date category axis or the index of the last category displayed on a category axis ([see example]({% slug appearance_chart_charts %}#toc-limiting-the-displayed-range)). By default, the max value is the same as the last category. This is often used in combination with the [`categoryAxis.min`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-min) and [`categoryAxis.roundToBaseUnit`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-roundtobaseunit) options to set up a fixed date range.
+     */
+    max?: any;
+    /**
+     * The maximum number of groups (categories) to display when [`categoryAxis.baseUnit`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-baseunit) is set to `"fit"` or [`categoryAxis.baseUnitStep`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-baseunitstep) is set to `"auto"`([see example]({% slug axes_chart_charts %}#toc-selecting-time-intervals)).
+     */
+    maxDateGroups?: number;
+    /**
+     * The maximum number of ticks and labels to display. Applicabable for date category axis ([see example]({% slug axes_chart_charts %}#toc-limiting-the-number-of-labels)).
+     */
+    maxDivisions?: number;
+    /**
+     * The first date which is displayed on a date category axis or the index of the first category which is displayed on a category axis ([see example]({% slug appearance_chart_charts %}#toc-limiting-the-displayed-range)). By default, the min value is the same as the first category. This is often used in combination with the [`categoryAxis.max`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-max) and [`categoryAxis.roundToBaseUnit`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-roundtobaseunit) options to set up a fixed date range.
+     */
+    min?: any;
+    /**
+     * The configuration of the minor grid lines. These are the lines that are an extension of the minor ticks through the body of the Chart.
+     */
+    minorGridLines?: GridLines;
+    /**
+     * The configuration of the category axis minor ticks.
+     */
+    minorTicks?: AxisTicks;
+    /**
+     * The unique axis name. Used to associate a series with a category axis, which utilizes the [`series.categoryAxis`]({% slug api_charts_chartseriesitemprops %}#toc-categoryaxis) option.
+     */
+    name?: string;
+    /**
+     * The configuration of the date axis date range labels.
+     */
+    rangeLabels?: CategoryAxisRangeLabels;
+    /**
+     * The name of the pane in which the category axis has to be rendered. If not set, the axis will be rendered in the first (default) pane.
+     */
+    pane?: string;
+    /**
+     * The plot bands of the category axis.
+     */
+    plotBands?: PlotBand[];
+    /**
+     * If set to `true`, the category axis direction is reversed. By default, categories are listed from left to right and from bottom to top.
+     */
+    reverse?: boolean;
+    /**
+     * If set to `true`, the Chart rounds the first and last date to the nearest base unit.
+     */
+    roundToBaseUnit?: boolean;
+    /**
+     * The angle (degrees) of the first category on the axis. Angles increase clockwise with zero to the left. Negative values are acceptable.
+     */
+    startAngle?: number;
+    /**
+     * The category axis type.
+     *
+     * The supported values are:
+     * - `"category"`—Discrete category axis.
+     * - `"date"`—Specialized axis for displaying chronological data.
+     */
+    type?: string;
+    /**
+     * If set to `true`, the Chart displays the category axis. By default, the category axis is visible.
+     */
+    visible?: boolean;
+    /**
+     * The week start day when the `baseUnit` is set to `"weeks"`.
+     */
+    weekStartDay?: WeekStartDay;
+    /**
+     * The configuration options of the crosshair. The crosshair is displayed when the [`categoryAxis.crosshair.visible`]({% slug api_charts_chartcategoryaxiscrosshairprops %}#toc-visible) option is set to `true`.
+     */
+    crosshair?: CategoryAxisCrosshair;
+    /**
+     * The configuration of the axis labels.
+     */
+    labels?: CategoryAxisLabels;
+    /**
+     * The configuration of the category axis notes.
+     */
+    notes?: CategoryAxisNotes;
+    /**
+     * The selected axis range ([see example]({% slug selection_chart_charts %})). If set, the axis selection is enabled. The range is index-based, starting from zero. Categories with indexes in the range (`select.from`, `select.to`) will be selected. That is, the last category in the range will not be included in the selection. If the categories are dates, the range has to be also specified with date values. Selection is only supported if the axis is horizontal.
+     */
+    select?: CategoryAxisSelect;
+    /**
+     * The title configuration of the category axis. To display the title, set the [`categoryAxis.title.text`]({% slug api_charts_chartcategoryaxisitemprops %}#toc-text) option.
+     */
+    title?: CategoryAxisTitle;
+}

package/dist/esm/option-types/category-axis-item.interface.js

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

package/dist/esm/option-types/chart-area.interface.d.ts

@@ -0,0 +1,30 @@
+import { Border, Margin } from '../common/property-types';
+/**
+ * @hidden
+ */
+export interface ChartingArea {
+    /**
+     * The background color of the Chart area. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the Chart area.
+     */
+    border?: Border;
+    /**
+     * The height of the Chart area.
+     */
+    height?: number;
+    /**
+     * The margin of the Chart area. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The background opacity of the Chart area. By default, the background is opaque.
+     */
+    opacity?: number;
+    /**
+     * The width of the Chart area.
+     */
+    width?: number;
+}

package/dist/esm/option-types/chart-area.interface.js

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

package/dist/esm/option-types/legend/inactive-items.interface.d.ts

@@ -0,0 +1,10 @@
+import { LegendLabels } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface LegendInactiveItems {
+    /**
+     * The label configuration of the Chart legend.
+     */
+    labels?: LegendLabels;
+}

package/dist/esm/option-types/legend/inactive-items.interface.js

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

package/dist/esm/option-types/legend/item.interface.d.ts

@@ -0,0 +1,21 @@
+import { drawing } from '@progress/kendo-drawing';
+import { LegendItemVisualArgs } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface LegendItem {
+    /**
+     * The cursor style of the legend item.
+     */
+    cursor?: string;
+    /**
+     * A function for creating a custom visual for the legend items.
+     *
+     * The available argument fields are:
+     * - `options`—The item options.
+     * - `createVisual`—A function for getting the default visual.
+     * - `series`—The item series.
+     * - `pointIndex`—The index of the point in the series. Available for the Pie, Donut, and Funnel series.
+     */
+    visual?: (e: LegendItemVisualArgs) => drawing.Element;
+}

package/dist/esm/option-types/legend/item.interface.js

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

package/dist/esm/option-types/legend/legend-title.interface.d.ts

@@ -0,0 +1,61 @@
+import { Element } from '@progress/kendo-drawing';
+import { Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface LegendTitle {
+    /**
+     * The alignment of the title.
+     *
+     * The available options are:
+     * - `"center"`—The text is aligned to the middle.
+     * - `"left"`—The text is aligned to the left.
+     * - `"right"`—The text is aligned to the right.
+     */
+    align?: 'center' | 'left' | 'right' | string;
+    /**
+     * The background color of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the title.
+     */
+    border?: Border;
+    /**
+     * The text color of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The font of the title.
+     */
+    font?: string;
+    /**
+     * The margin of the title. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The padding of the title. A numeric value sets all margins.
+     */
+    padding?: Padding | number;
+    /**
+     * The position of the title.
+     *
+     * The available options are:
+     * - `"bottom"`—The title is positioned beneath the legend.
+     * - `"top"`—The title is positioned above the legend.
+     */
+    position?: 'top' | 'bottom' | string;
+    /**
+     * The text of the title.
+     * You can split the text into multiple lines by using the line feed characters ("\n").
+     */
+    text?: string;
+    /**
+     * If set to `true`, the Chart displays the Legend title. By default, the title is displayed.
+     */
+    visible?: boolean;
+    /**
+     * A function for creating a custom visual for the title.
+     */
+    visual?: (args: TitleVisualArgs) => Element;
+}

package/dist/esm/option-types/legend/legend-title.interface.js

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

package/dist/esm/option-types/legend.interface.d.ts

@@ -0,0 +1,98 @@
+import { Border, LegendLabels, Margin, Padding } from '../common/property-types';
+import { LegendInactiveItems } from './legend/inactive-items.interface';
+import { LegendItem } from './legend/item.interface';
+import { LegendTitle } from './legend/legend-title.interface';
+/**
+ * @hidden
+ */
+export interface Legend {
+    /**
+     * The legend is horizontally aligned when [`legend.position`]({% slug api_charts_chartlegendprops %}#toc-position) is set to `"top"` or `"bottom"`. The legend is vertically aligned when [`legend.position`]({% slug api_charts_chartlegendprops %}#toc-position) is set to `"left"` or `"right"`.
+     *
+     * The supported values are:
+     * - `"start"`—The legend is aligned to the start.
+     * - `"center"`—The legend is aligned to the center.
+     * - `"end"`—The legend is aligned to the end.
+     */
+    align?: 'start' | 'center' | 'end' | string;
+    /**
+     * The background color of the legend. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the legend.
+     */
+    border?: Border;
+    /**
+     * The height of the legend when [`legend.orientation`]({% slug api_charts_chartlegendprops %}#toc-orientation) is set to `"vertical"`.
+     */
+    height?: number;
+    /**
+     * The label configuration of the Chart legend.
+     */
+    labels?: LegendLabels;
+    /**
+     * The margin of the Chart legend. A numeric value sets all paddings.
+     */
+    margin?: Margin | number;
+    /**
+     * The X offset of the Chart legend. The offset is relative to the default position of the legend. For example, a value of `20` moves the legend 20 pixels to the right of its initial position. Negative values move the legend to the left of its current position.
+     */
+    offsetX?: number;
+    /**
+     * The Y offset of the chart legend. The offset is relative to the current position of the legend. For example, a value of `20` moves the legend 20 pixels down from its initial position. Negative values move the legend upwards from its current position.
+     */
+    offsetY?: number;
+    /**
+     * The orientation of the legend items.
+     *
+     * The supported values are:
+     * - `"vertical"`—The legend items are added vertically.
+     * - `"horizontal"`—The legend items are added horizontally.
+     */
+    orientation?: 'vertical' | 'horizontal' | string;
+    /**
+     * The padding of the Chart legend. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * The positions of the Chart legend.
+     *
+     * The supported values are:
+     * - `"top"`—The legend is positioned on the top.
+     * - `"bottom"`—The legend is positioned on the bottom.
+     * - `"left"`—The legend is positioned on the left.
+     * - `"right"`—The legend is positioned on the right.
+     * - `"custom"`—The legend is positioned by using [`legend.offsetX`]({% slug api_charts_chartlegendprops %}#toc-offsetx) and [`legend.offsetY`]({% slug api_charts_chartlegendprops %}#toc-offsety).
+     */
+    position?: 'top' | 'bottom' | 'left' | 'right' | 'custom' | string;
+    /**
+     * If set to `true`, the legend items are reversed.
+     */
+    reverse?: boolean;
+    /**
+     * If set to `true`, the Chart displays the legend ([see example]({% slug legend_chart_charts %}#toc-hiding-the-legend)). By default, the Chart legend is visible.
+     */
+    visible?: boolean;
+    /**
+     * The legend width when the [`legend.orientation`]({% slug api_charts_chartlegendprops %}#toc-orientation) is set to `"horizontal"`.
+     */
+    width?: number;
+    /**
+     * The configuration of the Chart inactive legend items.
+     */
+    inactiveItems?: LegendInactiveItems;
+    /**
+     * The configuration of the Chart legend item.
+     */
+    item?: LegendItem;
+    /**
+     * The distance (in pixels) between the legend items. Defaults to 6.
+     */
+    spacing?: number;
+    /**
+     * The title of the Chart legend.
+     * By default, the Chart will not render a legend title.
+     */
+    title?: LegendTitle;
+}

package/dist/esm/option-types/legend.interface.js

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

package/dist/esm/option-types/navigator/hint.interface.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @hidden
+ */
+export interface NavigatorHint {
+    /**
+     * The function that returns the content of the hint.
+     *
+     * The available fields in the event argument are:
+     * - `from`—The lower boundary of the selected range.
+     * - `to`—The upper boundary of the selected range.
+     */
+    content?: (e: any) => string;
+    /**
+     * The format of the hint.
+     */
+    format?: string;
+    /**
+     * The visibility of the hint.
+     */
+    visible?: boolean;
+}

package/dist/esm/option-types/navigator/hint.interface.js

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

package/dist/esm/option-types/navigator/select.interface.d.ts

@@ -0,0 +1,18 @@
+import { MousewheelSelect } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface NavigatorSelect {
+    /**
+     * The lower boundary of the selected range.
+     */
+    from?: Date;
+    /**
+     * The configuration of the mousewheel selection. If set to `false`, the mousewheel does not update the selection.
+     */
+    mousewheel?: boolean | MousewheelSelect;
+    /**
+     * The upper boundary of the selected range.
+     */
+    to?: Date;
+}

package/dist/esm/option-types/navigator/select.interface.js

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

package/dist/esm/option-types/navigator.interface.d.ts

@@ -0,0 +1,32 @@
+import { CategoryAxis, Pane, Series } from './../common/property-types';
+import { NavigatorHint } from './navigator/hint.interface';
+import { NavigatorSelect } from './navigator/select.interface';
+/**
+ * @hidden
+ */
+export interface Navigator {
+    /**
+     * The visibility of the navigator.
+     */
+    visible?: boolean;
+    /**
+     * The configuration options of the category axis.
+     */
+    categoryAxis?: CategoryAxis;
+    /**
+     * The default options of the navigator hint.
+     */
+    hint?: NavigatorHint;
+    /**
+     * The configuration of the navigator pane.
+     */
+    pane?: Pane;
+    /**
+     * Specifies the initially selected range. If no range is specified, the full range of values is shown.
+     */
+    select?: NavigatorSelect;
+    /**
+     * An array of series definitions. Accepts the same options as the root series collection. Omitting the array and specifying a single series is also acceptable.
+     */
+    series?: Series | Series[];
+}

package/dist/esm/option-types/navigator.interface.js

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

package/dist/esm/option-types/pane/title.interface.d.ts

@@ -0,0 +1,56 @@
+import { drawing } from '@progress/kendo-drawing';
+import { Border, Margin } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface PanesTitle {
+    /**
+     * The background color of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the title.
+     */
+    border?: Border;
+    /**
+     * The text color of the title. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The font style of the title.
+     */
+    font?: string;
+    /**
+     * The margin of the title. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The position of the title.
+     *
+     * The supported values are:
+     * - `"left"`—The axis title is positioned on the left (applicable to the horizontal axis).
+     * - `"right"`—The axis title is positioned on the right (applicable to the horizontal axis).
+     * - `"center"`—The axis title is positioned in the center.
+     */
+    position?: 'left' | 'right' | 'center' | string;
+    /**
+     * The text of the title. You can split the text into multiple lines by using line feed characters (`"\n"`).
+     */
+    text?: string;
+    /**
+     * If set to `true`, the Chart displays the pane title. By default, the pane title is visible.
+     */
+    visible?: boolean;
+    /**
+     * A function that can be used to create a custom visual for the title.
+     *
+     * The available argument fields are:
+     *
+     * - `text`—The label text.
+     * - `rect`—The [geometry Rect]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
+     * - `sender`—The Chart instance (might be `undefined`).
+     * - `options`—The label options.
+     * - `createVisual`—A function that can be used to get the default visual.
+     */
+    visual?: (e: any) => drawing.Element;
+}

package/dist/esm/option-types/pane/title.interface.js

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