Class CircularGaugeBuilder

Inheritance
System.Object
ControlBuilder
CircularGaugeBuilder
Inherited Members
Namespace: Syncfusion.EJ2.CircularGauge
Assembly: Syncfusion.EJ2.dll
Syntax
public class CircularGaugeBuilder : ControlBuilder

Constructors

CircularGaugeBuilder()

Declaration
public CircularGaugeBuilder()

CircularGaugeBuilder(CircularGauge)

Declaration
public CircularGaugeBuilder(CircularGauge model)
Parameters
Type Name Description
CircularGauge model

Fields

model

Declaration
public CircularGauge model
Field Value
Type Description
CircularGauge

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

AllowImageExport(Boolean)

Enables and disables the export to image functionality in circular gauge.

Declaration
public CircularGaugeBuilder AllowImageExport(bool allowImageExport = true)
Parameters
Type Name Description
System.Boolean allowImageExport
Returns
Type Description
CircularGaugeBuilder

AllowMargin(Boolean)

Enables and disables left, right, top and bottom spacing in the circular gauge.

Declaration
public CircularGaugeBuilder AllowMargin(bool allowMargin = true)
Parameters
Type Name Description
System.Boolean allowMargin
Returns
Type Description
CircularGaugeBuilder

AllowPdfExport(Boolean)

Enables and disables the export to pdf functionality in circular gauge.

Declaration
public CircularGaugeBuilder AllowPdfExport(bool allowPdfExport = true)
Parameters
Type Name Description
System.Boolean allowPdfExport
Returns
Type Description
CircularGaugeBuilder

AllowPrint(Boolean)

Enables and disables the print functionality in circular gauge.

Declaration
public CircularGaugeBuilder AllowPrint(bool allowPrint = true)
Parameters
Type Name Description
System.Boolean allowPrint
Returns
Type Description
CircularGaugeBuilder

AnimationComplete(String)

Triggers after the animation gets completed for pointers.

Declaration
public CircularGaugeBuilder AnimationComplete(string animationComplete)
Parameters
Type Name Description
System.String animationComplete
Returns
Type Description
CircularGaugeBuilder

AnnotationRender(String)

Triggers before each annotation for the circular gauge gets rendered.

Declaration
public CircularGaugeBuilder AnnotationRender(string annotationRender)
Parameters
Type Name Description
System.String annotationRender
Returns
Type Description
CircularGaugeBuilder

Axes(Action<CircularGaugeAxisBuilder>)

Declaration
public CircularGaugeBuilder Axes(Action<CircularGaugeAxisBuilder> axes)
Parameters
Type Name Description
System.Action<CircularGaugeAxisBuilder> axes
Returns
Type Description
CircularGaugeBuilder

Axes(List<CircularGaugeAxis>)

Sets and gets the options for customizing the axes of circular gauge.

Declaration
public CircularGaugeBuilder Axes(List<CircularGaugeAxis> axes)
Parameters
Type Name Description
System.Collections.Generic.List<CircularGaugeAxis> axes
Returns
Type Description
CircularGaugeBuilder

AxisLabelRender(String)

Triggers before each axis label gets rendered.

Declaration
public CircularGaugeBuilder AxisLabelRender(string axisLabelRender)
Parameters
Type Name Description
System.String axisLabelRender
Returns
Type Description
CircularGaugeBuilder

Background(String)

Sets and gets the background color of the gauge. This property accepts value in hex code, rgba string as a valid CSS color string.

Declaration
public CircularGaugeBuilder Background(string background)
Parameters
Type Name Description
System.String background
Returns
Type Description
CircularGaugeBuilder

BeforePrint(String)

Triggers before the prints gets started.

Declaration
public CircularGaugeBuilder BeforePrint(string beforePrint)
Parameters
Type Name Description
System.String beforePrint
Returns
Type Description
CircularGaugeBuilder

Border(CircularGaugeBorder)

Sets and gets the options for customizing the color and width of the gauge border.

Declaration
public CircularGaugeBuilder Border(CircularGaugeBorder border)
Parameters
Type Name Description
CircularGaugeBorder border
Returns
Type Description
CircularGaugeBuilder

Border(Action<CircularGaugeBorderBuilder>)

Declaration
public CircularGaugeBuilder Border(Action<CircularGaugeBorderBuilder> border)
Parameters
Type Name Description
System.Action<CircularGaugeBorderBuilder> border
Returns
Type Description
CircularGaugeBuilder

CenterX(String)

Sets and gets the X coordinate of the circular gauge.

Declaration
public CircularGaugeBuilder CenterX(string centerX)
Parameters
Type Name Description
System.String centerX
Returns
Type Description
CircularGaugeBuilder

