New to Kendo UI for Angular? Start a free 30-day trial

SeriesItemComponent

Component

Represents the Kendo UI for Angular Chart Series Item component.

Definition

Package:@progress/kendo-angular-charts

Selector:kendo-chart-series-item

Syntax:

html

<kendo-chart ...>
  <kendo-chart-series>
    <kendo-chart-series-item type="line" ...> </kendo-chart-series-item>
  </kendo-chart-series>
</kendo-chart>

Specifies the aggregate function for the date series. Use this function 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. Use the aggregate option with categorical chart axis only.

The supported values are:

"avg"—The average of all values for the date period.
"count"—The number of values for the date period.
"max"—The highest value for the date period.
"min"—The lowest value for the date period.
"sum"—The sum of all values for the date period. Defaults to 0 if no data points are defined.
"sumOrNull"—The sum of all values for the date period. Defaults to null if no data points are defined.
"first"—The first value.
function (values, series, dataItems, category)—A user-defined aggregate function. Returns a single value or a data item.
object (compound aggregate)—Applicable to the Candlestick, Box Plot, and OHLC series. Specifies the aggregate for each data item field.

Default:

'max'

autoFit

boolean

Determines whether the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series. (See example).

Default:

false

axis

string

Specifies the name of the value axis. Use this option for Scatter plots. For more information on Scatter plots, refer to xAxis and yAxis.

Default:

'primary'

border

Border

Specifies the border configuration of the series.

categoryAxis

string

Specifies the name of the category axis.

categoryField

string

Specifies the data item field which contains the category name or date. If the category is a date, the points are rendered in chronological order.

Default:

'category'

closeField

string

Specifies the data field that contains the close value. Use the closeField option when series.type is set to "candlestick" or "ohlc".

Default:

'close'

color

any

Specifies the color of the series.

colorField

string

Specifies the data item field which contains the series color. Use the colorField option when series.type is set to "bar", "column", "rangeBar", "rangeColumn", "bubble", "donut", "pie", "candlestick", "ohlc", or "waterfall".

Default:

'color'

connectors

LabelConnectors

Specifies the connectors configuration for the labels.

currentField

string

Specifies the data item field which contains the current value. Use the currentField option when series.type is set to "bullet" or "verticalBullet".

Default:

'current'

dashType

DashType

Specifies the dash type of line Chart. Use the dashType option only if the series.type option is set to "line".

Default:

'solid'

data

any[]

Specifies the data source for the series.

downColor

string

Specifies the color that is applied when the close value is less than the open value.

downColorField

string

Specifies the data field which contains the color that is applied when the open value is greater than the close value. Use the downColorField option when series.type is set to "candlestick".

Default:

'downColor'

drilldownField

string

Specifies the field for the drilldown functionality.

dynamicHeight

boolean

Use the dynamicHeight option when series.type is set to "funnel" or "pyramid". Determines whether all segments become with the same height. When set to false, all segments have the same height. Otherwise, the height of each segment is based on its value.

Default:

true

dynamicSlope

boolean

Use this option when series.type is set to "funnel". Determines whether 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.

Default:

false

errorBars

SeriesErrorBars

Specifies the configuration options of the series error bars.

errorHighField

string

Specifies the data item field which contains the series.errorBars high value. Use the errorHighField option when series.type is set to "bar", "column", "line", or "area".

Default:

'errorHigh'

errorLowField

string

Specifies the data item field which contains the series.errorBars low value. Use the errorLowField option when series.type is set to "bar", "column", "line", or "area".

Default:

'errorLow'

explodeField

string

Specifies the data item field which contains a Boolean value indicating whether the sector is exploded. Use the explodeField option when series.type is set to "donut" or "pie".

Default:

'explode'

extremes

SeriesExtremes

Specifies the configuration options of the series extremes.

field

string

Specifies the data item field which contains the series value.

Default:

'value'

for

string

