Packageorg.axiis.layouts.scale
Classpublic class LinearScale
InheritanceLinearScale Inheritance ContinuousScale Inheritance AbstractScale Inheritance flash.events.EventDispatcher
Implements IScale

A scale that deals with linear numeric data.


Public Properties
 PropertyDefined By
 InheritedcomputedAverage : *
[read-only] The average value in the dataProvider.
ContinuousScale
 InheritedcomputedMaxValue : *
[read-only] The maximum value in the dataProvider.
AbstractScale
 InheritedcomputedMinValue : *
[read-only] The minimum value in the dataProvider.
AbstractScale
 InheritedcomputedSum : *
[read-only] The sum of the value in the dataProvider.
ContinuousScale
 InheriteddataField : String
The name of the property of the Objects in the dataProvider that should be used when computing min, max, sum, and average values.
AbstractScale
 InheriteddataProvider : Object
The DataSet, ArrayCollection, Array, XML, etc.
AbstractScale
 Inheritedinvalidated : Boolean
[read-only] Indicates that the scale should recalculate it's minimum and maximum values and layouts the next time either layoutToValue or valueToLayout is called.
AbstractScale
 InheritedmaxLayout : Number
The maximum layout position.
AbstractScale
 InheritedmaxValue : *
The maximum value allowed in this scale.
AbstractScale
 InheritedminLayout : Number
The minimum layout position.
AbstractScale
 InheritedminValue : *
The minimum value allowed in this scale.
AbstractScale
Protected Properties
 PropertyDefined By
 Inheritedcollection : ArrayCollection
AbstractScale
 Inherited_computedMaxValue : *
[write-only]
AbstractScale
 Inherited_computedMinValue : *
[write-only]
AbstractScale
 InheriteduserMaxValue : *
The maximum value as specified by the user.
AbstractScale
 InheriteduserMinValue : *
The minimum value as specified by the user.
AbstractScale
Public Methods
 MethodDefined By
  
LinearScale()
LinearScale
 Inherited
invalidate():void
Marks this IScale as needing its minValue and maxValue recomputed.
AbstractScale
  
layoutToValue(layout:*, invert:Boolean = false, clamp:Boolean = true):*
Converts a layout position to a value that would arise in the space defined by the implementing class.
LinearScale
 Inherited
validate():void
Initiates the computation of minValue and maxValue.
ContinuousScale
  
valueToLayout(value:*, invert:Boolean = false, clamp:Boolean = true):*
Converts a value to a position in layout space.
LinearScale
Protected Methods
 MethodDefined By
 Inherited
computeMax():*
Returns the maximum value from the dataProvider.
ContinuousScale
 Inherited
computeMin():*
Returns the minimum value from the dataProvider.
ContinuousScale
 Inherited
computeSum():*
Returns the sum of the items in the dataProvider.
ContinuousScale
Events
 Event Summary Defined By
 Inherited
invalidate
Dispatched when the data in the becomes invalid and the new min, max, sum, and average need to be computed.AbstractScale
Constructor Detail
LinearScale()Constructor
public function LinearScale()



Method Detail
layoutToValue()method
public function layoutToValue(layout:*, invert:Boolean = false, clamp:Boolean = true):*

Converts a layout position to a value that would arise in the space defined by the implementing class. For example, LinearScale converts a layout position to a Number between minValue and maxValue, whether or not that Number is actually present within the dataProvider. CategoricalScale, on the other hand, will only convert layout positions to values found within the dataProvider.

Parameters

layout:* — layout position to translate into a value.
 
invert:Boolean (default = false)
 
clamp:Boolean (default = true)

Returns
*
valueToLayout()method 
public function valueToLayout(value:*, invert:Boolean = false, clamp:Boolean = true):*

Converts a value to a position in layout space.

Parameters

value:* — The value to be converted into layout space.
 
invert:Boolean (default = false) — Whether the minValue translates to minLayout (false) or to maxLayout (true).
 
clamp:Boolean (default = true)

Returns
*




Fri Oct 2 2009, 08:24 PM -04:00