| Package | com.flexicious.components.charts.axis |
| Class | public class AxisBase |
| Inheritance | AxisBase  Gauge com.flexicious.lic.GaugeBase |
| Subclasses | HorizontalAxis, VerticalAxis |
Default MXML PropertymxmlContentFactory
| Property | Defined By | ||
|---|---|---|---|
 | activeRangeInfo : RangeInfo [read-only]
Gets the range info object within which the current gauge value falls. | Gauge | |
| animate : Boolean
Whether or not to animate the gauges. | Gauge | |
| animationDuration : Number
The number of milliseconds to run the animation for. | Gauge | |
| axisType : String = linear
Type of the axis. | AxisBase | ||
| chart : CartesianChart
Chart associated with this axis
| AxisBase | ||
| circleSize : Number [read-only] | Gauge | |
| convertZeroesToAlpha : Boolean
Flag to convert thousands, millions and billions into Alpha representations. | Gauge | |
| currentTip : IToolTip
The current instance of the data tip for this control
| Gauge | |
| data : Object | Gauge | |
| dataTipFunction : Function
A function that gets called to retrieve the text to be displayed in the tooltip behavior. | Gauge | |
| dataTipRenderer : IFactory
Renderer for the data tip. | Gauge | |
| dialColor : Number | Gauge | |
| dialColorGradientBrightness : Number | Gauge | |
| dialColorGradientDarkness : Number | Gauge | |
| dialLinearGradient : Boolean | Gauge | |
| dialRimColor : Number | Gauge | |
| dialTitle : String
The text for the title of the dial. | Gauge | |
| dialTitleStyleName : String
The style name to apply to the dial title
Default: dialText - textAlign:center;color:#3c3c3c;
| Gauge | |
| diameter : Number
By default, returns width. | Gauge | |
| displayName : String
The name of the axis. | AxisBase | ||
| elementsToBlur : Array [read-only] | Gauge | |
| elementToCenter : IUIComponent [read-only] | Gauge | |
| endAngle : Number
The angle at which to end the ticks and the ranges. | Gauge | |
| gaugeValue : Number
The value to show for the dial
| Gauge | |
| gaugeValueStyleName : String
The style name to apply to the dial value
Default: gaugeValueText - textAlign:center;color:#3c3c3c;
| Gauge | |
| labelRotation : Number
The degrees to rotate the label by
| Gauge | |
| labelXOffset : Number
To accomodate various positioning scenarios, the default calculation of the labels
can be changed. | Gauge | |
| labelYOffset : Number
To accomodate various positioning scenarios, the default calculation of the labels
can be changed. | Gauge | |
| needleBaseColor : Number | Gauge | |
| needleColor : Number | Gauge | |
| needleRotation : Number [read-only]
In normal state, needle is in the 9 o clock position. | Gauge | |
| needleThickness : Number | Gauge | |
| rangeGap : Number
Distance between the edge of the dial, and the edge of the
range arc as well as the needle tip. | Gauge | |
| ranges : Array
An array of RangeInfo Objects that define the ranges of the gauge. | Gauge | |
| rangeThickness : Number
The thickness of the range lines. | Gauge | |
| showGaugeValue : Boolean
Flag whether or not to show the gauge value. | Gauge | |
| showSpinnerOnCreationComplete : Boolean | Gauge | |
| spinner : ISpinner | Gauge | |
| spinnerBehavior : SpinnerBehavior | Gauge | |
| spinnerFactory : IFactory
Factory responsible for instantiating a new spinner. | Gauge | |
| spinnerLabel : String
The label of the spinner control, you can use styles
to control the appearance. | Gauge | |
| spinnerParent : Object [read-only] | Gauge | |
| startAngle : Number
The angle at which to start the ticks and the ranges. | Gauge | |
| tickEndValue : Number
The numeric value to assicoate with the endAngle. | Gauge | |
| tickLabelFactory : IFactory
The factory used to instantiate the tick labels. | Gauge | |
| tickLabelFunction : Function
The label function that determines the label for the tick. | Gauge | |
| tickLabelPrecision : Number
Precision of the tick labels
| Gauge | |
| tickMajorColor : uint
The color of the major tick
Default: white
| Gauge | |
| tickMajorLabelStyleName : String
The style name to apply to the major tick labels
Default: tickMajorLabel
| Gauge | |
| tickMajorLength : uint
The length of the major tick
Default: 22
| Gauge | |
| tickMajorStartOffset : Number
The start offset at which to being drawing the major tick. | Gauge | |
| tickMajorStep : Number
The numeric difference between two major ticks. | Gauge | |
| tickMajorThickness : int
The thickness of the major tick
Default: 2
| Gauge | |
| tickMinorColor : uint
The color of the minor tick
Default: white
| Gauge | |
| tickMinorLabelStyleName : String
The style name ot apply to the minor tick labels
Default: tickMinorLabel
| Gauge | |
| tickMinorLength : uint
The length of the minor tick
Default: 16
| Gauge | |
| tickMinorStartOffset : Number
The start offset at which to being drawing the minor tick. | Gauge | |
| tickMinorStep : Number
The numeric difference between two minor ticks
Default: 5
| Gauge | |
| tickMinorThickness : int
The thickness of the minor tick
Default: 2
| Gauge | |
| tickShowMajorLabels : Boolean
Whether or not to show major tick labels
Default: true
| Gauge | |
| tickShowMinorLabels : Boolean
Whether or not to show values for minor tick labels
Default: false
| Gauge | |
| tickStartValue : Number
The numeric value to assicoate with the startAngle. | Gauge | |
| tickSteps : Array
For custom drawn ticks, where we provide the tick steps. | Gauge | |
| title : String
The text for the title displayed along the axis. | AxisBase | ||
| tooltipBehavior : TooltipBehavior | Gauge | |
| useElements : Boolean [read-only]
Whether to use addElement or addChild;
| Gauge | |
| Method | Defined By | ||
|---|---|---|---|
AxisBase() | AxisBase | ||
getPositionForValue(val:*, index:int = -1):Number [override] | AxisBase | ||
getXYForValue(val:Number, index:int = -1):Number
Given a value between tickStartValue and tickEndValue, returns an x between 0 and ranges.width. | AxisBase | ||
| hideSpinner():void
Removes the spinner and sets the bodyContainer.alpha back to 1
| Gauge | |
| invalidateTicks():void
Drops and recreates all tick labels and ticks
| Gauge | |
| 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 | |
| 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 | |
| Constant | Defined By | ||
|---|---|---|---|
| CATEGORY : String = category [static] | AxisBase | ||
| LINEAR : String = linear [static] | AxisBase | ||
| axisType | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var axisType:String = linearType of the axis. Can be linear or Category. For Bar Charts, XAxis is linear, Y is category. For Column Charts, X Axis is Category, Y is Linear.
| chart | property |
chart:CartesianChartChart associated with this axis
This property can be used as the source for data binding.
public function get chart():CartesianChart public function set chart(value:CartesianChart):void| displayName | property |
displayName:StringThe name of the axis. If set, Flex uses this name to format DataTip controls.
public function get displayName():String public function set displayName(value:String):void| title | property |
title:StringThe text for the title displayed along the axis.
public function get title():String public function set title(value:String):void| AxisBase | () | Constructor |
public function AxisBase()| getPositionForValue | () | method |
override public function getPositionForValue(val:*, index:int = -1):NumberParameters
val:* | |
index:int (default = -1) |
Number |
| getXYForValue | () | method |
public function getXYForValue(val:Number, index:int = -1):NumberGiven a value between tickStartValue and tickEndValue, returns an x between 0 and ranges.width.
Parameters
val:Number | |
index:int (default = -1) |
Number |
| CATEGORY | Constant |
public static const CATEGORY:String = category| LINEAR | Constant |
public static const LINEAR:String = linear