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. The inner area of the graph upon which grid lines and points are rendered is called the "grid" area.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XYGraphWidget.CursorLabelFormatter
static class	XYGraphWidget.Edge
static class	XYGraphWidget.LineLabelRenderer
static class	XYGraphWidget.LineLabelStyle

Nested classes/interfaces inherited from class com.androidplot.ui.widget.Widget

Widget.Rotation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	containsPoint(float x, float y) Checks whether the point exists within the visible grid space.
protected void	doOnDraw(android.graphics.Canvas canvas, android.graphics.RectF widgetRect)
protected void	drawCursorLabel(android.graphics.Canvas canvas)
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	drawDomainLine(android.graphics.Canvas canvas, float xPix, java.lang.Number xVal, android.graphics.Paint linePaint, boolean isOrigin)
protected void	drawGrid(android.graphics.Canvas canvas) Draws the grid and domain/range labels for the plot.
protected void	drawGridBackground(android.graphics.Canvas canvas)
protected void	drawLineLabel(android.graphics.Canvas canvas, XYGraphWidget.Edge edge, java.lang.Number val, float x, float y, boolean isOrigin)
protected void	drawMarkers(android.graphics.Canvas canvas)
protected void	drawPoint(android.graphics.Canvas canvas, android.graphics.PointF point, android.graphics.Paint paint)
protected void	drawRangeLine(android.graphics.Canvas canvas, float yPix, java.lang.Number yVal, android.graphics.Paint linePaint, boolean isOrigin)
XYGraphWidget.CursorLabelFormatter	getCursorLabelFormatter()
protected java.util.Map<XYGraphWidget.Edge,XYGraphWidget.LineLabelRenderer>	getDefaultLineLabelRenderers()
protected java.util.Map<XYGraphWidget.Edge,XYGraphWidget.LineLabelStyle>	getDefaultLineLabelStyles()
android.graphics.Paint	getDomainCursorPaint()
java.lang.Float	getDomainCursorPosition()
java.lang.Number	getDomainCursorVal()
android.graphics.Paint	getDomainGridLinePaint() Get the paint used to draw the domain grid line.
android.graphics.Paint	getDomainOriginLinePaint()
android.graphics.Paint	getDomainSubGridLinePaint() Get the paint used to draw the domain grid line.
android.graphics.Paint	getGridBackgroundPaint()
Insets	getGridInsets() Grid insets
android.graphics.RectF	getGridRect()
android.graphics.RectF	getLabelRect()
float	getLineExtensionBottom()
float	getLineExtensionLeft()
float	getLineExtensionRight()
float	getLineExtensionTop()
Insets	getLineLabelInsets() Domain / Range label insets
XYGraphWidget.LineLabelRenderer	getLineLabelRenderer(XYGraphWidget.Edge edge)
XYGraphWidget.LineLabelStyle	getLineLabelStyle(XYGraphWidget.Edge edge)
int	getLinesPerDomainLabel()
int	getLinesPerRangeLabel()
android.graphics.Paint	getRangeCursorPaint()
java.lang.Float	getRangeCursorPosition()
java.lang.Number	getRangeCursorVal()
android.graphics.Paint	getRangeGridLinePaint() Get the paint used to draw the range grid line.
android.graphics.Paint	getRangeOriginLinePaint()
android.graphics.Paint	getRangeSubGridLinePaint() Get the paint used to draw the range grid line.
boolean	isDrawGridOnTop()
boolean	isDrawMarkersEnabled()
boolean	isGridClippingEnabled()
boolean	isLineLabelEnabled(XYGraphWidget.Edge position)
void	processAttrs(android.content.res.TypedArray attrs) Apply xml attrs
protected XYCoords	screenToSeries(android.graphics.PointF point) Convenience method.
protected java.lang.Number	screenToSeriesX(float xPix) Converts an x pixel into an x value.
protected java.lang.Number	screenToSeriesX(android.graphics.PointF point) Convenience method.
protected java.lang.Number	screenToSeriesY(float yPix) Converts a y pixel to a y value.
protected java.lang.Number	screenToSeriesY(android.graphics.PointF point) Convenience method.
protected android.graphics.PointF	seriesToScreen(XYCoords xy)
protected float	seriesToScreenX(java.lang.Number x)
protected float	seriesToScreenY(java.lang.Number y)
void	setCursorLabelFormatter(XYGraphWidget.CursorLabelFormatter cursorLabelFormatter)
void	setCursorPosition(java.lang.Float x, java.lang.Float y) Set domain and range cursor position using screen coordinates
void	setCursorPosition(android.graphics.PointF point) Set domain and range cursor position using screen coordinates
void	setDomainCursorPaint(android.graphics.Paint domainCursorPaint)
void	setDomainCursorPosition(java.lang.Float domainCursorPosition) Set domain cursor position using screen coordinates
void	setDomainGridLinePaint(android.graphics.Paint gridLinePaint) Set the paint used to draw the domain grid line.
void	setDomainOriginLinePaint(android.graphics.Paint domainOriginLinePaint)
void	setDomainSubGridLinePaint(android.graphics.Paint gridLinePaint) Set the paint used to draw the domain grid line.
void	setDrawGridOnTop(boolean drawGridOnTop)
void	setDrawMarkersEnabled(boolean drawMarkersEnabled)
void	setGridBackgroundPaint(android.graphics.Paint gridBackgroundPaint)
void	setGridClippingEnabled(boolean gridClippingEnabled)
void	setGridInsets(Insets gridInsets)
void	setGridRect(android.graphics.RectF gridRect)
void	setLabelRect(android.graphics.RectF labelRect)
void	setLineExtensionBottom(float lineExtensionBottom)
void	setLineExtensionLeft(float lineExtensionLeft)
void	setLineExtensionRight(float lineExtensionRight)
void	setLineExtensionTop(float lineExtensionTop)
void	setLineLabelEdges(java.util.Collection<XYGraphWidget.Edge> positions)
protected void	setLineLabelEdges(int bitfield)
void	setLineLabelEdges(XYGraphWidget.Edge... positions)
void	setLineLabelInsets(Insets lineLabelInsets)
void	setLineLabelRenderer(XYGraphWidget.Edge edge, XYGraphWidget.LineLabelRenderer renderer)
void	setLineLabelStyle(XYGraphWidget.Edge edge, XYGraphWidget.LineLabelStyle style)
void	setLinesPerDomainLabel(int linesPerDomainLabel)
void	setLinesPerRangeLabel(int linesPerRangeLabel)
void	setRangeCursorPaint(android.graphics.Paint rangeCursorPaint)
void	setRangeCursorPosition(java.lang.Float rangeCursorPosition) Set range cursor position using screen coordinates
void	setRangeGridLinePaint(android.graphics.Paint gridLinePaint) Set the Paint used to draw the range grid line.
void	setRangeOriginLinePaint(android.graphics.Paint rangeOriginLinePaint)
void	setRangeSubGridLinePaint(android.graphics.Paint gridLinePaint) Set the Paint used to draw the range grid line.

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

