React Radial Gauge Overview

    The React radial gauge component provides a number of visual elements, like a needle, tick marks, ranges, and labels, in order to create a predefined shape and scale.

    The Ignite UI for React radial gauge component is a data visualization tool capable of displaying a radial gauge containing a number of visual elements, such as a scale with tick marks and labels, a needle, and a number of ranges. The component also has built-in support for animated transitions. This animation is easily customizable by setting the transitionDuration property.

    React Radial Gauge Example

    The following sample demonstrates how setting multiple properties on the same radial gauge can transform it to completely different radial gauge.

    Dependencies

    When installing the gauge component, the core package must also be installed.

    npm install --save igniteui-react-core
    npm install --save igniteui-react-gauges
    

    Required Modules

    The IgrRadialGauge requires the following modules:

    import { IgrRadialGaugeModule } from 'igniteui-react-gauges';
    
    IgrRadialGaugeModule.register();
    

    Usage

    The following code demonstrates how create a radial gauge containing a needle and three comparative ranges on the scale.

     <IgrRadialGauge height="400px" width="400px"
        value={25}
        interval={5}
        minimumValue={0}
        maximumValue={100}>
        <IgrRadialGaugeRange startValue={0}
                             endValue={30}
                             brush="red"/>
        <IgrRadialGaugeRange startValue={30}
                             endValue={60}
                             brush="yellow"/>
        <IgrRadialGaugeRange startValue={60}
                             endValue={100}
                             brush="green"/>
    </IgrRadialGauge>
    

    Backing

    The radial gauge component comes with a backing shape drawn behind the scale that acts as a background for the radial gauge.

    The backing element represents background and border of the radial gauge component. It is always the first element rendered and all the rest of elements such as needle, labels, and tick marks are overlay on top of it.

    The backing can be circular or fitted. A circular shape creates a 360 degree circle gauge while a fitted shape creates a filled arc segment encompassing the scaleStartAngle and scaleEndAngle properties. This can be set by setting the backingShape property.

    <IgrRadialGauge
        backingShape="Fitted"
        backingBrush="#fcfcfc"
        backingOutline="DodgerBlue"
        backingOversweep={5}
        backingCornerRadius={10}
        backingStrokeThickness={5}
        backingOuterExtent={0.8}
        backingInnerExtent={0.15}
        scaleStartAngle={135} scaleEndAngle={45}
        height="300px" width="300px"
        minimumValue={0} value={50}
        maximumValue={80} interval={10} />
    

    Scale

    The scale is visual element that highlights full range of values in the gauge which can be created by supplying minimumValue and maximumValue values. Together with backing, it defines overall shape of gauge. The scaleStartAngle and scaleEndAngle properties define bounds of arc of the scale. While, the scaleSweepDirection property specifies whether the scale sweeps in clockwise or counter-clockwise direction. You can customize appearance of the scale by setting scaleBrush, scaleStartExtent, and scaleEndExtent properties.

    <IgrRadialGauge
        scaleStartAngle={135}
        scaleEndAngle={45}
        scaleBrush="DodgerBlue"
        scaleSweepDirection="Clockwise"
        scaleOversweep={1}
        scaleOversweepShape="Fitted"
        scaleStartExtent={0.45}
        scaleEndExtent={0.575}
        height="300px" width="300px"
        minimumValue={0} value={50}
        maximumValue={80} interval={10} />
    

    Labels

    The radial gauge labels are visual elements displaying numeric values at a specified interval between values of the minimumValue and maximumValue properties. You can position labels by setting the labelExtent property to a fraction, where 0 represents center of gauge and 1 represents outer extent of the gauge backing. Also, you can customize labels setting various styling properties such as fontBrush and font.

    <IgrRadialGauge
        labelExtent={0.65}
        labelInterval={10}
        font="11px Verdana"
        fontBrush="DodgerBlue"
        height="300px" width="300px"
        minimumValue={0} value={50}
        maximumValue={80} interval={10} />
    

    Tick Marks

    Tick marks are thin lines radiating from the center of the radial gauge. There are two types of tick marks: major and minor. Major tick marks are displayed at the interval between the minimumValue and maximumValue properties. Use the minorTickCount property to specify the number of minor tick marks displayed between each major tick mark. You can control the length of tick marks by setting a fraction (between 0 and 1) to tickStartExtent, tickEndExtent, minorTickStartExtent, and minorTickEndExtent properties.

    <IgrRadialGauge
        tickStartExtent={0.45}
        tickEndExtent={0.575}
        tickStrokeThickness={2}
        tickBrush="DodgerBlue"
        minorTickCount={4}
        minorTickEndExtent={0.5}
        minorTickStartExtent={0.575}
        minorTickStrokeThickness={1}
        minorTickBrush="DarkViolet"
        height="300px" width="300px"
        minimumValue={0} value={50}
        maximumValue={80} interval={10}/>
    

    Ranges

    A range highlights a set of continuous values bound by a specified minimumValue and maximumValue properties. You can add multiple ranges to the radial gauge by specifying their starting and ending values. Each range has a few customization properties such as brush and outline. Alternatively, you can set rangeBrushes and rangeOutlines properties to a list of colors for the ranges.

    <IgrRadialGauge
        height="300px" width="300px"
        minimumValue={0} value={50}
        maximumValue={80} interval={10}
        rangeBrushes ="red, yellow, green"
        rangeOutlines="red, yellow, green">
       <IgrRadialGaugeRange
           startValue={1}  endValue={10} brush="yellow" />
       <IgrRadialGaugeRange
           startValue={10}  endValue={25} brush="green" />
       <IgrRadialGaugeRange
           startValue={25}  endValue={40} brush="red" />
        <IgrRadialGaugeRange
           startValue={40}  endValue={80} brush="yellow" />
    </IgrRadialGauge>
    

    Needle

    Radial gauge needles are visual elements used to signify a gauge set value. Needles are available in one of the several predefined shapes. The needle can have a pivot shape, which is placed in the center of the gauge. The pivot shape also takes one of the predefined shapes. Pivot shapes that include an overlay or an underlay can have a separate pivot brush applied to the shape.

    The supported needle shapes and caps are set using the needleShape and needlePivotShape properties.

    You can enable an interactive mode of the gauge (using isNeedleDraggingEnabled property) and the end-user will be able to change value by dragging the needle between values of minimumValue and maximumValue properties.

    <IgrRadialGauge
        value={50}
        isNeedleDraggingEnabled={true}
        isNeedleDraggingConstrained={true}
        needleShape="NeedleWithBulb"
        needleBrush="DodgerBlue"
        needleOutline="DodgerBlue"
        needleEndExtent={0.475}
        needleStrokeThickness={1}
        needlePivotShape="CircleOverlay"
        needlePivotBrush="#9f9fa0"
        needlePivotOutline="#9f9fa0"
        needlePivotWidthRatio={0.2}
        needlePivotStrokeThickness={1}
        height="300px" width="300px"
        minimumValue={0}
        maximumValue={80} interval={10} />
    

    Summary

    For your convenience, all above code snippets are combined into one code block below that you can easily copy to your project and see the radial gauge with all features and visuals enabled.

    <IgrRadialGauge
        height="300px" width="300px"
        minimumValue={0}
        maximumValue={80}
        scaleStartAngle={135}
        scaleEndAngle={45}
        scaleBrush="#c6c6c6"
        scaleSweepDirection="Clockwise"
        scaleOversweep={1}
        scaleOversweepShape="Fitted"
        scaleStartExtent={0.45}
        scaleEndExtent={0.575}
    
        value={70}
        isNeedleDraggingEnabled={true}
        isNeedleDraggingConstrained={true}
        needleShape="NeedleWithBulb"
        needleBrush="DodgerBlue"
        needleOutline="DodgerBlue"
        needleEndExtent={0.475}
        needleStrokeThickness={1}
        needlePivotShape="CircleOverlay"
        needlePivotBrush="#9f9fa0"
        needlePivotOutline="#9f9fa0"
        needlePivotWidthRatio={0.2}
        needlePivotStrokeThickness={1}
    
        interval={10}
        tickStartExtent={0.45}
        tickEndExtent={0.575}
        tickStrokeThickness={2}
        tickBrush="Black"
        minorTickCount={4}
        minorTickEndExtent={0.5}
        minorTickStartExtent={0.575}
        minorTickStrokeThickness={1}
        minorTickBrush="Black"
    
        labelExtent={0.65}
        labelInterval={10}
        font="11px Verdana"
        fontBrush="Black"
    
        backingShape="Fitted"
        backingBrush="#ededed"
        backingOutline="Gray"
        backingOversweep={5}
        backingCornerRadius={10}
        backingStrokeThickness={5}
        backingOuterExtent={0.8}
        backingInnerExtent={0.15}
    
        rangeBrushes ="#a4bd29, #F86232"
        rangeOutlines="#a4bd29, #F86232">
        <IgrRadialGaugeRange
            startValue={20} endValue={40}
            innerStartExtent={0.45} innerEndExtent={0.45}
            outerStartExtent={0.57} outerEndExtent={0.57} />
        <IgrRadialGaugeRange
            startValue={40} endValue={60}
            innerStartExtent={0.45} innerEndExtent={0.45}
            outerStartExtent={0.57} outerEndExtent={0.57} />
    </IgrRadialGauge>