Packageflare.vis.operator.layout
Classpublic class DendrogramLayout
InheritanceDendrogramLayout Inheritance Layout Inheritance Operator

Layout that places items in a dendrogram for displaying the results of hierarchical clustering. This class computes a dendrogram layout and sets edge control points to create "U" shaped dendrogram branches. It is common, though by no means required, to hide the node instances in a dendrogram display.

To determine the height of dendrogram branches, a distance property can be provided. The values of this property will directly determine node heights by laying out the depth axis using a linear scale of distance values. The distance property should be set for all non-leaf nodes in the tree. Typically, leaf nodes have a distance of zero, resulting in an aligned list of leaf nodes.



Public Properties
 PropertyDefined by
  distanceProperty : String
Data property to use as the distance field for determining the height values of dendrogram branches.
DendrogramLayout
 Inheritedenabled : Boolean
Indicates if the operator is enabled or disabled.
Operator
 InheritedlayoutAnchor : Point
The layout anchor, used by some layout instances to place an initial item or determine a focal point.
Layout
 InheritedlayoutBounds : Rectangle
The layout bounds for the layout.
Layout
 InheritedlayoutRoot : DataSprite
The layout root, the root node for tree layouts.
Layout
 InheritedlayoutType : String = "null"
The type of layout and axes.
Layout
  orientation : String
The orientation of the dendrogram
DendrogramLayout
 Inheritedparameters : Object
Sets parameter values for this operator.
Operator
 Inheritedvisualization : Visualization
The visualization processed by this operator.
Operator
Protected Properties
 PropertyDefined by
 Inherited_anchor : Point
Layout
 Inherited_setAnchor : Boolean = false
Layout
 Inherited_t : Transitioner = null
A transitioner for storing value updates.
Layout
 InheritedxyAxes : CartesianAxes
Returns the visualization's axes as a CartesianAxes instance.
Layout
Public Methods
 MethodDefined by
  
DendrogramLayout(distField:String = null, orientation:String)
Creates a new DendrogramLayout.
DendrogramLayout
 Inherited
applyParameters(op:IOperator, params:Object):void
[static] Static method that applies parameter settings to an operator.
Operator
 Inherited
Strips all EdgeSprites in a visualization of any control points.
Layout
 Inherited
Hides the axes.
Layout
 Inherited
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
Layout
 Inherited
setup():void
Setup method invoked whenever this operator's visualization property is set.
Operator
 Inherited
Reveals the axes.
Layout
 Inherited
[static] Updates all edges to be straight lines.
Layout
Protected Methods
 MethodDefined by
 Inherited
autoAnchor():void
Automatically-generate an anchor point.
Layout
  
layout():void
Calculates the spatial layout of visualized items.
DendrogramLayout
 Inherited
minAngle(a1:Number, a2:Number):Number
Returns an angle value that minimizes the angular distance between a reference angle and a target angle.
Layout
Public Constants
 ConstantDefined by
 InheritedCARTESIAN : String = "cartesian"
[static] Constant indicating Cartesian (x, y) coordinates.
Layout
 InheritedPOLAR : String = "polar"
[static] Constant indicating polar (radius, angle) coordinates.
Layout
Property detail
distancePropertyproperty
distanceProperty:String  [read-write]

Data property to use as the distance field for determining the height values of dendrogram branches.

Implementation
    public function get distanceProperty():String
    public function set distanceProperty(value:String):void
orientationproperty 
orientation:String  [read-write]

The orientation of the dendrogram

Implementation
    public function get orientation():String
    public function set orientation(value:String):void
Constructor detail
DendrogramLayout()constructor
public function DendrogramLayout(distField:String = null, orientation:String)

Creates a new DendrogramLayout.

Parameters
distField:String (default = null) — data property to use as the distance field for determining the height values of dendrogram branches
 
orientation:String — the orientation of the dendrogram
Method detail
layout()method
protected override function layout():void

Calculates the spatial layout of visualized items. Layout operators override this method with their layout implementations.