Angular CircularGauge Properties

An object that defines configuration properties for the CircularGauge UI component.

See Also
jQuery
Angular
Vue
React

animation

Specifies animation properties.

Selector: dxo-animation
Type: viz/gauges/base_gauge:BaseGaugeAnimation

To make your gauge "live", enable animation for it by setting the enabled property of the animation object to true. In this instance, the gauge indicators will appear in motion. In addition, within the animation object, you can set an appropriate easing mode using the easing property and specify how long the animation should run using the duration property.

jQuery
index.js
$(function() {
    $("#circularGaugeContainer").dxCircularGauge({
        // ...
        animation: {
            easing: "linear",
            duration: 500
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-circular-gauge ... >
    <dxo-animation
        easing="linear"
        [duration]="500">
    </dxo-animation>
</dx-circular-gauge>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxCircularGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxCircularGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxCircularGauge ... >
        <DxAnimation
            easing="linear"
            :duration="500"
        />
    </DxCircularGauge>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxCircularGauge, {
    DxAnimation
} from 'devextreme-vue/circular-gauge';

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

import 'devextreme/dist/css/dx.light.css';

import CircularGauge, {
    Animation 
} from 'devextreme-react/circular-gauge';

class App extends React.Component {
    render() {
        return (
            <CircularGauge ... >
                <Animation
                    easing="linear"
                    duration={500}
                />
            </CircularGauge>
        );
    }
}
export default App;
ASP.NET MVC Controls
Razor C#
@(Html.DevExtreme().CircularGauge()
    @* ... *@
    .Animation(a => a
        .Easing(VizAnimationEasing.Linear)
        .Duration(500)
    )
)

centerTemplate

Specifies a custom template for content in the component's center.

Type:

template

| undefined
Function parameters:
component:

CircularGauge

The UI component's instance.

element:

SVGGElement

An empty SVGGElement that acts as a container for the template content.

Return Value:

String

|

SVGElement

|

jQuery

One of the following:

  • SVG markup as a string
  • An SVGElement
  • SVG markup wrapped in a jQuery element
Default Value: undefined

You need to render template content as an SVG element. The following code snippet shows how to specify a custom template for content in the CircularGauge's center:

jQuery
$(function(){
    $("#circularGaugeContainer").dxCircularGauge({
        // ...
        centerTemplate: (gauge, container) => {
            const rect = createRect(50, 50, 'transparent');
            const text = createText(10, 200, 12, 'start', gauge.value());

            container.appendChild(rect);
            container.appendChild(text);
        },
    });
});

function createRect(width, height, fill) {
    const rect = document.createElementNS('http://www.w3.org/2000/svg', 'rect');

    rect.setAttribute('x', 0);
    rect.setAttribute('y', 0);
    rect.setAttribute('width', width);
    rect.setAttribute('height', height);
    rect.setAttribute('fill', fill);

    return rect;
}

function createText(x, y, fontSize, textAnchor, content) {
    const text = document.createElementNS('http://www.w3.org/2000/svg', 'text');

    text.setAttribute('x', x);
    text.setAttribute('y', y);
    text.setAttribute('fill', '#000');
    text.setAttribute('text-anchor', textAnchor);
    text.setAttribute('font-size', fontSize);

    text.textContent = content;

    return text;
}
Angular
app.component.html
app.module.ts
<dx-circular-gauge centerTemplate="centerTemplate" ... >
    <svg *dxTemplate="let gauge of 'centerTemplate'">
        <rect x="0" y="0" width="50" height="50" fill="transparent"></rect>
        <text text-anchor="start" y="200" x="10" fill="#000" font-size="12">
           {{gauge.value()}}
        </text>
    </svg>
</dx-circular-gauge>
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxCircularGaugeModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxCircularGaugeModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <DxCircularGauge center-template="centerTemplate" ... >
        <template #centerTemplate="data">
            <svg>
                <rect x="0" y="0" width="50" height="50" fill="transparent"></rect>
                <text text-anchor="start" y="200" x="10" fill="#000" font-size="12">
                    {{data.data.value()}}
                </text>
            </svg>
        </template>
    >
    </DxCircularGauge>
</template>

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

export default {
    components: {
        DxCircularGauge
    },
    data() {
        return {
            // ...
        }
    }
}
</script>
<template>
    <DxCircularGauge center-template="centerTemplate" ... >
        <template #centerTemplate="data">
            <svg>
                <rect x="0" y="0" width="50" height="50" fill="transparent"></rect>
                <text text-anchor="start" y="200" x="10" fill="#000" font-size="12">
                    {{data.data.value()}}
                </text>
            </svg>
        </template>
    >
    </DxCircularGauge>
</template>

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

const data = { ... };
// ...
</script>
React
App.js
import CircularGauge from 'devextreme-react/circular-gauge';

const CenterTemplate = (gauge) => {
    return (
        <svg>
            <rect x="0" y="0" width="50" height="50" fill="transparent"></rect>
            <text text-anchor="start" y="200" x="10" fill="#000" font-size="12">
                {gauge.value()}
            </text>
        </svg>
    );
}

export default function App() { 
    return ( 
        <CircularGauge centerRender={CenterTemplate} ... >   
            { /* ... */ } 
        </CircularGauge>       
    ); 
}

containerBackgroundColor

Specifies the color of the parent page element.

Type:

String

Default Value: 'none'

Set this property to the color of the parent page element. Certain elements of the UI component will use this color so that they coordinate with the page. Currently, different auxiliary separators use the container background color, so there is no need to set a custom color for them.

This property supports the following colors:

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false
Cannot be used in themes.

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Selector: dxo-element-attr
Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#circularGaugeContainer").dxCircularGauge({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-circular-gauge ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-circular-gauge>
import { DxCircularGaugeModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxCircularGaugeModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxCircularGauge ...
        :element-attr="circularGaugeAttributes">
    </DxCircularGauge>
</template>

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

export default {
    components: {
        DxCircularGauge
    },
    data() {
        return {
            circularGaugeAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

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

class App extends React.Component {
    circularGaugeAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <CircularGauge ...
                elementAttr={this.circularGaugeAttributes}>
            </CircularGauge>
        );
    }
}
export default App;

export

Configures the exporting and printing features.

Selector: dxo-export
Type: viz/core/base_widget:BaseWidgetExport

These features allow a user to export your UI component into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the UI component. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

See Also

geometry

Specifies the properties required to set the geometry of the CircularGauge UI component.

Selector: dxo-geometry
Type:

Object

Specify the startAngle and endAngle properties of the geometry configuration object to customize the shape of the circular gauge's arc. This arc is drawn from the startAngle to the endAngle as it is illustrated by the following image.

GaugeGeometry ChartJS

View Demo

loadingIndicator

Configures the loading indicator.

Selector: dxo-loading-indicator
Type: viz/gauges/base_gauge:BaseGaugeLoadingIndicator

When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.

DevExtreme Gauges - Loading indicator

To change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.

margin

Generates space around the UI component.

Selector: dxo-margin
Type: viz/core/base_widget:BaseWidgetMargin

WidgetMargin DevExtreme ChartJS

jQuery
index.js
$(function() {
    $("#circularGaugeContainer").dxCircularGauge({
        // ...
        margin: {
            top: 20,
            bottom: 20,
            left: 30,
            right: 30
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-circular-gauge ... >
    <dxo-margin
        [top]="20"
        [bottom]="20"
        [left]="30"
        [right]="30">
    </dxo-margin>
</dx-circular-gauge>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxCircularGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxCircularGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxCircularGauge ... >
        <DxMargin
            :top="20"
            :bottom="20"
            :left="30"
            :right="30"
        />
    </DxCircularGauge>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxCircularGauge, {
    DxMargin 
} from 'devextreme-vue/circular-gauge';

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

import 'devextreme/dist/css/dx.light.css';

import CircularGauge, {
    Margin 
} from 'devextreme-react/circular-gauge';

class App extends React.Component {
    render() {
        return (
            <CircularGauge ... >
                <Margin
                    top={20}
                    bottom={20}
                    left={30}
                    right={30}
                />
            </CircularGauge>
        );
    }
}
export default App;

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:
e:

DisposingEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null

onDrawn

A function that is executed when the UI component's rendering has finished.

Type:

Function

Function parameters:
e:

DrawnEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null
Cannot be used in themes.

onExported

A function that is executed after the UI component is exported.

Type:

Function

Function parameters:
e:

ExportedEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null

See Also

onExporting

A function that is executed before the UI component is exported.

Type:

Function

Function parameters:
e:

ExportingEvent

Information about the event.

Object structure:
Name Type Description
format

String

The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.
fileName

String

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

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null

See Also

onFileSaving

A function that is executed before a file with exported UI component is saved to the user's local storage.

Type:

Function

Function parameters:
e:

FileSavingEvent

Information about the event.

Object structure:
Name Type Description
format

String

The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
fileName

String

The name of the file to be saved.
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
data

BLOB

Exported data as a BLOB.
component

CircularGauge

The UI component's instance.
cancel

Boolean

Allows you to prevent file saving.
Default Value: null

See Also

onIncidentOccurred

A function that is executed when an error or warning occurs.

Type:

Function

Function parameters:
e:

IncidentOccurredEvent

Information about the event.

Object structure:
Name Type Description
target any

Information on the occurred incident.
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null

The UI component notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

  • id
    The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
  • type
    The incident's type: "error" or "warning".
  • args
    The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the property that was not set properly.
  • text
    The text passed to the browser's console. Includes the args content, if there is any.
  • widget
    The name of the UI component that produced the error or warning.
  • version
    The used DevExtreme version.

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function

Function parameters:
e:

InitializedEvent

Information about the event.

Object structure:
Name Type Description
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null

Angular
app.component.html
app.component.ts
<dx-circular-gauge ...
    (onInitialized)="saveInstance($event)">
</dx-circular-gauge>
import { Component } from "@angular/core";
import CircularGauge from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    circularGaugeInstance: CircularGauge;
    saveInstance (e) {
        this.circularGaugeInstance = e.component;
    }
}
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <div>
        <DxCircularGauge ...
            @initialized="saveInstance">
        </DxCircularGauge>
    </div>
</template>

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

export default {
    components: {
        DxCircularGauge
    },
    data: function() {
        return {
            circularGaugeInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.circularGaugeInstance = e.component;
        }
    }
};
</script>
<template>
    <div>
        <DxCircularGauge ...
            @initialized="saveInstance">
        </DxCircularGauge>
    </div>
</template>

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

let circularGaugeInstance = null;

const saveInstance = (e) => {
    circularGaugeInstance = e.component;
}
</script>
React
App.js
import CircularGauge from 'devextreme-react/circular-gauge';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.circularGaugeInstance = e.component;
    }

    render() {
        return (
            <div>
                <CircularGauge onInitialized={this.saveInstance} />
            </div>
        );
    }
}
See Also
jQuery
  • Get a UI component Instance in jQuery
Angular
  • Get a UI component Instance in Angular
Vue
  • Get a UI component Instance in Vue
React
  • Get a UI component Instance in React

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:
e:

OptionChangedEvent

Information about the event.

Object structure:
Name Type Description
value any

The modified property's new value.
previousValue any

The UI component's previous value.
name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullName

String

The path to the modified property that includes all parent properties.
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#circularGaugeContainer").dxCircularGauge({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-circular-gauge ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-circular-gauge>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxCircularGaugeModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxCircularGaugeModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }
Vue
App.vue
<template> 
    <DxCircularGauge ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxCircularGauge from 'devextreme-vue/circular-gauge'; 

export default { 
    components: { 
        DxCircularGauge
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script>
React
App.js
import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

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

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <CircularGauge ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
}

onTooltipHidden

A function that is executed when a tooltip becomes hidden.

Type:

Function

Function parameters:
e:

TooltipHiddenEvent

Information about the event.

Object structure:
Name Type Description
target

Object

Information on the (sub)value indicator being pressed or hovered over with the mouse pointer. Contains the type ("value-indicator" or "subvalue-indicator") and index (undefined for value indicators) fields.
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null
Cannot be used in themes.

onTooltipShown

A function that is executed when a tooltip appears.

Type:

Function

Function parameters:
e:

TooltipShownEvent

Information about the event.

Object structure:
Name Type Description
target

Object

Information on the (sub)value indicator being pressed or hovered over with the mouse pointer. Contains the type ("value-indicator" or "subvalue-indicator") and index (undefined for value indicators) fields.
element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component

CircularGauge

The UI component's instance.
Default Value: null
Cannot be used in themes.

pathModified

Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path.

Type:

Boolean

Default Value: false
Cannot be used in themes.

If you place the UI component on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the UI component elements may get mixed up or disappear. To solve this problem, set the pathModified property to true.

See Also

rangeContainer

Specifies gauge range container properties.

Selector: dxo-range-container
Type:

RangeContainer

For the purpose of more intelligible data visualization, you can combine values into ranges and color each range differently. For instance, you can indicate the range of warm and cold temperatures. To set the ranges, assign an array of objects defining the ranges to the ranges property of the rangeContainer configuration object. In addition, you can specify the orientation of the ranges relative to an invisible scale line, and an offset from this line using the rangeContainer properties.

redrawOnResize

Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates.

Type:

Boolean

Default Value: true
Cannot be used in themes.

When this property is set to true, the UI component will be redrawn automatically in case the size of its container changes.

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

Boolean

Default Value: false
Cannot be used in themes.

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
NOTE
In a right-to-left representation, SVG elements have the direction attribute with the rtl value. This might cause problems when rendering left-to-right texts. Use this property if you have only right-to-left texts.

scale

Specifies a gauge's scale properties.

Selector: dxo-scale
Type:

Scale

To divide a scale, set its startValue and endValue properties. The scale's major and minor ticks will be calculated automatically. Major ticks will be shown by default. To show minor ticks, set their visible property to true. You can set custom major and minor tick intervals, show custom major and minor ticks, and format tick labels. These and other scale properties are available in the scale configuration object.

size

Specifies the UI component's size in pixels.

Selector: dxo-size
Type: viz/core/base_widget:BaseWidgetSize
Default Value: {height: 300, width: 300}

You can specify a custom width and height for the component:

Fixed Relative
Assign values to the size object's height and width properties or specify a container for the component. Specify a container for the component. The component occupies the container area.
NOTE
The size object has priority over the container.
jQuery
index.js
$(function() {
    $("#circularGaugeContainer").dxCircularGauge({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-circular-gauge ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-circular-gauge>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxCircularGaugeModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxCircularGaugeModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxCircularGauge ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxCircularGauge>
</template>

<script>

import DxCircularGauge, {
    DxSize
} from 'devextreme-vue/circular-gauge';

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

import CircularGauge, {
    Size
} from 'devextreme-react/circular-gauge';

class App extends React.Component {
    render() {
        return (
            <CircularGauge ... >
                <Size
                    height={300}
                    width={600}
                />
            </CircularGauge>
        );
    }
}
export default App;

Alternatively, you can use CSS to style the UI component's container:

jQuery
index.js
styles.css
$(function() {
    $("#circularGauge").dxCircularGauge({
        // ...
    });
});
#circularGauge {
    width: 85%;
    height: 70%;
}
Angular
app.component.html
app.styles.css
<dx-circular-gauge ...
    id="circularGauge">
</dx-circular-gauge>
#circularGauge {
    width: 85%;
    height: 70%;
}
Vue
App.vue
<template>
    <DxCircularGauge ...
        id="circularGauge">
    </DxCircularGauge>
</template>

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

export default {
    components: {
        DxCircularGauge
    },
    // ...
}
</script>

<style>
#circularGauge {
    width: 85%;
    height: 70%;
}
</style>
React
App.js
styles.css
import React from 'react';

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

class App extends React.Component {
    render() {
        return (
            <CircularGauge ...
                id="circularGauge">
            </CircularGauge>
        );
    }
}
export default App;
#circularGauge {
    width: 85%;
    height: 70%;
}

subvalueIndicator

Specifies the appearance properties of subvalue indicators.

Selector: dxo-subvalue-indicator
Type:

Object

The CircularGauge UI component can display one main value and several subvalues. The gauge's main value and subvalues are indicated by special pointers. You can customize the appearance of these pointers using the valueIndicator and subvalueIndicator configuration objects correspondingly.

The subvalue indicator is a pointer which designates an extra value on a scale. There are several types of subvalue indicators. Set the required one by using the type property, and then specify the properties that are specific to this type, if needed. To learn about the properties that can be specified for a particular type, refer to one of the following sections.

View Demo

subvalues

Specifies a set of subvalues to be designated by the subvalue indicators.

Type:

Array<Number>

Default Value: undefined
Raised Events: onOptionChanged
Cannot be used in themes.

In addition to one main value, you can indicate several extra values on a gauge. These are called subvalues. To specify the subvalues, assign an array with them to the subvalues field.

You can obtain and change the subvalues at runtime. In order to do this, use the subvalues() and subvalues(subvalues) methods. Note that in that case, you need to initialize the subvalues property at least with an empty array.

JavaScript
var gaugeOptions = {
    // ...
    subvalues: []    
}

Subvalues are designated by subvalue indicators. You can customize the appearance of these indicators using the subvalueIndicator configuration object.

View Demo

theme

Sets the name of the theme the UI component uses.

Type:

Theme

Default Value: 'generic.light'

A theme is a UI component configuration that gives the UI component a distinctive appearance. You can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.

title

Configures the UI component's title.

Selector: dxo-title
Type: viz/core/base_widget:BaseWidgetTitle

The UI component's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title property. Otherwise, set this property to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

tooltip

Configures tooltips.

Selector: dxo-tooltip
Type: viz/gauges/base_gauge:BaseGaugeTooltip

A tooltip is a miniature rectangle displaying the value of a gauge's indicator. A tooltip appears when the end-user hovers the cursor over an indicator. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

value

Specifies the main value on a gauge.

Type:

Number

| undefined
Default Value: undefined
Raised Events: onOptionChanged
Cannot be used in themes.

The main value is designated by the value indicator. To customize the appearance of the value indicator, use the valueIndicator configuration object.

You can obtain and change the gauge value at runtime. In order to do this, use the value() and value(value) methods.

Only one main value can be indicated on a gauge. Besides the main gauge value, you can indicate several extra values. Refer to the subvalues property description for more information.

See Also

valueIndicator

Specifies the appearance properties of the value indicator.

Selector: dxo-value-indicator
Type:

Object

The value indicator is a pointer which designates the main value of the gauge. There are several types of value indicators. Set the required one by using the type property, and then specify the properties that are specific to this type, if needed. To learn the properties that can be specified for a particular type, refer to one of the following sections.

View Demo