| Package | ardisia.components.colorizer |
| Class | public class GradientColorizer |
| Inheritance | GradientColorizer  flash.events.EventDispatcher |
| Implements | IColorizer |
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertydataProvider
| Property | Defined By | ||
|---|---|---|---|
| dataProvider : Vector.<GradientColorizerData>
Populate with a vector of GradientColorizerData objects. | GradientColorizer | ||
| rangeMaximum : Number = 1
Defines the maximum value of the range. | GradientColorizer | ||
| rangeMinimum : Number = 0
Defines the minimum value of the range. | GradientColorizer | ||
| Method | Defined By | ||
|---|---|---|---|
getColor(value:Number):uint
Returns a color based on the value parameter. | GradientColorizer | ||
| Method | Defined By | ||
|---|---|---|---|
Sorts the passed GradientColorizerData objects from lowest ratio to
the highest ratio. | GradientColorizer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the "dataProvider" property changes. | GradientColorizer | |||
| dataProvider | property |
dataProvider:Vector.<GradientColorizerData>Populate with a vector of GradientColorizerData objects.
The default value is null.
public function get dataProvider():Vector.<GradientColorizerData> public function set dataProvider(value:Vector.<GradientColorizerData>):void| rangeMaximum | property |
public var rangeMaximum:Number = 1Defines the maximum value of the range.
The default value is 1.
| rangeMinimum | property |
public var rangeMinimum:Number = 0Defines the minimum value of the range.
The default value is 0.
| getColor | () | method |
public function getColor(value:Number):uintReturns a color based on the value parameter.
Parameters
value:Number — the number used to lookup the color from the dataProvider
|
uint — a uint color value or null if no color returned
|
| sortFunction | () | method |
protected function sortFunction(x:GradientColorizerData, y:GradientColorizerData):NumberSorts the passed GradientColorizerData objects from lowest ratio to the highest ratio.
Parameters
x:GradientColorizerData — the first GradientColorizerData object to sort
| |
y:GradientColorizerData — the second GradientColorizerData object to sort
|
Number — -1 if x is first, 1 if y is first
|
| change | Event |
ardisia.components.colorizer.events.ColorizerEventardisia.components.colorizer.events.ColorizerEventDispatched when the "dataProvider" property changes.