ChartBoxPlotSeriesBuilder

Defines the fluent interface for configuring bar series.

Properties

Series - IChartBoxPlotSeries

Aggregates function for date series.

Methods

Aggregate(System.Nullable,System.Nullable,System.Nullable,System.Nullable,System.Nullable,System.Nullable,System.Nullable)

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

Parameters

lower - System.Nullable<ChartSeriesAggregate>

Lower aggregate name.

q1 - System.Nullable<ChartSeriesAggregate>

Q1 aggregate name.

median - System.Nullable<ChartSeriesAggregate>

Median aggregate name.

q3 - System.Nullable<ChartSeriesAggregate>

Q3 aggregate name.

upper - System.Nullable<ChartSeriesAggregate>

Upper aggregate name.

mean - System.Nullable<ChartSeriesAggregate>

Mean aggregate name.

outliers - System.Nullable<ChartSeriesAggregate>

Outliers aggregate name.

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => series.BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper)
                             .Aggregate(
                                ChartSeriesAggregate.Max,
                                ChartSeriesAggregate.Max,
                                ChartSeriesAggregate.Max,
                                ChartSeriesAggregate.Max,
                                ChartSeriesAggregate.Max,
                                ChartSeriesAggregate.Max,
                                ChartSeriesAggregate.Max,
                                ChartSeriesAggregate.First
                              )
                        )
            )

Gap(System.Double)

Set 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

Parameters

gap - System.Double

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper).Gap(1.5))
            )

Spacing(System.Double)

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

Parameters

spacing - System.Double

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

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper).Spacing(1))
            )

Border(System.Int32,System.String,Kendo.Mvc.UI.ChartDashType)

Sets the points border

Parameters

width - System.Int32

The points border width.

color - System.String

The points border color (CSS syntax).

dashType - ChartDashType

The points border dash type.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper).Border("1", "#000", ChartDashType.Dot))
                      .Render();
            )

Line(System.Int32,System.String,Kendo.Mvc.UI.ChartDashType)

Configures the ohlc chart lines.

Parameters

width - System.Int32

The lines width.

color - System.String

The lines color.

dashType - ChartDashType

The lines dashType.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series
                          .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper)        
                          .Line(2, "red", ChartDashType.Dot)
                      )
            )

Line(System.Int32)

Configures the ohlc line width.

Parameters

width - System.Int32

The lines width.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series
                          .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper)        
                          .Line(2)
                      )
            )

Line(System.Int32,System.String)

Configures the ohlc lines.

Parameters

width - System.Int32

The lines width.

color - System.String

The lines color.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series
                          .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper)        
                          .Line(2, "red")
                      )
            )

Line(System.Action)

Configures the ohlc chart lines.

Parameters

configurator - System.Action<ChartLineBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series
                          .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper)        
                          .Line(line => line.Opacity(0.2))
                      )
            )

Outliers(System.Action)

Configures the box plot chart outliers.

Parameters

configurator - System.Action<ChartMarkersBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper)    
                           .Outliers(outliers => outliers
                               .Type(ChartMarkerShape.Triangle)
                           )
                       )
            )

Outliers(System.Boolean)

Sets the visibility of box plot chart outliers.

Parameters

visible - System.Boolean

The visibility. The default value is true.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper) 
                           .Outliers(true);
                       )
            )

Extremum(System.Action)

Configures the box plot chart extremum.

Parameters

configurator - System.Action<ChartMarkersBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper)    
                           .Extremum(extremum => extremum
                               .Type(ChartMarkerShape.Triangle)
                           )
                       )
            )

Extremum(System.Boolean)

Sets the visibility of box plot chart extremum.

Parameters

visible - System.Boolean

The visibility. The default value is true.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .BoxPlot(s => s.Lower, s => s.Q1, s => s.Median, s => s.Q3, s => s.Upper) 
                           .Extremum(true)
                       )
            )

CategoryField(System.String)

Sets the category field for the series

Parameters

categoryField - System.String

The category field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").CategoryField("Category"))
            )

ColorField(System.String)

Sets the color field for the series

Parameters

colorField - System.String

The color field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").ColorField("Color"))
            )

NoteTextField(System.String)

Sets the note text field for the series

Parameters

noteTextField - System.String

The note text field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").NoteTextField("NoteText"))
            )

LowerField(System.String)

Sets the lower field for the series

Parameters

lowerField - System.String

The lower field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Bar(Model.Records).Field("Value").LowerField("Lower"))
            )

Q1Field(System.String)

Sets the q1 field for the series

Parameters

q1Field - System.String

The q1 field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").Q1Field("Q1"))
            )

MedianField(System.String)

Sets the median field for the series

Parameters

medianField - System.String

The median field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").MedianField("Median"))
            )

Q3Field(System.String)

Sets the q3 field for the series

Parameters

q3Field - System.String

The q3 field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").Q3Field("Q3"))
            )

UpperField(System.String)

Sets the upper field for the series

Parameters

upperField - System.String

The upper field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").UpperField("Upper"))
            )

MeanField(System.String)

Sets the mean field for the series

Parameters

meanField - System.String

The mean field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").MeanField("Mean"))
            )

OutliersField(System.String)

Sets the outliers field for the series

Parameters

outliersField - System.String

The outliers field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.BoxPlot(Model.Records).Field("Value").OutliersField("Outliers"))
            )

Name(System.String)

Sets the series title displayed in the legend.

