XuniGauge Class Reference

Inherits from XuniView : UIView
Conforms to UIGestureRecognizerDelegate
Declared in XuniGauge.h

Overview

Base class for the Gauge controls.

  gaugeTapped

Occurs when gauge tapped

@property XuniEvent<XuniPointEventArgs*> *gaugeTapped

Discussion

Occurs when gauge tapped

Declared In

XuniGauge.h

– raiseGaugeTapped:

Creates event args and calls onChartRendering.

- (void)raiseGaugeTapped:(XuniPoint *)point

Parameters

point

the tapped point.

Discussion

Creates event args and calls onChartRendering.

Declared In

XuniGauge.h

  gaugeRendering

Occurs before gauge rendering

@property XuniEvent<XuniEventArgs*> *gaugeRendering

Discussion

Occurs before gauge rendering

Declared In

XuniGauge.h

– raiseGaugeRendering

Creates event args and calls gaugeRendering.

- (void)raiseGaugeRendering

Discussion

Creates event args and calls gaugeRendering.

Declared In

XuniGauge.h

  gaugeRendered

Occurs when gauge rendered

@property XuniEvent<XuniEventArgs*> *gaugeRendered

Discussion

Occurs when gauge rendered

Declared In

XuniGauge.h

– raiseGaugeRendered

Creates event args and calls gaugeRendered.

- (void)raiseGaugeRendered

Discussion

Creates event args and calls gaugeRendered.

Declared In

XuniGauge.h

  gaugeValueChanged

Occurs when gauge value changed

@property XuniEvent<XuniEventArgs*> *gaugeValueChanged

Discussion

Occurs when gauge value changed

Declared In

XuniGauge.h

– raiseGaugeValueChanged

Creates event args and calls gaugeValueChanged.

- (void)raiseGaugeValueChanged

Discussion

Creates event args and calls gaugeValueChanged.

Declared In

XuniGauge.h

  delegate

Gets or sets the delegate for handling notifications.

@property (nonatomic, weak) id<XuniGaugeDelegate> delegate

Discussion

Gets or sets the delegate for handling notifications.

Declared In

XuniGauge.h

  faceColor

Gets or sets the color of the face.

@property (nonatomic) IBInspectable UIColor *faceColor

Discussion

Gets or sets the color of the face.

Declared In

XuniGauge.h

  faceBorderColor

Gets or sets the border color of the face.

@property (nonatomic) IBInspectable UIColor *faceBorderColor

Discussion

Gets or sets the border color of the face.

Declared In

XuniGauge.h

  faceBorderWidth

Gets or sets the border width of the face.

@property (nonatomic) IBInspectable double faceBorderWidth

Discussion

Gets or sets the border width of the face.

Declared In

XuniGauge.h

  faceBorderDashes

Gets or sets the border dashes of the face.

@property (nonatomic) NSArray<NSNumber*> *faceBorderDashes

Discussion

Gets or sets the border dashes of the face.

Declared In

XuniGauge.h

  pointerColor

Gets or sets the color of the pointer.

@property (nonatomic) IBInspectable UIColor *pointerColor

Discussion

Gets or sets the color of the pointer.

Declared In

XuniGauge.h

  maxOpacity

Gets or sets the opacity of the max label.

@property (nonatomic) IBInspectable double maxOpacity

Discussion

Gets or sets the opacity of the max label.

Declared In

XuniGauge.h

  maxFontSize

Gets or sets the font size of the max label.

@property (nonatomic) IBInspectable double maxFontSize

Discussion

Gets or sets the font size of the max label.

Declared In

XuniGauge.h

  maxFontColor

Gets or sets the font color of the max label.

@property (nonatomic) IBInspectable UIColor *maxFontColor

Discussion

Gets or sets the font color of the max label.

Declared In

XuniGauge.h

  maxFontName

Gets or sets the font name of the max label.

@property (nonatomic) IBInspectable NSString *maxFontName