CenterY(String)

Sets and gets the Y coordinate of the circular gauge.

Declaration
public CircularGaugeBuilder CenterY(string centerY)
Parameters
Type Name Description
System.String centerY
Returns
Type Description
CircularGaugeBuilder

Description(String)

Sets and gets the information about gauge for assistive technology.

Declaration
public CircularGaugeBuilder Description(string description)
Parameters
Type Name Description
System.String description
Returns
Type Description
CircularGaugeBuilder

DragEnd(String)

Triggers after the pointer is dragged.

Declaration
public CircularGaugeBuilder DragEnd(string dragEnd)
Parameters
Type Name Description
System.String dragEnd
Returns
Type Description
CircularGaugeBuilder

DragMove(String)

Triggers while dragging the pointers.

Declaration
public CircularGaugeBuilder DragMove(string dragMove)
Parameters
Type Name Description
System.String dragMove
Returns
Type Description
CircularGaugeBuilder

DragStart(String)

Triggers before the pointer is dragged.

Declaration
public CircularGaugeBuilder DragStart(string dragStart)
Parameters
Type Name Description
System.String dragStart
Returns
Type Description
CircularGaugeBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration
public CircularGaugeBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
CircularGaugeBuilder

EnablePointerDrag(Boolean)

Enables and disables drag movement of the pointer in the circular gauge.

Declaration
public CircularGaugeBuilder EnablePointerDrag(bool enablePointerDrag = true)
Parameters
Type Name Description
System.Boolean enablePointerDrag
Returns
Type Description
CircularGaugeBuilder

EnableRangeDrag(Boolean)

Enables and disables the drag movement of the ranges in the circular gauge.

Declaration
public CircularGaugeBuilder EnableRangeDrag(bool enableRangeDrag = true)
Parameters
Type Name Description
System.Boolean enableRangeDrag
Returns
Type Description
CircularGaugeBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public CircularGaugeBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
CircularGaugeBuilder

GaugeMouseDown(String)

Triggers on mouse down.

Declaration
public CircularGaugeBuilder GaugeMouseDown(string gaugeMouseDown)
Parameters
Type Name Description
System.String gaugeMouseDown
Returns
Type Description
CircularGaugeBuilder

GaugeMouseLeave(String)

Triggers while cursor leaves the circular gauge.

Declaration
public CircularGaugeBuilder GaugeMouseLeave(string gaugeMouseLeave)
Parameters
Type Name Description
System.String gaugeMouseLeave
Returns
Type Description
CircularGaugeBuilder

GaugeMouseMove(String)

Triggers on hovering the circular gauge.

Declaration
public CircularGaugeBuilder GaugeMouseMove(string gaugeMouseMove)
Parameters
Type Name Description
System.String gaugeMouseMove
Returns
Type Description
CircularGaugeBuilder

GaugeMouseUp(String)

Triggers on mouse up.

Declaration
public CircularGaugeBuilder GaugeMouseUp(string gaugeMouseUp)
Parameters
Type Name Description
System.String gaugeMouseUp
Returns
Type Description
CircularGaugeBuilder

Height(String)

Sets and gets the height of the circular gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full height of its parent element.

Declaration
public CircularGaugeBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type Description
CircularGaugeBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public CircularGaugeBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
CircularGaugeBuilder

LegendRender(String)

Triggers before each legend for the circular gauge gets rendered.

Declaration
public CircularGaugeBuilder LegendRender(string legendRender)
Parameters
Type Name Description
System.String legendRender
Returns
Type Description
CircularGaugeBuilder

LegendSettings(CircularGaugeLegendSettings)

Sets and gets the options for customizing the legend of the circular gauge.

Declaration
public CircularGaugeBuilder LegendSettings(CircularGaugeLegendSettings legendSettings)
Parameters
Type Name Description
CircularGaugeLegendSettings legendSettings
Returns
Type Description
CircularGaugeBuilder

LegendSettings(Action<CircularGaugeLegendSettingsBuilder>)

Declaration
public CircularGaugeBuilder LegendSettings(Action<CircularGaugeLegendSettingsBuilder> legendSettings)
Parameters
Type Name Description
System.Action<CircularGaugeLegendSettingsBuilder> legendSettings
Returns
Type Description
CircularGaugeBuilder

Load(String)

Triggers before the circular gauge gets loaded.

Declaration
public CircularGaugeBuilder Load(string load)
Parameters
Type Name Description
System.String load
Returns
Type Description
CircularGaugeBuilder

Loaded(String)

Triggers after the circular gauge gets loaded.

