Gauge pointers in Vue Circular gauge component

17 Feb 202324 minutes to read

Pointers are used to indicate values on the axis. Value of the pointer can be modified using the
value property.

<template>
  <div id="app">
      <div class='wrapper'>
          <ejs-circulargauge>
              <e-axes>
                  <e-axis>
                      <e-pointers>
                          <e-pointer value=90 ></e-pointer>
                     </e-pointers>
                  </e-axis>
              </e-axes>
          </ejs-circulargauge>
       </div>
   </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default { };
</script>
<style>
    .wrapper {
        max-width: 300px;
        margin: 0 auto;
    }
</style>

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.

<template>
    <div id="app">
        <div class='wrapper'>
            <ejs-circulargauge>
                 <e-axes>
                     <e-axis>
                         <e-pointers>
                             <e-pointer value=90  radius= '50%' :needleTail= 'needleTail' :cap ='cap'></e-pointer>
                        </e-pointers>
                     </e-axis>
                  </e-axes>
            </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
           cap: {
                radius: 10
            },
            needleTail: {
                length: '25%'
            }
        }
    }
};
</script>
<style>
    .wrapper {
        max-width: 300px;
        margin: 0 auto;
    }
</style>

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.

<template>
    <div id="app">
        <div class='wrapper'>
            <ejs-circulargauge>
                <e-axes>
                    <e-axis>
                        <e-pointers>
                            <e-pointer value=90 color= '#007DD1' pointerWidth= 25 radius= '50%' :needleTail= 'needleTail' :cap ='cap'></e-pointer>
                        </e-pointers>
                    </e-axis>
                </e-axes>
            </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
          cap: {
                radius: 15,
                color: 'white',
                border: {
                    color: '#007DD1',
                    width: 5
                }
            },
            needleTail: {
                length: '22%',
                color: '#007DD1'
            }
        }
    }
};
</script>
<style>
    .wrapper {
        max-width: 300px;
        margin: 0 auto;
    }
</style>

The appearance of the needle pointer can be customized by using needleStartWidth and needleEndWidth.

<template>
    <div class='wrapper'>
    <div id="app">
        <ejs-circulargauge>
            <e-axes>
                <e-axis  :radius='gauge3Radius' :startAngle='startAngle' :endAngle='endAngle' :lineStyle= 'lineStyle' :labelStyle ='labelStyle'
                :majorTicks= 'majorTicks' :minorTicks= 'minorTicks' minimum=0 maximum=100
                :annotations='annotations'>
                    <e-pointers>
                        <e-pointer value=70  radius= '80%' color='green' :pointerWidth='pointerWidth' :needleStartWidth='needleStartWidth'
                        :needleEndWidth='needleEndWidth' :cap= 'cap' :needleTail= 'needleTail' :animation= 'animation'></e-pointer>
                    </e-pointers>
                </e-axis>
            </e-axes>
        </ejs-circulargauge>
  </div>
  </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin, Annotations } from "@syncfusion/ej2-vue-circulargauge";

let contentVue = Vue.component("contentTemplate", {
  template: '<div style="color:#757575; font-family:Roboto; font-size:14px;padding-top: 26px">Customized Needle</div>',
  data() {
    return {
      data: {}
    };
  }
});
let contentTemplate = function() {
  return { template: contentVue };
};

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
            annotations:[{
                content:contentTemplate,
                zIndex: '1'
            }],
            gauge3Radius: '90%',
            startAngle:270,
            endAngle:90,
            lineStyle: {
                width: 3,
               color: '#1E7145'
            },
            labelStyle: {
                position:'Outside',
                font: {
                    color: '#1E7145',
                    size: '0px'
                }
            },
            majorTicks: {
                interval: 100,
                height: 0,
                width: 1
            },
            minorTicks: {
                height: 0,
                width: 0
            },
            cap: {
               radius: 8,
               color: 'green'
            },
            needleTail: {
                length:'0%'
            },
            animation:{
                enable:'true',
               duration:1000
            },
            pointerWidth: 2,
            needleStartWidth: 4,
            needleEndWidth: 4
        }
},
provide: {
    circulargauge: [Annotations]
},
};
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

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.

<template>
     <div id="app">
         <div class='wrapper'>
             <ejs-circulargauge>
                 <e-axes>
                     <e-axis>
                         <e-pointers>
                             <e-pointer value=50   type= 'RangeBar' radius= '60%'></e-pointer>
                         </e-pointers>
                     </e-axis>
                  </e-axes>
              </ejs-circulargauge>
          </div>
      </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default { };
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

RangeBar Pointer with rounded corners

The corners of the range bar pointer can be rounded by specifying desired values to the roundedCornerRadius property.

<template>
<div id="app">
    <div class='wrapper'>
        <ejs-circulargauge>
            <e-axes>
                <e-axis>
                    <e-pointers>
                        <e-pointer value=60   type= 'RangeBar' radius= '60%'  roundedCornerRadius= 10 :animation ='animation'></e-pointer>
                    </e-pointers>
                </e-axis>
           </e-axes>
       </ejs-circulargauge>
    </div>
  </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
          animation: { enable: false }
        }
    }
};
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

RangeBar Customization

RangeBar can be customized in terms of color, border and thickness by using
color, border and pointerWidth property.

<template>
<div id="app">
    <div class='wrapper'>
        <ejs-circulargauge>
            <e-axes>
                <e-axis>
                    <e-pointers>
                        <e-pointer value=50   type= 'RangeBar' radius= '60%' color= '#007DD1' pointerWidth: 15 :border= 'border'></e-pointer>
                    </e-pointers>
                </e-axis>
            </e-axes>
        </ejs-circulargauge>
    </div>
