ChartLegendSettingsBuilder

Methods

Background(System.String)

The background color of the legend. Accepts a valid CSS color string, including hex and rgb.

Parameters

value - System.String

The value for Background

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Border(System.Action)

The border of the legend.

Parameters

configurator - System.Action<ChartLegendBorderSettingsBuilder>

The configurator for the border setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

FocusHighlight(System.Action)

The legend focus highlight configuration options.

Parameters

configurator - System.Action<ChartLegendFocusHighlightSettingsBuilder>

The configurator for the focushighlight setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

Height(System.Double)

The legend height when the legend.orientation is set to "vertical".

Parameters

value - System.Double

The value for Height

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

InactiveItems(System.Action)

The chart inactive legend items configuration.

Parameters

configurator - System.Action<ChartLegendInactiveItemsSettingsBuilder>

The configurator for the inactiveitems setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

Item(System.Action)

The configuration of the Chart legend item.To override the marker configuration of individual series, use the series.legendItem settings of the series.

Parameters

configurator - System.Action<ChartLegendItemSettingsBuilder>

The configurator for the item setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

Labels(System.Action)

The chart legend label configuration.

Parameters

configurator - System.Action<ChartLegendLabelsSettingsBuilder>

The configurator for the labels setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

Margin(System.Action)

The margin of the chart legend. A numeric value will set all paddings.

Parameters

configurator - System.Action<ChartLegendMarginSettingsBuilder>

The configurator for the margin setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

OffsetX(System.Double)

The X offset of the chart legend. The offset is relative to the default position of the legend. For instance, a value of 20 will move the legend 20 pixels to the right of its initial position. A negative value will move the legend to the left of its current position.

Parameters

value - System.Double

The value for OffsetX

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

OffsetY(System.Double)

The Y offset of the chart legend. The offset is relative to the current position of the legend. For instance, a value of 20 will move the legend 20 pixels down from its initial position. A negative value will move the legend upwards from its current position.

Parameters

value - System.Double

The value for OffsetY

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Padding(System.Action)

The padding of the chart legend. A numeric value will set all paddings.

Parameters

configurator - System.Action<ChartLegendPaddingSettingsBuilder>

The configurator for the padding setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

Reverse(System.Boolean)

If set to true the legend items will be reversed.Available in versions 2013.3.1306 and later.

Parameters

value - System.Boolean

The value for Reverse

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Reverse()

If set to true the legend items will be reversed.Available in versions 2013.3.1306 and later.

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Spacing(System.Double)

The spacing between the labels in pixels when the legend.orientation is "horizontal".

Parameters

value - System.Double

The value for Spacing

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Title(System.Action)

The legend title configuration options or text.

Parameters

configurator - System.Action<ChartLegendTitleSettingsBuilder>

The configurator for the title setting.

RETURNS

Returns the current instance of ChartLegendSettingsBuilder .

Visible(System.Boolean)

If set to true the chart will display the legend. By default the chart legend is visible.

Parameters

value - System.Boolean

The value for Visible

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Width(System.Double)

The legend width when the legend.orientation is set to "horizontal".

Parameters

value - System.Double

The value for Width

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Align(Kendo.Mvc.UI.ChartLegendAlign)

Specifies the legend align.

Parameters

value - ChartLegendAlign

The value for Align

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Orientation(Kendo.Mvc.UI.ChartLegendOrientation)

Specifies the legend orientation.

Parameters

value - ChartLegendOrientation

The value for Orientation

RETURNS

Returns the current ChartLegendSettingsBuilder instance.

Position(Kendo.Mvc.UI.ChartLegendPosition)

Specifies the legend position.

Parameters

value - ChartLegendPosition

The value for Position

RETURNS

Returns the current ChartLegendSettingsBuilder instance.