li.netcat.chart.util
Interface ValueLocation

All Known Implementing Classes:

ArcValueLocation, RectValueLocation

public interface ValueLocation

Describes the location of a value on a graph. It has two main points: The lead and the trail. The lead is the effective position of the value. A line chart for example follows the leads of the series of value locations. The trail lies typically at the zero value for non stacked charts or at the lead value of the previous value location for stacked charts. Positions between lead and trail can also be retrieved. They must not necessarily lie on a straight line.

Author:

Arthur Marxer

Method Summary

float	getLeadX() Returns the x-coordinate of the lead point.
float	getLeadY() Returns the y-coordinate of the lead point.
float	getTrailX() Returns the x-coordinate of the trail point.
float	getTrailY() Returns the y-coordinate of the trail point.
float	getX(float lenghtPosition, float lenghtShift, float crossPosition, float crossShift) Returns the x-coordinate of an arbitrary point in this value location.
float	getY(float lenghtPosition, float lenghtShift, float crossPosition, float crossShift) Returns the y-coordinate of an arbitrary point in this value location.
void	move(float dx, float dy) Moves this value location by the given value.

Method Detail

getLeadX

public float getLeadX()

Returns the x-coordinate of the lead point.

Returns:

The x-coordinate of the lead point.

getLeadY

public float getLeadY()

Returns the y-coordinate of the lead point.

Returns:

The y-coordinate of the lead point.

getTrailX

public float getTrailX()

Returns the x-coordinate of the trail point.

Returns:

The x-coordinate of the trail point.

getTrailY

public float getTrailY()

Returns the y-coordinate of the trail point.

Returns:

The y-coordinate of the trail point.

getX

public float getX(float lenghtPosition,
                  float lenghtShift,
                  float crossPosition,
                  float crossShift)

Returns the x-coordinate of an arbitrary point in this value location.

Parameters:

lenghtPosition - The relative position in the length direction. 0.0 refers to the trail point, 1.0 to the lead point.

lenghtShift - The additional shift of the result position in the length direction in pixel.

crossPosition - The relative position in the crosswise direction. 0.5 refers to the middle, 0.0 and 1.0 to the borders.

crossShift - The additional shift of the result position in the crosswise direction in pixel.

getY

public float getY(float lenghtPosition,
                  float lenghtShift,
                  float crossPosition,
                  float crossShift)

Returns the y-coordinate of an arbitrary point in this value location.

Parameters:

lenghtPosition - The relative position in the length direction. 0.0 refers to the trail point, 1.0 to the lead point.

lenghtShift - The additional shift of the result position in the length direction in pixel.

crossPosition - The relative position in the crosswise direction. 0.5 refers to the middle, 0.0 and 1.0 to the borders.

crossShift - The additional shift of the result position in the crosswise direction in pixel.

move

public void move(float dx,
                 float dy)

Moves this value location by the given value.

Parameters:

dx - Movement in the x direction.

dy - Movement in the y direction.