ChartWaterfallSeriesBuilder
Properties
Series - IWaterfallSeries
The series line configuration.
Methods
Aggregate(Kendo.Mvc.UI.ChartSeriesAggregate)
Sets the aggregate function for Waterfall 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.Waterfall(model => model.Amount,
model => model.Period,
model => model.Summary)
.Aggregate(ChartSeriesAggregate.Avg))
)
Line(System.Int32,System.String,Kendo.Mvc.UI.ChartDashType)
Configures the series 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
.Waterfall(new int[] { 180, -60, -20, 10, 30 })
.Line(2, "red", ChartDashType.Dot)
)
)
Line(System.Int32)
Configures the series lines width.
Parameters
width - System.Int32
The lines width.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.Waterfall(new int[] { 180, -60, -20, 10, 30 })
.Line(2)
)
)
Line(System.Int32,System.String)
Configures the series lines.
Parameters
width - System.Int32
The lines width.
color - System.String
The lines color.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.Waterfall(new int[] { 180, -60, -20, 10, 30 })
.Line(2, "red")
)
)
Line(System.Action)
Configures the series lines.
Parameters
configurator - System.Action<ChartLineBuilder>
The configuration action.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Series(series => series
.Waterfall(new int[] { 180, -60, -20, 10, 30 })
.Line(line => line.Color("#00ff00"))
)
)
Stack(System.Boolean)
Sets a value indicating if the series should be stacked.
Parameters
stacked - System.Boolean
A value indicating if the series should be stacked.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.Waterfall(model => model.Amount,
model => model.Period,
model => model.Summary)
.Stack(true))
)
Stack(Kendo.Mvc.UI.ChartStackType,System.String)
Sets the type of stacking to use in the seris.
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.Waterfall(model => model.Amount,
model => model.Period,
model => model.Summary)
.Stack(ChartStackType.Stack100))
)
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.Waterfall(model => model.Amount,
model => model.Period,
model => model.Summary)
.Stack("stack1"))
)
Gap(System.Double)
Sets the distance between category clusters. A value of 1 means that there is a total of 1 column width / bar height between categories. The distance is distributed evenly on each side. The default value is 1.5
Parameters
gap - System.Double
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Gap(1))
)
Spacing(System.Double)
Sets a value indicating the distance between series points within a category.
Parameters
spacing - System.Double
Value of 1 means that the distance between bars is equal to their width. The default value is 0
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series.Spacing(s => s.Sales).Spacing(1))
)
Labels(System.Action)
Configures the Bar Chart labels.
Parameters
configurator - System.Action<ChartBarLabelsBuilder>
The action that configures the labels settings.
Example
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series => series
.Bar(s => s.Sales)
.Labels(labels => labels
.Position(ChartBarLabelsPosition.InsideEnd)
.Visible(true)
)
)
)
Labels(System.Boolean)
Sets the visibility of Bar Chart labels.
Parameters
visible - System.Boolean
The value that sets the visibility of the labels.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series
.Bar(s => s.Sales)
.Labels(true)
)
)
Border(System.Int32,System.String,Kendo.Mvc.UI.ChartDashType)
Sets the border of the chart series.
Parameters
width - System.Int32
The border width.
color - System.String
The border color (CSS syntax).
dashType - ChartDashType
The border dash type.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Border(1, "#000", ChartDashType.Dot))
)
Border(System.Action)
Configures the border of the series.
Parameters
configurator - System.Action<ChartBorderBuilder>
The action that configures the border settings.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Border(b => b.Width(1).Color("green")))
)
Overlay(Kendo.Mvc.UI.ChartBarSeriesOverlay)
Sets the series effects overlay.
Parameters
overlay - ChartBarSeriesOverlay
The enum value that sets the overlay. The default is ChartBarSeriesOverlay.Glass
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Overlay(ChartBarSeriesOverlay.None))
)
NegativeColor(System.String)
Sets the bar color for negative values.
Parameters
color - System.String
The color value (CSS syntax).
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).NegativeColor("red"))
)
Field(System.String)
Sets the Model property that holds the series value.
Parameters
field - System.String
The name of the Model property.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Field("Total"))
)
CategoryField(System.String)
Sets the Model property that holds the category name or date.
Parameters
categoryField - System.String
The name of the Model property.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Field("Total").CategoryField("Year"))
)
ColorField(System.String)
Sets the Model property that holds the series color.
Parameters
colorField - System.String
The name of the Model property.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).ColorField("AppliedColor"))
)
NoteTextField(System.String)
Sets the Model property that holds the series note text.
Parameters
noteTextField - System.String
The name of the Model property.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Field("Total").NoteTextField("NoteText"))
)
Visual(System.String)
Sets a JavaScript function that creates a custom visual for the points.
Parameters
handler - System.String
The name of the JavaScript function.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Field("Total").Visual("getSeriesVisual"))
)
Visual(System.Func)
Sets a handler that creates a custom visual for the points.
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag (Razor syntax).
Example
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =>
{
series.Column(new double[] { 52000, 34000, 23000, 48000, 67000, 83000 }).Name("Unique visitors").Visual(
@<text>
function(e) {
var origin = e.rect.origin;
var center = e.rect.center();
var bottomRight = e.rect.bottomRight();
var path = new kendo.drawing.Path({
fill: {
color: e.options.color
}
})
.moveTo(origin.x, bottomRight.y)
.lineTo(bottomRight.x, bottomRight.y)
.lineTo(center.x, origin.y)
.close();
return path;
}
</text>
);
})
)
Whiskers(System.Action)
Defines the whiskers configuration of the chart series.
Parameters
configurator - System.Action<ChartSeriesWhiskersSettingsBuilder>
The action that configures the whiskers settings.
Example
@(Html.Kendo().Chart<ChartViewModel>()
.Name("Chart")
.Series(series => series.Bar(s => s.Sales).Whiskers(w => w.Color("#0000FF")))
)
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.