FloatingCoordAuxReader (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.layer.FloatingCoordAuxReader

All Implemented Interfaces:

AuxReader
```
public class FloatingCoordAuxReader
extends java.lang.Object
implements AuxReader
```
AuxReader implementation that extends ranges simply by sampling a given scalar floating coordinate for all plottable points.

Since:

16 Jan 2015

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor	Description
`FloatingCoordAuxReader(FloatingCoord coord, int icol, DataGeom geom, boolean visibleOnly)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`adjustAuxRange(Surface surface, DataSpec dataSpec, DataStore dataStore, java.lang.Object[] plans, Range range)`	May use the supplied data specification to update (usually extend) the given range.
`uk.ac.starlink.table.ValueInfo`	`getAxisInfo(DataSpec dataSpec)`	Attempts to provide information suitable for labelling the axis corresponding to the values ranged by this reader.
`int`	`getCoordIndex()`	Returns the DataSpec index for the coordinate whose value is used by this reader.

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

- Constructor Detail
  - FloatingCoordAuxReader
```
public FloatingCoordAuxReader(FloatingCoord coord,
                              int icol,
                              DataGeom geom,
                              boolean visibleOnly)
```
    Constructor.
    
    Parameters:
    
    coord - coordinate reader
    
    icol - column index in tuple sequence corresponding to value
    
    geom - converts data to graphics coordinates
    
    visibleOnly - true to include only points visible in the current plot bounds, false for all potentially plottable points
- Method Detail
  - getCoordIndex
```
public int getCoordIndex()
```
    Description copied from interface: AuxReader
    
    Returns the DataSpec index for the coordinate whose value is used by this reader. This is provided on a best-efforts basis; if no single coordinate fits this description, then -1 may be returned.
    
    Specified by:
    
    getCoordIndex in interface AuxReader
    
    Returns:
    
    DataSpec coord index for auxiliary coordinate being ranged, or -1
  - getAxisInfo
```
public uk.ac.starlink.table.ValueInfo getAxisInfo(DataSpec dataSpec)
```
    Description copied from interface: AuxReader
    
    Attempts to provide information suitable for labelling the axis corresponding to the values ranged by this reader.
    
    Specified by:
    
    getAxisInfo in interface AuxReader
    
    Parameters:
    
    dataSpec - data specification
    
    Returns:
    
    info corresponding to this reader's scale, or null if none known
  - adjustAuxRange
```
public void adjustAuxRange(Surface surface,
                           DataSpec dataSpec,
                           DataStore dataStore,
                           java.lang.Object[] plans,
                           Range range)
```
    Description copied from interface: AuxReader
    
    May use the supplied data specification to update (usually extend) the given range. If available an array of plan objects may be supplied as well. The implementation may be able to make use of these to improve efficiency of the ranging (perhaps to avoid a data scan).
    
    Specified by:
    
    adjustAuxRange in interface AuxReader
    
    Parameters:
    
    surface - plot data destination surface
    
    dataSpec - specification for data
    
    dataStore - data storage object
    
    plans - array of available plan objects; may be empty
    
    range - range object to be updated with range information

Class FloatingCoordAuxReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FloatingCoordAuxReader

Method Detail

getCoordIndex

getAxisInfo

adjustAuxRange