@progress/kendo-vue-charts 3.14.2 → 3.15.0-dev.202309281301

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.
Files changed (65) hide show
  1. package/dist/cdn/js/kendo-vue-charts.js +1 -1
  2. package/dist/es/common/property-types.d.ts +2 -0
  3. package/dist/es/components/SeriesItem.js +2 -1
  4. package/dist/es/events/legend-item-click-event.d.ts +1 -1
  5. package/dist/es/events/legend-item-hover-event.d.ts +1 -1
  6. package/dist/es/events/legend-item-leave-event.d.ts +1 -1
  7. package/dist/es/field-types/series-labels-position.d.ts +3 -3
  8. package/dist/es/field-types/series-labels-position.js +3 -3
  9. package/dist/es/field-types/series-type.d.ts +1 -1
  10. package/dist/es/field-types/trendline-forecast.interface.d.ts +13 -0
  11. package/dist/es/field-types/trendline-forecast.interface.js +1 -0
  12. package/dist/es/option-types/series-defaults/labels.from.interface.d.ts +2 -2
  13. package/dist/es/option-types/series-defaults/labels.interface.d.ts +2 -2
  14. package/dist/es/option-types/series-defaults/labels.to.interface.d.ts +2 -2
  15. package/dist/es/option-types/series-defaults.interface.d.ts +1 -0
  16. package/dist/es/option-types/series-item/labels.interface.d.ts +2 -2
  17. package/dist/es/option-types/series-item/tooltip.interface.d.ts +1 -1
  18. package/dist/es/option-types/series-item/trendline.interface.d.ts +18 -0
  19. package/dist/es/option-types/series-item/trendline.interface.js +1 -0
  20. package/dist/es/option-types/series-item.interface.d.ts +18 -8
  21. package/dist/es/option-types/tooltip.interface.d.ts +1 -1
  22. package/dist/es/package-metadata.js +1 -1
  23. package/dist/esm/common/property-types.d.ts +2 -0
  24. package/dist/esm/components/SeriesItem.js +2 -1
  25. package/dist/esm/events/legend-item-click-event.d.ts +1 -1
  26. package/dist/esm/events/legend-item-hover-event.d.ts +1 -1
  27. package/dist/esm/events/legend-item-leave-event.d.ts +1 -1
  28. package/dist/esm/field-types/series-labels-position.d.ts +3 -3
  29. package/dist/esm/field-types/series-labels-position.js +3 -3
  30. package/dist/esm/field-types/series-type.d.ts +1 -1
  31. package/dist/esm/field-types/trendline-forecast.interface.d.ts +13 -0
  32. package/dist/esm/field-types/trendline-forecast.interface.js +1 -0
  33. package/dist/esm/option-types/series-defaults/labels.from.interface.d.ts +2 -2
  34. package/dist/esm/option-types/series-defaults/labels.interface.d.ts +2 -2
  35. package/dist/esm/option-types/series-defaults/labels.to.interface.d.ts +2 -2
  36. package/dist/esm/option-types/series-defaults.interface.d.ts +1 -0
  37. package/dist/esm/option-types/series-item/labels.interface.d.ts +2 -2
  38. package/dist/esm/option-types/series-item/tooltip.interface.d.ts +1 -1
  39. package/dist/esm/option-types/series-item/trendline.interface.d.ts +18 -0
  40. package/dist/esm/option-types/series-item/trendline.interface.js +1 -0
  41. package/dist/esm/option-types/series-item.interface.d.ts +18 -8
  42. package/dist/esm/option-types/tooltip.interface.d.ts +1 -1
  43. package/dist/esm/package-metadata.js +1 -1
  44. package/dist/npm/common/property-types.d.ts +2 -0
  45. package/dist/npm/components/SeriesItem.js +2 -1
  46. package/dist/npm/events/legend-item-click-event.d.ts +1 -1
  47. package/dist/npm/events/legend-item-hover-event.d.ts +1 -1
  48. package/dist/npm/events/legend-item-leave-event.d.ts +1 -1
  49. package/dist/npm/field-types/series-labels-position.d.ts +3 -3
  50. package/dist/npm/field-types/series-labels-position.js +3 -3
  51. package/dist/npm/field-types/series-type.d.ts +1 -1
  52. package/dist/npm/field-types/trendline-forecast.interface.d.ts +13 -0
  53. package/dist/npm/field-types/trendline-forecast.interface.js +2 -0
  54. package/dist/npm/option-types/series-defaults/labels.from.interface.d.ts +2 -2
  55. package/dist/npm/option-types/series-defaults/labels.interface.d.ts +2 -2
  56. package/dist/npm/option-types/series-defaults/labels.to.interface.d.ts +2 -2
  57. package/dist/npm/option-types/series-defaults.interface.d.ts +1 -0
  58. package/dist/npm/option-types/series-item/labels.interface.d.ts +2 -2
  59. package/dist/npm/option-types/series-item/tooltip.interface.d.ts +1 -1
  60. package/dist/npm/option-types/series-item/trendline.interface.d.ts +18 -0
  61. package/dist/npm/option-types/series-item/trendline.interface.js +2 -0
  62. package/dist/npm/option-types/series-item.interface.d.ts +18 -8
  63. package/dist/npm/option-types/tooltip.interface.d.ts +1 -1
  64. package/dist/npm/package-metadata.js +1 -1
  65. package/package.json +7 -7
