Class ShapePointer

Create the pointer to indicate the value with built-in shape. To highlight values, set the shape pointer type to a built-in shape, such as a circle, triangle, inverted triangle, rectangle, or diamond.

Inheritance

System.Object

GaugePointer

MarkerPointer

ShapePointer

Inherited Members

GaugePointer.AnimationDuration

GaugePointer.AnimationDurationProperty

GaugePointer.AnimationEasingFunction

GaugePointer.AnimationEasingFunctionProperty

GaugePointer.EnableAnimation

GaugePointer.EnableAnimationProperty

GaugePointer.IsInteractive

GaugePointer.IsInteractiveProperty

GaugePointer.Value

GaugePointer.ValueChangeCompleted

GaugePointer.ValueChanged

GaugePointer.ValueChangeStarted

GaugePointer.ValueChanging

GaugePointer.ValueProperty

MarkerPointer.MarkerOffset

MarkerPointer.MarkerOffsetProperty

MarkerPointer.OffsetUnit

MarkerPointer.OffsetUnitProperty

Namespace: Syncfusion.UI.Xaml.Gauges

Assembly: Syncfusion.Gauge.WinUI.dll

Syntax

public class ShapePointer : MarkerPointer

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value ="50" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

Constructors

ShapePointer()

Initializes new instance of ShapePointer class.

Declaration

public ShapePointer()

Examples

The below examples shows, how to add shape pointers to radial axis in radial gauge.

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value ="50" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

Fields

FillProperty

Identifies the Fill dependency property.

Declaration

public static readonly DependencyProperty FillProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The iidentifier for Fill dependency property.

HasShadowProperty

Identifies the HasShadow dependency property.

Declaration

public static readonly DependencyProperty HasShadowProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for HasShadow dependency property.

OverlayFillProperty

Identifies the OverlayFill dependency property.

Declaration

public static readonly DependencyProperty OverlayFillProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for OverlayFill dependency property.

OverlayRadiusProperty

Identifies the OverlayRadius dependency property.

Declaration

public static readonly DependencyProperty OverlayRadiusProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for OverlayRadius dependency property.

ShapeHeightProperty

Identifies the ShapeHeight dependency property.

Declaration

public static readonly DependencyProperty ShapeHeightProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ShapeHeight dependency property.

ShapeTypeProperty

Identifies the ShapeType dependency property.

Declaration

public static readonly DependencyProperty ShapeTypeProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ShapeType dependency property.

ShapeWidthProperty

Identifies the ShapeWidth dependency property.

Declaration

public static readonly DependencyProperty ShapeWidthProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for ShapeWidth dependency property.

StrokeProperty

Identifies the Stroke dependency property.

Declaration

public static readonly DependencyProperty StrokeProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for Stroke dependency property.

StrokeThicknessProperty

Identifies the StrokeThickness dependency property.

Declaration

public static readonly DependencyProperty StrokeThicknessProperty

Field Value

Type	Description
Microsoft.UI.Xaml.DependencyProperty	The identifier for StrokeThickness dependency property.

Properties

Fill

Gets or sets the brush that paints the interior of the shape.

Declaration

public Brush Fill { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Media.Brush	It defines the color of the shape's background. The default value is null

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Fill="Blue" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

HasShadow

Gets or sets a value indicating if the shape pointer has a shadow displayed.

Declaration

public bool HasShadow { get; set; }

Property Value

Type	Description
System.Boolean	It defines the shadow visibility of shape pointer. The default value is False.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value="60" 
                                    HasShadow="True" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

OverlayFill

Gets or sets a value that specifies the shape overlay fill color of pointer.

Declaration

public Brush OverlayFill { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Media.Brush	It defines the color of the overlay fill. The default value is Null.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value="60"
                                    IsInteractive="True"
                                    OverlayRadius="20"
                                    OverlayFill="Red" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

OverlayRadius

Gets or sets a value that specifies the shape overlay fill radius of pointer.

Declaration

public double OverlayRadius { get; set; }

Property Value

Type	Description
System.Double	It defines the radius of overlay fill. The default value is 0.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Value="60"
                                    IsInteractive="True"
                                    OverlayRadius="20" />
            </gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

ShapeHeight

Gets or sets a value that specifies the shape height in logical pixels.

Declaration

public double ShapeHeight { get; set; }

Property Value

Type	Description
System.Double	It defines the height of the shape of shape pointer. The default value is 20.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer ShapeHeight="2" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

ShapeType

Gets or sets a value that specifies the default shape type for the pointer.

Declaration

public GaugeShapeType ShapeType { get; set; }

Property Value

Type	Description
GaugeShapeType	One of the enumeration values that specifies the shape type of shape pointer in the radial gauge. The default is InvertedTriangle.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer ShapeType="Triangle" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

ShapeWidth

Gets or sets a value that specifies the shape width in logical pixels.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type	Description
System.Double	It defines the width of the shape of shape pointer. The default value is 20.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer ShapeWidth="2" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

Stroke

Gets or sets the Brush that specifies how the shape outline to be painted.

Declaration

public Brush Stroke { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Media.Brush	It defines the color of the shape's stroke. The default value is null

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer Stroke="Yellow" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

StrokeThickness

Gets or sets a value that specifies the width of the shape stroke outline.

Declaration

public double StrokeThickness { get; set; }

Property Value

Type	Description
System.Double	It defines the thickness of the shape's stroke. The default value is 0.

Examples

<gauge:SfRadialGauge>
    <gauge:SfRadialGauge.Axes>
        <gauge:RadialAxis>
            <gauge:RadialAxis.Pointers>
                <gauge:ShapePointer StrokeThickness="2" />
            </ gauge:RadialAxis.Pointers>
        </gauge:RadialAxis>
    </gauge:SfRadialGauge.Axes>
</gauge:SfRadialGauge>

Methods

OnApplyTemplate()

Invoked to render ShapePointer class.

Declaration

protected override void OnApplyTemplate()

OnCreateAutomationPeer()

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type
Microsoft.UI.Xaml.Automation.Peers.AutomationPeer

Overrides

GaugePointer.OnCreateAutomationPeer()

OnPointerEntered(PointerRoutedEventArgs)

Called when the pointer get entered.

Declaration

protected override void OnPointerEntered(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The pointer routed event arguments.

OnPointerExited(PointerRoutedEventArgs)

Called when the pointer get exited.

Declaration

protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The pointer routed event arguments.

OnPointerPressed(PointerRoutedEventArgs)

Called when the pointer gets pressed.

Declaration

protected override void OnPointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The pointer routed event arguments.

OnPointerReleased(PointerRoutedEventArgs)

Called when the pointer get released.

Declaration

protected override void OnPointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.PointerRoutedEventArgs	e	The pointer routed event arguments.

Overrides

GaugePointer.OnPointerReleased(PointerRoutedEventArgs)