| Package | flare.analytics.graph |
| Class | public class LinkDistance |
| Inheritance | LinkDistance  Operator |
ShortestPaths operator instead.
Nodes are annotated with both the computed distance and the incoming
edge in the shortest link distance path to a source node. Edges are
annotated with a Boolean value indicating whether or not the edge lies
along one of these computed shortest paths.
| Property | Defined by | ||
|---|---|---|---|
| distanceField : String The property in which to store the link distance.
| LinkDistance | ||
 | enabled : Boolean Indicates if the operator is enabled or disabled.
| Operator | |
| incomingField : String The property in which to store incoming edges along a shortest
path.
| LinkDistance | ||
| links : int The link type to consider when calculating link distance.
| LinkDistance | ||
| onpathField : String The property in which to store a path inclusion flag for edges.
| LinkDistance | ||
| parameters : Object
Sets parameter values for this operator.
| Operator | |
| sources : Array The roots of the breadth-first search.
| LinkDistance | ||
| visualization : Visualization
The visualization processed by this operator.
| Operator | |
| Method | Defined by | ||
|---|---|---|---|
|
LinkDistance(sources:Array = null)
Creates a new LinkDistance operator.
| LinkDistance | ||
|
applyParameters(op:IOperator, params:Object):void
[static]
Static method that applies parameter settings to an operator.
| Operator | |
|
Calculates link distances from a set of source nodes for for each
node in the graph.
| LinkDistance | ||
|
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
| LinkDistance | ||
|
setup():void
Setup method invoked whenever this operator's visualization
property is set.
| Operator | |
| distanceField | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdistanceField:String [read-write]The property in which to store the link distance. This property is used to annotate nodes with the minimum link distance to one of the source nodes. The default value is "props.distance".
Implementation public function get distanceField():String
public function set distanceField(value:String):void
| incomingField | property |
incomingField:String [read-write]The property in which to store incoming edges along a shortest path. This property is used to annotate nodes with the incoming along a shortest path from one of the source nodes. By following sequential incoming edges, one can recreate the shortest path from the nearest source node. The default value is "props.incoming".
Implementation public function get incomingField():String
public function set incomingField(value:String):void
| links | property |
links:int [read-write] The link type to consider when calculating link distance. Should
be one of NodeSprite.GRAPH_LINKS,
NodeSprite.IN_LINKS, or
NodeSprite.OUT_LINKS.
public function get links():int
public function set links(value:int):void
| onpathField | property |
onpathField:String [read-write] The property in which to store a path inclusion flag for edges.
This property is used to mark edges as belonging to one of the
computed shortest paths: true indicates that the edge
participates in a shortest path, false indicates that
the edge does not lie along a shortest path. The default value is
"props.onpath".
public function get onpathField():String
public function set onpathField(value:String):void
| sources | property |
public var sources:ArrayThe roots of the breadth-first search. The elements of the array should either be NodeSprite instances or integer indices into the node array.
| LinkDistance | () | constructor |
public function LinkDistance(sources:Array = null)Creates a new LinkDistance operator.
Parameterssources:Array (default = null)NodeSprite instances or integer indices into the node
array.
|
| calculate | () | method |
public function calculate(data:Data, sources:*):voidCalculates link distances from a set of source nodes for for each node in the graph. Each node in the graph will be annotated with its link distance from the nearest source node.
Parametersdata:Data — the graph to calculate distances for
|
|
sources:* — one or more source nodes from which to measure the
distance. This input can either be a single node or an array of
nodes. Nodes can be indicated as either a NodeSprite
instance or an integer index into the data.nodes
property.
|
| operate | () | method |
public override function operate(t:Transitioner = null):voidPerforms an operation over the contents of a visualization.
Parameterst:Transitioner (default = null) |