class Rubyvis::Layout::Cluster

Implements a hierarchical layout using the cluster (or dendrogram) algorithm. This layout provides both node-link and space-filling implementations of cluster diagrams. In many ways it is similar to {@link pv.Layout.Partition}, except that leaf nodes are positioned at maximum depth, and the depth of internal nodes is based on their distance from their deepest descendant, rather than their distance from the root.

<p>The cluster layout supports a “group” property, which if true causes siblings to be positioned closer together than unrelated nodes at the same depth. Unlike the partition layout, this layout does not support dynamic sizing for leaf nodes; all leaf nodes are the same size.

<p>For more details on how to use this layout, see Rubyvis::Layout::Hierarchy.

@see pv.Layout.Cluster.Fill @extends pv.Layout.Hierarchy



The group parameter; defaults to 0, disabling grouping of siblings. If this parameter is set to a positive number (or true, which is equivalent to 1), then additional space will be allotted between sibling groups. In other words, siblings (nodes that share the same parent) will be positioned more closely than nodes at the same depth that do not share a parent.

@type number


The inner radius; defaults to 0. This property applies only to radial orientations, and can be used to compress the layout radially. Note that for the node-link implementation, the root node is always at the center, regardless of the value of this property; this property only affects internal and leaf nodes. For the space-filling implementation, a non-zero value of this property will result in the root node represented as a ring rather than a circle.

@type number


Constructs a new, empty cluster layout. Layouts are not typically constructed directly; instead, they are added to an existing panel via {@link Rubyvis::Mark#add}.


The orientation. The default orientation is “top”, which means that the root node is placed on the top edge, leaf nodes appear on the bottom edge, and internal nodes are in-between. The following orientations are supported:<ul>

<li>left - left-to-right. <li>right - right-to-left. <li>top - top-to-bottom. <li>bottom - bottom-to-top. <li>radial - radially, with the root at the center.</ul>

@type string


The outer radius; defaults to fill the containing panel, based on the height and width of the layout. If the layout has no height and width specified, it will extend to fill the enclosing panel.

@type number

Public Class Methods

defaults() click to toggle source

Defaults for cluster layouts. The default group parameter is 0 and the default orientation is “top”.

@type pv.Layout.Cluster

# File lib/rubyvis/layout/cluster.rb, line 95
def self.defaults
new() click to toggle source
# File lib/rubyvis/layout/cluster.rb, line 34
def initialize
  ## @private Cache layout state to optimize properties. #/
  @link.interpolate {that.interpolate}

Public Instance Methods

build_implied(s) click to toggle source
# File lib/rubyvis/layout/cluster.rb, line 100
def build_implied(s)
cluster_build_implied(s) click to toggle source
# File lib/rubyvis/layout/cluster.rb, line 103
def cluster_build_implied(s)
  @interpolate=case s.orient
    when %r^(top|bottom)$/
    when %r^(left|right)$/
  return nil if hierarchy_build_implied(s)
  root = s.nodes[0]
  group =
  breadth =nil
  depth = nil 
  leaf_count = 0
  leaf_index = 0.5 - group / 2.0

  # Count the leaf nodes and compute the depth of descendants. #/
  par = nil
  root.visit_after {|n,i|
    #puts "#{n.node_value} #{i}"
    if (n.first_child) 
      n.depth = 1 + Rubyvis.max(n.child_nodes, lambda {|nn| nn.depth })
      if (group!=0 and (par != n.parent_node)) 
        par = n.parent_node
        leaf_count += group
      n.depth = 0
  breadth = 1.0 / leaf_count
  depth = 1.0 / root.depth

  # Compute the unit breadth and depth of each node. #/
  par = nil
  root.visit_after  {|n,i|
    if (n.first_child) 
        n.breadth = Rubyvis.mean(n.child_nodes, lambda {|nn| nn.breadth })
      if (group!=0 and (par != n.parent_node)) 
      par = n.parent_node
      leaf_index += group
      n.breadth = breadth * leaf_index
    n.depth = 1 - n.depth * depth

  # Compute breadth and depth ranges for space-filling layouts. #/
  root.visit_after {|n,i|
    n.min_breadth = n.first_child ? n.first_child.min_breadth : (n.breadth - breadth / 2.0)
    n.max_breadth = n.first_child ? n.last_child.max_breadth : (n.breadth + breadth / 2.0)
  root.visit_before {|n,i|
    n.min_depth = n.parent_node ? n.parent_node.max_depth : 0
    n.max_depth = n.parent_node ? (n.depth + root.depth) : (n.min_depth + 2 * root.depth)
  root.min_depth = -depth