Class SfCircularGauge

Represents a control that helps user to visualize the single numerical data.

true Syncfusion controls for Metro Syncfusion controls for Metro

Inheritance

System.Object

SfCircularGauge

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Gauges

Assembly: Syncfusion.SfGauge.UWP.dll

Syntax

public class SfCircularGauge : Control, IDisposable

Constructors

SfCircularGauge()

Initializes a new instance of the SfCircularGauge class.

Declaration

public SfCircularGauge()

Fields

AnnotationsProperty

Declaration

public static readonly DependencyProperty AnnotationsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CircularCoefficientProperty

This dependency property is used to calculate the radius of the gauge for the given offset

Declaration

public static readonly DependencyProperty CircularCoefficientProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CircularScaleStyleProperty

Declaration

public static readonly DependencyProperty CircularScaleStyleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

GaugeHeaderMarginProperty

Declaration

public static readonly DependencyProperty GaugeHeaderMarginProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

GaugeHeaderPositionProperty

Declaration

public static readonly DependencyProperty GaugeHeaderPositionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

GaugeHeaderProperty

Declaration

public static readonly DependencyProperty GaugeHeaderProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

GaugeTypeProperty

Declaration

public static readonly DependencyProperty GaugeTypeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HeaderAlignmentProperty

Declaration

public static readonly DependencyProperty HeaderAlignmentProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HorizontalHeaderPositionProperty

Declaration

public static readonly DependencyProperty HorizontalHeaderPositionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IsCenterAlignedProperty

This dependency property is used to indicate whether gauge should be placed in center or not

Declaration

public static readonly DependencyProperty IsCenterAlignedProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

MainScaleProperty

Declaration

public static readonly DependencyProperty MainScaleProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ScalesProperty

Declaration

public static readonly DependencyProperty ScalesProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SpacingMarginProperty

Declaration

public static readonly DependencyProperty SpacingMarginProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SubScalesProperty

Declaration

public static readonly DependencyProperty SubScalesProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

VerticalHeaderPositionProperty

Declaration

public static readonly DependencyProperty VerticalHeaderPositionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

Annotations

Declaration

public CircularAnnotationCollection Annotations { get; set; }

Property Value

Type
CircularAnnotationCollection

CircularCoefficient

Gets or sets the coefficient value for the gauge

Declaration

public double CircularCoefficient { get; set; }

Property Value

Type
System.Double

CircularScaleStyle

Gets or sets the style to the CircularScale in the SfCircularGauge.

Declaration

public Style CircularScaleStyle { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Style	Style

GaugeHeader

Gets or sets the header for CircularGauge.

Declaration

public object GaugeHeader { get; set; }

Property Value

Type	Description
System.Object	Object

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           gauge.GaugeHeader = "Syncfusion";
        }
    }
}

GaugeHeaderPosition

Gets or sets the position of the GaugeHeader of the SfCircularGauge. Set HeaderAlignment as Custom to work this property.

Declaration

public Point GaugeHeaderPosition { get; set; }

Property Value

Type	Description
Windows.Foundation.Point	Point

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           gauge.GaugeHeader = "Syncfusion";
           gauge.GaugeHeaderPosition = new Point(100, 200);
        }
    }
}

GaugeType

Gets or sets the type of CircularGauge.

Declaration

public CircularGaugeTypes GaugeType { get; set; }

Property Value

Type	Description
CircularGaugeTypes	Object

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           gauge.GaugeType = CircularGaugeTypes.None;
        }
    }
}

HeaderAlignment

Gets or sets the alignments of the GaugeHeader of the SfCircularGauge.

Declaration

public HeaderAlignment HeaderAlignment { get; set; }

Property Value

Type	Description
HeaderAlignment	HeaderAlignment

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           gauge.GaugeHeader = "Syncfusion";
           gauge.HeaderAlignment=HeaderAlignment.Center;
        }
    }
}

HorizontalHeaderPosition

Gets or sets the horizontal position alignment of gauge header. Set HorizontalHeaderPosition as Custom to work this property.

Declaration

public ViewAlignment HorizontalHeaderPosition { get; set; }

Property Value

Type
ViewAlignment

IsCenterAligned

Gets or sets the value indicating whether the gauge to be placed in center

Declaration

public bool IsCenterAligned { get; set; }

Property Value

Type
System.Boolean

MainScale

Gets or sets the MainScale that specifies basic look and feel of Circular Gauge.

Declaration

public CircularScale MainScale { get; set; }

Property Value

Type	Description
CircularScale	CircularScale

Remarks

Use Scales Property of CircularGauge to add CircularScale instead of using MainScale and SubScales Properties.

Scales

Gets or sets the collection of Scales to the ciruclar gauge.

Declaration

public ObservableCollection<CircularScale> Scales { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<CircularScale>	CircularScale

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;
namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
            InitializeComponent();
          SfCircularGauge gauge = new SfCircularGauge();
              CircularScale scale = new CircularScale();
               scale.Height = 300;
               scale.Width = 300;
               scale.StartAngle = 180;
               scale.SweepAngle = 180;
               scale.StartValue = 0;
               scale.EndValue = 100;
               scale.Height = 200;
               scale.Width = 200;
               gauge.Scales.Add(scale); 

        }
    }
}

SpacingMargin

Gets or sets the outer margin of the SfCircularGauge.

Declaration

public double SpacingMargin { get; set; }

Property Value

Type	Description
System.Double	double

Remarks

SpacingMargin property is used to place the SfCircularGauge in the center of the container. And also it decides the size of the SfCircularGauge. Value of the property should reside between 0.1 and 1.0. The default value is 1.0.

SubScales

Gets or sets the collection of subscales to be added in the same gauge.

Declaration

public ObservableCollection<CircularScale> SubScales { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<CircularScale>	ObservableCollection

Remarks

Use Scales Property of CircularGauge to add CircularScale instead of using MainScale and SubScales Properties.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
            InitializeComponent();
            SfCircularGauge gauge = new SfCircularGauge();
            CircularScale subScale1 = new CircularScale();
            CircularScale subScale2 = new CircularScale();
            subScale1.Height = 300;
            subScale1.Width = 300;
            subScale1.StartAngle = 180;
            subScale1.SweepAngle = 180;
             subScale1.SweepDirection = SweepDirection.Clockwise;
             subScale1.StartValue = 0;
             subScale1.EndValue = 100;
             subScale1.Height = 200;
             subScale1.Width = 200;
             subScale2.StartAngle = 270;
             subScale2.SweepAngle = 180;
             subScale2.SweepDirection = SweepDirection.Clockwise;
             subScale2.StartValue = 0;
             subScale2.EndValue = 200;
             gauge.SubScales.Add(subScale1);
             gauge.SubScales.Add(subScale2);

        }
    }
}

VerticalHeaderPosition

Gets or sets the vertical position alignment of gauge header.Set VerticalHeaderPosition as Custom to work this property.

Declaration

public ViewAlignment VerticalHeaderPosition { get; set; }

Property Value

Type
ViewAlignment

Methods

Dispose()

Method to release allocated resources of SfCircularGauge.

Declaration

public void Dispose()

OnPointerExited(PointerRoutedEventArgs)

Declaration

protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e

OnPointerMoved(PointerRoutedEventArgs)

Declaration

protected override void OnPointerMoved(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e

OnPointerReleased(PointerRoutedEventArgs)

Declaration

protected override void OnPointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)