ChartLegendItemSettingsBuilder

Methods

Area(System.Action)

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

Parameters

configurator - System.Action<ChartLegendItemAreaSettingsBuilder>

The configurator for the area setting.

RETURNS

Returns the current instance of ChartLegendItemSettingsBuilder .

Cursor(System.String)

The cursor style of the legend item.

Parameters

value - System.String

The value for Cursor

RETURNS

Returns the current ChartLegendItemSettingsBuilder instance.

Highlight(System.Action)

The highlight configuration of the legend item.

Parameters

configurator - System.Action<ChartLegendItemHighlightSettingsBuilder>

The configurator for the highlight setting.

RETURNS

Returns the current instance of ChartLegendItemSettingsBuilder .

Line(System.Action)

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

Parameters

configurator - System.Action<ChartLegendItemLineSettingsBuilder>

The configurator for the line setting.

RETURNS

Returns the current instance of ChartLegendItemSettingsBuilder .

Markers(System.Action)

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.

Parameters

configurator - System.Action<ChartLegendItemMarkersSettingsBuilder>

The configurator for the markers setting.

RETURNS

Returns the current instance of ChartLegendItemSettingsBuilder .

Visual(System.String)

A function that can be used to create a custom visual for the legend items. The available argument fields are: options—The item options.; createVisual—A function for getting the default visual.; series—The item series. or pointIndex—The index of the point in the series. Available for the Pie, Donut, and Funnel series..

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartLegendItemSettingsBuilder instance.

Visual(System.Func)

A function that can be used to create a custom visual for the legend items. The available argument fields are: options—The item options.; createVisual—A function for getting the default visual.; series—The item series. or pointIndex—The index of the point in the series. Available for the Pie, Donut, and Funnel series..

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartLegendItemSettingsBuilder instance.

Type(Kendo.Mvc.UI.ChartLegendItemType)

The type of the legend items.

Parameters

value - ChartLegendItemType

The value for Type

RETURNS

Returns the current ChartLegendItemSettingsBuilder instance.