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

ChartSeriesLabelsToSettingsBuilder

Class

Defines the fluent API for configuring ChartSeriesLabelsToSettings

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ChartSeriesLabelsToSettingsBuilder

Inheritance: objectChartSeriesLabelsToSettingsBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

ChartSeriesLabelsToSettingsBuilder(ChartSeriesLabelsToSettings)

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

public ChartSeriesLabelsToSettingsBuilder(ChartSeriesLabelsToSettings container)

Parameters:containerChartSeriesLabelsToSettings

The ChartSeriesLabelsToSettings<T> container

Properties

Container

ChartSeriesLabelsToSettings

Gets the ChartSeriesLabelsToSettings<T> container.

protected ChartSeriesLabelsToSettings Container { get; }

Methods

Background(string)

The background color of the to labels. Accepts a valid CSS color string, including hex and rgb.

public ChartSeriesLabelsToSettingsBuilder Background(string value)

Parameters:valuestring

The value for Background

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Background("green")
)
)
)
)

BackgroundHandler(Func<object, object>)

The background color of the to labels. Accepts a valid CSS color string, including hex and rgb.

public ChartSeriesLabelsToSettingsBuilder BackgroundHandler(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.BackgroundHandler(
@&lt;text&gt;
function(e) {
// event handler code
}
&lt;/text&gt;
)
)
)
)
)

BackgroundHandler(string)

The background color of the to labels. Accepts a valid CSS color string, including hex and rgb.

public ChartSeriesLabelsToSettingsBuilder BackgroundHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.BackgroundHandler("backgroundHandler")
)
)
)
)

Border(Action<ChartSeriesLabelsToBorderSettingsBuilder>)

The border of the to labels.

public ChartSeriesLabelsToSettingsBuilder Border(Action<ChartSeriesLabelsToBorderSettingsBuilder> configurator)

Parameters:configuratorAction<ChartSeriesLabelsToBorderSettingsBuilder>

The configurator for the border setting.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Border(b =&gt; b
.Color("red")
)
)
)
)
)

Color(string)

The text color of the to labels. Accepts a valid CSS color string, including hex and rgb.

public ChartSeriesLabelsToSettingsBuilder Color(string value)

Parameters:valuestring

The value for Color

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Color("red")
)
)
)
)

ColorHandler(Func<object, object>)

The text color of the to labels. Accepts a valid CSS color string, including hex and rgb.

public ChartSeriesLabelsToSettingsBuilder ColorHandler(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.ColorHandler(
@&lt;text&gt;
function(e) {
// event handler code
}
&lt;/text&gt;
)
)
)
)
)

ColorHandler(string)

The text color of the to labels. Accepts a valid CSS color string, including hex and rgb.

public ChartSeriesLabelsToSettingsBuilder ColorHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.ColorHandler("colorHandler")
)
)
)
)

Font(string)

The font style of the to labels.

public ChartSeriesLabelsToSettingsBuilder Font(string value)

Parameters:valuestring

The value for Font

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Font("14px Arial,Helvetica,sans-serif")
)
)
)
)

FontHandler(Func<object, object>)

The font style of the to labels.

public ChartSeriesLabelsToSettingsBuilder FontHandler(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.FontHandler(
@&lt;text&gt;
function(e) {
// event handler code
}
&lt;/text&gt;
)
)
)
)
)

FontHandler(string)

The font style of the to labels.

public ChartSeriesLabelsToSettingsBuilder FontHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.FontHandler("fontHandler")
)
)
)
)

Format(string)

The format of the to labels. Uses kendo.format.

public ChartSeriesLabelsToSettingsBuilder Format(string value)

Parameters:valuestring

The value for Format

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Format("{0:C}")
)
)
)
)

FormatHandler(Func<object, object>)

The format of the to labels. Uses kendo.format.

public ChartSeriesLabelsToSettingsBuilder FormatHandler(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.FormatHandler(
@&lt;text&gt;
function(e) {
// event handler code
}
&lt;/text&gt;
)
)
)
)
)

FormatHandler(string)

The format of the to labels. Uses kendo.format.

public ChartSeriesLabelsToSettingsBuilder FormatHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Format("formatHandler")
)
)
)
)

Margin(Action<ChartSeriesLabelsToMarginSettingsBuilder>)

The margin of the to labels. A numeric value will set all margins.

public ChartSeriesLabelsToSettingsBuilder Margin(Action<ChartSeriesLabelsToMarginSettingsBuilder> configurator)

Parameters:configuratorAction<ChartSeriesLabelsToMarginSettingsBuilder>

The configurator for the margin setting.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Margin(m =&gt; m
.Bottom(10)
)
)
)
)
)

Padding(Action<ChartSeriesLabelsToPaddingSettingsBuilder>)

The padding of the to labels. A numeric value will set all paddings.

public ChartSeriesLabelsToSettingsBuilder Padding(Action<ChartSeriesLabelsToPaddingSettingsBuilder> configurator)

Parameters:configuratorAction<ChartSeriesLabelsToPaddingSettingsBuilder>

The configurator for the padding setting.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Padding(p =&gt; p
.Top(10)
)
)
)
)
)

Position(ChartSeriesLabelsPosition)

Specifies the position of the "to" labels.

public ChartSeriesLabelsToSettingsBuilder Position(ChartSeriesLabelsPosition value)

Parameters:valueChartSeriesLabelsPosition

The value for Position

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Position(ChartSeriesLabelsPosition.Above)
)
)
)
)

The template which renders the chart series to label.The fields which can be used in the template are: category - the category name.; dataItem - the original data item used to construct the point. Will be null if binding to array.; series - the data series or value - the point value. An object containing from and to values..

public ChartSeriesLabelsToSettingsBuilder Template(string value)

Parameters:valuestring

The value for Template

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Template("#=FromSales#")
)
)
)
)

Template<TModel>(TemplateBuilder<TModel>)

public ChartSeriesLabelsToSettingsBuilder Template<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Template("template")
)
)
)
)

TemplateHandler(string)

public ChartSeriesLabelsToSettingsBuilder TemplateHandler(string templateHandler)

Parameters:templateHandlerstring

The handler that returs the template for Template

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.TemplateHandler("templateHandler")
)
)
)
)

TemplateId(string)

public ChartSeriesLabelsToSettingsBuilder TemplateId(string templateId)

Parameters:templateIdstring

The ID of the template element for Template

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.TemplateId("templateId")
)
)
)
)

TemplateView(MvcHtmlString)

public ChartSeriesLabelsToSettingsBuilder TemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlStringReturns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.TemplateView(new MvcHtmlString("#= FromSales #"))
)
)
)
)

Visible(bool)

If set to true the chart will display the series to labels. By default chart series to labels are not displayed.

public ChartSeriesLabelsToSettingsBuilder Visible(bool value)

Parameters:valuebool

The value for Visible

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.Visible("true")
)
)
)
)

VisibleHandler(Func<object, object>)

If set to true the chart will display the series to labels. By default chart series to labels are not displayed.

public ChartSeriesLabelsToSettingsBuilder VisibleHandler(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.VisibleHandler(
@&lt;text&gt;
function(e) {
// event handler code
}
&lt;/text&gt;
)
)
)
)
)

VisibleHandler(string)

If set to true the chart will display the series to labels. By default chart series to labels are not displayed.

public ChartSeriesLabelsToSettingsBuilder VisibleHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLabelsToSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series
.RangeArea(
m =&gt; m.FromSales,
m =&gt; m.ToSales
)
.Labels(l =&gt; l
.To(t =&gt; t
.VisibleHandler("visibleHandler")
)
)
)
)