Specifies the name of the series for which the current series serves as a trendline.

fromField

string

Specifies the data item field which contains the series from value.

Default:

'min'

gap

number

Specifies the distance between the categories expressed as a percentage of the bar width. See the related spacing setting. Use the gap option when series.type is set to "bar", "column", "candlestick", "ohlc", "radarColumn", or "waterfall".

Default:

1.5

highField

string

Specifies the data field which contains the high value. Use the highField option when series.type is set to "candlestick" or "ohlc".

Default:

'high'

highlight

SeriesHighlight

Specifies the configuration options of the series highlight.

holeSize

number

Specifies the size of the hole in donut charts.

labels

SeriesLabels

Specifies the configuration options of the series labels.

legendItem

LegendItem

Specifies the configuration options of the series legend item.

line

SeriesLine

Specifies the line configuration of the series.

lineStyle

LineStyle

Specifies the line style configuration of the series. Use the lineStyle option when series.type is set to "line", "scatterLine", "radarLine", or "polarLine".

Default:

'normal'

lowerField

string

Specifies the data item field which contains the series lower value. Use the lowerField option when series.type is set to "boxPlot".

Default:

'lower'

lowField

string

Specifies the data field containing the low value. Use the lowField option when series.type is set to "candlestick" or "ohlc".

Default:

'low'

margin

number | Margin

Specifies the margin around each donut series (ring). A numeric value sets all margins.

Default:

markers

SeriesMarkers

Specifies the configuration options of the series markers.

maxSize

number

Specifies the maximum size of the Chart bubble series marker.

Default:

100

mean

SeriesMean

Specifies the mean configuration of the series.

meanField

string

Specifies the data item field which contains the series mean value. Use the meanField option when series.type is set to "boxPlot".

Default:

'mean'

median

SeriesMedian

Specifies the median configuration of the series.

medianField

string

Specifies the data item field which contains the series median value. Use the medianField option when series.type is set to "boxPlot".

Default:

'median'

minSize

number

Specifies the minimum size of the Chart bubble series marker.

Default:

missingValues

"gap" | "interpolate" | "zero"

Specifies how to handle missing values in the series.

name

string

Specifies the name of the series.

neckRatio

number

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. Use the neckRatio option when series.type is set to "funnel" and dynamicSlope is set to false.

Default:

0.3

negativeColor

string

Specifies the color for negative values.

negativeValues

NegativeBubbleValues

Specifies the configuration for negative bubble values.

notes

SeriesNotes

Specifies the configuration options of the series notes.

noteTextField

string

Specifies the data item field which contains the series note text.

Default:

'noteText'

opacity

number

Specifies the opacity of the series. By default, the series are opaque.

Default:

openField

string

Specifies the data field that contains the open value.

outliers

SeriesOutliers

Specifies the configuration options of the series outliers.

outliersField

string

Specifies the data item field which contains the series outliers value. Use the outliersField option when series.type is set to "boxPlot".

Default:

'outliers'

overlay

Overlay

Specifies the overlay configuration of the series.

padding

number

Specifies the padding of the series.

pattern?

SeriesPattern | (point: any) => SeriesPattern

Specifies the configuration options of the series pattern.

patternField?

string

Specifies the data item field that contains the series pattern. The patternField option is supported when series.type is set to "pie", "donut", "funnel", "heatmap", or "pyramid".

q1Field

string

Specifies the data item field which contains the series q1 value. Use the q1Field option when series.type is set to "boxPlot".

Default:

'q1'

q3Field

string

Specifies the data item field which contains the series q3 value. Use the q3Field option when series.type is set to "boxPlot".

Default:

'q3'

segmentSpacing

number

Specifies the space in pixels between the different segments of the Funnel or Pyramid Chart. Use the segmentSpacing option when series.type is set to "funnel" or "pyramid".

Default:

size

number

Specifies the size of the series.

sizeField

string

