@progress/kendo-angular-charts 13.2.0-develop.2 → 13.2.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/README.md +1 -1
- package/api-types/chart-axis.interface.d.ts +8 -8
- package/api-types/chart-pane.interface.d.ts +2 -2
- package/argument-types/legend-item-visual-args.interface.d.ts +1 -1
- package/chart/axis-defaults/crosshair.component.d.ts +1 -1
- package/chart/axis-defaults/labels.component.d.ts +1 -1
- package/chart/axis-defaults/title.component.d.ts +1 -1
- package/chart/axis-defaults.component.d.ts +5 -108
- package/chart-options.interface.d.ts +0 -4
- package/esm2020/chart/axis-defaults/crosshair.component.mjs +1 -1
- package/esm2020/chart/axis-defaults/labels.component.mjs +1 -1
- package/esm2020/chart/axis-defaults/title.component.mjs +1 -1
- package/esm2020/chart/axis-defaults.component.mjs +5 -108
- package/esm2020/package-metadata.mjs +2 -2
- package/fesm2015/progress-kendo-angular-charts.mjs +10 -113
- package/fesm2020/progress-kendo-angular-charts.mjs +10 -113
- package/field-types/auto-base-unit-steps.interface.d.ts +12 -7
- package/field-types/axis-line.interface.d.ts +1 -1
- package/field-types/axis-ticks.interface.d.ts +1 -1
- package/field-types/border.interface.d.ts +1 -1
- package/field-types/grid-lines.interface.d.ts +1 -1
- package/field-types/mousewheel-select.interface.d.ts +1 -6
- package/field-types/mousewheel-zoom.interface.d.ts +0 -1
- package/field-types/overlay.interface.d.ts +1 -5
- package/field-types/plot-band-label.interface.d.ts +3 -17
- package/field-types/series-line.interface.d.ts +0 -6
- package/field-types/series-median.interface.d.ts +1 -1
- package/field-types/series-stack.interface.d.ts +1 -4
- package/option-types/axis-defaults/crosshair.interface.d.ts +2 -12
- package/option-types/axis-defaults/crosshair.tooltip.interface.d.ts +1 -1
- package/option-types/axis-defaults/labels.interface.d.ts +1 -13
- package/option-types/axis-defaults/title.interface.d.ts +1 -17
- package/option-types/axis-defaults.interface.d.ts +3 -3
- package/option-types/category-axis-item/crosshair.interface.d.ts +0 -10
- package/option-types/category-axis-item/labels.interface.d.ts +3 -16
- package/option-types/category-axis-item/notes.icon.interface.d.ts +0 -6
- package/option-types/category-axis-item/notes.interface.d.ts +0 -14
- package/option-types/category-axis-item/notes.label.interface.d.ts +0 -5
- package/option-types/category-axis-item/title.interface.d.ts +0 -16
- package/option-types/category-axis-item.interface.d.ts +9 -26
- package/option-types/legend/item.interface.d.ts +0 -7
- package/option-types/legend/legend-title.interface.d.ts +0 -9
- package/option-types/legend/markers.interface.d.ts +1 -17
- package/option-types/legend.interface.d.ts +2 -20
- package/option-types/pane/title.interface.d.ts +2 -6
- package/option-types/pane-defaults/title.interface.d.ts +1 -13
- package/option-types/series-defaults/labels.interface.d.ts +0 -8
- package/option-types/series-defaults/notes.icon.interface.d.ts +0 -6
- package/option-types/series-defaults/notes.interface.d.ts +0 -11
- package/option-types/series-defaults/notes.label.interface.d.ts +0 -5
- package/option-types/series-defaults/tooltip.interface.d.ts +9 -12
- package/option-types/series-defaults.interface.d.ts +0 -41
- package/option-types/series-item/error-bars.interface.d.ts +0 -9
- package/option-types/series-item/extremes.interface.d.ts +0 -6
- package/option-types/series-item/highlight.interface.d.ts +0 -30
- package/option-types/series-item/labels.from.interface.d.ts +8 -8
- package/option-types/series-item/labels.interface.d.ts +0 -8
- package/option-types/series-item/labels.to.interface.d.ts +8 -8
- package/option-types/series-item/markers.interface.d.ts +0 -19
- package/option-types/series-item/notes.icon.interface.d.ts +0 -6
- package/option-types/series-item/notes.interface.d.ts +0 -19
- package/option-types/series-item/notes.label.interface.d.ts +0 -4
- package/option-types/series-item/outliers.interface.d.ts +0 -6
- package/option-types/series-item/tooltip.interface.d.ts +8 -14
- package/option-types/series-item.interface.d.ts +15 -59
- package/option-types/subtitle.interface.d.ts +2 -7
- package/option-types/title.interface.d.ts +2 -9
- package/option-types/tooltip.interface.d.ts +6 -9
- package/option-types/value-axis-item/labels.interface.d.ts +2 -21
- package/option-types/value-axis-item/notes.icon.interface.d.ts +0 -6
- package/option-types/value-axis-item/notes.interface.d.ts +0 -12
- package/option-types/value-axis-item/notes.label.interface.d.ts +0 -3
- package/option-types/value-axis-item/title.interface.d.ts +0 -16
- package/option-types/value-axis-item.interface.d.ts +5 -7
- package/option-types/x-axis-item/labels.interface.d.ts +0 -14
- package/option-types/x-axis-item/notes.icon.interface.d.ts +0 -6
- package/option-types/x-axis-item/notes.interface.d.ts +0 -13
- package/option-types/x-axis-item/notes.label.interface.d.ts +0 -4
- package/option-types/x-axis-item/title.interface.d.ts +0 -16
- package/option-types/x-axis-item.interface.d.ts +2 -19
- package/option-types/y-axis-item/labels.interface.d.ts +0 -14
- package/option-types/y-axis-item/notes.icon.interface.d.ts +0 -6
- package/option-types/y-axis-item/notes.interface.d.ts +0 -12
- package/option-types/y-axis-item/notes.label.interface.d.ts +0 -4
- package/option-types/y-axis-item/title.interface.d.ts +0 -16
- package/option-types/y-axis-item.interface.d.ts +2 -19
- package/package.json +7 -7
- package/stock-chart/option-types/navigator/hint.interface.d.ts +2 -5
|
@@ -32,29 +32,16 @@ export interface CategoryAxis {
|
|
|
32
32
|
/**
|
|
33
33
|
* The base time interval for the date axis. The default base unit is automatically determined by the
|
|
34
34
|
* minimum difference between subsequent categories.
|
|
35
|
+
* Setting `baseUnit` to `"fit"` sets such a base unit and [`categoryAxis.baseUnitStep`](slug:api_charts_categoryaxis#toc-baseunitstep)
|
|
36
|
+
* that the total number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups).
|
|
35
37
|
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* - `"fit"`
|
|
39
|
-
* - `"milliseconds"`
|
|
40
|
-
* - `"seconds"`
|
|
41
|
-
* - `"minutes"`
|
|
42
|
-
* - `"hours"`
|
|
43
|
-
* - `"days"`
|
|
44
|
-
* - `"weeks"`
|
|
45
|
-
* - `"months"`
|
|
46
|
-
* - `"years"`
|
|
47
|
-
*
|
|
48
|
-
* Setting `baseUnit` to `"fit"` sets such a base unit and [`categoryAxis.baseUnitStep`]({% slug api_charts_categoryaxis %}#toc-baseunitstep)
|
|
49
|
-
* that the total number of categories does not exceed [`categoryAxis.maxDateGroups`]({% slug api_charts_categoryaxis %}#toc-maxdategroups).
|
|
50
|
-
*
|
|
51
|
-
* Series data is aggregated for the specified base unit by using the [`series.aggregate`]({% slug api_charts_series %}#toc-aggregate) function.
|
|
38
|
+
* Series data is aggregated for the specified base unit by using the [`series.aggregate`](slug:api_charts_series#toc-aggregate) function.
|
|
52
39
|
*/
|
|
53
40
|
baseUnit?: CategoryBaseUnit;
|
|
54
41
|
/**
|
|
55
42
|
* The step (interval) between the categories in base units. Setting it to `"auto"` sets the step to such
|
|
56
|
-
* a value that the total number of categories does not exceed [`categoryAxis.maxDateGroups`](
|
|
57
|
-
* The option is ignored if [`categoryAxis.baseUnit`](
|
|
43
|
+
* a value that the total number of categories does not exceed [`categoryAxis.maxDateGroups`](slug:api_charts_categoryaxis#toc-maxdategroups).
|
|
44
|
+
* The option is ignored if [`categoryAxis.baseUnit`](slug:api_charts_categoryaxis#toc-baseunit) is set to `"fit"`.
|
|
58
45
|
*/
|
|
59
46
|
baseUnitStep?: number | 'auto';
|
|
60
47
|
/**
|
|
@@ -62,15 +49,15 @@ export interface CategoryAxis {
|
|
|
62
49
|
*/
|
|
63
50
|
categories?: any[];
|
|
64
51
|
/**
|
|
65
|
-
* The color to apply to all axis elements. Accepts a valid CSS color string, including
|
|
66
|
-
* Can be overridden by [`categoryAxis.labels.color`](
|
|
52
|
+
* The color to apply to all axis elements. Accepts a valid CSS color string, including HEX and RGB.
|
|
53
|
+
* Can be overridden by [`categoryAxis.labels.color`](slug:api_charts_categoryaxislabels#toc-color) and [`categoryAxis.line.color`](slug:api_charts_axisline#toc-color).
|
|
67
54
|
*/
|
|
68
55
|
color?: string;
|
|
69
56
|
/**
|
|
70
57
|
* If set to `true`, the Chart positions categories and series points on major ticks.
|
|
71
58
|
* This removes the empty space before and after the series.
|
|
72
59
|
* The default value is `false` except for `"area"`, `"verticalArea"`, `"rangeArea"`, and `"verticalRangeArea"`.
|
|
73
|
-
* The option is ignored if the [`series.type`](
|
|
60
|
+
* The option is ignored if the [`series.type`](slug:api_charts_series#toc-type) option is set to `"bar"`, `"column"`, `"boxPlot"`, `"ohlc"`,
|
|
74
61
|
* `"candlestick"`, or `"waterfall"`.
|
|
75
62
|
*/
|
|
76
63
|
justified?: boolean;
|
|
@@ -154,11 +141,7 @@ export interface CategoryAxis {
|
|
|
154
141
|
startAngle?: number;
|
|
155
142
|
/**
|
|
156
143
|
* The category axis type.
|
|
157
|
-
*
|
|
158
|
-
* The supported values are:
|
|
159
|
-
*
|
|
160
|
-
* - `"category"`—Discrete category axis.
|
|
161
|
-
* - `"date"`—Specialized axis for displaying chronological data.
|
|
144
|
+
* The supported values include `category` for a discrete category axis and `date` for a specialized axis for displaying chronological data.
|
|
162
145
|
*/
|
|
163
146
|
type?: 'category' | 'date';
|
|
164
147
|
/**
|
|
@@ -14,13 +14,6 @@ export interface LegendItem {
|
|
|
14
14
|
cursor?: string;
|
|
15
15
|
/**
|
|
16
16
|
* A function for creating a custom visual for the legend items.
|
|
17
|
-
*
|
|
18
|
-
* The available argument fields are:
|
|
19
|
-
*
|
|
20
|
-
* - `options`—The item options.
|
|
21
|
-
* - `createVisual`—A function for getting the default visual.
|
|
22
|
-
* - `series`—The item series.
|
|
23
|
-
* - `pointIndex`—The index of the point in the series. Available for the Pie, Donut, and Funnel series.
|
|
24
17
|
*/
|
|
25
18
|
visual?: (e: LegendItemVisualArgs) => drawing.Element;
|
|
26
19
|
}
|
|
@@ -11,11 +11,6 @@ import { Border, Margin, Padding, TitleVisualArgs } from '../../common/property-
|
|
|
11
11
|
export interface LegendTitle {
|
|
12
12
|
/**
|
|
13
13
|
* The alignment of the title.
|
|
14
|
-
*
|
|
15
|
-
* The available options are:
|
|
16
|
-
* - `"center"`—The text is aligned to the middle.
|
|
17
|
-
* - `"left"`—The text is aligned to the left.
|
|
18
|
-
* - `"right"`—The text is aligned to the right.
|
|
19
14
|
*/
|
|
20
15
|
align?: 'center' | 'left' | 'right';
|
|
21
16
|
/**
|
|
@@ -44,10 +39,6 @@ export interface LegendTitle {
|
|
|
44
39
|
padding?: Padding | number;
|
|
45
40
|
/**
|
|
46
41
|
* The position of the title.
|
|
47
|
-
*
|
|
48
|
-
* The available options are:
|
|
49
|
-
* - `"bottom"`—The title is positioned beneath the legend.
|
|
50
|
-
* - `"top"`—The title is positioned above the legend.
|
|
51
42
|
*/
|
|
52
43
|
position?: 'top' | 'bottom';
|
|
53
44
|
/**
|
|
@@ -17,13 +17,7 @@ export interface LegendMarkers {
|
|
|
17
17
|
*/
|
|
18
18
|
height?: number;
|
|
19
19
|
/**
|
|
20
|
-
* The shape of the legend item markers.
|
|
21
|
-
*
|
|
22
|
-
* The supported values are:
|
|
23
|
-
* * (Default) `"circle"`—The marker shape is a circle.
|
|
24
|
-
* * `"square"`—The marker shape is a square.
|
|
25
|
-
* * `"triangle"`—The marker shape is a triangle.
|
|
26
|
-
* * `"cross"`—The marker shape is a cross.
|
|
20
|
+
* The shape of the legend item markers. Defaults to `circle`.
|
|
27
21
|
*/
|
|
28
22
|
type?: MarkerType;
|
|
29
23
|
/**
|
|
@@ -33,16 +27,6 @@ export interface LegendMarkers {
|
|
|
33
27
|
visible?: boolean;
|
|
34
28
|
/**
|
|
35
29
|
* A function for creating a custom visual for the markers.
|
|
36
|
-
*
|
|
37
|
-
* The available argument fields are:
|
|
38
|
-
* - `rect`—The [geometry Rect]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual will be rendered.
|
|
39
|
-
* - `options`—The marker options.
|
|
40
|
-
* - `createVisual`—A function for getting the default visual.
|
|
41
|
-
* - `category`—The category of the marker point.
|
|
42
|
-
* - `dataItem`—The `dataItem` of the marker point.
|
|
43
|
-
* - `value`—The value of the marker point.
|
|
44
|
-
* - `sender`—The Chart instance.
|
|
45
|
-
* - `series`—The series of the marker point.
|
|
46
30
|
*/
|
|
47
31
|
visual?: (e: MarkersVisualArgs) => drawing.Element;
|
|
48
32
|
}
|
|
@@ -7,18 +7,12 @@ import { LegendInactiveItems } from './legend/inactive-items.interface';
|
|
|
7
7
|
import { LegendItem } from './legend/item.interface';
|
|
8
8
|
import { LegendMarkers } from './legend/markers.interface';
|
|
9
9
|
/**
|
|
10
|
-
* The configuration options of the Chart legend.
|
|
10
|
+
* The configuration options of the Chart legend ([see examples](slug:legend_chart_charts)).
|
|
11
11
|
*/
|
|
12
12
|
export interface Legend {
|
|
13
13
|
/**
|
|
14
14
|
* The legend is horizontally aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"top"` or `"bottom"`.
|
|
15
15
|
* The legend is vertically aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"left"` or `"right"`.
|
|
16
|
-
*
|
|
17
|
-
* The supported values are:
|
|
18
|
-
*
|
|
19
|
-
* - `"start"`—The legend is aligned to the start.
|
|
20
|
-
* - `"center"`—The legend is aligned to the center.
|
|
21
|
-
* - `"end"`—The legend is aligned to the end.
|
|
22
16
|
*/
|
|
23
17
|
align?: 'start' | 'center' | 'end';
|
|
24
18
|
/**
|
|
@@ -55,11 +49,6 @@ export interface Legend {
|
|
|
55
49
|
offsetY?: number;
|
|
56
50
|
/**
|
|
57
51
|
* The orientation of the legend items.
|
|
58
|
-
*
|
|
59
|
-
* The supported values are:
|
|
60
|
-
*
|
|
61
|
-
* - `"vertical"`—The legend items are added vertically.
|
|
62
|
-
* - `"horizontal"`—The legend items are added horizontally.
|
|
63
52
|
*/
|
|
64
53
|
orientation?: 'vertical' | 'horizontal';
|
|
65
54
|
/**
|
|
@@ -68,14 +57,7 @@ export interface Legend {
|
|
|
68
57
|
padding?: Padding | number;
|
|
69
58
|
/**
|
|
70
59
|
* The positions of the Chart legend.
|
|
71
|
-
*
|
|
72
|
-
* The supported values are:
|
|
73
|
-
*
|
|
74
|
-
* - `"top"`—The legend is positioned on the top.
|
|
75
|
-
* - `"bottom"`—The legend is positioned on the bottom.
|
|
76
|
-
* - `"left"`—The legend is positioned on the left.
|
|
77
|
-
* - `"right"`—The legend is positioned on the right.
|
|
78
|
-
* - `"custom"`—The legend is positioned by using [`legend.offsetX`]({% slug api_charts_legend %}#toc-offsetx) and [`legend.offsetY`]({% slug api_charts_legend %}#toc-offsety).
|
|
60
|
+
* Setting the legend position to `custom` allows you to position the legend using the [`legend.offsetX`](slug:api_charts_legend#toc-offsetx) and [`legend.offsetY`](slug:api_charts_legend#toc-offsety) options.
|
|
79
61
|
*/
|
|
80
62
|
position?: 'top' | 'bottom' | 'left' | 'right' | 'custom';
|
|
81
63
|
/**
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
import { drawing } from '@progress/kendo-drawing';
|
|
6
6
|
import { Border, Margin } from '../../common/property-types';
|
|
7
7
|
/**
|
|
8
|
-
* The panes.title options.
|
|
8
|
+
* The `panes.title` options.
|
|
9
9
|
*/
|
|
10
10
|
export interface PanesTitle {
|
|
11
11
|
/**
|
|
@@ -31,11 +31,7 @@ export interface PanesTitle {
|
|
|
31
31
|
/**
|
|
32
32
|
* The position of the title.
|
|
33
33
|
*
|
|
34
|
-
* The
|
|
35
|
-
*
|
|
36
|
-
* - `"left"`—The axis title is positioned on the left (applicable to the horizontal axis).
|
|
37
|
-
* - `"right"`—The axis title is positioned on the right (applicable to the horizontal axis).
|
|
38
|
-
* - `"center"`—The axis title is positioned in the center.
|
|
34
|
+
* The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
|
|
39
35
|
*/
|
|
40
36
|
position?: 'left' | 'right' | 'center';
|
|
41
37
|
/**
|
|
@@ -31,11 +31,7 @@ export interface PaneDefaultsTitle {
|
|
|
31
31
|
/**
|
|
32
32
|
* The position of the title.
|
|
33
33
|
*
|
|
34
|
-
* The
|
|
35
|
-
*
|
|
36
|
-
* - `"left"`—The axis title is positioned on the left (applicable to the horizontal axis).
|
|
37
|
-
* - `"right"`—The axis title is positioned on the right (applicable to the horizontal axis).
|
|
38
|
-
* - `"center"`—The axis title is positioned in the center.
|
|
34
|
+
* The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
|
|
39
35
|
*/
|
|
40
36
|
position?: 'left' | 'right' | 'center';
|
|
41
37
|
/**
|
|
@@ -44,14 +40,6 @@ export interface PaneDefaultsTitle {
|
|
|
44
40
|
visible?: boolean;
|
|
45
41
|
/**
|
|
46
42
|
* A function that can be used to create a custom visual for the title.
|
|
47
|
-
*
|
|
48
|
-
* The available argument fields are:
|
|
49
|
-
*
|
|
50
|
-
* - `text`—The label text.
|
|
51
|
-
* - `rect`—The [geometry Rect]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
|
|
52
|
-
* - `sender`—The Chart instance (might be `undefined`).
|
|
53
|
-
* - `options`—The label options.
|
|
54
|
-
* - `createVisual`—A function that can be used to get the default visual.
|
|
55
43
|
*/
|
|
56
44
|
visual?: (e: any) => drawing.Element;
|
|
57
45
|
}
|
|
@@ -54,14 +54,6 @@ export interface SeriesDefaultsLabels {
|
|
|
54
54
|
visible?: boolean;
|
|
55
55
|
/**
|
|
56
56
|
* A function that can be used to create a custom visual for the labels.
|
|
57
|
-
*
|
|
58
|
-
* The available argument fields are:
|
|
59
|
-
*
|
|
60
|
-
* - `text`—The label text.
|
|
61
|
-
* - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
|
|
62
|
-
* - `sender`—The Chart instance (might be `undefined`).
|
|
63
|
-
* - `options`—The label options.
|
|
64
|
-
* - `createVisual`—A function that can be used to get the default visual.
|
|
65
57
|
*/
|
|
66
58
|
visual?: (e: SeriesLabelsVisualArgs) => drawing.Element;
|
|
67
59
|
/**
|
|
@@ -21,12 +21,6 @@ export interface SeriesDefaultsNotesIcon {
|
|
|
21
21
|
size?: number;
|
|
22
22
|
/**
|
|
23
23
|
* The shape of the notes icon.
|
|
24
|
-
*
|
|
25
|
-
* The supported values are:
|
|
26
|
-
* * `"circle"`—The marker shape is a circle.
|
|
27
|
-
* * `"square"`—The marker shape is a square.
|
|
28
|
-
* * `"triangle"`—The marker shape is a triangle.
|
|
29
|
-
* * `"cross"`—The marker shape is a cross.
|
|
30
24
|
*/
|
|
31
25
|
type?: MarkerType;
|
|
32
26
|
/**
|
|
@@ -17,17 +17,6 @@ export interface SeriesDefaultsNotes {
|
|
|
17
17
|
/**
|
|
18
18
|
* A function for creating a custom visual for the notes.
|
|
19
19
|
*
|
|
20
|
-
* The available argument fields are:
|
|
21
|
-
*
|
|
22
|
-
* - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines the note target rect.
|
|
23
|
-
* - `options`—The note options.
|
|
24
|
-
* - `createVisual`—A function for getting the default visual.
|
|
25
|
-
* - `category`—The category of the note point.
|
|
26
|
-
* - `dataItem`—The `dataItem` of the note point.
|
|
27
|
-
* - `value`—The value of the note point.
|
|
28
|
-
* - `sender`—The Chart instance.
|
|
29
|
-
* - `series`—The series of the note point.
|
|
30
|
-
* - `text`—The note text.
|
|
31
20
|
*/
|
|
32
21
|
visual?: (e: SeriesNoteVisualArgs) => drawing.Element;
|
|
33
22
|
/**
|
|
@@ -35,11 +35,6 @@ export interface SeriesDefaultsNotesLabel {
|
|
|
35
35
|
format?: string;
|
|
36
36
|
/**
|
|
37
37
|
* The position of the labels.
|
|
38
|
-
*
|
|
39
|
-
* The available options are:
|
|
40
|
-
*
|
|
41
|
-
* - `"inside"`—The label is positioned inside the icon.
|
|
42
|
-
* - `"outside"`—The label is positioned outside the icon.
|
|
43
38
|
*/
|
|
44
39
|
position?: NoteLabelPosition;
|
|
45
40
|
/**
|
|
@@ -26,19 +26,16 @@ export interface SeriesDefaultsTooltip {
|
|
|
26
26
|
/**
|
|
27
27
|
* The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
|
|
28
28
|
*
|
|
29
|
-
* The
|
|
29
|
+
* The Area, Bar, Column, Funnel, Line, and Pie are represented by `{0}` as the value placeholder.
|
|
30
|
+
*
|
|
31
|
+
* The Bubble chart type uses the following value placeholders: `{0}` - x value, `{1}` - y value, `{2}` - size value, and `{3}` - category name.
|
|
32
|
+
*
|
|
33
|
+
* The Scatter and ScatterLine chart types use the following value placeholders: `{0}` - x value and `{1}` - y value.
|
|
34
|
+
*
|
|
35
|
+
* The Candlestick and OHLC chart types use the following value placeholders: `{0}` - open value, `{1}` - high value, `{2}` - low value, `{3}` - close value, and `{4}` - category name.
|
|
36
|
+
*
|
|
37
|
+
* The RangeArea, RangeBar, and RangeColumn chart types utilize the following value placeholders: `{0}` - from value and `{1}` - to value.
|
|
30
38
|
*
|
|
31
|
-
* - Area, Bar, Column, Funnel, Line, and Pie
|
|
32
|
-
* {0} - value
|
|
33
|
-
* - Bubble
|
|
34
|
-
* {0} - x value{1} - y value{2} - size value{3} - category name
|
|
35
|
-
* - Scatter and Scatter Line
|
|
36
|
-
* {0} - x value{1} - y value
|
|
37
|
-
* - Candlestick and OHLC
|
|
38
|
-
* {0} - open value{1} - high value{2} - low value{3} - close value{4} - category name
|
|
39
|
-
* - RangeArea, rangeBar, rangeColumn
|
|
40
|
-
* {0} - from value
|
|
41
|
-
* {1} - to value
|
|
42
39
|
*/
|
|
43
40
|
format?: string;
|
|
44
41
|
/**
|
|
@@ -150,52 +150,11 @@ export interface SeriesDefaults {
|
|
|
150
150
|
stack?: boolean | string | SeriesStack;
|
|
151
151
|
/**
|
|
152
152
|
* The default type of the series.
|
|
153
|
-
*
|
|
154
|
-
* The supported values are:
|
|
155
|
-
*
|
|
156
|
-
* - `area`
|
|
157
|
-
* - `bar`
|
|
158
|
-
* - `bubble`
|
|
159
|
-
* - `bullet`
|
|
160
|
-
* - `candlestick`
|
|
161
|
-
* - `column`
|
|
162
|
-
* - `donut`
|
|
163
|
-
* - `funnel`
|
|
164
|
-
* - `line`
|
|
165
|
-
* - `ohlc`
|
|
166
|
-
* - `pie`
|
|
167
|
-
* - `polarArea`
|
|
168
|
-
* - `polarLine`
|
|
169
|
-
* - `polarScatter`
|
|
170
|
-
* - `radarArea`
|
|
171
|
-
* - `radarColumn`
|
|
172
|
-
* - `radarLine`
|
|
173
|
-
* - `rangeArea`
|
|
174
|
-
* - `rangeBar`
|
|
175
|
-
* - `rangeColumn`
|
|
176
|
-
* - `scatter`
|
|
177
|
-
* - `scatterLine`
|
|
178
|
-
* - `verticalArea`
|
|
179
|
-
* - `verticalBullet`
|
|
180
|
-
* - `verticalLine`
|
|
181
|
-
* - `verticalRangeArea`
|
|
182
|
-
* - `waterfall`
|
|
183
153
|
*/
|
|
184
154
|
type?: SeriesType;
|
|
185
155
|
/**
|
|
186
156
|
* A function for creating custom visuals for the points.
|
|
187
157
|
* Applicable for the Bar and Column series.
|
|
188
|
-
*
|
|
189
|
-
* The available argument fields are:
|
|
190
|
-
*
|
|
191
|
-
* - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
|
|
192
|
-
* - `options`—The point options.
|
|
193
|
-
* - `createVisual`—A function that can be used to get the default visual.
|
|
194
|
-
* - `category`—The point category.
|
|
195
|
-
* - `dataItem`—The point `dataItem`.
|
|
196
|
-
* - `value`—The point value.
|
|
197
|
-
* - `sender`—The Chart instance.
|
|
198
|
-
* - `series`—The point series.
|
|
199
158
|
*/
|
|
200
159
|
visual?: (e: SeriesVisualArgs) => drawing.Element;
|
|
201
160
|
/**
|
|
@@ -39,15 +39,6 @@ export interface SeriesErrorBars {
|
|
|
39
39
|
value?: string | number | [number, number] | ((e: ErrorBarsValueArgs) => [number, number]);
|
|
40
40
|
/**
|
|
41
41
|
* A function that for creating custom visuals for the error bars.
|
|
42
|
-
*
|
|
43
|
-
* The available argument fields are:
|
|
44
|
-
*
|
|
45
|
-
* - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
|
|
46
|
-
* - `options`—The error bar options.
|
|
47
|
-
* - `createVisual`—A function that can be used to get the default visual.
|
|
48
|
-
* - `low`—The error bar low value.
|
|
49
|
-
* - `high`—The error bar high value.
|
|
50
|
-
* - `sender`—The Chart instance.
|
|
51
42
|
*/
|
|
52
43
|
visual?: (e: ErrorBarsVisualArgs) => drawing.Element;
|
|
53
44
|
/**
|
|
@@ -25,12 +25,6 @@ export interface SeriesExtremes {
|
|
|
25
25
|
size?: number;
|
|
26
26
|
/**
|
|
27
27
|
* The shape of the series extremes.
|
|
28
|
-
*
|
|
29
|
-
* The supported values are:
|
|
30
|
-
* * `"circle"`—The marker shape is a circle.
|
|
31
|
-
* * `"square"`—The marker shape is a square.
|
|
32
|
-
* * `"triangle"`—The marker shape is a triangle.
|
|
33
|
-
* * `"cross"`—The marker shape is a cross.
|
|
34
28
|
*/
|
|
35
29
|
type?: MarkerType;
|
|
36
30
|
}
|
|
@@ -43,16 +43,6 @@ export interface SeriesHighlight {
|
|
|
43
43
|
markers?: MarkersHighlight;
|
|
44
44
|
/**
|
|
45
45
|
* A function for handling the toggling of the points highlight.
|
|
46
|
-
*
|
|
47
|
-
* The available argument fields are:
|
|
48
|
-
*
|
|
49
|
-
* - `preventDefault`—A function that can be used to prevent the showing of the default highlight overlay.
|
|
50
|
-
* - `show`—A Boolean value indicating whether the highlight has to be shown.
|
|
51
|
-
* - `visual`—The visual element that needs to be highlighted.
|
|
52
|
-
* - `category`—The point category.
|
|
53
|
-
* - `dataItem`—The point `dataItem`.
|
|
54
|
-
* - `value`—The point value.
|
|
55
|
-
* - `series`—The point series.
|
|
56
46
|
*/
|
|
57
47
|
toggle?: (e: HighlightToggleArgs) => void;
|
|
58
48
|
/**
|
|
@@ -62,26 +52,6 @@ export interface SeriesHighlight {
|
|
|
62
52
|
visible?: boolean;
|
|
63
53
|
/**
|
|
64
54
|
* A function for setting custom visuals for the point highlights.
|
|
65
|
-
*
|
|
66
|
-
* The available argument fields are:
|
|
67
|
-
*
|
|
68
|
-
* - `createVisual`—A function that can be used to get the default highlight visual.
|
|
69
|
-
* - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
|
|
70
|
-
* - `visual`—The visual element that needs to be highlighted.
|
|
71
|
-
* - `options`—The point options.
|
|
72
|
-
* - `category`—The point category.
|
|
73
|
-
* - `dataItem`—The point `dataItem`.
|
|
74
|
-
* - `value`—The point value.
|
|
75
|
-
* - `sender`—The Chart instance.
|
|
76
|
-
* - `series`—The point series.
|
|
77
|
-
* - `stackValue`—The cumulative point value on the stack. Available only for the stackable series.
|
|
78
|
-
* - `percentage`—The point value represented as a percentage value. Available only for the Donut, Pie, and
|
|
79
|
-
* 100% stacked charts.
|
|
80
|
-
* - `runningTotal`—The sum of point values since the last `"runningTotal"` summary point. Available for
|
|
81
|
-
* the Waterfall series.
|
|
82
|
-
* - `total`—The sum of all previous series values. Available for the Waterfall series.
|
|
83
|
-
* - `from`—The `from` point highlight visual options. Available for the RangeArea and VerticalRangeArea series.
|
|
84
|
-
* - `to`—The `to` point highlight visual options. Available for the RangeArea and VerticalRangeArea series.
|
|
85
55
|
*/
|
|
86
56
|
visual?: (e: HighlightVisualArgs) => drawing.Element;
|
|
87
57
|
}
|
|
@@ -43,14 +43,14 @@ export interface SeriesLabelsFrom {
|
|
|
43
43
|
/**
|
|
44
44
|
* The position of the `from` labels.
|
|
45
45
|
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
46
|
+
* `"center"`—The label is positioned at the point center.
|
|
47
|
+
* `"insideBase"`—The label is positioned inside, near the base of the bar.
|
|
48
|
+
* `"insideEnd"`—The label is positioned inside, near the end of the point.
|
|
49
|
+
* `"outsideEnd"`—The label is positioned outside, near the end of the point.
|
|
50
|
+
* `"above"`—the label is positioned at the top of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
|
|
51
|
+
* `"below"`—the label is positioned at the bottom of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
|
|
52
|
+
* `"left"`—the label is positioned to the left of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
|
|
53
|
+
* `"right"`—the label is positioned to the right of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
|
|
54
54
|
*/
|
|
55
55
|
position?: 'center' | 'insideBase' | 'insideEnd' | 'outsideEnd';
|
|
56
56
|
/**
|
|
@@ -69,14 +69,6 @@ export interface SeriesLabels {
|
|
|
69
69
|
visible?: boolean;
|
|
70
70
|
/**
|
|
71
71
|
* A function that can be used to create a custom visual for the labels.
|
|
72
|
-
*
|
|
73
|
-
* The available argument fields are:
|
|
74
|
-
*
|
|
75
|
-
* - `text`—The label text.
|
|
76
|
-
* - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
|
|
77
|
-
* - `options`—The label options.
|
|
78
|
-
* - `createVisual`—A function that can be used to get the default visual.
|
|
79
|
-
* - `sender`—The Chart instance (might be `undefined`).
|
|
80
72
|
*/
|
|
81
73
|
visual?: (e: SeriesLabelsVisualArgs) => drawing.Element;
|
|
82
74
|
/**
|
|
@@ -45,14 +45,14 @@ export interface SeriesLabelsTo {
|
|
|
45
45
|
*
|
|
46
46
|
* The available options are:
|
|
47
47
|
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
48
|
+
* `"center"`—The label is positioned at the point center.
|
|
49
|
+
* `"insideBase"`—The label is positioned inside, near the base of the bar.
|
|
50
|
+
* `"insideEnd"`—The label is positioned inside, near the end of the point.
|
|
51
|
+
* `"outsideEnd"`—The label is positioned outside, near the end of the point.
|
|
52
|
+
* `"above"`—The label is positioned at the top of the marker. Applicable for the RangeArea and VerticalRangeArea series.
|
|
53
|
+
* `"below"`—The label is positioned at the bottom of the marker. Applicable for the RangeArea and VerticalRangeArea series.
|
|
54
|
+
* `"left"`—The label is positioned to the left of the marker. Applicable for the RangeArea and VerticalRangeArea series.
|
|
55
|
+
* `"right"`—The label is positioned to the right of the marker. Applicable for the RangeArea and VerticalRangeArea series.
|
|
56
56
|
*/
|
|
57
57
|
position?: 'center' | 'insideBase' | 'insideEnd' | 'outsideEnd';
|
|
58
58
|
/**
|
|
@@ -30,14 +30,6 @@ export interface SeriesMarkers {
|
|
|
30
30
|
borderRadius?: number;
|
|
31
31
|
/**
|
|
32
32
|
* The shape of the series markers.
|
|
33
|
-
*
|
|
34
|
-
* The supported values are:
|
|
35
|
-
* * `"circle"`—The marker shape is a circle.
|
|
36
|
-
* * `"square"`—The marker shape is a square.
|
|
37
|
-
* * `"triangle"`—The marker shape is a triangle.
|
|
38
|
-
* * `"cross"`—The marker shape is a cross.
|
|
39
|
-
* * `"rect"`—An alias for "square".
|
|
40
|
-
* * `"roundedRect"`—The marker shape is a rounded rectangle.
|
|
41
33
|
*/
|
|
42
34
|
type?: MarkerType;
|
|
43
35
|
/**
|
|
@@ -47,17 +39,6 @@ export interface SeriesMarkers {
|
|
|
47
39
|
visible?: boolean;
|
|
48
40
|
/**
|
|
49
41
|
* A function for creating a custom visual for the markers.
|
|
50
|
-
*
|
|
51
|
-
* The available argument fields are:
|
|
52
|
-
*
|
|
53
|
-
* - `rect`—The [geometry Rect]({% slug api_kendo-drawing_geometry_rect %}) that defines where the visual has to be rendered.
|
|
54
|
-
* - `options`—The marker options.
|
|
55
|
-
* - `createVisual`—A function that can be used to get the default visual.
|
|
56
|
-
* - `category`—The category of the marker point.
|
|
57
|
-
* - `dataItem`—The `dataItem` of the marker point.
|
|
58
|
-
* - `value`—The value of the marker point.
|
|
59
|
-
* - `sender`—The Chart instance.
|
|
60
|
-
* - `series`—The series of the marker point.
|
|
61
42
|
*/
|
|
62
43
|
visual?: (e: MarkersVisualArgs) => drawing.Element;
|
|
63
44
|
/**
|
|
@@ -21,12 +21,6 @@ export interface SeriesNotesIcon {
|
|
|
21
21
|
size?: number;
|
|
22
22
|
/**
|
|
23
23
|
* The icon shape.
|
|
24
|
-
*
|
|
25
|
-
* The supported values are:
|
|
26
|
-
* * `"circle"`—The marker shape is a circle.
|
|
27
|
-
* * `"square"`—The marker shape is a square.
|
|
28
|
-
* * `"triangle"`—The marker shape is a triangle.
|
|
29
|
-
* * `"cross"`—The marker shape is a cross.
|
|
30
24
|
*/
|
|
31
25
|
type?: MarkerType;
|
|
32
26
|
/**
|
|
@@ -16,29 +16,10 @@ export interface SeriesNotes {
|
|
|
16
16
|
line?: NoteLine;
|
|
17
17
|
/**
|
|
18
18
|
* The position of the series note.
|
|
19
|
-
*
|
|
20
|
-
* The available options are:
|
|
21
|
-
*
|
|
22
|
-
* - `"top"`—The note is positioned on the top.
|
|
23
|
-
* - `"bottom"`—The note is positioned on the bottom.
|
|
24
|
-
* - `"left"`—The note is positioned on the left.
|
|
25
|
-
* - `"right"`—The note is positioned on the right.
|
|
26
19
|
*/
|
|
27
20
|
position?: NotePosition;
|
|
28
21
|
/**
|
|
29
22
|
* A function for creating a custom visual for the notes.
|
|
30
|
-
*
|
|
31
|
-
* The available argument fields are:
|
|
32
|
-
*
|
|
33
|
-
* - `rect`—The geometry [`Rect`]({% slug api_kendo-drawing_geometry_rect %}) that defines the note target rect.
|
|
34
|
-
* - `options`—The note options.
|
|
35
|
-
* - `createVisual`—A function that can be used to get the default visual.
|
|
36
|
-
* - `category`—The category of the note point.
|
|
37
|
-
* - `dataItem`—The `dataItem` of the note point.
|
|
38
|
-
* - `value`—The value of the note point.
|
|
39
|
-
* - `sender`—The Chart instance.
|
|
40
|
-
* - `series`—The series of the note point.
|
|
41
|
-
* - `text`—The note text.
|
|
42
23
|
*/
|
|
43
24
|
visual?: (e: SeriesNoteVisualArgs) => drawing.Element;
|
|
44
25
|
/**
|
|
@@ -36,10 +36,6 @@ export interface SeriesNotesLabel {
|
|
|
36
36
|
/**
|
|
37
37
|
* The position of the labels.
|
|
38
38
|
*
|
|
39
|
-
* The available options are:
|
|
40
|
-
*
|
|
41
|
-
* - `"inside"`—The label is positioned inside the icon.
|
|
42
|
-
* - `"outside"`—The label is positioned outside the icon.
|
|
43
39
|
*/
|
|
44
40
|
position?: NoteLabelPosition;
|
|
45
41
|
/**
|
|
@@ -25,12 +25,6 @@ export interface SeriesOutliers {
|
|
|
25
25
|
size?: number;
|
|
26
26
|
/**
|
|
27
27
|
* The outliers shape.
|
|
28
|
-
*
|
|
29
|
-
* The supported values are:
|
|
30
|
-
* * `"circle"`—The marker shape is a circle.
|
|
31
|
-
* * `"square"`—The marker shape is a square.
|
|
32
|
-
* * `"triangle"`—The marker shape is a triangle.
|
|
33
|
-
* * `"cross"`—The marker shape is a cross.
|
|
34
28
|
*/
|
|
35
29
|
type?: MarkerType;
|
|
36
30
|
}
|