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

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Class

Defines the fluent API for configuring ChartSeriesLegendItemHighlightMarkersSettings

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Inheritance: objectChartSeriesLegendItemHighlightMarkersSettingsBuilder

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

Constructors

ChartSeriesLegendItemHighlightMarkersSettingsBuilder(ChartSeriesLegendItemHighlightMarkersSettings)

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder(ChartSeriesLegendItemHighlightMarkersSettings container)

Parameters:containerChartSeriesLegendItemHighlightMarkersSettings

Properties

Container

ChartSeriesLegendItemHighlightMarkersSettings

protected ChartSeriesLegendItemHighlightMarkersSettings Container { get; }

Methods

Background(string)

The background color of the highlighted legend item markers.

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder Background(string value)

Parameters:valuestring

The value for Background

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.Background("lightgreen"))));
})
)

BackgroundHandler(Func<object, object>)

The background color of the highlighted legend item markers.

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

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.BackgroundHandler(@&lt;text&gt;
function() {
//code
}
&lt;/text&gt;))));
})
)

BackgroundHandler(string)

The background color of the highlighted legend item markers.

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder BackgroundHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.BackgroundHandler("backgroundHandler"))));
})
)

Border(Action<ChartSeriesLegendItemHighlightMarkersBorderSettingsBuilder>)

The border of the highlighted markers.

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder Border(Action<ChartSeriesLegendItemHighlightMarkersBorderSettingsBuilder> configurator)

Parameters:configuratorAction<ChartSeriesLegendItemHighlightMarkersBorderSettingsBuilder>

The configurator for the border setting.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.Border(border =&gt; border.Color("blue")))));
})
)

BorderRadius(double)

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

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder BorderRadius(double value)

Parameters:valuedouble

The value for BorderRadius

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.BorderRadius(10))));
})
)

Type(ChartMarkerShape)

The highlighted markers shape.

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder Type(ChartMarkerShape value)

Parameters:valueChartMarkerShape

The value for Type

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.Type(ChartMarkerShape.Rect))));
})
)

TypeHandler(Func<object, object>)

The highlighted markers shape.

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

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.TypeHandler(@&lt;text&gt;
function() {
//code
}
&lt;/text&gt;))));
})
)

TypeHandler(string)

The highlighted markers shape.

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder TypeHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.TypeHandler("typeHandler"))));
})
)

Visible(bool)

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

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder Visible(bool value)

Parameters:valuebool

The value for Visible

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.Visible(true))));
})
)

VisibleHandler(Func<object, object>)

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

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

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.VisibleHandler(@&lt;text&gt;
function() {
//code
}
&lt;/text&gt;))));
})
)

VisibleHandler(string)

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

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder VisibleHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.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 ChartSeriesLegendItemHighlightMarkersSettingsBuilder Visual(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.Visual(@&lt;text&gt;
function() {
//code
}
&lt;/text&gt;))));
})
)

Visual(string)

public ChartSeriesLegendItemHighlightMarkersSettingsBuilder Visual(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartSeriesLegendItemHighlightMarkersSettingsBuilder

Example:

@(Html.Kendo().Chart()
.Name("chart")
.Series(series =&gt;
{
series.Column(model =&gt; model.UnitPrice).Name("Unit Price").LegendItem(legendItem =&gt; legendItem.Highlight(highlight =&gt; highlight.Markers(markers =&gt; markers.Visual("visualHandler"))));
})
)