com.github.mikephil.charting.utils

Class ViewPortHandler

java.lang.Object

com.github.mikephil.charting.utils.ViewPortHandler

public class ViewPortHandler
extends java.lang.Object

Class that contains information about the charts current viewport settings, including offsets, scale & translation levels, ...

Field Summary

Fields

Modifier and Type	Field and Description
protected float	mChartHeight
protected float	mChartWidth
protected android.graphics.RectF	mContentRect this rectangle defines the area in which graph values can be drawn
protected android.graphics.Matrix	mMatrixTouch matrix used for touch events

Constructor Summary

Constructors

Constructor and Description
ViewPortHandler() Constructor - don't forget calling setChartDimens(...)

Method Summary

Modifier and Type	Method and Description
boolean	canZoomInMoreX() Returns true if the chart is not yet fully zoomed in on the x-axis
boolean	canZoomOutMoreX() Returns true if the chart is not yet fully zoomed out on the x-axis
void	centerViewPort(float[] transformedPts, android.view.View view) Centers the viewport around the specified position (x-index and y-value) in the chart.
float	contentBottom()
float	contentHeight()
float	contentLeft()
float	contentRight()
float	contentTop()
float	contentWidth()
android.graphics.Matrix	fitScreen() Resets all zooming and dragging and makes the chart fit exactly it's bounds.
float	getChartHeight()
float	getChartWidth()
android.graphics.PointF	getContentCenter()
android.graphics.RectF	getContentRect()
android.graphics.Matrix	getMatrixTouch() Returns the charts-touch matrix used for translation and scale on touch.
float	getScaleX() returns the current x-scale factor
float	getScaleY() returns the current y-scale factor
float	getTransX() Returns the translation (drag / pan) distance on the x-axis
float	getTransY() Returns the translation (drag / pan) distance on the y-axis
boolean	hasChartDimens()
boolean	hasNoDragOffset() Returns true if both drag offsets (x and y) are zero or smaller.
boolean	isFullyZoomedOut() if the chart is fully zoomed out, return true
boolean	isFullyZoomedOutX() Returns true if the chart is fully zoomed out on it's x-axis (horizontal).
boolean	isFullyZoomedOutY() Returns true if the chart is fully zoomed out on it's y-axis (vertical).
boolean	isInBounds(float x, float y)
boolean	isInBoundsBottom(float y)
boolean	isInBoundsLeft(float x)
boolean	isInBoundsRight(float x)
boolean	isInBoundsTop(float y)
boolean	isInBoundsX(float x) BELOW METHODS FOR BOUNDS CHECK
boolean	isInBoundsY(float y)
void	limitTransAndScale(android.graphics.Matrix matrix, android.graphics.RectF content) limits the maximum scale and X translation of the given matrix
float	offsetBottom()
float	offsetLeft()
float	offsetRight()
float	offsetTop()
android.graphics.Matrix	refresh(android.graphics.Matrix newMatrix, android.view.View chart, boolean invalidate) call this method to refresh the graph with a given matrix
void	restrainViewPort(float offsetLeft, float offsetTop, float offsetRight, float offsetBottom)
void	setChartDimens(float width, float height) Sets the width and height of the chart.
void	setDragOffsetX(float offset) Set an offset in dp that allows the user to drag the chart over it's bounds on the x-axis.
void	setDragOffsetY(float offset) Set an offset in dp that allows the user to drag the chart over it's bounds on the y-axis.
void	setMaximumScaleX(float xScale) Sets the maximum scale factor for the x-axis
void	setMaximumScaleY(float yScale) Sets the maximum scale factor for the y-axis
void	setMinimumScaleX(float xScale) Sets the minimum scale factor for the x-axis
void	setMinimumScaleY(float yScale) Sets the minimum scale factor for the y-axis
void	setMinMaxScaleX(float minScaleX, float maxScaleX) Sets the minimum and maximum scale factors for the x-axis
android.graphics.Matrix	zoom(float scaleX, float scaleY, float x, float y) Zooms in or out by the given scale factor.
android.graphics.Matrix	zoomIn(float x, float y) Zooms in by 1.4f, x and y are the coordinates (in pixels) of the zoom center.
android.graphics.Matrix	zoomOut(float x, float y) Zooms out by 0.7f, x and y are the coordinates (in pixels) of the zoom center.

Methods inherited from class java.lang.Object

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

Field Detail

mMatrixTouch

protected final android.graphics.Matrix mMatrixTouch

matrix used for touch events

mContentRect

protected android.graphics.RectF mContentRect

this rectangle defines the area in which graph values can be drawn

mChartWidth

protected float mChartWidth

mChartHeight

protected float mChartHeight

Constructor Detail

ViewPortHandler

public ViewPortHandler()

Constructor - don't forget calling setChartDimens(...)

Method Detail

setChartDimens

public void setChartDimens(float width,
                           float height)

Sets the width and height of the chart.

Parameters:

width -

height -

hasChartDimens

public boolean hasChartDimens()

restrainViewPort

public void restrainViewPort(float offsetLeft,
                             float offsetTop,
                             float offsetRight,
                             float offsetBottom)

offsetLeft

public float offsetLeft()

offsetRight

