ilog.views.chart

Interface IlvChartDataPicker

All Known Implementing Classes:

IlvChartDataInteractor.DataPicker, IlvDefaultChartDataPicker

public interface IlvChartDataPicker

Defines the methods to perform a picking operation on a set of projected data points. This interface provides the information needed to search for a data point whose projected coordinates are closest to a picking point.

Since:

JViews 5.0

See Also:

IlvChart.getNearestPoint(ilog.views.chart.IlvChartDataPicker), IlvChart.getDisplayItem(ilog.views.chart.IlvChartDataPicker)

Method Summary

Modifier and Type	Method and Description
boolean	accept(IlvChartRenderer renderer) Tells whether the specified renderer must be considered, when searching among several renderers.
double	computeDistance(double x1, double y1, double x2, double y2) Returns the distance between two points.
int	getPickDistance() Returns the picking distance.
int	getPickX() Returns the x-coordinate of the picking point.
int	getPickY() Returns the y-coordinate of the picking point.
boolean	useDataSpace() Tells whether the picker computes the distance in data space.

Method Detail

getPickX

int getPickX()

Returns the x-coordinate of the picking point. This coordinate is expressed in projected space.

getPickY

int getPickY()

Returns the y-coordinate of the picking point. This coordinate is expressed in projected space.

getPickDistance

int getPickDistance()

Returns the picking distance. This distance specifies the maximum distance from the picking point beyond which data points are not considered.

Note: This distance influences the IlvChartRenderer.getNearestPoint(IlvChartDataPicker), IlvChartRenderer.getNearestItem(IlvChartDataPicker, double[]), IlvTreemapChartRenderer.getNearestPoint(IlvChartDataPicker), IlvTreemapChartRenderer.getNearestItem(IlvChartDataPicker, double[]) methods but not the IlvChartRenderer.getDisplayItem(IlvChartDataPicker) and IlvTreemapChartRenderer.getDisplayItem(IlvChartDataPicker) methods.

This distance is expressed in projected space.

accept

boolean accept(IlvChartRenderer renderer)

Tells whether the specified renderer must be considered, when searching among several renderers.

useDataSpace

boolean useDataSpace()

Tells whether the picker computes the distance in data space. Using data space instead of projected space allows to compute a distance independently of the projection used. One useful example for this is when you want to express the fact that only the difference between the x-values of the data is meaningful.

See Also:

computeDistance(double, double, double, double)

computeDistance

double computeDistance(double x1,
                       double y1,
                       double x2,
                       double y2)

Returns the distance between two points. If useDataSpace() returns true, the specified coordinates are expressed in data space. In that case, x1 and y1 are the coordinates of the picking point in data space. If useDataSpace() returns false, the specified coordinates are expressed in projected space.