Packageflare.vis.operator
Classpublic class OperatorList
InheritanceOperatorList Inheritance flash.utils.Proxy
ImplementsIOperator
SubclassesOperatorSequence, OperatorSwitch

An OperatorList maintains a sequential chain of operators that are invoked one after the other. Operators can be added to an OperatorList using the add method. Once added, operators can be retrieved and set using their index in the lists, either with array notation ([]) or with the getOperatorAt and setOperatorAt methods.



Public Properties
 PropertyDefined by
  enabled : Boolean
Indicates if the operator is enabled or disabled.
OperatorList
  first : Object
[read-only] Returns the first operator in the list.
OperatorList
  last : Object
[read-only] Returns the last operator in the list.
OperatorList
  length : uint
[read-only] The number of operators in the list.
OperatorList
  list : Array
[write-only] An array of the operators contained in the operator list.
OperatorList
  parameters : Object
[write-only] Sets parameter values for this operator.
OperatorList
  visualization : Visualization
The visualization processed by this operator.
OperatorList
Protected Properties
 PropertyDefined by
  _enabled : Boolean = true
OperatorList
  _list : Array
OperatorList
  _vis : Visualization
OperatorList
Public Methods
 MethodDefined by
  
OperatorList(... ops)
Creates a new OperatorList.
OperatorList
  
add(op:IOperator):void
Adds an operator to the end of this list.
OperatorList
  
clear():void
Removes all operators from this list.
OperatorList
  
Returns the operator at the specified position in the list
OperatorList
  
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
OperatorList
  
remove(op:IOperator):Boolean
Removes an operator from this list.
OperatorList
  
Removes the operator at the specified position in the list
OperatorList
  
Set the operator at the specified position in the list
OperatorList
  
setup():void
Setup method invoked whenever this operator's visualization property is set.
OperatorList
Protected Methods
 MethodDefined by
  
getProperty(name:*):*
Proxy method for retrieving operators from the internal array.
OperatorList
  
setProperty(name:*, value:*):void
Proxy method for setting operators in the internal array.
OperatorList
Property detail
_enabledproperty
protected var _enabled:Boolean = true
enabledproperty 
enabled:Boolean  [read-write]

Indicates if the operator is enabled or disabled.

Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
firstproperty 
first:Object  [read-only]

Returns the first operator in the list.

Implementation
    public function get first():Object
lastproperty 
last:Object  [read-only]

Returns the last operator in the list.

Implementation
    public function get last():Object
lengthproperty 
length:uint  [read-only]

The number of operators in the list.

Implementation
    public function get length():uint
_listproperty 
protected var _list:Array
listproperty 
list:Array  [write-only]

An array of the operators contained in the operator list.

Implementation
    public function set list(value:Array):void
parametersproperty 
parameters:Object  [write-only]

Sets parameter values for this operator.

Implementation
    public function set parameters(value:Object):void
_visproperty 
protected var _vis:Visualization
visualizationproperty 
visualization:Visualization  [read-write]

The visualization processed by this operator.

Implementation
    public function get visualization():Visualization
    public function set visualization(value:Visualization):void
Constructor detail
OperatorList()constructor
public function OperatorList(... ops)

Creates a new OperatorList.

Parameters
... ops — an ordered set of operators to include in the list.
Method detail
add()method
public function add(op:IOperator):void

Adds an operator to the end of this list.

Parameters
op:IOperator — the operator to add
clear()method 
public function clear():void

Removes all operators from this list.

getOperatorAt()method 
public function getOperatorAt(i:uint):IOperator

Returns the operator at the specified position in the list

Parameters
i:uint — the index into the operator list

Returns
IOperator — the requested operator
getProperty()method 
flash_proxy override function getProperty(name:*):*

Proxy method for retrieving operators from the internal array.

Parameters
name:*

Returns
*
operate()method 
public 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.
remove()method 
public function remove(op:IOperator):Boolean

Removes an operator from this list.

Parameters
op:IOperator — the operator to remove

Returns
Boolean — true if the operator was found and removed, false otherwise
removeOperatorAt()method 
public function removeOperatorAt(i:uint):IOperator

Removes the operator at the specified position in the list

Parameters
i:uint — the index into the operator list

Returns
IOperator — the removed operator
setOperatorAt()method 
public function setOperatorAt(i:uint, op:IOperator):IOperator

Set the operator at the specified position in the list

Parameters
i:uint — the index into the operator list
 
op:IOperator — the operator to place in the list

Returns
IOperator — the operator previously at the index
setProperty()method 
flash_proxy override function setProperty(name:*, value:*):void

Proxy method for setting operators in the internal array.

Parameters
name:*
 
value:*
setup()method 
public function setup():void

Setup method invoked whenever this operator's visualization property is set.