ShinobiControls Xamarin Bindings Documentation

ShinobiGauges : Shinobi.Gauges Namespace

SGaugeAxis Class

The axis shows the major and minor tick marks, and labels around the perimeter of the gauge.

Syntax

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

Remarks

The axis may be drawn in a linear or radial way, depending on the parent gauge passed in on creation.

The properties SGaugeAxis.MinorTickFrequency and SGaugeAxis.MajorTickFrequency control how often the tick marks are drawn. The tick marks can be styled using the Shinobi.Gauges.SGaugeStyle property, or by using SGaugeDelegate.AlterTickMark(SGauge, UIKit.UIView, float, bool) method.

Values are shown next to each major tick. These can be styled or turned off using the SGaugeStyle.ShowTickLabels property, or by using the SGaugeDelegate.AlterTickLabel(SGauge, UIKit.UILabel, float) method.

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

A constructor that initializes the object from the data stored in the unarchiver object.
Create an axis, with a reference to a parent gauge.

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

[read-only]
override
ClassHandle IntPtr . The handle for this class.
Formatter Foundation.NSFormatter . A label formatter for tick mark labels.
MajorTickFrequency double . The spacing between the major ticks on the axis.
MaximumValue double . The maximum value of the range of the axis.
MinimumValue double . The minimum value of the range of the axis.
MinorTickFrequency double . The spacing between the minor ticks on the axis.
TickBaselinePosition nfloat . The offset from the axis to display the baseline, as a proportion of the total radius.
TickLabelOffsetFromBaseline nfloat . The offset from the baseline to draw the tick mark labels at.
TickMarkAlignment SGaugeTickAlign . The alignment of the tickmarks from the baseline.

Public Methods

GetTickMarkView (nfloat, bool) : UIKit.UIView
Documentation for this section has not yet been entered.

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.

Member Details

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

SGaugeAxis Constructor

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

Syntax

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

SGaugeAxis Constructor

Create an axis, with a reference to a parent gauge.

Syntax

[Foundation.Export("initWithGauge:")]
public SGaugeAxis (SGauge gauge)

Parameters

gauge
The parent gauge to attach the axis to.

Remarks

Requirements

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

SGaugeAxis Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

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

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

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

Formatter Property

A label formatter for tick mark labels.

Syntax

[get: Foundation.Export("formatter", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setFormatter:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual Foundation.NSFormatter Formatter { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Use this to set formatting options for tick labels on this axis - currencies, (negative) value styles etc.

Requirements

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

GetTickMarkView Method

Documentation for this section has not yet been entered.

Syntax

[Foundation.Export("viewForTickMarkAtValue:isMajorTick:")]
public virtual UIKit.UIView GetTickMarkView (nfloat value, bool isMajorTick)

Parameters

value
Documentation for this section has not yet been entered.
isMajorTick
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

MajorTickFrequency Property

The spacing between the major ticks on the axis.

Syntax

[get: Foundation.Export("majorTickFrequency", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setMajorTickFrequency:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual double MajorTickFrequency { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Default value is auto-calculated from the range of the gauge.

Requirements

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

MaximumValue Property

The maximum value of the range of the axis.

Syntax

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

Value

Documentation for this section has not yet been entered.

Remarks

Default value is auto-populated by the Shinobi.Gauges.SGauge on initialization.

Requirements

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

MinimumValue Property

The minimum value of the range of the axis.

Syntax

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

Value

Documentation for this section has not yet been entered.

Remarks

Default value is auto-populated by the Shinobi.Gauges.SGauge on initialization.

Requirements

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

MinorTickFrequency Property

The spacing between the minor ticks on the axis.

Syntax

[get: Foundation.Export("minorTickFrequency", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setMinorTickFrequency:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual double MinorTickFrequency { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Default value is auto-calculated from the range of the gauge.

Requirements

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

TickBaselinePosition Property

The offset from the axis to display the baseline, as a proportion of the total radius.

Syntax

[get: Foundation.Export("tickBaselinePosition", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setTickBaselinePosition:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat TickBaselinePosition { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The default is the value of the property SGaugeStyle.TickBaselinePosition from the style object of the gauge passed into the constructor (SGaugeAxis(SGauge)).

  • At 1, the baseline touches the axis.
  • A lower value draws the baseline closer to the center.
  • A higher value draws the baseline further from the center.

Requirements

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

TickLabelOffsetFromBaseline Property

The offset from the baseline to draw the tick mark labels at.

Syntax

[get: Foundation.Export("tickLabelOffsetFromBaseline", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setTickLabelOffsetFromBaseline:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat TickLabelOffsetFromBaseline { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The default is the value of the property SGaugeStyle.TickLabelOffsetFromBaseline from the style object of the gauge passed into the constructor (SGaugeAxis(SGauge)).

  • In a radial gauge, this will place the labels this many points further from the center than the major tick labels.
  • In a linear gauge, this will place the labels this many points underneath the major tick labels.

Requirements

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

TickMarkAlignment Property

The alignment of the tickmarks from the baseline.

Syntax

[get: Foundation.Export("tickMarkAlignment", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setTickMarkAlignment:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SGaugeTickAlign TickMarkAlignment { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

The default is the value of the property SGaugeStyle.TickMarkAlignment from the style object of the gauge passed into the constructor (SGaugeAxis(SGauge)).

Requirements

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