Pointers

24 May 201914 minutes to read

Pointer types

The pivot gauge has two types of pointers namely,

• Needle
• Marker

Needle type pointers are the default pointers that are always located at the center of the gauge. Following are the supported shapes for the needle pointers:

• rectangle
• triangle
• trapezoid
• arrow
• image.

JAVASCRIPT

$("#PivotGauge1").ejPivotGauge({
        //...
        scales: [{
            //...
            pointers: [{
                type: "needle",
                needleType: "trapezoid",
            }]
        }]
    });

For marker pointer, the available shapes are rectangle, triangle, ellipse, diamond, pentagon, circle, slider, pointer, wedge, trapezoid, rounded rectangle, and image.

JAVASCRIPT

$("#PivotGauge1").ejPivotGauge({
        //...
        scales: [{
            //...
            pointers: [{
                type: "marker",
                markerType: "diamond",
            }]
        }]
    });

Adding pointer collection

The pointer collection can be directly added to the scales option within the pivot gauge widget as an array.

JAVASCRIPT

$("#PivotGauge1").ejPivotGauge({
        //...
        scales: [{
            //...
            pointers: [
                {
                    type: "needle",
                    needleType: "triangle",
                }, 
                {
                    type: "marker",
                    markerType: "diamond"
                }     
            ]
        }]
    });

Appearance customization

The appearance of the pointer can be customized through the following properties:

• border – sets the color and width of the pointer border.
• backgroundColor – sets the background color of the pointer.
• length – sets the length of the pointer.
• width – sets the width of the pointer.
• opacity – sets the opacity of the pointer. By default, the value is 1.
• type – sets the type of the pointer. By default, the type is needle.

JAVASCRIPT

$("#PivotGauge1").ejPivotGauge({
        //...
        scales: [{
            //...
            pointers: [
                {
                    border: {
                        color: "green",
                        width: 2
                    },
                    backgroundColor: "yellow",
                    length: 120,
                    width: 7,
                    opacity: 0.6,
                    type: "needle",
                    needleType: "triangle"
                }, 
                {
                    border: {
                        color: "green",
                        width: 2
                    },
                    backgroundColor: "yellow",
                    length: 25,
                    width: 15,
                    opacity: 0.8,
                    type: "marker",
                    markerType: "diamond"
                }
            ]
        }]
    });

Pointer position

Pointer can be positioned with the help of following two properties:

• distanceFromScale - defines the distance between the scale and the pointer. By default, the value is 0.
• placement - defines the location of the pointer. By default, the value is center.

NOTE

Both the properties can be applied only if the pointer type is set to marker. The needle pointer type appears only at the center of the widget, which is its default position.

JAVASCRIPT

$("#PivotGauge1").ejPivotGauge({
        //...
        scales: [{
            //...
            pointers: [{
                //...
                type: "marker",
                placement: "far",
                distanceFromScale: 2
            }]
        }]
    });

Pointer image

It is possible to replace the pointers with an image. To view the pointers as an image, set the appropriate location in the imageUrl property.

JAVASCRIPT

$("#PivotGauge1").ejPivotGauge({
        //...
        scales: [{
            //...
            pointers: [{
                //For replacing needle pointer with image
                type: "needle",
                needleType: "image",
                imageUrl: "image.png"
            }, 
            {
                //For replacing marker pointer with image
                type: "marker",
                markerType: "image",
                imageUrl: "image.png"
            }]
        }]
    });

Pointer value text

To display the current value of pointers in the pivot gauge widget, the pointerValueText option is used. Following are the properties used to enable and customize the pointer value text.

• showValue – enables the pointer value text by setting the property to “true”. By default, its value is “true”.
• distance – sets the distance between the pointer and the text.
• color – sets the color of the text.
• opacity – sets the opacity of the text. By default, its value is 1.
• angle – sets the rotation angle of the text. By default, its value is 0.
• font – sets the font size, font style, and font family of the text.

JAVASCRIPT

$("#PivotGauge1").ejPivotGauge({
        //...
        scales: [{
            //...
            pointers: [{
                //For needle type
                pointerValueText: {
                    showValue: true,
                    distance: 10,
                    color: "red",
                    opacity: 0.7,
                    angle: 20,
                    font: {
                        size: "15px",
                        fontStyle: "Normal",
                        fontFamily: "Arial"
                    }
                }
            }, 
            {
                //For marker type
                pointerValueText: {
                    showValue: true,
                    distance: 40,
                    color: "red",
                    opacity: 0.7,
                    angle: -40,
                    font: {
                        size: "15px",
                        fontStyle: "Normal",
                        fontFamily: "Arial"
                    }
                },
            }]
        }]
    });