| Package | flare.vis.operator.encoder |
| Class | public class PropertyEncoder |
| Inheritance | PropertyEncoder  Operator |
For example, a PropertyEncoder created with this code:
new PropertyEncoder({size:1, lineColor:0xff0000ff{);
will set the size to 1 and the line color to blue for all
data sprites processed by the encoder.
Property values can take a number of forms, as determined by
the flare.vis.data.DataList.setProperties method:
Function, it will be evaluated
for each element and the result will be used as the property
value for that element.IEvaluable instance, such as
flare.util.Property or
flare.query.Expression, it will be evaluated for
each element and the result will be used as the property value
for that element.| Property | Defined by | ||
|---|---|---|---|
 | enabled : Boolean Indicates if the operator is enabled or disabled.
| Operator | |
| filter : Function Boolean function indicating which items to process.
| PropertyEncoder | ||
| group : String The name of the data group for which to compute the encoding.
| PropertyEncoder | ||
| ignoreTransitioner : Boolean | PropertyEncoder | ||
| parameters : Object
Sets parameter values for this operator.
| Operator | |
| values : Object The properties to set on each invocation.
| PropertyEncoder | ||
| visualization : Visualization
The visualization processed by this operator.
| Operator | |
| Property | Defined by | ||
|---|---|---|---|
| _filter : Function Boolean function indicating which items to process.
| PropertyEncoder | ||
| _group : String The name of the data group for which to compute the encoding.
| PropertyEncoder | ||
| _ignoreTrans : Boolean Flag indicating if property values should be set immediately.
| PropertyEncoder | ||
| _t : Transitioner
A transitioner for collecting value updates.
| PropertyEncoder | ||
| _values : Object The properties to set on each invocation.
| PropertyEncoder | ||
| Method | Defined by | ||
|---|---|---|---|
|
PropertyEncoder(values:Object = null, group:String, filter:Boolean = null, ignoreTransitioner:* = false)
Creates a new PropertyEncoder
| PropertyEncoder | ||
|
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.
| PropertyEncoder | ||
|
setup():void
Setup method invoked whenever this operator's visualization
property is set.
| Operator | |
| _filter | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected 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 |
protected var _group:StringThe name of the data group for which to compute the encoding.
| 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
| _ignoreTrans | property |
protected var _ignoreTrans:BooleanFlag indicating if property values should be set immediately.
| ignoreTransitioner | property |
ignoreTransitioner:Boolean [read-write]Implementation
public function get ignoreTransitioner():Boolean
public function set ignoreTransitioner(value:Boolean):void
| _t | property |
protected var _t:TransitionerA transitioner for collecting value updates.
| _values | property |
protected var _values:ObjectThe properties to set on each invocation.
| values | property |
values:Object [read-write]The properties to set on each invocation.
Implementation public function get values():Object
public function set values(value:Object):void
| PropertyEncoder | () | constructor |
public function PropertyEncoder(values:Object = null, group:String, filter:Boolean = null, ignoreTransitioner:* = false)Creates a new PropertyEncoder
Parametersvalues:Object (default = null) |
|
group:String — the data group to process
|
|
filter:Boolean (default = null) |
|
ignoreTransitioner:* (default = false) |
| operate | () | method |
public override function operate(t:Transitioner = null):voidPerforms an operation over the contents of a visualization.
Parameterst:Transitioner (default = null) |