ShadeAxis (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.ShadeAxis

```
public class ShadeAxis
extends java.lang.Object
```
Graphical representation of aux shading range which can be placed near the plot.

Since:

13 Feb 2013

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor and Description
`ShadeAxis(Shader shader, Scaling scaling, double dlo, double dhi, java.lang.String label, Captioner captioner, double crowding, int rampWidth)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.swing.Icon`	`createAxisIcon(java.awt.Rectangle rampBounds)` Returns an icon containing a graphical representation of the shading axis including axis annotations (label and numbers).
`int`	`getEndPadding()` Returns a nominal number of pixels required at the top and bottom of the ramp icon to accommodated possible axis labels.
`java.awt.Insets`	`getRampInsets(java.awt.Rectangle rampBounds)` Returns the insets that the bounds icon would like to have for annotating the axis given the dimensions of the actual scale ramp graphic.
`int`	`getRampWidth()` Preferred number of pixels in the lateral direction for the axis colour ramp.

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

- Constructor Detail
  - ShadeAxis
```
public ShadeAxis(Shader shader,
                 Scaling scaling,
                 double dlo,
                 double dhi,
                 java.lang.String label,
                 Captioner captioner,
                 double crowding,
                 int rampWidth)
```
    Constructor.
    
    Parameters:
    
    shader - object performing the actual shading
    
    scaling - maps data values to unit range
    
    dlo - minimum data value
    
    dhi - maximum data value
    
    label - axis label
    
    captioner - text rendering object
    
    crowding - 1 for normal tick density, lower for fewer labels, higher for more
    
    rampWidth - preferred number of pixels in the lateral for the direction of the ramp icon; this value is not used by this class, but this class serves as a useful place to keep it
- Method Detail
  - createAxisIcon
```
@Equality
public javax.swing.Icon createAxisIcon(java.awt.Rectangle rampBounds)
```
    Returns an icon containing a graphical representation of the shading axis including axis annotations (label and numbers). The supplied rectangle gives the dimensions of the actual scale ramp, not including annotations.
    
    Parameters:
    
    rampBounds - ramp position
    
    Returns:
    
    axis icon, with equality semantics
  - getRampInsets
```
public java.awt.Insets getRampInsets(java.awt.Rectangle rampBounds)
```
    Returns the insets that the bounds icon would like to have for annotating the axis given the dimensions of the actual scale ramp graphic.
    
    Parameters:
    
    rampBounds - ramp position
    
    Returns:
    
    insets surrounding rampBounds required for annotation
  - getEndPadding
```
public int getEndPadding()
```
    Returns a nominal number of pixels required at the top and bottom of the ramp icon to accommodated possible axis labels. This is currently half the height of a digit caption.
    
    Returns:
    
    ramp icon vertical padding for labels
  - getRampWidth
```
public int getRampWidth()
```
    Preferred number of pixels in the lateral direction for the axis colour ramp. Not enforced by any behaviour of this class.
    
    Returns:
    
    preferred ramp width

Class ShadeAxis

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShadeAxis

Method Detail

createAxisIcon

getRampInsets

getEndPadding

getRampWidth