Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / ChartBoxPlotSeriesBuilder<T>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ChartBoxPlotSeriesBuilder<T>

Class

Defines the fluent interface for configuring bar series.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

T

The type of the data item

Syntax:
C#
public class ChartBoxPlotSeriesBuilder<T> : ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>> where T : class

Inheritance: objectChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>ChartBoxPlotSeriesBuilder<T>

Inherited Members ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Name(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Opacity(double)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Color(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.ColorHandler(Func<object, object>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.ColorHandler(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Tooltip(Action<ChartTooltipBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Tooltip(bool)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Axis(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.CategoryAxis(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Highlight(Action<ChartSeriesHighlightBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.FocusHighlight(Action<ChartSeriesFocusHighlightSettingsBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Highlight(bool)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Visible(bool)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.VisibleInLegend(bool)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Notes(Action<ChartNoteBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Aggregate(Func<object, object>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Aggregate(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.ZIndex(double)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Median(Action<ChartSeriesMedianBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Mean(Action<ChartSeriesMeanBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.DrilldownField(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.DrilldownSeriesFactory(string)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.DrilldownSeriesFactory(Func<object, object>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.LegendItem(Action<ChartSeriesLegendItemSettingsBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Pattern(Action<ChartSeriesPatternSettingsBuilder>)ChartSeriesBuilderBase<IChartBoxPlotSeries, ChartBoxPlotSeriesBuilder<T>>.Seriesobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ChartBoxPlotSeriesBuilder(IChartBoxPlotSeries)

Initializes a new instance of the ChartBoxPlotSeriesBuilder<T> class.

C#
public ChartBoxPlotSeriesBuilder(IChartBoxPlotSeries series)
Parameters:seriesIChartBoxPlotSeries

The series.

Methods

Aggregate(ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?)

Sets the aggregate function for date series. This function is used when a category (an year, month, etc.) contains two or more points.

C#
public ChartBoxPlotSeriesBuilder<T> Aggregate(ChartSeriesAggregate? lower = null, ChartSeriesAggregate? q1 = null, ChartSeriesAggregate? median = null, ChartSeriesAggregate? q3 = null, ChartSeriesAggregate? upper = null, ChartSeriesAggregate? mean = null, ChartSeriesAggregate? outliers = null)
Parameters:lowerChartSeriesAggregate?

Lower aggregate name.

q1ChartSeriesAggregate?

Q1 aggregate name.

medianChartSeriesAggregate?

Median aggregate name.

q3ChartSeriesAggregate?

Q3 aggregate name.

upperChartSeriesAggregate?

Upper aggregate name.

meanChartSeriesAggregate?

Mean aggregate name.

outliersChartSeriesAggregate?

Outliers aggregate name.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Aggregate(
ChartSeriesAggregate.Max,
ChartSeriesAggregate.Max,
ChartSeriesAggregate.Max,
ChartSeriesAggregate.Max,
ChartSeriesAggregate.Max,
ChartSeriesAggregate.Max,
ChartSeriesAggregate.Max,
ChartSeriesAggregate.First
)
)
)

Border(int, string, ChartDashType)

Sets the points border.

C#
public ChartBoxPlotSeriesBuilder<T> Border(int width, string color, ChartDashType dashType)
Parameters:widthint

The points border width.

colorstring

The points border color (CSS syntax).

dashTypeChartDashType

The points border dash type.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Border(1, "#000", ChartDashType.Dot)
)
)

CategoryField(string)

Sets the Model property that holds the category for the series.

C#
public ChartBoxPlotSeriesBuilder<T> CategoryField(string categoryField)
Parameters:categoryFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").CategoryField("Category"))
)

ColorField(string)

Sets the Model property that holds the series color.

C#
public ChartBoxPlotSeriesBuilder<T> ColorField(string colorField)
Parameters:colorFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").ColorField("AppliedColor"))
)

Extremum(Action<ChartMarkersBuilder>)

Configures the Box Plot Chart extremum.

C#
public ChartBoxPlotSeriesBuilder<T> Extremum(Action<ChartMarkersBuilder> configurator)
Parameters:configuratorAction<ChartMarkersBuilder>

The configuration action.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Extremum(extremum =&gt; extremum
.Type(ChartMarkerShape.Triangle)
)
)
)

Extremum(bool)

Sets the visibility of Box Plot Chart extremum.

C#
public ChartBoxPlotSeriesBuilder<T> Extremum(bool visible)
Parameters:visiblebool

The value that sets the visibility of the option.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Extremum(true)
)
)

Gap(double)

Sets the distance between category clusters.

A value of 1 means that there is a total of 1 point width between categories. The distance is distributed evenly on each side. The default value is 1
C#
public ChartBoxPlotSeriesBuilder<T> Gap(double gap)
Parameters:gapdoubleReturns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper).Gap(1.5))
)

Line(Action<ChartLineBuilder>)

Defines the lines configuration of the series.

C#
public ChartBoxPlotSeriesBuilder<T> Line(Action<ChartLineBuilder> configurator)
Parameters:configuratorAction<ChartLineBuilder>

The action that configures the lines options.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Line(line =&gt; line.Opacity(0.2).Width(2))
)
)

Line(int, string, ChartDashType)

Configures the lines of the series.

C#
public ChartBoxPlotSeriesBuilder<T> Line(int width, string color, ChartDashType dashType)
Parameters:widthint

The lines width.

colorstring

The lines color.

dashTypeChartDashType

The lines dash type.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Line(2, "red", ChartDashType.Dot)
)
)

