com.androidplot.xy

Class XYGraphWidget

java.lang.Object

com.androidplot.ui.widget.Widget

com.androidplot.xy.XYGraphWidget

All Implemented Interfaces:

BoxModelable, Resizable

public class XYGraphWidget
extends Widget

Displays graphical data (lines, points, etc.) annotated with domain and range tick markers.

Constructor Summary

Constructors

Constructor and Description
XYGraphWidget(LayoutManager layoutManager, XYPlot plot, Size size)

Method Summary

Modifier and Type	Method and Description
void	addAxisValueLabelRegion(RectRegion region, AxisValueLabelFormatter formatter) Add a new Region used for rendering axis valuelabels.
void	addDomainAxisValueLabelRegion(double min, double max, AxisValueLabelFormatter formatter) Convenience method - wraps addAxisValueLabelRegion, using Double.POSITIVE_INFINITY and Double.NEGATIVE_INFINITY to mask off range axis value labels.
void	addRangeAxisValueLabelRegion(double min, double max, AxisValueLabelFormatter formatter) Convenience method - wraps addAxisValueLabelRegion, using Double.POSITIVE_INFINITY and Double.NEGATIVE_INFINITY to mask off domain axis value labels.
protected void	doOnDraw(android.graphics.Canvas canvas, android.graphics.RectF widgetRect)
protected void	drawCursors(android.graphics.Canvas canvas)
protected void	drawData(android.graphics.Canvas canvas) Draws lines and points for each element in the series.
protected void	drawGrid(android.graphics.Canvas canvas) Draws the drid and domain/range labels for the plot.
protected void	drawMarkers(android.graphics.Canvas canvas)
protected void	drawPoint(android.graphics.Canvas canvas, android.graphics.PointF point, android.graphics.Paint paint)
void	drawRangeTick(android.graphics.Canvas canvas, float yPix, Number yVal, android.graphics.Paint labelPaint, android.graphics.Paint linePaint, boolean drawLineOnly)
AxisValueLabelFormatter	getAxisValueLabelFormatterForDomainVal(double val)
AxisValueLabelFormatter	getAxisValueLabelFormatterForRangeVal(double val)
AxisValueLabelFormatter	getAxisValueLabelFormatterForVal(double x, double y) Returns the formatter associated with the first (bottom) Region containing x and y.
ZIndexable<RectRegion>	getAxisValueLabelRegions()
android.graphics.Paint	getCursorLabelBackgroundPaint()
android.graphics.Paint	getCursorLabelPaint()
android.graphics.Paint	getDomainCursorPaint()
float	getDomainCursorPosition()
Double	getDomainCursorVal()
android.graphics.Paint	getDomainGridLinePaint() Get the paint used to draw the domain grid line.
float	getDomainLabelOrientation()
int	getDomainLabelSubTickExtension()
android.graphics.Paint	getDomainOriginLinePaint()
android.graphics.Paint	getDomainOriginTickLabelPaint()
android.graphics.Paint	getDomainSubGridLinePaint() Get the paint used to draw the domain grid line.
int	getDomainTickExtension()
float	getDomainTickLabelHorizontalOffset()
android.graphics.Paint	getDomainTickLabelPaint()
Mapping<android.graphics.Paint,Number>	getDomainTickLabelPaintMap()
float	getDomainTickLabelVerticalOffset()
float	getDomainTickLabelWidth()
Format	getDomainValueFormat()
android.graphics.Paint	getGridBackgroundPaint()
BoxModel	getGridBox()
DisplayDimensions	getGridDimensions()
android.graphics.Paint	getRangeCursorPaint()
float	getRangeCursorPosition()
Double	getRangeCursorVal()
android.graphics.Paint	getRangeGridLinePaint() Get the paint used to draw the range grid line.
float	getRangeLabelOrientation()
int	getRangeLabelSubTickExtension()
android.graphics.Paint	getRangeOriginLinePaint()
android.graphics.Paint	getRangeOriginTickLabelPaint()
android.graphics.Paint	getRangeSubGridLinePaint() Get the paint used to draw the range grid line.
int	getRangeTickExtension()
float	getRangeTickLabelHorizontalOffset()
android.graphics.Paint	getRangeTickLabelPaint()
Mapping<android.graphics.Paint,Number>	getRangeTickLabelPaintMap()
float	getRangeTickLabelVerticalOffset()
float	getRangeTickLabelWidth()
Format	getRangeValueFormat()
int	getTicksPerDomainLabel()
int	getTicksPerRangeLabel()
Double	getXVal(float xPix) Converts an x pixel into an x value.
Double	getXVal(android.graphics.PointF point) Convenience method.
Double	getYVal(float yPix) Converts a y pixel to a y value.
Double	getYVal(android.graphics.PointF point) Convenience method.
boolean	isDomainAxisBottom()
boolean	isDomainSubTick()
boolean	isDomainTick()
boolean	isDrawMarkersEnabled()
boolean	isRangeAxisLeft()
boolean	isRangeSubTick()
boolean	isRangeTick()
void	setCursorLabelBackgroundPaint(android.graphics.Paint cursorLabelBackgroundPaint)
void	setCursorLabelPaint(android.graphics.Paint cursorLabelPaint)
void	setCursorPosition(float x, float y)
void	setCursorPosition(android.graphics.PointF point)
void	setDomainAxisBottom(boolean domainAxisBottom)
void	setDomainAxisPosition(boolean domainAxisBottom, boolean domainAxisOverlay, int tickSize, String maxLabelString)
void	setDomainCursorPaint(android.graphics.Paint domainCursorPaint)
void	setDomainCursorPosition(float domainCursorPosition)
void	setDomainGridLinePaint(android.graphics.Paint gridLinePaint) Set the paint used to draw the domain grid line.
void	setDomainLabelOrientation(float domainLabelOrientation)
void	setDomainLabelSubTickExtension(int domainLabelSubTickExtension)
void	setDomainOriginLinePaint(android.graphics.Paint domainOriginLinePaint)
void	setDomainOriginTickLabelPaint(android.graphics.Paint domainOriginTickLabelPaint)
void	setDomainSubGridLinePaint(android.graphics.Paint gridLinePaint) Set the paint used to draw the domain grid line.
void	setDomainSubTick(boolean domainSubTick)
void	setDomainTick(boolean domainTick)
void	setDomainTickExtension(int domainTickExtension)
void	setDomainTickLabelHorizontalOffset(float domainTickLabelHorizontalOffset)
void	setDomainTickLabelPaint(android.graphics.Paint domainTickLabelPaint)
void	setDomainTickLabelPaintMap(Mapping<android.graphics.Paint,Number> domainTickLabelPaintMap) Set a mapping to override the Paint used to draw domain labels.
void	setDomainTickLabelVerticalOffset(float domainTickLabelVerticalOffset)
void	setDomainTickLabelWidth(float domainTickLabelWidth)
void	setDomainValueFormat(Format domainValueFormat)
void	setDrawMarkersEnabled(boolean drawMarkersEnabled)
void	setGridBackgroundPaint(android.graphics.Paint gridBackgroundPaint)
void	setGridBox(BoxModel gridBox)
void	setRangeAxisLeft(boolean rangeAxisLeft)
void	setRangeAxisPosition(boolean rangeAxisLeft, boolean rangeAxisOverlay, int tickSize, String maxLableString)
void	setRangeCursorPaint(android.graphics.Paint rangeCursorPaint)
void	setRangeCursorPosition(float rangeCursorPosition)
void	setRangeGridLinePaint(android.graphics.Paint gridLinePaint) Set the Paint used to draw the range grid line.
void	setRangeLabelOrientation(float rangeLabelOrientation)
void	setRangeLabelSubTickExtension(int rangeLabelSubTickExtension)
void	setRangeLabelTickPaintMap(Mapping<android.graphics.Paint,Number> rangeLabelTickPaintMap) Set a mapping to override the Paint used to draw range labels.
void	setRangeOriginLinePaint(android.graphics.Paint rangeOriginLinePaint)
void	setRangeOriginTickLabelPaint(android.graphics.Paint rangeOriginTickLabelPaint)
void	setRangeSubGridLinePaint(android.graphics.Paint gridLinePaint) Set the Paint used to draw the range grid line.
void	setRangeSubTick(boolean rangeSubTick)
void	setRangeTick(boolean rangeTick)
void	setRangeTickExtension(int rangeTickExtension)
void	setRangeTickLabelHorizontalOffset(float rangeTickLabelHorizontalOffset)
void	setRangeTickLabelPaint(android.graphics.Paint rangeTickLabelPaint)
void	setRangeTickLabelVerticalOffset(float rangeTickLabelVerticalOffset)
void	setRangeTickLabelWidth(float rangeTickLabelWidth)
void	setRangeValueFormat(Format rangeValueFormat)
void	setTicksPerDomainLabel(int ticksPerDomainLabel)
void	setTicksPerRangeLabel(int ticksPerRangeLabel)

