ChartSeriesItemProps
Name | Type | Default | Description |
---|---|---|---|
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:
| |
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 to | |
border? |
| The border of the Chart series. The border option is supported when | |
categoryAxis? |
| The name of the category axis that will be used for the series. If no | |
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 the | |
color? |
| The series base color. The supported values are:
| |
colorField? |
| The data item field which contains the series color. The | |
connectors? |
| The label connectors options. The connectors option is supported when | |
currentField? |
| The data item field which contains the current value. The | |
dashType? |
| The dash type of line Chart. The The following dash types are supported:
| |
dataItems? |
| The array of data items which represent the series data. You can set it to:
The Bubble series need arrays of three values—X value, Y value, and Size value—for example, | |
downColor? |
| The series color when the open value is greater than the close value. The | |
downColorField? |
| The data field which contains the color that is applied when the | |
dynamicHeight? |
| The | |
dynamicSlope? |
| The | |
errorBars? |
| The error bars of the Chart series. The | |
errorHighField? |
| The data item field which contains the | |
errorLowField? |
| The data item field which contains the | |
explodeField? |
| The data item field which contains a Boolean value indicating whether the sector is exploded. The | |
extremes? |
| The configuration of the Chart series extremes. Applies to extreme outliers. For more information, refer to | |
field? |
| The data item field which contains the series value. | |
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. The | |
highField? |
| The data field which contains the high value. The | |
highlight? |
| The configuration of the Chart series highlight. | |
holeSize? |
| The diameter of the donut hole in pixels. The | |
labels? |
| The configuration of the Chart series label. The Chart displays the series labels when the | |
line? |
| The Chart line configuration options. The line option is supported when | |
lineStyle? |
| The The supported values are:
| |
lowField? |
| The data field containing the low value. The | |
lowerField? |
| The data item field which contains the series lower value. | |
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 the | |
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. The The supported values are:
| |
name? |
| The name of the Chart series which is visible in the legend. | |
neckRatio? |
| Specifies the top-base/bottom-base ratio of the whole Chart. If the | |
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. | |
noteTextField? |
| The data item field which contains the series note text (see example). | |
notes? |
| The configuration of the series notes. | |
opacity? |
| The opacity of the series. By default, the series are opaque. | |
openField? |
| The data field which contains the open value. The | |
outliers? |
| The configuration of the Chart series outliers. Applies to mild outliers. For more information, refer to | |
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 when | |
q1Field? |
| The data item field which contains the series | |
q3Field? |
| The data item field which contains the series | |
segmentSpacing? |
| The space in pixels between the different segments of the Funnel Chart. The | |
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 related | |
stack? |
| A Boolean value which indicates if the series have to be stacked. A string value is interpreted as The | |
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:
| |
target? |
| The configuration options of the target. The | |
toField? |
| The data item field which contains the series to value. | |
tooltip? |
| The configuration options of the Chart series tooltip. | |
type? |
| The type of the series. The supported values are:
| |
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, 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. The | |
width? |
| The line width. The | |
xAxis? |
| The name of the X axis. The | |
xErrorHighField? |
| The data item field which contains the | |
xErrorLowField? |
| The data item field which contains the | |
xField? |
| The data item field containing the x value. The | |
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 the | |
yErrorLowField? |
| The data item field which contains the | |
yField? |
| The data item field containing the y value. The | |
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. |
Methods
visual | ||||||
---|---|---|---|---|---|---|
A function that can be used to create a custom visual for the points. Applicable for the Bar, Column, Pie, Donut, Funnel, Range Bar, Range Column, and Waterfall series. The available argument fields are:
| ||||||
| ||||||
|