| Package | flare.vis.operator.encoder |
| Class | public class Encoder |
| Inheritance | Encoder  Operator |
| Subclasses | ColorEncoder, ShapeEncoder, SizeEncoder |
| Property | Defined by | ||
|---|---|---|---|
 | enabled : Boolean Indicates if the operator is enabled or disabled.
| Operator | |
| filter : Function Boolean function indicating which items to process.
| Encoder | ||
| group : String The name of the data group for which to compute the encoding.
| Encoder | ||
| palette : Palette
The palette used to map scale values to visual values.
| Encoder | ||
| parameters : Object
Sets parameter values for this operator.
| Operator | |
| scale : ScaleBinding
A scale binding to the source data.
| Encoder | ||
| source : String The source property.
| Encoder | ||
| target : String The target property.
| Encoder | ||
| visualization : Visualization
The visualization processed by this operator.
| Operator | |
| Property | Defined by | ||
|---|---|---|---|
| _binding : ScaleBinding
A scale binding to the source data.
| Encoder | ||
| _filter : Function Boolean function indicating which items to process.
| Encoder | ||
| _t : Transitioner
A transitioner for collecting value updates.
| Encoder | ||
| _target : String The target property.
| Encoder | ||
| Method | Defined by | ||
|---|---|---|---|
|
Encoder(source:String = null, target:String = null, group:String, filter:* = null)
Creates a new Encoder.
| Encoder | ||
|
applyParameters(op:IOperator, params:Object):void
[static]
Static method that applies parameter settings to an operator.
| Operator | |
|
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
| Encoder | ||
|
setup():void
Setup method invoked whenever this operator's visualization
property is set.
| Encoder | ||
| Method | Defined by | ||
|---|---|---|---|
|
encode(val:Object):*
Computes an encoding for the input value.
| Encoder | ||
| _binding | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _binding:ScaleBindingA scale binding to the source data.
| _filter | property |
protected var _filter:FunctionBoolean function indicating which items to process.
| filter | property |
filter:Function [read-write]Boolean function indicating which items to process. Only items for which this function return true will be considered by the labeler. If the function is null, all items will be considered.
Implementation public function get filter():Function
public function set filter(value:Function):void
See also
| group | property |
group:String [read-write]The name of the data group for which to compute the encoding.
Implementation public function get group():String
public function set group(value:String):void
| palette | property |
palette:Palette [read-write]The palette used to map scale values to visual values.
Implementation public function get palette():Palette
public function set palette(value:Palette):void
| scale | property |
scale:ScaleBinding [read-write]A scale binding to the source data.
Implementation public function get scale():ScaleBinding
public function set scale(value:ScaleBinding):void
| source | property |
source:String [read-write]The source property.
Implementation public function get source():String
public function set source(value:String):void
| _t | property |
protected var _t:TransitionerA transitioner for collecting value updates.
| _target | property |
protected var _target:StringThe target property.
| target | property |
target:String [read-write]The target property.
Implementation public function get target():String
public function set target(value:String):void
| Encoder | () | constructor |
public function Encoder(source:String = null, target:String = null, group:String, filter:* = null)Creates a new Encoder.
Parameterssource:String (default = null) |
|
target:String (default = null) |
|
group:String — the data group to process
|
|
filter:* (default = null) |
| encode | () | method |
protected function encode(val:Object):*Computes an encoding for the input value.
Parametersval:Object — a data value to encode
|
* — the encoded visual value
|
| operate | () | method |
public override function operate(t:Transitioner = null):voidPerforms an operation over the contents of a visualization.
Parameterst:Transitioner (default = null) |
| setup | () | method |
public override function setup():voidSetup method invoked whenever this operator's visualization property is set.