@progress/kendo-angular-charts
Version:
Kendo UI Charts for Angular - A comprehensive package for creating beautiful and interactive data visualization. Every chart type, stock charts, and sparklines are included.
71 lines (70 loc) • 6.46 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
/**
* Specifies the series type.
*
* The supported values are:
* - `"area"`—Shows data as continuous lines that display trends over time, evenly distributed along the category field.
* - `"bar"`—Shows data as sets of horizontal bars that display the relationship between individual items and the whole category.
* - `"boxPlot"`—Shows data as a box-and-whisker diagram, which displays the distribution of values in a series.
* - `"bubble"`—Shows data as bubbles, where each bubble represents a value from the series data.
* - `"bullet"`—Shows data as vertical bars that display the performance measure, and markers that display the comparative measure.
* - `"candlestick"`—Shows data as candlesticks, which display the open, close, high, and low values of a series.
* - `"column"`—Shows data as sets of vertical bars that display the relationship between individual items and the whole category.
* - `"donut"`—Shows data as a series of rings that are sliced depending on the value.
* - `"exponentialTrendline"`—Shows an exponential [trendline]({% slug trendlines_chart_charts %}#toc-exponential-trendline) for the specified parent series.
* - `"funnel"`—Shows data as a funnel, which is useful for sales data visualization.
* - `"heatmap"`—Shows data as a heatmap, which is useful for comparing values in a matrix.
* - `"horizontalWaterfall"`—Shows data as a horizontal waterfall chart, which is useful for comparing positive and negative values over a period.
* - `"line"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
* - `"linearTrendline"`—Shows a linear [trendline]({% slug trendlines_chart_charts %}#toc-linear-trendline) for the specified parent series.
* - `"logarithmicTrendline"`—Shows a logarithmic [trendline]({% slug trendlines_chart_charts %}#toc-logarithmic-trendline) for the specified parent series.
* - `"movingAverageTrendline"`—Shows a moving average [trendline]({% slug trendlines_chart_charts %}#toc-moving-average-trendline) for the specified parent series.
* - `"ohlc"`—Shows data as OHLC (open-high-low-close) bars, which display the open, high, low, and close values of a series.
* - `"pie"`—Shows data as a series of pie slices, which display the contribution of each value to a total.
* - `"polarArea"`—Shows data as a series of polar area segments, which display the contribution of each value to a total.
* - `"polarLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
* - `"polarScatter"`—Shows data as points distributed in a polar coordinate system.
* - `"polynomialTrendline"`—Shows a polynomial [trendline]({% slug trendlines_chart_charts %}#toc-polynomial-trendline) for the specified parent series.
* - `"powerTrendline"`—Shows a power [trendline]({% slug trendlines_chart_charts %}#toc-power-trendline) for the specified parent series.
* - `"pyramid"`—Shows data as a pyramid divided in segments proportional to each value.
* - `"radarArea"`—Shows data as a series of radar area segments, which display the contribution of each value to a total.
* - `"radarColumn"`—Shows data as sets of vertical bars that display the relationship between individual items and the whole category.
* - `"radarLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
* - `"rangeArea"`—Shows data as a series of range area segments, which display the contribution of each value to a total.
* - `"rangeBar"`—Shows data as sets of horizontal bars that display the relationship between individual items and the whole category.
* - `"rangeColumn"`—Shows data as sets of vertical bars that display the relationship between individual items and the whole category.
* - `"scatter"`—Shows data as points that display the relationship between two variables.
* - `"scatterLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
* - `"verticalArea"`—Shows data as continuous lines that display trends over time, evenly distributed along the category field.
* - `"verticalBoxPlot"`—Shows data as a box-and-whisker diagram, which displays the distribution of values in a series.
* - `"verticalBullet"`—Shows data as vertical bars that display the performance measure, and markers that display the comparative measure.
* - `"verticalLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
* - `"verticalRangeArea"`—Shows data as a series of range area segments, which display the contribution of each value to a total.
* - `"waterfall"`—Shows data as a waterfall chart, which is useful for comparing positive and negative values over a period.
*
* @example
* ```ts
* import { Component } from '@angular/core';
* import { SeriesType } from '@progress/kendo-angular-charts';
*
* _@Component({
* selector: 'my-app',
* template: `
* <kendo-chart>
* <kendo-chart-series>
* <kendo-chart-series-item [type]="seriesType" [data]="[1, 2, 3]">
* </kendo-chart-series-item>
* </kendo-chart-series>
* </kendo-chart>
* `
* })
* class AppComponent {
* public seriesType: SeriesType = "verticalLine";
* }
*
* ```
*/
export type SeriesType = 'area' | 'bar' | 'boxPlot' | 'bubble' | 'bullet' | 'candlestick' | 'column' | 'donut' | 'exponentialTrendline' | 'funnel' | 'pyramid' | 'heatmap' | 'horizontalWaterfall' | 'line' | 'linearTrendline' | 'logarithmicTrendline' | 'movingAverageTrendline' | 'ohlc' | 'pie' | 'polarArea' | 'polarLine' | 'polarScatter' | 'polynomialTrendline' | 'powerTrendline' | 'radarArea' | 'radarColumn' | 'radarLine' | 'rangeArea' | 'rangeBar' | 'rangeColumn' | 'scatter' | 'scatterLine' | 'verticalArea' | 'verticalBoxPlot' | 'verticalBullet' | 'verticalLine' | 'verticalRangeArea' | 'waterfall';