ChartSeriesBuilder
Methods
Aggregate(System.Action)
The aggregate function to apply for date series.This function is used when a category (an year, month, etc.) contains two or more points. The function return value is displayed instead of the individual points.The supported values are:
Parameters
configurator - System.Action<ChartSeriesAggregateSettingsBuilder>
The configurator for the aggregates setting.
MissingValues(Kendo.Mvc.UI.ChartAreaMissingValues)
Specifies the behavior for handling missing values in the series.
Parameters
value - ChartAreaMissingValues
The value for MissingValues
MissingValues(Kendo.Mvc.UI.ChartLineMissingValues)
Specifies the behavior for handling missing values in the series.
Parameters
value - ChartLineMissingValues
The value for MissingValues
MissingValues(Kendo.Mvc.UI.ChartScatterLineMissingValues)
Specifies the behavior for handling missing values in the series.
Parameters
value - ChartScatterLineMissingValues
The value for MissingValues
Stack(Kendo.Mvc.UI.ChartStackType,System.String)
Sets the name of the stack that this series belongs to. Each unique name creates a new stack.
Parameters
stackType - ChartStackType
The stack type.
stackGroup - System.String
The name of the stack group.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Stack("Female"))
);
Stack(System.String)
Sets the name of the stack that this series belongs to. Each unique name creates a new stack.
Parameters
stackGroup - System.String
The name of the stack group.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Stack("Female"))
);
Style(Kendo.Mvc.UI.ChartLineStyle)
Specifies the preferred rendering style.
Parameters
value - ChartLineStyle
The value for Style
Style(Kendo.Mvc.UI.ChartPolarLineStyle)
Specifies the preferred rendering style.
Parameters
value - ChartPolarLineStyle
The value for Style
Style(Kendo.Mvc.UI.ChartRadarLineStyle)
Specifies the preferred rendering style.
Parameters
value - ChartRadarLineStyle
The value for Style
Style(Kendo.Mvc.UI.ChartScatterLineStyle)
Specifies the preferred rendering style.
Parameters
value - ChartScatterLineStyle
The value for Style
AutoFit(System.Boolean)
If set to true, the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series.
Parameters
value - System.Boolean
The value for AutoFit
AutoFit()
If set to true, the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series.
Axis(System.String)
The name of the value axis to use.
Parameters
value - System.String
The value for Axis
Border(System.Action)
The border of the chart series.
Parameters
configurator - System.Action<ChartSeriesBorderSettingsBuilder>
The configurator for the border setting.
CategoryAxis(System.String)
The name of the category axis to use for the series.The first axis will be used if no categoryAxis is specified.
Parameters
value - System.String
The value for CategoryAxis
CategoryField(System.String)
The data item field which contains the category name or date.
Parameters
value - System.String
The value for CategoryField
CloseField(System.String)
The data field containing the close value.
Parameters
value - System.String
The value for CloseField
Color(System.String)
The series base color. The supported values are: CSS color string, including hex and rgb or function(point) - user-defined function that will be evaluated for each point. Returning undefined will assume the default series color..
Parameters
value - System.String
The value for Color
ColorHandler(System.String)
The series base color. The supported values are: CSS color string, including hex and rgb or function(point) - user-defined function that will be evaluated for each point. Returning undefined will assume the default series color..
Parameters
handler - System.String
The name of the JavaScript function that will be evaluated.
ColorHandler(System.Func)
The series base color. The supported values are: CSS color string, including hex and rgb or function(point) - user-defined function that will be evaluated for each point. Returning undefined will assume the default series color..
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag.
ColorField(System.String)
The data item field which contains the series color.
Parameters
value - System.String
The value for ColorField
Connectors(System.Action)
The label connectors options.
Parameters
configurator - System.Action<ChartSeriesConnectorsSettingsBuilder>
The configurator for the connectors setting.
CurrentField(System.String)
The data item field containing the current value.
Parameters
value - System.String
The value for CurrentField
DashType(Kendo.Mvc.UI.ChartDashType)
The dash type of line chart.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 or "solid" - a solid line.
Parameters
value - ChartDashType
The value for DashType
DownColor(System.String)
The series color when the open value is greater than the close value.
Parameters
value - System.String
The value for DownColor
DownColorHandler(System.String)
The series color when the open value is greater than the close value.
Parameters
handler - System.String
The name of the JavaScript function that will be evaluated.
DownColorHandler(System.Func)
The series color when the open value is greater than the close value.
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag.
DownColorField(System.String)
The data field containing the color applied when the open value is greater than the close value.
Parameters
value - System.String
The value for DownColorField
DrilldownField(System.String)
The data field which contains the value to use to drill down into detailed data for the point.
Parameters
value - System.String
The value for DrilldownField
DrilldownSeriesFactory(System.String)
A function that creates the drilldown series for a given point.The function should accept a single parameter, the point drilldownField value. The function should return a series configuration object or a Promise that resolves to one.
Parameters
handler - System.String
The name of the JavaScript function that will be evaluated.
DrilldownSeriesFactory(System.Func)
A function that creates the drilldown series for a given point.The function should accept a single parameter, the point drilldownField value. The function should return a series configuration object or a Promise that resolves to one.
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag.
SegmentSpacing(System.Double)
The space in pixels between the different segments of the funnel and pyramid charts.
Parameters
value - System.Double
The value for SegmentSpacing
SummaryField(System.String)
The data item field which contains the summary type for waterfall series. Summary columns are optional and can be one of two types: "runningTotal" - Displays the sum of all items since the last "runningTotal" point. or "total" - Displays the sum of all previous items..
Parameters
value - System.String
The value for SummaryField
NeckRatio(System.Double)
specifies the ratio top-base/bottom-base of the whole chart. neckRatio set to three means the top base is three times smaller than the bottom base.
Parameters
value - System.Double
The value for NeckRatio
DynamicSlope(System.Boolean)
When set to true the ratio of the bases of each segment is calculated based on the ratio of currentDataItem.value/nextDataItem.value The last element is always created like a rectangle since there is no following element.
Parameters
value - System.Boolean
The value for DynamicSlope
DynamicSlope()
When set to true the ratio of the bases of each segment is calculated based on the ratio of currentDataItem.value/nextDataItem.value The last element is always created like a rectangle since there is no following element.
DynamicHeight(System.Boolean)
When set to false all segments become with the same height, otherwise the height of each segment is based on its value.
Parameters
value - System.Boolean
The value for DynamicHeight
ErrorBars(System.Action)
The error bars of the chart series.
Parameters
configurator - System.Action<ChartSeriesErrorBarsSettingsBuilder>
The configurator for the errorbars setting.
ErrorLowField(System.String)
The data item field which contains the series.errorBars low value.
Parameters
value - System.String
The value for ErrorLowField
ErrorHighField(System.String)
The data item field which contains the series.errorBars high value.
Parameters
value - System.String
The value for ErrorHighField
XErrorLowField(System.String)
The data item field which contains the series.errorBars xAxis low value.
Parameters
value - System.String
The value for XErrorLowField
XErrorHighField(System.String)
The data item field which contains the series.errorBars xAxis high value.
Parameters
value - System.String
The value for XErrorHighField
YErrorLowField(System.String)
The data item field which contains the series.errorBars yAxis low value.
Parameters
value - System.String
The value for YErrorLowField
YErrorHighField(System.String)
The data item field which contains the series.errorBars yAxis high value.
Parameters
value - System.String
The value for YErrorHighField
ExplodeField(System.String)
The data item field which contains a boolean value indicating whether the sector is exploded.
Parameters
value - System.String
The value for ExplodeField
Field(System.String)
The data item field which contains the series value. The field name should be a valid Javascript identifier and should contain only alphanumeric characters (or "$" or "_"), and may not start with a digit.
Parameters
value - System.String
The value for Field
For(System.String)
The name of the parent series of the trendline.
Parameters
value - System.String
The value for For
FromField(System.String)
The data item field which contains the series from value.
Parameters
value - System.String
The value for FromField
ToField(System.String)
The data item field which contains the series to value.
Parameters
value - System.String
The value for ToField
Trendline(System.Action)
The trendline configuration options.
Parameters
configurator - System.Action<ChartSeriesTrendlineSettingsBuilder>
The configurator for the trendline setting.
NoteTextField(System.String)
The data item field which contains the series note text.
Parameters
value - System.String
The value for NoteTextField
LowerField(System.String)
The data item field which contains the series lower value.
Parameters
value - System.String
The value for LowerField
Q1Field(System.String)
The data item field which contains the series q1 value.
Parameters
value - System.String
The value for Q1Field
Median(System.Action)
The configuration of the Box Plot median value indicator (line).
Parameters
configurator - System.Action<ChartSeriesMedianSettingsBuilder>
The configurator for the median setting.
MedianField(System.String)
The data item field which contains the series median value.
Parameters
value - System.String
The value for MedianField
Q3Field(System.String)
The data item field which contains the series q3 value.
Parameters
value - System.String
The value for Q3Field
UpperField(System.String)
The data item field which contains the series upper value.
Parameters
value - System.String
The value for UpperField
Mean(System.Action)
The configuration of the Box Plot mean value indicator (line).
Parameters
configurator - System.Action<ChartSeriesMeanSettingsBuilder>
The configurator for the mean setting.
MeanField(System.String)
The data item field which contains the series mean value.
Parameters
value - System.String
The value for MeanField
OutliersField(System.String)
The data item field which contains the series outliers value.
Parameters
value - System.String
The value for OutliersField
Gap(System.Double)
The distance between categories expressed as a percentage of the bar width.See the related spacing setting.
Parameters
value - System.Double
The value for Gap
HighField(System.String)
The data field containing the high value.
Parameters
value - System.String
The value for HighField
Highlight(System.Action)
The chart series highlighting configuration options.
Parameters
configurator - System.Action<ChartSeriesHighlightSettingsBuilder>
The configurator for the highlight setting.
HoleSize(System.Double)
The radius of the donut hole in pixels.
Parameters
value - System.Double
The value for HoleSize
Labels(System.Action)
The chart series label configuration.
Parameters
configurator - System.Action<ChartSeriesLabelsSettingsBuilder>
The configurator for the labels setting.
LegendItem(System.Action)
The configuration of the Chart legend item for this series.
Parameters
configurator - System.Action<ChartSeriesLegendItemSettingsBuilder>
The configurator for the legenditem setting.
Line(System.Action)
The chart line configuration options.
Parameters
configurator - System.Action<ChartSeriesLineSettingsBuilder>
The configurator for the line setting.
LowField(System.String)
The data field containing the low value.
Parameters
value - System.String
The value for LowField
Margin(System.Double)
The margin around each donut series (ring). A numeric value will set all margins.
Parameters
value - System.Double
The value for Margin
Markers(System.Action)
The chart series marker configuration.
Parameters
configurator - System.Action<ChartSeriesMarkersSettingsBuilder>
The configurator for the markers setting.
Outliers(System.Action)
The chart series outliers configuration. Applies to mild outliers. Also check series.extremes.
Parameters
configurator - System.Action<ChartSeriesOutliersSettingsBuilder>
The configurator for the outliers setting.
Extremes(System.Action)
The chart series extremes configuration. Applies to extreme outliers. Also check series.outliers.
Parameters
configurator - System.Action<ChartSeriesExtremesSettingsBuilder>
The configurator for the extremes setting.
MaxSize(System.Double)
The maximum size of the chart bubble series marker.
Parameters
value - System.Double
The value for MaxSize
MinSize(System.Double)
The minimum size of the chart bubble series marker.
Parameters
value - System.Double
The value for MinSize
Name(System.String)
The name of the chart series which is visible in the legend.
Parameters
value - System.String
The value for Name
NegativeColor(System.String)
The color to use for bar, column or waterfall series with negative values. Accepts a valid CSS color string, including hex and rgb.
Parameters
value - System.String
The value for NegativeColor
NegativeValues(System.Action)
The options for displaying the chart negative bubble values.
Parameters
configurator - System.Action<ChartSeriesNegativeValuesSettingsBuilder>
The configurator for the negativevalues setting.
Opacity(System.Double)
The series opacity. By default the series are opaque.
Parameters
value - System.Double
The value for Opacity
OpenField(System.String)
The data field containing the open value.
Parameters
value - System.String
The value for OpenField
Overlay(System.Action)
The chart series overlay options.
Parameters
configurator - System.Action<ChartSeriesOverlaySettingsBuilder>
The configurator for the overlay setting.
Padding(System.Double)
The padding around the chart (equal on all sides).
Parameters
value - System.Double
The value for Padding
Pattern(System.Action)
The configuration options of the series pattern. The pattern inherits the series color as main color and accepts an optional background color.
Parameters
configurator - System.Action<ChartSeriesPatternSettingsBuilder>
The configurator for the pattern setting.
PatternField(System.String)
The data item field which contains the series pattern configuration for individual chart segments. The PatternField option is supported when the series typeis set to Pie, Donut, Funnel, Heatmap, or Pyramid.
Parameters
value - System.String
The value for PatternField
Size(System.Double)
The or radius of the chart donut series in pixels. If not set, the available space is split evenly between the series.
Parameters
value - System.Double
The value for Size
SizeField(System.String)
The data field containing the bubble size value.
Parameters
value - System.String
The value for SizeField
Spacing(System.Double)
The distance between series points within a category. Expressed as a percentage of the bar width.See the related gap setting.
Parameters
value - System.Double
The value for Spacing
Stack(System.Action)
A boolean value indicating if the series should be stacked. A string value is interpreted as series.stack.group.
Parameters
configurator - System.Action<ChartSeriesStackSettingsBuilder>
The configurator for the stack setting.
Stack()
Sets the name of the stack that this series belongs to. Each unique name creates a new stack.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Stack("Female"))
);
Stack(System.Boolean)
A boolean value indicating if the series should be stacked. A string value is interpreted as series.stack.group.
Parameters
enabled - System.Boolean
Enables or disables the stack option.
StartAngle(System.Double)
The start angle (degrees) of the first donut or pie segment.Angles increase clockwise and zero is to the left. Negative values are acceptable.
Parameters
value - System.Double
The value for StartAngle
TargetField(System.String)
The data item field containing the target value.
Parameters
value - System.String
The value for TargetField
Target(System.Action)
The configuration options of the target
Parameters
configurator - System.Action<ChartSeriesTargetSettingsBuilder>
The configurator for the target setting.
Tooltip(System.Action)
The chart series tooltip configuration options.
Parameters
configurator - System.Action<ChartSeriesTooltipSettingsBuilder>
The configurator for the tooltip setting.
Visible(System.Boolean)
Sets the visible property of a chart series
Parameters
value - System.Boolean
The value for Visible
VisibleInLegend(System.Boolean)
A value indicating whether to show the point category name (for funnel, pyramid, donut and pie series) or series name (for other available series types) in the legend.
Parameters
value - System.Boolean
The value for VisibleInLegend
VisibleInLegendField(System.String)
The data item field which indicates whether to show the point category name in the legend.
Parameters
value - System.String
The value for VisibleInLegendField
Visual(System.String)
A function that can be used to create a custom visual for the points. Applicable for bar, column, pie, donut, funnel, pyramid, line, scatterLine, rangeBar, rangeColumn and waterfall series. The available argument fields are: rect - the kendo.geometry.Rect that defines where the visual should be rendered.; options - the point options.; createVisual - a function that can be used to get the default visual.; category - the point category.; dataItem - the point dataItem.; value - the point value.; stackValue - the cumulative point value on the stack. Available only for stackable series.; sender - the chart instance.; series - the point series.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series.; total - the sum of all previous series values. Available for waterfall series.; radius - the segment radius. Available for donut and pie series.; innerRadius - the segment inner radius. Available for donut series.; startAngle - the segment start angle. Available for donut and pie series.; endAngle - the segment end angle. Available for donut and pie series.; center - the segment center point. Available for donut and pie series. or points - the segment points. Available for funnel, pyramid, line and scatterLine series..
Parameters
handler - System.String
The name of the JavaScript function that will be evaluated.
Visual(System.Func)
A function that can be used to create a custom visual for the points. Applicable for bar, column, pie, donut, funnel, pyramid, line, scatterLine, rangeBar, rangeColumn and waterfall series. The available argument fields are: rect - the kendo.geometry.Rect that defines where the visual should be rendered.; options - the point options.; createVisual - a function that can be used to get the default visual.; category - the point category.; dataItem - the point dataItem.; value - the point value.; stackValue - the cumulative point value on the stack. Available only for stackable series.; sender - the chart instance.; series - the point series.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series.; total - the sum of all previous series values. Available for waterfall series.; radius - the segment radius. Available for donut and pie series.; innerRadius - the segment inner radius. Available for donut series.; startAngle - the segment start angle. Available for donut and pie series.; endAngle - the segment end angle. Available for donut and pie series.; center - the segment center point. Available for donut and pie series. or points - the segment points. Available for funnel, pyramid, line and scatterLine series..
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag.
Whiskers(System.Action)
The chart series whiskers configuration.
Parameters
configurator - System.Action<ChartSeriesWhiskersSettingsBuilder>
The configurator for the whiskers setting.
Width(System.Double)
The line width.
Parameters
value - System.Double
The value for Width
XAxis(System.String)
The name of the X axis to use.For polar series the xAxis range is expressed in degrees.
Parameters
value - System.String
The value for XAxis
XField(System.String)
The data item field containing the X value.
Parameters
value - System.String
The value for XField
YAxis(System.String)
The name of the Y axis to use.** Available for bubble, scatter, scatterLine and polar series. **
Parameters
value - System.String
The value for YAxis
YField(System.String)
The data item field containing the Y value.
Parameters
value - System.String
The value for YField
Notes(System.Action)
The series notes configuration.
Parameters
configurator - System.Action<ChartSeriesNotesSettingsBuilder>
The configurator for the notes setting.
ZIndex(System.Double)
An optional Z-index that can be used to change the default stacking order of series.The series with the highest Z-index will be placed on top.Series with no Z-index will use the default stacking order based on series type. For example line series will be on top with bar and area following below.
Parameters
value - System.Double
The value for ZIndex
Aggregate(Kendo.Mvc.UI.ChartSeriesAggregate)
Specifies the preferred series aggregate.
Parameters
value - ChartSeriesAggregate
The value for Aggregate
AggregateHandler(System.String)
Specifies the preferred series aggregate.
Parameters
handler - System.String
The name of the JavaScript function that will be evaluated.
AggregateHandler(System.Func)
Specifies the preferred series aggregate.
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag.
MissingValues(Kendo.Mvc.UI.ChartSeriesMissingValues)
Specifies the behavior for handling missing values in the series.
Parameters
value - ChartSeriesMissingValues
The value for MissingValues
Style(Kendo.Mvc.UI.ChartSeriesStyle)
Specifies the preferred rendering style.
Parameters
value - ChartSeriesStyle
The value for Style