Series

Represents the configuration options of the series.

Name	Type	Default	Description
aggregate?	any		Specifies the aggregate function for the date series. Apply 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. This option is supported for Categorical Chart axis only. Aggregate functions support the following values: "avg"—Calculates the average of all values for the date period. "count"—Counts the number of values for the date period. "max"—Finds the highest value for the date period. "min"—Finds the lowest value for the date period. "sum"—Sums all values for the date period. Uses 0 when no data points are defined. "sumOrNull"—Sums all values for the date period. Uses null when no data points are defined. "first"—Uses the first value. function (values, series, dataItems, category)—A user-defined aggregate function that returns a single value or a data item. object (compound aggregate)—Applies to the Candlestick, Box Plot, and OHLC series. Sets the aggregate for each data item field.
autoFit?	boolean		Determines whether the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series. (See example)
axis?	string		Specifies the name of the value axis. This option is supported for Scatter plots. For more information on Scatter plots, refer to xAxis and yAxis.
border?	Border		Specifies the border of the Chart series. This option is supported when series.type is set to "bar", "column", "donut", "pie", "bubble", "boxPlot", "candlestick", or "ohlc".
categoryAxis?	string		Specifies the name of the category axis that the series uses. If you do not specify a categoryAxis, the Chart uses the first axis.
categoryField?	string		Specifies the data item field which contains the category name or date. When the category is a date, renders the points in chronological order.
closeField?	string		Specifies the data field that contains the close value. This option is supported when series.type is set to "candlestick" or "ohlc".
color?	any		Specifies the series base color. Accepts CSS color string (including HEX and RGB) and function (point). The function, which is user-defined and evaluated for each point, assumes the default series color when it returns undefined.
colorField?	string		Specifies the data item field which contains the series color. This option is supported when series.type is set to "bar", "column", "rangeBar", "rangeColumn", "bubble", "donut", "pie", "candlestick", "ohlc", or "waterfall".
connectors?	LabelConnectors		Specifies the label connectors options. This option is supported when series.type is set to "donut" or "pie" and series.labels.visible is set to true.
currentField?	string		Specifies the data item field which contains the current value. This option is supported when series.type is set to "bullet" or "verticalBullet".
dashType?	DashType		Specifies the dash type of line Chart. Use this option only when the series.type option is set to "line".
data?	any[]		Specifies the array of data items which represent the series data. You can set it to: Array of objects. Each point is bound to the field specified through the series.field option. Array of numbers. Supported when the series.type option is set to "area", "bar", "column", "donut", "pie", "line", or "waterfall". Array of arrays of numbers. Supported when the series.type option is set to "bubble", "scatter", "scatterLine", "ohlc", "polar", "rangeBar", or "rangeArea". Bubble series need arrays of three values—X value, Y value, and Size value—for example, [1, 1, 10]. Scatter and ScatterLine series need arrays of two values—X value and Y value. OHLC and Candlestick series need arrays of four values—open, high, low, and close. RangeBar and RangeArea series need arrays of two values—the from and to value.
downColor?	string		Specifies the series color when the open value is greater than the close value. This option is supported when series.type is set to "candlestick".
downColorField?	string		Specifies the data field which contains the color that applies when the open value is greater than the close value. This option is supported when series.type is set to "candlestick".
drilldownField?	string		Specifies the data field which contains the value to use to drill down into detailed data for the point.
dynamicHeight?	boolean		Determines whether the segments have the same height. This option is supported when series.type is set to "funnel" or "pyramid". Setting it to false makes all segments have the same height. Setting it to true bases the height of each segment on its value.
dynamicSlope?	boolean		This option is supported when series.type is set to "funnel". Setting it to true makes the ratio of the bases of each segment calculate based on the ratio of currentDataItem.value/nextDataItem.value. Charts always create the last element as a rectangle since there is no following element.
errorBars?	SeriesErrorBars		Specifies the error bars of the Chart series. This option is supported when series.type is set to "bar", "column", "line", "area", "scatter", "scatterLine", or "bubble".
errorHighField?	string		Specifies the data item field which contains the series.errorBars high value. This option is supported when series.type is set to "bar", "column", "line", or "area".
errorLowField?	string		Specifies the data item field which contains the series.errorBars low value. This option is supported when series.type is set to "bar", "column", "line", or "area".
explodeField?	string		Specifies the data item field which contains a Boolean value indicating whether the sector is exploded. This option is supported when series.type is set to "donut" or "pie".
extremes?	SeriesExtremes		Specifies the configuration of the Chart series extremes. Applies to extreme outliers. This option is supported when series.type is set to "boxPlot".
field?	string		Specifies the data item field which contains the series value.
for?	string		Specifies the name of the parent series of the trendline. This option is supported when series.type is set to "linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline", "polynomialTrendline" or "movingAverageTrendline".
fromField?	string		Specifies the data item field which contains the series from value.
gap?	number		Specifies the distance between the categories expressed as a percentage of the bar width. See the related spacing setting. This option is supported when series.type is set to "bar", "column", "candlestick", "ohlc", "radarColumn", or "waterfall".
highField?	string		Specifies the data field which contains the high value. This option is supported when series.type is set to "candlestick" or "ohlc".
highlight?	SeriesHighlight		Specifies the configuration of the Chart series highlight.
holeSize?	number		Specifies the diameter of the donut hole in pixels. This option is supported when series.type is set to "donut".
labels?	SeriesLabels		Specifies the configuration of the Chart series label. Displays the series labels when the series.labels.visible option is set to true.
legendItem?	LegendItem		Specifies the configuration of the Chart legend item. Inherits the Legend item type and markers from the series by default.
line?	SeriesLine		Specifies the Chart line configuration options. This option is supported when series.type is set to "area", "candlestick", "ohlc", or "waterfall".
lowerField?	string		Specifies the data item field which contains the series lower value. This option is supported when series.type is set to "boxPlot".
lowField?	string		Specifies the data field containing the low value. This option is supported when series.type is set to "candlestick" or "ohlc".
margin?	number | Margin		Specifies the margin around each donut series (ring). A numeric value sets all margins.
markers?	SeriesMarkers		Specifies the configuration of the Chart series marker. Displays the series labels when the series.markers.visible option is set to true. This option is supported when series.type is set to "area", "rangeArea", "line", "scatter", "scatterLine", "radarLine", "radarArea", "polarLine", "polarScatter", or "polarArea".
maxSize?	number		Specifies the maximum size of the Chart bubble series marker.
mean?	SeriesMedian		Specifies the configuration of the mean value indicator (line) for Box Plot series. This option is not supported by other series types.
meanField?	string		Specifies the data item field which contains the series mean value. This option is supported when series.type is set to "boxPlot".
median?	SeriesMedian		Specifies the configuration of the median value indicator (line) for Box Plot series. This option is not supported by other series types.
medianField?	string		Specifies the data item field which contains the series median value. This option is supported when series.type is set to "boxPlot".
minSize?	number		Specifies the minimum size of the Chart bubble series marker.
missingValues?	"gap" | "interpolate" | "zero"		Specifies the behavior for handling missing values. This option is available when series.type is set to "area", "rangeArea", "line", "scatterLine", "radarLine", "radarArea", "polarLine", or "polarArea". Supports the following values: "gap"—The plot stops before the missing point and continues after it. "interpolate"—Interpolates the value from neighboring points. Represents the default value for all series except for the "area" and stacked series. Area and stacked series default to "zero". "zero"—Assumes the value to be zero.
name?	string		Specifies the name of the Chart series which is visible in the legend.
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. This option is supported when series.type is set to "funnel" and dynamicSlope is set to false.
negativeColor?	string		Specifies the color to use for the Bar, Column, or Waterfall series with negative values. Accepts valid CSS color string, including HEX and RGB.
negativeValues?	NegativeBubbleValues		Specifies the options for displaying the Chart negative bubble values.
notes?	SeriesNotes		Specifies the configuration of the series notes.
noteTextField?	string		Specifies the data item field which contains the series note text.
opacity?	number		Specifies the opacity of the series. Series are opaque by default.
openField?	string		Specifies the data field which contains the open value. This option is available when series.type is set to "candlestick" or "ohlc".
outliers?	SeriesOutliers		Specifies the configuration of the Chart series outliers. Applies to mild outliers. This option is supported when series.type is set to "boxPlot".
outliersField?	string		Specifies the data item field which contains the series outliers value. This option is supported when series.type is set to "boxPlot".
overlay?	Overlay		Specifies the overlay options of the Chart series.
padding?	number		Specifies the padding around the Chart (equal on all sides). This option is available when series.type is set to "donut" or "pie".
pattern?	SeriesPattern | (point: any) => SeriesPattern		Specifies the configuration options of the series pattern.
patternField?	string		Specifies the data item field which contains the series pattern. This 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. This option is supported when series.type is set to "boxPlot".
q3Field?	string		Specifies the data item field which contains the series q3 value. This option is supported when series.type is set to "boxPlot".
segmentSpacing?	number		Specifies the space in pixels between the different segments of the Funnel or Pyramid Chart. This option is supported when series.type is set to "funnel" or "pyramid".
size?	number		Specifies the radius of the Chart Donut series in pixels. When not set, Charts split the available space evenly between the series.
sizeField?	string		Specifies the data field which contains the bubble size value.
spacing?	number		Specifies the distance between series points within a category expressed as a percentage of the bar width. See the related gap setting. This option is supported when series.type is set to "bar", "column", "candlestick", "ohlc", or "radarColumn".
stack?	string | boolean | SeriesStack		Determines whether the series stacks. Interprets a string value as series.stack.group. This option is supported when series.type is set to "bar", "column", "line", "area", "verticalLine", "verticalArea", "radarLine", "radarArea", and "radarColumn". If not overridden, inherits the stack settings of the first series as a default value for the rest of the series.
startAngle?	number		Specifies the start angle (in degrees) of the first Donut or Pie segment. Increases clockwise with zero to the left. You can use negative values.
style?	LineStyle		Specifies the style options for the series. This option is supported when series.type is set to "line", "scatterLine", "radarLine", or "polarLine".
summaryField?	string		Specifies the data item field which contains the summary type for the Waterfall series. Discards the value (if any) of a data item marked as a summary point. Summary columns are optional and take one of two types: "runningTotal"—Displays the sum of all items since the last "runningTotal" point. "total"—Displays the sum of all previous items.
target?	BulletTarget		Specifies the configuration options of the target. This option is supported when series.type is set to "bullet" or "verticalBullet".
toField?	string		Specifies the data item field which contains the series to value.
tooltip?	SeriesTooltip		Specifies the configuration options of the Chart series tooltip.
trendline?	SeriesTrendline		Specifies the trendline configuration options. This option is supported when series.type is set to "linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline", "polynomialTrendline" or "movingAverageTrendline".
type?	SeriesType		Specifies the type of the series.
upperField?	string		Specifies the data item field which contains the series upper value. This option is supported when series.type is set to "boxPlot".
visible?	boolean		Specifies the visible property of a Chart series.
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.
visibleInLegendField?	string		Specifies the data item field which indicates whether to show the point category name in the legend. This option is supported when series.type is set to "funnel", "pyramid", "donut", or "pie".
visual?	(e: SeriesVisualArgs) => Element		Specifies a function that creates a custom visual for the points. Applicable for the Bar, Column, Pie, Donut, Funnel, Pyramid, Range Bar, Range Column, Line, ScatterLine, and Waterfall series.
whiskers?	SeriesWhiskers		Specifies the configuration of the whiskers for the Chart series. This option is supported when series.type is set to "boxPlot".
width?	number		Specifies the line width. This option is supported when series.type is set to "line", "scatterLine", "radarLine", or "polarLine".
xAxis?	string		Specifies the name of the X axis. This option is supported when series.type is set to "bubble", "scatter", "scatterLine", or "polar" series. For the Polar series, Charts express the xAxis range in degrees.
xErrorHighField?	string		Specifies the data item field which contains the series.errorBars xAxis high value. This option is supported when series.type is set to "scatter", "scatterLine", or "bubble".
xErrorLowField?	string		Specifies the data item field which contains the series.errorBars xAxis low value. This option is supported when series.type is set to "scatter", "scatterLine", or "bubble".
xField?	string		Specifies the data item field containing the x value. This option is supported when series.type is set to "bubble", "scatter", "scatterLine", or "polar" series.
yAxis?	string		Specifies the name of the Y axis to use. Available for the Bubble, Scatter, Scatter Line, and Polar series.
yErrorHighField?	string		Specifies the data item field which contains the series.errorBars yAxis high value. This option is supported when series.type is set to "scatter", "scatterLine", or "bubble".
yErrorLowField?	string		Specifies the data item field which contains the series.errorBars yAxis low value. This option is supported when series.type is set to "scatter", "scatterLine", or "bubble".
yField?	string		Specifies the data item field containing the y value. This option is supported when series.type is set to "bubble", "scatter", or "scatterLine".
zIndex?	number		Specifies an optional Z-index that changes the default stacking order of series. Series with the highest Z-index appear on top. Series with no Z-index use the default stacking order based on the series type. For example, Line series appear on top with the Bar and Area following after.