@@ -36,6 +36,7 @@ export { SeriesLabelsPosition } from '../field-types/series-labels-position';
36
36
  export { SeriesLine } from '../field-types/series-line.interface';
37
37
  export { SeriesStack } from '../field-types/series-stack.interface';
38
38
  export { SeriesType } from '../field-types/series-type';
39
+ export { TrendlineForecast } from '../field-types/trendline-forecast.interface';
39
40
  export { WeekStartDay } from '../field-types/week-start-day.enum';
40
41
  export { AxisLabelVisualArgs } from '../argument-types/axis-label-visual-args.interface';
41
42
  export { AxisNoteVisualArgs } from '../argument-types/axis-note-visual-args.interface';
@@ -98,6 +99,7 @@ export { SeriesNotesIcon } from '../option-types/series-item/notes.icon.interfac
98
99
  export { SeriesNotesLabel } from '../option-types/series-item/notes.label.interface';
99
100
  export { SeriesOutliers } from '../option-types/series-item/outliers.interface';
100
101
  export { SeriesTooltip } from '../option-types/series-item/tooltip.interface';
102
+ export { SeriesTrendline } from '../option-types/series-item/trendline.interface';
101
103
  export { Series } from '../option-types/series-item.interface';
102
104
  export { Title } from '../option-types/title.interface';
103
105
  export { Tooltip } from '../option-types/tooltip.interface';
@@ -73,6 +73,7 @@ var ChartSeriesItemVue2 = {
73
73
  errorLowField: String,
74
74
  explodeField: String,
75
75
  field: String,
76
+ for: String,
76
77
  fromField: String,
77
78
  gap: Number,
78
79
  highField: String,
@@ -160,7 +161,7 @@ var ChartSeriesItemVue2 = {
160
161
  return undefined;
161
162
  },
162
163
  validator: function validator(value) {
163
- return ['area', 'bar', 'boxPlot', 'bubble', 'bullet', 'candlestick', 'column', 'donut', 'funnel', 'horizontalWaterfall', 'line', 'ohlc', 'pie', 'polarArea', 'polarLine', 'polarScatter', 'radarArea', 'radarColumn', 'radarLine', 'rangeArea', 'rangeBar', 'rangeColumn', 'scatter', 'scatterLine', 'verticalArea', 'verticalBoxPlot', 'verticalBullet', 'verticalLine', 'verticalRangeArea', 'waterfall'].includes(value);
164
+ return ['area', 'bar', 'boxPlot', 'bubble', 'bullet', 'candlestick', 'column', 'donut', 'funnel', 'pyramid', 'linearTrendline', 'movingAverageTrendline', 'horizontalWaterfall', 'line', 'ohlc', 'pie', 'polarArea', 'polarLine', 'polarScatter', 'radarArea', 'radarColumn', 'radarLine', 'rangeArea', 'rangeBar', 'rangeColumn', 'scatter', 'scatterLine', 'verticalArea', 'verticalBoxPlot', 'verticalBullet', 'verticalLine', 'verticalRangeArea', 'waterfall'].includes(value);
164
165
  }
165
166
  },
166
167
  upperField: String,
