| Package | ardisia.components.gauges |
| Class | public class RadialGauge |
| Inheritance | RadialGauge  GaugeBase spark.components.supportClasses.SliderBase |
View the technical documentation on the Ardisia Labs website for more information.
| Property | Defined By | ||
|---|---|---|---|
| angleEnd : Number
The angle at which to end the drawing of the gauge arc in degrees. | RadialGauge | ||
| angleStart : Number
The angle at which to begin drawing the gauge arc in degrees. | RadialGauge | ||
 | editable : Boolean
Whether the value can be changed via user interaction. | GaugeBase | |
| labelDefaultPrecision : Number
Default precision for the number formatter if a labelsFormatFunction
is not provided. | GaugeBase | |
| labelsFormatFunction : Function
The callback function used to format the labels. | GaugeBase | |
| majorTickCount : int
The number of major ticks to display. | GaugeBase | |
| minorTickCount : int
The number of minor ticks to display between major ticks. | GaugeBase | |
| showTickLabels : Boolean
True to display labels along with the major ticks. | GaugeBase | |
| showTicks : Boolean
True to display ticks. | GaugeBase | |
| Property | Defined By | ||
|---|---|---|---|
| radius : Number
Radius of the arc swept out by the gauge. | RadialGauge | ||
| Method | Defined By | ||
|---|---|---|---|
checkAngle(value:Number):Number
Checks that the passed angle is between 0 and 360 and if not, returns
the normalized value
| RadialGauge | ||
| formatLabelText(value:Number):Object
Format the value to a human readable String. | GaugeBase | |
| updateTickLabels():void
Update the tick labels skin parts. | GaugeBase | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
inset | Type: Number CSS Inheritance: no The number of pixels by which to inset the gauge within the track. Must be at least 1 pixel. The default value is 15. | RadialGauge | ||
| Type: Number CSS Inheritance: no The number of pixels to offset the labels from the tick marks. | GaugeBase | ||
| Type: uint Format: Color CSS Inheritance: no The color of the major ticks. | GaugeBase | ||
| Type: String CSS Inheritance: no The shape of the major tick mark: line or circle. | GaugeBase | ||
| Type: Number CSS Inheritance: no The length of the major tick. | GaugeBase | ||
| Type: Number CSS Inheritance: no The thickness of major tick strokes or the radius of the circle. | GaugeBase | ||
| Type: uint Format: Color CSS Inheritance: no The color of the minor ticks. | GaugeBase | ||
| Type: String CSS Inheritance: no The shape of the minor tick mark: line or circle. | GaugeBase | ||
| Type: Number CSS Inheritance: no The length of the minor tick. | GaugeBase | ||
| Type: Number CSS Inheritance: no The thickness of minor tick strokes or the radius of the circle. | GaugeBase | ||
thumbInset | Type: Number CSS Inheritance: no The number of pixels by which to inset the tip of the thumb (needle) from the radius of the gauge's arc. The default value is 10. | RadialGauge | ||
| Type: Number CSS Inheritance: no The number of pixels to offset the tick marks from the track. | GaugeBase | ||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| angleEnd | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesangleEnd:NumberThe angle at which to end the drawing of the gauge arc in degrees.
The default value is 360.
public function get angleEnd():Number public function set angleEnd(value:Number):void| angleStart | property |
angleStart:NumberThe angle at which to begin drawing the gauge arc in degrees.
The default value is 180.
public function get angleStart():Number public function set angleStart(value:Number):void| radius | property |
protected var radius:NumberRadius of the arc swept out by the gauge.
| checkAngle | () | method |
protected function checkAngle(value:Number):NumberChecks that the passed angle is between 0 and 360 and if not, returns the normalized value
Parameters
value:Number — the Number to check
|
Number — normalized value
|