applyRotation, containsPoint, draw, drawBackground, drawBorder, getAnchor, getAnchorCoordinates, getAnchorCoordinates, getAnchorOffset, getBackgroundPaint, getBorderPaint, getElementCoordinates, getHeightMetric, getHeightPix, getMarginatedRect, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddedRect, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPositionMetrics, getRotation, 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, setRotation, 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

processAttrs

public void processAttrs(android.content.res.TypedArray attrs)

Apply xml attrs

Parameters:

attrs -

screenToSeries

protected XYCoords screenToSeries(android.graphics.PointF point)

Convenience method. Wraps screenToSeriesY(float) This is a relatively slow operation and should not be used for operations that are a part of the main render loop of a dynamic plot.

Parameters:

point -

Returns:

screenToSeriesX

protected java.lang.Number screenToSeriesX(android.graphics.PointF point)

Convenience method. Wraps screenToSeriesX(float) This is a relatively slow operation and should not be used for operations that are a part of the main render loop of a dynamic plot.

Parameters:

point -

Returns:

screenToSeriesY

protected java.lang.Number screenToSeriesY(android.graphics.PointF point)

Convenience method. Wraps screenToSeriesY(float) This is a relatively slow operation and should not be used for operations that are a part of the main render loop of a dynamic plot.

Parameters:

point -

Returns:

screenToSeriesX

protected java.lang.Number screenToSeriesX(float xPix)

Converts an x pixel into an x value. This is a relatively slow operation and should not be used for operations that are a part of the main render loop of a dynamic plot.

Parameters:

xPix -

Returns:

screenToSeriesY

protected java.lang.Number screenToSeriesY(float yPix)

Converts a y pixel to a y value. This is a relatively slow operation and should not be used for operations that are a part of the main render loop of a dynamic plot.

Parameters:

yPix -

Returns:

seriesToScreen

protected android.graphics.PointF seriesToScreen(XYCoords xy)

seriesToScreenX

protected float seriesToScreenX(java.lang.Number x)

seriesToScreenY

protected float seriesToScreenY(java.lang.Number y)

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

drawDomainLine

protected void drawDomainLine(android.graphics.Canvas canvas,
                              float xPix,
                              java.lang.Number xVal,
                              android.graphics.Paint linePaint,
                              boolean isOrigin)

drawRangeLine

protected void drawRangeLine(android.graphics.Canvas canvas,
                             float yPix,
                             java.lang.Number yVal,
                             android.graphics.Paint linePaint,
                             boolean isOrigin)

drawLineLabel

protected void drawLineLabel(android.graphics.Canvas canvas,
                             XYGraphWidget.Edge edge,
                             java.lang.Number val,
                             float x,
                             float y,
                             boolean isOrigin)

drawGrid

protected void drawGrid(android.graphics.Canvas canvas)

Draws the grid 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)

drawCursorLabel

protected void drawCursorLabel(android.graphics.Canvas canvas)

drawGridBackground

protected void drawGridBackground(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)