Specifies the data field which contains the bubble size value.

Default:

'size'

spacing

number

Specifies the distance between series points within a category. Expressed as a percentage of the bar width. See the related gap setting. Use the spacing option when series.type is set to "bar", "column", "candlestick", "ohlc", or "radarColumn".

Default:

0.4

stack

string | boolean | SeriesStack

Determines whether the series have to be stacked. A string value is interpreted as series.stack.group.

Use the stack option when series.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.

Default:

false

startAngle

number

Specifies the start angle (in degrees) of the first Donut or Pie segment. Use positive values to increase angles clockwise with zero to the left. Negative values are acceptable.

Default:

summaryField

string

Specifies the data item field which contains the summary type for the Waterfall series. The value (if any) of a data item marked as a summary point will be discarded.

Summary columns are optional and can be one of two types:

"runningTotal"—Displays the sum of all items since the last "runningTotal" point. "total"—Displays the sum of all previous items.

Default:

'summary'

target

BulletTarget

Specifies the bullet target configuration.

toField

string

Specifies the data item field which contains the series to value.

Default:

'max'

SeriesTooltip

Specifies the configuration options of the series tooltip.

trendline

SeriesTrendline

Specifies the configuration options of the trendline series.

The trendline option is supported when series.type is set to "linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline", "polynomialTrendline" or "movingAverageTrendline".

type

SeriesType

Specifies the type of the series.

Default:

'column'

upperField

string

Specifies the data item field which contains the series upper value. Use the upperField option when series.type is set to "boxPlot".

Default:

'upper'

visible

boolean

Determines whether the Chart series is visible.

Default:

true

visibleInLegend

boolean

Determines 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.

Default:

true

visibleInLegendField

string

Specifies the data item field which contains the visibility state in the legend.

visual

Specifies a function that returns a custom visual for the series.

Parameters:eSeriesVisualArgsReturns:

Element

whiskers

SeriesWhiskers

Specifies the whiskers configuration of the series.

width

number

Specifies the width of the series.

xAxis

string

Specifies the name of the X axis. Use the xAxis option when series.type is set to "bubble", "scatter", "scatterLine", or "polar" series. For the Polar series, the xAxis range is expressed in degrees.

Default:

'primary'

xErrorHighField

string

Specifies the data item field which contains the series.errorBars xAxis high value. Use the xErrorHighField option when series.type is set to "scatter", "scatterLine", or "bubble".

Default:

'xErrorHigh'

xErrorLowField

string

Specifies the data item field which contains the series.errorBars xAxis low value. Use the xErrorLowField option when series.type is set to "scatter", "scatterLine", or "bubble".

Default:

'xErrorLow'

xField

string

Specifies the data item field containing the x value. Use the xField option when series.type is set to "bubble", "scatter", "scatterLine", or "polar" series.

Default:

'x'

yAxis

string

Specifies the name of the Y axis to use. Available for the Bubble, Scatter, Scatter Line, and Polar series.

Default:

'primary'

yErrorHighField

string

Specifies the data item field that contains the series.errorBars yAxis high value. The yErrorHighField option is supported when series.type is set to "scatter", "scatterLine", or "bubble".

Default:

'yErrorHigh'

yErrorLowField

string

Specifies the data item field that contains the series.errorBars yAxis low value. The yErrorLowField option is supported when series.type is set to "scatter", "scatterLine", or "bubble".

Default:

'yErrorLow'

yField

string

Specifies the data item field that contains the y value. The yField option is supported when series.type is set to "bubble", "scatter", or "scatterLine".

Default:

'y'

Parameters:changesany

An object containing the updated input fields.

togglePointVisibility

Toggles the visibility of a point with the given index. Applicable for the Pie, Donut, Funnel and Pyramid series.

Parameters:pointIndexnumber

The zero-based index of the point to toggle.

toggleVisibility

Toggles the series visibility and updates the parent Chart without animated transitions.