ChartRangeAreaSeriesBuilder
Properties
Series - IChartRangeAreaSeries
Gets the data from member of the series.
Methods
Aggregate(Kendo.Mvc.UI.ChartSeriesAggregate)
Sets the aggregate function for Range Area series. This function is used when a category (an year, month, etc.) contains two or more points.
Parameters
aggregate - ChartSeriesAggregate
Aggregate function name.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.RangeArea(f => f.FromSales, t => t.ToSales).Aggregate(ChartSeriesAggregate.Avg))
)
Line(System.Int32,System.String,Kendo.Mvc.UI.ChartDashType,Kendo.Mvc.UI.ChartAreaStyle)
Configures the range area chart line.
Parameters
width - System.Int32
The line width.
color - System.String
The line color.
dashType - ChartDashType
The line dashType.
style - ChartAreaStyle
The line style.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.RangeArea(f => f.From, t => t.To)
.Line(2, "red", ChartDashType.Dot, ChartAreaStyle.Smooth)
)
)
Line(System.Action)
Configures the range area chart line.
Parameters
configurator - System.Action<ChartAreaLineBuilder>
The configuration action.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.RangeArea(f => f.From, t => t.To)
.Line(line => line.Opacity(0.2))
)
)
Labels(System.Action)
Configures the range area chart labels.
Parameters
configurator - System.Action<ChartRangeAreaLabelsBuilder>
The configuration action.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.RangeArea(f => f.From, t => t.To)
.Labels(labels => labels
.Visible(true)
)
)
)
Labels(System.Boolean)
Sets the visibility of range area chart labels.
Parameters
visible - System.Boolean
The visibility. The default value is false.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.RangeArea(f => f.From, t => t.To)
.Labels(true);
)
)
Markers(System.Action)
Configures the range area chart markers.
Parameters
configurator - System.Action<ChartRangeAreaMarkersBuilder>
The configuration action.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.RangeArea(f => f.From, t => t.To)
.Markers(markers => markers
.Type(ChartMarkerShape.Triangle)
)
)
)
Markers(System.Boolean)
Sets the visibility of range area chart markers.
Parameters
visible - System.Boolean
The visibility. The default value is false.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.RangeArea(f => f.From, t => t.To)
.Markers(true);
)
)
MissingValues(Kendo.Mvc.UI.ChartAreaMissingValues)
Configures the behavior for handling missing values in range area series.
Parameters
missingValues - ChartAreaMissingValues
The missing values behavior. The default is to interpolate the points.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.RangeArea(f => f.From, t => t.To)
.MissingValues(ChartAreaMissingValues.Interpolate);
)
)
FromField(System.String)
Sets the from field for the series
Parameters
field - System.String
The from field for the series
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series.RangeArea(Model.Records).FromField("From").ToField("To"))
)
ToField(System.String)
Sets the to field for the series
Parameters
field - System.String
The to field for the series
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series.RangeArea(Model.Records).FromField("From").ToField("To"))
)
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.RangeArea(Model.Records).FromField("From").ToField("To").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.Area(Model.Records).Field("Value").ColorField("Color"))
)
Name(System.String)
Sets the series title displayed in the legend.
Parameters
text - System.String
The value that sets the title.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Name("Sales"))
)
Opacity(System.Double)
Sets the series opacity.
Parameters
opacity - System.Double
The value that sets 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 value that configures the bar fill color (CSS syntax).
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Color("#aa00bb"))
)
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 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 value that sets 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 value that sets 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>
Use the configurator to set highlight options.
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 value that sets 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 value that sets 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 value that configures 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>
Use the configurator to set notes options.
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>
Use the configurator to set median options.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => {
series.Area(s => s.Sales).Median(m => {
m.Color("red");
});
series.Column(s => s.Price).Median(m => {
m.Color("red");
});
})
)
Mean(System.Action)
The configuration of the Box Plot mean value indicator (line).
Parameters
configurator - System.Action<ChartSeriesMeanBuilder>
Use the configurator to set mean options.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => {
series.Area(s => s.Sales).Mean(m => {
m.Color("red");
});
series.Column(s => s.Price).Mean(m => {
m.Color("red");
});
})
)
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 that sets the DrilldownField
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => {
series.Area(s => s.Sales).DrilldownField("details");
})
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.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => {
series.Area(s => s.Sales).DrilldownSeriesFactory("drilldownByModel");
})
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.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => {
series
.Area(s => s.Sales)
.DrilldownSeriesFactory(
@<text>
function (e) {
//event handler code
}
</text>
);
})
LegendItem(System.Action)
The chart series legend configuration options.
Parameters
configurator - System.Action<ChartSeriesLegendItemSettingsBuilder>
Use the configurator to set series legend options.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => {
series
.Area(s => s.Sales)
.LegendItem(l => l.Type("area"))
})
Pattern(System.Action)
The chart series pattern configuration options.
Parameters
configurator - System.Action<ChartSeriesPatternSettingsBuilder>
The configurator for the Pattern setting.