Packageflare.vis.operator.encoder
Classpublic class PropertyEncoder
InheritancePropertyEncoder Inheritance Operator

Encodes property values for a collection of visual items. A property encoder simply sets a group of properties to static values for all data sprites. An input object determines which properties to set and what their values are.

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:



Public Properties
 PropertyDefined by
 Inheritedenabled : 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
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
  values : Object
The properties to set on each invocation.
PropertyEncoder
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
Protected Properties
 PropertyDefined 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
Public Methods
 MethodDefined by
  
PropertyEncoder(values:Object = null, group:String, filter:Boolean = null, ignoreTransitioner:* = false)
Creates a new PropertyEncoder
PropertyEncoder
 Inherited
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
 Inherited
setup():void
Setup method invoked whenever this operator's visualization property is set.
Operator
Property detail
_filterproperty
protected var _filter:Function

Boolean function indicating which items to process.

filterproperty 
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

_groupproperty 
protected var _group:String

The name of the data group for which to compute the encoding.

groupproperty 
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
_ignoreTransproperty 
protected var _ignoreTrans:Boolean

Flag indicating if property values should be set immediately.

ignoreTransitionerproperty 
ignoreTransitioner:Boolean  [read-write]Implementation
    public function get ignoreTransitioner():Boolean
    public function set ignoreTransitioner(value:Boolean):void
_tproperty 
protected var _t:Transitioner

A transitioner for collecting value updates.

_valuesproperty 
protected var _values:Object

The properties to set on each invocation.

valuesproperty 
values:Object  [read-write]

The properties to set on each invocation.

Implementation
    public function get values():Object
    public function set values(value:Object):void
Constructor detail
PropertyEncoder()constructor
public function PropertyEncoder(values:Object = null, group:String, filter:Boolean = null, ignoreTransitioner:* = false)

Creates a new PropertyEncoder

Parameters
values:Object (default = null) — The properties to set on each invocation. The input should be an object with a set of name/value pairs.
 
group:String — the data group to process
 
filter:Boolean (default = null) — a Boolean-valued function that takes a DataSprite as input and returns true if the sprite should be processed
 
ignoreTransitioner:* (default = false) — Flag indicating if values should be set immediately rather than being processed by any transitioners
Method detail
operate()method
public override function operate(t:Transitioner = null):void

Performs an operation over the contents of a visualization.

Parameters
t:Transitioner (default = null) — a Transitioner instance for collecting value updates.