Class BarPointer

Represents the bar pointer that is used to indicate the current value of the gauge in a linear bar shape.

Inheritance
System.Object
LinearGaugePointer
BarPointer
Inherited Members
Namespace: Syncfusion.UI.Xaml.Gauges
Assembly: Syncfusion.Gauge.WinUI.dll
Syntax
public class BarPointer : LinearGaugePointer
Examples

The below examples shows, how to add bar pointers to linear axis in linear gauge.

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.Axis>
        <gauge:LinearAxis>
            <gauge:LinearAxis.BarPointers>
                <gauge:BarPointer Value="50"
                                  PointerSize="10"
                                  Background="Orange" 
                                  CornerStyle="BothFlat"
                                  Offset="-15" />
            </gauge:LinearAxis.BarPointers>
        </gauge:LinearAxis>
    </gauge:SfLinearGauge.Axis>
</gauge:SfLinearGauge>

Constructors

BarPointer()

Initializes a new instance of the BarPointer class.

Declaration
public BarPointer()

Fields

ChildProperty

Identifies Child dependency property.

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

CornerStyleProperty

Identifies CornerStyle dependency property.

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

GradientStopsProperty

Identifies GradientStops dependency property.

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

OffsetProperty

Identifies Offset dependency property.

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

PointerSizeProperty

Identifies PointerSize dependency property.

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

Properties

Child

Gets or sets the child content of a BarPointer.

Declaration
public object Child { get; set; }
Property Value
Type Description
System.Object

An object that contains the pointer's visual child content. The default value is null.

CornerStyle

Gets or sets a CornerStyle enumeration value that describes the corner/edge style of the BarPointer.

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

A value of the enumeration. The default is BothFlat.

GradientStops

Gets or sets the collection of GaugeGradientStop that specifies how interior is painted with gradient brush on the BarPointer.

Declaration
public ObservableCollection<GaugeGradientStop> GradientStops { get; set; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<GaugeGradientStop>

A collection of the GaugeGradientStop objects associated with the brush, each of which specifies a color and an offset along the linear axis. The default is an empty collection.
Examples

The below examples shows, how to add a collection of gradient stop to the bar pointer.

<gauge:SfLinearGauge>
    <gauge:SfLinearGauge.Axis>
        <gauge:LinearAxis>
            <gauge:LinearAxis.BarPointers>
                <gauge:BarPointer Value="90"
                                  PointerSize="10"
                                  Background="Orange" 
                                  CornerStyle="BothCurve"
                                  Offset="-15">
                    <gauge:BarPointer.GradientStops>
                        <gauge:GaugeGradientStop Value="0"
                                                 Color="Green" />
                        <gauge:GaugeGradientStop Value="50"
                                                 Color="Orange" />
                        <gauge:GaugeGradientStop Value="100"
                                                 Color="Red" />
                    </gauge:BarPointer.GradientStops>
                </gauge:BarPointer>
            </gauge:LinearAxis.BarPointers>
        </gauge:LinearAxis>
    </gauge:SfLinearGauge.Axis>
</gauge:SfLinearGauge>

Offset

Gets or sets the value to adjusts the BarPointer position from the axis line.

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

Its default value is 0.
Remarks

Specifies the distance between the pointer and the axis line. BarPointer rendered over the axis line by default.

PointerSize

Gets or sets the value that specifies the height of BarPointer for a horizontal linear gauge, or to the width of bar pointer for a vertical linear gauge.

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

The size of the BarPointer, in pixels. The default value is 4.

Methods

OnApplyTemplate()

Invoke to render LinearGaugeRange class.

Declaration
protected override void OnApplyTemplate()

OnCreateAutomationPeer()

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