@progress/kendo-react-charts 6.1.1 → 7.0.0-develop.2

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

@@ -0,0 +1,41 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+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;
+    /**
+     * The position of the navigator.
+     * By default, the navigator is positioned at the bottom.
+     */
+    position?: 'top' | 'bottom';
+    /**
+     * 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/option-types/pane/title.interface.d.ts

@@ -0,0 +1,60 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+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';
+    /**
+     * 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/option-types/pane-defaults/title.interface.d.ts

@@ -0,0 +1,56 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { drawing } from '@progress/kendo-drawing';
+import { Border, Margin } from '../../common/property-types';
+/**
+ * The configuration options of the default pane title.
+ */
+export interface PaneDefaultsTitle {
+    /**
+     * 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';
+    /**
+     * 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/option-types/pane-defaults.interface.d.ts

@@ -0,0 +1,43 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, Margin, Padding } from '../common/property-types';
+import { PaneDefaultsTitle } from './pane-defaults/title.interface';
+/**
+ * The configuration options of the Chart pane defaults.
+ */
+export interface PaneDefaults {
+    /**
+     * The background color of the pane. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the pane.
+     */
+    border?: Border;
+    /**
+     * Specifies whether the Charts in the pane have to be clipped. By default, all Charts except the Radar and Polar Charts are clipped.
+     */
+    clip?: boolean;
+    /**
+     * The height of the pane in pixels.
+     */
+    height?: number;
+    /**
+     * The margin of the pane. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The unique name of the pane.
+     */
+    name?: string;
+    /**
+     * The padding of the pane. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * The title configuration of the pane. To display the title, set the [`panes.title.text`]({% slug api_charts_chartpanetitleprops %}#toc-text) option.
+     */
+    title?: PaneDefaultsTitle;
+}

package/option-types/pane.interface.d.ts

@@ -0,0 +1,43 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, Margin, Padding } from '../common/property-types';
+import { PanesTitle } from './pane/title.interface';
+/**
+ * @hidden
+ */
+export interface Pane {
+    /**
+     * The background color of the pane. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the pane.
+     */
+    border?: Border;
+    /**
+     * Specifies whether the Charts in the pane have to be clipped. By default, all Charts except the Radar and Polar Charts are clipped.
+     */
+    clip?: boolean;
+    /**
+     * The height of the pane in pixels.
+     */
+    height?: number;
+    /**
+     * The margin of the pane. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The unique name of the pane.
+     */
+    name?: string;
+    /**
+     * The padding of the pane. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * The title configuration of the pane. To display the title, set the [`panes.title.text`]({% slug api_charts_chartpanetitleprops %}#toc-text) option.
+     */
+    title?: string | PanesTitle;
+}

package/option-types/plot-area.interface.d.ts

@@ -0,0 +1,30 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, Margin, Padding } from '../common/property-types';
+/**
+ * @hidden
+ */
+export interface PlotArea {
+    /**
+     * The background color of the Chart plot area. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the plot area.
+     */
+    border?: Border;
+    /**
+     * The margin of the plot area. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The background opacity of the plot area. By default, the background is opaque.
+     */
+    opacity?: number;
+    /**
+     * The padding of the plot area. A numeric value sets all paddings. The default padding for the Pie, Donut, Radar, and Polar Charts is proportional of the Chart size.
+     */
+    padding?: Padding | number;
+}

package/option-types/series-defaults/labels.from.interface.d.ts

@@ -0,0 +1,55 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, Margin, Padding } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface SeriesDefaultsLabelsFrom {
+    /**
+     * The background color of the `from` labels. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the `from` labels.
+     */
+    border?: Border;
+    /**
+     * The text color of the `from` labels. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The function which returns the `from` label content of the Chart series. You can split the text into multiple lines by using line feed characters (`"\n"`).
+     *
+     * The available fields in the function argument are:
+     * - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
+     * - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
+     * - `percentage`—The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid and Pie series.
+     * - `series`—The data series.
+     * - `value`—The point value. Can be a number or object which contain each bound field.
+     * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
+     * - `total`—The sum of all previous series values. Available for the Waterfall series.
+     */
+    content?: (e: any) => string;
+    /**
+     * The font style of the from labels.
+     */
+    font?: string;
+    /**
+     * The format of the `from` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) of IntlService.
+     */
+    format?: string;
+    /**
+     * The margin of the `from` labels. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The padding of the `from` labels. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the series `from` labels. By default, the Chart series from labels are not displayed.
+     */
+    visible?: boolean;
+}

