@progress/kendo-react-charts 13.3.0-develop.2 → 13.3.0-develop.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cdn/js/kendo-react-charts.js +1 -1
- package/index.d.mts +244 -244
- package/index.d.ts +244 -244
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +6 -6
package/index.d.ts
CHANGED
|
@@ -111,7 +111,7 @@ declare interface AxisCrosshairTooltip {
|
|
|
111
111
|
*/
|
|
112
112
|
font?: string;
|
|
113
113
|
/**
|
|
114
|
-
* The format for displaying the tooltip. Uses the [`format`](
|
|
114
|
+
* The format for displaying the tooltip. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the value.
|
|
115
115
|
*/
|
|
116
116
|
format?: string;
|
|
117
117
|
/**
|
|
@@ -181,7 +181,7 @@ export declare interface AxisDefaults {
|
|
|
181
181
|
*/
|
|
182
182
|
visible?: boolean;
|
|
183
183
|
/**
|
|
184
|
-
* The crosshair configuration options. The crosshair is displayed when the [`axisDefaults.crosshair.visible`](
|
|
184
|
+
* The crosshair configuration options. The crosshair is displayed when the [`axisDefaults.crosshair.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartaxisdefaultscrosshairprops#toc-visible) option is set to `true`.
|
|
185
185
|
*/
|
|
186
186
|
crosshair?: AxisDefaultsCrosshair;
|
|
187
187
|
/**
|
|
@@ -189,7 +189,7 @@ export declare interface AxisDefaults {
|
|
|
189
189
|
*/
|
|
190
190
|
labels?: AxisDefaultsLabels;
|
|
191
191
|
/**
|
|
192
|
-
* The title configuration of the axis. To display the title, set the [`axisDefaults.title.text`](
|
|
192
|
+
* The title configuration of the axis. To display the title, set the [`axisDefaults.title.text`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartaxisdefaultstitleprops#toc-text) option.
|
|
193
193
|
*/
|
|
194
194
|
title?: AxisDefaultsTitle;
|
|
195
195
|
}
|
|
@@ -229,7 +229,7 @@ export declare interface AxisDefaultsCrosshair {
|
|
|
229
229
|
*/
|
|
230
230
|
width?: number;
|
|
231
231
|
/**
|
|
232
|
-
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`](
|
|
232
|
+
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`axisDefaults.crosshair.tooltip.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartaxisdefaultscrosshairtooltipprops#toc-visible) option is set to `true`.
|
|
233
233
|
*/
|
|
234
234
|
tooltip?: AxisDefaultsCrosshairTooltip;
|
|
235
235
|
}
|
|
@@ -260,7 +260,7 @@ export declare interface AxisDefaultsLabels {
|
|
|
260
260
|
*/
|
|
261
261
|
font?: string;
|
|
262
262
|
/**
|
|
263
|
-
* The format for displaying the labels. Uses the [`format`](
|
|
263
|
+
* The format for displaying the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value.
|
|
264
264
|
*/
|
|
265
265
|
format?: string;
|
|
266
266
|
/**
|
|
@@ -276,7 +276,7 @@ export declare interface AxisDefaultsLabels {
|
|
|
276
276
|
*/
|
|
277
277
|
padding?: Padding | number;
|
|
278
278
|
/**
|
|
279
|
-
* The rotation angle of the labels ([see example](
|
|
279
|
+
* The rotation angle of the labels ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-limiting-the-number-of-labels)). By default, the labels are not rotated. If the axis is horizontal, can be set to `"auto"`. In this case, the labels are rotated only if the slot size is not sufficient for the entire labels.
|
|
280
280
|
*/
|
|
281
281
|
rotation?: LabelRotation | number | 'auto';
|
|
282
282
|
/**
|
|
@@ -300,7 +300,7 @@ export declare interface AxisDefaultsLabels {
|
|
|
300
300
|
* - `dataItem`—The data item if a field has been specified.
|
|
301
301
|
* - `format`—The default format of the label.
|
|
302
302
|
* - `options`—The label options.
|
|
303
|
-
* - `rect`—The geometry [`Rect`](
|
|
303
|
+
* - `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.
|
|
304
304
|
* - `sender`—The Chart instance (can be `undefined`).
|
|
305
305
|
* - `text`—The label text.
|
|
306
306
|
* - `value`—The category value.
|
|
@@ -366,7 +366,7 @@ export declare interface AxisDefaultsTitle {
|
|
|
366
366
|
* The available argument fields are:
|
|
367
367
|
*
|
|
368
368
|
* - `text`—The label text.
|
|
369
|
-
* - `rect`—The geometry [`Rect`](
|
|
369
|
+
* - `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.
|
|
370
370
|
* - `sender`—The Chart instance (can be `undefined`).
|
|
371
371
|
* - `options`—The label options.
|
|
372
372
|
* - `createVisual`—A function for getting the default visual.
|
|
@@ -465,7 +465,7 @@ export declare interface AxisLabelVisualArgs {
|
|
|
465
465
|
}
|
|
466
466
|
|
|
467
467
|
/**
|
|
468
|
-
* The appearance settings for the axis lines. Affects the major and minor axis ticks, but not the grid lines (see the [basic usage example](
|
|
468
|
+
* The appearance settings for the axis lines. Affects the major and minor axis ticks, but not the grid lines (see the [basic usage example](https://www.telerik.com/kendo-react-ui/components/charts/api/chartaxisdefaults)).
|
|
469
469
|
*/
|
|
470
470
|
export declare interface AxisLine {
|
|
471
471
|
/**
|
|
@@ -527,7 +527,7 @@ export declare interface AxisRange {
|
|
|
527
527
|
}
|
|
528
528
|
|
|
529
529
|
/**
|
|
530
|
-
* The appearance configuration for the major and minor axis ticks (see the [basic usage example](
|
|
530
|
+
* The appearance configuration for the major and minor axis ticks (see the [basic usage example](https://www.telerik.com/kendo-react-ui/components/charts/api/chartaxisdefaults)).
|
|
531
531
|
*/
|
|
532
532
|
export declare interface AxisTicks {
|
|
533
533
|
/**
|
|
@@ -595,14 +595,14 @@ declare interface BaseChartProps {
|
|
|
595
595
|
*/
|
|
596
596
|
children?: any;
|
|
597
597
|
/**
|
|
598
|
-
* Gets or sets the current drill-down state for [Drilldown Charts](
|
|
598
|
+
* Gets or sets the current drill-down state for [Drilldown Charts](https://www.telerik.com/kendo-react-ui/components/charts/drill-down).
|
|
599
599
|
*
|
|
600
600
|
* To return to a previous level, remove the items from the `steps` array following the desired level.
|
|
601
601
|
* To return to the root chart, set the `steps` array to `[]`.
|
|
602
602
|
*/
|
|
603
603
|
drilldownState?: ChartDrilldownState;
|
|
604
604
|
/**
|
|
605
|
-
* Sets the preferred rendering engine ([see example](
|
|
605
|
+
* Sets the preferred rendering engine ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/rendering)). If not supported by the browser, the Chart switches to the first available mode.
|
|
606
606
|
*
|
|
607
607
|
* The supported values are:
|
|
608
608
|
* - `"svg"`—If available, renders the component as an inline `.svg` file.
|
|
@@ -610,11 +610,11 @@ declare interface BaseChartProps {
|
|
|
610
610
|
*/
|
|
611
611
|
renderAs?: 'svg' | 'canvas';
|
|
612
612
|
/**
|
|
613
|
-
* Specifies if the Chart can be panned ([see example](
|
|
613
|
+
* Specifies if the Chart can be panned ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/pan-zoom)).
|
|
614
614
|
*/
|
|
615
615
|
pannable?: boolean | DragAction;
|
|
616
616
|
/**
|
|
617
|
-
* Specifies if the Chart can be zoomed ([see example](
|
|
617
|
+
* Specifies if the Chart can be zoomed ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/pan-zoom)). Currently is only applicable to linear types, where the range on the X axis can be changed based on the zoom level.
|
|
618
618
|
*/
|
|
619
619
|
zoomable?: boolean | Zoomable;
|
|
620
620
|
/**
|
|
@@ -671,7 +671,7 @@ declare interface BaseChartProps {
|
|
|
671
671
|
*/
|
|
672
672
|
onLegendItemHover?: (event: LegendItemHoverEvent) => void;
|
|
673
673
|
/**
|
|
674
|
-
* Fires when the user clicks a legend item ([see example](
|
|
674
|
+
* Fires when the user clicks a legend item ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/legend#toc-clicking-legend-items)).
|
|
675
675
|
*/
|
|
676
676
|
onLegendItemClick?: (event: LegendItemClickEvent) => void;
|
|
677
677
|
/**
|
|
@@ -687,15 +687,15 @@ declare interface BaseChartProps {
|
|
|
687
687
|
*/
|
|
688
688
|
onPlotAreaClick?: (event: PlotAreaClickEvent) => void;
|
|
689
689
|
/**
|
|
690
|
-
* Fires when the user hovers the plot area ([see example](
|
|
690
|
+
* Fires when the user hovers the plot area ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/crosshairs#toc-current-cursor-values)).
|
|
691
691
|
*/
|
|
692
692
|
onPlotAreaHover?: (event: PlotAreaHoverEvent) => void;
|
|
693
693
|
/**
|
|
694
|
-
* Fires when the Chart is ready to render on screen ([see example](
|
|
694
|
+
* Fires when the Chart is ready to render on screen ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-bands#toc-custom-plot-bands)). For example, you can use it to remove loading indicators. Any changes made to the options are ignored.
|
|
695
695
|
*/
|
|
696
696
|
onRender?: (event: RenderEvent) => void;
|
|
697
697
|
/**
|
|
698
|
-
* Fires when the Chart is about to refresh. The event can be used to prevent the refresh of the Chart in specific cases ([see example](
|
|
698
|
+
* Fires when the Chart is about to refresh. The event can be used to prevent the refresh of the Chart in specific cases ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/chart-refresh).
|
|
699
699
|
*/
|
|
700
700
|
onRefresh?: (chartOptions: any, themeOptions: any, chartInstance: any) => void;
|
|
701
701
|
/**
|
|
@@ -707,7 +707,7 @@ declare interface BaseChartProps {
|
|
|
707
707
|
*/
|
|
708
708
|
onSelect?: (event: SelectEvent) => void;
|
|
709
709
|
/**
|
|
710
|
-
* Fires when the user completes the modification of the selection ([see example](
|
|
710
|
+
* Fires when the user completes the modification of the selection ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/selection#toc-using-selection-as-navigator)).
|
|
711
711
|
*
|
|
712
712
|
* The range units are:
|
|
713
713
|
* - Generic axis—Category index (0-based).
|
|
@@ -791,7 +791,7 @@ declare abstract class BaseEvent {
|
|
|
791
791
|
export declare type BaseUnit = 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
|
|
792
792
|
|
|
793
793
|
/**
|
|
794
|
-
* The appearance settings for the border lines (see the [basic usage example](
|
|
794
|
+
* The appearance settings for the border lines (see the [basic usage example](https://www.telerik.com/kendo-react-ui/components/charts/api/charttitle)).
|
|
795
795
|
*/
|
|
796
796
|
export declare interface Border {
|
|
797
797
|
/**
|
|
@@ -859,7 +859,7 @@ export declare interface CategoryAxis {
|
|
|
859
859
|
*/
|
|
860
860
|
background?: string;
|
|
861
861
|
/**
|
|
862
|
-
* The base time interval for the date axis ([see example](
|
|
862
|
+
* The base time interval for the date axis ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-selecting-time-intervals)). The default base unit is automatically determined by the minimum difference between subsequent categories.
|
|
863
863
|
*
|
|
864
864
|
* The supported values are:
|
|
865
865
|
* - `"fit"`
|
|
@@ -872,13 +872,13 @@ export declare interface CategoryAxis {
|
|
|
872
872
|
* - `"months"`
|
|
873
873
|
* - `"years"`
|
|
874
874
|
*
|
|
875
|
-
* Setting `baseUnit` to `"fit"` sets such a base unit and [`categoryAxis.baseUnitStep`](
|
|
875
|
+
* Setting `baseUnit` to `"fit"` sets such a base unit and [`categoryAxis.baseUnitStep`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-baseunitstep) that the total number of categories does not exceed [`categoryAxis.maxDateGroups`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-maxdategroups).
|
|
876
876
|
*
|
|
877
|
-
* Series data is aggregated for the specified base unit by using the [`series.aggregate`](
|
|
877
|
+
* Series data is aggregated for the specified base unit by using the [`series.aggregate`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-aggregate) function.
|
|
878
878
|
*/
|
|
879
879
|
baseUnit?: CategoryBaseUnit;
|
|
880
880
|
/**
|
|
881
|
-
* The step (interval) between the categories in base units ([see example](
|
|
881
|
+
* The step (interval) between the categories in base units ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#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`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-maxdategroups). The option is ignored if [`categoryAxis.baseUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-baseunit) is set to `"fit"`.
|
|
882
882
|
*/
|
|
883
883
|
baseUnitStep?: number | 'auto';
|
|
884
884
|
/**
|
|
@@ -886,11 +886,11 @@ export declare interface CategoryAxis {
|
|
|
886
886
|
*/
|
|
887
887
|
categories?: any[];
|
|
888
888
|
/**
|
|
889
|
-
* 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`](
|
|
889
|
+
* 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`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxislabelsprops#toc-color) and [`categoryAxis.line.color`](https://www.telerik.com/kendo-react-ui/components/charts/api/axisline#toc-color).
|
|
890
890
|
*/
|
|
891
891
|
color?: string;
|
|
892
892
|
/**
|
|
893
|
-
* 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`](
|
|
893
|
+
* 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`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) option is set to `"bar"`, `"column"`, `"boxPlot"`, `"ohlc"`, `"candlestick"`, or `"waterfall"`.
|
|
894
894
|
*/
|
|
895
895
|
justified?: boolean;
|
|
896
896
|
/**
|
|
@@ -906,19 +906,19 @@ export declare interface CategoryAxis {
|
|
|
906
906
|
*/
|
|
907
907
|
majorTicks?: AxisTicks;
|
|
908
908
|
/**
|
|
909
|
-
* The last date displayed on a date category axis or the index of the last category displayed on a category axis ([see example](
|
|
909
|
+
* The last date displayed on a date category axis or the index of the last category displayed on a category axis ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/styling#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`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-min) and [`categoryAxis.roundToBaseUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-roundtobaseunit) options to set up a fixed date range.
|
|
910
910
|
*/
|
|
911
911
|
max?: any;
|
|
912
912
|
/**
|
|
913
|
-
* The maximum number of groups (categories) to display when [`categoryAxis.baseUnit`](
|
|
913
|
+
* The maximum number of groups (categories) to display when [`categoryAxis.baseUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-baseunit) is set to `"fit"` or [`categoryAxis.baseUnitStep`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-baseunitstep) is set to `"auto"`([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-selecting-time-intervals)).
|
|
914
914
|
*/
|
|
915
915
|
maxDateGroups?: number;
|
|
916
916
|
/**
|
|
917
|
-
* The maximum number of ticks and labels to display. Applicabable for date category axis ([see example](
|
|
917
|
+
* The maximum number of ticks and labels to display. Applicabable for date category axis ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-limiting-the-number-of-labels)).
|
|
918
918
|
*/
|
|
919
919
|
maxDivisions?: number;
|
|
920
920
|
/**
|
|
921
|
-
* 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](
|
|
921
|
+
* 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](https://www.telerik.com/kendo-react-ui/components/charts/chart/styling#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`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-max) and [`categoryAxis.roundToBaseUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-roundtobaseunit) options to set up a fixed date range.
|
|
922
922
|
*/
|
|
923
923
|
min?: any;
|
|
924
924
|
/**
|
|
@@ -930,7 +930,7 @@ export declare interface CategoryAxis {
|
|
|
930
930
|
*/
|
|
931
931
|
minorTicks?: AxisTicks;
|
|
932
932
|
/**
|
|
933
|
-
* The unique axis name. Used to associate a series with a category axis, which utilizes the [`series.categoryAxis`](
|
|
933
|
+
* The unique axis name. Used to associate a series with a category axis, which utilizes the [`series.categoryAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-categoryaxis) option.
|
|
934
934
|
*/
|
|
935
935
|
name?: string;
|
|
936
936
|
/**
|
|
@@ -974,7 +974,7 @@ export declare interface CategoryAxis {
|
|
|
974
974
|
*/
|
|
975
975
|
weekStartDay?: WeekStartDay;
|
|
976
976
|
/**
|
|
977
|
-
* The configuration options of the crosshair. The crosshair is displayed when the [`categoryAxis.crosshair.visible`](
|
|
977
|
+
* The configuration options of the crosshair. The crosshair is displayed when the [`categoryAxis.crosshair.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxiscrosshairprops#toc-visible) option is set to `true`.
|
|
978
978
|
*/
|
|
979
979
|
crosshair?: CategoryAxisCrosshair;
|
|
980
980
|
/**
|
|
@@ -986,11 +986,11 @@ export declare interface CategoryAxis {
|
|
|
986
986
|
*/
|
|
987
987
|
notes?: CategoryAxisNotes;
|
|
988
988
|
/**
|
|
989
|
-
* The selected axis range ([see example](
|
|
989
|
+
* The selected axis range ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/selection)). 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.v
|
|
990
990
|
*/
|
|
991
991
|
select?: CategoryAxisSelect;
|
|
992
992
|
/**
|
|
993
|
-
* The title configuration of the category axis. To display the title, set the [`categoryAxis.title.text`](
|
|
993
|
+
* The title configuration of the category axis. To display the title, set the [`categoryAxis.title.text`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxistitleprops#toc-text) option.
|
|
994
994
|
*/
|
|
995
995
|
title?: CategoryAxisTitle;
|
|
996
996
|
}
|
|
@@ -1029,7 +1029,7 @@ export declare interface CategoryAxisCrosshair {
|
|
|
1029
1029
|
*/
|
|
1030
1030
|
width?: number;
|
|
1031
1031
|
/**
|
|
1032
|
-
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`categoryAxis.crosshair.tooltip.visible`](
|
|
1032
|
+
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`categoryAxis.crosshair.tooltip.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxiscrosshairtooltipprops#toc-visible) option is set to `true`.
|
|
1033
1033
|
*/
|
|
1034
1034
|
tooltip?: CategoryAxisCrosshairTooltip;
|
|
1035
1035
|
}
|
|
@@ -1070,15 +1070,15 @@ export declare interface CategoryAxisLabels {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
content?: (e: any) => string;
|
|
1072
1072
|
/**
|
|
1073
|
-
* The culture to use when formatting date values. The specified culture must be loaded as demonstrated in the [Internationalization Overview](
|
|
1073
|
+
* The culture to use when formatting date values. The specified culture must be loaded as demonstrated in the [Internationalization Overview](https://www.telerik.com/kendo-react-ui/components/intl/i18n).
|
|
1074
1074
|
*/
|
|
1075
1075
|
culture?: string;
|
|
1076
1076
|
/**
|
|
1077
|
-
* The format for displaying the labels of the date category axis. The `{0}` placeholder represents the category value. The Chart selects the appropriate format for the current [`categoryAxis.baseUnit`](
|
|
1077
|
+
* The format for displaying the labels of the date category axis. The `{0}` placeholder represents the category value. The Chart selects the appropriate format for the current [`categoryAxis.baseUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops#toc-baseunit) option.
|
|
1078
1078
|
*
|
|
1079
|
-
* Setting the [`categoryAxis.labels.format`](
|
|
1079
|
+
* Setting the [`categoryAxis.labels.format`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxislabelsprops#toc-format) option overrides the date formats. For more information, refer to the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
|
|
1080
1080
|
*
|
|
1081
|
-
* > Not supported for Radar Charts. Use [`categoryAxis.labels.format`](
|
|
1081
|
+
* > Not supported for Radar Charts. Use [`categoryAxis.labels.format`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxislabelsprops#toc-format) instead.
|
|
1082
1082
|
*/
|
|
1083
1083
|
dateFormats?: DateFormats;
|
|
1084
1084
|
/**
|
|
@@ -1086,7 +1086,7 @@ export declare interface CategoryAxisLabels {
|
|
|
1086
1086
|
*/
|
|
1087
1087
|
font?: string;
|
|
1088
1088
|
/**
|
|
1089
|
-
* The format for displaying the labels. Uses the [`format`](
|
|
1089
|
+
* The format for displaying the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value.
|
|
1090
1090
|
*/
|
|
1091
1091
|
format?: string;
|
|
1092
1092
|
/**
|
|
@@ -1134,7 +1134,7 @@ export declare interface CategoryAxisLabels {
|
|
|
1134
1134
|
* - `dataItem`—The data item if a field is specified.
|
|
1135
1135
|
* - `format`—The default format of the label.
|
|
1136
1136
|
* - `options`—The label options.
|
|
1137
|
-
* - `rect`—The geometry [`Rect`](
|
|
1137
|
+
* - `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.
|
|
1138
1138
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
1139
1139
|
* - `text`—The label text.
|
|
1140
1140
|
* - `value`—The category value.
|
|
@@ -1168,7 +1168,7 @@ export declare interface CategoryAxisNotes {
|
|
|
1168
1168
|
* A function that can be used to create a custom visual for the notes.
|
|
1169
1169
|
*
|
|
1170
1170
|
* The available argument fields are:
|
|
1171
|
-
* - `rect`—The geometry [`Rect`](
|
|
1171
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines the note target rect.
|
|
1172
1172
|
* - `options`—The note options.
|
|
1173
1173
|
* - `createVisual`—A function for getting the default visual.
|
|
1174
1174
|
* - `value`—The note value.
|
|
@@ -1241,7 +1241,7 @@ export declare interface CategoryAxisNotesLabel {
|
|
|
1241
1241
|
*/
|
|
1242
1242
|
font?: string;
|
|
1243
1243
|
/**
|
|
1244
|
-
* The format for displaying the notes label. Uses the [`format`](
|
|
1244
|
+
* The format for displaying the notes label. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value.
|
|
1245
1245
|
*/
|
|
1246
1246
|
format?: string;
|
|
1247
1247
|
/**
|
|
@@ -1367,7 +1367,7 @@ export declare interface CategoryAxisTitle {
|
|
|
1367
1367
|
*
|
|
1368
1368
|
* The available argument fields are:
|
|
1369
1369
|
* - `text`—The label text.
|
|
1370
|
-
* - `rect`—The geometry [`Rect`](
|
|
1370
|
+
* - `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.
|
|
1371
1371
|
* - `sender`—The Chart instance (can be `undefined`).
|
|
1372
1372
|
* - `options`—The label options.
|
|
1373
1373
|
* - `createVisual`—A function for getting the default visual.
|
|
@@ -1406,7 +1406,7 @@ export declare interface CategoryAxisTitle {
|
|
|
1406
1406
|
export declare type CategoryBaseUnit = BaseUnit | 'auto' | 'fit';
|
|
1407
1407
|
|
|
1408
1408
|
/**
|
|
1409
|
-
* Represents the [KendoReact Chart component](
|
|
1409
|
+
* Represents the [KendoReact Chart component](https://www.telerik.com/kendo-react-ui/components/charts/chart).
|
|
1410
1410
|
*
|
|
1411
1411
|
* @remarks
|
|
1412
1412
|
* Supported children components are: {@link ChartAxisDefaults}, {@link ChartCategoryAxis}, {@link ChartArea},
|
|
@@ -1491,7 +1491,7 @@ export declare class Chart extends React_2.Component<ChartProps, {}> {
|
|
|
1491
1491
|
export declare const ChartArea: React_2.FunctionComponent<ChartAreaProps>;
|
|
1492
1492
|
|
|
1493
1493
|
/**
|
|
1494
|
-
* Represents the props of the KendoReact ChartArea component ([see example](
|
|
1494
|
+
* Represents the props of the KendoReact ChartArea component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/chart-area)).
|
|
1495
1495
|
*/
|
|
1496
1496
|
export declare interface ChartAreaProps extends ChartingArea {
|
|
1497
1497
|
}
|
|
@@ -1545,7 +1545,7 @@ export declare interface ChartAxisDefaultsLabelsProps extends AxisDefaultsLabels
|
|
|
1545
1545
|
}
|
|
1546
1546
|
|
|
1547
1547
|
/**
|
|
1548
|
-
* Represents the props of the KendoReact ChartAxisDefaults component ([see example](
|
|
1548
|
+
* Represents the props of the KendoReact ChartAxisDefaults component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-default-axis-configuration)).
|
|
1549
1549
|
*/
|
|
1550
1550
|
export declare interface ChartAxisDefaultsProps extends AxisDefaults {
|
|
1551
1551
|
/**
|
|
@@ -1576,7 +1576,7 @@ export declare interface ChartAxisType {
|
|
|
1576
1576
|
*/
|
|
1577
1577
|
range(): AxisRange;
|
|
1578
1578
|
/**
|
|
1579
|
-
* Returns a slot that is based on the specified `from` and `to` values ([see example](
|
|
1579
|
+
* Returns a slot that is based on the specified `from` and `to` values ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-bands#toc-custom-plot-bands)).
|
|
1580
1580
|
*
|
|
1581
1581
|
* @param from - The slot start value.
|
|
1582
1582
|
* @param to - The end slot value. If not specified, the `from` value is used.
|
|
@@ -1621,7 +1621,7 @@ declare interface ChartBreadcrumbHandle {
|
|
|
1621
1621
|
}
|
|
1622
1622
|
|
|
1623
1623
|
/**
|
|
1624
|
-
* Represents the properties of [Chart Breadcrumb](
|
|
1624
|
+
* Represents the properties of [Chart Breadcrumb](https://www.telerik.com/kendo-react-ui/components/charts/api/chartbreadcrumb) component.
|
|
1625
1625
|
*/
|
|
1626
1626
|
export declare interface ChartBreadcrumbProps extends Omit<BreadcrumbProps, 'data'> {
|
|
1627
1627
|
/**
|
|
@@ -1688,7 +1688,7 @@ export declare interface ChartCategoryAxisCrosshairTooltipProps extends Category
|
|
|
1688
1688
|
export declare const ChartCategoryAxisItem: React_2.FunctionComponent<ChartCategoryAxisItemProps>;
|
|
1689
1689
|
|
|
1690
1690
|
/**
|
|
1691
|
-
* Represents the props of the KendoReact ChartCategoryAxisItem component ([see example](
|
|
1691
|
+
* Represents the props of the KendoReact ChartCategoryAxisItem component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-categorical-chart-axes)).
|
|
1692
1692
|
*/
|
|
1693
1693
|
export declare interface ChartCategoryAxisItemProps extends CategoryAxis {
|
|
1694
1694
|
/**
|
|
@@ -1748,7 +1748,7 @@ export declare interface ChartCategoryAxisNotesProps extends CategoryAxisNotes {
|
|
|
1748
1748
|
}
|
|
1749
1749
|
|
|
1750
1750
|
/**
|
|
1751
|
-
* Represents the props of the KendoReact ChartCategoryAxis component ([see example](
|
|
1751
|
+
* Represents the props of the KendoReact ChartCategoryAxis component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-categorical-chart-axes)).
|
|
1752
1752
|
*/
|
|
1753
1753
|
export declare interface ChartCategoryAxisProps {
|
|
1754
1754
|
/**
|
|
@@ -1887,7 +1887,7 @@ export declare interface ChartLegendItemProps extends LegendItem {
|
|
|
1887
1887
|
}
|
|
1888
1888
|
|
|
1889
1889
|
/**
|
|
1890
|
-
* Represents the props of the KendoReact ChartLegend component ([see example](
|
|
1890
|
+
* Represents the props of the KendoReact ChartLegend component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/legend)).
|
|
1891
1891
|
*/
|
|
1892
1892
|
export declare interface ChartLegendProps extends Legend {
|
|
1893
1893
|
/**
|
|
@@ -1898,7 +1898,7 @@ export declare interface ChartLegendProps extends Legend {
|
|
|
1898
1898
|
|
|
1899
1899
|
/**
|
|
1900
1900
|
* Represents the KendoReact ChartLegendTitle component.
|
|
1901
|
-
* ([see example](
|
|
1901
|
+
* ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/legend#toc-setting-a-title)).
|
|
1902
1902
|
*/
|
|
1903
1903
|
export declare const ChartLegendTitle: React_2.FunctionComponent<ChartLegendTitleProps>;
|
|
1904
1904
|
|
|
@@ -2294,7 +2294,7 @@ export declare const ChartPane: React_2.FunctionComponent<ChartPaneProps>;
|
|
|
2294
2294
|
export declare const ChartPaneDefaults: React_2.FunctionComponent<ChartPaneDefaultsProps>;
|
|
2295
2295
|
|
|
2296
2296
|
/**
|
|
2297
|
-
* Represents the props of the KendoReact ChartPaneDefaults component ([see example](
|
|
2297
|
+
* Represents the props of the KendoReact ChartPaneDefaults component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/panes)).
|
|
2298
2298
|
*/
|
|
2299
2299
|
export declare interface ChartPaneDefaultsProps extends PaneDefaults {
|
|
2300
2300
|
/**
|
|
@@ -2304,18 +2304,18 @@ export declare interface ChartPaneDefaultsProps extends PaneDefaults {
|
|
|
2304
2304
|
}
|
|
2305
2305
|
|
|
2306
2306
|
/**
|
|
2307
|
-
* Represents the KendoReact ChartPaneDefaultsTitle component ([see example](
|
|
2307
|
+
* Represents the KendoReact ChartPaneDefaultsTitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/panes)).
|
|
2308
2308
|
*/
|
|
2309
2309
|
export declare const ChartPaneDefaultsTitle: React_2.FunctionComponent<ChartPaneDefaultsTitleProps>;
|
|
2310
2310
|
|
|
2311
2311
|
/**
|
|
2312
|
-
* Represents the props of the KendoReact ChartPaneDefaultsTitle component ([see example](
|
|
2312
|
+
* Represents the props of the KendoReact ChartPaneDefaultsTitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/panes)).
|
|
2313
2313
|
*/
|
|
2314
2314
|
export declare interface ChartPaneDefaultsTitleProps extends PaneDefaultsTitle {
|
|
2315
2315
|
}
|
|
2316
2316
|
|
|
2317
2317
|
/**
|
|
2318
|
-
* Represents the props of the KendoReact ChartPane component ([see example](
|
|
2318
|
+
* Represents the props of the KendoReact ChartPane component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/panes)).
|
|
2319
2319
|
*/
|
|
2320
2320
|
export declare interface ChartPaneProps extends Pane {
|
|
2321
2321
|
}
|
|
@@ -2339,12 +2339,12 @@ export declare interface ChartPanesProps {
|
|
|
2339
2339
|
}
|
|
2340
2340
|
|
|
2341
2341
|
/**
|
|
2342
|
-
* Represents the KendoReact ChartPaneTitle component ([see example](
|
|
2342
|
+
* Represents the KendoReact ChartPaneTitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/panes)).
|
|
2343
2343
|
*/
|
|
2344
2344
|
export declare const ChartPaneTitle: React_2.FunctionComponent<ChartPaneTitleProps>;
|
|
2345
2345
|
|
|
2346
2346
|
/**
|
|
2347
|
-
* Represents the props of the KendoReact ChartPaneTitle component ([see example](
|
|
2347
|
+
* Represents the props of the KendoReact ChartPaneTitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/panes)).
|
|
2348
2348
|
*/
|
|
2349
2349
|
export declare interface ChartPaneTitleProps extends PanesTitle {
|
|
2350
2350
|
}
|
|
@@ -2364,12 +2364,12 @@ export declare interface ChartPaneType {
|
|
|
2364
2364
|
}
|
|
2365
2365
|
|
|
2366
2366
|
/**
|
|
2367
|
-
* Represents the KendoReact ChartPlotArea component ([see example](
|
|
2367
|
+
* Represents the KendoReact ChartPlotArea component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-area)).
|
|
2368
2368
|
*/
|
|
2369
2369
|
export declare const ChartPlotArea: React_2.FunctionComponent<ChartPlotAreaProps>;
|
|
2370
2370
|
|
|
2371
2371
|
/**
|
|
2372
|
-
* Represents the props of the KendoReact ChartPlotArea component ([see example](
|
|
2372
|
+
* Represents the props of the KendoReact ChartPlotArea component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-area)).
|
|
2373
2373
|
*/
|
|
2374
2374
|
export declare interface ChartPlotAreaProps extends PlotArea {
|
|
2375
2375
|
}
|
|
@@ -2454,7 +2454,7 @@ export declare interface ChartSeriesDefaultsLabelsFromProps extends SeriesDefaul
|
|
|
2454
2454
|
}
|
|
2455
2455
|
|
|
2456
2456
|
/**
|
|
2457
|
-
* Represents the props of the KendoReact ChartSeriesDefaultsLabels component ([see example](
|
|
2457
|
+
* Represents the props of the KendoReact ChartSeriesDefaultsLabels component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/series#toc-default-series-configuration)).
|
|
2458
2458
|
*/
|
|
2459
2459
|
export declare interface ChartSeriesDefaultsLabelsProps extends SeriesDefaultsLabels {
|
|
2460
2460
|
}
|
|
@@ -2501,13 +2501,13 @@ export declare interface ChartSeriesDefaultsNotesLabelProps extends SeriesDefaul
|
|
|
2501
2501
|
}
|
|
2502
2502
|
|
|
2503
2503
|
/**
|
|
2504
|
-
* Represents the props of the KendoReact ChartSeriesDefaultsNotes component ([see example](
|
|
2504
|
+
* Represents the props of the KendoReact ChartSeriesDefaultsNotes component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/series#toc-default-series-configuration)).
|
|
2505
2505
|
*/
|
|
2506
2506
|
export declare interface ChartSeriesDefaultsNotesProps extends SeriesDefaultsNotes {
|
|
2507
2507
|
}
|
|
2508
2508
|
|
|
2509
2509
|
/**
|
|
2510
|
-
* Represents the props of the KendoReact ChartSeriesDefaults component ([see example](
|
|
2510
|
+
* Represents the props of the KendoReact ChartSeriesDefaults component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/series#toc-default-series-configuration)).
|
|
2511
2511
|
*/
|
|
2512
2512
|
export declare interface ChartSeriesDefaultsProps extends SeriesDefaults {
|
|
2513
2513
|
}
|
|
@@ -2583,12 +2583,12 @@ export declare interface ChartSeriesItemProps extends Series {
|
|
|
2583
2583
|
}
|
|
2584
2584
|
|
|
2585
2585
|
/**
|
|
2586
|
-
* Represents the KendoReact ChartSeriesItemTooltip component ([see example](
|
|
2586
|
+
* Represents the KendoReact ChartSeriesItemTooltip component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/tooltips)).
|
|
2587
2587
|
*/
|
|
2588
2588
|
export declare const ChartSeriesItemTooltip: React_2.FunctionComponent<ChartSeriesItemTooltipProps>;
|
|
2589
2589
|
|
|
2590
2590
|
/**
|
|
2591
|
-
* Represents the props of the KendoReact ChartSeriesItemTooltip component ([see example](
|
|
2591
|
+
* Represents the props of the KendoReact ChartSeriesItemTooltip component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/tooltips)).
|
|
2592
2592
|
*/
|
|
2593
2593
|
export declare interface ChartSeriesItemTooltipProps extends SeriesTooltip_2 {
|
|
2594
2594
|
/**
|
|
@@ -2620,7 +2620,7 @@ export declare interface ChartSeriesLabelsFromProps extends SeriesLabelsFrom {
|
|
|
2620
2620
|
}
|
|
2621
2621
|
|
|
2622
2622
|
/**
|
|
2623
|
-
* Represents the props of the KendoReact ChartSeriesLabels component ([see example](
|
|
2623
|
+
* Represents the props of the KendoReact ChartSeriesLabels component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/labels#toc-setting-the-appearance)).
|
|
2624
2624
|
*/
|
|
2625
2625
|
export declare interface ChartSeriesLabelsProps extends SeriesLabels {
|
|
2626
2626
|
/**
|
|
@@ -2698,34 +2698,34 @@ export declare interface ChartSeriesProps {
|
|
|
2698
2698
|
}
|
|
2699
2699
|
|
|
2700
2700
|
/**
|
|
2701
|
-
* Represents the KendoReact ChartSubtitle component ([see example](
|
|
2701
|
+
* Represents the KendoReact ChartSubtitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/title)).
|
|
2702
2702
|
*/
|
|
2703
2703
|
export declare const ChartSubtitle: React_2.FunctionComponent<ChartSubtitleProps>;
|
|
2704
2704
|
|
|
2705
2705
|
/**
|
|
2706
|
-
* Represents the props of the KendoReact ChartSubtitle component ([see example](
|
|
2706
|
+
* Represents the props of the KendoReact ChartSubtitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/title)).
|
|
2707
2707
|
*/
|
|
2708
2708
|
export declare interface ChartSubtitleProps extends Subtitle {
|
|
2709
2709
|
}
|
|
2710
2710
|
|
|
2711
2711
|
/**
|
|
2712
|
-
* Represents the KendoReact ChartTitle component ([see example](
|
|
2712
|
+
* Represents the KendoReact ChartTitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/title)).
|
|
2713
2713
|
*/
|
|
2714
2714
|
export declare const ChartTitle: React_2.FunctionComponent<ChartTitleProps>;
|
|
2715
2715
|
|
|
2716
2716
|
/**
|
|
2717
|
-
* Represents the props of the KendoReact ChartTitle component ([see example](
|
|
2717
|
+
* Represents the props of the KendoReact ChartTitle component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/title)).
|
|
2718
2718
|
*/
|
|
2719
2719
|
export declare interface ChartTitleProps extends Title {
|
|
2720
2720
|
}
|
|
2721
2721
|
|
|
2722
2722
|
/**
|
|
2723
|
-
* Represents the KendoReact ChartTooltip component ([see example](
|
|
2723
|
+
* Represents the KendoReact ChartTooltip component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/tooltips)).
|
|
2724
2724
|
*/
|
|
2725
2725
|
export declare const ChartTooltip: React_2.FunctionComponent<ChartTooltipProps>;
|
|
2726
2726
|
|
|
2727
2727
|
/**
|
|
2728
|
-
* Represents the props of the KendoReact ChartTooltip component ([see example](
|
|
2728
|
+
* Represents the props of the KendoReact ChartTooltip component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/tooltips)).
|
|
2729
2729
|
*/
|
|
2730
2730
|
export declare interface ChartTooltipProps extends Tooltip {
|
|
2731
2731
|
/**
|
|
@@ -2740,7 +2740,7 @@ export declare interface ChartTooltipProps extends Tooltip {
|
|
|
2740
2740
|
}
|
|
2741
2741
|
|
|
2742
2742
|
/**
|
|
2743
|
-
* Represents the KendoReact ChartValueAxis component ([see example](
|
|
2743
|
+
* Represents the KendoReact ChartValueAxis component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-categorical-chart-axes)).
|
|
2744
2744
|
*
|
|
2745
2745
|
* @remarks
|
|
2746
2746
|
* Supported children components are: {@link ChartValueAxisItem}.
|
|
@@ -2777,7 +2777,7 @@ export declare interface ChartValueAxisCrosshairTooltipProps extends ValueAxisCr
|
|
|
2777
2777
|
}
|
|
2778
2778
|
|
|
2779
2779
|
/**
|
|
2780
|
-
* Represents the KendoReact ChartValueAxisItem component ([see example](
|
|
2780
|
+
* Represents the KendoReact ChartValueAxisItem component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-categorical-chart-axes)).
|
|
2781
2781
|
*
|
|
2782
2782
|
* @remarks
|
|
2783
2783
|
* Supported children components are: {@link ChartValueAxisCrosshair}, {@link ChartValueAxisLabels}, {@link ChartValueAxisNotes}, {@link ChartValueAxisTitle}.
|
|
@@ -2785,7 +2785,7 @@ export declare interface ChartValueAxisCrosshairTooltipProps extends ValueAxisCr
|
|
|
2785
2785
|
export declare const ChartValueAxisItem: React_2.FunctionComponent<ChartValueAxisItemProps>;
|
|
2786
2786
|
|
|
2787
2787
|
/**
|
|
2788
|
-
* Represents the props of the KendoReact ChartValueAxisItem component ([see example](
|
|
2788
|
+
* Represents the props of the KendoReact ChartValueAxisItem component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-categorical-chart-axes)).
|
|
2789
2789
|
*/
|
|
2790
2790
|
export declare interface ChartValueAxisItemProps extends ValueAxis {
|
|
2791
2791
|
/**
|
|
@@ -2795,12 +2795,12 @@ export declare interface ChartValueAxisItemProps extends ValueAxis {
|
|
|
2795
2795
|
}
|
|
2796
2796
|
|
|
2797
2797
|
/**
|
|
2798
|
-
* Represents the KendoReact ChartValueAxisLabels component ([see example](
|
|
2798
|
+
* Represents the KendoReact ChartValueAxisLabels component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/labels#toc-setting-the-appearance)).
|
|
2799
2799
|
*/
|
|
2800
2800
|
export declare const ChartValueAxisLabels: React_2.FunctionComponent<ChartValueAxisLabelsProps>;
|
|
2801
2801
|
|
|
2802
2802
|
/**
|
|
2803
|
-
* Represents the props of the KendoReact ChartValueAxisLabels component ([see example](
|
|
2803
|
+
* Represents the props of the KendoReact ChartValueAxisLabels component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/labels#toc-setting-the-appearance)).
|
|
2804
2804
|
*/
|
|
2805
2805
|
export declare interface ChartValueAxisLabelsProps extends ValueAxisLabels {
|
|
2806
2806
|
}
|
|
@@ -2846,7 +2846,7 @@ export declare interface ChartValueAxisNotesProps extends ValueAxisNotes {
|
|
|
2846
2846
|
}
|
|
2847
2847
|
|
|
2848
2848
|
/**
|
|
2849
|
-
* Represents the props of the KendoReact ChartValueAxis component ([see example](
|
|
2849
|
+
* Represents the props of the KendoReact ChartValueAxis component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-categorical-chart-axes)).
|
|
2850
2850
|
*/
|
|
2851
2851
|
export declare interface ChartValueAxisProps {
|
|
2852
2852
|
/**
|
|
@@ -2867,7 +2867,7 @@ export declare interface ChartValueAxisTitleProps extends ValueAxisTitle {
|
|
|
2867
2867
|
}
|
|
2868
2868
|
|
|
2869
2869
|
/**
|
|
2870
|
-
* Represents the KendoReact ChartXAxis component ([see example](
|
|
2870
|
+
* Represents the KendoReact ChartXAxis component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-scatter-chart-axes)).
|
|
2871
2871
|
*
|
|
2872
2872
|
* @remarks
|
|
2873
2873
|
* Supported children components are: {@link ChartXAxisItem}.
|
|
@@ -2904,7 +2904,7 @@ export declare interface ChartXAxisCrosshairTooltipProps extends XAxisCrosshairT
|
|
|
2904
2904
|
}
|
|
2905
2905
|
|
|
2906
2906
|
/**
|
|
2907
|
-
* Represents the KendoReact ChartXAxisItem component ([see example](
|
|
2907
|
+
* Represents the KendoReact ChartXAxisItem component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-scatter-chart-axes)).
|
|
2908
2908
|
*
|
|
2909
2909
|
* @remarks
|
|
2910
2910
|
* Supported children components are: {@link ChartXAxisCrosshair}, {@link ChartXAxisLabels}, {@link ChartXAxisNotes}, {@link ChartXAxisTitle}.
|
|
@@ -2912,7 +2912,7 @@ export declare interface ChartXAxisCrosshairTooltipProps extends XAxisCrosshairT
|
|
|
2912
2912
|
export declare const ChartXAxisItem: React_2.FunctionComponent<ChartXAxisItemProps>;
|
|
2913
2913
|
|
|
2914
2914
|
/**
|
|
2915
|
-
* Represents the props of the KendoReact ChartXAxisItem component ([see example](
|
|
2915
|
+
* Represents the props of the KendoReact ChartXAxisItem component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-scatter-chart-axes)).
|
|
2916
2916
|
*/
|
|
2917
2917
|
export declare interface ChartXAxisItemProps extends XAxis {
|
|
2918
2918
|
/**
|
|
@@ -2973,7 +2973,7 @@ export declare interface ChartXAxisNotesProps extends XAxisNotes {
|
|
|
2973
2973
|
}
|
|
2974
2974
|
|
|
2975
2975
|
/**
|
|
2976
|
-
* Represents the props of the KendoReact ChartXAxis component ([see example](
|
|
2976
|
+
* Represents the props of the KendoReact ChartXAxis component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-scatter-chart-axes)).
|
|
2977
2977
|
*/
|
|
2978
2978
|
export declare interface ChartXAxisProps {
|
|
2979
2979
|
/**
|
|
@@ -2994,7 +2994,7 @@ export declare interface ChartXAxisTitleProps extends XAxisTitle {
|
|
|
2994
2994
|
}
|
|
2995
2995
|
|
|
2996
2996
|
/**
|
|
2997
|
-
* Represents the KendoReact ChartYAxis component ([see example](
|
|
2997
|
+
* Represents the KendoReact ChartYAxis component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-scatter-chart-axes)).
|
|
2998
2998
|
*
|
|
2999
2999
|
* @remarks
|
|
3000
3000
|
* Supported children components are: {@link ChartYAxisItem}.
|
|
@@ -3033,7 +3033,7 @@ export declare interface ChartYAxisCrosshairTooltipProps extends YAxisCrosshairT
|
|
|
3033
3033
|
export declare const ChartYAxisItem: React_2.FunctionComponent<ChartYAxisItemProps>;
|
|
3034
3034
|
|
|
3035
3035
|
/**
|
|
3036
|
-
* Represents the props of the KendoReact ChartYAxisItem component ([see example](
|
|
3036
|
+
* Represents the props of the KendoReact ChartYAxisItem component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-scatter-chart-axes)).
|
|
3037
3037
|
*/
|
|
3038
3038
|
export declare interface ChartYAxisItemProps extends YAxis {
|
|
3039
3039
|
/**
|
|
@@ -3090,7 +3090,7 @@ export declare interface ChartYAxisNotesProps extends YAxisNotes {
|
|
|
3090
3090
|
}
|
|
3091
3091
|
|
|
3092
3092
|
/**
|
|
3093
|
-
* Represents the props of the KendoReact ChartXAxis component ([see example](
|
|
3093
|
+
* Represents the props of the KendoReact ChartXAxis component ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-scatter-chart-axes)).
|
|
3094
3094
|
*/
|
|
3095
3095
|
export declare interface ChartYAxisProps {
|
|
3096
3096
|
/**
|
|
@@ -3433,7 +3433,7 @@ export declare class DragStartEvent extends PreventableEvent {
|
|
|
3433
3433
|
/**
|
|
3434
3434
|
* Arguments for the `drilldown` event.
|
|
3435
3435
|
*
|
|
3436
|
-
* See [Drilldown Charts](
|
|
3436
|
+
* See [Drilldown Charts](https://www.telerik.com/kendo-react-ui/components/charts/drill-down).
|
|
3437
3437
|
*/
|
|
3438
3438
|
export declare class DrilldownEvent extends BaseEvent {
|
|
3439
3439
|
/**
|
|
@@ -3449,13 +3449,13 @@ export declare class DrilldownEvent extends BaseEvent {
|
|
|
3449
3449
|
*/
|
|
3450
3450
|
value: any;
|
|
3451
3451
|
/**
|
|
3452
|
-
* The current Chart [drilldown state](
|
|
3452
|
+
* The current Chart [drilldown state](https://www.telerik.com/kendo-react-ui/components/charts/api/chartprops#toc-drilldownstate).
|
|
3453
3453
|
*/
|
|
3454
3454
|
currentState: ChartDrilldownState;
|
|
3455
3455
|
/**
|
|
3456
|
-
* The Chart [drilldown state](
|
|
3456
|
+
* The Chart [drilldown state](https://www.telerik.com/kendo-react-ui/components/charts/api/chartprops#toc-drilldownstate) that will apply the current drilldown operation.
|
|
3457
3457
|
*
|
|
3458
|
-
* See [Drilldown](
|
|
3458
|
+
* See [Drilldown](https://www.telerik.com/kendo-react-ui/components/charts/drill-down) for an application example.
|
|
3459
3459
|
*/
|
|
3460
3460
|
nextState: ChartDrilldownState;
|
|
3461
3461
|
/**
|
|
@@ -3465,7 +3465,7 @@ export declare class DrilldownEvent extends BaseEvent {
|
|
|
3465
3465
|
}
|
|
3466
3466
|
|
|
3467
3467
|
/**
|
|
3468
|
-
* Represents the props of a [Drilldown Series Factory](
|
|
3468
|
+
* Represents the props of a [Drilldown Series Factory](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-drilldownseriesfactory) component.
|
|
3469
3469
|
*/
|
|
3470
3470
|
export declare interface DrilldownSeriesFactoryProps {
|
|
3471
3471
|
/**
|
|
@@ -3485,17 +3485,17 @@ export declare interface DrilldownSeriesFactoryProps {
|
|
|
3485
3485
|
/**
|
|
3486
3486
|
* Arguments for the `drilldownStateChange` event on the Chart Breadcrumb.
|
|
3487
3487
|
*
|
|
3488
|
-
* See [Drilldown Charts](
|
|
3488
|
+
* See [Drilldown Charts](https://www.telerik.com/kendo-react-ui/components/charts/drill-down).
|
|
3489
3489
|
*/
|
|
3490
3490
|
export declare class DrilldownStateChangeEvent {
|
|
3491
3491
|
/**
|
|
3492
|
-
* The current Chart [drilldown state](
|
|
3492
|
+
* The current Chart [drilldown state](https://www.telerik.com/kendo-react-ui/components/charts/api/chartprops#toc-drilldownstate).
|
|
3493
3493
|
*/
|
|
3494
3494
|
currentState: ChartDrilldownState;
|
|
3495
3495
|
/**
|
|
3496
|
-
* The Chart [drilldown state](
|
|
3496
|
+
* The Chart [drilldown state](https://www.telerik.com/kendo-react-ui/components/charts/api/chartprops#toc-drilldownstate) that will apply the current drilldown operation.
|
|
3497
3497
|
*
|
|
3498
|
-
* See [Drilldown](
|
|
3498
|
+
* See [Drilldown](https://www.telerik.com/kendo-react-ui/components/charts/drill-down) for an application example.
|
|
3499
3499
|
*/
|
|
3500
3500
|
nextState: ChartDrilldownState;
|
|
3501
3501
|
/**
|
|
@@ -3617,7 +3617,7 @@ export { FocusHighlight }
|
|
|
3617
3617
|
export { FocusHighlightBorder }
|
|
3618
3618
|
|
|
3619
3619
|
/**
|
|
3620
|
-
* The appearance configuration for the major and minor axis grid lines (see the [basic usage example](
|
|
3620
|
+
* The appearance configuration for the major and minor axis grid lines (see the [basic usage example](https://www.telerik.com/kendo-react-ui/components/charts/api/chartaxisdefaults)).
|
|
3621
3621
|
*/
|
|
3622
3622
|
export declare interface GridLines {
|
|
3623
3623
|
/**
|
|
@@ -3797,7 +3797,7 @@ export declare interface LabelRotation {
|
|
|
3797
3797
|
*/
|
|
3798
3798
|
export declare interface Legend {
|
|
3799
3799
|
/**
|
|
3800
|
-
* The legend is horizontally aligned when [`legend.position`](
|
|
3800
|
+
* The legend is horizontally aligned when [`legend.position`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartlegendprops#toc-position) is set to `"top"` or `"bottom"`. The legend is vertically aligned when [`legend.position`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartlegendprops#toc-position) is set to `"left"` or `"right"`.
|
|
3801
3801
|
*
|
|
3802
3802
|
* The supported values are:
|
|
3803
3803
|
* - `"start"`—The legend is aligned to the start.
|
|
@@ -3814,7 +3814,7 @@ export declare interface Legend {
|
|
|
3814
3814
|
*/
|
|
3815
3815
|
border?: Border;
|
|
3816
3816
|
/**
|
|
3817
|
-
* The height of the legend when [`legend.orientation`](
|
|
3817
|
+
* The height of the legend when [`legend.orientation`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartlegendprops#toc-orientation) is set to `"vertical"`.
|
|
3818
3818
|
*/
|
|
3819
3819
|
height?: number;
|
|
3820
3820
|
/**
|
|
@@ -3853,7 +3853,7 @@ export declare interface Legend {
|
|
|
3853
3853
|
* - `"bottom"`—The legend is positioned on the bottom.
|
|
3854
3854
|
* - `"left"`—The legend is positioned on the left.
|
|
3855
3855
|
* - `"right"`—The legend is positioned on the right.
|
|
3856
|
-
* - `"custom"`—The legend is positioned by using [`legend.offsetX`](
|
|
3856
|
+
* - `"custom"`—The legend is positioned by using [`legend.offsetX`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartlegendprops#toc-offsetx) and [`legend.offsetY`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartlegendprops#toc-offsety).
|
|
3857
3857
|
*/
|
|
3858
3858
|
position?: 'top' | 'bottom' | 'left' | 'right' | 'custom';
|
|
3859
3859
|
/**
|
|
@@ -3861,11 +3861,11 @@ export declare interface Legend {
|
|
|
3861
3861
|
*/
|
|
3862
3862
|
reverse?: boolean;
|
|
3863
3863
|
/**
|
|
3864
|
-
* If set to `true`, the Chart displays the legend ([see example](
|
|
3864
|
+
* If set to `true`, the Chart displays the legend ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/legend#toc-hiding-the-legend)). By default, the Chart legend is visible.
|
|
3865
3865
|
*/
|
|
3866
3866
|
visible?: boolean;
|
|
3867
3867
|
/**
|
|
3868
|
-
* The legend width when the [`legend.orientation`](
|
|
3868
|
+
* The legend width when the [`legend.orientation`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartlegendprops#toc-orientation) is set to `"horizontal"`.
|
|
3869
3869
|
*/
|
|
3870
3870
|
width?: number;
|
|
3871
3871
|
/**
|
|
@@ -4624,7 +4624,7 @@ export declare interface Overlay {
|
|
|
4624
4624
|
}
|
|
4625
4625
|
|
|
4626
4626
|
/**
|
|
4627
|
-
* The padding configuration for each side (see the [basic usage example](
|
|
4627
|
+
* The padding configuration for each side (see the [basic usage example](https://www.telerik.com/kendo-react-ui/components/charts/api/charttitle)).
|
|
4628
4628
|
*/
|
|
4629
4629
|
export declare interface Padding extends Margin {
|
|
4630
4630
|
}
|
|
@@ -4662,7 +4662,7 @@ export declare interface Pane {
|
|
|
4662
4662
|
*/
|
|
4663
4663
|
padding?: Padding | number;
|
|
4664
4664
|
/**
|
|
4665
|
-
* The title configuration of the pane. To display the title, set the [`panes.title.text`](
|
|
4665
|
+
* The title configuration of the pane. To display the title, set the [`panes.title.text`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartpanetitleprops#toc-text) option.
|
|
4666
4666
|
*/
|
|
4667
4667
|
title?: string | PanesTitle;
|
|
4668
4668
|
/**
|
|
@@ -4707,7 +4707,7 @@ export declare interface PaneDefaults {
|
|
|
4707
4707
|
*/
|
|
4708
4708
|
padding?: Padding | number;
|
|
4709
4709
|
/**
|
|
4710
|
-
* The title configuration of the pane. To display the title, set the [`panes.title.text`](
|
|
4710
|
+
* The title configuration of the pane. To display the title, set the [`panes.title.text`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartpanetitleprops#toc-text) option.
|
|
4711
4711
|
*/
|
|
4712
4712
|
title?: PaneDefaultsTitle;
|
|
4713
4713
|
}
|
|
@@ -4755,7 +4755,7 @@ export declare interface PaneDefaultsTitle {
|
|
|
4755
4755
|
* The available argument fields are:
|
|
4756
4756
|
*
|
|
4757
4757
|
* - `text`—The label text.
|
|
4758
|
-
* - `rect`—The [geometry Rect](
|
|
4758
|
+
* - `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.
|
|
4759
4759
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
4760
4760
|
* - `options`—The label options.
|
|
4761
4761
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
@@ -4810,7 +4810,7 @@ export declare interface PanesTitle {
|
|
|
4810
4810
|
* The available argument fields are:
|
|
4811
4811
|
*
|
|
4812
4812
|
* - `text`—The label text.
|
|
4813
|
-
* - `rect`—The [geometry Rect](
|
|
4813
|
+
* - `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.
|
|
4814
4814
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
4815
4815
|
* - `options`—The label options.
|
|
4816
4816
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
@@ -4907,7 +4907,7 @@ export declare class PlotAreaHoverEvent extends BaseEvent {
|
|
|
4907
4907
|
}
|
|
4908
4908
|
|
|
4909
4909
|
/**
|
|
4910
|
-
* A plot band ([see example](
|
|
4910
|
+
* A plot band ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-bands)).
|
|
4911
4911
|
*/
|
|
4912
4912
|
export declare interface PlotBand {
|
|
4913
4913
|
/**
|
|
@@ -4931,7 +4931,7 @@ export declare interface PlotBand {
|
|
|
4931
4931
|
*
|
|
4932
4932
|
* To display a label, set the text option.
|
|
4933
4933
|
*
|
|
4934
|
-
* See [Plot Bands - Labels](
|
|
4934
|
+
* See [Plot Bands - Labels](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/plot-bands#toc-labels) for sample usage.
|
|
4935
4935
|
*/
|
|
4936
4936
|
label?: PlotBandLabel;
|
|
4937
4937
|
}
|
|
@@ -5011,7 +5011,7 @@ export declare interface PlotBandLabel {
|
|
|
5011
5011
|
* The available argument fields are:
|
|
5012
5012
|
*
|
|
5013
5013
|
* - `text`—The label text.
|
|
5014
|
-
* - `rect`—The geometry [`Rect`](
|
|
5014
|
+
* - `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.
|
|
5015
5015
|
* - `options`—The label options.
|
|
5016
5016
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
5017
5017
|
* - `sender`—A reference to the Chart instance.
|
|
@@ -5095,7 +5095,7 @@ export { SankeyExportVisualOptions }
|
|
|
5095
5095
|
|
|
5096
5096
|
/**
|
|
5097
5097
|
* Represents the object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)
|
|
5098
|
-
* callback of the [Sankey](
|
|
5098
|
+
* callback of the [Sankey](https://www.telerik.com/kendo-react-ui/components/charts/api/sankey) component.
|
|
5099
5099
|
*/
|
|
5100
5100
|
export declare interface SankeyHandle {
|
|
5101
5101
|
/**
|
|
@@ -5143,7 +5143,7 @@ export { SankeyNodeDefaults }
|
|
|
5143
5143
|
export { SankeyOptions }
|
|
5144
5144
|
|
|
5145
5145
|
/**
|
|
5146
|
-
* Represents the props of the KendoReact [Sankey](
|
|
5146
|
+
* Represents the props of the KendoReact [Sankey](https://www.telerik.com/kendo-react-ui/components/charts/api/sankey) component.
|
|
5147
5147
|
*/
|
|
5148
5148
|
export declare interface SankeyProps {
|
|
5149
5149
|
/**
|
|
@@ -5348,7 +5348,7 @@ export declare class SelectStartEvent extends PreventableEvent {
|
|
|
5348
5348
|
*/
|
|
5349
5349
|
export declare interface Series {
|
|
5350
5350
|
/**
|
|
5351
|
-
* The aggregate function for the date series ([see example](
|
|
5351
|
+
* The aggregate function for the date series ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/axes#toc-aggregating-data)). The function is used when a category (year, month, or other) contains two or more points. The Chart displays the return value of the function instead of the individual points.
|
|
5352
5352
|
*
|
|
5353
5353
|
* The supported values are:
|
|
5354
5354
|
* - `"avg"`—The average of all values for the date period.
|
|
@@ -5363,7 +5363,7 @@ export declare interface Series {
|
|
|
5363
5363
|
*/
|
|
5364
5364
|
aggregate?: any;
|
|
5365
5365
|
/**
|
|
5366
|
-
* The name of the value axis. The axis option is supported for Scatter plots. For more information on Scatter plots, refer to [`xAxis`](
|
|
5366
|
+
* The name of the value axis. The axis option is supported for Scatter plots. For more information on Scatter plots, refer to [`xAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops) and [`yAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxisitemprops).
|
|
5367
5367
|
*/
|
|
5368
5368
|
axis?: string;
|
|
5369
5369
|
/**
|
|
@@ -5371,11 +5371,11 @@ export declare interface Series {
|
|
|
5371
5371
|
*/
|
|
5372
5372
|
autoFit?: boolean;
|
|
5373
5373
|
/**
|
|
5374
|
-
* The border of the Chart series. The border option is supported when [`series.type`](
|
|
5374
|
+
* The border of the Chart series. The border option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bar"`, `"column"`, `"donut"`, `"pie"`, `"bubble"`, `"boxPlot"`, `"candlestick"`, or `"ohlc"`.
|
|
5375
5375
|
*/
|
|
5376
5376
|
border?: Border;
|
|
5377
5377
|
/**
|
|
5378
|
-
* The name of the category axis that will be used for the series. If no [`categoryAxis`](
|
|
5378
|
+
* The name of the category axis that will be used for the series. If no [`categoryAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitemprops) is specified, the first axis is used.
|
|
5379
5379
|
*/
|
|
5380
5380
|
categoryAxis?: string;
|
|
5381
5381
|
/**
|
|
@@ -5383,7 +5383,7 @@ export declare interface Series {
|
|
|
5383
5383
|
*/
|
|
5384
5384
|
categoryField?: string;
|
|
5385
5385
|
/**
|
|
5386
|
-
* The data field that contains the `close` value. The `closeField` option is supported when [`series.type`](
|
|
5386
|
+
* The data field that contains the `close` value. The `closeField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"candlestick"` or `"ohlc"`.
|
|
5387
5387
|
*/
|
|
5388
5388
|
closeField?: string;
|
|
5389
5389
|
/**
|
|
@@ -5395,19 +5395,19 @@ export declare interface Series {
|
|
|
5395
5395
|
*/
|
|
5396
5396
|
color?: any;
|
|
5397
5397
|
/**
|
|
5398
|
-
* The data item field which contains the series color. The `colorField` option is supported when [`series.type`](
|
|
5398
|
+
* The data item field which contains the series color. The `colorField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bar"`, `"column"`, `"rangeBar"`, `"rangeColumn"`, `"bubble"`, `"donut"`, `"pie"`, `"candlestick"`, `"ohlc"`, or `"waterfall"`.
|
|
5399
5399
|
*/
|
|
5400
5400
|
colorField?: string;
|
|
5401
5401
|
/**
|
|
5402
|
-
* The label connectors options. The connectors option is supported when [`series.type`](
|
|
5402
|
+
* The label connectors options. The connectors option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"` or `"pie"` and [`series.labels.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartserieslabelsprops#toc-visible) is set to `true`.
|
|
5403
5403
|
*/
|
|
5404
5404
|
connectors?: LabelConnectors;
|
|
5405
5405
|
/**
|
|
5406
|
-
* The data item field which contains the current value. The `currentField` option is supported when [`series.type`](
|
|
5406
|
+
* The data item field which contains the current value. The `currentField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bullet"` or `"verticalBullet"`.
|
|
5407
5407
|
*/
|
|
5408
5408
|
currentField?: string;
|
|
5409
5409
|
/**
|
|
5410
|
-
* The dash type of line Chart. The `dashType` option is considered only if the [`series.type`](
|
|
5410
|
+
* The dash type of line Chart. The `dashType` option is considered only if the [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) option is set to `"line"`.
|
|
5411
5411
|
*
|
|
5412
5412
|
* The following dash types are supported:
|
|
5413
5413
|
* - `"dash"`—A line consisting of dashes.
|
|
@@ -5423,43 +5423,43 @@ export declare interface Series {
|
|
|
5423
5423
|
* The array of data items which represent the series data.
|
|
5424
5424
|
*
|
|
5425
5425
|
* You can set it to:
|
|
5426
|
-
* - Array of objects. Each point is bound to the field specified through the [`series.field`](
|
|
5427
|
-
* - Array of numbers. Supported when the [`series.type`](
|
|
5428
|
-
* - Array of arrays of numbers. Supported when the [`series.type`](
|
|
5426
|
+
* - Array of objects. Each point is bound to the field specified through the [`series.field`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-field) option.
|
|
5427
|
+
* - Array of numbers. Supported when the [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) option is set to `"area"`, `"bar"`, `"column"`, `"donut"`, `"pie"`, `"line"`, or `"waterfall"`.
|
|
5428
|
+
* - Array of arrays of numbers. Supported when the [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) option is set to `"bubble"`, `"scatter"`, `"scatterLine"`, `"ohlc"`, `"polar"`, `"rangeBar"`, or `"rangeArea"`.
|
|
5429
5429
|
*
|
|
5430
5430
|
* The Bubble series need arrays of three values—X value, Y value, and Size value—for example, `[1, 1, 10]`. The Scatter and ScatterLine series need arrays of two values—X value and Y value. The OHLC and Candlestick series need arrays of four values—open, high, low, and close. The RangeBar and RangeArea series need arrays of two values—the from and to value.
|
|
5431
5431
|
*/
|
|
5432
5432
|
data?: any[];
|
|
5433
5433
|
/**
|
|
5434
|
-
* The series color when the open value is greater than the close value. The `downColor` option is supported when [`series.type`](
|
|
5434
|
+
* The series color when the open value is greater than the close value. The `downColor` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"candlestick"`.
|
|
5435
5435
|
*/
|
|
5436
5436
|
downColor?: string;
|
|
5437
5437
|
/**
|
|
5438
|
-
* The data field which contains the color that is applied when the `open` value is greater than the `close` value. The `downColorField` option is supported when [`series.type`](
|
|
5438
|
+
* The data field which contains the color that is applied when the `open` value is greater than the `close` value. The `downColorField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"candlestick"`.
|
|
5439
5439
|
*/
|
|
5440
5440
|
downColorField?: string;
|
|
5441
5441
|
/**
|
|
5442
|
-
* The data field which contains the value to use to [drill down](
|
|
5442
|
+
* The data field which contains the value to use to [drill down](https://www.telerik.com/kendo-react-ui/components/charts/drill-down) into detailed data for the point.
|
|
5443
5443
|
*/
|
|
5444
5444
|
drilldownField?: string;
|
|
5445
5445
|
/**
|
|
5446
|
-
* The `dynamicHeight` option is supported when [`series.type`](
|
|
5446
|
+
* The `dynamicHeight` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"funnel"` or `"pyramid"`. When set to `false`, all segments become with the same height. Otherwise, the height of each segment is based on its value.
|
|
5447
5447
|
*/
|
|
5448
5448
|
dynamicHeight?: boolean;
|
|
5449
5449
|
/**
|
|
5450
|
-
* The `dynamicSlope` option is supported when [`series.type`](
|
|
5450
|
+
* The `dynamicSlope` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"funnel"`. When set to `true`, the ratio of the bases of each segment is calculated based on the ratio of `currentDataItem.value`/`nextDataItem.value`. The last element is always created like a rectangle since there is no following element.
|
|
5451
5451
|
*/
|
|
5452
5452
|
dynamicSlope?: boolean;
|
|
5453
5453
|
/**
|
|
5454
|
-
* The data item field which contains the [`series.errorBars`](
|
|
5454
|
+
* The data item field which contains the [`series.errorBars`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-errorbars) high value ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-categorical-charts)). The `errorHighField` 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"`, or `"area"`.
|
|
5455
5455
|
*/
|
|
5456
5456
|
errorHighField?: string;
|
|
5457
5457
|
/**
|
|
5458
|
-
* The data item field which contains the [`series.errorBars`](
|
|
5458
|
+
* The data item field which contains the [`series.errorBars`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-errorbars) low value ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-categorical-charts)). The `errorLowField` 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"`, or `"area"`.
|
|
5459
5459
|
*/
|
|
5460
5460
|
errorLowField?: string;
|
|
5461
5461
|
/**
|
|
5462
|
-
* The data item field which contains a Boolean value indicating whether the sector is exploded. The `explodeField` option is supported when [`series.type`](
|
|
5462
|
+
* The data item field which contains a Boolean value indicating whether the sector is exploded. The `explodeField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"` or `"pie"`.
|
|
5463
5463
|
*/
|
|
5464
5464
|
explodeField?: string;
|
|
5465
5465
|
/**
|
|
@@ -5469,7 +5469,7 @@ export declare interface Series {
|
|
|
5469
5469
|
/**
|
|
5470
5470
|
* The name of the parent series of the trendline.
|
|
5471
5471
|
*
|
|
5472
|
-
* The `for` option is supported when [`series.type`](
|
|
5472
|
+
* The `for` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to
|
|
5473
5473
|
* "`linearTrendline`", "`exponentialTrendline`", "`logarithmicTrendline`", "`powerTrendline`", "`polynomialTrendline`" or "`movingAverageTrendline`".
|
|
5474
5474
|
*/
|
|
5475
5475
|
for?: string;
|
|
@@ -5478,23 +5478,23 @@ export declare interface Series {
|
|
|
5478
5478
|
*/
|
|
5479
5479
|
fromField?: string;
|
|
5480
5480
|
/**
|
|
5481
|
-
* The distance between the categories expressed as a percentage of the bar width. See the related spacing setting. The `gap` option is supported when [`series.type`](
|
|
5481
|
+
* The distance between the categories expressed as a percentage of the bar width. See the related spacing setting. The `gap` 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"`, `"radarColumn"`, or `"waterfall"`.
|
|
5482
5482
|
*/
|
|
5483
5483
|
gap?: number;
|
|
5484
5484
|
/**
|
|
5485
|
-
* The data field which contains the high value. The `highField` option is supported when [`series.type`](
|
|
5485
|
+
* The data field which contains the high value. The `highField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"candlestick"` or `"ohlc"`.
|
|
5486
5486
|
*/
|
|
5487
5487
|
highField?: string;
|
|
5488
5488
|
/**
|
|
5489
|
-
* The diameter of the donut hole in pixels. The `holeSize` option is supported when [`series.type`](
|
|
5489
|
+
* The diameter of the donut hole in pixels. The `holeSize` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"`.
|
|
5490
5490
|
*/
|
|
5491
5491
|
holeSize?: number;
|
|
5492
5492
|
/**
|
|
5493
|
-
* The Chart line configuration options. The line option is supported when [`series.type`](
|
|
5493
|
+
* The Chart line configuration options. The line option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"area"`, `"candlestick"`, `"ohlc"`, or `"waterfall"`.
|
|
5494
5494
|
*/
|
|
5495
5495
|
line?: SeriesLine;
|
|
5496
5496
|
/**
|
|
5497
|
-
* The data field containing the low value. The `lowField` option is supported when [`series.type`](
|
|
5497
|
+
* The data field containing the low value. The `lowField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"candlestick"` or `"ohlc"`.
|
|
5498
5498
|
*/
|
|
5499
5499
|
lowField?: string;
|
|
5500
5500
|
/**
|
|
@@ -5522,7 +5522,7 @@ export declare interface Series {
|
|
|
5522
5522
|
*/
|
|
5523
5523
|
minSize?: number;
|
|
5524
5524
|
/**
|
|
5525
|
-
* The behavior for handling missing values. The `missingValues` option is available when [`series.type`](
|
|
5525
|
+
* The behavior for handling missing values. The `missingValues` option is available when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatterLine"`, `"radarLine"`, `"radarArea"`, `"polarLine"`, or `"polarArea"`.
|
|
5526
5526
|
*
|
|
5527
5527
|
* The supported values are:
|
|
5528
5528
|
* - `"gap"`—The plot stops before the missing point and continues after it.
|
|
@@ -5535,7 +5535,7 @@ export declare interface Series {
|
|
|
5535
5535
|
*/
|
|
5536
5536
|
name?: string;
|
|
5537
5537
|
/**
|
|
5538
|
-
* Specifies the top-base/bottom-base ratio of the whole Funnel Chart. If the `neckRatio` is set to `3`, it means the top base is three times smaller than the bottom base. The `neckRatio` option is supported when [`series.type`](
|
|
5538
|
+
* Specifies the top-base/bottom-base ratio of the whole Funnel Chart. If the `neckRatio` is set to `3`, it means the top base is three times smaller than the bottom base. The `neckRatio` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"funnel"` and `dynamicSlope` is set to `false`.
|
|
5539
5539
|
*/
|
|
5540
5540
|
neckRatio?: number;
|
|
5541
5541
|
/**
|
|
@@ -5547,7 +5547,7 @@ export declare interface Series {
|
|
|
5547
5547
|
*/
|
|
5548
5548
|
negativeValues?: NegativeBubbleValues;
|
|
5549
5549
|
/**
|
|
5550
|
-
* The data item field which contains the series note text ([see example](
|
|
5550
|
+
* The data item field which contains the series note text ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/notes#toc-series-notes)).
|
|
5551
5551
|
*/
|
|
5552
5552
|
noteTextField?: string;
|
|
5553
5553
|
/**
|
|
@@ -5555,7 +5555,7 @@ export declare interface Series {
|
|
|
5555
5555
|
*/
|
|
5556
5556
|
opacity?: number;
|
|
5557
5557
|
/**
|
|
5558
|
-
* The data field which contains the open value. The `openField` option is available when [`series.type`](
|
|
5558
|
+
* The data field which contains the open value. The `openField` option is available when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"candlestick"` or `"ohlc"`.
|
|
5559
5559
|
*/
|
|
5560
5560
|
openField?: string;
|
|
5561
5561
|
/**
|
|
@@ -5567,7 +5567,7 @@ export declare interface Series {
|
|
|
5567
5567
|
*/
|
|
5568
5568
|
overlay?: Overlay;
|
|
5569
5569
|
/**
|
|
5570
|
-
* The padding around the Chart (equal on all sides). The padding option is available when [`series.type`](
|
|
5570
|
+
* The padding around the Chart (equal on all sides). The padding option is available when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"` or `"pie"`.
|
|
5571
5571
|
*/
|
|
5572
5572
|
padding?: number;
|
|
5573
5573
|
/**
|
|
@@ -5579,7 +5579,7 @@ export declare interface Series {
|
|
|
5579
5579
|
*/
|
|
5580
5580
|
q3Field?: string;
|
|
5581
5581
|
/**
|
|
5582
|
-
* The space in pixels between the different segments of the Funnel or Pyramid Chart. The `segmentSpacing` option is supported when [`series.type`](
|
|
5582
|
+
* The space in pixels between the different segments of the Funnel or Pyramid Chart. The `segmentSpacing` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"funnel"` or `"pyramid"`.
|
|
5583
5583
|
*/
|
|
5584
5584
|
segmentSpacing?: number;
|
|
5585
5585
|
/**
|
|
@@ -5591,13 +5591,13 @@ export declare interface Series {
|
|
|
5591
5591
|
*/
|
|
5592
5592
|
sizeField?: string;
|
|
5593
5593
|
/**
|
|
5594
|
-
* The distance between series points within a category. Expressed as a percentage of the bar width. See the related `gap` setting. The spacing option is supported when [`series.type`](
|
|
5594
|
+
* The distance between series points within a category. Expressed as a percentage of the bar width. See the related `gap` setting. 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"`, or `"radarColumn"`.
|
|
5595
5595
|
*/
|
|
5596
5596
|
spacing?: number;
|
|
5597
5597
|
/**
|
|
5598
|
-
* A Boolean value which indicates if the series have to be stacked. A string value is interpreted as [`series.stack.group`](
|
|
5598
|
+
* A Boolean value which indicates if the series have to be stacked. A string value is interpreted as [`series.stack.group`](https://www.telerik.com/kendo-react-ui/components/charts/api/seriesstack#toc-group).
|
|
5599
5599
|
*
|
|
5600
|
-
* The `stack` option is supported when [`series.type`](
|
|
5600
|
+
* 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"`. If not overridden, the stack settings of the first series are inherited as a default value by the rest of the series.
|
|
5601
5601
|
*/
|
|
5602
5602
|
stack?: boolean | string | SeriesStack;
|
|
5603
5603
|
/**
|
|
@@ -5605,12 +5605,12 @@ export declare interface Series {
|
|
|
5605
5605
|
*/
|
|
5606
5606
|
startAngle?: number;
|
|
5607
5607
|
/**
|
|
5608
|
-
* The `style` option is supported when [`series.type`](
|
|
5608
|
+
* The `style` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"line"`, `"scatterLine"`, `"radarLine"`, or `"polarLine"`.
|
|
5609
5609
|
*
|
|
5610
5610
|
* The supported values are:
|
|
5611
5611
|
* - `"normal"` (default)—The values are connected with a straight line.
|
|
5612
5612
|
* - `"step"`—The values are connected with a right-angled line.
|
|
5613
|
-
* Only available when [`series.type`](
|
|
5613
|
+
* Only available when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"line"`.
|
|
5614
5614
|
* - `"smooth"`—The values are connected with a smooth line.
|
|
5615
5615
|
* Not supported for stacked area series with missing values.
|
|
5616
5616
|
*/
|
|
@@ -5624,7 +5624,7 @@ export declare interface Series {
|
|
|
5624
5624
|
*/
|
|
5625
5625
|
summaryField?: string;
|
|
5626
5626
|
/**
|
|
5627
|
-
* The configuration options of the target. The `target` option is supported when [`series.type`](
|
|
5627
|
+
* The configuration options of the target. The `target` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bullet"` or `"verticalBullet"`.
|
|
5628
5628
|
*/
|
|
5629
5629
|
target?: BulletTarget;
|
|
5630
5630
|
/**
|
|
@@ -5688,7 +5688,7 @@ export declare interface Series {
|
|
|
5688
5688
|
*/
|
|
5689
5689
|
visibleInLegend?: boolean;
|
|
5690
5690
|
/**
|
|
5691
|
-
* The data item field which indicates whether to show the point category name in the legend. The `visibleInLegendField` option is supported when [`series.type`](
|
|
5691
|
+
* The data item field which indicates whether to show the point category name in the legend. The `visibleInLegendField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"funnel"`, `"pyramid"`, `"donut"`, or `"pie"`.
|
|
5692
5692
|
*/
|
|
5693
5693
|
visibleInLegendField?: string;
|
|
5694
5694
|
/**
|
|
@@ -5696,7 +5696,7 @@ export declare interface Series {
|
|
|
5696
5696
|
*
|
|
5697
5697
|
* The available argument fields are:
|
|
5698
5698
|
*
|
|
5699
|
-
* - `rect`—The geometry [`Rect`](
|
|
5699
|
+
* - `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.
|
|
5700
5700
|
* - `options`—The point options.
|
|
5701
5701
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
5702
5702
|
* - `category`—The point category.
|
|
@@ -5717,23 +5717,23 @@ export declare interface Series {
|
|
|
5717
5717
|
*/
|
|
5718
5718
|
visual?: (e: SeriesVisualArgs) => drawing.Element;
|
|
5719
5719
|
/**
|
|
5720
|
-
* The line width. The `width` option is supported when [`series.type`](
|
|
5720
|
+
* The line width. The `width` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"line"`, `"scatterLine"`, `"radarLine"`, or `"polarLine"`.
|
|
5721
5721
|
*/
|
|
5722
5722
|
width?: number;
|
|
5723
5723
|
/**
|
|
5724
|
-
* The name of the X axis. The [`xAxis`](
|
|
5724
|
+
* The name of the X axis. The [`xAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops) option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or `"polar"` series. For the Polar series, the [`xAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops) range is expressed in degrees.
|
|
5725
5725
|
*/
|
|
5726
5726
|
xAxis?: string;
|
|
5727
5727
|
/**
|
|
5728
|
-
* The data item field which contains the [`series.errorBars`](
|
|
5728
|
+
* The data item field which contains the [`series.errorBars`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-errorbars) xAxis high value ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-scatter-charts)). The `xErrorHighField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"scatter"``, `"scatterLine"`, or `"bubble"`.
|
|
5729
5729
|
*/
|
|
5730
5730
|
xErrorHighField?: string;
|
|
5731
5731
|
/**
|
|
5732
|
-
* The data item field which contains the [`series.errorBars`](
|
|
5732
|
+
* The data item field which contains the [`series.errorBars`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-errorbars) xAxis low value ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-scatter-charts)). The `xErrorLowField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
|
|
5733
5733
|
*/
|
|
5734
5734
|
xErrorLowField?: string;
|
|
5735
5735
|
/**
|
|
5736
|
-
* The data item field containing the x value. The `xField` option is supported when [`series.type`](
|
|
5736
|
+
* The data item field containing the x value. The `xField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bubble"`, `"scatter"`, `"scatterLine"`, or `"polar"` series.
|
|
5737
5737
|
*/
|
|
5738
5738
|
xField?: string;
|
|
5739
5739
|
/**
|
|
@@ -5741,15 +5741,15 @@ export declare interface Series {
|
|
|
5741
5741
|
*/
|
|
5742
5742
|
yAxis?: string;
|
|
5743
5743
|
/**
|
|
5744
|
-
* The data item field which contains the [`series.errorBars`](
|
|
5744
|
+
* The data item field which contains the [`series.errorBars`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-errorbars) yAxis high value ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-scatter-charts)). The `yErrorHighField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
|
|
5745
5745
|
*/
|
|
5746
5746
|
yErrorHighField?: string;
|
|
5747
5747
|
/**
|
|
5748
|
-
* The data item field which contains the [`series.errorBars`](
|
|
5748
|
+
* The data item field which contains the [`series.errorBars`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-errorbars) yAxis low value ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-scatter-charts)). The `yErrorLowField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
|
|
5749
5749
|
*/
|
|
5750
5750
|
yErrorLowField?: string;
|
|
5751
5751
|
/**
|
|
5752
|
-
* The data item field containing the y value. The `yField` option is supported when [`series.type`](
|
|
5752
|
+
* The data item field containing the y value. The `yField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bubble"`, `"scatter"`, or `"scatterLine"`.
|
|
5753
5753
|
*/
|
|
5754
5754
|
yField?: string;
|
|
5755
5755
|
/**
|
|
@@ -5757,11 +5757,11 @@ export declare interface Series {
|
|
|
5757
5757
|
*/
|
|
5758
5758
|
zIndex?: number;
|
|
5759
5759
|
/**
|
|
5760
|
-
* The error bars of the Chart series. The `errorBars` option is supported when [`series.type`](
|
|
5760
|
+
* The error bars of the Chart series. The `errorBars` 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"`, `"scatter"`, `"scatterLine"`, or `"bubble"`.
|
|
5761
5761
|
*/
|
|
5762
5762
|
errorBars?: SeriesErrorBars;
|
|
5763
5763
|
/**
|
|
5764
|
-
* The configuration of the Chart series extremes. Applies to extreme outliers. For more information, refer to [`series.outliers`](
|
|
5764
|
+
* The configuration of the Chart series extremes. Applies to extreme outliers. For more information, refer to [`series.outliers`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-outliers).
|
|
5765
5765
|
*/
|
|
5766
5766
|
extremes?: SeriesExtremes;
|
|
5767
5767
|
/**
|
|
@@ -5769,11 +5769,11 @@ export declare interface Series {
|
|
|
5769
5769
|
*/
|
|
5770
5770
|
highlight?: SeriesHighlight;
|
|
5771
5771
|
/**
|
|
5772
|
-
* The configuration of the Chart series label. The Chart displays the series labels when the [`series.labels.visible`](
|
|
5772
|
+
* The configuration of the Chart series label. The Chart displays the series labels when the [`series.labels.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartserieslabelsprops#toc-visible) option is set to `true`.
|
|
5773
5773
|
*/
|
|
5774
5774
|
labels?: SeriesLabels;
|
|
5775
5775
|
/**
|
|
5776
|
-
* The configuration of the Chart series marker. The Chart displays the series markers when the [`series.markers.visible`](
|
|
5776
|
+
* The configuration of the Chart series marker. The Chart displays the series markers when the [`series.markers.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesmarkersprops#toc-visible) option is set to `true`. The markers option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"area"`, `"rangeArea"`, `"line"`, `"scatter"`, `"scatterLine"`, `"radarLine"`, `"radarArea"`, `"polarLine"`, `"polarScatter"`, or `"polarArea"`.
|
|
5777
5777
|
*/
|
|
5778
5778
|
markers?: SeriesMarkers;
|
|
5779
5779
|
/**
|
|
@@ -5786,7 +5786,7 @@ export declare interface Series {
|
|
|
5786
5786
|
*/
|
|
5787
5787
|
notes?: SeriesNotes;
|
|
5788
5788
|
/**
|
|
5789
|
-
* The configuration of the Chart series outliers. Applies to mild outliers. For more information, refer to [`series.extremes`](
|
|
5789
|
+
* The configuration of the Chart series outliers. Applies to mild outliers. For more information, refer to [`series.extremes`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-extremes).
|
|
5790
5790
|
*/
|
|
5791
5791
|
outliers?: SeriesOutliers;
|
|
5792
5792
|
/**
|
|
@@ -5796,7 +5796,7 @@ export declare interface Series {
|
|
|
5796
5796
|
/**
|
|
5797
5797
|
* The configuration options of the series trendlines.
|
|
5798
5798
|
*
|
|
5799
|
-
* The `trendline` option is supported when [`series.type`](
|
|
5799
|
+
* The `trendline` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to
|
|
5800
5800
|
* "`linearTrendline`", "`exponentialTrendline`", "`logarithmicTrendline`", "`powerTrendline`", "`polynomialTrendline`" or "`movingAverageTrendline`".
|
|
5801
5801
|
*/
|
|
5802
5802
|
trendline?: SeriesTrendline;
|
|
@@ -5806,7 +5806,7 @@ export declare interface Series {
|
|
|
5806
5806
|
pattern?: SeriesPattern | ((point: any) => SeriesPattern);
|
|
5807
5807
|
/**
|
|
5808
5808
|
* The data item field which contains the series pattern.
|
|
5809
|
-
* The `patternField` option is supported when [`series.type`](
|
|
5809
|
+
* The `patternField` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"pie"`, `"donut"`, `"funnel"`, `"heatmap"`, or `"pyramid"`.
|
|
5810
5810
|
*/
|
|
5811
5811
|
patternField?: string;
|
|
5812
5812
|
/**
|
|
@@ -5877,11 +5877,11 @@ export declare interface SeriesDefaults {
|
|
|
5877
5877
|
*/
|
|
5878
5878
|
overlay?: Overlay;
|
|
5879
5879
|
/**
|
|
5880
|
-
* The space between the Chart series as a proportion of the series width. The `spacing` option is supported when [`series.type`](
|
|
5880
|
+
* 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"`.
|
|
5881
5881
|
*/
|
|
5882
5882
|
spacing?: number;
|
|
5883
5883
|
/**
|
|
5884
|
-
* A Boolean value which indicates if the series has to be stacked. The stack option is supported when [`series.type`](
|
|
5884
|
+
* 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"`.
|
|
5885
5885
|
*/
|
|
5886
5886
|
stack?: boolean | string | SeriesStack;
|
|
5887
5887
|
/**
|
|
@@ -5923,7 +5923,7 @@ export declare interface SeriesDefaults {
|
|
|
5923
5923
|
* A function for creating custom visuals for the points. Applicable for the Bar and Column series.
|
|
5924
5924
|
*
|
|
5925
5925
|
* The available argument fields are:
|
|
5926
|
-
* - `rect`—The geometry [`Rect`](
|
|
5926
|
+
* - `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.
|
|
5927
5927
|
* - `options`—The point options.
|
|
5928
5928
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
5929
5929
|
* - `category`—The point category.
|
|
@@ -5934,7 +5934,7 @@ export declare interface SeriesDefaults {
|
|
|
5934
5934
|
*/
|
|
5935
5935
|
visual?: (e: SeriesVisualArgs) => drawing.Element;
|
|
5936
5936
|
/**
|
|
5937
|
-
* The label configuration of the Chart series. The Chart displays the series labels when the [`seriesDefaults.labels.visible`](
|
|
5937
|
+
* 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`.
|
|
5938
5938
|
*/
|
|
5939
5939
|
labels?: SeriesDefaultsLabels;
|
|
5940
5940
|
/**
|
|
@@ -5985,7 +5985,7 @@ export declare interface SeriesDefaultsLabels {
|
|
|
5985
5985
|
*/
|
|
5986
5986
|
font?: string;
|
|
5987
5987
|
/**
|
|
5988
|
-
* The format of the labels. Uses the [`format`](
|
|
5988
|
+
* The format of the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
|
|
5989
5989
|
*/
|
|
5990
5990
|
format?: string;
|
|
5991
5991
|
/**
|
|
@@ -6005,18 +6005,18 @@ export declare interface SeriesDefaultsLabels {
|
|
|
6005
6005
|
*
|
|
6006
6006
|
* The available argument fields are:
|
|
6007
6007
|
* - `text`—The label text.
|
|
6008
|
-
* - `rect`—The geometry [`Rect`](
|
|
6008
|
+
* - `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.
|
|
6009
6009
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
6010
6010
|
* - `options`—The label options.
|
|
6011
6011
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
6012
6012
|
*/
|
|
6013
6013
|
visual?: (e: SeriesLabelsVisualArgs) => drawing.Element;
|
|
6014
6014
|
/**
|
|
6015
|
-
* The Chart series `from` label configuration. The Chart displays the series labels when either the [`seriesDefaults.labels.visible`](
|
|
6015
|
+
* The Chart series `from` label configuration. The Chart displays the series labels when either the [`seriesDefaults.labels.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultslabelsprops#toc-visible) or the [`seriesDefaults.labels.from.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultslabelsfromprops#toc-visible) option is set to `true`.
|
|
6016
6016
|
*/
|
|
6017
6017
|
from?: SeriesDefaultsLabelsFrom;
|
|
6018
6018
|
/**
|
|
6019
|
-
* The Chart series `to` label configuration. The Chart displays the series labels when either the [`seriesDefaults.labels.visible`](
|
|
6019
|
+
* The Chart series `to` label configuration. The Chart displays the series labels when either the [`seriesDefaults.labels.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultslabelsprops#toc-visible) or the [`seriesDefaults.labels.to.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultslabelstoprops#toc-visible) option is set to `true`.
|
|
6020
6020
|
*/
|
|
6021
6021
|
to?: SeriesDefaultsLabelsTo;
|
|
6022
6022
|
}
|
|
@@ -6055,7 +6055,7 @@ export declare interface SeriesDefaultsLabelsFrom {
|
|
|
6055
6055
|
*/
|
|
6056
6056
|
font?: string;
|
|
6057
6057
|
/**
|
|
6058
|
-
* The format of the `from` labels. Uses the [`format`](
|
|
6058
|
+
* The format of the `from` labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) of IntlService.
|
|
6059
6059
|
*/
|
|
6060
6060
|
format?: string;
|
|
6061
6061
|
/**
|
|
@@ -6106,7 +6106,7 @@ export declare interface SeriesDefaultsLabelsTo {
|
|
|
6106
6106
|
*/
|
|
6107
6107
|
font?: string;
|
|
6108
6108
|
/**
|
|
6109
|
-
* The format of the `to` labels. Uses the [`format`](
|
|
6109
|
+
* The format of the `to` labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
|
|
6110
6110
|
*/
|
|
6111
6111
|
format?: string;
|
|
6112
6112
|
/**
|
|
@@ -6135,7 +6135,7 @@ export declare interface SeriesDefaultsNotes {
|
|
|
6135
6135
|
* A function for creating a custom visual for the notes.
|
|
6136
6136
|
*
|
|
6137
6137
|
* The available argument fields are:
|
|
6138
|
-
* - `rect`—The geometry [`Rect`](
|
|
6138
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines the note target rect.
|
|
6139
6139
|
* - `options`—The note options.
|
|
6140
6140
|
* - `createVisual`—A function for getting the default visual.
|
|
6141
6141
|
* - `category`—The category of the note point.
|
|
@@ -6213,7 +6213,7 @@ export declare interface SeriesDefaultsNotesLabel {
|
|
|
6213
6213
|
*/
|
|
6214
6214
|
font?: string;
|
|
6215
6215
|
/**
|
|
6216
|
-
* The format for displaying the notes label. Uses the [`format`](
|
|
6216
|
+
* The format for displaying the notes label. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the axis value.
|
|
6217
6217
|
*/
|
|
6218
6218
|
format?: string;
|
|
6219
6219
|
/**
|
|
@@ -6229,7 +6229,7 @@ export declare interface SeriesDefaultsNotesLabel {
|
|
|
6229
6229
|
*/
|
|
6230
6230
|
rotation?: number;
|
|
6231
6231
|
/**
|
|
6232
|
-
* If set to `true`, the Chart displays the [`seriesDefaults`](
|
|
6232
|
+
* If set to `true`, the Chart displays the [`seriesDefaults`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultsprops) notes label. By default, the [`seriesDefaults`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultsprops) notes label is visible.
|
|
6233
6233
|
*/
|
|
6234
6234
|
visible?: boolean;
|
|
6235
6235
|
}
|
|
@@ -6255,7 +6255,7 @@ export declare interface SeriesDefaultsTooltip {
|
|
|
6255
6255
|
*/
|
|
6256
6256
|
font?: string;
|
|
6257
6257
|
/**
|
|
6258
|
-
* The format of the labels. Uses the [`format`](
|
|
6258
|
+
* The format of the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
|
|
6259
6259
|
*
|
|
6260
6260
|
* The available format placeholders are:
|
|
6261
6261
|
* - Area, Bar, Column, Funnel, Line, and Pie: {0} - value.
|
|
@@ -6292,7 +6292,7 @@ export declare interface SeriesErrorBars {
|
|
|
6292
6292
|
*/
|
|
6293
6293
|
line?: ErrorBarLine;
|
|
6294
6294
|
/**
|
|
6295
|
-
* The error bars value ([see example](
|
|
6295
|
+
* The error bars value ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-calculating-values-based-on-data)). The value 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"`, or `"area"`.
|
|
6296
6296
|
*
|
|
6297
6297
|
* The following value types are supported:
|
|
6298
6298
|
* - `"stderr"`—The standard error of the series values will be used to calculate the point low and high values.
|
|
@@ -6309,7 +6309,7 @@ export declare interface SeriesErrorBars {
|
|
|
6309
6309
|
* A function that for creating custom visuals for the error bars.
|
|
6310
6310
|
*
|
|
6311
6311
|
* The available argument fields are:
|
|
6312
|
-
* - `rect`—The geometry [`Rect`](
|
|
6312
|
+
* - `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.
|
|
6313
6313
|
* - `options`—The error bar options.
|
|
6314
6314
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
6315
6315
|
* - `low`—The error bar low value.
|
|
@@ -6318,15 +6318,15 @@ export declare interface SeriesErrorBars {
|
|
|
6318
6318
|
*/
|
|
6319
6319
|
visual?: (e: ErrorBarsVisualArgs) => drawing.Element;
|
|
6320
6320
|
/**
|
|
6321
|
-
* The value of the [`xAxis`](
|
|
6321
|
+
* The value of the [`xAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops) error bars ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-calculating-values-based-on-data)).
|
|
6322
6322
|
*
|
|
6323
|
-
* For a list of the supported value types, refer to the [`series.errorBars.value`](
|
|
6323
|
+
* For a list of the supported value types, refer to the [`series.errorBars.value`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartserieserrorbarsprops#toc-value) option. The `xValue` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
|
|
6324
6324
|
*/
|
|
6325
6325
|
xValue?: string;
|
|
6326
6326
|
/**
|
|
6327
|
-
* The value of the [`yAxis`](
|
|
6327
|
+
* The value of the [`yAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxisitemprops) error bars ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/error-bars#toc-calculating-values-based-on-data)).
|
|
6328
6328
|
*
|
|
6329
|
-
* For a list of supported value types, refer to the [`series.errorBars.value`](
|
|
6329
|
+
* For a list of supported value types, refer to the [`series.errorBars.value`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartserieserrorbarsprops#toc-value) option. The `yValue` option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
|
|
6330
6330
|
*/
|
|
6331
6331
|
yValue?: string;
|
|
6332
6332
|
}
|
|
@@ -6370,19 +6370,19 @@ export declare interface SeriesHighlight {
|
|
|
6370
6370
|
/**
|
|
6371
6371
|
* The border of the highlighted Chart series.
|
|
6372
6372
|
*
|
|
6373
|
-
* The color is computed automatically from the base point color. The border option is supported when [`series.type`](
|
|
6373
|
+
* The color is computed automatically from the base point color. The border option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"`, `"bubble"`, `"pie"`, `"candlestick"`, or `"ohlc"`.
|
|
6374
6374
|
*/
|
|
6375
6375
|
border?: Border;
|
|
6376
6376
|
/**
|
|
6377
|
-
* The highlight color. Accepts a valid CSS color string, including hex and rgb. The color option is supported when [`series.type`](
|
|
6377
|
+
* The highlight color. Accepts a valid CSS color string, including hex and rgb. The color option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"` or `"pie"`.
|
|
6378
6378
|
*/
|
|
6379
6379
|
color?: string;
|
|
6380
6380
|
/**
|
|
6381
|
-
* The line of the highlighted Chart series. The color is computed automatically from the base point color. The line option is supported when [`series.type`](
|
|
6381
|
+
* The line of the highlighted Chart series. The color is computed automatically from the base point color. The line option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"candlestick"` or `"ohlc"`.
|
|
6382
6382
|
*/
|
|
6383
6383
|
line?: HighlightLine;
|
|
6384
6384
|
/**
|
|
6385
|
-
* The opacity of the highlighted points. The opacity option is supported when [`series.type`](
|
|
6385
|
+
* The opacity of the highlighted points. The opacity option is supported when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"bubble"`, `"pie"`, or `"donut"`.
|
|
6386
6386
|
*/
|
|
6387
6387
|
opacity?: number;
|
|
6388
6388
|
/**
|
|
@@ -6411,7 +6411,7 @@ export declare interface SeriesHighlight {
|
|
|
6411
6411
|
*
|
|
6412
6412
|
* The available argument fields are:
|
|
6413
6413
|
* - `createVisual`—A function that can be used to get the default highlight visual.
|
|
6414
|
-
* - `rect`—The geometry [`Rect`](
|
|
6414
|
+
* - `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.
|
|
6415
6415
|
* - `visual`—The visual element that needs to be highlighted.
|
|
6416
6416
|
* - `options`—The point options.
|
|
6417
6417
|
* - `category`—The point category.
|
|
@@ -6480,7 +6480,7 @@ export declare class SeriesHoverEvent extends PreventableEvent {
|
|
|
6480
6480
|
*/
|
|
6481
6481
|
export declare interface SeriesLabels {
|
|
6482
6482
|
/**
|
|
6483
|
-
* The alignment of the label when [`series.type`](
|
|
6483
|
+
* The alignment of the label when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
|
|
6484
6484
|
*
|
|
6485
6485
|
* The supported values for `"donut"` and `"pie"` are:
|
|
6486
6486
|
* - `"circle"`—The labels are positioned in circle around the Chart.
|
|
@@ -6520,7 +6520,7 @@ export declare interface SeriesLabels {
|
|
|
6520
6520
|
*/
|
|
6521
6521
|
content?: (e: any) => string;
|
|
6522
6522
|
/**
|
|
6523
|
-
* The distance between the labels when [`series.type`](
|
|
6523
|
+
* The distance between the labels when [`series.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-type) is set to `"donut"` or `"pie"`.
|
|
6524
6524
|
*/
|
|
6525
6525
|
distance?: number;
|
|
6526
6526
|
/**
|
|
@@ -6528,7 +6528,7 @@ export declare interface SeriesLabels {
|
|
|
6528
6528
|
*/
|
|
6529
6529
|
font?: string;
|
|
6530
6530
|
/**
|
|
6531
|
-
* The format of the labels. Uses the [`format`](
|
|
6531
|
+
* The format of the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
|
|
6532
6532
|
*/
|
|
6533
6533
|
format?: string;
|
|
6534
6534
|
/**
|
|
@@ -6552,18 +6552,18 @@ export declare interface SeriesLabels {
|
|
|
6552
6552
|
*
|
|
6553
6553
|
* The available argument fields are:
|
|
6554
6554
|
* - `text`—The label text.
|
|
6555
|
-
* - `rect`—The geometry [`Rect`](
|
|
6555
|
+
* - `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.
|
|
6556
6556
|
* - `options`—The label options.
|
|
6557
6557
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
6558
6558
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
6559
6559
|
*/
|
|
6560
6560
|
visual?: (e: SeriesLabelsVisualArgs) => drawing.Element;
|
|
6561
6561
|
/**
|
|
6562
|
-
* The `from` label configuration of the Chart series. The Chart displays the series from labels when either the [`series.labels.visible`](
|
|
6562
|
+
* The `from` label configuration of the Chart series. The Chart displays the series from labels when either the [`series.labels.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartserieslabelsprops#toc-visible) or the [`series.labels.from.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesdefaultslabelsfromprops#toc-visible) option is set to `true`.
|
|
6563
6563
|
*/
|
|
6564
6564
|
from?: SeriesLabelsFrom;
|
|
6565
6565
|
/**
|
|
6566
|
-
* The `to` label configuration of the Chart series. The Chart displays the series to labels when either the [`series.labels.visible`](
|
|
6566
|
+
* The `to` label configuration of the Chart series. The Chart displays the series to labels when either the [`series.labels.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartserieslabelsprops#toc-visible) or the [`series.labels.to.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartserieslabelstoprops#toc-visible) option is set to `true`.
|
|
6567
6567
|
*/
|
|
6568
6568
|
to?: SeriesLabelsTo;
|
|
6569
6569
|
/**
|
|
@@ -6610,7 +6610,7 @@ export declare interface SeriesLabelsFrom {
|
|
|
6610
6610
|
*/
|
|
6611
6611
|
font?: string;
|
|
6612
6612
|
/**
|
|
6613
|
-
* The format of the `from` labels. Uses the IntlService [`format`](
|
|
6613
|
+
* The format of the `from` labels. Uses the IntlService [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method.
|
|
6614
6614
|
*/
|
|
6615
6615
|
format?: string;
|
|
6616
6616
|
/**
|
|
@@ -6692,7 +6692,7 @@ export declare interface SeriesLabelsTo {
|
|
|
6692
6692
|
*/
|
|
6693
6693
|
font?: string;
|
|
6694
6694
|
/**
|
|
6695
|
-
* The format of the `to` labels. Uses [IntlService format](
|
|
6695
|
+
* The format of the `to` labels. Uses [IntlService format](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format).
|
|
6696
6696
|
*/
|
|
6697
6697
|
format?: string;
|
|
6698
6698
|
/**
|
|
@@ -6821,7 +6821,7 @@ export declare interface SeriesMarkers {
|
|
|
6821
6821
|
* A function for creating a custom visual for the markers.
|
|
6822
6822
|
*
|
|
6823
6823
|
* The available argument fields are:
|
|
6824
|
-
* - `rect`—The [geometry Rect](
|
|
6824
|
+
* - `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.
|
|
6825
6825
|
* - `options`—The marker options.
|
|
6826
6826
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
6827
6827
|
* - `category`—The category of the marker point.
|
|
@@ -6863,7 +6863,7 @@ export declare interface SeriesNotes {
|
|
|
6863
6863
|
* A function for creating a custom visual for the notes.
|
|
6864
6864
|
*
|
|
6865
6865
|
* The available argument fields are:
|
|
6866
|
-
* - `rect`—The geometry [`Rect`](
|
|
6866
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines the note target rect.
|
|
6867
6867
|
* - `options`—The note options.
|
|
6868
6868
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
6869
6869
|
* - `category`—The category of the note point.
|
|
@@ -6941,7 +6941,7 @@ export declare interface SeriesNotesLabel {
|
|
|
6941
6941
|
*/
|
|
6942
6942
|
font?: string;
|
|
6943
6943
|
/**
|
|
6944
|
-
* The format for displaying the notes label. Uses the [`format`](
|
|
6944
|
+
* The format for displaying the notes label. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the axis value.
|
|
6945
6945
|
*/
|
|
6946
6946
|
format?: string;
|
|
6947
6947
|
/**
|
|
@@ -7134,7 +7134,7 @@ declare interface SeriesTooltip_2 {
|
|
|
7134
7134
|
*/
|
|
7135
7135
|
font?: string;
|
|
7136
7136
|
/**
|
|
7137
|
-
* The format of the labels. Uses the [`format`](
|
|
7137
|
+
* The format of the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
|
|
7138
7138
|
*
|
|
7139
7139
|
* The available format placeholders are:
|
|
7140
7140
|
* - Area, Bar, Column, Line, Funnel, Pyramid, Pie, radarArea, radarColumn and radarLine: {0} - value.
|
|
@@ -7199,7 +7199,7 @@ export declare interface SeriesTrendline {
|
|
|
7199
7199
|
}
|
|
7200
7200
|
|
|
7201
7201
|
/**
|
|
7202
|
-
* [The series type](
|
|
7202
|
+
* [The series type](https://www.telerik.com/kendo-react-ui/components/charts/series-types#series-type)
|
|
7203
7203
|
*
|
|
7204
7204
|
* @example
|
|
7205
7205
|
* ```jsx
|
|
@@ -7671,7 +7671,7 @@ export declare interface Tooltip {
|
|
|
7671
7671
|
*/
|
|
7672
7672
|
font?: string;
|
|
7673
7673
|
/**
|
|
7674
|
-
* The format of the labels. Uses the [`format`](
|
|
7674
|
+
* The format of the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService.
|
|
7675
7675
|
*
|
|
7676
7676
|
* The available format placeholders are:
|
|
7677
7677
|
* - Area, Bar, Column, Funnel, Pyramid, Line, and Pie: {0} - value.
|
|
@@ -7689,7 +7689,7 @@ export declare interface Tooltip {
|
|
|
7689
7689
|
*/
|
|
7690
7690
|
padding?: Padding | number;
|
|
7691
7691
|
/**
|
|
7692
|
-
* If set to `true`, the Chart displays a single tooltip for every category ([see example](
|
|
7692
|
+
* If set to `true`, the Chart displays a single tooltip for every category ([see example](https://www.telerik.com/kendo-react-ui/components/charts/chart/elements/tooltips#toc-shared-tooltip)).
|
|
7693
7693
|
*/
|
|
7694
7694
|
shared?: boolean;
|
|
7695
7695
|
/**
|
|
@@ -7902,7 +7902,7 @@ export declare interface ValueAxis {
|
|
|
7902
7902
|
*/
|
|
7903
7903
|
majorTicks?: AxisTicks;
|
|
7904
7904
|
/**
|
|
7905
|
-
* The interval between major divisions. If [`valueAxis.type`](
|
|
7905
|
+
* The interval between major divisions. If [`valueAxis.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartvalueaxisitemprops#toc-type) is set to `"log"`, the `majorUnit` value is used for the base of the logarithm.
|
|
7906
7906
|
*/
|
|
7907
7907
|
majorUnit?: number;
|
|
7908
7908
|
/**
|
|
@@ -7922,11 +7922,11 @@ export declare interface ValueAxis {
|
|
|
7922
7922
|
*/
|
|
7923
7923
|
minorTicks?: AxisTicks;
|
|
7924
7924
|
/**
|
|
7925
|
-
* The interval between minor divisions. It defaults to one-fifth (1/5) of the [`valueAxis.majorUnit`](
|
|
7925
|
+
* The interval between minor divisions. It defaults to one-fifth (1/5) of the [`valueAxis.majorUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartvalueaxisitemprops#toc-majorunit). If [`valueAxis.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartvalueaxisitemprops#toc-type) is set to `"log"`, the `minorUnit` value represents the number of divisions between two major units and defaults to the major unit minus one.
|
|
7926
7926
|
*/
|
|
7927
7927
|
minorUnit?: number;
|
|
7928
7928
|
/**
|
|
7929
|
-
* The unique axis name. Used to associate a series with a value axis by using the [`series.axis`](
|
|
7929
|
+
* The unique axis name. Used to associate a series with a value axis by using the [`series.axis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-axis) option.
|
|
7930
7930
|
*/
|
|
7931
7931
|
name?: string;
|
|
7932
7932
|
/**
|
|
@@ -7962,7 +7962,7 @@ export declare interface ValueAxis {
|
|
|
7962
7962
|
/**
|
|
7963
7963
|
* The crosshair configuration options.
|
|
7964
7964
|
*
|
|
7965
|
-
* The crosshair is displayed when the [`valueAxis.crosshair.visible`](
|
|
7965
|
+
* The crosshair is displayed when the [`valueAxis.crosshair.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartvalueaxiscrosshairprops#toc-visible) option is set to `true`.
|
|
7966
7966
|
*/
|
|
7967
7967
|
crosshair?: ValueAxisCrosshair;
|
|
7968
7968
|
/**
|
|
@@ -7976,7 +7976,7 @@ export declare interface ValueAxis {
|
|
|
7976
7976
|
/**
|
|
7977
7977
|
* The title configuration of the value axis.
|
|
7978
7978
|
*
|
|
7979
|
-
* To display the title, set the [`valueAxis.title.text`](
|
|
7979
|
+
* To display the title, set the [`valueAxis.title.text`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartvalueaxistitleprops#toc-text) option.
|
|
7980
7980
|
*/
|
|
7981
7981
|
title?: ValueAxisTitle;
|
|
7982
7982
|
}
|
|
@@ -8002,7 +8002,7 @@ export declare interface ValueAxisCrosshair {
|
|
|
8002
8002
|
*/
|
|
8003
8003
|
width?: number;
|
|
8004
8004
|
/**
|
|
8005
|
-
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`valueAxis.crosshair.tooltip.visible`](
|
|
8005
|
+
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`valueAxis.crosshair.tooltip.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartvalueaxiscrosshairtooltipprops#toc-visible) option is set to `true`.
|
|
8006
8006
|
*/
|
|
8007
8007
|
tooltip?: ValueAxisCrosshairTooltip;
|
|
8008
8008
|
}
|
|
@@ -8045,7 +8045,7 @@ export declare interface ValueAxisLabels {
|
|
|
8045
8045
|
*/
|
|
8046
8046
|
font?: string;
|
|
8047
8047
|
/**
|
|
8048
|
-
* The format for displaying the labels. Uses the [`format`](
|
|
8048
|
+
* The format for displaying the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value.
|
|
8049
8049
|
*/
|
|
8050
8050
|
format?: string;
|
|
8051
8051
|
/**
|
|
@@ -8085,7 +8085,7 @@ export declare interface ValueAxisLabels {
|
|
|
8085
8085
|
* - `culture`—The default culture (if set) on the label.
|
|
8086
8086
|
* - `format`—The default format of the label.
|
|
8087
8087
|
* - `options`—The label options.
|
|
8088
|
-
* - `rect`—The geometry [`Rect`](
|
|
8088
|
+
* - `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.
|
|
8089
8089
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
8090
8090
|
* - `text`—The label text.
|
|
8091
8091
|
* - `value`—The category value.
|
|
@@ -8119,7 +8119,7 @@ export declare interface ValueAxisNotes {
|
|
|
8119
8119
|
* A function for creating custom visuals for the notes.
|
|
8120
8120
|
*
|
|
8121
8121
|
* The available argument fields are:
|
|
8122
|
-
* - `rect`—The geometry [`Rect`](
|
|
8122
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines the note target rect.
|
|
8123
8123
|
* - `options`—The note options.
|
|
8124
8124
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
8125
8125
|
* - `value`—The note value.
|
|
@@ -8192,7 +8192,7 @@ export declare interface ValueAxisNotesLabel {
|
|
|
8192
8192
|
*/
|
|
8193
8193
|
font?: string;
|
|
8194
8194
|
/**
|
|
8195
|
-
* The format used to display the notes label. Uses the IntlService [`format`](
|
|
8195
|
+
* The format used to display the notes label. Uses the IntlService [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method. Contains one placeholder (`"{0}"`) which represents the axis value.
|
|
8196
8196
|
*/
|
|
8197
8197
|
format?: string;
|
|
8198
8198
|
/**
|
|
@@ -8269,7 +8269,7 @@ export declare interface ValueAxisTitle {
|
|
|
8269
8269
|
*
|
|
8270
8270
|
* The available argument fields are:
|
|
8271
8271
|
* - `text`—The label text.
|
|
8272
|
-
* - `rect`—The geometry [`Rect`](
|
|
8272
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect)
|
|
8273
8273
|
* that defines where the visual has to be rendered.
|
|
8274
8274
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
8275
8275
|
* - `options`—The label options.
|
|
@@ -8281,7 +8281,7 @@ export declare interface ValueAxisTitle {
|
|
|
8281
8281
|
export { VerticalStripesPattern }
|
|
8282
8282
|
|
|
8283
8283
|
/**
|
|
8284
|
-
* Specifies the `weekStartDay` of a [ChartCategoryAxisItem](
|
|
8284
|
+
* Specifies the `weekStartDay` of a [ChartCategoryAxisItem](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxisitem).
|
|
8285
8285
|
*/
|
|
8286
8286
|
export declare enum WeekStartDay {
|
|
8287
8287
|
/**
|
|
@@ -8365,7 +8365,7 @@ export declare interface XAxis {
|
|
|
8365
8365
|
*/
|
|
8366
8366
|
majorTicks?: AxisTicks;
|
|
8367
8367
|
/**
|
|
8368
|
-
* The interval between major divisions. If this is a date axis, the value represents the number of [`xAxis.baseUnits`](
|
|
8368
|
+
* The interval between major divisions. If this is a date axis, the value represents the number of [`xAxis.baseUnits`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops#toc-baseunit) between major divisions. If [`xAxis.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops#toc-type) is set to `"log"`, the `majorUnit` value is used for the base of the logarithm.
|
|
8369
8369
|
*/
|
|
8370
8370
|
majorUnit?: number;
|
|
8371
8371
|
/**
|
|
@@ -8385,11 +8385,11 @@ export declare interface XAxis {
|
|
|
8385
8385
|
*/
|
|
8386
8386
|
minorTicks?: AxisTicks;
|
|
8387
8387
|
/**
|
|
8388
|
-
* The interval between minor divisions. It defaults to 1/5 of the [`xAxis.majorUnit`](
|
|
8388
|
+
* The interval between minor divisions. It defaults to 1/5 of the [`xAxis.majorUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops#toc-majorunit). If [`xAxis.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops#toc-type) is set to `"log"`, the `minorUnit` value represents the number of divisions between two major units and defaults to the major unit minus one.
|
|
8389
8389
|
*/
|
|
8390
8390
|
minorUnit?: number;
|
|
8391
8391
|
/**
|
|
8392
|
-
* The unique axis name. Used to associate a series with a X axis by using the [`series.xAxis`](
|
|
8392
|
+
* The unique axis name. Used to associate a series with a X axis by using the [`series.xAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-xaxis) option.
|
|
8393
8393
|
*/
|
|
8394
8394
|
name?: string;
|
|
8395
8395
|
/**
|
|
@@ -8428,7 +8428,7 @@ export declare interface XAxis {
|
|
|
8428
8428
|
*/
|
|
8429
8429
|
visible?: boolean;
|
|
8430
8430
|
/**
|
|
8431
|
-
* The configuration options of the crosshair. The crosshair is displayed when the [`xAxis.crosshair.visible`](
|
|
8431
|
+
* The configuration options of the crosshair. The crosshair is displayed when the [`xAxis.crosshair.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxiscrosshairprops#toc-visible) option is set to `true`.
|
|
8432
8432
|
*/
|
|
8433
8433
|
crosshair?: XAxisCrosshair;
|
|
8434
8434
|
/**
|
|
@@ -8440,7 +8440,7 @@ export declare interface XAxis {
|
|
|
8440
8440
|
*/
|
|
8441
8441
|
notes?: XAxisNotes;
|
|
8442
8442
|
/**
|
|
8443
|
-
* The title configuration of the Scatter Chart X axis. To display the title, set the [`xAxis.title.text`](
|
|
8443
|
+
* The title configuration of the Scatter Chart X axis. To display the title, set the [`xAxis.title.text`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxistitleprops#toc-text) option.
|
|
8444
8444
|
*/
|
|
8445
8445
|
title?: XAxisTitle;
|
|
8446
8446
|
}
|
|
@@ -8466,7 +8466,7 @@ export declare interface XAxisCrosshair {
|
|
|
8466
8466
|
*/
|
|
8467
8467
|
width?: number;
|
|
8468
8468
|
/**
|
|
8469
|
-
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`xAxis.crosshair.tooltip.visible`](
|
|
8469
|
+
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`xAxis.crosshair.tooltip.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxiscrosshairtooltipprops#toc-visible) option is set to `true`.
|
|
8470
8470
|
*/
|
|
8471
8471
|
tooltip?: XAxisCrosshairTooltip;
|
|
8472
8472
|
}
|
|
@@ -8505,11 +8505,11 @@ export declare interface XAxisLabels {
|
|
|
8505
8505
|
*/
|
|
8506
8506
|
content?: (e: any) => string;
|
|
8507
8507
|
/**
|
|
8508
|
-
* The culture to use when formatting date values. The specified culture must be loaded as demonstrated in the [Internationalization Overview](
|
|
8508
|
+
* The culture to use when formatting date values. The specified culture must be loaded as demonstrated in the [Internationalization Overview](https://www.telerik.com/kendo-react-ui/components/intl/i18n).
|
|
8509
8509
|
*/
|
|
8510
8510
|
culture?: string;
|
|
8511
8511
|
/**
|
|
8512
|
-
* The format for displaying the labels when the X values are dates. Uses the [`format`](
|
|
8512
|
+
* The format for displaying the labels when the X values are dates. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value. The Chart selects the appropriate format for the current [`xAxis.baseUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartxaxisitemprops#toc-baseunit). Setting the [`categoryAxis.labels.format`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxislabelsprops#toc-format) option overrides the date formats.
|
|
8513
8513
|
*/
|
|
8514
8514
|
dateFormats?: DateFormats;
|
|
8515
8515
|
/**
|
|
@@ -8517,7 +8517,7 @@ export declare interface XAxisLabels {
|
|
|
8517
8517
|
*/
|
|
8518
8518
|
font?: string;
|
|
8519
8519
|
/**
|
|
8520
|
-
* The format for displaying the labels. Uses the [`format`](
|
|
8520
|
+
* The format for displaying the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value.
|
|
8521
8521
|
*/
|
|
8522
8522
|
format?: string;
|
|
8523
8523
|
/**
|
|
@@ -8556,7 +8556,7 @@ export declare interface XAxisLabels {
|
|
|
8556
8556
|
* - `culture`—The default culture (if set) of the label.
|
|
8557
8557
|
* - `format`—The default format of the label.
|
|
8558
8558
|
* - `options`—The label options.
|
|
8559
|
-
* - `rect`—The geometry [`Rect`](
|
|
8559
|
+
* - `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.
|
|
8560
8560
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
8561
8561
|
* - `text`—The label text.
|
|
8562
8562
|
* - `value`—The category value.
|
|
@@ -8590,7 +8590,7 @@ export declare interface XAxisNotes {
|
|
|
8590
8590
|
* A function for creating custom visuals for the notes.
|
|
8591
8591
|
*
|
|
8592
8592
|
* The available argument fields are:
|
|
8593
|
-
* - `rect`—The geometry [`Rect`](
|
|
8593
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines the note target rect.
|
|
8594
8594
|
* - `sender`—The chart instance (might be `undefined`).
|
|
8595
8595
|
* - `options`—The note options.
|
|
8596
8596
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
@@ -8664,7 +8664,7 @@ export declare interface XAxisNotesLabel {
|
|
|
8664
8664
|
*/
|
|
8665
8665
|
font?: string;
|
|
8666
8666
|
/**
|
|
8667
|
-
* The format for displaying the notes label. Uses the [`format`](
|
|
8667
|
+
* The format for displaying the notes label. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the axis value.
|
|
8668
8668
|
*/
|
|
8669
8669
|
format?: string;
|
|
8670
8670
|
/**
|
|
@@ -8741,7 +8741,7 @@ export declare interface XAxisTitle {
|
|
|
8741
8741
|
*
|
|
8742
8742
|
* The available argument fields are:
|
|
8743
8743
|
* - `text`—The label text.
|
|
8744
|
-
* - `rect`—The geometry [`Rect`](
|
|
8744
|
+
* - `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.
|
|
8745
8745
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
8746
8746
|
* - `options`—The label options.
|
|
8747
8747
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
@@ -8800,7 +8800,7 @@ export declare interface YAxis {
|
|
|
8800
8800
|
*/
|
|
8801
8801
|
majorTicks?: AxisTicks;
|
|
8802
8802
|
/**
|
|
8803
|
-
* The interval between major divisions. If this is a date axis, the value represents the number of [`yAxis.baseUnits`](
|
|
8803
|
+
* The interval between major divisions. If this is a date axis, the value represents the number of [`yAxis.baseUnits`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxisitemprops#toc-baseunit) between major divisions. If the [`yAxis.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxisitemprops#toc-type) is set to `"log"`, the `majorUnit` value is used for the base of the logarithm.
|
|
8804
8804
|
*/
|
|
8805
8805
|
majorUnit?: number;
|
|
8806
8806
|
/**
|
|
@@ -8820,11 +8820,11 @@ export declare interface YAxis {
|
|
|
8820
8820
|
*/
|
|
8821
8821
|
minorTicks?: AxisTicks;
|
|
8822
8822
|
/**
|
|
8823
|
-
* The interval between minor divisions. It defaults to one-fifth (1/5) of [`yAxis.majorUnit`](
|
|
8823
|
+
* The interval between minor divisions. It defaults to one-fifth (1/5) of [`yAxis.majorUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxisitemprops#toc-majorunit). If [`yAxis.type`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxisitemprops#toc-type) is set to `"log"`, the `minorUnit` value represents the number of divisions between two major units and defaults to the major unit minus one.
|
|
8824
8824
|
*/
|
|
8825
8825
|
minorUnit?: number;
|
|
8826
8826
|
/**
|
|
8827
|
-
* The unique axis name. Used to associate a series with a Y axis by using the [`series.yAxis`](
|
|
8827
|
+
* The unique axis name. Used to associate a series with a Y axis by using the [`series.yAxis`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartseriesitemprops#toc-yaxis) option.
|
|
8828
8828
|
*/
|
|
8829
8829
|
name?: string;
|
|
8830
8830
|
/**
|
|
@@ -8859,7 +8859,7 @@ export declare interface YAxis {
|
|
|
8859
8859
|
*/
|
|
8860
8860
|
visible?: boolean;
|
|
8861
8861
|
/**
|
|
8862
|
-
* The configuration options of the crosshair. The crosshair is displayed when the [`yAxis.crosshair.visible`](
|
|
8862
|
+
* The configuration options of the crosshair. The crosshair is displayed when the [`yAxis.crosshair.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxiscrosshairprops#toc-visible) option is set to `true`.
|
|
8863
8863
|
*/
|
|
8864
8864
|
crosshair?: YAxisCrosshair;
|
|
8865
8865
|
/**
|
|
@@ -8871,7 +8871,7 @@ export declare interface YAxis {
|
|
|
8871
8871
|
*/
|
|
8872
8872
|
notes?: YAxisNotes;
|
|
8873
8873
|
/**
|
|
8874
|
-
* The title configuration of the Scatter Chart Y axis. To display the title, set the [`yAxis.title.text`](
|
|
8874
|
+
* The title configuration of the Scatter Chart Y axis. To display the title, set the [`yAxis.title.text`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxistitleprops#toc-text) option.
|
|
8875
8875
|
*/
|
|
8876
8876
|
title?: YAxisTitle;
|
|
8877
8877
|
}
|
|
@@ -8897,7 +8897,7 @@ export declare interface YAxisCrosshair {
|
|
|
8897
8897
|
*/
|
|
8898
8898
|
width?: number;
|
|
8899
8899
|
/**
|
|
8900
|
-
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`yAxis.crosshair.tooltip.visible`](
|
|
8900
|
+
* The options of the crosshair tooltip. The crosshair tooltip is displayed when the [`yAxis.crosshair.tooltip.visible`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxiscrosshairtooltipprops#toc-visible) option is set to `true`.
|
|
8901
8901
|
*/
|
|
8902
8902
|
tooltip?: YAxisCrosshairTooltip;
|
|
8903
8903
|
}
|
|
@@ -8936,11 +8936,11 @@ export declare interface YAxisLabels {
|
|
|
8936
8936
|
*/
|
|
8937
8937
|
content?: (e: any) => string;
|
|
8938
8938
|
/**
|
|
8939
|
-
* The culture to use when formatting date values. The specified culture must be loaded as demonstrated in the [Internationalization Overview](
|
|
8939
|
+
* The culture to use when formatting date values. The specified culture must be loaded as demonstrated in the [Internationalization Overview](https://www.telerik.com/kendo-react-ui/components/intl/i18n).
|
|
8940
8940
|
*/
|
|
8941
8941
|
culture?: string;
|
|
8942
8942
|
/**
|
|
8943
|
-
* The format for displaying the labels when the X values are dates. Uses the [`format`](
|
|
8943
|
+
* The format for displaying the labels when the X values are dates. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value. The Chart selects the appropriate format for the current [`yAxis.baseUnit`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartyaxisitemprops#toc-baseunit). Setting the [`categoryAxis.labels.format`](https://www.telerik.com/kendo-react-ui/components/charts/api/chartcategoryaxislabelsprops#toc-format) option overrides the date formats.
|
|
8944
8944
|
*/
|
|
8945
8945
|
dateFormats?: DateFormats;
|
|
8946
8946
|
/**
|
|
@@ -8948,7 +8948,7 @@ export declare interface YAxisLabels {
|
|
|
8948
8948
|
*/
|
|
8949
8949
|
font?: string;
|
|
8950
8950
|
/**
|
|
8951
|
-
* The format for displaying the labels. Uses the [`format`](
|
|
8951
|
+
* The format for displaying the labels. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the category value.
|
|
8952
8952
|
*/
|
|
8953
8953
|
format?: string;
|
|
8954
8954
|
/**
|
|
@@ -8987,7 +8987,7 @@ export declare interface YAxisLabels {
|
|
|
8987
8987
|
* - `culture`—The default culture (if set) on the label.
|
|
8988
8988
|
* - `format`—The default format of the label.
|
|
8989
8989
|
* - `options`—The label options.
|
|
8990
|
-
* - `rect`—The geometry [`Rect`](
|
|
8990
|
+
* - `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.
|
|
8991
8991
|
* - `sender`—The Chart instance (might be `undefined`).
|
|
8992
8992
|
* - `text`—The label text.
|
|
8993
8993
|
* - `value`—The category value.
|
|
@@ -9021,7 +9021,7 @@ export declare interface YAxisNotes {
|
|
|
9021
9021
|
* A function for creating custom visuals for the notes.
|
|
9022
9022
|
*
|
|
9023
9023
|
* The available argument fields are:
|
|
9024
|
-
* - `rect`—The geometry [`Rect`](
|
|
9024
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect) that defines the note target rect.
|
|
9025
9025
|
* - `options`—The note options.
|
|
9026
9026
|
* - `createVisual`—A function that can be used to get the default visual.
|
|
9027
9027
|
* - `value`—The note value.
|
|
@@ -9094,7 +9094,7 @@ export declare interface YAxisNotesLabel {
|
|
|
9094
9094
|
*/
|
|
9095
9095
|
font?: string;
|
|
9096
9096
|
/**
|
|
9097
|
-
* The format for displaying the notes label. Uses the [`format`](
|
|
9097
|
+
* The format for displaying the notes label. Uses the [`format`](https://www.telerik.com/kendo-react-ui/components/intl/api/intlservice#toc-format) method of IntlService. Contains one placeholder (`"{0}"`) which represents the axis value.
|
|
9098
9098
|
*/
|
|
9099
9099
|
format?: string;
|
|
9100
9100
|
/**
|
|
@@ -9171,7 +9171,7 @@ export declare interface YAxisTitle {
|
|
|
9171
9171
|
*
|
|
9172
9172
|
* The available argument fields are:
|
|
9173
9173
|
* - `text`—The label text.
|
|
9174
|
-
* - `rect`—The geometry [`Rect`](
|
|
9174
|
+
* - `rect`—The geometry [`Rect`](https://www.telerik.com/kendo-react-ui/components/drawing/api/geometry/rect)
|
|
9175
9175
|
* that defines where the visual has to be rendered.
|
|
9176
9176
|
* - `sender`—The Chart instance (can be `undefined`).
|
|
9177
9177
|
* - `options`—The label options.
|