Discussion

Gets or sets the font name of the max label.

Declared In

XuniGauge.h

  maxFont

Gets or sets the font of the max label.

@property (nonatomic) UIFont *maxFont

Discussion

Gets or sets the font of the max label.

Declared In

XuniGauge.h

  minOpacity

Gets or sets the opacity of the min label.

@property (nonatomic) IBInspectable double minOpacity

Discussion

Gets or sets the opacity of the min label.

Declared In

XuniGauge.h

  minFontSize

Gets or sets the font size of the min label.

@property (nonatomic) IBInspectable double minFontSize

Discussion

Gets or sets the font size of the min label.

Declared In

XuniGauge.h

  minFontColor

Gets or sets the font color of the min label.

@property (nonatomic) IBInspectable UIColor *minFontColor

Discussion

Gets or sets the font color of the min label.

Declared In

XuniGauge.h

  minFontName

Gets or sets the font name of the min label.

@property (nonatomic) IBInspectable NSString *minFontName

Discussion

Gets or sets the font name of the min label.

Declared In

XuniGauge.h

  minFont

Gets or sets the font of the min label.

@property (nonatomic) UIFont *minFont

Discussion

Gets or sets the font of the min label.

Declared In

XuniGauge.h

  value

Gets or sets the value displayed on the gauge.

@property (nonatomic) IBInspectable double value

Discussion

Gets or sets the value displayed on the gauge.

Declared In

XuniGauge.h

  valueFontSize

Gets or sets the font size of the value.

@property (nonatomic) IBInspectable double valueFontSize

Discussion

Gets or sets the font size of the value.

Declared In

XuniGauge.h

  valueFontColor

Gets or sets the font color of the value.

@property (nonatomic) IBInspectable UIColor *valueFontColor

Discussion

Gets or sets the font color of the value.

Declared In

XuniGauge.h

  valueFontName

Gets or sets the font name of the value.

@property (nonatomic) IBInspectable NSString *valueFontName

Discussion

Gets or sets the font name of the value.

Declared In

XuniGauge.h

  valueFont

Gets or sets the font of the value label.

@property (nonatomic) UIFont *valueFont

Discussion

Gets or sets the font of the value label.

Declared In

XuniGauge.h

  isReadOnly

Gets or sets whether the value can change.

@property (nonatomic) IBInspectable BOOL isReadOnly

Discussion

Gets or sets whether the value can change.

Declared In

XuniGauge.h

  isEnabled

Gets or sets whether animation is enabled on the control.

@property (nonatomic) IBInspectable BOOL isEnabled

Discussion

Gets or sets whether animation is enabled on the control.

Declared In

XuniGauge.h

  isAnimated

Gets or sets whether animation is enabled on the control.

@property (nonatomic) IBInspectable BOOL isAnimated

Discussion

Gets or sets whether animation is enabled on the control.

Declared In

XuniGauge.h

  loadAnimation

Gets or sets the loading animation that occurs when the control first display.

@property (nonatomic) XuniAnimation *loadAnimation

Discussion

Gets or sets the loading animation that occurs when the control first display.

Declared In

XuniGauge.h

  updateAnimation

Gets or sets the updating animation that occurs when the control’s value is updated.

@property (nonatomic) XuniAnimation *updateAnimation

Discussion

Gets or sets the updating animation that occurs when the control’s value is updated.

Declared In

XuniGauge.h

  min

Gets or sets the minimun value of the gague.

@property (nonatomic) IBInspectable double min

Discussion

Gets or sets the minimun value of the gague.

Declared In

XuniGauge.h

  max

Gets or sets the maximun value of the gague.

@property (nonatomic) IBInspectable double max

Discussion

Gets or sets the maximun value of the gague.

Declared In

XuniGauge.h

  origin

Gets or sets the origin value of the gague.

@property (nonatomic) IBInspectable double origin

Discussion

Gets or sets the origin value of the gague.

Declared In