Methods inherited from class com.androidplot.ui.widget.Widget

containsPoint, draw, drawBackground, drawBorder, getAnchor, getAnchorCoordinates, getAnchorCoordinates, getAnchorOffset, getBackgroundPaint, getBorderPaint, getElementCoordinates, getHeightMetric, getHeightPix, getMarginatedRect, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddedRect, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPositionMetrics, getSize, getWidgetDimensions, getWidthMetric, getWidthPix, isClippingEnabled, isVisible, layout, onMetricsChanged, onPostInit, position, position, refreshLayout, setAnchor, setBackgroundPaint, setBorderPaint, setClippingEnabled, setHeight, setHeight, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPositionMetrics, setSize, setVisible, setWidth, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XYGraphWidget

public XYGraphWidget(LayoutManager layoutManager,
                     XYPlot plot,
                     Size size)

Method Detail

getRangeLabelOrientation

public float getRangeLabelOrientation()

setRangeLabelOrientation

public void setRangeLabelOrientation(float rangeLabelOrientation)

getDomainLabelOrientation

public float getDomainLabelOrientation()

setDomainLabelOrientation

public void setDomainLabelOrientation(float domainLabelOrientation)

getDomainTickLabelPaintMap

public Mapping<android.graphics.Paint,Number> getDomainTickLabelPaintMap()

