aggregate?

The aggregate function for the date series (see example). The function is used 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.

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 to0 if no data points are defined.
• "sumOrNull"—The sum of all values for the date period. Defaults tonull 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.

autoFit?

If set to true, the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series.

axis?

The name of the value axis. The axis option is supported for Scatter plots. For more information on Scatter plots, refer toxAxis andyAxis.

border?

The border of the Chart series. The border option is supported whenseries.type is set to"bar","column","donut","pie","bubble","boxPlot","candlestick", or"ohlc".

categoryAxis?

The name of the category axis that will be used for the series. If nocategoryAxis is specified, the first axis is used.

categoryField?

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

closeField?

The data field that contains theclose value. ThecloseField option is supported whenseries.type is set to"candlestick" or"ohlc".

color?

The series base color.

The supported values are:

• CSS color string, including hex and rgb.
• function (point)—A user-defined function that is evaluated for each point. Returningundefined assumes the default series color.

colorField?

The data item field which contains the series color. ThecolorField option is supported whenseries.type is set to"bar","column","rangeBar","rangeColumn","bubble","donut","pie","candlestick","ohlc", or"waterfall".

connectors?

The label connectors options. The connectors option is supported whenseries.type is set to"donut" or"pie" andseries.labels.visible is set totrue.

currentField?

The data item field which contains the current value. ThecurrentField option is supported whenseries.type is set to"bullet" or"verticalBullet".

dashType?

The dash type of line Chart. ThedashType option is considered only if theseries.type option is set to"line".

The following dash types are supported:

• "dash"—A line consisting of dashes.
• "dashDot"—A line consisting of a repeating pattern of dash-dot.
• "dot"—A line consisting of dots.
• "longDash"—A line consisting of a repeating pattern of long-dash.
• "longDashDot"—A line consisting of a repeating pattern of long-dash-dot.
• "longDashDotDot"—A line consisting of a repeating pattern of long-dash-dot-dot.
• "solid"—A solid line.

dataItems?

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 theseries.field option.
• Array of numbers. Supported when theseries.type option is set to"area","bar","column","donut","pie","line", or"waterfall".
• Array of arrays of numbers. Supported when theseries.type option is set to"bubble","scatter","scatterLine","ohlc","polar","rangeBar", or"rangeArea".

The Bubble series need arrays of three values—X value, Y value, and Size value—for example,[1, 1, 10]. The Scatter and ScatterLine series need arrays of two values—X value and Y value. The OHLC and Candlestick series need arrays of four values—open, high, low, and close. The RangeBar and RangeArea series need arrays of two values—the from and to value.

downColor?

The series color when the open value is greater than the close value. ThedownColor option is supported whenseries.type is set to"candlestick".

downColorField?

The data field which contains the color that is applied when theopen value is greater than theclose value. ThedownColorField option is supported whenseries.type is set to"candlestick".

dynamicHeight?

ThedynamicHeight option is supported whenseries.type is set to"funnel" or"pyramid". When set tofalse, all segments become with the same height. Otherwise, the height of each segment is based on its value.

dynamicSlope?

ThedynamicSlope option is supported whenseries.type is set to"funnel". When set totrue, the ratio of the bases of each segment is calculated based on the ratio ofcurrentDataItem.value/nextDataItem.value. The last element is always created like a rectangle since there is no following element.

errorBars?

The error bars of the Chart series. TheerrorBars option is supported whenseries.type is set to"bar","column","line","area","scatter","scatterLine", or"bubble".

errorHighField?

The data item field which contains theseries.errorBars high value (see example). TheerrorHighField option is supported whenseries.type is set to"bar","column","line", or"area".

errorLowField?

The data item field which contains theseries.errorBars low value (see example). TheerrorLowField option is supported whenseries.type is set to"bar","column","line", or"area".

explodeField?

The data item field which contains a Boolean value indicating whether the sector is exploded. TheexplodeField option is supported whenseries.type is set to"donut" or"pie".

extremes?

