Packageflare.vis.operator.filter
Classpublic class VisibilityFilter
InheritanceVisibilityFilter Inheritance Operator

Filter operator that sets item visibility based on a filtering condition. Filtering conditions are specified using Boolean-valued predicate functions that return true if the item meets the filtering criteria and false if it does not. For items which meet the criteria, this class sets the visibility property to true and the alpha value to 1. For those items that do not meet the criteria, this class sets the visibility property to false and the alpha value to 0.

Predicate functions can either be arbitrary functions that take a single argument and return a Boolean value, or can be systematically constructed using the Expression language provided by the flare.query package.

See also

flare.query


Public Properties
 PropertyDefined by
 Inheritedenabled : Boolean
Indicates if the operator is enabled or disabled.
Operator
  filter : Function
Boolean function indicating which items to process.
VisibilityFilter
  group : String
The name of the data group for which to compute the encoding.
VisibilityFilter
  immediate : Boolean = false
Immediate mode sets the visibility settings immediately, bypassing any transitioner provided.
VisibilityFilter
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
  predicate : Function
Predicate function determining item visibility.
VisibilityFilter
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
Public Methods
 MethodDefined by
  
VisibilityFilter(predicate:Function = null, group:String, filter:* = null)
Creates a new VisibilityFilter.
VisibilityFilter
 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.
VisibilityFilter
 Inherited
setup():void
Setup method invoked whenever this operator's visualization property is set.
Operator
Property detail
filterproperty
filter:Function  [read-write]

Boolean function indicating which items to process. This function does not determine which items will be visible, it only determines which items are visited by this operator. Only items for which this function return true will be considered by the VisibilityFilter. 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 
public var group:String

The name of the data group for which to compute the encoding. The default is Data.NODES.

immediateproperty 
public var immediate:Boolean = false

Immediate mode sets the visibility settings immediately, bypassing any transitioner provided.

predicateproperty 
public var predicate:Function

Predicate function determining item visibility.

Constructor detail
VisibilityFilter()constructor
public function VisibilityFilter(predicate:Function = null, group:String, filter:* = null)

Creates a new VisibilityFilter.

Parameters
predicate:Function (default = null) — the predicate function for filtering items. This should be a Boolean-valued function that returns true for items that pass the filtering criteria and false for those that do not.
 
group:String — the data group to process.
 
filter:* (default = null) — a Boolean-valued filter function that determines which items are considered by this visibility filter. Only tems that pass this filter will then have their visibility value set according to the predicate argument.
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.