BuyLog In
DevExtreme
All docs
V 20.1
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
19.1
18.2
18.1
17.2
All docs
V20.1

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
24.2
24.1
23.2
23.1
22.2
22.1
21.2
21.1
20.2
20.1
19.2
19.1
18.2
18.1
17.2
Full-text search
API Reference
UI Components
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
ButtonGroup
Calendar
Chart
CheckBox
CircularGauge
Configuration
Methods
beginUpdate()
dispose()
element()
endUpdate()
exportTo(fileName, format)
getInstance(element)
getSize()
hideLoadingIndicator()
instance()
off(eventName)
off(eventName, eventHandler)
on(eventName, eventHandler)
on(events)
option()
option(optionName)
option(optionName, optionValue)
option(options)
print()
render()
resetOption(optionName)
showLoadingIndicator()
subvalues()
subvalues(subvalues)
svg()
value()
value(value)
Events
Indicator Types
ColorBox
ContextMenu
DataGrid
DateBox
DeferRendering
Diagram
Draggable
Drawer
DropDownBox
DropDownButton
FileManager
FileUploader
FilterBuilder
Form
Funnel
Gallery
Gantt
HtmlEditorCTP
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NavBar
NumberBox
PieChart
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Sankey
Scheduler
ScrollView
SelectBox
SlideOut
SlideOutView
Slider
Sortable
Sparkline
SpeedDialAction
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
TreeMap
TreeView
ValidationGroup
ValidationSummary
Validator
VectorMap
Markup Components
UI Events
CSS Classes
Data Layer
Types
Utilities
Angular
React
Vue
ASP.NET MVC 5
ASP.NET Core
jQuery
UI Components
Data Binding
Common Features
Migrate to the New Version

General Information

.NET Subscription

What's Included
DevExpress Installation
DevExpress Code Examples

Common Tools

Project Converter
Assembly Deployment Tool
Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)
TestCafe Studio

Desktop

Controls

WinForms
WPF
VCL
WinUI

Tools

WinForms Skin Editor
WPF Theme Designer
WPF Theme Editor (Legacy)
Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI
XPO - .NET ORM Library (FREE)
XPO Profiler
Core Libraries
Drawing Graphics Library
.NET App Security & Web API Service (FREE)

Web

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

Mobile

Xamarin UI Controls (FREE)
.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting
Report and Dashboard Server
BI Dashboard
Office File API

End-User Documentation

Interface Elements for Desktop
Interface Elements for Web
Dashboard for Desktop
Dashboard for Web
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery CircularGauge Methods

This section describes methods that can be used to manipulate the UI component.

See Also

beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.

See Also

dispose()

Disposes of all the resources allocated to the CircularGauge instance.

After calling this method, remove the DOM element associated with the UI component:

JavaScript
$("#myCircularGauge").dxCircularGauge("dispose");
$("#myCircularGauge").remove();

Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular
app.component.html
<dx-circular-gauge ...
    *ngIf="condition">
</dx-circular-gauge>
Vue
App.vue
<template>
    <DxCircularGauge ...
        v-if="condition">
    </DxCircularGauge>
</template>

<script>
import DxCircularGauge from 'devextreme-vue/circular-gauge';

export default {
    components: {
        DxCircularGauge
    }
}
</script>
React
App.js
import React from 'react';

import CircularGauge from 'devextreme-react/circular-gauge';

function DxCircularGauge(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <CircularGauge ... >    
        </CircularGauge>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxCircularGauge shouldRender="condition" />
        );
    }
}
export default App;
See Also

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the UI component.

Parameters:
fileName:

String

The name of the file to which the UI component is about to be exported.

format:

String

The file's format. One of 'PNG', 'PDF', 'JPEG', 'SVG' and 'GIF'.
PNG is used if the browser does not support exporting to the specified format.

View Demo

See Also

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the CircularGauge instance found in an element with the myCircularGauge ID:

// Modular approach
import CircularGauge from "devextreme/viz/circular_gauge";
...
let element = document.getElementById("myCircularGauge");
let instance = CircularGauge.getInstance(element) as CircularGauge;

// Non-modular approach
let element = document.getElementById("myCircularGauge");
let instance = DevExpress.viz.dxCircularGauge.getInstance(element);
See Also

getSize()

Gets the current UI component size.

Return Value:

Size

The current UI component size.

Returns an object with the following fields.

  • width
    The width of the UI component in pixels.
  • height
    The height of the UI component in pixels.
See Also

hideLoadingIndicator()

Hides the loading indicator.

Although the loading indicator hides automatically once the UI component is ready, you can hide it from code at the required moment using this method.

See Also

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

CircularGauge

This UI component's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

CircularGauge

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

CircularGauge

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

CircularGauge

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

CircularGauge

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets all UI component properties.

Return Value:

Object

The UI component's properties.

See Also

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

See Also

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

See Also

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Propertieswith their new values.

See Also

print()

Opens the browser's print window.

View Demo

See Also

render()

Redraws the UI component.

Normally, the UI component redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the UI component's container is resized. For this purpose, call the render() method.

See Also

resetOption(optionName)

Resets an property to its default value.

Parameters:
optionName:

String

An property's name.

See Also

showLoadingIndicator()

Shows the loading indicator.

See Also

subvalues()

Gets subvalues.

Return Value:

Array<Number>

The subvalues.

See the subvalues property description for more information on gauge subvalues.

View Demo

See Also

subvalues(subvalues)

Updates subvalues.

Parameters:
subvalues:

Array<Number>

New subvalues.

Use this method to change gauge subvalues at runtime.

NOTE
It is necessary to set the subvalues property in order to use the subvalues(subvalues) method. Set this property to an empty array, in case you don't need to show subvalues initially.

Value Indicators API Demo Subvalue Indicators Demo

See Also

svg()

Gets the UI component's SVG markup.

Return Value:

String

The UI component's SVG markup.

View Demo

See Also

value()

Gets the main value.

Return Value:

Number

The main value.

See the value property description for more information on the main gauge value.

View Demo

See Also

value(value)

Updates the main value.

Parameters:
value:

Number

A new value.

Use this method to change the main gauge value at runtime.

Value Indicators API Demo Subvalue Indicators Demo

See Also