Returns:

setDomainTickLabelPaintMap

public void setDomainTickLabelPaintMap(Mapping<android.graphics.Paint,Number> domainTickLabelPaintMap)

Set a mapping to override the Paint used to draw domain labels. The mapping should return null for values that should not be overridden.

Parameters:

domainTickLabelPaintMap -

getRangeTickLabelPaintMap

public Mapping<android.graphics.Paint,Number> getRangeTickLabelPaintMap()

setRangeLabelTickPaintMap

public void setRangeLabelTickPaintMap(Mapping<android.graphics.Paint,Number> rangeLabelTickPaintMap)

Set a mapping to override the Paint used to draw range labels. The mapping should return null for values that should not be overridden.

Parameters:

rangeLabelTickPaintMap -

getGridBox

public BoxModel getGridBox()

setGridBox

public void setGridBox(BoxModel gridBox)

getDomainCursorPaint

public android.graphics.Paint getDomainCursorPaint()

setDomainCursorPaint

public void setDomainCursorPaint(android.graphics.Paint domainCursorPaint)

Parameters:

domainCursorPaint - The Paint used to draw the domain cursor line. Set to null (default) to disable.

getRangeCursorPaint

public android.graphics.Paint getRangeCursorPaint()

setRangeCursorPaint

public void setRangeCursorPaint(android.graphics.Paint rangeCursorPaint)

