Class CircularGauge
Inheritance
Namespace: Syncfusion.EJ2.CircularGauge
Assembly: Syncfusion.EJ2.dll
Syntax
public class CircularGauge : EJTagHelperConstructors
CircularGauge()
Declaration
public CircularGauge()Properties
AllowImageExport
Enables and disables the export to image functionality in circular gauge.
Declaration
public bool AllowImageExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
AllowMargin
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 bool AllowMargin { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
AllowPdfExport
Enables and disables the export to pdf functionality in circular gauge.
Declaration
public bool AllowPdfExport { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
AllowPrint
Enables and disables the print functionality in circular gauge.
Declaration
public bool AllowPrint { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
AllowRangePreRender
Allow the range element to be rendered ahead of the axis element, when this property is set to "true".
Declaration
public bool AllowRangePreRender { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
AnimationComplete
Triggers after the animation gets completed for pointers.
Declaration
public string AnimationComplete { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
AnimationDuration
Sets and gets the duration of animation in milliseconds in circular gauge.
Declaration
public double AnimationDuration { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 0 |
AnnotationRender
Triggers before each annotation for the circular gauge gets rendered.
Declaration
public string AnnotationRender { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Axes
Sets and gets the options for customizing the axes of circular gauge.
Declaration
public List<CircularGaugeAxis> Axes { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<CircularGaugeAxis> | The default value is null |
AxisLabelRender
Triggers before each axis label gets rendered.
Declaration
public string AxisLabelRender { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Background
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 string Background { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
BeforePrint
Triggers before the prints gets started.
Declaration
public string BeforePrint { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Border
Sets and gets the options for customizing the style properties of the gauge border.
Declaration
public CircularGaugeBorder Border { get; set; }Property Value
| Type | Description |
|---|---|
| CircularGaugeBorder | The default value is null |
CenterX
Sets and gets the X coordinate of the center of the circular gauge.
Declaration
public string CenterX { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CenterY
Sets and gets the Y coordinate of the center of the circular gauge.
Declaration
public string CenterY { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Description
Sets and gets the information about gauge for assistive technology.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
DragEnd
Triggers after the pointer is dragged.
Declaration
public string DragEnd { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
DragMove
Triggers while dragging the pointers.
Declaration
public string DragMove { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
DragStart
Triggers before the pointer is dragged.
Declaration
public string DragStart { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnablePointerDrag
Enables and disables drag movement of the pointer in the circular gauge.
Declaration
public bool EnablePointerDrag { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableRangeDrag
Enables and disables the drag movement of the ranges in the circular gauge.
Declaration
public bool EnableRangeDrag { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
GaugeMouseDown
Triggers on mouse down.
Declaration
public string GaugeMouseDown { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
GaugeMouseLeave
Triggers while cursor leaves the circular gauge.
Declaration
public string GaugeMouseLeave { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
GaugeMouseMove
Triggers on hovering the circular gauge.
Declaration
public string GaugeMouseMove { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
GaugeMouseUp
Triggers when mouse up action is performed over the circular gauge.
Declaration
public string GaugeMouseUp { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Height
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 string Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }Property Value
| Type |
|---|
| System.Object |
LegendRender
Triggers before each legend for the circular gauge gets rendered.
Declaration
public string LegendRender { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
LegendSettings
Sets and gets the options for customizing the legend of the circular gauge.
Declaration
public CircularGaugeLegendSettings LegendSettings { get; set; }Property Value
| Type | Description |
|---|---|
| CircularGaugeLegendSettings | The default value is null |
Load
Triggers before the circular gauge gets loaded.
Declaration
public string Load { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Loaded
Triggers after the circular gauge gets loaded.
Declaration
public string Loaded { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
Margin
Sets and gets the options to customize the left, right, top and bottom margins of the circular gauge.
Declaration
public CircularGaugeMargin Margin { get; set; }Property Value
| Type | Description |
|---|---|
| CircularGaugeMargin | The default value is null |
MoveToCenter
Enables and disables placing the half or quarter circle in center, if centerX and centerY properties are not specified.
Declaration
public bool MoveToCenter { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
RadiusCalculate
Triggers before the radius for the circular gauge gets calculated.
Declaration
public string RadiusCalculate { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Resized
Triggers to notify the resize of the circular gauge when the window is resized.
Declaration
public string Resized { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
TabIndex
Sets and gets the tab index value for the circular gauge.
Declaration
public double TabIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 0 |
Theme
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 GaugeTheme Theme { get; set; }Property Value
| Type | Description |
|---|---|
| GaugeTheme | The default value is GaugeTheme.Material |
Title
Sets and gets the title for circular gauge.
Declaration
public string Title { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
TitleStyle
Sets and gets the options for customizing the title for circular gauge.
Declaration
public CircularGaugeFont TitleStyle { get; set; }Property Value
| Type | Description |
|---|---|
| CircularGaugeFont | The default value is null |
Tooltip
Sets and gets the options for customizing the tooltip of gauge.
Declaration
public CircularGaugeTooltipSettings Tooltip { get; set; }Property Value
| Type | Description |
|---|---|
| CircularGaugeTooltipSettings | The default value is null |
TooltipRender
Triggers before the tooltip for pointer of the circular gauge gets rendered.
Declaration
public string TooltipRender { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
UseGroupingSeparator
Enables and disables the grouping separator should be used for a number.
Declaration
public bool UseGroupingSeparator { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
Width
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 string Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |