@progress/kendo-react-charts
Version:
React Chart renders a wide range of high-quality data visualizations. KendoReact Charts package
104 lines (103 loc) • 3.94 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 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, Overlay, SeriesStack, SeriesType, SeriesVisualArgs } from '../common/property-types.js';
import { SeriesDefaultsLabels } from './series-defaults/labels.interface.js';
import { SeriesDefaultsNotes } from './series-defaults/notes.interface.js';
import { SeriesDefaultsTooltip } from './series-defaults/tooltip.interface.js';
import { FocusHighlight } from '@progress/kendo-charts';
/**
* @hidden
*/
export interface SeriesDefaults {
/**
* The border of the series.
*/
border?: Border;
/**
* The distance between category clusters.
*/
gap?: number;
/**
* The Chart series overlay options.
*/
overlay?: Overlay;
/**
* The space between the Chart series as a proportion of the series width. The `spacing` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`, and `"waterfall"`.
*/
spacing?: number;
/**
* A Boolean value which indicates if the series has to be stacked. The stack option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bar"`, `"column"`, `"line"`, `"area"`, `"verticalLine"`, `"verticalArea"`, `"radarLine"`, `"radarArea"`, and `"radarColumn"`.
*/
stack?: boolean | string | SeriesStack;
/**
* The default type of the series.
*
* The supported values are:
* - `area`
* - `bar`
* - `bubble`
* - `bullet`
* - `candlestick`
* - `column`
* - `donut`
* - `funnel`
* - `pyramid`
* - `line`
* - `ohlc`
* - `pie`
* - `polarArea`
* - `polarLine`
* - `polarScatter`
* - `radarArea`
* - `radarColumn`
* - `radarLine`
* - `rangeArea`
* - `rangeBar`
* - `rangeColumn`
* - `scatter`
* - `scatterLine`
* - `waterfall`
* - `verticalArea`
* - `verticalBullet`
* - `verticalLine`
* - `verticalRangeArea`
* - `waterfall`
*/
type?: SeriesType;
/**
* A function for creating custom visuals for the points. Applicable for the Bar and Column series.
*
* The available argument fields are:
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines where the visual has to be rendered.
* - `options`—The point options.
* - `createVisual`—A function that can be used to get the default visual.
* - `category`—The point category.
* - `dataItem`—The point `dataItem`.
* - `value`—The point value.
* - `sender`—The Chart instance.
* - `series`—The point series.
*/
visual?: (e: SeriesVisualArgs) => drawing.Element;
/**
* The label configuration of the Chart series. The Chart displays the series labels when the [`seriesDefaults.labels.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultslabelsprops#toc-visible) option is set to `true`.
*/
labels?: SeriesDefaultsLabels;
/**
* The `seriesDefaults` notes configuration.
*/
notes?: SeriesDefaultsNotes;
/**
* The configuration options of the Chart series tooltip.
*/
tooltip?: SeriesDefaultsTooltip;
/**
* The focus highlight configuration options.
*/
focusHighlight?: FocusHighlight;
}