de.erichseifert.gral.plots.points

Interface PointRenderer

All Known Implementing Classes:

AbstractPointRenderer, BarPlot.BarRenderer, BoxPlot.BoxWhiskerRenderer, DefaultPointRenderer2D, LabelPointRenderer, PiePlot.PieSliceRenderer, SizeablePointRenderer

public interface PointRenderer

An interface providing functions for rendering points in a plot. It defines methods for:

• Retrieving the point of a certain row in a DataTable
• Getting and setting the points color
• Getting and setting the bounds of the points

Method Summary

Modifier and Type	Method and Description
ColorMapper	getColor() Returns a mapping that is used to fill the point shapes.
ColorMapper	getErrorColor() Returns the mapping that is used to fill the error indicators.
int	getErrorColumnBottom() Returns the index of the column that contains the lower error value.
int	getErrorColumnTop() Returns the index of the column that contains the upper error value.
java.awt.Shape	getErrorShape() Returns the shape which is used to draw the error indicators.
java.awt.Stroke	getErrorStroke() Returns the stroke which is used to draw the error indicators.
Drawable	getPoint(PointData data, java.awt.Shape shape) Returns the graphical representation to be drawn for the specified data value.
java.awt.Shape	getPointShape(PointData data) Returns a Shape instance that can be used for further calculations.
java.awt.Shape	getShape() Returns the shape which is used to draw the point.
Drawable	getValue(PointData data, java.awt.Shape shape) Returns a graphical representation of the value label to be drawn for the specified data value.
double	getValueAlignmentX() Returns the relative horizontal position of the value.
double	getValueAlignmentY() Returns the relative vertical position of the value.
ColorMapper	getValueColor() Returns the mapping that is used to fill the value.
int	getValueColumn() Returns the index of the column that contains the displayed values.
double	getValueDistance() Returns the current distance of values to the point.
java.awt.Font	getValueFont() Returns the font that is used to render the value.
java.text.Format	getValueFormat() Returns the format that is used to render the displayed data values.
Location	getValueLocation() Returns the current positioning of the data value relative to the data point.
double	getValueRotation() Returns the current rotation angle of the value.
boolean	isErrorVisible() Returns whether the error value is displayed.
boolean	isValueVisible() Returns whether the data value of a point is displayed or not.
void	setColor(ColorMapper color) Sets the mapping that will be used to fill the point shapes.
void	setColor(java.awt.Paint color) Sets the paint that will be used to fill the point shapes.
void	setErrorColor(ColorMapper color) Sets the mapping that will be used to fill the error indicators.
void	setErrorColor(java.awt.Paint color) Sets the paint that will be used to fill the error indicators.
void	setErrorColumnBottom(int columnIndex) Sets the index of the column that contains the lower error value.
void	setErrorColumnTop(int columnIndex) Sets the index of the column that contains the upper error value.
void	setErrorShape(java.awt.Shape shape) Sets the shape which will be used to draw the error indicators.
void	setErrorStroke(java.awt.Stroke stroke) Sets the stroke which will be used to draw the error indicators.
void	setErrorVisible(boolean errorVisible) Sets whether the error value will be displayed.
void	setShape(java.awt.Shape shape) Sets the shape which will be used to draw the point.
void	setValueAlignmentX(double alignmentX) Sets the relative horizontal position of the value.
void	setValueAlignmentY(double alignmentX) Sets the relative vertical position of the value.
void	setValueColor(ColorMapper color) Sets the mapping that will be used to fill the value.
void	setValueColor(java.awt.Paint color) Sets the paint that will be used to fill the value.
void	setValueColumn(int columnIndex) Sets the index of the column that contains the displayed values.
void	setValueDistance(double distance) Sets the distance of values to the point.
void	setValueFont(java.awt.Font font) Sets the font that will be used to render the value.
void	setValueFormat(java.text.Format format) Sets the format that will be used to render the displayed data values.
void	setValueLocation(Location location) Sets the positioning of the data value relative to the data point.
void	setValueRotation(double angle) Sets the rotation angle of the value.
void	setValueVisible(boolean valueVisible) Returns whether the data value of a point will be displayed or not.

Method Detail

getShape

java.awt.Shape getShape()

Returns the shape which is used to draw the point.

Returns:

Shape instance for the point.

setShape

void setShape(java.awt.Shape shape)

Sets the shape which will be used to draw the point.

Parameters:

shape - Shape instance for the point.

getColor

ColorMapper getColor()

Returns a mapping that is used to fill the point shapes.

Returns:

ColorMapper that is used to fill the point shapes.

setColor

void setColor(ColorMapper color)

Sets the mapping that will be used to fill the point shapes.

Parameters:

color - ColorMapper instance to fill the point shapes.

setColor

void setColor(java.awt.Paint color)

Sets the paint that will be used to fill the point shapes.

Parameters:

color - Paint instance to fill the point shapes.

isValueVisible

boolean isValueVisible()

Returns whether the data value of a point is displayed or not.

Returns:

true when the value is displayed, otherwise false.

setValueVisible

void setValueVisible(boolean valueVisible)

Returns whether the data value of a point will be displayed or not.

Parameters:

valueVisible - true if the value should be displayed, otherwise false.

getValueColumn

int getValueColumn()

Returns the index of the column that contains the displayed values.

Returns:

Index of the column that contains the displayed values.

setValueColumn

void setValueColumn(int columnIndex)

Sets the index of the column that contains the displayed values.

Parameters:

columnIndex - Index of the column that contains the displayed values.

getValueFormat

java.text.Format getValueFormat()

Returns the format that is used to render the displayed data values.