@@ -14,7 +14,7 @@ export declare class LegendItemClickEvent extends PreventableEvent {
14
14
  */
15
15
  seriesIndex: number;
16
16
  /**
17
- * The point index in the series. Applicable only to the Pie, Donut, and Funnel series.
17
+ * The point index in the series. Applicable only to the Pie, Donut, Funnel and Pyramid series.
18
18
  */
19
19
  pointIndex: number;
20
20
  /**
@@ -14,7 +14,7 @@ export declare class LegendItemHoverEvent extends PreventableEvent {
14
14
  */
15
15
  seriesIndex: number;
16
16
  /**
17
- * The point index in the series. Applicable only for the Pie, Donut, and Funnel series.
17
+ * The point index in the series. Applicable only to the Pie, Donut, Funnel and Pyramid series.
18
18
  */
19
19
  pointIndex: number;
20
20
  /**
@@ -14,7 +14,7 @@ export declare class LegendItemLeaveEvent extends PreventableEvent {
14
14
  */
15
15
  seriesIndex: number;
16
16
  /**
17
- * The point index in the series. Applicable only to the Pie, Donut, and Funnel series.
17
+ * The point index in the series. Applicable only to the Pie, Donut, Funnel and Pyramid series.
18
18
  */
19
19
  pointIndex: number;
20
20
  /**
@@ -3,14 +3,14 @@
3
3
  *
4
4
  * - `"above"`—The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
5
5
  * - `"below"`—The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
6
- * - `"center"`—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, RadarColumn, and Waterfall series.
6
+ * - `"center"`—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, Pyramid, RadarColumn, and Waterfall series.
7
7
  * - `"insideBase"`—The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
8
8
  * - `"insideEnd"`—The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
9
9
  * - `"left"`—The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
10
10
  * - `"outsideEnd"`—The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
11
11
  * - `"right"`—The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
12
- * - `"top"`—The label is positioned at the top of the segment. Applicable for the Funnel series.
13
- * - `"bottom"`—The label is positioned at the bottom of the segment. Applicable for the Funnel series.
12
+ * - `"top"`—The label is positioned at the top of the segment. Applicable for the Funnel and Pyramid series.
13
+ * - `"bottom"`—The label is positioned at the bottom of the segment. Applicable for the Funnel and Pyramid series.
14
14
  * - `"auto"`—The from and to labels are positioned at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
15
15
  */
16
16
  export declare type SeriesLabelsPosition = 'auto' | 'above' | 'below' | 'center' | 'insideBase' | 'insideEnd' | 'left' | 'outsideEnd' | 'right' | 'top' | 'bottom';
@@ -4,14 +4,14 @@
4
4
  *
5
5
  * - `"above"`—The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
6
6
  * - `"below"`—The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
7
- * - `"center"`—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, RadarColumn, and Waterfall series.
7
+ * - `"center"`—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, Pyramid, RadarColumn, and Waterfall series.
8
8
  * - `"insideBase"`—The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
9
9
  * - `"insideEnd"`—The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
10
10
  * - `"left"`—The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
11
11
  * - `"outsideEnd"`—The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
12
12
  * - `"right"`—The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
13
- * - `"top"`—The label is positioned at the top of the segment. Applicable for the Funnel series.
14
- * - `"bottom"`—The label is positioned at the bottom of the segment. Applicable for the Funnel series.
13
+ * - `"top"`—The label is positioned at the top of the segment. Applicable for the Funnel and Pyramid series.
14
+ * - `"bottom"`—The label is positioned at the bottom of the segment. Applicable for the Funnel and Pyramid series.
15
15
  * - `"auto"`—The from and to labels are positioned at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
16
16
  */
17
17
  // tslint:enable:max-line-length
@@ -35,4 +35,4 @@
35
35
  * </script>
36
36
  * ```
37
37
  */
38
- export declare type SeriesType = 'area' | 'bar' | 'boxPlot' | 'bubble' | 'bullet' | 'candlestick' | 'column' | 'donut' | 'funnel' | 'horizontalWaterfall' | 'line' | 'ohlc' | 'pie' | 'polarArea' | 'polarLine' | 'polarScatter' | 'radarArea' | 'radarColumn' | 'radarLine' | 'rangeArea' | 'rangeBar' | 'rangeColumn' | 'scatter' | 'scatterLine' | 'verticalArea' | 'verticalBoxPlot' | 'verticalBullet' | 'verticalLine' | 'verticalRangeArea' | 'waterfall';
38
+ export declare type SeriesType = 'area' | 'bar' | 'boxPlot' | 'bubble' | 'bullet' | 'candlestick' | 'column' | 'donut' | 'funnel' | 'pyramid' | 'horizontalWaterfall' | 'line' | 'linearTrendline' | 'movingAverageTrendline' | 'ohlc' | 'pie' | 'polarArea' | 'polarLine' | 'polarScatter' | 'radarArea' | 'radarColumn' | 'radarLine' | 'rangeArea' | 'rangeBar' | 'rangeColumn' | 'scatter' | 'scatterLine' | 'verticalArea' | 'verticalBoxPlot' | 'verticalBullet' | 'verticalLine' | 'verticalRangeArea' | 'waterfall';
@@ -0,0 +1,13 @@
1
+ /**
2
+ * The series trendline forecast settings.
3
+ */
4
+ export interface TrendlineForecast {
5
+ /**
6
+ * The number of intervals to extend the trendline before the first data point.
7
+ */
8
+ before?: number;
9
+ /**
10
+ * The number of intervals to extend the trendline after the last data point.
11
+ */
12
+ after?: number;
13
+ }
@@ -19,9 +19,9 @@ export interface SeriesDefaultsLabelsFrom {
19
19
  * The function which returns the `from` label content of the Chart series. You can split the text into multiple lines by using line feed characters (`"\n"`).
20
20
  *
21
21
  * The available fields in the function argument are:
22
- * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie series.
22
+ * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
23
23
  * - `dataItem`&mdash;The original data item used to construct the point. If binding to an array, it will be `null`.
24
- * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, and Pie series.
24
+ * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid, and Pie series.
25
25
  * - `series`&mdash;The data series.
26
26
  * - `value`&mdash;The point value. Can be a number or object which contain each bound field.
27
27
  * - `runningTotal`&mdash;The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
@@ -22,9 +22,9 @@ export interface SeriesDefaultsLabels {
22
22
  * The function which returns the Chart series labels content. You can split the text into multiple lines by using line feed characters (`"\n"`).
23
23
  *
24
24
  * The available fields in the function argument are:
25
- * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie series.
25
+ * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
26
26
  * - `dataItem`&mdash;The original data item used to construct the point. If binding to an array, it will be `null`.
27
- * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, and Pie series.
27
+ * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid and Pie series.
28
28
  * - `series`&mdash;The data series.
29
29
  * - `value`&mdash;The point value. Can be a number or object containing each bound field.
30
30
  * - `runningTotal`&mdash;The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
@@ -19,9 +19,9 @@ export interface SeriesDefaultsLabelsTo {
19
19
  * The function which returns the `from` label content of the Chart series. You can split the text into multiple lines by using the line feed characters (`"\n"`).
20
20
  *
21
21
  * The available fields in the function argument are:
22
- * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie series.
22
+ * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
23
23
  * - `dataItem`&mdash;The original data item used to construct the point. If binding to an array, it will be `null`.
24
- * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, and Pie series.
24
+ * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid and Pie series.
25
25
  * - `series`&mdash;The data series.
26
26
  * - `value`&mdash;The point value. Can be a number or object containing each bound field.
27
27
  * - `runningTotal`&mdash;The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
@@ -39,6 +39,7 @@ export interface SeriesDefaults {
39
39
  * - `column`
40
40
  * - `donut`
41
41
  * - `funnel`
42
+ * - `pyramid`
42
43
  * - `line`
43
44
  * - `ohlc`
44
45
  * - `pie`
@@ -8,13 +8,13 @@ import { SeriesLabelsTo } from './labels.to.interface';
8
8
  */
9
9
  export interface SeriesLabels {
10
10
  /**
11
- * The alignment of the label when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"donut"`, `"funnel"`, or `"pie"`.
11
+ * The alignment of the label when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
12
12
  *
13
13
  * The supported values for `"donut"` and `"pie"` are:
14
14
  * - `"circle"`&mdash;The labels are positioned in circle around the Chart.
15
15
  * - `"column"`&mdash;The labels are positioned in columns to the left and right of the Chart.
16
16
  *
17
- * The supported values for `"funnel"` are:
17
+ * The supported values for `"funnel"` and `"pyramid"` are:
18
18
  * - `"center"`&mdash;The labels are positioned in the center over the funnel segment.
19
19
  * - `"right"`&mdash;The labels are positioned on the right side of the Chart and, if there is enough space, do not overlap the funnel segments.
20
20
  * - `"left"`&mdash;The labels are positioned on the left side of the Chart and, if there is enough space, do not overlap the funnel segments.
@@ -23,7 +23,7 @@ export interface SeriesTooltip {
23
23
  * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
24
24
  *
25
25
  * The available format placeholders are:
26
- * - Area, Bar, Column, Line, Pie, radarArea, radarColumn and radarLine: {0} - value.
26
+ * - Area, Bar, Column, Line, Funnel, Pyramid, Pie, radarArea, radarColumn and radarLine: {0} - value.
27
27
  * - Bubble: {0} - x value, {1} - y value, {2} - size value, {3} - category name.
28
28
  * - Scatter, scatterLine: {0} - x value, {1} - y value.
29
29
  * - PolarArea, polarLine and polarScatterL: {0} - x value (degrees), {1} - y value.
@@ -0,0 +1,18 @@
1
+ import { TrendlineForecast } from '../../common/property-types';
2
+ /**
3
+ * The configuration options of the series trendlines.
4
+ */
5
+ export interface SeriesTrendline {
6
+ /**
7
+ * The trendline forecast settings. By default, the trendline does not display a forecast.
8
+ *
9
+ * The forecast setting is supported for Linear Trendlines on date and scatter series.
10
+ */
11
+ forecast?: TrendlineForecast;
12
+ /**
13
+ * The number of intervals to take when calculating averages. The value should be an integer greater than 2.
14
+ *
15
+ * The period setting is supported only for Moving Average trendlines.
16
+ */
17
+ period?: number;
18
+ }
@@ -1,5 +1,5 @@
1
1
  import { drawing } from '@progress/kendo-drawing';
2
- import { Border, BulletTarget, DashType, LabelConnectors } from '../common/property-types';
2
+ import { Border, BulletTarget, DashType, LabelConnectors, SeriesTrendline } from '../common/property-types';
3
3
  import { Margin, NegativeBubbleValues, Overlay, SeriesLine, SeriesType } from '../common/property-types';
4
4
  import { LineStyle, SeriesStack, SeriesVisualArgs } from '../common/property-types';
5
5
  import { SeriesErrorBars } from './series-item/error-bars.interface';
@@ -106,7 +106,7 @@ export interface Series {
106
106
  */
107
107
  downColorField?: string;
108
108
  /**
109
- * The `dynamicHeight` option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"funnel"`. When set to `false`, all segments become with the same height. Otherwise, the height of each segment is based on its value.
109
+ * The `dynamicHeight` option is supported when [`series.type`]({% slug api_charts_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.
110
110
  */
111
111
  dynamicHeight?: boolean;
112
112
  /**
@@ -129,6 +129,12 @@ export interface Series {
129
129
  * The data item field which contains the series value.
130
130
  */
131
131
  field?: string;
132
+ /**
133
+ * The name of the parent series of the trendline.
134
+ *
135
+ * The `for` option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"linearTrendline"` or `"movingAverageTrendline"`.
136
+ */
137
+ for?: string;
132
138
  /**
133
139
  * The data item field which contains the series from value.
134
140
  */
@@ -191,7 +197,7 @@ export interface Series {
191
197
  */
192
198
  name?: string;
193
199
  /**
194
- * Specifies the top-base/bottom-base ratio of the whole 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`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"funnel"` and `dynamicSlope` is set to `false`.
200
+ * 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`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"funnel"` and `dynamicSlope` is set to `false`.
195
201
  */
196
202
  neckRatio?: number;
197
203
  /**
@@ -235,7 +241,7 @@ export interface Series {
235
241
  */
236
242
  q3Field?: string;
237
243
  /**
238
- * The space in pixels between the different segments of the Funnel Chart. The `segmentSpacing` option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"funnel"`.
244
+ * The space in pixels between the different segments of the Funnel or Pyramid Chart. The `segmentSpacing` option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"funnel"` or `"pyramid"`.
239
245
  */
240
246
  segmentSpacing?: number;
241
247
  /**
@@ -332,15 +338,15 @@ export interface Series {
332
338
  */
333
339
  visible?: boolean;
334
340
  /**
335
- * A value which indicates whether to show the point category (for Funnel, Donut, and Pie series) or the series name (for other available series types) in the legend.
341
+ * A value which indicates whether to show the point category (for Funnel, Pyramid, Donut, and Pie series) or the series name (for other available series types) in the legend.
336
342
  */
337
343
  visibleInLegend?: boolean;
338
344
  /**
339
- * The data item field which indicates whether to show the point category name in the legend. The `visibleInLegendField` option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"funnel"`, `"donut"`, or `"pie"`.
345
+ * The data item field which indicates whether to show the point category name in the legend. The `visibleInLegendField` option is supported when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"funnel"`, `"pyramid"`, `"donut"`, or `"pie"`.
340
346
  */
341
347
  visibleInLegendField?: string;
342
348
  /**
343
- * A function that can be used to create a custom visual for the points. Applicable for the Bar, Column, Pie, Donut, Funnel, Range Bar, Range Column, and Waterfall series.
349
+ * A function that can be used to create a custom visual for the points. Applicable for the Bar, Column, Pie, Donut, Funnel, Pyramid, Range Bar, Range Column, and Waterfall series.
344
350
  *
345
351
  * The available argument fields are:
346
352
  *
@@ -361,7 +367,7 @@ export interface Series {
361
367
  * - `startAngle`&mdash;The segment start angle. Available for the Donut and Pie series.
362
368
  * - `endAngle`&mdash;The segment end angle. Available for the Donut and Pie series.
363
369
  * - `center`&mdash;The segment center point. Available for the Donut and Pie series.
364
- * - `points`&mdash;The segment points. Available for the Funnel series.
370
+ * - `points`&mdash;The segment points. Available for the Funnel and Pyramid series.
365
371
  */
366
372
  visual?: (e: SeriesVisualArgs) => drawing.Element;
367
373
  /**
@@ -436,4 +442,8 @@ export interface Series {
436
442
  * The configuration options of the Chart series tooltip.
437
443
  */
438
444
  tooltip?: SeriesTooltip;
445
+ /**
446
+ * The configuration options of the series trendlines.
447
+ */
448
+ trendline?: SeriesTrendline;
439
449
  }
@@ -23,7 +23,7 @@ export interface Tooltip {
23
23
  * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
24
24
  *
25
25
  * The available format placeholders are:
26
- * - Area, Bar, Column, Funnel, Line, and Pie: {0} - value.
26
+ * - Area, Bar, Column, Funnel, Pyramid, Line, and Pie: {0} - value.
27
27
  * - Bubble: {0} - x value, {1} - y value, {2} - size value, {3} - category name.
28
28
  * - Scatter and scatterLine: {0} - x value, {1} - y value.
29
29
  * - Candlestick and OHLC: {0} - open value, {1} - high value, {2} - low value, {3} - close value, {4} - category name.
@@ -5,7 +5,7 @@ export var packageMetadata = {
5
5
  name: '@progress/kendo-vue-charts',
6
6
  productName: 'Kendo UI for Vue',
7
7
  productCodes: ['KENDOUIVUE', 'KENDOUICOMPLETE'],
8
- publishDate: 1695651513,
8
+ publishDate: 1695905225,
9
9
  version: '',
10
10
  licensingDocsUrl: 'https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=product&utm_source=kendovue&utm_campaign=kendo-ui-vue-purchase-license-keys-warning'
11
11
  };
@@ -36,6 +36,7 @@ export { SeriesLabelsPosition } from '../field-types/series-labels-position';
36
36
  export { SeriesLine } from '../field-types/series-line.interface';
37
37
  export { SeriesStack } from '../field-types/series-stack.interface';
38
38
  export { SeriesType } from '../field-types/series-type';
39
+ export { TrendlineForecast } from '../field-types/trendline-forecast.interface';
39
40
  export { WeekStartDay } from '../field-types/week-start-day.enum';
40
41
  export { AxisLabelVisualArgs } from '../argument-types/axis-label-visual-args.interface';
41
42
  export { AxisNoteVisualArgs } from '../argument-types/axis-note-visual-args.interface';
@@ -98,6 +99,7 @@ export { SeriesNotesIcon } from '../option-types/series-item/notes.icon.interfac
98
99
  export { SeriesNotesLabel } from '../option-types/series-item/notes.label.interface';
99
100
  export { SeriesOutliers } from '../option-types/series-item/outliers.interface';
100
101
  export { SeriesTooltip } from '../option-types/series-item/tooltip.interface';
102
+ export { SeriesTrendline } from '../option-types/series-item/trendline.interface';
101
103
  export { Series } from '../option-types/series-item.interface';
102
104
  export { Title } from '../option-types/title.interface';
103
105
  export { Tooltip } from '../option-types/tooltip.interface';
@@ -73,6 +73,7 @@ var ChartSeriesItemVue2 = {
73
73
  errorLowField: String,
74
74
  explodeField: String,
75
75
  field: String,
76
+ for: String,
76
77
  fromField: String,
77
78
  gap: Number,
78
79
  highField: String,
@@ -160,7 +161,7 @@ var ChartSeriesItemVue2 = {
160
161
  return undefined;
161
162
  },
162
163
  validator: function validator(value) {
163
- return ['area', 'bar', 'boxPlot', 'bubble', 'bullet', 'candlestick', 'column', 'donut', 'funnel', 'horizontalWaterfall', 'line', 'ohlc', 'pie', 'polarArea', 'polarLine', 'polarScatter', 'radarArea', 'radarColumn', 'radarLine', 'rangeArea', 'rangeBar', 'rangeColumn', 'scatter', 'scatterLine', 'verticalArea', 'verticalBoxPlot', 'verticalBullet', 'verticalLine', 'verticalRangeArea', 'waterfall'].includes(value);
164
+ return ['area', 'bar', 'boxPlot', 'bubble', 'bullet', 'candlestick', 'column', 'donut', 'funnel', 'pyramid', 'linearTrendline', 'movingAverageTrendline', 'horizontalWaterfall', 'line', 'ohlc', 'pie', 'polarArea', 'polarLine', 'polarScatter', 'radarArea', 'radarColumn', 'radarLine', 'rangeArea', 'rangeBar', 'rangeColumn', 'scatter', 'scatterLine', 'verticalArea', 'verticalBoxPlot', 'verticalBullet', 'verticalLine', 'verticalRangeArea', 'waterfall'].includes(value);
164
165
  }
165
166
  },
166
167
  upperField: String,
@@ -14,7 +14,7 @@ export declare class LegendItemClickEvent extends PreventableEvent {
14
14
  */
15
15
  seriesIndex: number;
16
16
  /**
17
- * The point index in the series. Applicable only to the Pie, Donut, and Funnel series.
17
+ * The point index in the series. Applicable only to the Pie, Donut, Funnel and Pyramid series.
18
18
  */
19
19
  pointIndex: number;
20
20
  /**
@@ -14,7 +14,7 @@ export declare class LegendItemHoverEvent extends PreventableEvent {
14
14
  */
15
15
  seriesIndex: number;
16
16
  /**
17
- * The point index in the series. Applicable only for the Pie, Donut, and Funnel series.
17
+ * The point index in the series. Applicable only to the Pie, Donut, Funnel and Pyramid series.
18
18
  */
19
19
  pointIndex: number;
20
20
  /**
@@ -14,7 +14,7 @@ export declare class LegendItemLeaveEvent extends PreventableEvent {
14
14
  */
15
15
  seriesIndex: number;
16
16
  /**
17
- * The point index in the series. Applicable only to the Pie, Donut, and Funnel series.
17
+ * The point index in the series. Applicable only to the Pie, Donut, Funnel and Pyramid series.
18
18
  */
19
19
  pointIndex: number;
20
20
  /**
@@ -3,14 +3,14 @@
3
3
  *
4
4
  * - `"above"`&mdash;The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
5
5
  * - `"below"`&mdash;The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
6
- * - `"center"`&mdash;The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, RadarColumn, and Waterfall series.
6
+ * - `"center"`&mdash;The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, Pyramid, RadarColumn, and Waterfall series.
7
7
  * - `"insideBase"`&mdash;The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
8
8
  * - `"insideEnd"`&mdash;The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
9
9
  * - `"left"`&mdash;The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
10
10
  * - `"outsideEnd"`&mdash;The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
11
11
  * - `"right"`&mdash;The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
12
- * - `"top"`&mdash;The label is positioned at the top of the segment. Applicable for the Funnel series.
13
- * - `"bottom"`&mdash;The label is positioned at the bottom of the segment. Applicable for the Funnel series.
12
+ * - `"top"`&mdash;The label is positioned at the top of the segment. Applicable for the Funnel and Pyramid series.
13
+ * - `"bottom"`&mdash;The label is positioned at the bottom of the segment. Applicable for the Funnel and Pyramid series.
14
14
  * - `"auto"`&mdash;The from and to labels are positioned at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
15
15
  */
16
16
  export declare type SeriesLabelsPosition = 'auto' | 'above' | 'below' | 'center' | 'insideBase' | 'insideEnd' | 'left' | 'outsideEnd' | 'right' | 'top' | 'bottom';
@@ -4,14 +4,14 @@
4
4
  *
5
5
  * - `"above"`&mdash;The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
6
6
  * - `"below"`&mdash;The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
7
- * - `"center"`&mdash;The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, RadarColumn, and Waterfall series.
7
+ * - `"center"`&mdash;The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, Pyramid, RadarColumn, and Waterfall series.
8
8
  * - `"insideBase"`&mdash;The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
9
9
  * - `"insideEnd"`&mdash;The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
10
10
  * - `"left"`&mdash;The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
11
11
  * - `"outsideEnd"`&mdash;The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
12
12
  * - `"right"`&mdash;The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
13
- * - `"top"`&mdash;The label is positioned at the top of the segment. Applicable for the Funnel series.
14
- * - `"bottom"`&mdash;The label is positioned at the bottom of the segment. Applicable for the Funnel series.
13
+ * - `"top"`&mdash;The label is positioned at the top of the segment. Applicable for the Funnel and Pyramid series.
14
+ * - `"bottom"`&mdash;The label is positioned at the bottom of the segment. Applicable for the Funnel and Pyramid series.
15
15
  * - `"auto"`&mdash;The from and to labels are positioned at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
16
16
  */
17
17
  // tslint:enable:max-line-length
@@ -35,4 +35,4 @@
35
35
  * </script>
36
36
  * ```
37
37
  */
38
- export declare type SeriesType = 'area' | 'bar' | 'boxPlot' | 'bubble' | 'bullet' | 'candlestick' | 'column' | 'donut' | 'funnel' | 'horizontalWaterfall' | 'line' | 'ohlc' | 'pie' | 'polarArea' | 'polarLine' | 'polarScatter' | 'radarArea' | 'radarColumn' | 'radarLine' | 'rangeArea' | 'rangeBar' | 'rangeColumn' | 'scatter' | 'scatterLine' | 'verticalArea' | 'verticalBoxPlot' | 'verticalBullet' | 'verticalLine' | 'verticalRangeArea' | 'waterfall';
38
+ export declare type SeriesType = 'area' | 'bar' | 'boxPlot' | 'bubble' | 'bullet' | 'candlestick' | 'column' | 'donut' | 'funnel' | 'pyramid' | 'horizontalWaterfall' | 'line' | 'linearTrendline' | 'movingAverageTrendline' | 'ohlc' | 'pie' | 'polarArea' | 'polarLine' | 'polarScatter' | 'radarArea' | 'radarColumn' | 'radarLine' | 'rangeArea' | 'rangeBar' | 'rangeColumn' | 'scatter' | 'scatterLine' | 'verticalArea' | 'verticalBoxPlot' | 'verticalBullet' | 'verticalLine' | 'verticalRangeArea' | 'waterfall';
@@ -0,0 +1,13 @@
1
+ /**
2
+ * The series trendline forecast settings.
3
+ */
4
+ export interface TrendlineForecast {
5
+ /**
6
+ * The number of intervals to extend the trendline before the first data point.
7
+ */
8
+ before?: number;
9
+ /**
10
+ * The number of intervals to extend the trendline after the last data point.
11
+ */
12
+ after?: number;
13
+ }
@@ -19,9 +19,9 @@ export interface SeriesDefaultsLabelsFrom {
19
19
  * The function which returns the `from` label content of the Chart series. You can split the text into multiple lines by using line feed characters (`"\n"`).
20
20
  *
21
21
  * The available fields in the function argument are:
22
- * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie series.
22
+ * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
23
23
  * - `dataItem`&mdash;The original data item used to construct the point. If binding to an array, it will be `null`.
24
- * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, and Pie series.
24
+ * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid, and Pie series.
25
25
  * - `series`&mdash;The data series.
26
26
  * - `value`&mdash;The point value. Can be a number or object which contain each bound field.
27
27
  * - `runningTotal`&mdash;The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
@@ -22,9 +22,9 @@ export interface SeriesDefaultsLabels {
22
22
  * The function which returns the Chart series labels content. You can split the text into multiple lines by using line feed characters (`"\n"`).
23
23
  *
24
24
  * The available fields in the function argument are:
25
- * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie series.
25
+ * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
26
26
  * - `dataItem`&mdash;The original data item used to construct the point. If binding to an array, it will be `null`.
27
- * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, and Pie series.
27
+ * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid and Pie series.
28
28
  * - `series`&mdash;The data series.
29
29
  * - `value`&mdash;The point value. Can be a number or object containing each bound field.
30
30
  * - `runningTotal`&mdash;The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
@@ -19,9 +19,9 @@ export interface SeriesDefaultsLabelsTo {
19
19
  * The function which returns the `from` label content of the Chart series. You can split the text into multiple lines by using the line feed characters (`"\n"`).
20
20
  *
21
21
  * The available fields in the function argument are:
22
- * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie series.
22
+ * - `category`&mdash;The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Pyramid, Line, and Pie series.
23
23
  * - `dataItem`&mdash;The original data item used to construct the point. If binding to an array, it will be `null`.
24
- * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, and Pie series.
24
+ * - `percentage`&mdash;The point value represented as a percentage value. Available for the Donut, Funnel, Pyramid and Pie series.
25
25
  * - `series`&mdash;The data series.
26
26
  * - `value`&mdash;The point value. Can be a number or object containing each bound field.
27
27
  * - `runningTotal`&mdash;The sum of point values since the last `"runningTotal"` summary point. Available for the Waterfall series.
@@ -39,6 +39,7 @@ export interface SeriesDefaults {
39
39
  * - `column`
40
40
  * - `donut`
41
41
  * - `funnel`
42
+ * - `pyramid`
42
43
  * - `line`
43
44
  * - `ohlc`
44
45
  * - `pie`
@@ -8,13 +8,13 @@ import { SeriesLabelsTo } from './labels.to.interface';
8
8
  */
9
9
  export interface SeriesLabels {
10
10
  /**
11
- * The alignment of the label when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"donut"`, `"funnel"`, or `"pie"`.
11
+ * The alignment of the label when [`series.type`]({% slug api_charts_chartseriesitemprops %}#toc-type) is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
12
12
  *
13
13
  * The supported values for `"donut"` and `"pie"` are:
14
14
  * - `"circle"`&mdash;The labels are positioned in circle around the Chart.
15
15
  * - `"column"`&mdash;The labels are positioned in columns to the left and right of the Chart.
16
16
  *
17
- * The supported values for `"funnel"` are:
17
+ * The supported values for `"funnel"` and `"pyramid"` are:
18
18
  * - `"center"`&mdash;The labels are positioned in the center over the funnel segment.
19
19
  * - `"right"`&mdash;The labels are positioned on the right side of the Chart and, if there is enough space, do not overlap the funnel segments.
20
20
  * - `"left"`&mdash;The labels are positioned on the left side of the Chart and, if there is enough space, do not overlap the funnel segments.
@@ -23,7 +23,7 @@ export interface SeriesTooltip {
23
23
  * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
24
24
  *
25
25
  * The available format placeholders are:
26
- * - Area, Bar, Column, Line, Pie, radarArea, radarColumn and radarLine: {0} - value.
26
+ * - Area, Bar, Column, Line, Funnel, Pyramid, Pie, radarArea, radarColumn and radarLine: {0} - value.
27
27
  * - Bubble: {0} - x value, {1} - y value, {2} - size value, {3} - category name.
28
28
  * - Scatter, scatterLine: {0} - x value, {1} - y value.
29
29
  * - PolarArea, polarLine and polarScatterL: {0} - x value (degrees), {1} - y value.
@@ -0,0 +1,18 @@
1
+ import { TrendlineForecast } from '../../common/property-types';
2
+ /**
3
+ * The configuration options of the series trendlines.
4
+ */
5
+ export interface SeriesTrendline {
6
+ /**
7
+ * The trendline forecast settings. By default, the trendline does not display a forecast.
8
+ *
9
+ * The forecast setting is supported for Linear Trendlines on date and scatter series.
10
+ */
11
+ forecast?: TrendlineForecast;
12
+ /**
13
+ * The number of intervals to take when calculating averages. The value should be an integer greater than 2.
14
+ *
15
+ * The period setting is supported only for Moving Average trendlines.
16
+ */
17
+ period?: number;
18
+ }