package/option-types/series-defaults/labels.interface.d.ts

@@ -0,0 +1,77 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { drawing } from '@progress/kendo-drawing';
+import { Border, Margin, Padding, SeriesLabelsVisualArgs } from '../../common/property-types';
+import { SeriesDefaultsLabelsFrom } from './labels.from.interface';
+import { SeriesDefaultsLabelsTo } from './labels.to.interface';
+/**
+ * @hidden
+ */
+export interface SeriesDefaultsLabels {
+    /**
+     * The background color of the labels. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the labels.
+     */
+    border?: Border;
+    /**
+     * The text color of the labels. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The function which returns the Chart series labels content. You can split the text into multiple lines by using line feed characters (`"\n"`).
+     *
+     * The available fields in the function argument are:
+     * - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
+     * - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
+     * - `percentage`—The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid and Pie series.
+     * - `series`—The data series.
+     * - `value`—The point value. Can be a number or object containing each bound field.
+     * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
+     * - `total`—The sum of all previous series values. Available for the Waterfall series.
+     */
+    content?: (e: any) => string;
+    /**
+     * The font style of the labels.
+     */
+    font?: string;
+    /**
+     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     */
+    format?: 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 margins.
+     */
+    padding?: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the series labels. By default, the Chart series labels are not displayed.
+     */
+    visible?: boolean;
+    /**
+     * A function that can be used to create a custom visual for the labels.
+     *
+     * 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: SeriesLabelsVisualArgs) => drawing.Element;
+    /**
+     * The Chart series `from` label configuration. The Chart displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_chartseriesdefaultslabelsprops %}#toc-visible) or the [`seriesDefaults.labels.from.visible`]({% slug api_charts_chartseriesdefaultslabelsfromprops %}#toc-visible) option is set to `true`.
+     */
+    from?: SeriesDefaultsLabelsFrom;
+    /**
+     * The Chart series `to` label configuration. The Chart displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_chartseriesdefaultslabelsprops %}#toc-visible) or the [`seriesDefaults.labels.to.visible`]({% slug api_charts_chartseriesdefaultslabelstoprops %}#toc-visible) option is set to `true`.
+     */
+    to?: SeriesDefaultsLabelsTo;
+}

package/option-types/series-defaults/labels.to.interface.d.ts

@@ -0,0 +1,55 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, Margin, Padding } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface SeriesDefaultsLabelsTo {
+    /**
+     * The background color of `to` lables. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of `to` labels.
+     */
+    border?: Border;
+    /**
+     * The text color of `to` labels. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The function which returns the `from` label content of the Chart series. You can split the text into multiple lines by using the line feed characters (`"\n"`).
+     *
+     * The available fields in the function argument are:
+     * - `category`—The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
+     * - `dataItem`—The original data item used to construct the point. If binding to an array, it will be `null`.
+     * - `percentage`—The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid and Pie series.
+     * - `series`—The data series.
+     * - `value`—The point value. Can be a number or object containing each bound field.
+     * - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
+     * - `total`—The sum of all previous series values. Available for the Waterfall series.
+     */
+    content?: (e: any) => string;
+    /**
+     * The font style of the `to` labels.
+     */
+    font?: string;
+    /**
+     * The format of the `to` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     */
+    format?: string;
+    /**
+     * The margin of the `to` labels. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+    /**
+     * The padding of the `to` labels. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the `to` labels of the series. By default, the `to` labels of the Chart series are not displayed.
+     */
+    visible?: boolean;
+}

package/option-types/series-defaults/notes.icon.interface.d.ts

@@ -0,0 +1,36 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, MarkerType } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface SeriesDefaultsNotesIcon {
+    /**
+     * The background color of the notes icon.
+     */
+    background?: string;
+    /**
+     * The border of the notes icon.
+     */
+    border?: Border;
+    /**
+     * The size of the notes icon.
+     */
+    size?: number;
+    /**
+     * The shape of the notes icon.
+     *
+     * The supported values are:
+     * * `"circle"`—The marker shape is a circle.
+     * * `"square"`—The marker shape is a square.
+     * * `"triangle"`—The marker shape is a triangle.
+     * * `"cross"`—The marker shape is a cross.
+     */
+    type?: MarkerType;
+    /**
+     * The visibility of the notes icon.
+     */
+    visible?: boolean;
+}

