ilog.views.chart

Interface IlvChartProjector

public interface IlvChartProjector

Defines the methods to perform the mapping between data and display coordinates. A projector is used by an IlvChart and can be retrieved with the IlvChart.getProjector() method.

Since:

JViews 5.0

Method Summary

Modifier and Type	Method and Description
double	getAxisLength(Rectangle projRect, IlvAxis axis) Returns the length of the specified axis.
Shape	getShape(double value, IlvDataInterval inter, int axisType, Rectangle projRect, IlvCoordinateSystem coordSys) Returns the shape corresponding to the specified value.
Shape	getShape(double value, int axisType, Rectangle projRect, IlvCoordinateSystem coordSys) Returns the shape corresponding to the specified value.
Shape	getShape(IlvDataWindow dataWindow, Rectangle projRect, IlvCoordinateSystem coordSys) Returns the shape corresponding to the specified data window.
void	shiftAlongAxis(Rectangle projRect, IlvAxis axis, IlvDoublePoint point, double delta) Shifts a point in projected space along a given axis.
void	toData(IlvDoublePoints pts, Rectangle projRect, IlvCoordinateSystem coordSys) Maps the specified points from display coordinates to data coordinates.
IlvDataWindow	toDataWindow(Rectangle rect, Rectangle projRect, IlvCoordinateSystem coordSys) Returns the data window enclosed by the specified bounding rectangle, expressed in projected space.
void	toDisplay(IlvDoublePoints pts, Rectangle projRect, IlvCoordinateSystem coordSys) Maps the specified points from data coordinates to display coordinates.
Rectangle	toRectangle(IlvDataWindow dataWindow, Rectangle projRect, IlvCoordinateSystem coordSys) Returns the bounding rectangle enclosing the specified data window.

Method Detail

toDisplay

void toDisplay(IlvDoublePoints pts,
               Rectangle projRect,
               IlvCoordinateSystem coordSys)

Maps the specified points from data coordinates to display coordinates.

Parameters:

pts - The considered points in data space. The method directly modifies the values stored in this object.

projRect - The projecting rectangle.

coordSys - The data coordinate system.

toData

void toData(IlvDoublePoints pts,
            Rectangle projRect,
            IlvCoordinateSystem coordSys)

Maps the specified points from display coordinates to data coordinates.

Parameters:

pts - The considered points in display space. The method directly modifies the values stored in this object.

projRect - The projecting rectangle.

coordSys - The data coordinate system.

toDataWindow

IlvDataWindow toDataWindow(Rectangle rect,
                           Rectangle projRect,
                           IlvCoordinateSystem coordSys)

Returns the data window enclosed by the specified bounding rectangle, expressed in projected space.

Parameters:

rect - The considered rectangle.

projRect - The projecting rectangle.

coordSys - The data coordinate system.

Returns:

The computed data window.

toRectangle

Rectangle toRectangle(IlvDataWindow dataWindow,
                      Rectangle projRect,
                      IlvCoordinateSystem coordSys)

Returns the bounding rectangle enclosing the specified data window. The result is that all the data points within the specified data window are projected within the returned rectangle.

Parameters:

dataWindow - The considered data window.

projRect - The projecting rectangle.

coordSys - The data coordinate system.

Returns:

The computed rectangle.

shiftAlongAxis

void shiftAlongAxis(Rectangle projRect,
                    IlvAxis axis,
                    IlvDoublePoint point,
                    double delta)

Shifts a point in projected space along a given axis.

Parameters:

projRect - The projecting rectangle.

axis - The considered axis.

point - The considered point. The method modifies the coordinates of this point.

delta - The shift applied to the point, expressed in projected space.

getAxisLength

double getAxisLength(Rectangle projRect,
                     IlvAxis axis)

Returns the length of the specified axis.

getShape

Shape getShape(IlvDataWindow dataWindow,
               Rectangle projRect,
               IlvCoordinateSystem coordSys)

Returns the shape corresponding to the specified data window. The result is that all the data points within the specified data window are projected within the returned shape.

Parameters:

dataWindow - The considered data window.

projRect - The projecting rectangle.

coordSys - The data coordinate system.

Returns:

The shape containing all the projected points of the specified data window.

getShape

Shape getShape(double value,
               int axisType,
               Rectangle projRect,
               IlvCoordinateSystem coordSys)

Returns the shape corresponding to the specified value. The result is that all the data points with the specified coordinate value are projected on the returned shape.

Parameters:

value - The considered value.

axisType - The axis type: IlvAxis.X_AXIS or IlvAxis.Y_AXIS.

projRect - The projecting rectangle.

coordSys - The data coordinate system.

getShape

Shape getShape(double value,
               IlvDataInterval inter,
               int axisType,
               Rectangle projRect,
               IlvCoordinateSystem coordSys)

Returns the shape corresponding to the specified value. The result is that all the data points within the specified interval with the specified coordinate value are projected on the returned shape.

Parameters:

value - The considered value.

inter - The values range.

axisType - The axis type: IlvAxis.X_AXIS or IlvAxis.Y_AXIS.

projRect - The projecting rectangle.

coordSys - The data coordinate system.