Returns:

Format instance that is used to render the displayed data values.

setValueFormat

void setValueFormat(java.text.Format format)

Sets the format that will be used to render the displayed data values.

Parameters:

format - Format instance that will be used to render the displayed data values.

getValueLocation

Location getValueLocation()

Returns the current positioning of the data value relative to the data point.

Returns:

Current positioning of the data value relative to the data point.

setValueLocation

void setValueLocation(Location location)

Sets the positioning of the data value relative to the data point.

Parameters:

location - Positioning of the data value relative to the data point.

getValueAlignmentX

double getValueAlignmentX()

Returns the relative horizontal position of the value. The position will be between 0 and 1.

Returns:

Relative horizontal position of the value.

setValueAlignmentX

void setValueAlignmentX(double alignmentX)

Sets the relative horizontal position of the value. The position can be specified between 0 and 1.

Parameters:

alignmentX - Relative horizontal position of the value.

getValueAlignmentY

double getValueAlignmentY()

Returns the relative vertical position of the value. The position will be between 0 and 1.

Returns:

Relative vertical position of the value.

setValueAlignmentY

void setValueAlignmentY(double alignmentX)

Sets the relative vertical position of the value. The position can be specified between 0 and 1.

Parameters:

alignmentX - Relative vertical position of the value.

getValueRotation

double getValueRotation()

Returns the current rotation angle of the value.

Returns:

Rotation angle in degrees.

setValueRotation

void setValueRotation(double angle)

Sets the rotation angle of the value.

Parameters:

angle - Rotation angle in degrees.

getValueDistance

double getValueDistance()

Returns the current distance of values to the point. The distance is specified relative to the font height.

Returns:

Distance relative to the font height.

setValueDistance

void setValueDistance(double distance)

Sets the distance of values to the point. The distance is specified relative to the font height.

Parameters:

distance - Distance relative to the font height.

getValueColor

ColorMapper getValueColor()

Returns the mapping that is used to fill the value.

Returns:

ColorMapper instance that is used to fill the value.

setValueColor

void setValueColor(ColorMapper color)

Sets the mapping that will be used to fill the value.

Parameters:

color - ColorMapper instance that will be used to fill the value.

setValueColor

void setValueColor(java.awt.Paint color)

Sets the paint that will be used to fill the value.

Parameters:

color - Paint instance that will be used to fill the value.

getValueFont

java.awt.Font getValueFont()

Returns the font that is used to render the value.

Returns:

Font that is used to render the value.

setValueFont

void setValueFont(java.awt.Font font)

Sets the font that will be used to render the value.

Parameters:

font - Font that will be used to render the value.

isErrorVisible

boolean isErrorVisible()

Returns whether the error value is displayed.

Returns:

true if the error value is displayed, otherwise false.

setErrorVisible

void setErrorVisible(boolean errorVisible)

Sets whether the error value will be displayed.

Parameters:

errorVisible - true if the error value should be displayed, otherwise false.

getErrorColumnTop

int getErrorColumnTop()

Returns the index of the column that contains the upper error value.

Returns:

Index of the column that contains the upper error value.

setErrorColumnTop

void setErrorColumnTop(int columnIndex)

Sets the index of the column that contains the upper error value.

Parameters:

columnIndex - Index of the column that contains the upper error value.

getErrorColumnBottom

int getErrorColumnBottom()

Returns the index of the column that contains the lower error value.

Returns:

Index of the column that contains the lower error value.

setErrorColumnBottom

void setErrorColumnBottom(int columnIndex)

Sets the index of the column that contains the lower error value.

Parameters:

columnIndex - Index of the column that contains the lower error value.

getErrorColor

ColorMapper getErrorColor()

Returns the mapping that is used to fill the error indicators.

Returns:

ColorMapper instance that is used to fill the error indicators.

setErrorColor

void setErrorColor(ColorMapper color)

Sets the mapping that will be used to fill the error indicators.

Parameters:

color - ColorMapper instance that will be used to fill the error indicators.

setErrorColor

void setErrorColor(java.awt.Paint color)

Sets the paint that will be used to fill the error indicators.

Parameters:

color - Paint instance that will be used to fill the error indicators.

getErrorShape

java.awt.Shape getErrorShape()

Returns the shape which is used to draw the error indicators.

Returns:

Shape instance of the error indicators.

setErrorShape

void setErrorShape(java.awt.Shape shape)

Sets the shape which will be used to draw the error indicators.

Parameters:

shape - Shape instance for the error indicators.

getErrorStroke

java.awt.Stroke getErrorStroke()

Returns the stroke which is used to draw the error indicators.

Returns:

Current stroke of the error indicators.

setErrorStroke

void setErrorStroke(java.awt.Stroke stroke)

Sets the stroke which will be used to draw the error indicators.

Parameters:

stroke - Stroke of the error indicators.

getPointShape

java.awt.Shape getPointShape(PointData data)

Returns a Shape instance that can be used for further calculations.

Parameters:

data - Information on axes, renderers, and values.

Returns:

Outline that describes the point's shape.

getPoint

Drawable getPoint(PointData data,
                  java.awt.Shape shape)

Returns the graphical representation to be drawn for the specified data value.

Parameters:

data - Information on axes, renderers, and values.

shape - Outline that describes the point's shape.

Returns:

Component that can be used to draw the point.

getValue

Drawable getValue(PointData data,
                  java.awt.Shape shape)

Returns a graphical representation of the value label to be drawn for the specified data value.

Parameters:

data - Information on axes, renderers, and values.

shape - Outline that describes the bounds for the value label.

Returns:

Component that can be used to draw the value label.