Parameters:

rangeCursorPaint - The Paint used to draw the range cursor line. Set to null (default) to disable.

getAxisValueLabelRegions

public ZIndexable<RectRegion> getAxisValueLabelRegions()

addAxisValueLabelRegion

public void addAxisValueLabelRegion(RectRegion region,
                                    AxisValueLabelFormatter formatter)

Add a new Region used for rendering axis valuelabels. Note that it is possible to add multiple Region instances which overlap, in which cast the last region to be added will be used. It is up to the developer to guard against this often undesireable situation.

Parameters:

region -

formatter -

addDomainAxisValueLabelRegion

public void addDomainAxisValueLabelRegion(double min,
                                          double max,
                                          AxisValueLabelFormatter formatter)

Convenience method - wraps addAxisValueLabelRegion, using Double.POSITIVE_INFINITY and Double.NEGATIVE_INFINITY to mask off range axis value labels.

Parameters:

min -

max -

formatter -

addRangeAxisValueLabelRegion

public void addRangeAxisValueLabelRegion(double min,
                                         double max,
                                         AxisValueLabelFormatter formatter)

Convenience method - wraps addAxisValueLabelRegion, using Double.POSITIVE_INFINITY and Double.NEGATIVE_INFINITY to mask off domain axis value labels.

Parameters:

min -

max -

formatter -

getAxisValueLabelFormatterForVal

public AxisValueLabelFormatter getAxisValueLabelFormatterForVal(double x,
                                                                double y)

Returns the formatter associated with the first (bottom) Region containing x and y.

Parameters:

x -

y -

Returns:

the formatter associated with the first (bottom) region containing x and y. null otherwise.

getAxisValueLabelFormatterForDomainVal

public AxisValueLabelFormatter getAxisValueLabelFormatterForDomainVal(double val)

getAxisValueLabelFormatterForRangeVal

public AxisValueLabelFormatter getAxisValueLabelFormatterForRangeVal(double val)

getYVal

public Double getYVal(android.graphics.PointF point)

Convenience method. Wraps getYVal(float)

Parameters:

point -

Returns:

getYVal

public Double getYVal(float yPix)

Converts a y pixel to a y value.

Parameters:

yPix -

Returns:

getXVal

public Double getXVal(android.graphics.PointF point)

Convenience method. Wraps getXVal(float)

Parameters:

point -

Returns:

getXVal

public Double getXVal(float xPix)

Converts an x pixel into an x value.

Parameters:

xPix -

Returns:

doOnDraw

protected void doOnDraw(android.graphics.Canvas canvas,
                        android.graphics.RectF widgetRect)
                 throws PlotRenderException

Specified by:

doOnDraw in class Widget

Parameters:

canvas - The Canvas to draw onto

widgetRect - the size and coordinates of this widget

Throws:

PlotRenderException

drawRangeTick

public void drawRangeTick(android.graphics.Canvas canvas,
                          float yPix,
                          Number yVal,
                          android.graphics.Paint labelPaint,
                          android.graphics.Paint linePaint,
                          boolean drawLineOnly)

drawGrid

protected void drawGrid(android.graphics.Canvas canvas)

Draws the drid and domain/range labels for the plot.

Parameters:

canvas -

drawMarkers

protected void drawMarkers(android.graphics.Canvas canvas)

drawCursors

protected void drawCursors(android.graphics.Canvas canvas)

drawData

protected void drawData(android.graphics.Canvas canvas)
                 throws PlotRenderException

Draws lines and points for each element in the series.

Parameters:

canvas -

Throws:

PlotRenderException

drawPoint

protected void drawPoint(android.graphics.Canvas canvas,
                         android.graphics.PointF point,
                         android.graphics.Paint paint)

getDomainTickLabelWidth

public float getDomainTickLabelWidth()

setDomainTickLabelWidth

public void setDomainTickLabelWidth(float domainTickLabelWidth)

getRangeTickLabelWidth

