Pointers in EJ2 TypeScript Linear Gauge Control
20 Jan 202424 minutes to read
Pointers are used to indicate values on an axis. The value of the pointer can be modified using the value property in pointers.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge({
axes: [{
pointers: [{
value: 80
}]
}]
}, '#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" />
<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>Types of pointer
The Linear Gauge supports the following types of pointers:
- Bar
- Marker
The type of pointer can be modified by using the type property in pointers.
Marker pointer
A marker pointer is a shape that can be used to mark the pointer value in the Linear Gauge.
Types of marker shapes
By default, the marker shape for the pointer is InvertedTriangle. To change the shape of the pointer, use the markerType property in pointers. The following marker types are available in Linear Gauge.
- Circle
- Rectangle
- Triangle
- InvertedTriangle
- Diamond
- Image
- Text
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge({
axes: [{
pointers: [{
value: 80,
type: 'Marker',
markerType: 'Circle'
}]
}]
}, '#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" />
<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>Image can be rendered instead of rendering a shape as a pointer. It can be achieved by setting the markerType property to Image and setting the source URL of image to imageUrl property in pointers.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge(
{
orientation: 'Horizontal',
axes: [
{
majorTicks: {
interval: 20,
position: 'Outside',
},
minorTicks: {
position: 'Outside',
},
labelStyle: {
position: 'Outside',
font: { fontFamily: 'inherit' },
},
pointers: [
{
value: 60,
markerType: 'Image',
imageUrl:
'https://ej2.syncfusion.com/demos/src/linear-gauge/images/step-count.png',
offset: -27,
height: 40,
width: 40,
},
],
},
],
},
'#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" />
<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>Text can be added instead of rendering a shape as a pointer. It can be achieved by setting the markerType property to Text, and the text content can be set using the text property in pointers.
The following properties in the textStyle property can be used to set the text style for the text pointer.
- fontFamily - It is used to set the font family for the text pointer.
- fontStyle - It is used to set the font style for the text pointer.
- fontWeight - It is used to set the font weight for the text pointer.
- size - It is used to set the font size for the text pointer.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge(
{
orientation: 'Horizontal',
axes: [
{
line: {
width: 5
},
ranges: [
{
start: 0,
end: 30,
color: '#6FC78A',
startWidth: 50,
endWidth: 50,
position: 'Inside'
},
{
start: 30,
end: 65,
color: '#ECC85B',
startWidth: 50,
endWidth: 50,
position: 'Inside'
},
{
start: 65,
end: 100,
color: '#FB7D55',
startWidth: 50,
endWidth: 50,
position: 'Inside'
},
],
majorTicks: {
interval: 20,
height: 7,
width: 1,
position: 'Inside'
},
minorTicks: {
interval: 10,
height: 3,
position: 'Inside'
},
labelStyle: {
position: 'Inside',
font: { fontFamily: 'inherit' }
},
pointers: [
{
value: 13,
markerType: 'Text',
text: 'Low',
color: 'black',
offset: '-50',
textStyle: {
size: '18px',
fontWeight: 'bold'
}
},
{
value: 48,
markerType: 'Text',
text: 'Moderate',
color: 'black',
offset: '-50',
textStyle: {
size: '18px',
fontWeight: 'bold'
}
},
{
value: 83,
markerType: 'Text',
text: 'High',
color: 'black',
offset: '-50',
textStyle: {
size: '18px',
fontWeight: 'bold'
}
},
],
minimum: 0,
maximum: 100,
opposedPosition: true
}
]
},
'#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" />
<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 Customization
The marker pointer can be customized using the following properties.
- height - To set the height of the pointer.
- position - The position of the pointer can be changed by setting the value as Inside, Outside, Cross, or Auto.
- width - To set the width of the pointer.
- color - To set the color of the pointer.
- placement - To place the pointer in the specified position. By default, the pointer is placed Far from the axis. To change the placement, set the placement property as Near, Center, or None.
- offset - To place the pointer with specified distance from the axis.
- opacity - To set the opacity of the pointer.
- animationDuration - To specify the duration of the animation in pointer.
- border - To set the color and width for the border of the pointer.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge({
axes: [{
pointers: [{
value: 80,
markerType: 'Circle',
height: 15,
width: 15,
color: '#cd41f4'
}]
}]
}, '#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" />
<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>Bar Pointer
The bar pointer is used to track the axis value. The bar pointer starts from the beginning of the gauge and ends at the pointer value. To enable bar pointer set the type property property in pointer as Bar.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge({
axes: [{
pointers: [{
value: 60,
type: 'Bar'
}]
}]
}, '#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" />
<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>Bar pointer customization
The bar pointer can be customized using following properties.
- width - To set the thickness of the bar pointer.
- color - To set the color of the bar pointer.
- offset - To place the bar pointer with the specified distance from it’s default position.
- opacity - To set the opacity of the bar pointer.
- roundedCornerRadius - To set the corner radius for the bar pointer.
- border - To set the color and width for the border of the pointer.
- animationDuration - To set the duration of the animation in bar pointer.
Note: The placement property is not applicable for the bar pointer.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge({
axes: [{
pointers: [{
value: 60,
type: 'Bar',
width: 20,
color: '#f44141'
}]
}]
}, '#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" />
<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
Multiple pointers can be added to the Linear Gauge by adding multiple pointer objects in the pointers and customization for the pointers can be done with the pointer object.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge({
axes: [{
pointers: [
{
value: 80
},
{
value: 60,
markerType: 'Circle'
},
{
value: 30,
markerType: 'Diamond'
}
]
}]
}, '#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" />
<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>Pointer animation
Pointer is animated on loading the gauge. This can be handled using the animationDuration property. The duration of the animation can be specified in milliseconds.
import { LinearGauge } from '@syncfusion/ej2-lineargauge';
let gauge: LinearGauge = new LinearGauge({
axes: [{
pointers: [{
value: 60,
animationDuration: 1000
}]
}]
}, '#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" />
<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 the addition of multiple colors in the pointers of the Linear Gauge. The following gradient types are supported in the Linear 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 rendered for the pointer in the Linear Gauge by using the below example.
import { LinearGauge, Gradient } from '@syncfusion/ej2-lineargauge';
LinearGauge.Inject(Gradient);
let gauge: LinearGauge = new LinearGauge({
orientation: 'Horizontal',
container: {
width: 30, offset: 30
},
axes: [{
line: { width: 0 },
majorTicks: { height: 0, interval: 25 },
minorTicks: { height: 0 },
labelStyle: {
font: { color: '#424242',
}, offset: 55
},
pointers: [{
value: 80, height: 25,
width: 35, placement: 'Near',
offset: -44, markerType: 'Triangle',
color : '#f54ea2',
linearGradient: {
startValue: '0%',
endValue: '100%',
colorStop: [
{ color: '#fef3f9', offset: '0%', opacity: 1 },
{ color: '#f54ea2', offset: '100%', opacity: 1 }]
}
}],
ranges: [{
start: 0, end: 80,
startWidth: 30, endWidth: 30,
color: '#f54ea2', offset: 30,
}]
}]
}, '#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" />
<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 rendered for the pointer in the Linear Gauge by using the below example.
import { LinearGauge, Gradient } from '@syncfusion/ej2-lineargauge';
LinearGauge.Inject(Gradient);
let gauge: LinearGauge = new LinearGauge({
orientation: 'Horizontal',
container: {
width: 30, offset: 30
},
axes: [{
line: { width: 0 },
majorTicks: { height: 0, interval: 25 },
minorTicks: { height: 0 },
labelStyle: {
font: { color: '#424242',
}, offset: 55
},
pointers: [{
value: 80, height: 25,
width: 35, placement: 'Near',
offset: -44, markerType: 'Triangle',
color : '#f54ea2',
radialGradient: {
radius: '60%',
outerPosition: { x: '50%', y: '50%' },
innerPosition: { x: '50%', y: '50%' },
colorStop: [
{ color: '#fff5f5', offset: '0%', opacity: 0.9 },
{ color: '#f54ea2', offset: '100%', opacity: 0.8 }]
}
}],
ranges: [{
start: 0, end: 80,
startWidth: 30, endWidth: 30,
color: '#f54ea2', offset: 30,
}]
}]
}, '#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" />
<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>Note: If we set both gradients, only the linear gradient gets rendered. If we set the startValue and endValue of the linearGradient as empty strings, then the radial gradient gets rendered in the pointer of the Linear Gauge.