| Package | org.axiis.layouts.scale |
| Interface | public interface IScale |
| Implementors | CategoricalScale, DateTimeScale, LinearScale, LogScale |
| Property | Defined By | ||
|---|---|---|---|
| dataField : String
The name of the property of the Objects in the dataProvider
that should be used when computing min, max, sum, and average values. | IScale | ||
| dataProvider : Object
The DataSet, ArrayCollection, Array, XML, etc. | IScale | ||
| maxLayout : Number
The maximum layout position. | IScale | ||
| maxValue : *
The maximum value allowed in this scale. | IScale | ||
| minLayout : Number
The minimum layout position. | IScale | ||
| minValue : *
The minimum value allowed in this scale. | IScale | ||
| Method | Defined By | ||
|---|---|---|---|
invalidate():void
Marks this IScale as needing its minValue and maxValue recomputed. | IScale | ||
layoutToValue(layout:*, invert:Boolean = false, clamp:Boolean = false):*
Converts a layout position to a value that would arise in the
space defined by the implementing class. | IScale | ||
validate():void
Initiates the computation of minValue and maxValue. | IScale | ||
valueToLayout(value:*, invert:Boolean = false, clamp:Boolean = false):*
Converts a value to a position in layout space. | IScale | ||
| dataField | property |
dataField:String [read-write] The name of the property of the Objects in the dataProvider that should be used when computing min, max, sum, and average values. If this property is not set, the implementing class should use the Objects themselves.
public function get dataField():String public function set dataField(value:String):void| dataProvider | property |
dataProvider:Object [read-write] The DataSet, ArrayCollection, Array, XML, etc. that is used to determine the range of this scale.
public function get dataProvider():Object public function set dataProvider(value:Object):void| maxLayout | property |
maxLayout:Number [read-write] The maximum layout position.
public function get maxLayout():Number public function set maxLayout(value:Number):void| maxValue | property |
maxValue:* [read-write] The maximum value allowed in this scale. If this property is not set, the implementer should compute an appropriate maximum by analyzing the contents of the dataProvider.
public function get maxValue():* public function set maxValue(value:any):void| minLayout | property |
minLayout:Number [read-write] The minimum layout position.
public function get minLayout():Number public function set minLayout(value:Number):void| minValue | property |
minValue:* [read-write] The minimum value allowed in this scale. If this property is not set, the implementer should compute an appropriate minimum by analyzing the contents of the dataProvider.
public function get minValue():* public function set minValue(value:any):void| invalidate | () | method |
public function invalidate():voidMarks this IScale as needing its minValue and maxValue recomputed.
| layoutToValue | () | method |
public function layoutToValue(layout:*, invert:Boolean = false, clamp:Boolean = false):*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 = false) |
* |
| validate | () | method |
public function validate():voidInitiates the computation of minValue and maxValue.
| valueToLayout | () | method |
public function valueToLayout(value:*, invert:Boolean = false, clamp:Boolean = false):*Converts a value to a position in layout space.
Parameters
value:* — The value to be converted into layout space.
| |
invert:Boolean (default = false) | |
clamp:Boolean (default = false) |
* |