getGridBackgroundPaint

public android.graphics.Paint getGridBackgroundPaint()

setGridBackgroundPaint

public void setGridBackgroundPaint(android.graphics.Paint gridBackgroundPaint)

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 -

getLinesPerRangeLabel

public int getLinesPerRangeLabel()

setLinesPerRangeLabel

public void setLinesPerRangeLabel(int linesPerRangeLabel)

getLinesPerDomainLabel

public int getLinesPerDomainLabel()

setLinesPerDomainLabel

public void setLinesPerDomainLabel(int linesPerDomainLabel)

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)

setCursorPosition

public void setCursorPosition(java.lang.Float x,
                              java.lang.Float y)

Set domain and range cursor position using screen coordinates

Parameters:

x -

y -

setCursorPosition

public void setCursorPosition(android.graphics.PointF point)

Set domain and range cursor position using screen coordinates

Parameters:

point -

getDomainCursorPosition

public java.lang.Float getDomainCursorPosition()

getDomainCursorVal

public java.lang.Number getDomainCursorVal()

setDomainCursorPosition

public void setDomainCursorPosition(java.lang.Float domainCursorPosition)

Set domain cursor position using screen coordinates

Parameters:

domainCursorPosition -

getRangeCursorPosition

public java.lang.Float getRangeCursorPosition()

getRangeCursorVal

public java.lang.Number getRangeCursorVal()

setRangeCursorPosition

public void setRangeCursorPosition(java.lang.Float rangeCursorPosition)

Set range cursor position using screen coordinates

Parameters:

rangeCursorPosition -

isDrawGridOnTop

public boolean isDrawGridOnTop()

setDrawGridOnTop

public void setDrawGridOnTop(boolean drawGridOnTop)

isDrawMarkersEnabled

public boolean isDrawMarkersEnabled()

setDrawMarkersEnabled

public void setDrawMarkersEnabled(boolean drawMarkersEnabled)

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.

getLineExtensionTop

public float getLineExtensionTop()

setLineExtensionTop

public void setLineExtensionTop(float lineExtensionTop)

getLineExtensionBottom

public float getLineExtensionBottom()

setLineExtensionBottom

public void setLineExtensionBottom(float lineExtensionBottom)

getLineExtensionLeft

public float getLineExtensionLeft()

setLineExtensionLeft

public void setLineExtensionLeft(float lineExtensionLeft)

getLineExtensionRight

public float getLineExtensionRight()

setLineExtensionRight

public void setLineExtensionRight(float lineExtensionRight)

getDefaultLineLabelStyles

protected java.util.Map<XYGraphWidget.Edge,XYGraphWidget.LineLabelStyle> getDefaultLineLabelStyles()

getDefaultLineLabelRenderers

protected java.util.Map<XYGraphWidget.Edge,XYGraphWidget.LineLabelRenderer> getDefaultLineLabelRenderers()

getLineLabelRenderer

public XYGraphWidget.LineLabelRenderer getLineLabelRenderer(XYGraphWidget.Edge edge)

setLineLabelRenderer

public void setLineLabelRenderer(XYGraphWidget.Edge edge,
                                 XYGraphWidget.LineLabelRenderer renderer)

getLineLabelStyle

public XYGraphWidget.LineLabelStyle getLineLabelStyle(XYGraphWidget.Edge edge)

setLineLabelStyle

public void setLineLabelStyle(XYGraphWidget.Edge edge,
                              XYGraphWidget.LineLabelStyle style)

getCursorLabelFormatter

public XYGraphWidget.CursorLabelFormatter getCursorLabelFormatter()

setCursorLabelFormatter

public void setCursorLabelFormatter(XYGraphWidget.CursorLabelFormatter cursorLabelFormatter)

getGridInsets

public Insets getGridInsets()

Grid insets

setGridInsets

public void setGridInsets(Insets gridInsets)

getLineLabelInsets

public Insets getLineLabelInsets()

Domain / Range label insets

setLineLabelInsets

public void setLineLabelInsets(Insets lineLabelInsets)

getGridRect

public android.graphics.RectF getGridRect()

setGridRect

public void setGridRect(android.graphics.RectF gridRect)

getLabelRect

public android.graphics.RectF getLabelRect()

setLabelRect

public void setLabelRect(android.graphics.RectF labelRect)

isGridClippingEnabled

public boolean isGridClippingEnabled()

setGridClippingEnabled

public void setGridClippingEnabled(boolean gridClippingEnabled)

isLineLabelEnabled

public boolean isLineLabelEnabled(XYGraphWidget.Edge position)

setLineLabelEdges

public void setLineLabelEdges(XYGraphWidget.Edge... positions)

setLineLabelEdges

public void setLineLabelEdges(java.util.Collection<XYGraphWidget.Edge> positions)

setLineLabelEdges

protected void setLineLabelEdges(int bitfield)

containsPoint

public boolean containsPoint(float x,
                             float y)

Checks whether the point exists within the visible grid space.

Parameters:

x -

y -

Returns:

Since:

1.0