ShinobiControls Xamarin Bindings Documentation

ShinobiGauges : Shinobi.Gauges Namespace

SGauge Class

A component representing a single value.

Syntax

[Foundation.Register("SGauge", true)]
public abstract class SGauge : UIKit.UIView

Remarks

An SGauge can appear in one of two layout styles:

The gauge indicates the current SGauge.Value with a needle, pointing towards the value.

Styling Axes and Axis Labels

Styling the Needle

Applying colors to the Ranges and Background

It can also optionally color some sections of the gauge, to indicate special values. For example, a car revometer may wish to colour values above 7000 rpm in red, to indicate a "danger zone".

Requirements

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

Members

See Also: Inherited members from UIKit.UIView.

Public Constructors

Inherited from UIView.
A constructor that initializes the object from the data stored in the unarchiver object.
Create a gauge with a given range.

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

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

Public Methods

GetAngle (nfloat) : nfloat
Documentation for this section has not yet been entered.
static
GetInfo () : string
Returns information about the current build version and type of the ShinobiGauges project.
GetPosition (nfloat, nfloat) : CoreGraphics.CGPoint
Documentation for this section has not yet been entered.
SetLicenseKey (string)
Sets the license key for the trial version of the ShinobiGauges framework.
SetValue (nfloat, nfloat)
Documentation for this section has not yet been entered.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

SGauge Constructor

Inherited from UIView.

Syntax

public SGauge (CoreGraphics.CGRect frame)

Parameters

frame
The size and position of the gauge.

Remarks

Requirements

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

SGauge 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 SGauge (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

SGauge Constructor

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

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SGauge (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

SGauge Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SGauge (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

SGauge Constructor

Create a gauge with a given range.

Syntax

[Foundation.Export("initWithFrame:fromMinimum:toMaximum:")]
public SGauge (CoreGraphics.CGRect frame, Foundation.NSNumber minimum, Foundation.NSNumber maximum)

Parameters

frame
The size and position of the gauge.
minimum
The minimum value of the axis.
maximum
The maximum value of the axis.

Remarks

Requirements

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

Axis Property

The axis displayed around the perimeter of the gauge.

Syntax

[get: Foundation.Export("axis", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setAxis:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGaugeAxis Axis { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This may be in a linear or radial display, depending on the gauge. Includes major and minor tick marks, and labels.

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

Delegate Property

The delegate used by the gauge, to inform of changes to the gauge.

Syntax

[get: Foundation.Export("delegate", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setDelegate:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual ISGaugeDelegate Delegate { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

See the Shinobi.Gauges.SGaugeDelegate protocol for more details.

Requirements

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

Dispose Method

Releases unmanaged resources.

Syntax

protected override void Dispose (bool disposing)

Parameters

disposing
True if called by Dispose, false if called from a finalizer

Remarks

Documentation for this section has not yet been entered.

Requirements

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

GetAngle Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("angleOfValue:")]
public virtual nfloat GetAngle (nfloat value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

GetInfo Method

Returns information about the current build version and type of the ShinobiGauges project.

Syntax

[Foundation.Export("getInfo")]
public static string GetInfo ()

Returns

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

GetPosition Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("positionOfValue:atOffset:")]
public virtual CoreGraphics.CGPoint GetPosition (nfloat value, nfloat offset)

Parameters

value
Documentation for this section has not yet been entered.
offset
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

MaximumValue Property

The maximum range of the gauge.

Syntax

[get: Foundation.Export("maximumValue", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setMaximumValue:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSNumber MaximumValue { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

MinimumValue Property

The minimum range of the gauge.

Syntax

[get: Foundation.Export("minimumValue", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setMinimumValue:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSNumber MinimumValue { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Needle Property

The needle object, used to point to the current value. Must be a UIView subclass.

Syntax

[get: Foundation.Export("needle")]
[set: Foundation.Export("setNeedle:")]
public virtual ISGaugeNeedle Needle { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to a single black line, in the center of the gauge.

Requirements

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

QualitativeRanges Property

An array of Shinobi.Gauges.SGaugeQualitativeRange objects, to indicate sections of the gauge which will be coloured.

Syntax

[get: Foundation.Export("qualitativeRanges", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setQualitativeRanges:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGaugeQualitativeRange[] QualitativeRanges { get; set; }

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

QualitativeRangeZPosition Property

The z-ordering of the qualitative ranges.

Syntax

[get: Foundation.Export("qualitativeRangeZPosition", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setQualitativeRangeZPosition:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat QualitativeRangeZPosition { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to 0.

When used in conjunction with the zPosition property on the layer of the Shinobi.Gauges.SGaugeNeedle and Shinobi.Gauges.SGaugeAxis, the order to draw each in can be specified.

Requirements

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

SetLicenseKey Method

Sets the license key for the trial version of the ShinobiGauges framework.

Syntax

[Foundation.Export("setLicenseKey:")]
public virtual void SetLicenseKey (string licenseKey)

Parameters

licenseKey
Documentation for this section has not yet been entered.

Remarks

You will be emailed a license key when you download the framework.

Requirements

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

SetValue Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("setValue:duration:")]
public virtual void SetValue (nfloat value, nfloat duration)

Parameters

value
Documentation for this section has not yet been entered.
duration
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Style Property

The style to use for drawing the gauge, the axis and the needle.

Syntax

[get: Foundation.Export("style", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setStyle:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual SGaugeStyle Style { get; set; }

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

Value Property

The current value of the gauge.

Syntax

[get: Foundation.Export("value", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setValue:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat Value { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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