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

ChartLegendItemHighlightMarkersSettingsBuilder

Class

Defines the fluent API for configuring ChartLegendItemHighlightMarkersSettings

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ChartLegendItemHighlightMarkersSettingsBuilder

Inheritance: objectChartLegendItemHighlightMarkersSettingsBuilder

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

Constructors

ChartLegendItemHighlightMarkersSettingsBuilder(ChartLegendItemHighlightMarkersSettings)

public ChartLegendItemHighlightMarkersSettingsBuilder(ChartLegendItemHighlightMarkersSettings container)

Parameters:containerChartLegendItemHighlightMarkersSettings

Properties

Container

ChartLegendItemHighlightMarkersSettings

protected ChartLegendItemHighlightMarkersSettings Container { get; }

Methods

Background(string)

The background color of the highlighted legend item markers.

public ChartLegendItemHighlightMarkersSettingsBuilder Background(string value)

Parameters:valuestring

The value for Background

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.Background("green")))))
)

BackgroundHandler(Func<object, object>)

The background color of the highlighted legend item markers.

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

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.BackgroundHandler(
@&lt;text&gt;
function(e) {
//event handling code
}
&lt;/text&gt;
))))))

BackgroundHandler(string)

The background color of the highlighted legend item markers.

public ChartLegendItemHighlightMarkersSettingsBuilder BackgroundHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.BackgroundHandler("backgroundHandler")))))
)

Border(Action<ChartLegendItemHighlightMarkersBorderSettingsBuilder>)

The border of the highlighted markers.

public ChartLegendItemHighlightMarkersSettingsBuilder Border(Action<ChartLegendItemHighlightMarkersBorderSettingsBuilder> configurator)

Parameters:configuratorAction<ChartLegendItemHighlightMarkersBorderSettingsBuilder>

The configurator for the border setting.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.Border(b =&gt; b.Color("green"))))))
)

BorderRadius(double)

The border radius in pixels when type is set to "roundedRect".

public ChartLegendItemHighlightMarkersSettingsBuilder BorderRadius(double value)

Parameters:valuedouble

The value for BorderRadius

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.BorderRadius(20)))))
)

Type(ChartMarkerShape)

The highlighted markers shape.

public ChartLegendItemHighlightMarkersSettingsBuilder Type(ChartMarkerShape value)

Parameters:valueChartMarkerShape

The value for Type

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.Type(ChartMarkerShape.Circle)))))
)

TypeHandler(Func<object, object>)

The highlighted markers shape.

public ChartLegendItemHighlightMarkersSettingsBuilder TypeHandler(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.TypeHandler(
@&lt;text&gt;
function(e) {
//event handling code
}
&lt;/text&gt;
))))))

TypeHandler(string)

The highlighted markers shape.

public ChartLegendItemHighlightMarkersSettingsBuilder TypeHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.TypeHandler("typeHandler")))))
)

Visible(bool)

If set to true the chart will display the legend item markers. Defaults to the series options.

public ChartLegendItemHighlightMarkersSettingsBuilder Visible(bool value)

Parameters:valuebool

The value for Visible

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.Visible(true)))))
)

VisibleHandler(Func<object, object>)

If set to true the chart will display the legend item markers. Defaults to the series options.

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

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.VisibleHandler(
@&lt;text&gt;
function(e) {
//event handling code
}
&lt;/text&gt;
))))))

VisibleHandler(string)

If set to true the chart will display the legend item markers. Defaults to the series options.

public ChartLegendItemHighlightMarkersSettingsBuilder VisibleHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.VisibleHandler("visibleHandler")))))
)

A function that can be used to create a custom visual for the highlighted markers. The available argument fields are: rect - the kendo.geometry.Rect that defines where the visual should be rendered.; options - the marker options.; createVisual - a function that can be used to get the default visual.; category - the category of the marker point.; dataItem - the dataItem of the marker point.; value - the value of the marker point.; sender - the chart instance. or series - the series of the marker point..

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

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.Visual(
@&lt;text&gt;
function(e) {
//event handling code
}
&lt;/text&gt;
))))))

Visual(string)

public ChartLegendItemHighlightMarkersSettingsBuilder Visual(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Highlight(h =&gt; h.Markers(m =&gt; m.Visual("visualHandler")))))
)