| Package | flare.scale |
| Class | public class Scale |
| Implements | mx.core.IMXMLObject |
| Subclasses | OrdinalScale, QuantileScale, QuantitativeScale, ScaleBinding, TimeScale |
| Property | Defined by | ||
|---|---|---|---|
| flush : Boolean
Flag indicating if the scale bounds should be flush with the data.
| Scale | ||
| labelFormat : String
Formatting pattern for formatting labels for scale values.
| Scale | ||
| max : Object The maximum data value backing this scale.
| Scale | ||
| min : Object The minimum data value backing this scale.
| Scale | ||
| scaleType : String [read-only] A string indicating the type of scale this is.
| Scale | ||
| Property | Defined by | ||
|---|---|---|---|
| _flush : Boolean = false Flag indicating if the scale bounds should be flush with the data.
| Scale | ||
| _format : String = "null" Formatting pattern for formatting labels for scale values.
| Scale | ||
| Method | Defined by | ||
|---|---|---|---|
|
Returns a cloned copy of the scale.
| Scale | ||
|
interpolate(value:Object):Number
Returns an interpolation fraction indicating the position of the input
value within the scale range.
| Scale | ||
|
label(value:Object):String
Returns a string label representing a value in this scale.
| Scale | ||
|
lookup(f:Number):Object
Performs a reverse lookup, returning an object value corresponding
to a interpolation fraction along the scale range.
| Scale | ||
|
values(num:int = -1):Array
Returns a set of label values for this scale.
| Scale | ||
| _flush | property |
protected var _flush:Boolean = falseFlag indicating if the scale bounds should be flush with the data. False by default, thereby allowing some padding space on the end of the scale.
| flush | property |
flush:Boolean [read-write]Flag indicating if the scale bounds should be flush with the data. If true, the scale should be flush with the data range, such that the min and max values should sit directly on the extremes of the scale. If false, the scale should be padded as needed to make the scale more readable and human-friendly.
Implementation public function get flush():Boolean
public function set flush(value:Boolean):void
| _format | property |
protected var _format:String = "null"Formatting pattern for formatting labels for scale values.
See also
| labelFormat | property |
labelFormat:String [read-write]
Formatting pattern for formatting labels for scale values.
For details about the various formatting patterns, see the
documentation for the Strings.format method.
public function get labelFormat():String
public function set labelFormat(value:String):void
See also
| max | property |
max:Object [read-write]The maximum data value backing this scale. Note that the actual maximum scale value may be higher if the scale is not flush.
Implementation public function get max():Object
public function set max(value:Object):void
| min | property |
min:Object [read-write]The minimum data value backing this scale. Note that the actual minimum scale value may be lower if the scale is not flush.
Implementation public function get min():Object
public function set min(value:Object):void
| scaleType | property |
scaleType:String [read-only]A string indicating the type of scale this is.
Implementation public function get scaleType():String
| clone | () | method |
| interpolate | () | method |
public function interpolate(value:Object):NumberReturns an interpolation fraction indicating the position of the input value within the scale range.
Parametersvalue:Object — a data value for which to return an interpolation
fraction along the data scale
|
Number — the interpolation fraction of the value in the data scale
|
| label | () | method |
public function label(value:Object):StringReturns a string label representing a value in this scale. The labelFormat property determines how the value will be formatted.
Parametersvalue:Object — the data value to get the string label for
|
String — a string label for the value
|
| lookup | () | method |
public function lookup(f:Number):ObjectPerforms a reverse lookup, returning an object value corresponding to a interpolation fraction along the scale range.
Parametersf:Number — the interpolation fraction
|
Object — the scale value at the interpolation fraction. May return
null if no value corresponds to the input fraction.
|
| values | () | method |
public function values(num:int = -1):ArrayReturns a set of label values for this scale.
Parametersnum:int (default = -1) |
Array — an array of label values for the scale
|