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

ChartSeriesHighlightBuilder

Class

Defines the fluent interface for configuring series highlight.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ChartSeriesHighlightBuilder

Inheritance: objectChartSeriesHighlightBuilder

Derived Classes: ChartBubbleSeriesHighlightBuilderChartCandlestickSeriesHighlightBuilderChartLineSeriesHighlightBuilderChartPieSeriesHighlightBuilder

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

Constructors

ChartSeriesHighlightBuilder(ChartSeriesHighlight)

Initializes a new instance of the ChartSeriesHighlightBuilder class.

public ChartSeriesHighlightBuilder(ChartSeriesHighlight highlight)

Parameters:highlightChartSeriesHighlight

The series highlight.

Properties

Highlight

ChartSeriesHighlight

Gets or sets the highlight

protected ChartSeriesHighlight Highlight { get; set; }

Methods

InactiveOpacity(double)

The opacity of the series when another series is highlighted.

public ChartSeriesHighlightBuilder InactiveOpacity(double value)

Parameters:valuedouble

The value for InactiveOpacity

Returns:

ChartSeriesHighlightBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.Pie(s =&gt; s.Sales, s =&gt; s.DateString)
.Highlight(highlight =&gt; highlight.InactiveOpacity(10)
)
)

Toggle(Func<object, object>)

Sets the highlight toggle handler

public ChartSeriesHighlightBuilder Toggle(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The toggle handler

Returns:

ChartSeriesHighlightBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.Pie(s =&gt; s.Sales, s =&gt; s.DateString)
.Highlight(highlight =&gt; highlight.Toggle(
@&lt;text&gt;
function(e) {
e.preventDefault();

var opacity = e.show ? 0.5 : 1;
e.visual.opacity(opacity);
}
&lt;/text&gt;)
)
)
)

Toggle(string)

Sets the highlight toggle handler

public ChartSeriesHighlightBuilder Toggle(string handler)

Parameters:handlerstring

The JavaScript toggle handler name.

Returns:

ChartSeriesHighlightBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.Pie(s =&gt; s.Sales, s =&gt; s.DateString)
.Highlight(highlight =&gt; highlight.Toggle("toggleHighlight"))
)
)
&lt;script&gt;
function toggleHandler(e) {
e.preventDefault();

var opacity = e.show ? 0.5 : 1;
e.visual.opacity(opacity);
}
&lt;/script&gt;

Visible(bool)

Sets the highlight visibility

public ChartSeriesHighlightBuilder Visible(bool visible)

Parameters:visiblebool

The value that sets the highlight visibility.

Returns:

ChartSeriesHighlightBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.Pie(s =&gt; s.Sales, s =&gt; s.DateString)
.Highlight(highlight =&gt; highlight.Visible(false))
)
)

Visual(Func<object, object>)

Sets the highlight visual handler

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

Parameters:handlerFunc<object, object>

The visual handler

Returns:

ChartSeriesHighlightBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.Pie(s =&gt; s.Sales, s =&gt; s.DateString)
.Highlight(highlight =&gt; highlight.Visual(
@&lt;text&gt;
function(e) {
return e.createVisual(); // returns the default visual
}
&lt;/text&gt;)
)
)
)

Visual(string)

Sets the highlight visual handler

public ChartSeriesHighlightBuilder Visual(string handler)

Parameters:handlerstring

The JavaScript visual handler name.

Returns:

ChartSeriesHighlightBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Series(series =&gt; series.Pie(s =&gt; s.Sales, s =&gt; s.DateString)
.Highlight(highlight =&gt; highlight.Toggle("highlightVisual"))
)
)