Gauge pointers in EJ2 TypeScript Circular gauge control
15 Dec 202424 minutes to read
Pointers are used to indicate values on the axis. Value of the pointer can be modified using the value
property.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 90
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Gauge supports 3 types of pointers such as Needle
, RangeBar
and Marker
. You can choose any one of the pointer by using type
property.
Needle Pointers
A needle pointer contains three parts, a needle, a cap / knob and a tail. The length of the needle can be customized by using radius
property. The length of the tail can be
customized by using length
property. The radius of the cap can be customized by using radius
in cap object. The needle and tail
length takes value either in percentage
or pixel
.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 90,
radius: '50%',
cap: {
radius: 10
},
needleTail: {
length: '25%'
}
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Customization
Needle color and width can be customized by using color
and pointerWidth
property.
Cap and tails can be customized by using cap
and needleTail
object.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 90,
radius: '50%',
cap: {
radius: 15,
color: 'white',
border: {
color: '#007DD1',
width: 5
}
},
needleTail: {
length: '22%',
color: '#007DD1'
},
color: '#007DD1',
pointerWidth: 25
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
The appearance of the needle pointer can be customized by using needleStartWidth
and needleEndWidth
.
import { CircularGauge, Annotations} from '@syncfusion/ej2-circulargauge';
CircularGauge.Inject(Annotations);
let gauge: CircularGauge = new CircularGauge({
axes: [{
startAngle: 270,
endAngle: 90,
lineStyle: { width: 3, color: '#1E7145' },
labelStyle: {
position: 'Outside',
font: { size: '0px', color: '#1E7145' }
}, majorTicks: {
width: 1,
height: 0,
interval: 100
}, minorTicks: {
height: 0,
width: 0,
},
radius: '90%',
minimum: 0,
maximum: 100,
pointers: [{
animation: { enable: true , duration: 1000},
value: 70,
radius: '80%',
color: 'green',
pointerWidth: 2,
needleStartWidth: 4,
needleEndWidth: 4,
cap: {
radius: 8,
color: 'green'
},
needleTail: {
length: '0%'
}
}],
annotations: [
{
angle: 180, zIndex: '1',
radius: '20%',
content: '<div style="color:#757575; font-family:Roboto; font-size:14px;padding-top: 26px">Customized Needle</div>'
}
]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
RangeBar Pointer
RangeBar pointer is like ranges in an axis, that can be placed on gauge to mark the pointer value.
RangeBar starts from the beginning of the gauge and ends at the pointer value.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 50,
type: 'RangeBar',
radius: '60%'
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Customization
RangeBar can be customized in terms of color, border and thickness by using
color
, border
and pointerWidth
property.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 50,
type: 'RangeBar',
radius: '60%',
color: '#007DD1',
border: {
color: 'grey',
width: 2
},
pointerWidth: 15
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Rounded corner for range bar pointer
The start and end pointers of range bar in the circular gauge are rounded to form arc gauges.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
lineStyle: {
color: 'transparent'
},
ranges: [
{ start: 0, end: 50, color: '#30B32D', radius:'108%' },
{ start: 50, end: 100, color: '#FFDD00', radius:'108%' }
],
pointers: [{
value: 50,
type: 'RangeBar',
roundedCornerRadius: 6
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Marker Pointer
Different type of marker shape can be used to mark the pointer value in axis. You can change the marker shape using markerShape
property in pointer. Gauge supports the below marker shape.
- Circle
- Rectangle
- Triangle
- InvertedTriangle
- Diamond
We can use image instead of rendering marker shape to denote the pointer value. It can be achieved by setting markerShape
to Image and assigning image path to imageUrl
in pointer.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 90,
type: 'Marker',
markerShape: 'InvertedTriangle',
radius: '100%',
markerHeight: 15,
markerWidth: 15
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Customization
The marker can be customized in terms of color, border, width and height by using
color
,
border
,
markerWidth
and
markerHeight
property in
pointer
.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 90,
type: 'Marker',
markerShape: 'Triangle',
radius: '100%',
color: 'white',
border: {
color: '#007DD1',
width: 2
},
markerHeight: 15,
markerWidth: 15
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Dragging pointer
The pointers can be dragged along the axis line by clicking and dragging them. To enable or disable the drag functionality for all pointers across all axes, use the enablePointerDrag property. When this property is set to true, all pointers can be dynamically adjusted by dragging. Setting it to false keeps all pointers fixed in their specified positions.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
enablePointerDrag:true,
height:'250px',
width:'250px',
axes: [{
pointers: [{
value: 50
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Enabling drag functionality for a specific pointer
To enable or disable the drag functionality for specific pointers along the axis line, use the enableDrag property in the required pointer model.
When the
enableDrag
property is enabled for any individual pointer model, theenablePointerDrag
property becomes ineffective.
The following example demonstrates how to enable the drag functionality for multiple pointers individually.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
enableDrag: false,
value: 90,
type: 'Marker',
markerShape: 'InvertedTriangle',
radius: '100%',
markerHeight: 15,
markerWidth: 15
}, {
enableDrag: true,
value: 90,
type: 'RangeBar',
radius: '60%',
pointerWidth: 10
}, {
enableDrag: true,
value: 90,
radius: '60%',
cap: {
radius: 15,
border: {
width: 5
}
},
needleTail: {
length: '22%',
},
pointerWidth: 25
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Multiple Pointers
In addition to the default pointer, you can add n number of pointer to an axis by using pointers
property.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 90,
type: 'Marker',
markerShape: 'InvertedTriangle',
radius: '100%',
markerHeight: 15,
markerWidth: 15
}, {
value: 90,
type: 'RangeBar',
radius: '60%',
pointerWidth: 10
}, {
value: 90,
radius: '60%',
cap: {
radius: 15,
border: {
width: 5
}
},
needleTail: {
length: '22%',
},
pointerWidth: 25
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Animation
Pointer will get animate on loading the gauge, this can be handled by using
animation
property in pointer.
The enable
property in animation allows you to enable or disable the animation.
The duration
property specify the duration of the animation in milliseconds.
import { CircularGauge } from '@syncfusion/ej2-circulargauge';
let gauge: CircularGauge = new CircularGauge({
axes: [{
pointers: [{
value: 90,
animation: {
enable: true,
duration: 1500
}
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Gradient Color
Gradient support allows to add multiple colors in the ranges and pointers of the circular gauge. The following gradient types are supported in the circular gauge.
- Linear Gradient
- Radial Gradient
Linear Gradient
Using linear gradient, colors will be applied in a linear progression. The start value of the linear gradient can be set using the startValue
property. The end value of the linear gradient will be set using the endValue
property. The color stop values such as color, opacity and offset are set using colorStop
property.
The linear gradient can be applied to all pointer types like marker, range bar and needle. To do so, follow the below code sample.
import { CircularGauge, Gradient } from '@syncfusion/ej2-circulargauge';
CircularGauge.Inject(Gradient);
let pointerLinearGradient: Object = {
startValue: '0%',
endValue: '100%',
colorStop: [
{ color: '#FEF3F9', offset: '0%', opacity: 0.9 },
{ color: '#E63B86', offset: '70%', opacity: 0.9 }
]
};
let gauge: CircularGauge = new CircularGauge({
axes: [{
startAngle: 270,
endAngle: 90,
lineStyle: { width: 3, color: '#E63B86' },
labelStyle: {
font: { size: '0px' }
}, majorTicks: {
height: 0
}, minorTicks: {
height: 0
},
radius: '90%',
minimum: 0,
maximum: 100,
pointers: [{
radius: '80%',
value: 80,
animation: { enable: true, duration: 1000 },
pointerWidth: 10,
linearGradient: pointerLinearGradient,
cap: {
radius: 8,
color: 'white',
border: {
color: '#E63B86',
width: 1
}
},
needleTail: {
length: '20%',
linearGradient: pointerLinearGradient,
}
}, {
radius: '60%', value: 40,
animation: { duration: 1000 },
pointerWidth: 10,
linearGradient: pointerLinearGradient,
cap: {
radius: 8, color: 'white',
border: { color: '#E63B86', width: 1 }
},
needleTail: {
length: '20%',
linearGradient: pointerLinearGradient
}
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>
Radial Gradient
Using radial gradient, colors will be applied in circular progression. The inner circle position of the radial gradient will be set using the innerPosition
property. The outer circle position of the radial gradient can be set using the outerPosition
property. The color stop values such as color, opacity and offset are set using colorStop
property.
The radial gradient can be applied to all pointer types like marker, range bar and needle. To do so, follow the below code sample.
import { CircularGauge, Gradient } from '@syncfusion/ej2-circulargauge';
CircularGauge.Inject(Gradient);
let pointerRadialGradient: Object = {
radius: '50%',
innerPosition: { x: '50%', y: '50%' },
outerPosition: { x: '50%', y: '50%' },
colorStop: [
{ color: '#FEF3F9', offset: '0%', opacity: 0.9 },
{ color: '#E63B86', offset: '60%', opacity: 0.9 }
]
};
let gauge: CircularGauge = new CircularGauge({
axes: [{
startAngle: 270,
endAngle: 90,
lineStyle: { width: 3, color: '#E63B86' },
labelStyle: {
font: { size: '0px'}
}, majorTicks: {
height: 0
}, minorTicks: {
height: 0
},
radius: '90%',
minimum: 0,
maximum: 100,
pointers: [{
radius: '80%',
value: 80,
animation: { enable: true, duration: 1000 },
pointerWidth: 10,
radialGradient: pointerRadialGradient,
cap: {
radius: 8,
color: 'white',
border: {
color: '#E63B86',
width: 1
}
},
needleTail: {
length: '20%',
radialGradient: pointerRadialGradient,
}
}, {
radius: '60%', value: 40,
animation: { duration: 1000 },
pointerWidth: 10,
radialGradient: pointerRadialGradient,
cap: {
radius: 8, color: 'white',
border: { color: '#E63B86', width: 1 }
},
needleTail: {
length: '20%',
radialGradient: pointerRadialGradient
}
}]
}]
}, '#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Animation</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<link href="https://cdn.syncfusion.com/ej2/28.1.33/ej2-popups/styles/material.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container'>
<div id='element'></div>
</div>
</body>
</html>