New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ChartBarSeriesBuilderBase<TSeries, TSeriesBuilder>

Class

Defines the fluent interface for configuring Bar series.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TSeries

TSeriesBuilder

Syntax:

public class ChartBarSeriesBuilderBase<TSeries, TSeriesBuilder> : ChartSeriesBuilderBase<TSeries, TSeriesBuilder> where TSeries : IBarSeries where TSeriesBuilder : ChartBarSeriesBuilderBase<TSeries, TSeriesBuilder>

Inheritance: objectChartSeriesBuilderBase<TSeries, TSeriesBuilder>ChartBarSeriesBuilderBase<TSeries, TSeriesBuilder>

Derived Classes: ChartBarSeriesBuilder<T>ChartRadarColumnSeriesBuilder<T>ChartRangeBarSeriesBuilder<T>ChartWaterfallSeriesBuilder<T>

Constructors

ChartBarSeriesBuilderBase(TSeries)

Initializes a new instance of the ChartBarSeriesBuilderBase<TSeries, TSeriesBuilder> class.

public ChartBarSeriesBuilderBase(TSeries series)

Parameters:seriesTSeries

The series.

Methods

Aggregate(ChartSeriesAggregate)

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

public virtual TSeriesBuilder Aggregate(ChartSeriesAggregate aggregate)

Parameters:aggregateChartSeriesAggregate

The aggregate function name.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("chart")
.Series(series =&gt; series.Bar(model =&gt; model.Value, model =&gt; model.Date).Aggregate(ChartSeriesAggregate.Avg))
)

Border(Action<ChartBorderBuilder>)

Configures the border of the series.

public TSeriesBuilder Border(Action<ChartBorderBuilder> configurator)

Parameters:configuratorAction<ChartBorderBuilder>

The action that configures the border settings.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Border(b =&gt; b.Width(1).Color("green")))
)

Border(int, string, ChartDashType)

Sets the border of the chart series.

public TSeriesBuilder Border(int width, string color, ChartDashType dashType)

Parameters:widthint

The border width.

colorstring

The border color (CSS syntax).

dashTypeChartDashType

The border dash type.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Border(1, "#000", ChartDashType.Dot))
)

CategoryField(string)

Sets the Model property that holds the category name or date.

public TSeriesBuilder CategoryField(string categoryField)

Parameters:categoryFieldstring

The name of the Model property.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Field("Total").CategoryField("Year"))
)

ColorField(string)

Sets the Model property that holds the series color.

public TSeriesBuilder ColorField(string colorField)

Parameters:colorFieldstring

The name of the Model property.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).ColorField("AppliedColor"))
)

Field(string)

Sets the Model property that holds the series value.

public TSeriesBuilder Field(string field)

Parameters:fieldstring

The name of the Model property.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Field("Total"))
)

Gap(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

public TSeriesBuilder Gap(double gap)

Parameters:gapdoubleReturns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Gap(1))
)

Labels(Action<ChartBarLabelsBuilder>)

Configures the Bar Chart labels.

public virtual TSeriesBuilder Labels(Action<ChartBarLabelsBuilder> configurator)

Parameters:configuratorAction<ChartBarLabelsBuilder>

The action that configures the labels settings.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series
.Bar(s =&gt; s.Sales)
.Labels(labels =&gt; labels
.Position(ChartBarLabelsPosition.InsideEnd)
.Visible(true)
)
)
)

Labels(bool)

Sets the visibility of Bar Chart labels.

public virtual TSeriesBuilder Labels(bool visible)

Parameters:visiblebool

The value that sets the visibility of the labels.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series
.Bar(s =&gt; s.Sales)
.Labels(true)
)
)

NegativeColor(string)

Sets the bar color for negative values.

public TSeriesBuilder NegativeColor(string color)

Parameters:colorstring

The color value (CSS syntax).

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).NegativeColor("red"))
)

NoteTextField(string)

Sets the Model property that holds the series note text.

public TSeriesBuilder NoteTextField(string noteTextField)

Parameters:noteTextFieldstring

The name of the Model property.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Field("Total").NoteTextField("NoteText"))
)

Overlay(ChartBarSeriesOverlay)

Sets the series effects overlay.

public TSeriesBuilder Overlay(ChartBarSeriesOverlay overlay)

Parameters:overlayChartBarSeriesOverlay

The enum value that sets the overlay. The default is ChartBarSeriesOverlay.Glass

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Overlay(ChartBarSeriesOverlay.None))
)

Spacing(double)

Sets a value indicating the distance between series points within a category.

public TSeriesBuilder Spacing(double spacing)

Parameters:spacingdouble

Value of 1 means that the distance between bars is equal to their width. The default value is 0

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; series.Spacing(s =&gt; s.Sales).Spacing(1))
)

Stack(bool)

Indicates if the series must be stacked.

public virtual TSeriesBuilder Stack(bool stacked)

Parameters:stackedbool

A value that enables/disables the Stack option.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Stack(true))
)

Stack(ChartStackType, string)

Configures the stack that the series belongs to.

public virtual TSeriesBuilder Stack(ChartStackType stackType, string stackGroup = null)

Parameters:stackTypeChartStackType

The stack type.

stackGroupstring

The name of the stack group.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Stack(ChartStackType.Stack100, "Female"))
)

Stack(string)

Sets the name of the stack that this series belongs to. Each unique name creates a new stack.

public virtual TSeriesBuilder Stack(string stackGroup)

Parameters:stackGroupstring

The name of the stack group.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Stack("Female"))
)

Visual(Func<object, object>)

Sets a handler that creates a custom visual for the points.

public TSeriesBuilder Visual(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag (Razor syntax).

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(new double[] { 52000, 34000, 23000, 48000, 67000, 83000 }).Name("Unique visitors").Visual(
@&lt;text&gt;
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;
}
&lt;/text&gt;
);
})
)

Visual(string)

Sets a JavaScript function that creates a custom visual for the points.

public TSeriesBuilder Visual(string handler)

Parameters:handlerstring

The name of the JavaScript function.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Field("Total").Visual("getSeriesVisual"))
)

Whiskers(Action<ChartSeriesWhiskersSettingsBuilder>)

Defines the whiskers configuration of the chart series.

public TSeriesBuilder Whiskers(Action<ChartSeriesWhiskersSettingsBuilder> configurator)

Parameters:configuratorAction<ChartSeriesWhiskersSettingsBuilder>

The action that configures the whiskers settings.

Returns:

TSeriesBuilder

Example:

@(Html.Kendo().Chart&lt;ChartViewModel&gt;()
.Name("Chart")
.Series(series =&gt; series.Bar(s =&gt; s.Sales).Whiskers(w =&gt; w.Color("#0000FF")))
)