public float getRangeTickLabelWidth()

setRangeTickLabelWidth

public void setRangeTickLabelWidth(float rangeTickLabelWidth)

getDomainTickLabelVerticalOffset

public float getDomainTickLabelVerticalOffset()

setDomainTickLabelVerticalOffset

public void setDomainTickLabelVerticalOffset(float domainTickLabelVerticalOffset)

getDomainTickLabelHorizontalOffset

public float getDomainTickLabelHorizontalOffset()

setDomainTickLabelHorizontalOffset

public void setDomainTickLabelHorizontalOffset(float domainTickLabelHorizontalOffset)

getRangeTickLabelHorizontalOffset

public float getRangeTickLabelHorizontalOffset()

setRangeTickLabelHorizontalOffset

public void setRangeTickLabelHorizontalOffset(float rangeTickLabelHorizontalOffset)

getRangeTickLabelVerticalOffset

public float getRangeTickLabelVerticalOffset()

setRangeTickLabelVerticalOffset

public void setRangeTickLabelVerticalOffset(float rangeTickLabelVerticalOffset)

getGridBackgroundPaint

public android.graphics.Paint getGridBackgroundPaint()

setGridBackgroundPaint

public void setGridBackgroundPaint(android.graphics.Paint gridBackgroundPaint)

getDomainTickLabelPaint

public android.graphics.Paint getDomainTickLabelPaint()

setDomainTickLabelPaint

public void setDomainTickLabelPaint(android.graphics.Paint domainTickLabelPaint)

getRangeTickLabelPaint

public android.graphics.Paint getRangeTickLabelPaint()

setRangeTickLabelPaint

public void setRangeTickLabelPaint(android.graphics.Paint rangeTickLabelPaint)

getDomainGridLinePaint

public android.graphics.Paint getDomainGridLinePaint()

Get the paint used to draw the domain grid line.

setDomainGridLinePaint

public void setDomainGridLinePaint(android.graphics.Paint gridLinePaint)

Set the paint used to draw the domain grid line.

Parameters:

gridLinePaint -

getRangeGridLinePaint

public android.graphics.Paint getRangeGridLinePaint()

Get the paint used to draw the range grid line.

getDomainSubGridLinePaint

public android.graphics.Paint getDomainSubGridLinePaint()

Get the paint used to draw the domain grid line.

setDomainSubGridLinePaint

public void setDomainSubGridLinePaint(android.graphics.Paint gridLinePaint)

Set the paint used to draw the domain grid line.

Parameters:

gridLinePaint -

setRangeGridLinePaint

public void setRangeGridLinePaint(android.graphics.Paint gridLinePaint)

Set the Paint used to draw the range grid line.

Parameters:

gridLinePaint -

getRangeSubGridLinePaint

public android.graphics.Paint getRangeSubGridLinePaint()

Get the paint used to draw the range grid line.

setRangeSubGridLinePaint

public void setRangeSubGridLinePaint(android.graphics.Paint gridLinePaint)

Set the Paint used to draw the range grid line.

Parameters:

gridLinePaint -

getRangeValueFormat

public Format getRangeValueFormat()

setRangeValueFormat

public void setRangeValueFormat(Format rangeValueFormat)

getDomainValueFormat

public Format getDomainValueFormat()

setDomainValueFormat

public void setDomainValueFormat(Format domainValueFormat)

getDomainTickExtension

public int getDomainTickExtension()

setDomainTickExtension

public void setDomainTickExtension(int domainTickExtension)

getRangeTickExtension

public int getRangeTickExtension()

getDomainLabelSubTickExtension

public int getDomainLabelSubTickExtension()

setDomainLabelSubTickExtension

public void setDomainLabelSubTickExtension(int domainLabelSubTickExtension)

setRangeTickExtension

public void setRangeTickExtension(int rangeTickExtension)

getRangeLabelSubTickExtension

public int getRangeLabelSubTickExtension()

