Class CircularGauge

Inheritance
System.Object
TagHelper
EJTagHelper
CircularGauge
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.CircularGauge
Assembly: Syncfusion.EJ2.dll
Syntax
public class CircularGauge : EJTagHelper

Constructors

CircularGauge()

Declaration
public CircularGauge()

Properties

AllowImageExport

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

Declaration
[HtmlAttributeName("allowImageExport")]
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
[HtmlAttributeName("allowMargin")]
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
[HtmlAttributeName("allowPdfExport")]
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
[HtmlAttributeName("allowPrint")]
public bool AllowPrint { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

AnimationComplete

Triggers after the animation gets completed for pointers.

Declaration
[HtmlAttributeName("animationComplete")]
public string AnimationComplete { get; set; }
Property Value
Type Description
System.String

The default value is null

AnnotationRender

Triggers before each annotation for the circular gauge gets rendered.

Declaration
[HtmlAttributeName("annotationRender")]
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
[HtmlAttributeName("axes")]
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
[HtmlAttributeName("axisLabelRender")]
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
[HtmlAttributeName("background")]
public string Background { get; set; }
Property Value
Type Description
System.String

The default value is null

BeforePrint

Triggers before the prints gets started.

Declaration
[HtmlAttributeName("beforePrint")]
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
[HtmlAttributeName("border")]
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
[HtmlAttributeName("centerX")]
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
[HtmlAttributeName("centerY")]
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
[HtmlAttributeName("description")]
public string Description { get; set; }
Property Value
Type Description
System.String

The default value is null

DragEnd

Triggers after the pointer is dragged.

Declaration
[HtmlAttributeName("dragEnd")]
public string DragEnd { get; set; }
Property Value
Type Description
System.String

The default value is null

DragMove

Triggers while dragging the pointers.

Declaration
[HtmlAttributeName("dragMove")]
public string DragMove { get; set; }
Property Value
Type Description
System.String

The default value is null

DragStart

Triggers before the pointer is dragged.

Declaration
[HtmlAttributeName("dragStart")]
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
[HtmlAttributeName("enablePersistence")]
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
[HtmlAttributeName("enablePointerDrag")]
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
[HtmlAttributeName("enableRangeDrag")]
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
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

GaugeMouseDown

Triggers on mouse down.

Declaration
[HtmlAttributeName("gaugeMouseDown")]
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
[HtmlAttributeName("gaugeMouseLeave")]
public string GaugeMouseLeave { get; set; }
Property Value
Type Description
System.String

The default value is null

GaugeMouseMove

Triggers on hovering the circular gauge.

Declaration
[HtmlAttributeName("gaugeMouseMove")]
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
[HtmlAttributeName("gaugeMouseUp")]
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
[HtmlAttributeName("height")]
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
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

LegendRender

Triggers before each legend for the circular gauge gets rendered.

Declaration
[HtmlAttributeName("legendRender")]
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
[HtmlAttributeName("legendSettings")]
public CircularGaugeLegendSettings LegendSettings { get; set; }
Property Value
Type Description
CircularGaugeLegendSettings

The default value is null

Load

Triggers before the circular gauge gets loaded.

Declaration
[HtmlAttributeName("load")]
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
[HtmlAttributeName("loaded")]
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
[HtmlAttributeName("locale")]
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
[HtmlAttributeName("margin")]
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
[HtmlAttributeName("moveToCenter")]
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
[HtmlAttributeName("radiusCalculate")]
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
[HtmlAttributeName("resized")]
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
[HtmlAttributeName("tabIndex")]
public double TabIndex { get; set; }
Property Value
Type Description
System.Double

The default value is 1

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
[HtmlAttributeName("theme")]
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
[HtmlAttributeName("title")]
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
[HtmlAttributeName("titleStyle")]
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
[HtmlAttributeName("tooltip")]
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
[HtmlAttributeName("tooltipRender")]
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
[HtmlAttributeName("useGroupingSeparator")]
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
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

The default value is null