Series
Represents the configuration options of the series.
Name | Type | Default | Description |
---|---|---|---|
aggregate? |
|
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:
defined.
value or a data item.
Sets the aggregate for each data item field. | |
autoFit? |
|
Determines whether the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series. (See example) | |
axis? |
|
Specifies the name of the value axis.
This option is supported for Scatter plots. For more information on Scatter plots, refer to
| |
border? |
|
Specifies the border of the Chart series.
This option is supported when | |
categoryAxis? |
|
Specifies the name of the category axis that the series uses.
If you do not specify a | |
categoryField? |
|
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? |
|
Specifies the data field that contains the | |
color? |
|
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 | |
colorField? |
|
Specifies the data item field which contains the series color.
This option is supported when | |
connectors? |
|
Specifies the label connectors options.
This option is supported when | |
currentField? |
|
Specifies the data item field which contains the current value.
This option is supported when | |
dashType? |
|
Specifies the dash type of line Chart.
Use this option only when the | |
data? |
|
Specifies the array of data items which represent the series data. You can set it to:
Bubble series need arrays of three values—X value, Y value, and Size value—for example, 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? |
|
Specifies the series color when the open value is greater than the close value.
This option is supported when | |
downColorField? |
|
Specifies the data field which contains the color that applies when the | |
drilldownField? |
|
Specifies the data field which contains the value to use to drill down into detailed data for the point. | |
dynamicHeight? |
|
Determines whether the segments have the same height.
This option is supported when | |
dynamicSlope? |
|
This option is supported when | |
errorBars? |
|
Specifies the error bars of the Chart series.
This option is supported when | |
errorHighField? |
|
Specifies the data item field which contains the | |
errorLowField? |
|
Specifies the data item field which contains the | |
explodeField? |
|
Specifies the data item field which contains a Boolean value indicating whether the sector is exploded.
This option is supported when | |
extremes? |
|
Specifies the configuration of the Chart series extremes. Applies to extreme outliers.
This option is supported when | |
field? |
|
Specifies the data item field which contains the series value. | |
for? |
|
Specifies the name of the parent series of the trendline. This option is supported when | |
fromField? |
|
Specifies the data item field which contains the series from value. | |
gap? |
|
Specifies the distance between the categories expressed as a percentage of the bar width.
See the related spacing setting.
This option is supported when | |
highField? |
|
Specifies the data field which contains the high value.
This option is supported when | |
highlight? |
|
Specifies the configuration of the Chart series highlight. | |
holeSize? |
|
Specifies the diameter of the donut hole in pixels.
This option is supported when | |
labels? |
|
Specifies the configuration of the Chart series label.
Displays the series labels when the | |
legendItem? |
|
Specifies the configuration of the Chart legend item. Inherits the Legend item type and markers from the series by default. | |
line? |
|
Specifies the Chart line configuration options.
This option is supported when | |
lowerField? |
|
Specifies the data item field which contains the series lower value.
This option is supported when | |
lowField? |
|
Specifies the data field containing the low value.
This option is supported when | |
margin? |
|
Specifies the margin around each donut series (ring). A numeric value sets all margins. | |
markers? |
|
Specifies the configuration of the Chart series marker.
Displays the series labels when the | |
maxSize? |
|
Specifies the maximum size of the Chart bubble series marker. | |
mean? |
|
Specifies the configuration of the mean value indicator (line) for Box Plot series. This option is not supported by other series types. | |
meanField? |
|
Specifies the data item field which contains the series mean value.
This option is supported when | |
median? |
|
Specifies the configuration of the median value indicator (line) for Box Plot series. This option is not supported by other series types. | |
medianField? |
|
Specifies the data item field which contains the series median value.
This option is supported when | |
minSize? |
|
Specifies the minimum size of the Chart bubble series marker. | |
missingValues? |
|
Specifies the behavior for handling missing values.
This option is available when Supports the following values:
| |
name? |
|
Specifies 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 the | |
negativeColor? |
|
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? |
|
Specifies the options for displaying the Chart negative bubble values. | |
notes? |
|
Specifies the configuration of the series notes. | |
noteTextField? |
|
Specifies the data item field which contains the series note text. | |
opacity? |
|
Specifies the opacity of the series. Series are opaque by default. | |
openField? |
|
Specifies the data field which contains the open value.
This option is available when | |
outliers? |
|
Specifies the configuration of the Chart series outliers. Applies to mild outliers.
This option is supported when | |
outliersField? |
|
Specifies the data item field which contains the series outliers value.
This option is supported when | |
overlay? |
|
Specifies the overlay options of the Chart series. | |
padding? |
|
Specifies the padding around the Chart (equal on all sides).
This option is available when | |
pattern? |
|
Specifies the configuration options of the series pattern. | |
patternField? |
|
Specifies the data item field which contains the series pattern.
This option is supported when | |
q1Field? |
|
Specifies the data item field which contains the series | |
q3Field? |
|
Specifies the data item field which contains the series | |
segmentSpacing? |
|
Specifies the space in pixels between the different segments of the Funnel or Pyramid Chart.
This option is supported when | |
size? |
|
Specifies the radius of the Chart Donut series in pixels. When not set, Charts split the available space evenly between the series. | |
sizeField? |
|
Specifies the data field which contains the bubble size value. | |
spacing? |
|
Specifies the distance between series points within a category expressed as a percentage of the bar width.
See the related | |
stack? |
|
Determines whether the series stacks.
Interprets a string value as This option is supported when | |
startAngle? |
|
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? |
|
Specifies the style options for the series.
This option is supported when | |
summaryField? |
|
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:
| |
target? |
|
Specifies the configuration options of the target.
This option is supported when | |
toField? |
|
Specifies the data item field which contains the series to value. | |
tooltip? |
|
Specifies the configuration options of the Chart series tooltip. | |
trendline? |
|
Specifies the trendline configuration options. This option is supported when | |
type? |
|
Specifies the type of the series. | |
upperField? |
|
Specifies the data item field which contains the series upper value.
This option is supported when | |
visible? |
|
Specifies the visible property of a Chart series. | |
visibleInLegend? |
|
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? |
|
Specifies the data item field which indicates whether to show the point category name in the legend.
This option is supported when | |
visual? |
|
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? |
|
Specifies the configuration of the whiskers for the Chart series.
This option is supported when | |
width? |
|
Specifies the line width.
This option is supported when | |
xAxis? |
|
Specifies the name of the X axis.
This option is supported when | |
xErrorHighField? |
|
Specifies the data item field which contains the | |
xErrorLowField? |
|
Specifies the data item field which contains the | |
xField? |
|
Specifies the data item field containing the x value.
This option is supported when | |
yAxis? |
|
Specifies the name of the Y axis to use. Available for the Bubble, Scatter, Scatter Line, and Polar series. | |
yErrorHighField? |
|
Specifies the data item field which contains the | |
yErrorLowField? |
|
Specifies the data item field which contains the | |
yField? |
|
Specifies the data item field containing the y value.
This option is supported when | |
zIndex? |
|
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. |