Line(int, string)

Configures the width and color of the series lines.

C#
public ChartBoxPlotSeriesBuilder<T> Line(int width, string color)
Parameters:widthint

The lines width.

colorstring

The lines color.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Line(2, "red")
)
)

Line(int)

Configures the width of the series lines in pixels.

C#
public ChartBoxPlotSeriesBuilder<T> Line(int width)
Parameters:widthint

The lines width.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Line(2)
)
)

LowerField(string)

Sets the Model property that holds the series lower value.

C#
public ChartBoxPlotSeriesBuilder<T> LowerField(string lowerField)
Parameters:lowerFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.Bar(Model.Records).Field("Value").LowerField("Lower"))
)

MeanField(string)

Sets the Model property that holds the mean field for the series.

C#
public ChartBoxPlotSeriesBuilder<T> MeanField(string meanField)
Parameters:meanFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").MeanField("Mean"))
)

MedianField(string)

Sets the Model property that holds the median field for the series.

C#
public ChartBoxPlotSeriesBuilder<T> MedianField(string medianField)
Parameters:medianFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").MedianField("Median"))
)

NoteTextField(string)

Sets the Model property that holds the series note text.

C#
public ChartBoxPlotSeriesBuilder<T> NoteTextField(string noteTextField)
Parameters:noteTextFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").NoteTextField("NoteText"))
)

Outliers(Action<ChartMarkersBuilder>)

Defines the series outliers configuration.

C#
public ChartBoxPlotSeriesBuilder<T> Outliers(Action<ChartMarkersBuilder> configurator)
Parameters:configuratorAction<ChartMarkersBuilder>

The action that configures the outliers options.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Outliers(outliers =&gt; outliers.Type(ChartMarkerShape.Triangle))
)
)

Outliers(bool)

Sets the visibility of Box Plot Chart outliers.

C#
public ChartBoxPlotSeriesBuilder<T> Outliers(bool visible)
Parameters:visiblebool

The value that sets the visibility of the option.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper)
.Outliers(true)
)
)

OutliersField(string)

Sets the Model property that holds the outliers field for the series.

C#
public ChartBoxPlotSeriesBuilder<T> OutliersField(string outliersField)
Parameters:outliersFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").OutliersField("Outliers"))
)

Q1Field(string)

Sets the Model property that holds the series q1 value.

C#
public ChartBoxPlotSeriesBuilder<T> Q1Field(string q1Field)
Parameters:q1Fieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").Q1Field("Q1"))
)

Q3Field(string)

Sets the Model property that holds the q3 field for the series.

C#
public ChartBoxPlotSeriesBuilder<T> Q3Field(string q3Field)
Parameters:q3Fieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").Q3Field("Q3"))
)

Spacing(double)

Sets a value indicating the distance between series points in the same category.

C#
public ChartBoxPlotSeriesBuilder<T> Spacing(double spacing)
Parameters:spacingdouble

Value of 1 means that the distance between points in the same category. The default value is 0.3

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(s =&gt; s.Lower, s =&gt; s.Q1, s =&gt; s.Median, s =&gt; s.Q3, s =&gt; s.Upper).Spacing(1))
)

UpperField(string)

Sets the Model property that holds the upper field for the series.

C#
public ChartBoxPlotSeriesBuilder<T> UpperField(string upperField)
Parameters:upperFieldstring

The name of the Model property.

Returns:

ChartBoxPlotSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.BoxPlot(Model.Records).Field("Value").UpperField("Upper"))
)
In this article
DefinitionConstructorsChartBoxPlotSeriesBuilder(IChartBoxPlotSeries)MethodsAggregate(ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?, ChartSeriesAggregate?)Border(int, string, ChartDashType)CategoryField(string)ColorField(string)Extremum(Action<ChartMarkersBuilder>)Extremum(bool)Gap(double)Line(Action<ChartLineBuilder>)Line(int, string, ChartDashType)Line(int, string)Line(int)LowerField(string)MeanField(string)MedianField(string)NoteTextField(string)Outliers(Action<ChartMarkersBuilder>)Outliers(bool)OutliersField(string)Q1Field(string)Q3Field(string)Spacing(double)UpperField(string)
Not finding the help you need?
Contact Support