Class CircularGaugeBuilder
Inheritance
System.Object
CircularGaugeBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class CircularGaugeBuilder : ControlBuilder
Constructors
CircularGaugeBuilder()
Declaration
public CircularGaugeBuilder()
CircularGaugeBuilder(CircularGauge)
Declaration
public CircularGaugeBuilder(CircularGauge model)
Parameters
Fields
model
Declaration
public CircularGauge model
Field Value
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
AllowMargin(Boolean)
Enables or disables the ability of the gauge to be rendered to the complete width. The left, right, top and bottom spacing will not be considered in the gauge when this property is disabled.
Declaration
public CircularGaugeBuilder AllowMargin(bool allowMargin = true)
Parameters
Type |
Name |
Description |
System.Boolean |
allowMargin |
|
Returns
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
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
AnimationComplete(String)
Triggers after the animation gets completed for pointers.
Declaration
public CircularGaugeBuilder AnimationComplete(string animationComplete)
Parameters
Type |
Name |
Description |
System.String |
animationComplete |
|
Returns
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
Axes(Action<CircularGaugeAxisBuilder>)
Declaration
public CircularGaugeBuilder Axes(Action<CircularGaugeAxisBuilder> axes)
Parameters
Returns
Axes(List<CircularGaugeAxis>)
Sets and gets the options for customizing the axes of circular gauge.
Declaration
public CircularGaugeBuilder Axes(List<CircularGaugeAxis> axes)
Parameters
Returns
AxisLabelRender(String)
Triggers before each axis label gets rendered.
Declaration
public CircularGaugeBuilder AxisLabelRender(string axisLabelRender)
Parameters
Type |
Name |
Description |
System.String |
axisLabelRender |
|
Returns
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
BeforePrint(String)
Triggers before the prints gets started.
Declaration
public CircularGaugeBuilder BeforePrint(string beforePrint)
Parameters
Type |
Name |
Description |
System.String |
beforePrint |
|
Returns
Border(CircularGaugeBorder)
Sets and gets the options for customizing the style properties of the gauge border.
Declaration
public CircularGaugeBuilder Border(CircularGaugeBorder border)
Parameters
Returns
Border(Action<CircularGaugeBorderBuilder>)
Declaration
public CircularGaugeBuilder Border(Action<CircularGaugeBorderBuilder> border)
Parameters
Returns
CenterX(String)
Sets and gets the X coordinate of the center of the circular gauge.
Declaration
public CircularGaugeBuilder CenterX(string centerX)
Parameters
Type |
Name |
Description |
System.String |
centerX |
|
Returns
CenterY(String)
Sets and gets the Y coordinate of the center of the circular gauge.
Declaration
public CircularGaugeBuilder CenterY(string centerY)
Parameters
Type |
Name |
Description |
System.String |
centerY |
|
Returns
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
DragEnd(String)
Triggers after the pointer is dragged.
Declaration
public CircularGaugeBuilder DragEnd(string dragEnd)
Parameters
Type |
Name |
Description |
System.String |
dragEnd |
|
Returns
DragMove(String)
Triggers while dragging the pointers.
Declaration
public CircularGaugeBuilder DragMove(string dragMove)
Parameters
Type |
Name |
Description |
System.String |
dragMove |
|
Returns
DragStart(String)
Triggers before the pointer is dragged.
Declaration
public CircularGaugeBuilder DragStart(string dragStart)
Parameters
Type |
Name |
Description |
System.String |
dragStart |
|
Returns
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
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
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
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
GaugeMouseDown(String)
Declaration
public CircularGaugeBuilder GaugeMouseDown(string gaugeMouseDown)
Parameters
Type |
Name |
Description |
System.String |
gaugeMouseDown |
|
Returns
GaugeMouseLeave(String)
Triggers while cursor leaves the circular gauge.
Declaration
public CircularGaugeBuilder GaugeMouseLeave(string gaugeMouseLeave)
Parameters
Type |
Name |
Description |
System.String |
gaugeMouseLeave |
|
Returns
GaugeMouseMove(String)
Triggers on hovering the circular gauge.
Declaration
public CircularGaugeBuilder GaugeMouseMove(string gaugeMouseMove)
Parameters
Type |
Name |
Description |
System.String |
gaugeMouseMove |
|
Returns
GaugeMouseUp(String)
Triggers when mouse up action is performed over the circular gauge.
Declaration
public CircularGaugeBuilder GaugeMouseUp(string gaugeMouseUp)
Parameters
Type |
Name |
Description |
System.String |
gaugeMouseUp |
|
Returns
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
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
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
LegendSettings(CircularGaugeLegendSettings)
Sets and gets the options for customizing the legend of the circular gauge.
Declaration
public CircularGaugeBuilder LegendSettings(CircularGaugeLegendSettings legendSettings)
Parameters
Returns
LegendSettings(Action<CircularGaugeLegendSettingsBuilder>)
Declaration
public CircularGaugeBuilder LegendSettings(Action<CircularGaugeLegendSettingsBuilder> legendSettings)
Parameters
Returns
Load(String)
Triggers before the circular gauge gets loaded.
Declaration
public CircularGaugeBuilder Load(string load)
Parameters
Type |
Name |
Description |
System.String |
load |
|
Returns
Loaded(String)
Triggers after the circular gauge gets loaded.
Declaration
public CircularGaugeBuilder Loaded(string loaded)
Parameters
Type |
Name |
Description |
System.String |
loaded |
|
Returns
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
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
Returns
Margin(Action<CircularGaugeMarginBuilder>)
Declaration
public CircularGaugeBuilder Margin(Action<CircularGaugeMarginBuilder> margin)
Parameters
Returns
MoveToCenter(Boolean)
Enables and disables placing the half or quarter circle in center, if centerX
and centerY
properties are not specified.
Declaration
public CircularGaugeBuilder MoveToCenter(bool moveToCenter = true)
Parameters
Type |
Name |
Description |
System.Boolean |
moveToCenter |
|
Returns
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
Render()
Declaration
public HtmlString Render()
Returns
Type |
Description |
Microsoft.AspNetCore.Html.HtmlString |
|
Resized(String)
Triggers to notify the resize of the circular gauge when the window is resized.
Declaration
public CircularGaugeBuilder Resized(string resized)
Parameters
Type |
Name |
Description |
System.String |
resized |
|
Returns
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
Theme(GaugeTheme)
Sets and gets the theme styles supported for circular gauge. When the theme is set, the styles associated with the theme will be set in the gauge.
Declaration
public CircularGaugeBuilder Theme(GaugeTheme theme)
Parameters
Returns
Title(String)
Sets and gets the title for circular gauge.
Declaration
public CircularGaugeBuilder Title(string title)
Parameters
Type |
Name |
Description |
System.String |
title |
|
Returns
TitleStyle(CircularGaugeFont)
Sets and gets the options for customizing the title for circular gauge.
Declaration
public CircularGaugeBuilder TitleStyle(CircularGaugeFont titleStyle)
Parameters
Returns
TitleStyle(Action<CircularGaugeFontBuilder>)
Declaration
public CircularGaugeBuilder TitleStyle(Action<CircularGaugeFontBuilder> titleStyle)
Parameters
Returns
Sets and gets the options for customizing the tooltip of gauge.
Declaration
public CircularGaugeBuilder Tooltip(CircularGaugeTooltipSettings tooltip)
Parameters
Returns
Declaration
public CircularGaugeBuilder Tooltip(Action<CircularGaugeTooltipSettingsBuilder> tooltip)
Parameters
Returns
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
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
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