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

CircularGaugeBuilder

Class

Defines the fluent API for configuring the Kendo CircularGauge for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class CircularGaugeBuilder : WidgetBuilderBase<CircularGauge, CircularGaugeBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<CircularGauge, CircularGaugeBuilder>CircularGaugeBuilder

Implements: IHtmlString

Constructors

CircularGaugeBuilder(CircularGauge)

Initializes a new instance of the CircularGauge class.

public CircularGaugeBuilder(CircularGauge component)

Parameters:componentCircularGauge

The component.

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.GaugeArea(ga=&gt;ga.Background(value))
)

Methods

CenterTemplate(string)

The label template. Template variables: * value - the value

public CircularGaugeBuilder CenterTemplate(string value)

Parameters:valuestring

The value that configures the centertemplate.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.CenterTemplate(value)
)

CenterTemplate<TModel>(TemplateBuilder<TModel>)

The label template. Template variables: * value - the value

public CircularGaugeBuilder CenterTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the centertemplate.

Returns:

CircularGaugeBuilder

CenterTemplateHandler(string)

The label template. Template variables: * value - the value

public CircularGaugeBuilder CenterTemplateHandler(string value)

Parameters:valuestring

The value that configures the centertemplate.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.CenterTemplateHandler(value)
)

CenterTemplateId(string)

The label template. Template variables: * value - the value

public CircularGaugeBuilder CenterTemplateId(string value)

Parameters:valuestring

The value that configures the centertemplate.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.CenterTemplateId(value)
)

CenterTemplateView(MvcHtmlString)

The label template. Template variables: * value - the value

public CircularGaugeBuilder CenterTemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the centertemplate.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.CenterTemplate(Html.Partial("template"))
)

Color(string)

The color of the value pointer. Accepts a valid CSS color string, including hex and rgb.

public CircularGaugeBuilder Color(string value)

Parameters:valuestring

The value that configures the color.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.Color(value)
)

Colors(Action<CircularGaugeColorFactory>)

The color ranges of the value pointer. The pointer color will be set to the color from the range that contains the current value.

public CircularGaugeBuilder Colors(Action<CircularGaugeColorFactory> configurator)

Parameters:configuratorAction<CircularGaugeColorFactory>

The action that configures the colors.

Returns:

CircularGaugeBuilder

GaugeArea(Action<CircularGaugeGaugeAreaSettingsBuilder>)

The gauge area configuration options. This is the entire visible area of the gauge.

public CircularGaugeBuilder GaugeArea(Action<CircularGaugeGaugeAreaSettingsBuilder> configurator)

Parameters:configuratorAction<CircularGaugeGaugeAreaSettingsBuilder>

The action that configures the gaugearea.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.GaugeArea(ga=&gt;ga.Background(value))
)

Opacity(double)

The opacity of the value pointer.

public CircularGaugeBuilder Opacity(double value)

Parameters:valuedouble

The value that configures the opacity.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.Opacity(value)
)

Sets the preferred rendering engine. If it is not supported by the browser, the Gauge will switch to the first available mode.The supported values are: "svg" - renders the widget as inline SVG document, if available or "canvas" - renders the widget as a Canvas element, if available..

public CircularGaugeBuilder RenderAs(string value)

Parameters:valuestring

The value that configures the renderas.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.RenderAs(value)
)

Scale(Action<CircularGaugeScaleSettingsBuilder>)

Configures the scale.

public CircularGaugeBuilder Scale(Action<CircularGaugeScaleSettingsBuilder> configurator)

Parameters:configuratorAction<CircularGaugeScaleSettingsBuilder>

The action that configures the scale.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.Scale(s=&gt;s.StartAngle(value))
)

Theme(string)

The gauge theme. This can be either a built-in theme or "sass". When set to "sass" the gauge will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".

public CircularGaugeBuilder Theme(string value)

Parameters:valuestring

The value that configures the theme.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.Theme(value)
)

Transitions(bool)

A value indicating if transition animations should be played.

public CircularGaugeBuilder Transitions(bool value)

Parameters:valuebool

The value that configures the transitions.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.Transitions(value)
)

Value(double)

The gauge value.

public CircularGaugeBuilder Value(double value)

Parameters:valuedouble

The value that configures the value.

Returns:

CircularGaugeBuilder

Example:

@(Html.Kendo().CircularGauge()
.Name("circularGauge")
.Value(value)
)