public float offsetRight()

offsetTop

public float offsetTop()

offsetBottom

public float offsetBottom()

contentTop

public float contentTop()

contentLeft

public float contentLeft()

contentRight

public float contentRight()

contentBottom

public float contentBottom()

contentWidth

public float contentWidth()

contentHeight

public float contentHeight()

getContentRect

public android.graphics.RectF getContentRect()

getContentCenter

public android.graphics.PointF getContentCenter()

getChartHeight

public float getChartHeight()

getChartWidth

public float getChartWidth()

zoomIn

public android.graphics.Matrix zoomIn(float x,
                                      float y)

Zooms in by 1.4f, x and y are the coordinates (in pixels) of the zoom center.

Parameters:

x -

y -

zoomOut

public android.graphics.Matrix zoomOut(float x,
                                       float y)

Zooms out by 0.7f, x and y are the coordinates (in pixels) of the zoom center.

zoom

public android.graphics.Matrix zoom(float scaleX,
                                    float scaleY,
                                    float x,
                                    float y)

Zooms in or out by the given scale factor. x and y are the coordinates (in pixels) of the zoom center.

Parameters:

scaleX - if < 1f --> zoom out, if > 1f --> zoom in

scaleY - if < 1f --> zoom out, if > 1f --> zoom in

x -

y -

fitScreen

public android.graphics.Matrix fitScreen()

Resets all zooming and dragging and makes the chart fit exactly it's bounds.

centerViewPort

public void centerViewPort(float[] transformedPts,
                           android.view.View view)

Centers the viewport around the specified position (x-index and y-value) in the chart. Centering the viewport outside the bounds of the chart is not possible. Makes most sense in combination with the setScaleMinima(...) method.

Parameters:

transformedPts - the position to center view viewport to

view -

refresh

public android.graphics.Matrix refresh(android.graphics.Matrix newMatrix,
                                       android.view.View chart,
                                       boolean invalidate)

call this method to refresh the graph with a given matrix

Parameters:

newMatrix -

Returns:

limitTransAndScale

public void limitTransAndScale(android.graphics.Matrix matrix,
                               android.graphics.RectF content)

limits the maximum scale and X translation of the given matrix

Parameters:

matrix -

setMinimumScaleX

public void setMinimumScaleX(float xScale)

Sets the minimum scale factor for the x-axis

Parameters:

xScale -

setMaximumScaleX

public void setMaximumScaleX(float xScale)

Sets the maximum scale factor for the x-axis

Parameters:

xScale -

setMinMaxScaleX

public void setMinMaxScaleX(float minScaleX,
                            float maxScaleX)

Sets the minimum and maximum scale factors for the x-axis

Parameters:

minScaleX -

maxScaleX -

setMinimumScaleY

public void setMinimumScaleY(float yScale)

Sets the minimum scale factor for the y-axis

Parameters:

yScale -

setMaximumScaleY

public void setMaximumScaleY(float yScale)

Sets the maximum scale factor for the y-axis

Parameters:

yScale -

getMatrixTouch

public android.graphics.Matrix getMatrixTouch()

Returns the charts-touch matrix used for translation and scale on touch.

Returns:

isInBoundsX

public boolean isInBoundsX(float x)

BELOW METHODS FOR BOUNDS CHECK

isInBoundsY

public boolean isInBoundsY(float y)

isInBounds

public boolean isInBounds(float x,
                          float y)

isInBoundsLeft

public boolean isInBoundsLeft(float x)

isInBoundsRight

public boolean isInBoundsRight(float x)

isInBoundsTop

public boolean isInBoundsTop(float y)

isInBoundsBottom

public boolean isInBoundsBottom(float y)

getScaleX

public float getScaleX()

returns the current x-scale factor

getScaleY

public float getScaleY()

returns the current y-scale factor

getTransX

public float getTransX()

Returns the translation (drag / pan) distance on the x-axis

Returns:

getTransY

public float getTransY()

Returns the translation (drag / pan) distance on the y-axis

Returns:

isFullyZoomedOut

public boolean isFullyZoomedOut()

if the chart is fully zoomed out, return true

Returns:

isFullyZoomedOutY

public boolean isFullyZoomedOutY()

Returns true if the chart is fully zoomed out on it's y-axis (vertical).

Returns:

isFullyZoomedOutX

public boolean isFullyZoomedOutX()

Returns true if the chart is fully zoomed out on it's x-axis (horizontal).

Returns:

setDragOffsetX

public void setDragOffsetX(float offset)

Set an offset in dp that allows the user to drag the chart over it's bounds on the x-axis.

Parameters:

offset -

setDragOffsetY

public void setDragOffsetY(float offset)

Set an offset in dp that allows the user to drag the chart over it's bounds on the y-axis.

Parameters:

offset -

hasNoDragOffset

public boolean hasNoDragOffset()

Returns true if both drag offsets (x and y) are zero or smaller.

Returns:

canZoomOutMoreX

public boolean canZoomOutMoreX()

Returns true if the chart is not yet fully zoomed out on the x-axis

Returns:

canZoomInMoreX

public boolean canZoomInMoreX()

Returns true if the chart is not yet fully zoomed in on the x-axis

Returns: