Packagecom.flexicious.components.visualization
Classpublic class VerticalLinearGauge
InheritanceVerticalLinearGauge Inheritance Gauge Inheritance com.flexicious.lic.GaugeBase

A Gauge that draws a vertical bar for the scale, and color coded vertically stacked ranges for the ranges.

Default MXML PropertymxmlContentFactory


Public Properties
 PropertyDefined By
 InheritedactiveRangeInfo : RangeInfo
[read-only] Gets the range info object within which the current gauge value falls.
Gauge
 Inheritedanimate : Boolean
Whether or not to animate the gauges.
Gauge
 InheritedanimationDuration : Number
The number of milliseconds to run the animation for.
Gauge
 InheritedcircleSize : Number
[read-only]
Gauge
 InheritedconvertZeroesToAlpha : Boolean
Flag to convert thousands, millions and billions into Alpha representations.
Gauge
 InheritedcurrentTip : IToolTip
The current instance of the data tip for this control
Gauge
 Inheriteddata : Object
Gauge
 InheriteddataTipFunction : Function
A function that gets called to retrieve the text to be displayed in the tooltip behavior.
Gauge
 InheriteddataTipRenderer : IFactory
Renderer for the data tip.
Gauge
 InheriteddialColor : Number
Gauge
 InheriteddialColorGradientBrightness : Number
Gauge
 InheriteddialColorGradientDarkness : Number
Gauge
 InheriteddialLinearGradient : Boolean
Gauge
 InheriteddialRimColor : Number
Gauge
 InheriteddialTitle : String
The text for the title of the dial.
Gauge
 InheriteddialTitleStyleName : String
The style name to apply to the dial title Default: dialText - textAlign:center;color:#3c3c3c;
Gauge
 Inheriteddiameter : Number
By default, returns width.
Gauge
 InheritedelementsToBlur : Array
[read-only]
Gauge
 InheritedelementToCenter : IUIComponent
[read-only]
Gauge
 InheritedendAngle : Number
The angle at which to end the ticks and the ranges.
Gauge
 InheritedgaugeValue : Number
The value to show for the dial
Gauge
 InheritedgaugeValueStyleName : String
The style name to apply to the dial value Default: gaugeValueText - textAlign:center;color:#3c3c3c;
Gauge
 InheritedlabelRotation : Number
The degrees to rotate the label by
Gauge
 InheritedlabelXOffset : Number
To accomodate various positioning scenarios, the default calculation of the labels can be changed.
Gauge
 InheritedlabelYOffset : Number
To accomodate various positioning scenarios, the default calculation of the labels can be changed.
Gauge
 InheritedneedleBaseColor : Number
Gauge
 InheritedneedleColor : Number
Gauge
 InheritedneedleRotation : Number
[read-only] In normal state, needle is in the 9 o clock position.
Gauge
 InheritedneedleThickness : Number
Gauge
 InheritedrangeGap : Number
Distance between the edge of the dial, and the edge of the range arc as well as the needle tip.
Gauge
 Inheritedranges : Array
An array of RangeInfo Objects that define the ranges of the gauge.
Gauge
 InheritedrangeThickness : Number
The thickness of the range lines.
Gauge
 InheritedshowGaugeValue : Boolean
Flag whether or not to show the gauge value.
Gauge
 InheritedshowSpinnerOnCreationComplete : Boolean
Gauge
 Inheritedspinner : ISpinner
Gauge
 InheritedspinnerBehavior : SpinnerBehavior
Gauge
 InheritedspinnerFactory : IFactory
Factory responsible for instantiating a new spinner.
Gauge
 InheritedspinnerLabel : String
The label of the spinner control, you can use styles to control the appearance.
Gauge
 InheritedspinnerParent : Object
[read-only]
Gauge
 InheritedstartAngle : Number
The angle at which to start the ticks and the ranges.
Gauge
 InheritedtickEndValue : Number
The numeric value to assicoate with the endAngle.
Gauge
 InheritedtickLabelFactory : IFactory
The factory used to instantiate the tick labels.
Gauge
 InheritedtickLabelFunction : Function
The label function that determines the label for the tick.
Gauge
 InheritedtickLabelPrecision : Number
Precision of the tick labels
Gauge
 InheritedtickMajorColor : uint
The color of the major tick Default: white
Gauge
 InheritedtickMajorLabelStyleName : String
The style name to apply to the major tick labels Default: tickMajorLabel
Gauge
 InheritedtickMajorLength : uint
The length of the major tick Default: 22
Gauge
 InheritedtickMajorStartOffset : Number
The start offset at which to being drawing the major tick.
Gauge
 InheritedtickMajorStep : Number
The numeric difference between two major ticks.
Gauge
 InheritedtickMajorThickness : int