The configuration of the Chart series extremes. Applies to extreme outliers. For more information, refer toseries.outliers.

field?

The data item field which contains the series value.

for?

The name of the parent series of the trendline.

Thefor option is supported whenseries.type is set to"linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline", "polynomialTrendline" or "movingAverageTrendline".

fromField?

The data item field which contains the series from value.

gap?

The distance between the categories expressed as a percentage of the bar width. See the related spacing setting. Thegap option is supported whenseries.type is set to"bar","column","candlestick","ohlc","radarColumn", or"waterfall".

highField?

The data field which contains the high value. ThehighField option is supported whenseries.type is set to"candlestick" or"ohlc".

highlight?

The configuration of the Chart series highlight.

holeSize?

The diameter of the donut hole in pixels. TheholeSize option is supported whenseries.type is set to"donut".

labels?

The configuration of the Chart series label. The Chart displays the series labels when theseries.labels.visible option is set totrue.

legendItem?

The configuration of the Chart legend item.By default, the Legend item type and markers are inherited from the series.

line?

The Chart line configuration options. The line option is supported whenseries.type is set to"area","candlestick","ohlc", or"waterfall".

lineStyle?

ThelineStyle option is supported whenseries.type is set to"line","scatterLine","radarLine", or"polarLine".

The supported values are:

• "normal" (default)—The values are connected with a straight line.
• "step"—The values are connected with a right-angled line.

Only available whenseries.type is set to"line".

• "smooth"—The values are connected with a smooth line.

Not supported for stacked area series with missing values.

lowerField?

The data item field which contains the series lower value.

lowField?

The data field containing the low value. ThelowField option is supported whenseries.type is set to"candlestick" or"ohlc".

margin?

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

markers?

The configuration of the Chart series marker. The Chart displays the series labels when theseries.markers.visible option is set totrue. The markers option is supported whenseries.type is set to"area","rangeArea","line","scatter","scatterLine","radarLine","radarArea","polarLine","polarScatter", or"polarArea".

maxSize?

The maximum size of the Chart bubble series marker.

meanField?

The data item field which contains the series mean value.

medianField?

The data item field which contains the series median value.

minSize?

The minimum size of the Chart bubble series marker.

missingValues?

The behavior for handling missing values. ThemissingValues option is available whenseries.type is set to"area","rangeArea","line","scatterLine","radarLine","radarArea","polarLine", or"polarArea".

The supported values are:

• "gap"—The plot stops before the missing point and continues after it.
• "interpolate"—The value is interpolated 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"—The value is assumed to be zero.

name?

The name of the Chart series which is visible in the legend.

neckRatio?

Specifies the top-base/bottom-base ratio of the whole Funnel Chart. If theneckRatio is set to3, it means the top base is three times smaller than the bottom base. TheneckRatio option is supported whenseries.type is set to"funnel" anddynamicSlope is set tofalse.

negativeColor?

The color to use for the Bar, Column, or Waterfall series with negative values. Accepts a valid CSS color string, including hex and rgb.

negativeValues?

The options for displaying the Chart negative bubble values.

notes?

The configuration of the series notes.

noteTextField?

The data item field which contains the series note text (see example).

opacity?

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

openField?

The data field which contains the open value. TheopenField option is available whenseries.type is set to"candlestick" or"ohlc".

outliers?

The configuration of the Chart series outliers. Applies to mild outliers. For more information, refer toseries.extremes.

outliersField?

The data item field which contains the series outliers value.

overlay?

The overlay options of the Chart series.

padding?

The padding around the Chart (equal on all sides). The padding option is available whenseries.type is set to"donut" or"pie".

pattern?

The configuration options of the series pattern.

patternField?

The data item field which contains the series pattern.ThepatternField option is supported whenseries.type is set to"pie","donut","funnel","heatmap", or"pyramid".

q1Field?

The data item field which contains the seriesq1 value.

q3Field?

The data item field which contains the seriesq3 value.

segmentSpacing?

