The Dendrogrammer Code Documentation

dendrogrammer Dendrogrammer version 1.0.3

The Dendrogrammer > dendrogrammer > Group

Class Group

A group contains a list of leaf nodes (such leaf nodes sharing a common ancestor). Groups are collected in a GroupList.

Important attributes:
A group has attributes topBound and bottomBound which are the yPos of the topmost (nearest the origin) and bottommost (furthest from the origin) leaves in the group. These are used in drawing the group bands.

Constructor

Group


                                    (
  
                                        
                                                
                                                leafListIn

                                                , 
                                                ancestorNodeIn
                                    )

Parameters:: leafListIn <Array of ClusterNode objects> an array of leaf nodes; ancestorNodeIn <ClusterNode> the node which is the ancestor of all the other nodes in the list

Methods

getFirst


                                        
                                        
                                        
                                        ClusterNode object
                                            getFirst
                                           (
                                            )

Returns the first item. (A group will never be empty)

Returns: ClusterNode object: a leaf node

getLast


                                        
                                        
                                        
                                        ClusterNode object
                                            getLast
                                           (
                                            )

Return the last item. (A group will never be empty)

Returns: ClusterNode object: a leaf node

Modules

dendrogrammer

Classes

Files

dendrogrammer.js