XuniGauge.h

  step

Gets or sets the step.

@property (nonatomic) IBInspectable double step

Discussion

Gets or sets the step.

Declared In

XuniGauge.h

  format

Gets or sets the format string used for displaying the gauge values as text.

@property (nonatomic) IBInspectable NSString *format

Discussion

Gets or sets the format string used for displaying the gauge values as text.

Declared In

XuniGauge.h

  face

Gets or sets the range used to represent the gauge’s overall geometry and appearance.

@property (nonatomic) XuniGaugeRange *face

Discussion

Gets or sets the range used to represent the gauge’s overall geometry and appearance.

Declared In

XuniGauge.h

  pointer

Gets or sets the range used to represent the gauge’s current value.

@property (nonatomic) XuniGaugeRange *pointer

Discussion

Gets or sets the range used to represent the gauge’s current value.

Declared In

XuniGauge.h

  showRanges

Gets or sets whether the gauge should display the ranges contained in the ranges property.

@property (nonatomic) IBInspectable BOOL showRanges

Discussion

Gets or sets whether the gauge should display the ranges contained in the ranges property.

Declared In

XuniGauge.h

  ranges

Gets or sets the gague ranges.

@property (nonatomic) XuniObservableArray<XuniGaugeRange*> *ranges

Discussion

Gets or sets the gague ranges.

Declared In

XuniGauge.h

  showText

Gets or sets which values should be displayed as text in the gauge.

@property (nonatomic) XuniShowText showText

Discussion

Gets or sets which values should be displayed as text in the gauge.

Declared In

XuniGauge.h

  oldValue

Gets or sets the old value of the gague.

@property (nonatomic) IBInspectable double oldValue

Discussion

Gets or sets the old value of the gague.

Declared In

XuniGauge.h

  thickness

Gets or sets the thickness of the gauge, on a scale between zero and one.

@property (nonatomic) IBInspectable double thickness

Discussion

Gets or sets the thickness of the gauge, on a scale between zero and one.

Declared In

XuniGauge.h

  rectGauge

Gets or sets the frame of the gauge.

@property (nonatomic) XuniRect *rectGauge

Discussion

Gets or sets the frame of the gauge.

Declared In

XuniGauge.h

  renderEngine

Gets or sets the render engine of the gague.

@property (readonly) XuniRenderEngine *renderEngine

Discussion

Gets or sets the render engine of the gague.

Declared In

XuniGauge.h

  animColor

Gets or sets the color when is during animation.

@property (nonatomic) UIColor *animColor

Discussion

Gets or sets the color when is during animation.

Declared In

XuniGauge.h

  easingType

Gets or sets the ease type of the animation.

@property (nonatomic) id<IXuniEaseAction> easingType

Discussion

Gets or sets the ease type of the animation.

Declared In

XuniGauge.h

  valueFormatter

Gets or sets the value formatter.

@property (nonatomic) NSObject<IXuniValueFormatter> *valueFormatter

Discussion

Gets or sets the value formatter.

Declared In

XuniGauge.h

– initialization

@exclude

- (void)initialization

Discussion

@exclude

Declared In

XuniGauge.h

– invalidate

Refresh gague if needed.

- (void)invalidate

Discussion

Refresh gague if needed.

Declared In

XuniGauge.h

– drawRect:

Internal, draw a rectangle.

- (void)drawRect:(CGRect)rect

Parameters

rect

the rectangle to draw.

Discussion

Internal, draw a rectangle.

Declared In

XuniGauge.h

– updateText

Updates the content and position of the text elements.

- (void)updateText

Discussion

Updates the content and position of the text elements.

Declared In

XuniGauge.h

– updateRangeElement:value:time:

Updates the range element.

- (void)updateRangeElement:(XuniGaugeRange *)rng value:(double)value time:(double)time

Parameters

rng

the range of the gague.
value

the value about the range.
time

the time.

Discussion

Updates the range element.

Declared In

XuniGauge.h

– getValueFromPoint:

Get value from the point.

- (double)getValueFromPoint:(XuniPoint *)point

Parameters

point

the point in control coordinates that this HitTestInfo refers to.

Return Value

return a double value of the gague.

Discussion

Get value from the point.

Declared In

XuniGauge.h

– hitTest:

Gets a number that corresponds to the value of the gauge at a given point.

- (double)hitTest:(XuniPoint *)point

Parameters

point

the point in control coordinates that this HitTestInfo refers to.

Return Value

return a number that corresponds to the value of the gauge at a given point.

Discussion

Gets a number that corresponds to the value of the gauge at a given point.

Declared In

XuniGauge.h

– hitTest:y:

Gets a number that corresponds to the value of the gauge at a given point.

- (double)hitTest:(double)x y:(double)y

Parameters

x

x value of the point.
y

y value of the point.

Return Value

a value that corresponds to the value of the gauge at a given point.

Discussion

Gets a number that corresponds to the value of the gauge at a given point.

Declared In

XuniGauge.h

– getPercent:

Scales a value to a percentage based on the gauge’s min and max properties.

- (double)getPercent:(double)value

Parameters

value

the given value.

Return Value

a value to a percentage based on the gauge’s min and max properties.

Discussion

Scales a value to a percentage based on the gauge’s min and max properties.

Declared In

XuniGauge.h

– getPointerColor:

Gets the color for the pointer range based on the gauge ranges.

- (UIColor *)getPointerColor:(double)value

Parameters

value

the given value.

Return Value

the color for the pointer range based on the gauge ranges.

Discussion

Gets the color for the pointer range based on the gauge ranges.

Declared In

XuniGauge.h

– clamp:min:max:

Clamps a value between a minimum and a maximum.

- (double)clamp:(double)value min:(double)min max:(double)max

Parameters

value

the given value.
min

the minimun value.
max

the maximun value.

Return Value

a value between a minimum and a maximum.

Discussion

Clamps a value between a minimum and a maximum.

Declared In

XuniGauge.h

– respondToTapGesture:

Respond to tap gesture.

- (void)respondToTapGesture:(UITapGestureRecognizer *)recognizer

Parameters

recognizer

tap gesture recognizer.

Discussion

Respond to tap gesture.

Declared In

XuniGauge.h

– getAnimationEasing

Get animation easing.

- (id<IXuniEaseAction>)getAnimationEasing

Return Value

an ease type.

Discussion

Get animation easing.

Declared In

XuniGauge.h

– getAnimationDuration

Get animation duration.

- (double)getAnimationDuration

Return Value

the duration of the animation.

Discussion

Get animation duration.

Declared In

XuniGauge.h

– formatDecimal:

Format string.

- (NSString *)formatDecimal:(double)number

Parameters

number

the given number.

Return Value

a formatted string.

Discussion

Format string.

Declared In

XuniGauge.h

– refresh

Refreshes the control.

- (void)refresh

Discussion

Refreshes the control.

Declared In

XuniGauge.h

– getDescriptor:

Get a descriptor of font.

- (UIFontDescriptor *)getDescriptor:(NSMutableDictionary *)attributes

Parameters

attributes

the font attributes.

Return Value

a descriptor.

Discussion

Get a descriptor of font.

Declared In

XuniGauge.h

  showMinMax

Gets or sets whether to show Min and Max value.

@property (nonatomic) IBInspectable BOOL showMinMax

Discussion

Gets or sets whether to show Min and Max value.

Declared In

XuniGauge.h

  showValue

Gets or sets whether to show current gauge value.

@property (nonatomic) IBInspectable BOOL showValue

Discussion

Gets or sets whether to show current gauge value.

Declared In

XuniGauge.h

  pointerThickness

Gets or sets pointer thickness.

@property (nonatomic) IBInspectable double pointerThickness

Discussion

Gets or sets pointer thickness.

Declared In

XuniGauge.h