Class LinearPointer

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

Inheritance

System.Object

LinearPointer

BarPointer

LinearMarkerPointer

Namespace: Syncfusion.Maui.Gauges

Assembly: Syncfusion.Maui.Gauges.dll

Syntax

public abstract class LinearPointer : Element

Examples

<gauge:SfLinearGauge >
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer Position="Cross"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

Constructors

LinearPointer()

Initializes a new instance of the LinearPointer class.

Declaration

public LinearPointer()

Examples

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer Position="Cross"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

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.

DragOffsetProperty

Identifies the DragOffset bindable property.

Declaration

public static readonly BindableProperty DragOffsetProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for DragOffset 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.

PositionProperty

Identifies the Position bindable property.

Declaration

public static readonly BindableProperty PositionProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for Position 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 be taken to reach from old value to new value.

Examples

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer EnableAnimation="true" AnimationDuration="2000"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

AnimationEasing

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

Declaration

public Easing AnimationEasing { get; set; }

Property Value

Type	Description
Microsoft.Maui.Easing	The default value is Microsoft.Maui.Easing.Linear.

Examples

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer EnableAnimation="true" AnimationEasing="{x:Static Easing.CubicOut}"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

DragOffset

Gets or sets the value that specifies the offset around the pointer in order to easily capture the drag object.

Declaration

public double DragOffset { get; set; }

Property Value

Type	Description
System.Double	The default value is 15.

Examples

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer IsInteractive="true" DragOffset="0"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

EnableAnimation

Gets or sets a value indicating whether to enable or disable 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:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer EnableAnimation="true"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

IsInteractive

Gets or sets a value indicating whether the pointer accepts changing its Value 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:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer IsInteractive="true"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

Position

Gets or sets the placement (top, center or bottom) of the pointer relative to axis.

Declaration

public GaugeElementPosition Position { get; set; }

Property Value

Type	Description
GaugeElementPosition	One of the enumeration values that specifies the position of pointer in the linear gauge. The default value of BarPointer is Cross and the default value of LinearShapePointer and LinearContentPointer is Outside .

Examples

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer Position="Cross"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

StepFrequency

Gets or sets the value to select discrete value on dragging.

Declaration

public double StepFrequency { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.

Examples

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer IsInteractive="true" StepFrequency="5"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

Value

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

Declaration

public double Value { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.

Examples

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.MarkerPointers>
        <gauge:LinearShapePointer Position="Outside"
                              Value="70"/>
    </gauge:SfLinearGauge.MarkerPointers>
</gauge:SfLinearGauge>

Events

AnimationCompleted

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

Declaration

public event EventHandler<ValueChangedEventArgs> AnimationCompleted

Event Type

Type
System.EventHandler<ValueChangedEventArgs>

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>

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>

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>

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>