Parameters

text - System.String

The title.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Name("Sales"))
            )

GroupNameTemplate(System.String)

Sets the name template for auto-generated series when binding to grouped data.

Parameters

groupNameTemplate - System.String

The name template for auto-generated series when binding to grouped data.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .DataSource(dataSource => dataSource
                           .Read(read => read.Action("_StockData", "Scatter_Charts"))
                           .Group(group => group.Add(model => model.Symbol))
                       )
                       .Series(series => series.Bar(s => s.Sales)
                            .Name("Sales")
                            .GroupNameTemplate("#= series.name # for #= group.field # #= group.value #")
                       )
            )

Opacity(System.Double)

Sets the series opacity.

Parameters

opacity - System.Double

The series opacity in the range from 0 (transparent) to 1 (opaque). The default value is 1.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Opacity(0.5))
            )

Color(System.String)

Sets the bar fill color

Parameters

color - System.String

The bar fill color (CSS syntax).

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Color("Red"))
            )

Color(System.Func)

Sets the function used to retrieve point color.

Parameters

colorFunction - System.Func<Object,Object>

The JavaScript function that will be executed to retrieve the color of each point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .Color(
                               @<text>
                               function(point) {
                                   return point.value > 5 ? "red" : "green";
                               }
                               </text>
                           )
                        )
            )

ColorHandler(System.Func)

Sets the function used to retrieve point color.

Parameters

colorFunction - System.Func<Object,Object>

The JavaScript function that will be executed to retrieve the color of each point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .ColorHandler(
                               @<text>
                               function(point) {
                                   return point.value > 5 ? "red" : "green";
                               }
                               </text>
                           )
                        )
            )

ColorHandler(System.String)

Sets the function used to retrieve point color.

Parameters

colorFunction - System.String

The JavaScript function that will be executed to retrieve the color of each point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .ColorHandler("pointColor")
                        )
            )

Tooltip(System.Action)

Configure the data point tooltip for the series.

Parameters

configurator - System.Action<ChartTooltipBuilder>

Use the configurator to set data tooltip options.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales)
                           .Tooltip(tooltip =>
                           {
                               tooltip.Visible(true).Format("{0:C}");
                           })
                       )
            )

Tooltip(System.Boolean)

Sets the data point tooltip visibility.

Parameters

visible - System.Boolean

A value indicating if the data point tooltip should be displayed. The tooltip is not visible by default.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Tooltip(true))
            )

Axis(System.String)

Sets the axis name to use for this series.

Parameters

axis - System.String

The axis name for this series.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Name("Sales").Axis("secondary"))
                       .ValueAxis(axis => axis.Numeric())
                       .ValueAxis(axis => axis.Numeric("secondary"))
                       .CategoryAxis(axis => axis.AxisCrossingValue(0, 10))
            )

CategoryAxis(System.String)

Sets the axis name to use for this series.

Parameters

categoryAxis - System.String

The category axis name for this series.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Name("Sales").CategoryAxis("catAxis"))
                       .CategoryAxis(axis => axis.Name("catAxis"))
            )

Highlight(System.Action)

Configures the series highlight

Parameters

configurator - System.Action<ChartSeriesHighlightBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Pie(s => s.Sales, s => s.DateString)
                            .Highlight(highlight => highlight.Color("yellow"))
                      )
            )

Highlight(System.Boolean)

Configures the highlight visibility

Parameters

visible - System.Boolean

The highlight visibility.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Pie(s => s.Sales, s => s.DateString)
                            .Highlight(false)
                      )
            )

Visible(System.Boolean)

Sets the labels visibility

Parameters

visible - System.Boolean

The labels visibility.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Bar(s => s.Sales).Visible(false))
            )

VisibleInLegend(System.Boolean)

Sets the labels visibility in the legend

Parameters

visible - System.Boolean

The series visibility in the legend.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Bar(s => s.Sales).VisibleInLegend(false))
            )

Notes(System.Action)

Configures the series notes

Parameters

configurator - System.Action<ChartNoteBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series
                            .Bar(s => s.Sales).Notes(notes => notes.Position(ChartNotePosition.Right))
                       )
            )

Aggregate(System.Func)

Sets the function used to retrieve point color.

Parameters

aggregateFunction - System.Func<Object,Object>

The JavaScript function that will be executed to retrieve the value of each aggregated point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .Aggregate(
                               @<text>
                               function(values) {
                                   return values[0];
                               }
                               </text>
                           )
                        )
            )

Aggregate(System.String)

Sets the function used to retrieve point color.

Parameters

aggregateFunction - System.String

The JavaScript function that will be executed to retrieve the value of each aggregated point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .Aggregate("myAggregate")
                        )
            )
            <script>
            function myAggregate(values) {
                return values[0];
            }
            </script>

ZIndex(System.Double)

Sets the series stacking order relative to other series.

Parameters

zIndex - System.Double

The stacking order of series, relative to other 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.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => {
                            series.Area(s => s.Sales).ZIndex(2);
                            series.Column(s => s.Price).ZIndex(1);
                       })
            )

Median(System.Action)

The configuration of the Box Plot median value indicator (line).

Parameters

configurator - System.Action<ChartSeriesMedianBuilder>

The configurator for the median setting.

Mean(System.Action)

The configuration of the Box Plot mean value indicator (line).

Parameters

configurator - System.Action<ChartSeriesMeanBuilder>

The configurator for the mean setting.