The thickness of the major tick Default: 2
Gauge
 InheritedtickMinorColor : uint
The color of the minor tick Default: white
Gauge
 InheritedtickMinorLabelStyleName : String
The style name ot apply to the minor tick labels Default: tickMinorLabel
Gauge
 InheritedtickMinorLength : uint
The length of the minor tick Default: 16
Gauge
 InheritedtickMinorStartOffset : Number
The start offset at which to being drawing the minor tick.
Gauge
 InheritedtickMinorStep : Number
The numeric difference between two minor ticks Default: 5
Gauge
 InheritedtickMinorThickness : int
The thickness of the minor tick Default: 2
Gauge
 InheritedtickShowMajorLabels : Boolean
Whether or not to show major tick labels Default: true
Gauge
 InheritedtickShowMinorLabels : Boolean
Whether or not to show values for minor tick labels Default: false
Gauge
 InheritedtickStartValue : Number
The numeric value to assicoate with the startAngle.
Gauge
 InheritedtickSteps : Array
For custom drawn ticks, where we provide the tick steps.
Gauge
 InheritedtooltipBehavior : TooltipBehavior
Gauge
 InheriteduseElements : Boolean
[read-only] Whether to use addElement or addChild;
Gauge
Public Methods
 MethodDefined By
  
VerticalLinearGauge()
VerticalLinearGauge
  
getPositionForValue(val:*, index:int = -1):Number
[override]
VerticalLinearGauge
  
getYForValue(val:Number):Number
Given a value between tickStartValue and tickEndValue, returns y between 0 and ranges.height.
VerticalLinearGauge
 Inherited
hideSpinner():void
Removes the spinner and sets the bodyContainer.alpha back to 1
Gauge
 Inherited
invalidateTicks():void
Drops and recreates all tick labels and ticks
Gauge
 Inherited
showSpinner(msg:String):void
Shows the spinner with default values defined below: Label: "Loading please wait" X Position : center X of the grid Y Position : center Y of the grid Grid Alpa when the spinner is active : 0.3 Spinner appearance can be modified using styles .
Gauge
 Inherited
showToaster(message:String, toasterPosition:String, toasterRenderer:IFactory = null, animationDuration:Number = 1000, visibleDuration:Number = 5000, moveAnimate:Boolean = true, fadeAnimate:Boolean = true):void
[override] Shows the given toaster message
Gauge
Protected Methods
 MethodDefined By
 Inherited
mouseMoveHandler(event:MouseEvent):void
Handler for the mouse move event.
Gauge
 Inherited
mouseOutHandler(event:MouseEvent):void
Handler for the mouse out event.
Gauge
Styles
 Style Description Defined By
 Inherited
spinnerColors
Type: Array Format: Color
Colors for the spinners as an array.		Gauge
 Inherited
spinnerGridAlpha
Type: Number Format: Length
Background color of the grid when the spinner is active.		Gauge
 Inherited
spinnerLabelBackgroundColor
Type: uint Format: Color
Bacground color for the box in which the label is displayed.		Gauge
 Inherited
spinnerLabelColor
Type: uint Format: Color CSS Inheritance: yes
Label color for the spinner.		Gauge
 Inherited
spinnerLabelfontFamily
Type: String CSS Inheritance: yes
Label font family.		Gauge
 Inherited
spinnerLabelfontSize
Type: Number Format: Length CSS Inheritance: yes
Label font size.		Gauge
 Inherited
spinnerLabelfontStyle
Type: String CSS Inheritance: yes
Label font style.		Gauge
 Inherited
spinnerLabelfontThickness
Type: Number CSS Inheritance: yes
Label font thinkcness.		Gauge
 Inherited
spinnerLabelfontWeight
Type: String CSS Inheritance: yes
Label font weight.		Gauge
 Inherited
spinnerLabelShowBackground
Type: Boolean
A flag that controls whether or not to show the spinner.		Gauge
 Inherited
spinnerRadius
Type: Number Format: Length
Spinner radius , default value is 10.		Gauge
 Inherited
spinnerThickness
Type: Number Format: Length
Spinner thickness , default value is 5.		Gauge
Constructor Detail
VerticalLinearGauge()Constructor
public function VerticalLinearGauge()



Method Detail
getPositionForValue()method
override public function getPositionForValue(val:*, index:int = -1):Number

Parameters

val:*
 
index:int (default = -1)

Returns
Number
getYForValue()method 
public function getYForValue(val:Number):Number

Given a value between tickStartValue and tickEndValue, returns y between 0 and ranges.height.

Parameters

val:Number

Returns
Number



Copyright 2012 Flexicious LLC. All rights reserved.

Mon Jun 24 2013, 11:00 PM -04:00