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

ChartPlotBandLabelBuilder

Class

Defines the fluent API for configuring ChartCategoryAxisPlotBandLabelSettings

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class ChartPlotBandLabelBuilder

Inheritance: objectChartPlotBandLabelBuilder

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

Properties

Container

ChartPlotBandLabel

protected ChartPlotBandLabel Container { get; }

The position of the plotband label.The supported values are: "left" - the plotband label is positioned on the left; "right" - the plotband label is positioned on the right or "center" - the plotband label is positioned in the center.

public ChartPlotBandLabelBuilder Align(string value)

Parameters:valuestring

The value for Align

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Align("right"));
})
)
)

Background(string)

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

public ChartPlotBandLabelBuilder Background(string value)

Parameters:valuestring

The value for Background

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Background("lightblue"));
})
)
)

Border(Action<ChartPlotBandLabelBorderBuilder>)

The border of the label.

public ChartPlotBandLabelBuilder Border(Action<ChartPlotBandLabelBorderBuilder> configurator)

Parameters:configuratorAction<ChartPlotBandLabelBorderBuilder>

The configurator for the border setting.

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Border(border =&gt; border.Color("red")));
})
)
)

Color(string)

The text color of the label. Accepts a valid CSS color string, including hex and rgb.

public ChartPlotBandLabelBuilder Color(string value)

Parameters:valuestring

The value for Color

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Color("red"));
})
)
)

Font(string)

The font style of the label.

public ChartPlotBandLabelBuilder Font(string value)

Parameters:valuestring

The value for Font

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Font("12px Courier New"));
})
)
)

Margin(Action<ChartPlotBandLabelSpacingBuilder>)

The margin of the label. A numeric value will set all margins.

public ChartPlotBandLabelBuilder Margin(Action<ChartPlotBandLabelSpacingBuilder> configurator)

Parameters:configuratorAction<ChartPlotBandLabelSpacingBuilder>

The configurator for the margin setting.

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Margin(margin =&gt; margin.Top(10)));
})
)
)

Padding(Action<ChartPlotBandLabelSpacingBuilder>)

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

public ChartPlotBandLabelBuilder Padding(Action<ChartPlotBandLabelSpacingBuilder> configurator)

Parameters:configuratorAction<ChartPlotBandLabelSpacingBuilder>

The configurator for the padding setting.

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Padding(padding =&gt; padding.Left(5)));
})
)
)

Position(string)

The position of the label.The supported values are: "top" - the axis label is positioned on the top; "bottom" - the axis label is positioned on the bottom or "center" - the axis label is positioned in the center.

public ChartPlotBandLabelBuilder Position(string value)

Parameters:valuestring

The value for Position

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Position("top"));
})
)
)

Rotation(double)

The rotation angle of the label. By default the label is not rotated.

public ChartPlotBandLabelBuilder Rotation(double value)

Parameters:valuedouble

The value for Rotation

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Rotation(90));
})
)
)

Text(string)

The text of the label.

public ChartPlotBandLabelBuilder Text(string value)

Parameters:valuestring

The value for Text

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Text("My Label"));
})
)
)

Visible(bool)

If set to false the chart will not display the label.

public ChartPlotBandLabelBuilder Visible(bool value)

Parameters:valuebool

The value for Visible

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Visible(false));
})
)
)

Visual(Func<object, object>)

A function that can be used to create a custom visual for the label. The available argument fields are: text - the label text.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; sender - the chart instance (may be undefined).; options - the label options. or createVisual - a function that can be used to get the default visual..

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

Parameters:handlerFunc<object, object>

The handler code wrapped in a text tag.

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Visual(
@&lt;text&gt;
function(e) {
return e.createVisual(); // returns the default visual
}
&lt;/text&gt;
);
})
)
)

Visual(string)

public ChartPlotBandLabelBuilder Visual(string handler)

Parameters:handlerstring

The name of the JavaScript function that will be evaluated.

Returns:

ChartPlotBandLabelBuilder

Example:

@(Html.Kendo().Chart()
.Name("Chart")
.ValueAxis(axis =&gt; axis.Numeric()
.PlotBands(bands =&gt;
{
bands.Add().From(10000).To(30000).Label(label =&gt; label.Visual("labelsVisual"));
})
)
)

ChartPlotBandLabelBuilder

Definition

Constructors