package/option-types/series-defaults/notes.interface.d.ts

@@ -0,0 +1,40 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { drawing } from '@progress/kendo-drawing';
+import { NoteLine, SeriesNoteVisualArgs } from '../../common/property-types';
+import { SeriesDefaultsNotesIcon } from './notes.icon.interface';
+import { SeriesDefaultsNotesLabel } from './notes.label.interface';
+/**
+ * @hidden
+ */
+export interface SeriesDefaultsNotes {
+    /**
+     * The line of the notes.
+     */
+    line?: NoteLine;
+    /**
+     * A function for creating a custom visual for the notes.
+     *
+     * The available argument fields are:
+     * - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines the note target rect.
+     * - `options`—The note options.
+     * - `createVisual`—A function for getting the default visual.
+     * - `category`—The category of the note point.
+     * - `dataItem`—The `dataItem` of the note point.
+     * - `value`—The value of the note point.
+     * - `sender`—The Chart instance.
+     * - `series`—The series of the note point.
+     * - `text`—The note text.
+     */
+    visual?: (e: SeriesNoteVisualArgs) => drawing.Element;
+    /**
+     * The icon of the notes.
+     */
+    icon?: SeriesDefaultsNotesIcon;
+    /**
+     * The label of the notes.
+     */
+    label?: SeriesDefaultsNotesLabel;
+}

package/option-types/series-defaults/notes.label.interface.d.ts

@@ -0,0 +1,50 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, NoteLabelPosition } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface SeriesDefaultsNotesLabel {
+    /**
+     * The background color of the label. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border of the label.
+     */
+    border?: Border;
+    /**
+     * The text color of the label. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The function which returns the label content. The function argument contains a `value` field which defines the point value. You can split the text into multiple lines by using line feed characters (`"\n"`).
+     */
+    content?: (e: any) => string;
+    /**
+     * The font style of the label.
+     */
+    font?: string;
+    /**
+     * The format for displaying the notes label. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the axis value.
+     */
+    format?: string;
+    /**
+     * The position of the labels.
+     *
+     * The available options are:
+     * - `"inside"`—The label is positioned inside the icon.
+     * - `"outside"`—The label is positioned outside the icon.
+     */
+    position?: NoteLabelPosition;
+    /**
+     * The rotation angle of the label. By default, the label is not rotated.
+     */
+    rotation?: number;
+    /**
+     * If set to `true`, the Chart displays the [`seriesDefaults`]({% slug api_charts_chartseriesdefaultsprops %}) notes label. By default, the [`seriesDefaults`]({% slug api_charts_chartseriesdefaultsprops %}) notes label is visible.
+     */
+    visible?: boolean;
+}

package/option-types/series-defaults/tooltip.interface.d.ts

@@ -0,0 +1,45 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2023 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the package root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Border, Padding } from '../../common/property-types';
+/**
+ * @hidden
+ */
+export interface SeriesDefaultsTooltip {
+    /**
+     * The background color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
+     */
+    background?: string;
+    /**
+     * The border configuration options.
+     */
+    border?: Border;
+    /**
+     * The text color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
+     */
+    color?: string;
+    /**
+     * The tooltip font.
+     */
+    font?: string;
+    /**
+     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     *
+     * The available format placeholders are:
+     * - Area, Bar, Column, Funnel, Line, and Pie: {0} - value.
+     * - Bubble: {0} - x value{1} - y value{2} - size value{3} - category name.
+     * - Scatter and Scatter Line: {0} - x value, {1} - y value.
+     * - Candlestick and OHLC: {0} - open value, {1} - high value, {2} - low value, {3} - close value, {4} - category name.
+     * - RangeArea, rangeBar, rangeColumn: {0} - from value, {1} - to value.
+     */
+    format?: string;
+    /**
+     * The padding of the tooltip. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+    /**
+     * If set to `true`, the Chart displays the series tooltip. By default, the series tooltip is not displayed.
+     */
+    visible?: boolean;
+}