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

ChartLegendItemBuilder

Class

Defines the fluent interface for configuring the legend items.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ChartLegendItemBuilder

Inheritance: objectChartLegendItemBuilder

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

Constructors

ChartLegendItemBuilder(ChartLegendItem)

Initializes a new instance of the ChartLegendItemBuilder class.

public ChartLegendItemBuilder(ChartLegendItem legendItem)

Parameters:legendItemChartLegendItem

The chart legend item.

Methods

Area(Action<ChartLegendItemAreaSettingsBuilder>)

Sets the configuration of the legend items of type area. By default, all series except line and scatter use this legend type.

public ChartLegendItemBuilder Area(Action<ChartLegendItemAreaSettingsBuilder> configurator)

Parameters:configuratorAction<ChartLegendItemAreaSettingsBuilder>

The configurator for the area setting.

Returns:

ChartLegendItemBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Area(a =&gt; a.Background("green"))))
)

Cursor(string)

Sets the legend item cursor style

public ChartLegendItemBuilder Cursor(string cursor)

Parameters:cursorstring

The cursor style.

Returns:

ChartLegendItemBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Cursor("pointer")))
)

Highlight(Action<ChartLegendItemHighlightSettingsBuilder>)

The highlight configuration of the legend item.

public ChartLegendItemBuilder Highlight(Action<ChartLegendItemHighlightSettingsBuilder> configurator)

Parameters:configuratorAction<ChartLegendItemHighlightSettingsBuilder>

The configurator for the highlight setting.

Returns:

ChartLegendItemBuilder

Example:

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

Line(Action<ChartLegendItemLineSettingsBuilder>)

Sets the configuration of the legend items of type line. This is the default legend item type for all line and scatter series.

public ChartLegendItemBuilder Line(Action<ChartLegendItemLineSettingsBuilder> configurator)

Parameters:configuratorAction<ChartLegendItemLineSettingsBuilder>

The configurator for the line setting.

Returns:

ChartLegendItemBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Line(l =&gt; l.Color("green"))))
)

Markers(Action<ChartLegendItemMarkersSettingsBuilder>)

The configuration of the Chart legend item markers.By default, the marker configuration will be the same as the series.markers settings of the displayed series.

public ChartLegendItemBuilder Markers(Action<ChartLegendItemMarkersSettingsBuilder> configurator)

Parameters:configuratorAction<ChartLegendItemMarkersSettingsBuilder>

The configurator for the markers setting.

Returns:

ChartLegendItemBuilder

Example:

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

Type(ChartLegendItemType)

The type of the legend items.

public ChartLegendItemBuilder Type(ChartLegendItemType value)

Parameters:valueChartLegendItemType

The value for Type

Returns:

ChartLegendItemBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Type(ChartLegendItemType.Line)))
)

Visual(Func<object, object>)

Sets the note visual handler

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

Parameters:handlerFunc<object, object>

The handler

Returns:

ChartLegendItemBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Visual(
@&lt;text&gt;
function(e) {
return e.createVisual(); // returns the default visual
}
&lt;/text&gt;
)))
)

Visual(string)

Sets the legend item visual handler

public ChartLegendItemBuilder Visual(string handler)

Parameters:handlerstring

The JavaScript item visual handler name.

Returns:

ChartLegendItemBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.Legend(legend =&gt; legend.Item(item =&gt; item.Visual("itemVisual")))
)