ShinobiControls Xamarin Bindings Documentation

ShinobiGauges : Shinobi.Gauges Namespace

SGaugeRadial Class

A gauge displaying a circular arc composed of Ticks, Labels and a Needle.

Syntax

[Foundation.Register("SGaugeRadial", true)]
public class SGaugeRadial : SGauge

Remarks

The gauge allows for custom arcs, starting at the SGaugeRadial.ArcAngleStart and finishing at SGaugeRadial.ArcAngleEnd. If these two values are the same, then the gauge is drawn as a complete circle.

The SGaugeRadial inherits from the Shinobi.Gauges.SGauge base class. The methods and properties on the base class can be used to control all other aspects of the gauge's behaviour.

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

Members

See Also: Inherited members from SGauge.

Public Constructors

Protected Constructors

Constructor to call on derived classes to skip initialization and merely allocate the object.
A constructor used when creating managed representations of unmanaged objects.

Public Properties

ArcAngleEnd nfloat . The angle in radians to draw the gauge to.
ArcAngleStart nfloat . The angle in radians to start drawing the gauge from.
Axis SGaugeAxis . The axis displayed around the perimeter of the gauge. (Inherited from SGauge.)
[read-only]
override
ClassHandle IntPtr . The handle for this class.
[read-only]
override
ClassHandle IntPtr . The handle for this class. (Inherited from SGauge.)
Delegate ISGaugeDelegate . The delegate used by the gauge, to inform of changes to the gauge. (Inherited from SGauge.)
MaximumValue Foundation.NSNumber . The maximum range of the gauge. (Inherited from SGauge.)
MinimumValue Foundation.NSNumber . The minimum range of the gauge. (Inherited from SGauge.)
Needle ISGaugeNeedle . The needle object, used to point to the current value. Must be a UIView subclass. (Inherited from SGauge.)
QualitativeRanges SGaugeQualitativeRange[]. An array of Shinobi.Gauges.SGaugeQualitativeRange objects, to indicate sections of the gauge which will be coloured. (Inherited from SGauge.)
QualitativeRangeZPosition nfloat . The z-ordering of the qualitative ranges. (Inherited from SGauge.)
Style SGaugeStyle . The style to use for drawing the gauge, the axis and the needle. (Inherited from SGauge.)
Value nfloat . The current value of the gauge. (Inherited from SGauge.)

Public Methods

GetAngle (nfloat) : nfloat
Documentation for this section has not yet been entered. (Inherited from SGauge.)
GetPosition (nfloat, nfloat) : CoreGraphics.CGPoint
Documentation for this section has not yet been entered. (Inherited from SGauge.)
SetLicenseKey (string)
Sets the license key for the trial version of the ShinobiGauges framework. (Inherited from SGauge.)
SetValue (nfloat, nfloat)
Documentation for this section has not yet been entered. (Inherited from SGauge.)

Protected Methods

override
Dispose (bool)
Releases unmanaged resources. (Inherited from SGauge.)

Member Details

SGaugeRadial Constructor

Syntax

public SGaugeRadial (CoreGraphics.CGRect frame)

Parameters

frame
Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

SGaugeRadial Constructor

A constructor that initializes the object from the data stored in the unarchiver object.

Syntax

[Foundation.Export("initWithCoder:")]
[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
public SGaugeRadial (Foundation.NSCoder coder)

Parameters

coder
The unarchiver object

Remarks

This constructor is provided to allow the class to be initialized from an unarchiver (for example, during NIB deserialization).

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

SGaugeRadial Constructor

Constructor to call on derived classes to skip initialization and merely allocate the object.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SGaugeRadial (Foundation.NSObjectFlag t)

Parameters

t
Unused sentinel value

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

SGaugeRadial Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SGaugeRadial (IntPtr handle)

Parameters

handle
Handle of the unmanaged object

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

SGaugeRadial Constructor

Syntax

public SGaugeRadial (CoreGraphics.CGRect frame, Foundation.NSNumber minimum, Foundation.NSNumber maximum)

Parameters

frame
Documentation for this section has not yet been entered.
minimum
Documentation for this section has not yet been entered.
maximum
Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

ArcAngleEnd Property

The angle in radians to draw the gauge to.

Syntax

[get: Foundation.Export("arcAngleEnd", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setArcAngleEnd:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat ArcAngleEnd { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

An angle of 0 represents the top, with positive values going clockwise. Defaults to Math.PI/2.

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

ArcAngleStart Property

The angle in radians to start drawing the gauge from.

Syntax

[get: Foundation.Export("arcAngleStart", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setArcAngleStart:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat ArcAngleStart { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

An angle of 0 represents the top, with positive values going clockwise. Defaults to -Math.PI/2.

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4

ClassHandle Property

The handle for this class.

Syntax

public override IntPtr ClassHandle { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: Shinobi.Gauges
Assembly: ShinobiGauges (in ShinobiGauges.dll)
Assembly Versions: 2.8.0.4