Class RadialPointer

Defines the core behavior of SfRadialGauge pointers and provides a base for derived classes.

Inheritance

System.Object

RadialPointer

MarkerPointer

NeedlePointer

RangePointer

Namespace: Syncfusion.Maui.Gauges

Assembly: Syncfusion.Maui.Gauges.dll

Syntax

public abstract class RadialPointer : Element, IThemeElement

Constructors

RadialPointer()

Initializes a new instance of the RadialPointer class.

Declaration

public RadialPointer()

Fields

AnimationDurationProperty

Identifies the AnimationDuration bindable property.

Declaration

public static readonly BindableProperty AnimationDurationProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for AnimationDuration bindable property.

AnimationEasingProperty

Identifies the AnimationEasing bindable property.

Declaration

public static readonly BindableProperty AnimationEasingProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for AnimationEasing bindable property.

EnableAnimationProperty

Identifies the EnableAnimation bindable property.

Declaration

public static readonly BindableProperty EnableAnimationProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for EnableAnimation bindable property.

IsInteractiveProperty

Identifies the IsInteractive bindable property.

Declaration

public static readonly BindableProperty IsInteractiveProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for IsInteractive bindable property.

StepFrequencyProperty

Identifies the StepFrequency bindable property.

Declaration

public static readonly BindableProperty StepFrequencyProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for StepFrequency bindable property.

ValueProperty

Identifies the Value bindable property.

Declaration

public static readonly BindableProperty ValueProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for Value bindable property.

Properties

AnimationDuration

Gets or sets a value that specifies the pointer animation duration in milliseconds.

Declaration

public double AnimationDuration { get; set; }

Property Value

Type	Description
System.Double	The default value is `1000` milliseconds.

Remarks

It specifies how long the pointer animation will take to reach from old value to new value.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer EnableAnimation="True" AnimationDuration="1500" />
                <gauge:NeedlePointer EnableAnimation="True" AnimationDuration="1500" />
                <gauge:RangePointer EnableAnimation="True" AnimationDuration="1500" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

AnimationEasing

Gets or sets a value that specifies the pointer animation easing effect.

Declaration

public Easing AnimationEasing { get; set; }

Property Value

Type	Description
Microsoft.Maui.Easing	The default value is `null/Linear`.

Remarks

It specifies how long the pointer animation will take to reach from old value to new value.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer EnableAnimation="True" AnimationEasing="BounceIn" />
                <gauge:NeedlePointer EnableAnimation="True" AnimationEasing="BounceIn" />
                <gauge:RangePointer EnableAnimation="True" AnimationEasing="BounceIn" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

EnableAnimation

Gets or sets a value indicating whether enables or disables the pointer animation.

Declaration

public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean	true if animation is enabled; otherwise, false.The default value is false.

Remarks

EnableAnimation decides whether the pointer will be animated or not while its value get changed. If EnableAnimation is true, then it will be animated, otherwise not.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value="30" EnableAnimation="True" />
                <gauge:NeedlePointer Value="30" EnableAnimation="True" />
                <gauge:RangePointer Value="30" EnableAnimation="True" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

IsInteractive

Gets or sets a value that allowing pointer value change through interaction.

Declaration

public bool IsInteractive { get; set; }

Property Value

Type	Description
System.Boolean	true if pointer interaction is enabled; otherwise, false.The default value is false.

Remarks

It decides whether the gauge pointer will be interactive or not. If IsInteractive is true, the gauge pointer will be interactive, otherwise not.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer IsInteractive="True" />
                <gauge:NeedlePointer IsInteractive="True" />
                <gauge:RangePointer IsInteractive="True" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

StepFrequency

Gets or sets the value that specifies the dragging step frequency of the pointer.

Declaration

public double StepFrequency { get; set; }

Property Value

Type	Description
System.Double	The default value is `0`.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value="50" IsInteractive="True" StepFrequency="10"/>
                <gauge:NeedlePointer Value="30" IsInteractive="True" StepFrequency="10" />
                <gauge:RangePointer Value="80" IsInteractive="True" StepFrequency="10" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

Value

Gets or sets the value that specifies the value of the pointer.

Declaration

public double Value { get; set; }

Property Value

Type	Description
System.Double	The default value is `0`.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value="50" />
                <gauge:NeedlePointer Value="30" />
                <gauge:RangePointer Value="80" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

Events

ValueChangeCompleted

Called when the user is done selecting a new value of the pointer by dragging.

Declaration

public event EventHandler<ValueChangedEventArgs> ValueChangeCompleted

Event Type

Type
System.EventHandler<ValueChangedEventArgs>

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer ValueChangeCompleted="MarkerPointer_ValueChangeCompleted" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

private void MarkerPointer_ValueChangeCompleted(object sender, ValueChangedEventArgs e)
{
   var value = e.Value;
}

ValueChanged

Called when the user is selecting a new value for the pointers by dragging.

Declaration

public event EventHandler<ValueChangedEventArgs> ValueChanged

Event Type

Type
System.EventHandler<ValueChangedEventArgs>

Examples

XAML
C#

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer ValueChanged="MarkerPointer_ValueChanged" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

using Syncfusion.Maui.Gauges;
...
private void MarkerPointer_ValueChanged(object sender, ValueChangedEventArgs e)
{
   var value = e.Value;
}

ValueChangeStarted

Called when the user starts selecting a new value of pointer by dragging.

Declaration

public event EventHandler<ValueChangedEventArgs> ValueChangeStarted

Event Type

Type
System.EventHandler<ValueChangedEventArgs>

Examples

XAML
C#

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer ValueChangeStarted = "MarkerPointer_ValueChangeStarted" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

private void MarkerPointer_ValueChangeStarted(object sender, ValueChangedEventArgs e)
{
   var value = e.Value;
}

ValueChanging

Called before when the user is selecting a new value for the pointers by dragging.

Declaration

public event EventHandler<ValueChangingEventArgs> ValueChanging

Event Type

Type
System.EventHandler<ValueChangingEventArgs>

Examples

XAML
C#

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer ValueChanging="MarkerPointer_ValueChanging" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

private void MarkerPointer_ValueChanging(object sender, ValueChangingEventArgs e)
{
   var oldValue = e.OldValue;
   var newValue = e.NewValue;
   var cancel = e.Cancel;
}