</div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
          border: {
                color: 'grey',
                width: 2
            }
        }
    }
};
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

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.

<template>
    <div id="app">
        <div class='wrapper'>
            <ejs-circulargauge>
                <e-axes>
                    <e-axis :pointers ='pointers'>
                    </e-axis>
                </e-axes>
            </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
          pointers: [{
            value: 90,
            type: 'Marker',
            markerShape: 'InvertedTriangle',
            radius: '100%',
            markerHeight: 15,
            markerWidth: 15
        }]
        }
    }
};
</script>
 <style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

Marker Customization

The marker can be customized in terms of color, border, width and height by using
color,
border,
markerWidth and
markerHeight property in
pointer.

<template>
    <div id="app">
        <div class='wrapper'>
            <ejs-circulargauge>
                <e-axes>
                    <e-axis>
                        <e-pointers>
                            <e-pointer value=90  :border= 'border' type= 'Marker' markerWidth= 15 markerHeight= 15 markerShape= 'Triangle' radius= '100%' color= 'white' ></e-pointer>
                        </e-pointers>
                    </e-axis>
                </e-axes>
            </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
          border: {
                color: '#007DD1',
                width: 2
            }
        }
    }
};
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

Dragging pointer

The pointers can be dragged over the axis line by clicking and dragging the same. To enable or disable the pointer drag, use the enablePointerDrag property.

<template>
    <div id="app">
        <div class='wrapper'>
           <ejs-circulargauge enablePointerDrag='true' height='250px' width='250px'>
              <e-axes>
                  <e-axis>
                      <e-pointers>
                          <e-pointer value=50></e-pointer>
                      </e-pointers>
                  </e-axis>
              </e-axes>
           </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
        }
    }
};
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

Multiple Pointers

In addition to the default pointer, you can add n number of pointer to an axis by using pointers property.

<template>
    <div id="app">
        <div class='wrapper'>
            <ejs-circulargauge>
                <e-axes>
                    <e-axis>
                        <e-pointers>
                            <e-pointer value=90  type= 'Marker' markerWidth= 15 markerHeight= 15 markerShape= 'InvertedTriangle' radius= '100%'  ></e-pointer>
                             <e-pointer value=90 type= 'RangeBar' markerWidth= 10  radius= '60%'  ></e-pointer>
                             <e-pointer value=90 pointerWidth= 25 :cap= 'cap' :needleTail= 'needleTail' radius= '60%'  ></e-pointer>
                        </e-pointers>
                   </e-axis>
                </e-axes>
            </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
          cap: {
                radius: 15,
                border: {
                    width: 5
                }
            },
            needleTail: {
                length: '22%',
            }
        }
    }
};
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

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.

<template>
    <div id="app">
         <div class='wrapper'>
             <ejs-circulargauge>
                 <e-axes>
                     <e-axis>
                         <e-pointers>
                             <e-pointer value=90  :animation= 'animation' ></e-pointer>
                         </e-pointers>
                     </e-axis>
                 </e-axes>
             </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin } from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        return {
         animation: {
                enable: true,
                duration: 1500
            }
        }
    }
};
</script>
<style>
  .wrapper {
    max-width: 300px;
    margin: 0 auto;
  }
</style>

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.

<template>
    <div id="app">
         <div class='wrapper'>
             <ejs-circulargauge>
                 <e-axes>
                     <e-axis :startAngle = 270 :endAngle= 90 :lineStyle= 'lineStyle' :labelStyle= 'labelStyle' :majorTicks= 'majorTicks' :minorTicks= 'minorTicks' :radius= 'radius' :minimum= 0 :maximum= 100 :pointers='pointers' >
                     </e-axis>
                 </e-axes>
             </ejs-circulargauge>
         </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin, Gradient} from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        var pointerLinearGradient = {
            startValue: '0%',
            endValue: '100%',
            colorStop: [
                { color: '#FEF3F9', offset: '0%', opacity: 0.9 },
                { color: '#E63B86', offset: '70%', opacity: 0.9 }]
        }
        return {
            lineStyle: { width: 3, color: '#E63B86' },
            labelStyle: {
                font: { size: '0px'}
            }, majorTicks: {
                height: 0
            }, minorTicks: {
                height: 0
            },
            radius: '90%',
            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
                    }
               }]
      }
    },
    provide: {
        circulargauge: [Gradient]
    }
};
</script>
<style>
  .wrapper {
    max-width: 500px;
    margin: 0 auto;
  }
</style>

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.

<template>
    <div id="app">
        <div class='wrapper'>
            <ejs-circulargauge>
                <e-axes>
                    <e-axis :pointers= 'pointers' :startAngle = 270 :endAngle= 90 :lineStyle= 'lineStyle' :labelStyle= 'labelStyle' :majorTicks= 'majorTicks' :minorTicks= 'minorTicks' :radius= 'radius' :minimum= 0 :maximum= 100>
                    </e-axis>
                </e-axes>
            </ejs-circulargauge>
        </div>
    </div>
</template>
<script>
import Vue from 'vue';
import { CircularGaugePlugin, Gradient} from "@syncfusion/ej2-vue-circulargauge";

Vue.use(CircularGaugePlugin);
export default {
    data: function () {
        var pointerRadialGradient = {
            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 }]  
        }  
        return {
            lineStyle: { width: 3, color: '#E63B86' },
            labelStyle: {
                font: { size: '0px'}
            }, majorTicks: {
                height: 0
            }, minorTicks: {
                height: 0
            },
            radius: '90%',
            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
                }
             }]
      }
    },
    provide: {
        circulargauge: [Gradient]
    }
};
</script>
<style>
  .wrapper {
    max-width: 500px;
    margin: 0 auto;
  }
</style>