WinUI

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MarkerPointer - WinUI API Reference | Syncfusion

    Show / Hide Table of Contents

    Class MarkerPointer

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

    Inheritance
    System.Object
    GaugePointer
    MarkerPointer
    Inherited Members
    GaugePointer.ValueProperty
    GaugePointer.EnableAnimationProperty
    GaugePointer.AnimationDurationProperty
    GaugePointer.IsInteractiveProperty
    GaugePointer.AnimationEasingFunctionProperty
    GaugePointer.OnPointerReleased(PointerRoutedEventArgs)
    GaugePointer.Value
    GaugePointer.EnableAnimation
    GaugePointer.AnimationDuration
    GaugePointer.IsInteractive
    GaugePointer.AnimationEasingFunction
    GaugePointer.ValueChangeStarted
    GaugePointer.ValueChanging
    GaugePointer.ValueChanged
    GaugePointer.ValueChangeCompleted
    Namespace: Syncfusion.UI.Xaml.Gauges
    Assembly: Syncfusion.Gauge.WinUI.dll
    Syntax
    public class MarkerPointer : GaugePointer
    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer Value = "50" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    Constructors

    MarkerPointer()

    Initializes a new instance of the MarkerPointer class.

    Declaration
    public MarkerPointer()

    Fields

    BorderWidthProperty

    Identifies the BorderWidth dependency property.

    Declaration
    public static readonly DependencyProperty BorderWidthProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for BorderWidth dependency property.

    ImageSourceProperty

    Identifies the ImageSource dependency property.

    Declaration
    public static readonly DependencyProperty ImageSourceProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for ImageSource dependency property.

    MarkerHeightProperty

    Identifies the MarkerHeight dependency property.

    Declaration
    public static readonly DependencyProperty MarkerHeightProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for MarkerHeight dependency property.

    MarkerOffsetProperty

    Identifies the MarkerOffset dependency property.

    Declaration
    public static readonly DependencyProperty MarkerOffsetProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for MarkerOffset dependency property.

    MarkerTemplateProperty

    Identifies the MarkerTemplate dependency property.

    Declaration
    public static readonly DependencyProperty MarkerTemplateProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for MarkerTemplate dependency property.

    MarkerTypeProperty

    Identifies the MarkerType dependency property.

    Declaration
    public static readonly DependencyProperty MarkerTypeProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for MarkerType dependency property.

    MarkerWidthProperty

    Identifies the MarkerWidth dependency property.

    Declaration
    public static readonly DependencyProperty MarkerWidthProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for MarkerWidth dependency property.

    OffsetUnitProperty

    Identifies the OffsetUnit dependency property.

    Declaration
    public static readonly DependencyProperty OffsetUnitProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for OffsetUnit dependency property.

    TextProperty

    Identifies the Text dependency property.

    Declaration
    public static readonly DependencyProperty TextProperty
    Field Value
    Type Description
    Microsoft.UI.Xaml.DependencyProperty

    The identifier for Text dependency property.

    Properties

    BorderWidth

    Gets or sets the width of the marker border outline.

    Declaration
    public double BorderWidth { get; set; }
    Property Value
    Type Description
    System.Double

    It defines the thickness of the border. The default value is 0.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer BorderWidth="2" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    ImageSource

    Gets or sets the image Url source.

    Declaration
    public ImageSource ImageSource { get; set; }
    Property Value
    Type Description
    Microsoft.UI.Xaml.Media.ImageSource

    It defines the image path of the marker when MarkerType is Image. The default value is null.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer ImageSource="/Images/Cloud.png" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    MarkerHeight

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

    Declaration
    public double MarkerHeight { get; set; }
    Property Value
    Type Description
    System.Double

    It defines the height of the marker. The default value is 20.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer MarkerHeight="2" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    MarkerOffset

    Gets or sets a value that specifies the marker position value either in logical pixel or radius factor.

    Declaration
    public double MarkerOffset { get; set; }
    Property Value
    Type Description
    System.Double

    It defines the position offset of the marker either pixel or factor. The default value is double.NaN.

    Examples

    If OffsetUnit is Factor, value will be given from 0 to 1. Here pointer placing position is calculated by MarkerOffset * axis radius value. Example: MarkerOffset value is 0.2 and axis radius is 100, pointer is moving 20(0.2 * 100) logical pixels from axis outer radius. If OffsetUnit is Pixel, defined value distance pointer will move from the outer radius axis. When you specify MarkerOffset is negative, the pointer will be positioned outside the axis.

    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer MarkerOffset="0.2" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    MarkerTemplate

    Gets or sets the data template to customizes the marker shape.

    Declaration
    public DataTemplate MarkerTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.UI.Xaml.DataTemplate

    The template for the marker pointer. The default is null.

    Remarks

    Its DataContext is MarkerPointer.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer Value="50" >
                        < gauge:MarkerPointer.MarkerTemplate>
                            <DataTemplate>
                                <Grid>
                                    <Rectangle Fill = "{Binding Background}"
                                               Stroke="{Binding BorderBrush}"
                                               StrokeThickness="{Binding BorderWidth}"
                                               Width="{Binding MarkerWidth}"
                                               Height="{Binding MarkerHeight}"
                                               RadiusX="3"
                                               RadiusY="3" />
                                </Grid>
                            </DataTemplate>
                        </gauge:MarkerPointer.MarkerTemplate>
                    </gauge:MarkerPointer>
                </gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    MarkerType

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

    Declaration
    public MarkerType MarkerType { get; set; }
    Property Value
    Type Description
    MarkerType

    One of the enumeration values that specifies the marker type of marker pointer in the radial gauge. The default is InvertedTriangle.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer MarkerType="Triangle" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    MarkerWidth

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

    Declaration
    public double MarkerWidth { get; set; }
    Property Value
    Type Description
    System.Double

    It defines the width of the marker. The default value is 20.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer MarkerWidth="2" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    OffsetUnit

    Gets or sets the value that indicates to calculate the marker pointer offset in logical pixel or radius factor.

    Declaration
    public SizeUnit OffsetUnit { get; set; }
    Property Value
    Type Description
    SizeUnit

    One of the SizeUnit enumeration that specifies how the MarkerOffset value is considered. The default mode is Pixel.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer OffsetUnit="Factor" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    Text

    Gets or sets the marker text.

    Declaration
    public string Text { get; set; }
    Property Value
    Type Description
    System.String

    It defines the string of the marker when MarkerType is Text. The default value is null.

    Examples
    <gauge:SfRadialGauge>
        <gauge:SfRadialGauge.Axes>
            <gauge:RadialAxis>
                <gauge:RadialAxis.Pointers>
                    <gauge:MarkerPointer Text="Syncfusion" />
                </ gauge:RadialAxis.Pointers>
            </gauge:RadialAxis>
        </gauge:SfRadialGauge.Axes>
    </gauge:SfRadialGauge>

    Methods

    OnApplyTemplate()

    Invoke to render MarkerPointer class.

    Declaration
    protected override void OnApplyTemplate()

    OnCreateAutomationPeer()

    Declaration
    protected override AutomationPeer OnCreateAutomationPeer()
    Returns
    Type Description
    Microsoft.UI.Xaml.Automation.Peers.AutomationPeer
    Overrides
    GaugePointer.OnCreateAutomationPeer()

    OnPointerPressed(PointerRoutedEventArgs)

    Called when the pointer get pressed.

    Declaration
    protected override void OnPointerPressed(PointerRoutedEventArgs e)
    Parameters
    Type Name Description
    Microsoft.UI.Xaml.Input.PointerRoutedEventArgs e

    The pointer routed event arguments.

    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved