com.jjoe64.graphview

Class Viewport

java.lang.Object

com.jjoe64.graphview.Viewport

public class Viewport
extends java.lang.Object

This is the default implementation for the viewport. This implementation so for a normal viewport where there is a horizontal x-axis and a vertical y-axis. This viewport is compatible with - BarGraphSeries - LineGraphSeries - PointsGraphSeries

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Viewport.AxisBoundsStatus the state of the axis bounds
static interface	Viewport.OnXAxisBoundsChangedListener listener to notify when x bounds changed after scaling or scrolling.

Field Summary

Fields

Modifier and Type	Field and Description
protected RectD	mCompleteRange this holds the whole range of the data left = minX, right = maxX bottom = minY, top = maxY
protected RectD	mCurrentViewport this holds the current visible viewport left = minX, right = maxX bottom = minY, top = maxY
protected GestureDetector	mGestureDetector gesture detector to detect scrolling
protected double	mMaxXAxisSize maximum allowed viewport size (horizontal) 0 means use the bounds of the actual data that is available
protected double	mMaxYAxisSize maximum allowed viewport size (vertical) 0 means use the bounds of the actual data that is available
protected Viewport.OnXAxisBoundsChangedListener	mOnXAxisBoundsChangedListener listener to notify when x bounds changed after scaling or scrolling.
protected ScaleGestureDetector	mScaleGestureDetector detect scaling
protected boolean	mScalingActive flag whether scaling is currently active
protected OverScroller	mScroller not used - for fling
protected Viewport.AxisBoundsStatus	mXAxisBoundsStatus state of the x axis
protected Viewport.AxisBoundsStatus	mYAxisBoundsStatus state of the y axis
protected double	referenceX this reference value is used to generate the horizontal labels.
protected double	referenceY this reference value is used to generate the vertical labels.
protected boolean	scalableY flag whether the vertical scaling is activated

Method Summary

Modifier and Type	Method and Description
void	calcCompleteRange() caches the complete range (minX, maxX, minY, maxY) by iterating all series and all datapoints and stores it into #mCompleteRange for the x-range it will respect the series on the second scale - not for y-values
void	computeScroll() not used currently
void	draw(Canvas c) draws the glowing edge effect
void	drawFirst(Canvas c) will be first called in order to draw the canvas Used to draw the background
int	getBackgroundColor()
int	getBorderColor() the border color used.
double	getMaxX(boolean completeRange)
double	getMaxXAxisSize() maximum allowed viewport size (horizontal) 0 means use the bounds of the actual data that is available
double	getMaxY(boolean completeRange)
double	getMaxYAxisSize() maximum allowed viewport size (vertical) 0 means use the bounds of the actual data that is available
double	getMinX(boolean completeRange)
double	getMinY(boolean completeRange)
Viewport.OnXAxisBoundsChangedListener	getOnXAxisBoundsChangedListener()
protected double	getReferenceX() the reference number to generate the labels
protected double	getReferenceY() the reference number to generate the labels
Viewport.AxisBoundsStatus	getXAxisBoundsStatus()
Viewport.AxisBoundsStatus	getYAxisBoundsStatus()
boolean	isScalable()
boolean	isScrollable()
boolean	isXAxisBoundsManual()
boolean	isYAxisBoundsManual()
boolean	onTouchEvent(MotionEvent event) will be called on a touch event.
void	scrollToEnd() forces the viewport to scroll to the end of the range by keeping the current viewport size.
void	setBackgroundColor(int mBackgroundColor)
void	setBorderColor(java.lang.Integer borderColor) the border color used.
void	setBorderPaint(Paint borderPaint) custom paint to use for the border.
void	setDrawBorder(boolean drawBorder) optional draw a border between the labels and the viewport
void	setMaxX(double x) set the maximal x value for the current viewport.
void	setMaxXAxisSize(double mMaxXAxisViewportSize) Set the max viewport size (horizontal) This can prevent the user from zooming out too much.
void	setMaxY(double y) set the maximal y value for the current viewport.
void	setMaxYAxisSize(double mMaxYAxisViewportSize) Set the max viewport size (vertical) This can prevent the user from zooming out too much.
void	setMinimalViewport(double minX, double maxX, double minY, double maxY) minimal viewport used for scaling and scrolling.
void	setMinX(double x) set the minimal x value for the current viewport.
void	setMinY(double y) set the minimal y value for the current viewport.
void	setOnXAxisBoundsChangedListener(Viewport.OnXAxisBoundsChangedListener l) set a listener to notify when x bounds changed after scaling or scrolling.
void	setScalable(boolean mIsScalable) active the scaling/zooming feature notice: sets the x axis bounds to manual
void	setScalableY(boolean scalableY) activate or deactivate the vertical zooming/scaling functionallity.
void	setScrollable(boolean mIsScrollable)
void	setScrollableY(boolean scrollableY) activate/deactivate the vertical scrolling
void	setXAxisBoundsManual(boolean mXAxisBoundsManual)
void	setXAxisBoundsStatus(Viewport.AxisBoundsStatus s) change the state of the x axis.
void	setYAxisBoundsManual(boolean mYAxisBoundsManual)
void	setYAxisBoundsStatus(Viewport.AxisBoundsStatus s) change the state of the y axis.

Methods inherited from class java.lang.Object

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

Field Detail

referenceY

protected double referenceY

this reference value is used to generate the vertical labels. It is used when the y axis bounds is set manual and humanRoundingY=false. it will be the minValueY value.

referenceX

protected double referenceX

this reference value is used to generate the horizontal labels. It is used when the x axis bounds is set manual and humanRoundingX=false. it will be the minValueX value.

scalableY

protected boolean scalableY

flag whether the vertical scaling is activated

mCurrentViewport

protected RectD mCurrentViewport

this holds the current visible viewport left = minX, right = maxX bottom = minY, top = maxY

mMaxXAxisSize

protected double mMaxXAxisSize

maximum allowed viewport size (horizontal) 0 means use the bounds of the actual data that is available

mMaxYAxisSize

protected double mMaxYAxisSize

maximum allowed viewport size (vertical) 0 means use the bounds of the actual data that is available

mCompleteRange

protected RectD mCompleteRange

this holds the whole range of the data left = minX, right = maxX bottom = minY, top = maxY

mScalingActive

protected boolean mScalingActive

flag whether scaling is currently active

mGestureDetector

protected GestureDetector mGestureDetector

gesture detector to detect scrolling

mScaleGestureDetector

protected ScaleGestureDetector mScaleGestureDetector

detect scaling

mScroller

protected OverScroller mScroller

not used - for fling

mXAxisBoundsStatus

protected Viewport.AxisBoundsStatus mXAxisBoundsStatus

state of the x axis

mYAxisBoundsStatus

protected Viewport.AxisBoundsStatus mYAxisBoundsStatus

state of the y axis

mOnXAxisBoundsChangedListener

protected Viewport.OnXAxisBoundsChangedListener mOnXAxisBoundsChangedListener

listener to notify when x bounds changed after scaling or scrolling. This can be used to load more detailed data.

Method Detail

getReferenceX

protected double getReferenceX()

the reference number to generate the labels

Returns:

by default 0, only when manual bounds and no human rounding is active, the min x value is returned

onTouchEvent

public boolean onTouchEvent(MotionEvent event)

will be called on a touch event. needed to use scaling and scrolling

Parameters:

event -

Returns:

true if it was consumed

setXAxisBoundsStatus

public void setXAxisBoundsStatus(Viewport.AxisBoundsStatus s)

change the state of the x axis. normally you do not call this method. If you want to set manual axis use setXAxisBoundsManual(boolean) and setYAxisBoundsManual(boolean)

Parameters:

s - state

setYAxisBoundsStatus

public void setYAxisBoundsStatus(Viewport.AxisBoundsStatus s)

change the state of the y axis. normally you do not call this method. If you want to set manual axis use setXAxisBoundsManual(boolean) and setYAxisBoundsManual(boolean)

Parameters:

s - state

isScrollable

public boolean isScrollable()

Returns:

whether the viewport is scrollable

setScrollable

public void setScrollable(boolean mIsScrollable)

Parameters:

mIsScrollable - whether is viewport is scrollable

getXAxisBoundsStatus

public Viewport.AxisBoundsStatus getXAxisBoundsStatus()

Returns:

the x axis state

getYAxisBoundsStatus

public Viewport.AxisBoundsStatus getYAxisBoundsStatus()

Returns:

the y axis state

calcCompleteRange

public void calcCompleteRange()

caches the complete range (minX, maxX, minY, maxY) by iterating all series and all datapoints and stores it into #mCompleteRange for the x-range it will respect the series on the second scale - not for y-values

getMinX

public double getMinX(boolean completeRange)

Parameters:

completeRange - if true => minX of the complete range of all series if false => minX of the current visible viewport

Returns:

the min x value

getMaxX

public double getMaxX(boolean completeRange)

Parameters:

completeRange - if true => maxX of the complete range of all series if false => maxX of the current visible viewport

Returns:

the max x value

getMinY

public double getMinY(boolean completeRange)

Parameters:

completeRange - if true => minY of the complete range of all series if false => minY of the current visible viewport

Returns:

the min y value

getMaxY

public double getMaxY(boolean completeRange)

Parameters:

completeRange - if true => maxY of the complete range of all series if false => maxY of the current visible viewport

Returns:

the max y value

setMaxY

public void setMaxY(double y)

set the maximal y value for the current viewport. Make sure to set the y bounds to manual via setYAxisBoundsManual(boolean)

Parameters:

y - max / highest value

setMinY

public void setMinY(double y)

set the minimal y value for the current viewport. Make sure to set the y bounds to manual via setYAxisBoundsManual(boolean)

Parameters:

y - min / lowest value

setMaxX

public void setMaxX(double x)

set the maximal x value for the current viewport. Make sure to set the x bounds to manual via setXAxisBoundsManual(boolean)

Parameters:

x - max / highest value

setMinX

public void setMinX(double x)

set the minimal x value for the current viewport. Make sure to set the x bounds to manual via setXAxisBoundsManual(boolean)

Parameters:

x - min / lowest value

computeScroll

public void computeScroll()

not used currently

drawFirst

public void drawFirst(Canvas c)

will be first called in order to draw the canvas Used to draw the background

Parameters:

c - canvas.

draw

public void draw(Canvas c)

draws the glowing edge effect

Parameters:

c - canvas

getBackgroundColor

public int getBackgroundColor()

Returns:

background of the viewport area

setBackgroundColor

public void setBackgroundColor(int mBackgroundColor)

Parameters:

mBackgroundColor - background of the viewport area use transparent to have no background

isScalable

public boolean isScalable()

Returns:

whether the viewport is scalable

setScalable

public void setScalable(boolean mIsScalable)

active the scaling/zooming feature notice: sets the x axis bounds to manual

Parameters:

mIsScalable - whether the viewport is scalable

isXAxisBoundsManual

public boolean isXAxisBoundsManual()

Returns:

whether the x axis bounds are manual.

See Also:

setMinX(double), setMaxX(double)

setXAxisBoundsManual

public void setXAxisBoundsManual(boolean mXAxisBoundsManual)

Parameters:

mXAxisBoundsManual - whether the x axis bounds are manual.

See Also:

setMinX(double), setMaxX(double)

isYAxisBoundsManual

public boolean isYAxisBoundsManual()

Returns:

whether the y axis bound are manual

setYAxisBoundsManual

public void setYAxisBoundsManual(boolean mYAxisBoundsManual)

Parameters:

mYAxisBoundsManual - whether the y axis bounds are manual

See Also:

setMaxY(double), setMinY(double)

scrollToEnd

public void scrollToEnd()

forces the viewport to scroll to the end of the range by keeping the current viewport size. Important: Only takes effect if x axis bounds are manual.

See Also:

setXAxisBoundsManual(boolean)

getOnXAxisBoundsChangedListener

public Viewport.OnXAxisBoundsChangedListener getOnXAxisBoundsChangedListener()

Returns:

the listener when there is one registered.

setOnXAxisBoundsChangedListener

public void setOnXAxisBoundsChangedListener(Viewport.OnXAxisBoundsChangedListener l)

set a listener to notify when x bounds changed after scaling or scrolling. This can be used to load more detailed data.

Parameters:

l - the listener to use

setDrawBorder

public void setDrawBorder(boolean drawBorder)

optional draw a border between the labels and the viewport

Parameters:

drawBorder - true to draw the border

getBorderColor

public int getBorderColor()

the border color used. will be ignored when a custom paint is set.

Returns:

border color. by default the grid color is used

See Also:

setDrawBorder(boolean)

setBorderColor

public void setBorderColor(java.lang.Integer borderColor)

the border color used. will be ignored when a custom paint is set.

Parameters:

borderColor - null to reset

setBorderPaint

public void setBorderPaint(Paint borderPaint)

custom paint to use for the border. border color will be ignored

Parameters:

borderPaint -

See Also:

setDrawBorder(boolean)

setScrollableY

public void setScrollableY(boolean scrollableY)

activate/deactivate the vertical scrolling

Parameters:

scrollableY - true to activate

getReferenceY

protected double getReferenceY()

the reference number to generate the labels

Returns:

by default 0, only when manual bounds and no human rounding is active, the min y value is returned

setScalableY

public void setScalableY(boolean scalableY)

activate or deactivate the vertical zooming/scaling functionallity. This will automatically activate the vertical scrolling and the horizontal scaling/scrolling feature.

Parameters:

scalableY - true to activate

getMaxXAxisSize

public double getMaxXAxisSize()

maximum allowed viewport size (horizontal) 0 means use the bounds of the actual data that is available

getMaxYAxisSize

public double getMaxYAxisSize()

maximum allowed viewport size (vertical) 0 means use the bounds of the actual data that is available

setMaxXAxisSize

public void setMaxXAxisSize(double mMaxXAxisViewportSize)

Set the max viewport size (horizontal) This can prevent the user from zooming out too much. E.g. with a 24 hours graph, it could force the user to only be able to see 2 hours of data at a time. Default value is 0 (disabled)

Parameters:

mMaxXAxisViewportSize - maximum size of viewport

setMaxYAxisSize

public void setMaxYAxisSize(double mMaxYAxisViewportSize)

Set the max viewport size (vertical) This can prevent the user from zooming out too much. E.g. with a 24 hours graph, it could force the user to only be able to see 2 hours of data at a time. Default value is 0 (disabled)

Parameters:

mMaxYAxisViewportSize - maximum size of viewport

setMinimalViewport

public void setMinimalViewport(double minX,
                               double maxX,
                               double minY,
                               double maxY)

minimal viewport used for scaling and scrolling. this is used if the data that is available is less then the viewport that we want to be able to display. if Double.NaN is used, then this value is ignored

Parameters:

minX -

maxX -

minY -

maxY -