Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / ChartHeatMapSeriesBuilder<T>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

ChartHeatMapSeriesBuilder<T>

Class

A fluent builder for configuring chart heat map series.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

T

The type of the data model.

Syntax:
C#
public class ChartHeatMapSeriesBuilder<T> where T : class

Inheritance: objectChartHeatMapSeriesBuilder<T>

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

Constructors

ChartHeatMapSeriesBuilder(IHeatMapSeries)

C#
public ChartHeatMapSeriesBuilder(IHeatMapSeries series)
Parameters:seriesIHeatMapSeries

Properties

Series

Gets or sets the series.

C#
public IHeatMapSeries Series { get; }
Property Value:

The series.

Methods

Color(string)

Sets the color.

C#
public ChartHeatMapSeriesBuilder<T> Color(string value)
Parameters:valuestringReturns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }).Color("green"); })
)

ColorHandler(string)

Sets the color handler.

C#
public ChartHeatMapSeriesBuilder<T> ColorHandler(string value)
Parameters:valuestring

The name of a function handler for the color of the series.

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }).ColorHandler("colorHandler"); })
)

Field(string)

Sets the yField.

C#
public ChartHeatMapSeriesBuilder<T> Field(string value)
Parameters:valuestring

The field that will be set as an Field.

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }).Field("Field"); })
)

Labels(Action<ChartHeatMapLabelsBuilder>)

Configures the heatmap chart labels.

C#
public ChartHeatMapSeriesBuilder<T> Labels(Action<ChartHeatMapLabelsBuilder> configurator)
Parameters:configuratorAction<ChartHeatMapLabelsBuilder>

The configuration action.

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }).Labels(l =&gt; l.Color("green")); })
)

Markers(Action<ChartMarkersBuilder>)

Configures the heatmap chart markers.

C#
public ChartHeatMapSeriesBuilder<T> Markers(Action<ChartMarkersBuilder> configurator)
Parameters:configuratorAction<ChartMarkersBuilder>

The configuration action.

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }).Markers(m =&gt; m.Background("green")); })
)

Name(string)

Sets the name of the series.

C#
public ChartHeatMapSeriesBuilder<T> Name(string text)
Parameters:textstring

The name of the series

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } });}).Name("seriesName"))
)

Opacity(double)

Sets the opacity of the series.

C#
public ChartHeatMapSeriesBuilder<T> Opacity(double opacity)
Parameters:opacitydoubleReturns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } });}).Name("seriesName"))
)

Pattern(Action<ChartSeriesPatternSettingsBuilder>)

The chart series pattern configuration options.

C#
public ChartHeatMapSeriesBuilder<T> Pattern(Action<ChartSeriesPatternSettingsBuilder> configurator)
Parameters:configuratorAction<ChartSeriesPatternSettingsBuilder>

The configurator for the Pattern setting.

Returns:

ChartHeatMapSeriesBuilder<T>

PatternField(string)

Sets the data item field which contains the series pattern configuration for individual chart segments.

C#
public ChartHeatMapSeriesBuilder<T> PatternField(string value)
Parameters:valuestring

The data item field which contains the series pattern configuration for individual chart segments

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart(Model)
.Name("Chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } });}).PatternField("Pattern"))
)

Tooltip(Action<ChartTooltipBuilder>)

Configure the series tooltip.

C#
public ChartHeatMapSeriesBuilder<T> Tooltip(Action<ChartTooltipBuilder> configurator)
Parameters:configuratorAction<ChartTooltipBuilder>

The configurator settings for the series tooltip

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } });}).Tooltip(t =&gt; t.Color("green"))
)

Tooltip(bool)

Sets the tooltip visibility.

C#
public ChartHeatMapSeriesBuilder<T> Tooltip(bool visible)
Parameters:visiblebool

A value indicating if the tooltip should be displayed.

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }); }).Tooltip(true)
)

xField(string)

Sets the xField.

C#
public ChartHeatMapSeriesBuilder<T> xField(string value)
Parameters:valuestring

The field that will be set as an xField.

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }).xField("xField"); })
)

yField(string)

Sets the yField.

C#
public ChartHeatMapSeriesBuilder<T> yField(string value)
Parameters:valuestring

The field that will be set as an yField.

Returns:

ChartHeatMapSeriesBuilder<T>

Example:
C#
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt; { series.HeatMap(new object[] { new { Week = 1, Day = "Mon", Value = 8 } }).yField("yField"); })
)
In this article
DefinitionConstructorsChartHeatMapSeriesBuilder(IHeatMapSeries)PropertiesSeriesMethodsColor(string)ColorHandler(string)Field(string)Labels(Action<ChartHeatMapLabelsBuilder>)Markers(Action<ChartMarkersBuilder>)Name(string)Opacity(double)Pattern(Action<ChartSeriesPatternSettingsBuilder>)PatternField(string)Tooltip(Action<ChartTooltipBuilder>)Tooltip(bool)xField(string)yField(string)
Not finding the help you need?
Contact Support