NavigatorSeriesItemComponent
The configuration component of a navigator series item (see example).
Selector
kendo-chart-navigator-series-item
Inputs
NAME | TYPE | DEFAULT | DESCRIPTION |
---|---|---|---|
aggregate | any | The aggregate function for the date series.
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 The supported values are:
| |
autoFit | boolean | If set to | |
axis | string | 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 | string | The name of the category axis that will be used for the series.
If no | |
categoryField | string | 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 | string | The data field that contains the | |
color | any | The series base color. The supported values are:
| |
colorField | string | The data item field which contains the series color.
The | |
connectors | The label connectors options.
The connectors option is supported when | ||
currentField | string | The data item field which contains the current value.
The | |
dashType | The dash type of line Chart.
The The following dash types are supported:
| ||
data | any[] | 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 | string | The series color when the open value is greater than the close value.
The | |
downColorField | string | The data field which contains the color that is applied when the | |
dynamicHeight | boolean | The | |
dynamicSlope | boolean | The | |
errorBars | The error bars of the Chart series.
The | ||
errorHighField | string | The data item field which contains the | |
errorLowField | string | The data item field which contains the | |
explodeField | string | 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.
The | ||
field | string | The data item field which contains the series value. | |
fromField | string | The data item field which contains the series from value. | |
gap | number | The distance between the categories expressed as a percentage of the bar width.
See the related spacing setting.
The | |
highField | string | The data field which contains the high value.
The | |
highlight | The configuration of the Chart series highlight. | ||
holeSize | number | 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 | ||
lowField | string | The data field containing the low value.
The | |
lowerField | string | The data item field which contains the series lower value.
The | |
margin | number | 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 | number | The maximum size of the Chart bubble series marker. | |
mean | The configuration of the mean value indicator (line) for Box Plot series.
The | ||
meanField | string | The data item field which contains the series mean value.
The | |
median | The configuration of the median value indicator (line) for Box Plot series.
The | ||
medianField | string | The data item field which contains the series median value.
The | |
minSize | number | The minimum size of the Chart bubble series marker. | |
missingValues | "gap" | "interpolate" | "zero" | The behavior for handling missing values.
The The supported values are:
| |
name | string | The name of the Chart series which is visible in the legend. | |
neckRatio | number | Specifies the top-base/bottom-base ratio of the whole Chart. If the | |
negativeColor | string | 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 | string | The data item field which contains the series note text. | |
notes | The configuration of the series notes. | ||
opacity | number | The opacity of the series. By default, the series are opaque. | |
openField | string | The data field which contains the open value.
The | |
outliers | The configuration of the Chart series outliers. Applies to mild outliers.
The | ||
outliersField | string | The data item field which contains the series outliers value.
The | |
overlay | The overlay options of the Chart series. | ||
padding | number | The padding around the Chart (equal on all sides).
The padding option is available when | |
q1Field | string | The data item field which contains the series | |
q3Field | string | The data item field which contains the series | |
segmentSpacing | number | The space in pixels between the different segments of the Funnel Chart.
The | |
size | number | The radius of the Chart Donut series in pixels. If not set, the available space is split evenly between the series. | |
sizeField | string | The data field which contains the bubble size value. | |
spacing | number | The distance between series points within a category. Expressed as a percentage of the bar width.
See the related | |
stack | string | boolean | SeriesStack | A Boolean value which indicates if the series have to be stacked.
A string value is interpreted as The | |
startAngle | number | The start angle (in degrees) of the first Donut or Pie segment. Angles increase clockwise with zero to the left. Negative values are acceptable. | |
style | The The supported values are:
| ||
summaryField | string | 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 | string | 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 | string | The data item field which contains the series upper value.
The | |
visible | boolean | Sets the visible property of a Chart series. | |
visibleInLegend | boolean | 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 | string | The data item field which indicates whether to show the point category name in the legend.
The | |
visual | (e: SeriesVisualArgs) => Element | 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, Line, ScatterLine, and Waterfall series. The available argument fields are:
| |
whiskers | The configuration of the whiskers for the Chart series.
The | ||
width | number | The line width.
The | |
xAxis | string | The name of the X axis.
The | |
xErrorHighField | string | The data item field which contains the | |
xErrorLowField | string | The data item field which contains the | |
xField | string | The data item field containing the x value.
The | |
yAxis | string | The name of the Y axis to use. Available for the Bubble, Scatter, Scatter Line, and Polar series. | |
yErrorHighField | string | The data item field which contains the | |
yErrorLowField | string | The data item field which contains the | |
yField | string | The data item field containing the y value.
The | |
zIndex | number | 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
notifyChanges | ||
---|---|---|
Updates the component fields with the specified values and refreshes the Chart. Use this method when the configuration values cannot be set through the template.
|
Parameters | ||
---|---|---|
changes | any | An object containing the updated input fields. |
togglePointVisibility | ||
---|---|---|
Toggles the visibility of a point with the given index. Applicable for the Pie, Donut, and Funnel series. |
Parameters | ||
---|---|---|
pointIndex | number | The zero-based index of the point to toggle. |
toggleVisibility |
---|
Toggles the series visibility and updates the parent Chart without animated transitions. |