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 annotated with domain and range tick markers.

Nested Class Summary

static class

XYGraphWidget.XYPlotOrientation Will be used in a future version.

Constructor Summary

XYGraphWidget(XYPlot plot, SizeMetrics sizeMetrics)

Method Summary

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.
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()
float	getDomainCursorPosition()
Double	getDomainCursorVal()
float	getDomainLabelHorizontalOffset()
android.graphics.Paint	getDomainLabelPaint()
int	getDomainLabelTickExtension()
float	getDomainLabelVerticalOffset()
float	getDomainLabelWidth()
android.graphics.Paint	getDomainOriginLabelPaint()
android.graphics.Paint	getDomainOriginLinePaint()
Format	getDomainValueFormat()
android.graphics.Paint	getGridBackgroundPaint()
android.graphics.Paint	getGridDomainLinePaint() get the GridDomainLinePaint.
android.graphics.Paint	getGridLinePaint()
float	getGridPaddingBottom()
float	getGridPaddingLeft()
float	getGridPaddingRight()
float	getGridPaddingTop()
android.graphics.Paint	getGridRangeLinePaint() get the GridRangeLinePaint.
android.graphics.RectF	getGridRect() Returns a RectF representing the grid area last drawn by this plot.
float	getRangeCursorPosition()
Double	getRangeCursorVal()
float	getRangeLabelHorizontalOffset()
android.graphics.Paint	getRangeLabelPaint()
int	getRangeLabelTickExtension()
float	getRangeLabelVerticalOffset()
float	getRangeLabelWidth()
android.graphics.Paint	getRangeOriginLabelPaint()
android.graphics.Paint	getRangeOriginLinePaint()
int	getRangeTicksPerLabel() Deprecated.
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	isDrawMarkersEnabled()
boolean	isRangeAxisLeft()
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 maxLableString)
void	setDomainCursorPosition(float domainCursorPosition)
void	setDomainLabelHorizontalOffset(float domainLabelHorizontalOffset)
void	setDomainLabelPaint(android.graphics.Paint domainLabelPaint)
void	setDomainLabelTickExtension(int domainLabelTickExtension)
void	setDomainLabelVerticalOffset(float domainLabelVerticalOffset)
void	setDomainLabelWidth(float domainLabelWidth)
void	setDomainOriginLabelPaint(android.graphics.Paint domainOriginLabelPaint)
void	setDomainOriginLinePaint(android.graphics.Paint domainOriginLinePaint)
void	setDomainValueFormat(Format domainValueFormat)
void	setDrawMarkersEnabled(boolean drawMarkersEnabled)
void	setGridBackgroundPaint(android.graphics.Paint gridBackgroundPaint)
void	setGridDomainLinePaint(android.graphics.Paint gridLinePaint) Creates a copy of gridDomainLinePaint to be used for drawing grid lines.
void	setGridLinePaint(android.graphics.Paint gridLinePaint) Creates a copy of gridLinePaint to be used for drawing grid lines.
void	setGridPaddingBottom(float gridPaddingBottom)
void	setGridPaddingLeft(float gridPaddingLeft)
void	setGridPaddingRight(float gridPaddingRight)
void	setGridPaddingTop(float gridPaddingTop)
void	setGridRangeLinePaint(android.graphics.Paint gridLinePaint) Creates a copy of gridRangeLinePaint to be used for drawing grid lines.
void	setRangeAxisLeft(boolean rangeAxisLeft)
void	setRangeAxisPosition(boolean rangeAxisLeft, boolean rangeAxisOverlay, int tickSize, String maxLableString)
void	setRangeCursorPosition(float rangeCursorPosition)
void	setRangeLabelHorizontalOffset(float rangeLabelHorizontalOffset)
void	setRangeLabelPaint(android.graphics.Paint rangeLabelPaint)
void	setRangeLabelTickExtension(int rangeLabelTickExtension)
void	setRangeLabelVerticalOffset(float rangeLabelVerticalOffset)
void	setRangeLabelWidth(float rangeLabelWidth)
void	setRangeOriginLabelPaint(android.graphics.Paint rangeOriginLabelPaint)
void	setRangeOriginLinePaint(android.graphics.Paint rangeOriginLinePaint)
void	setRangeTicksPerLabel(int rangeTicksPerLabel) Deprecated.
void	setRangeValueFormat(Format rangeValueFormat)
void	setTicksPerDomainLabel(int ticksPerDomainLabel)
void	setTicksPerRangeLabel(int ticksPerRangeLabel)

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

containsPoint, draw, getBackgroundPaint, getBorderPaint, getHeightMetric, getHeightPix, getMarginatedRect, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddedRect, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getWidthMetric, getWidthPix, isClippingEnabled, isVisible, layout, setBackgroundPaint, setBorderPaint, setClippingEnabled, setHeight, setHeight, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setSize, setVisible, setWidth, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

XYGraphWidget

public XYGraphWidget(XYPlot plot,
                     SizeMetrics sizeMetrics)

Method Detail

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)

getGridRect

public android.graphics.RectF getGridRect()

Returns a RectF representing the grid area last drawn by this plot.

Returns:

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:

drawRangeTick

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

getDomainLabelWidth

public float getDomainLabelWidth()

setDomainLabelWidth

public void setDomainLabelWidth(float domainLabelWidth)

getRangeLabelWidth

public float getRangeLabelWidth()

