| Package | flare.analytics.graph |
| Class | public class SpanningTree |
| Inheritance | SpanningTree TreeBuilder |
| Implements | IOperator |
This class can annotate graph edges as belonging to the spanning tree
(done if the annotateEdges property is true), and can
construct a Tree instance (done if the
buildTree property is true). Generated Tree
instances are stored in the tree property. Generated trees
contain the original nodes and edges in the input graph, and any
previous parent or child links for input nodes will be cleared and
overwritten.
This class extends the TreeBuilder class to also function as an operator that can be added to a visualization's operator list.
| Property | Defined by | ||
|---|---|---|---|
![]() | annotateEdges : Boolean Flag indicating if edges in the spanning tree should be annotated.
| TreeBuilder | |
![]() | buildTree : Boolean Flag indicating if a spanning tree instance should be created.
| TreeBuilder | |
![]() | edgeWeight : Function A function determining edge weights used in the spanning tree
calculation.
| TreeBuilder | |
| enabled : Boolean Indicates if the operator is enabled or disabled.
| SpanningTree | ||
![]() | links : int The link type to consider when constructing a spanning tree.
| TreeBuilder | |
| parameters : Object [write-only]
Sets parameter values for this operator.
| SpanningTree | ||
![]() | policy : String The traveral policy used to generate the spanning tree.
| TreeBuilder | |
![]() | root : NodeSprite
The root node for the spanning tree.
| TreeBuilder | |
![]() | spanningField : String The property with which to annotate edges that make up the spanning
tree.
| TreeBuilder | |
![]() | tree : Tree
The tree created by this operator.
| TreeBuilder | |
| visualization : Visualization
The visualization processed by this operator.
| SpanningTree | ||
| Method | Defined by | ||
|---|---|---|---|
|
SpanningTree(policy:String = null, buildTree:Boolean = false, annotateEdges:Boolean = true, root:NodeSprite = null, edgeWeight:* = null)
Creates a new SpanningTree operator
| SpanningTree | ||
![]() |
Calculates the spanning tree.
| TreeBuilder | |
|
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
| SpanningTree | ||
|
setup():void
Setup method invoked whenever this operator's visualization
property is set.
| SpanningTree | ||
| enabled | property |
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
| parameters | property |
parameters:Object [write-only]Sets parameter values for this operator.
Implementation public function set parameters(value:Object):void
| visualization | property |
visualization:Visualization [read-write]The visualization processed by this operator.
Implementation public function get visualization():Visualization
public function set visualization(value:Visualization):void
| SpanningTree | () | constructor |
public function SpanningTree(policy:String = null, buildTree:Boolean = false, annotateEdges:Boolean = true, root:NodeSprite = null, edgeWeight:* = null)Creates a new SpanningTree operator
Parameterspolicy:String (default = null) — the spanning tree creation policy. The default is
SpanningTree.MINIMUM_SPAN
|
|
buildTree:Boolean (default = false) — if true, this operator will build a new
Tree instance containing the spanning tree
|
|
annotateEdges:Boolean (default = true) — if true, this operator will annotate the
edges of the original graph as belonging to the spanning tree
|
|
root:NodeSprite (default = null) — the root node from which to compute the spanning tree
|
|
edgeWeight:* (default = null) — the edge weight values. This can either be a
Function that returns weight values or a
String providing the name of a property to look up on
EdgeSprite instances.
|
| operate | () | method |
public function operate(t:Transitioner = null):voidPerforms an operation over the contents of a visualization.
Parameterst:Transitioner (default = null) — a Transitioner instance for collecting value updates.
|
| setup | () | method |
public function setup():voidSetup method invoked whenever this operator's visualization property is set.