CircularGaugeModel

23 Sep 20254 minutes to read

Interface for a class CircularGauge

Properties

animationComplete EmitType<IAnimationCompleteEventArgs>

Triggers after the animation gets completed for pointers.

annotationRender EmitType<IAnnotationRenderEventArgs>

Triggers before each annotation for the circular gauge gets rendered.

axisLabelRender EmitType<IAxisLabelRenderEventArgs>

Triggers before each axis label gets rendered.

beforePrint EmitType<IPrintEventArgs>

Triggers before the prints gets started.

dragEnd EmitType<IPointerDragEventArgs>

Triggers after the pointer is dragged.

dragMove EmitType<IPointerDragEventArgs>

Triggers while dragging the pointers.

dragStart EmitType<IPointerDragEventArgs>

Triggers before the pointer is dragged.

gaugeMouseDown EmitType<IMouseEventArgs>

Triggers on mouse down.

gaugeMouseLeave EmitType<IMouseEventArgs>

Triggers while cursor leaves the circular gauge.

gaugeMouseMove EmitType<IMouseEventArgs>

Triggers on hovering the circular gauge.

gaugeMouseUp EmitType<IMouseEventArgs>

Triggers when mouse up action is performed over the circular gauge.

legendRender EmitType<ILegendRenderEventArgs>

Triggers before each legend for the circular gauge gets rendered.

load EmitType<ILoadedEventArgs>

Triggers before the circular gauge gets loaded.

loaded EmitType<ILoadedEventArgs>

Triggers after the circular gauge gets loaded.

radiusCalculate EmitType<IRadiusCalculateEventArgs>

Triggers before the radius for the circular gauge gets calculated.

resized EmitType<IResizeEventArgs>

Triggers to notify the resize of the circular gauge when the window is resized.

tooltipRender EmitType<ITooltipRenderEventArgs>

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

allowImageExport boolean

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

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.

allowPdfExport boolean

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

allowPrint boolean

Enables and disables the print functionality in circular gauge.

allowRangePreRender boolean

Allow the range element to be rendered ahead of the axis element, when this property is set to “true”.

animationDuration number

Sets and gets the duration of animation in milliseconds in circular gauge.

axes AxisModel[]

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

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.

border BorderModel

Sets and gets the options for customizing the style properties of the gauge border.

centerX string

Sets and gets the X coordinate of the center of the circular gauge.

centerY string

Sets and gets the Y coordinate of the center of the circular gauge.

description string

Sets and gets the information about gauge for assistive technology.

enablePersistence boolean

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

enablePointerDrag boolean

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

enableRangeDrag boolean

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

enableRtl boolean

Enable or disable rendering component in right to left direction.

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.

legendSettings LegendSettingsModel

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

locale string

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

margin MarginModel

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

moveToCenter boolean

Enables and disables placing the half or quarter circle in center, if centerX and centerY properties are not specified.

tabIndex number

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

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.

title string

Sets and gets the title for circular gauge.

titleStyle FontModel

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

tooltip TooltipSettingsModel

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

useGroupingSeparator boolean

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

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.