Pointer API in React Circular Gauge API component

Sets and gets the options to customize the pointers of an axis in circular gauge.

Properties

animation

AnimationModel

Sets and gets the options for the animation of the pointers that propagate while rendering the axis and updating the pointer value in the circular gauge.

border

BorderModel

Sets and gets the options to customize the style properties of the border for the needle pointer in an axis.

cap

CapModel

Sets and gets the options to customize the cap element of the needle pointer in an axis.

color

string

Sets and gets the color of the pointer in an axis.

Defaults to null

description

string

Sets and gets the information about pointer for assistive technology.

Defaults to null

imageUrl

string

Sets and gets the URL for the image that is to be displayed as pointer. It requires marker shape value to be Image.

Defaults to null

linearGradient

LinearGradientModel

Sets and gets the properties to render a linear gradient for the pointer. If both linear and radial gradient is set, then the linear gradient will be rendered in the pointer.

Defaults to null

markerHeight

number

Sets and gets the height of the marker pointer in an axis.

Defaults to 5

markerShape

GaugeShape

Sets and gets the shape of the marker pointer in an axis.

Defaults to Circle

markerWidth

number

Sets and gets the width of the marker pointer in an axis.

Defaults to 5

needleEndWidth

number

Sets or gets the width at the ending edge of the needle pointer in an axis.

Defaults to null

needleStartWidth

number

Sets or gets the width at the starting edge of the needle pointer in an axis.

Defaults to null

needleTail

NeedleTailModel

Sets and gets the options to customize the tail element of the needle pointer in an axis.

offset

number | string

Sets and gets the offset value of pointer from scale.

Defaults to ‘0’

pointerWidth

number

Sets and gets the width of the pointer in axis.

Defaults to 20

position

PointerRangePosition

Sets and gets the position of pointer for an axis.

Defaults to Auto

radialGradient

RadialGradientModel

Sets and gets the properties to render a radial gradient for pointer.

Defaults to null

radius

string

Sets and gets the radius of pointer for marker and range type pointer and fix length of pointer for needle pointer.

Defaults to null

roundedCornerRadius

number

Sets and gets the corner radius for pointer in axis.

Defaults to 0

text

string

Sets and gets the text for the marker pointer. To render the text in the marker pointer, the marker shape must be set as Text.

Defaults to ”

textStyle

FontModel

Sets and gets the style of text in marker pointer of an axis.

type

PointerType

Sets and gets the type of pointer for an axis in Circular gauge.

Defaults to Needle

value

number

Sets and gets the value of the pointer in circular gauge.

Defaults to null