Declaration
public CircularGaugeBuilder Loaded(string loaded)
Parameters
Type Name Description
System.String loaded
Returns
Type Description
CircularGaugeBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public CircularGaugeBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
CircularGaugeBuilder

Margin(CircularGaugeMargin)

Sets and gets the options to customize the left, right, top and bottom margins of the circular gauge.

Declaration
public CircularGaugeBuilder Margin(CircularGaugeMargin margin)
Parameters
Type Name Description
CircularGaugeMargin margin
Returns
Type Description
CircularGaugeBuilder

Margin(Action<CircularGaugeMarginBuilder>)

Declaration
public CircularGaugeBuilder Margin(Action<CircularGaugeMarginBuilder> margin)
Parameters
Type Name Description
System.Action<CircularGaugeMarginBuilder> margin
Returns
Type Description
CircularGaugeBuilder

MoveToCenter(Boolean)

Enables and disables to place the half or quarter circle in center position, if values not specified for centerX and centerY.

Declaration
public CircularGaugeBuilder MoveToCenter(bool moveToCenter = true)
Parameters
Type Name Description
System.Boolean moveToCenter
Returns
Type Description
CircularGaugeBuilder

RadiusCalculate(String)

Triggers before the radius for the circular gauge gets calculated.

Declaration
public CircularGaugeBuilder RadiusCalculate(string radiusCalculate)
Parameters
Type Name Description
System.String radiusCalculate
Returns
Type Description
CircularGaugeBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
Microsoft.AspNetCore.Html.HtmlString

Resized(String)

Triggers after window resize.

Declaration
public CircularGaugeBuilder Resized(string resized)
Parameters
Type Name Description
System.String resized
Returns
Type Description
CircularGaugeBuilder

TabIndex(Double)

Sets and gets the tab index value for the circular gauge.

Declaration
public CircularGaugeBuilder TabIndex(double tabIndex)
Parameters
Type Name Description
System.Double tabIndex
Returns
Type Description
CircularGaugeBuilder

Theme(GaugeTheme)

Sets and gets the themes supported for circular gauge.

Declaration
public CircularGaugeBuilder Theme(GaugeTheme theme)
Parameters
Type Name Description
GaugeTheme theme
Returns
Type Description
CircularGaugeBuilder

Title(String)

Sets and gets the title for circular gauge.

Declaration
public CircularGaugeBuilder Title(string title)
Parameters
Type Name Description
System.String title
Returns
Type Description
CircularGaugeBuilder

TitleStyle(CircularGaugeFont)

Sets and gets the options for customizing the title for circular gauge.

Declaration
public CircularGaugeBuilder TitleStyle(CircularGaugeFont titleStyle)
Parameters
Type Name Description
CircularGaugeFont titleStyle
Returns
Type Description
CircularGaugeBuilder

TitleStyle(Action<CircularGaugeFontBuilder>)

Declaration
public CircularGaugeBuilder TitleStyle(Action<CircularGaugeFontBuilder> titleStyle)
Parameters
Type Name Description
System.Action<CircularGaugeFontBuilder> titleStyle
Returns
Type Description
CircularGaugeBuilder

Tooltip(CircularGaugeTooltipSettings)

Sets and gets the options for customizing the tooltip of gauge.

Declaration
public CircularGaugeBuilder Tooltip(CircularGaugeTooltipSettings tooltip)
Parameters
Type Name Description
CircularGaugeTooltipSettings tooltip
Returns
Type Description
CircularGaugeBuilder

Tooltip(Action<CircularGaugeTooltipSettingsBuilder>)

Declaration
public CircularGaugeBuilder Tooltip(Action<CircularGaugeTooltipSettingsBuilder> tooltip)
Parameters
Type Name Description
System.Action<CircularGaugeTooltipSettingsBuilder> tooltip
Returns
Type Description
CircularGaugeBuilder

TooltipRender(String)

Triggers before the tooltip for pointer of the circular gauge gets rendered.

Declaration
public CircularGaugeBuilder TooltipRender(string tooltipRender)
Parameters
Type Name Description
System.String tooltipRender
Returns
Type Description
CircularGaugeBuilder

UseGroupingSeparator(Boolean)

Enables and disables the grouping separator should be used for a number.

Declaration
public CircularGaugeBuilder UseGroupingSeparator(bool useGroupingSeparator = true)
Parameters
Type Name Description
System.Boolean useGroupingSeparator
Returns
Type Description
CircularGaugeBuilder

Width(String)

Sets and gets the width of the circular gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full width of its parent element.

Declaration
public CircularGaugeBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
CircularGaugeBuilder