setRangeLabelWidth

public void setRangeLabelWidth(float rangeLabelWidth)

getDomainLabelVerticalOffset

public float getDomainLabelVerticalOffset()

setDomainLabelVerticalOffset

public void setDomainLabelVerticalOffset(float domainLabelVerticalOffset)

getDomainLabelHorizontalOffset

public float getDomainLabelHorizontalOffset()

setDomainLabelHorizontalOffset

public void setDomainLabelHorizontalOffset(float domainLabelHorizontalOffset)

getRangeLabelHorizontalOffset

public float getRangeLabelHorizontalOffset()

setRangeLabelHorizontalOffset

public void setRangeLabelHorizontalOffset(float rangeLabelHorizontalOffset)

getRangeLabelVerticalOffset

public float getRangeLabelVerticalOffset()

setRangeLabelVerticalOffset

public void setRangeLabelVerticalOffset(float rangeLabelVerticalOffset)

getGridBackgroundPaint

public android.graphics.Paint getGridBackgroundPaint()

setGridBackgroundPaint

public void setGridBackgroundPaint(android.graphics.Paint gridBackgroundPaint)

getDomainLabelPaint

public android.graphics.Paint getDomainLabelPaint()

setDomainLabelPaint

public void setDomainLabelPaint(android.graphics.Paint domainLabelPaint)

getRangeLabelPaint

public android.graphics.Paint getRangeLabelPaint()

setRangeLabelPaint

public void setRangeLabelPaint(android.graphics.Paint rangeLabelPaint)

getGridLinePaint

public android.graphics.Paint getGridLinePaint()

setGridLinePaint

public void setGridLinePaint(android.graphics.Paint gridLinePaint)

Creates a copy of gridLinePaint to be used for drawing grid lines. The copied instance will have it's style attribute set to Paint.Style.STROKE.

Parameters:

gridLinePaint -

getGridDomainLinePaint

public android.graphics.Paint getGridDomainLinePaint()

get the GridDomainLinePaint. If the Domain and Range have the same paint then a copy is made to seperate them.

setGridDomainLinePaint

public void setGridDomainLinePaint(android.graphics.Paint gridLinePaint)

Creates a copy of gridDomainLinePaint to be used for drawing grid lines. The copied instance will have it's style attribute set to Paint.Style.STROKE.

Parameters:

gridLinePaint -

getGridRangeLinePaint

public android.graphics.Paint getGridRangeLinePaint()

get the GridRangeLinePaint. If the Domain and Range have the same paint then a copy is made to seperate them.

setGridRangeLinePaint

public void setGridRangeLinePaint(android.graphics.Paint gridLinePaint)

Creates a copy of gridRangeLinePaint to be used for drawing grid lines. The copied instance will have it's style attribute set to Paint.Style.STROKE.

Parameters:

gridLinePaint -

getRangeValueFormat

public Format getRangeValueFormat()

setRangeValueFormat

public void setRangeValueFormat(Format rangeValueFormat)

getDomainValueFormat

public Format getDomainValueFormat()

setDomainValueFormat

public void setDomainValueFormat(Format domainValueFormat)

getDomainLabelTickExtension

public int getDomainLabelTickExtension()

setDomainLabelTickExtension

public void setDomainLabelTickExtension(int domainLabelTickExtension)

getRangeLabelTickExtension

public int getRangeLabelTickExtension()

setRangeLabelTickExtension

public void setRangeLabelTickExtension(int rangeLabelTickExtension)

getTicksPerRangeLabel

public int getTicksPerRangeLabel()

setTicksPerRangeLabel

public void setTicksPerRangeLabel(int ticksPerRangeLabel)

getTicksPerDomainLabel

public int getTicksPerDomainLabel()

setTicksPerDomainLabel

public void setTicksPerDomainLabel(int ticksPerDomainLabel)

getRangeTicksPerLabel

@Deprecated
public int getRangeTicksPerLabel()

Deprecated.

Deprecated - use getTicksPerRangeLabel() instead.

Returns:

setRangeTicksPerLabel

@Deprecated
public void setRangeTicksPerLabel(int rangeTicksPerLabel)

Deprecated.

Deprecated - use setTicksPerRangeLabel() instead.

Parameters:

rangeTicksPerLabel -

setGridPaddingTop

public void setGridPaddingTop(float gridPaddingTop)

getGridPaddingBottom

public float getGridPaddingBottom()

setGridPaddingBottom

public void setGridPaddingBottom(float gridPaddingBottom)

getGridPaddingLeft

public float getGridPaddingLeft()

setGridPaddingLeft

public void setGridPaddingLeft(float gridPaddingLeft)

getGridPaddingRight

public float getGridPaddingRight()

setGridPaddingRight

public void setGridPaddingRight(float gridPaddingRight)

getGridPaddingTop

public float getGridPaddingTop()

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)

getDomainOriginLabelPaint

public android.graphics.Paint getDomainOriginLabelPaint()

setDomainOriginLabelPaint

public void setDomainOriginLabelPaint(android.graphics.Paint domainOriginLabelPaint)

getRangeOriginLabelPaint

public android.graphics.Paint getRangeOriginLabelPaint()

setRangeOriginLabelPaint

public void setRangeOriginLabelPaint(android.graphics.Paint rangeOriginLabelPaint)

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)

setRangeAxisPosition

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

setDomainAxisPosition

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