Packageflare.vis.operator
Classpublic class SortOperator
InheritanceSortOperator Inheritance Operator

A SortOperator sorts a data group. This can be used to sort elements prior to running a subsequent operation such as layout.

See also

flare.util.Sort


Public Properties
 PropertyDefined by
  criteria : Array
The sorting criteria.
SortOperator
 Inheritedenabled : Boolean
Indicates if the operator is enabled or disabled.
Operator
  group : String
The data group to sort.
SortOperator
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
Public Methods
 MethodDefined by
  
SortOperator(criteria:Array, group:String)
Creates a new SortOperator.
SortOperator
 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.
SortOperator
 Inherited
setup():void
Setup method invoked whenever this operator's visualization property is set.
Operator
Property detail
criteriaproperty
criteria:Array  [read-write]

The sorting criteria. Sort criteria are expressed as an array of property names to sort on. These properties are accessed by sorting functions using the Property class. The default is to sort in ascending order. If the field name includes a "-" (negative sign) prefix, that variable will instead be sorted in descending order.

Implementation
    public function get criteria():Array
    public function set criteria(value:Array):void
groupproperty 
public var group:String

The data group to sort.

Constructor detail
SortOperator()constructor
public function SortOperator(criteria:Array, group:String)

Creates a new SortOperator.

Parameters
criteria:Array — the sorting criteria. Sort criteria are expressed as an array of property names to sort on. These properties are accessed by sorting functions using the Property class. The default is to sort in ascending order. If the field name includes a "-" (negative sign) prefix, that variable will instead be sorted in descending order.
 
group:String — the data group to sort
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.