The space in pixels between the different segments of the Funnel or Pyramid Chart. ThesegmentSpacing option is supported whenseries.type is set to"funnel" or"pyramid".

size?

The radius of the Chart Donut series in pixels. If not set, the available space is split evenly between the series.

sizeField?

The data field which contains the bubble size value.

spacing?

The distance between series points within a category. Expressed as a percentage of the bar width. See the relatedgap setting. The spacing option is supported whenseries.type is set to"bar","column","candlestick","ohlc", or"radarColumn".

stack?

A Boolean value which indicates if the series have to be stacked. A string value is interpreted asseries.stack.group.

Thestack option is supported whenseries.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.

startAngle?

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

summaryField?

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.

target?

The configuration options of the target. Thetarget option is supported whenseries.type is set to"bullet" or"verticalBullet".

toField?

The data item field which contains the series to value.

tooltip?

The configuration options of the Chart series tooltip.

trendline?

The configuration options of the series trendlines.

Thetrendline option is supported whenseries.type is set to"linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline", "polynomialTrendline" or "movingAverageTrendline".

type

upperField?

The data item field which contains the series upper value.

visible?

Sets the visible property of a Chart series.

visibleInLegend?

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.

visibleInLegendField?

The data item field which indicates whether to show the point category name in the legend. ThevisibleInLegendField option is supported whenseries.type is set to"funnel","pyramid","donut", or"pie".

visual?

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.

The available argument fields are:

• rect—The geometryRect that defines where the visual has to be rendered.
• options—The point options.
• createVisual—A function that can be used to get the default visual.
• category—The point category.
• dataItem—The pointdataItem.
• value—The point value.
• stackValue—The cumulative point value on the stack. Available only for the stackable series.
• sender—The Chart instance.
• series—The point series.
• percentage—The point value represented as a percentage value. Available only for the Donut, Pie, and 100% Stacked Charts.
• runningTotal—The sum of point values since the last"runningTotal" summary point. Available for the Waterfall series.
• total—The sum of all previous series values. Available for the Waterfall series.
• radius—The segment radius. Available for the Donut and Pie series.
• innerRadius—The segment inner radius. Available for the Donut series.
• startAngle—The segment start angle. Available for the Donut and Pie series.
• endAngle—The segment end angle. Available for the Donut and Pie series.
• center—The segment center point. Available for the Donut and Pie series.
• points—The segment points. Available for the Funnel and Pyramid series.

width?

The line width. Thewidth option is supported whenseries.type is set to"line","scatterLine","radarLine", or"polarLine".

xAxis?

The name of the X axis. ThexAxis option is supported whenseries.type is set to"bubble","scatter","scatterLine", or"polar" series. For the Polar series, thexAxis range is expressed in degrees.

xErrorHighField?

The data item field which contains theseries.errorBars xAxis high value (see example). ThexErrorHighField option is supported whenseries.type is set to"scatter"``,"scatterLine", or"bubble"`.

xErrorLowField?

The data item field which contains theseries.errorBars xAxis low value (see example). ThexErrorLowField option is supported whenseries.type is set to"scatter","scatterLine", or"bubble".

xField?

The data item field containing the x value. ThexField option is supported whenseries.type is set to"bubble","scatter","scatterLine", or"polar" series.

yAxis?

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

yErrorHighField?

The data item field which contains theseries.errorBars yAxis high value (see example). TheyErrorHighField option is supported whenseries.type is set to"scatter","scatterLine", or"bubble".

yErrorLowField?

The data item field which contains theseries.errorBars yAxis low value (see example). TheyErrorLowField option is supported whenseries.type is set to"scatter","scatterLine", or"bubble".

yField?

The data item field containing the y value. TheyField option is supported whenseries.type is set to"bubble","scatter", or"scatterLine".

zIndex?

An optional Z-index that can be used to change the default stacking order of series. The series with the highest Z-index are placed on top. Series with no Z-index use the default stacking order based on the series type. For example, Line series will be on top with the Bar and Area following after.