Packageflare.vis.operator.filter
Classpublic class GraphDistanceFilter
InheritanceGraphDistanceFilter Inheritance Operator

Filter operator that sets visible all items within a specified graph distance from a set of focus nodes.



Public Properties
 PropertyDefined by
  distance : int
Graph distance within which which items wll be visible.
GraphDistanceFilter
 Inheritedenabled : Boolean
Indicates if the operator is enabled or disabled.
Operator
  focusNodes : Array
An array of focal NodeSprites.
GraphDistanceFilter
  links : int
Flag indicating which graph links to traverse.
GraphDistanceFilter
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
Public Methods
 MethodDefined by
  
GraphDistanceFilter(focusNodes:Array = null, distance:int = 1, links:int = 3)
Creates a new GraphDistanceFilter.
GraphDistanceFilter
 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.
GraphDistanceFilter
 Inherited
setup():void
Setup method invoked whenever this operator's visualization property is set.
Operator
Property detail
distanceproperty
public var distance:int

Graph distance within which which items wll be visible.

focusNodesproperty 
public var focusNodes:Array

An array of focal NodeSprites.

linksproperty 
public var links:int

Flag indicating which graph links to traverse.

Constructor detail
GraphDistanceFilter()constructor
public function GraphDistanceFilter(focusNodes:Array = null, distance:int = 1, links:int = 3)

Creates a new GraphDistanceFilter.

Parameters
focusNodes:Array (default = null) — an array of focal NodeSprites. Graph distance is measured as the minimum number of edge-hops to one of these nodes.
 
distance:int (default = 1) — graph distance within which items will be visible
 
links:int (default = 3) — flag indicating which graph links to traverse. The default value is NodeSprite.GRAPH_LINKS.
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.