setRangeLabelSubTickExtension

public void setRangeLabelSubTickExtension(int rangeLabelSubTickExtension)

getTicksPerRangeLabel

public int getTicksPerRangeLabel()

setTicksPerRangeLabel

public void setTicksPerRangeLabel(int ticksPerRangeLabel)

getTicksPerDomainLabel

public int getTicksPerDomainLabel()

setTicksPerDomainLabel

public void setTicksPerDomainLabel(int ticksPerDomainLabel)

getDomainOriginLinePaint

public android.graphics.Paint getDomainOriginLinePaint()

setDomainOriginLinePaint

public void setDomainOriginLinePaint(android.graphics.Paint domainOriginLinePaint)

getRangeOriginLinePaint

public android.graphics.Paint getRangeOriginLinePaint()

setRangeOriginLinePaint

public void setRangeOriginLinePaint(android.graphics.Paint rangeOriginLinePaint)

getDomainOriginTickLabelPaint

public android.graphics.Paint getDomainOriginTickLabelPaint()

setDomainOriginTickLabelPaint

public void setDomainOriginTickLabelPaint(android.graphics.Paint domainOriginTickLabelPaint)

getRangeOriginTickLabelPaint

public android.graphics.Paint getRangeOriginTickLabelPaint()

setRangeOriginTickLabelPaint

public void setRangeOriginTickLabelPaint(android.graphics.Paint rangeOriginTickLabelPaint)

setCursorPosition

public void setCursorPosition(float x,
                              float y)

setCursorPosition

public void setCursorPosition(android.graphics.PointF point)

getDomainCursorPosition

public float getDomainCursorPosition()

getDomainCursorVal

public Double getDomainCursorVal()

setDomainCursorPosition

public void setDomainCursorPosition(float domainCursorPosition)

getRangeCursorPosition

public float getRangeCursorPosition()

getRangeCursorVal

public Double getRangeCursorVal()

setRangeCursorPosition

public void setRangeCursorPosition(float rangeCursorPosition)

getCursorLabelPaint

public android.graphics.Paint getCursorLabelPaint()

setCursorLabelPaint

public void setCursorLabelPaint(android.graphics.Paint cursorLabelPaint)

getCursorLabelBackgroundPaint

public android.graphics.Paint getCursorLabelBackgroundPaint()

setCursorLabelBackgroundPaint

public void setCursorLabelBackgroundPaint(android.graphics.Paint cursorLabelBackgroundPaint)

isDrawMarkersEnabled

public boolean isDrawMarkersEnabled()

setDrawMarkersEnabled

public void setDrawMarkersEnabled(boolean drawMarkersEnabled)

isRangeAxisLeft

public boolean isRangeAxisLeft()

setRangeAxisLeft

public void setRangeAxisLeft(boolean rangeAxisLeft)

isDomainAxisBottom

public boolean isDomainAxisBottom()

setDomainAxisBottom

public void setDomainAxisBottom(boolean domainAxisBottom)

isRangeTick

public boolean isRangeTick()

setRangeTick

public void setRangeTick(boolean rangeTick)

isRangeSubTick

public boolean isRangeSubTick()

setRangeSubTick

public void setRangeSubTick(boolean rangeSubTick)

isDomainTick

public boolean isDomainTick()

setDomainTick

public void setDomainTick(boolean domainTick)

isDomainSubTick

public boolean isDomainSubTick()

setDomainSubTick

public void setDomainSubTick(boolean domainSubTick)

setRangeAxisPosition

public void setRangeAxisPosition(boolean rangeAxisLeft,
                                 boolean rangeAxisOverlay,
                                 int tickSize,
                                 String maxLableString)

setDomainAxisPosition

public void setDomainAxisPosition(boolean domainAxisBottom,
                                  boolean domainAxisOverlay,
                                  int tickSize,
                                  String maxLabelString)

getGridDimensions

public DisplayDimensions getGridDimensions()