IlvTreemapPackingAlgorithm (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.renderer.IlvTreemapPackingAlgorithm

```
public abstract class IlvTreemapPackingAlgorithm
extends Object
```
This class describes how to arrange rectangles in a treemap. It is the base class of all concrete treemap packing algorithms.

Since:

JViews 7.5

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`IlvTreemapPackingAlgorithm(IlvTreemapChartRenderer renderer)` Creates a packing algorithm, suitable for the given renderer with its current settings.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`arrangeChildren(Object node, IlvTreemapAreaObject areaObject, double xmin, double xmax, double ymin, double ymax)` Arranges the rectangles belonging to the children of the given node.
`double`	`getArea(Object node)` Returns the area that should be assigned to the given tree node.
`IlvTreemapAreaObject`	`getAreaObject(Object node)` Returns an object holding the area that should be assigned to the given tree node.
`double`	`getAspectRatio()` Returns the aspect ratio of the screen rectangle into which our [0,1]x[0,1] rectangle is mapped.
`int`	`getLevel()` Returns the current recursion level.
`double`	`getMarginReductionFactor()` Returns the margin reduction factor.
`double`	`getMaxBottomMarginProportion()` Returns the maximum bottom margin, as a proportion of `getPlotRectHeight()`.
`double`	`getMaxLeftMarginProportion()` Returns the maximum left margin, as a proportion of `getPlotRectWidth()`.
`double`	`getMaxRightMarginProportion()` Returns the maximum right margin, as a proportion of `getPlotRectWidth()`.
`double`	`getMaxTopMarginProportion()` Returns the maximum top margin, as a proportion of `getPlotRectHeight()`.
`IlvTreeListModel`	`getModel()` Returns the tree model containing the objects being represented.
`int`	`getPlotRectHeight()` Returns the height of the screen rectangle into which our [0,1]x[0,1] rectangle is mapped.
`int`	`getPlotRectWidth()` Returns the width of the screen rectangle into which our [0,1]x[0,1] rectangle is mapped.
`IlvTreemapChartRenderer`	`getRenderer()` Returns the renderer that uses this packing.
`void`	`setGeometry(Object node, double xmin, double xmax, double ymin, double ymax)` Assigns a given extent to the rectangle corresponding to the given tree node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvTreemapPackingAlgorithm
```
protected IlvTreemapPackingAlgorithm(IlvTreemapChartRenderer renderer)
```
    Creates a packing algorithm, suitable for the given renderer with its current settings.
- Method Detail
  - getRenderer
```
public final IlvTreemapChartRenderer getRenderer()
```
    Returns the renderer that uses this packing.
  - getModel
```
public final IlvTreeListModel getModel()
```
    Returns the tree model containing the objects being represented.
  - getMarginReductionFactor
```
public final double getMarginReductionFactor()
```
    Returns the margin reduction factor. It describes the margin proportions of a nested rectangle, compared to the margin proportions of the rectangle that contains it.
  - getPlotRectWidth
```
public final int getPlotRectWidth()
```
    Returns the width of the screen rectangle into which our [0,1]x[0,1] rectangle is mapped.
  - getPlotRectHeight
```
public final int getPlotRectHeight()
```
    Returns the height of the screen rectangle into which our [0,1]x[0,1] rectangle is mapped.
  - getAspectRatio
```
public final double getAspectRatio()
```
    Returns the aspect ratio of the screen rectangle into which our [0,1]x[0,1] rectangle is mapped.
  - getMaxLeftMarginProportion
```
public final double getMaxLeftMarginProportion()
```
    Returns the maximum left margin, as a proportion of getPlotRectWidth().
  - getMaxRightMarginProportion
```
public final double getMaxRightMarginProportion()
```
    Returns the maximum right margin, as a proportion of getPlotRectWidth().
  - getMaxBottomMarginProportion
```
public final double getMaxBottomMarginProportion()
```
    Returns the maximum bottom margin, as a proportion of getPlotRectHeight().
  - getMaxTopMarginProportion
```
public final double getMaxTopMarginProportion()
```
    Returns the maximum top margin, as a proportion of getPlotRectHeight().
  - getLevel
```
public int getLevel()
```
    Returns the current recursion level. It is 0 when the root node is being handled.
    This method should only be called during arrangeChildren(java.lang.Object, ilog.views.chart.renderer.IlvTreemapAreaObject, double, double, double, double).
  - getAreaObject
```
public final IlvTreemapAreaObject getAreaObject(Object node)
```
    Returns an object holding the area that should be assigned to the given tree node.
    
    Parameters:
    
    node - A tree node.
  - getArea
```
public final double getArea(Object node)
```
    Returns the area that should be assigned to the given tree node.
    This is the same as getAreaObject(node).getTotalArea().
    This value is the result of accumulating the area column values for the given node and its entire subtree. It needs to be scaled before it can be used to represent a rectangle area.
    
    Parameters:
    
    node - A tree node.
  - setGeometry
```
public void setGeometry(Object node,
                        double xmin,
                        double xmax,
                        double ymin,
                        double ymax)
```
    Assigns a given extent to the rectangle corresponding to the given tree node.
    This method stores the extent for the rectangle and then distributes a sub-rectangle, computed from the given rectangle by applying some margins, among the children of the given node, through a call to arrangeChildren(java.lang.Object, ilog.views.chart.renderer.IlvTreemapAreaObject, double, double, double, double).
    
    Parameters:
    
    node - A tree node.
    
    xmin - Left bound of the space to use for the node and its subtree.
    
    xmax - Right bound of the space to use for the node and its subtree.
    
    ymin - Bottom(!) bound of the space to use for the node and its subtree.
    
    ymax - Top(!) bound of the space to use for the node and its subtree.
  - arrangeChildren
```
public abstract void arrangeChildren(Object node,
                                     IlvTreemapAreaObject areaObject,
                                     double xmin,
                                     double xmax,
                                     double ymin,
                                     double ymax)
```
    Arranges the rectangles belonging to the children of the given node. This method must subdivide the space given by [xmin,xmax] x [ymin,ymax] among the children of the given node and invoke setGeometry(java.lang.Object, double, double, double, double) exactly once for each child object, in any order.
    
    Parameters:
    
    node - A tree node.
    
    areaObject - Information about the area that should be assigned to the tree node.
    
    xmin - Left bound of the space to use for the children objects.
    
    xmax - Right bound of the space to use for the children objects.
    
    ymin - Bottom(!) bound of the space to use for the children objects.
    
    ymax - Top(!) bound of the space to use for the children objects.

Class IlvTreemapPackingAlgorithm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvTreemapPackingAlgorithm

Method Detail

getRenderer

getModel

getMarginReductionFactor

getPlotRectWidth

getPlotRectHeight

getAspectRatio

getMaxLeftMarginProportion

getMaxRightMarginProportion

getMaxBottomMarginProportion

getMaxTopMarginProportion

getLevel

getAreaObject

getArea

setGeometry

arrangeChildren