ChartComputator (hellocharts-library API)

java.lang.Object
- lecho.lib.hellocharts.computator.ChartComputator

Direct Known Subclasses:

PreviewChartComputator
```
public class ChartComputator
extends java.lang.Object
```
Computes raw points coordinates(in pixels), holds content area dimensions and chart viewport.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`chartHeight`
`protected int`	`chartWidth`
`protected android.graphics.Rect`	`contentRectMinusAllMargins`
`protected android.graphics.Rect`	`contentRectMinusAxesMargins`
`protected Viewport`	`currentViewport` This rectangle represents the currently visible chart values ranges.
`protected static float`	`DEFAULT_MAXIMUM_ZOOM` Maximum chart zoom.
`protected android.graphics.Rect`	`maxContentRect`
`protected Viewport`	`maxViewport`
`protected float`	`maxZoom`
`protected float`	`minViewportHeight`
`protected float`	`minViewportWidth`
`protected ViewportChangeListener`	`viewportChangeListener` Warning! Viewport listener is disabled for all charts beside preview charts to avoid additional method calls during animations.

Constructor Summary

Constructors
Constructor and Description

ChartComputator()

Constructors
Constructor and Description
`ChartComputator()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`computeRawDistanceX(float distance)` Translates viewport distance int pixel distance for X coordinates.
`float`	`computeRawDistanceY(float distance)` Translates viewport distance int pixel distance for X coordinates.
`float`	`computeRawX(float valueX)` Translates chart value into raw pixel value.
`float`	`computeRawY(float valueY)` Translates chart value into raw pixel value.
`void`	`computeScrollSurfaceSize(android.graphics.Point out)` Computes the current scrollable surface size, in pixels.
`void`	`constrainViewport(float left, float top, float right, float bottom)` Checks if new viewport doesn't exceed max available viewport.
`int`	`getChartHeight()`
`int`	`getChartWidth()`
`android.graphics.Rect`	`getContentRectMinusAllMargins()` Returns content rectangle in pixels.
`android.graphics.Rect`	`getContentRectMinusAxesMargins()` Returns content rectangle with chart internal margins, for example for LineChart contentRectMinusAxesMargins is bigger than contentRectMinusAllMargins by point radius, thanks to that points are not cut on edges.
`Viewport`	`getCurrentViewport()` Returns current chart viewport, returned object is mutable but should not be modified.
`Viewport`	`getMaximumViewport()` Returns maximum viewport - values ranges extremes.
`float`	`getMaxZoom()`
`float`	`getMinimumViewportHeight()`
`float`	`getMinimumViewportWidth()`
`Viewport`	`getVisibleViewport()` Returns viewport for visible part of chart, for most charts it is equal to current viewport.
`void`	`insetContentRect(int deltaLeft, int deltaTop, int deltaRight, int deltaBottom)`
`void`	`insetContentRectByInternalMargins(int deltaLeft, int deltaTop, int deltaRight, int deltaBottom)`
`boolean`	`isWithinContentRect(float x, float y, float precision)` Check if given coordinates lies inside contentRectMinusAllMargins.
`boolean`	`rawPixelsToDataPoint(float x, float y, android.graphics.PointF dest)` Finds the chart point (i.e.
`void`	`resetContentRect()`
`void`	`setContentRect(int width, int height, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom)` Calculates available width and height.
`void`	`setCurrentViewport(float left, float top, float right, float bottom)` Set new values for curent viewport, that will change what part of chart is visible.
`void`	`setCurrentViewport(Viewport viewport)` Set current viewport to the same values as viewport passed in parameter.
`void`	`setMaxViewport(float left, float top, float right, float bottom)` Set new values for maximum viewport, that will change what part of chart is visible.
`void`	`setMaxViewport(Viewport maxViewport)` Set maximum viewport to the same values as viewport passed in parameter.
`void`	`setMaxZoom(float maxZoom)` Set maximum zoom level, default is 20.
`void`	`setViewportChangeListener(ViewportChangeListener viewportChangeListener)`
`void`	`setViewportTopLeft(float left, float top)` Sets the current viewport (defined by `currentViewport`) to the given X and Y positions.
`void`	`setVisibleViewport(Viewport visibleViewport)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAXIMUM_ZOOM
```
protected static final float DEFAULT_MAXIMUM_ZOOM
```
    Maximum chart zoom.
    
    See Also:
    
    Constant Field Values
  - maxZoom
```
protected float maxZoom
```
  - chartWidth
```
protected int chartWidth
```
  - chartHeight
```
protected int chartHeight
```
  - contentRectMinusAllMargins
```
protected android.graphics.Rect contentRectMinusAllMargins
```
  - contentRectMinusAxesMargins
```
protected android.graphics.Rect contentRectMinusAxesMargins
```
  - maxContentRect
```
protected android.graphics.Rect maxContentRect
```
  - currentViewport
```
protected Viewport currentViewport
```
    This rectangle represents the currently visible chart values ranges. The currently visible chart X values are from this rectangle's left to its right. The currently visible chart Y values are from this rectangle's top to its bottom.
  - maxViewport
```
protected Viewport maxViewport
```
  - minViewportWidth
```
protected float minViewportWidth
```
  - minViewportHeight
```
protected float minViewportHeight
```
  - viewportChangeListener
```
protected ViewportChangeListener viewportChangeListener
```
    Warning! Viewport listener is disabled for all charts beside preview charts to avoid additional method calls during animations.
- Constructor Detail
  - ChartComputator
```
public ChartComputator()
```
- Method Detail
  - setContentRect
```
public void setContentRect(int width,
                           int height,
                           int paddingLeft,
                           int paddingTop,
                           int paddingRight,
                           int paddingBottom)
```
    Calculates available width and height. Should be called when chart dimensions change. ContentRect is relative to chart view not the device's screen.
  - resetContentRect
```
public void resetContentRect()
```
  - insetContentRect
```
public void insetContentRect(int deltaLeft,
                             int deltaTop,
                             int deltaRight,
                             int deltaBottom)
```
  - insetContentRectByInternalMargins
```
public void insetContentRectByInternalMargins(int deltaLeft,
                                              int deltaTop,
                                              int deltaRight,
                                              int deltaBottom)
```
  - constrainViewport
```
public void constrainViewport(float left,
                              float top,
                              float right,
                              float bottom)
```
    Checks if new viewport doesn't exceed max available viewport.
  - setViewportTopLeft
```
public void setViewportTopLeft(float left,
                               float top)
```
    Sets the current viewport (defined by currentViewport) to the given X and Y positions.
  - computeRawX
```
public float computeRawX(float valueX)
```
    Translates chart value into raw pixel value. Returned value is absolute pixel X coordinate. If this method return 0 that means left most pixel of the screen.
  - computeRawY
```
public float computeRawY(float valueY)
```
    Translates chart value into raw pixel value. Returned value is absolute pixel Y coordinate. If this method return 0 that means top most pixel of the screen.
  - computeRawDistanceX
```
public float computeRawDistanceX(float distance)
```
    Translates viewport distance int pixel distance for X coordinates.
  - computeRawDistanceY
```
public float computeRawDistanceY(float distance)
```
    Translates viewport distance int pixel distance for X coordinates.
  - rawPixelsToDataPoint
```
public boolean rawPixelsToDataPoint(float x,
                                    float y,
                                    android.graphics.PointF dest)
```
    Finds the chart point (i.e. within the chart's domain and range) represented by the given pixel coordinates, if that pixel is within the chart region described by contentRectMinusAllMargins. If the point is found, the "dest" argument is set to the point and this function returns true. Otherwise, this function returns false and "dest" is unchanged.
  - computeScrollSurfaceSize
```
public void computeScrollSurfaceSize(android.graphics.Point out)
```
    Computes the current scrollable surface size, in pixels. For example, if the entire chart area is visible, this is simply the current size of contentRectMinusAllMargins. If the chart is zoomed in 200% in both directions, the returned size will be twice as large horizontally and vertically.
  - isWithinContentRect
```
public boolean isWithinContentRect(float x,
                                   float y,
                                   float precision)
```
    Check if given coordinates lies inside contentRectMinusAllMargins.
  - getContentRectMinusAllMargins
```
public android.graphics.Rect getContentRectMinusAllMargins()
```
    Returns content rectangle in pixels.
    
    See Also:
    
    setContentRect(int, int, int, int, int, int)
  - getContentRectMinusAxesMargins
```
public android.graphics.Rect getContentRectMinusAxesMargins()
```
    Returns content rectangle with chart internal margins, for example for LineChart contentRectMinusAxesMargins is bigger than contentRectMinusAllMargins by point radius, thanks to that points are not cut on edges.
    
    See Also:
    
    setContentRect(int, int, int, int, int, int)
  - getCurrentViewport
```
public Viewport getCurrentViewport()
```
    Returns current chart viewport, returned object is mutable but should not be modified.
    
    Returns:
  - setCurrentViewport
```
public void setCurrentViewport(Viewport viewport)
```
    Set current viewport to the same values as viewport passed in parameter. This method use deep copy so parameter can be safely modified later. Current viewport must be equal or smaller than maximum viewport.
    
    Parameters:
    
    viewport -
  - setCurrentViewport
```
public void setCurrentViewport(float left,
                               float top,
                               float right,
                               float bottom)
```
    Set new values for curent viewport, that will change what part of chart is visible. Current viewport must be equal or smaller than maximum viewport.
  - getMaximumViewport
```
public Viewport getMaximumViewport()
```
    Returns maximum viewport - values ranges extremes.
  - setMaxViewport
```
public void setMaxViewport(Viewport maxViewport)
```
    Set maximum viewport to the same values as viewport passed in parameter. This method use deep copy so parameter can be safely modified later.
    
    Parameters:
    
    maxViewport -
  - setMaxViewport
```
public void setMaxViewport(float left,
                           float top,
                           float right,
                           float bottom)
```
    Set new values for maximum viewport, that will change what part of chart is visible.
  - getVisibleViewport
```
public Viewport getVisibleViewport()
```
    Returns viewport for visible part of chart, for most charts it is equal to current viewport.
    
    Returns:
  - setVisibleViewport
```
public void setVisibleViewport(Viewport visibleViewport)
```
  - getMinimumViewportWidth
```
public float getMinimumViewportWidth()
```
  - getMinimumViewportHeight
```
public float getMinimumViewportHeight()
```
  - setViewportChangeListener
```
public void setViewportChangeListener(ViewportChangeListener viewportChangeListener)
```
  - getChartWidth
```
public int getChartWidth()
```
  - getChartHeight
```
public int getChartHeight()
```
  - getMaxZoom
```
public float getMaxZoom()
```
  - setMaxZoom
```
public void setMaxZoom(float maxZoom)
```
    Set maximum zoom level, default is 20.
    
    Parameters:
    
    maxZoom -

Class ChartComputator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAXIMUM_ZOOM

maxZoom

chartWidth

chartHeight

contentRectMinusAllMargins

contentRectMinusAxesMargins

maxContentRect

currentViewport

maxViewport

minViewportWidth

minViewportHeight

viewportChangeListener

Constructor Detail

ChartComputator

Method Detail

setContentRect

resetContentRect

insetContentRect

insetContentRectByInternalMargins

constrainViewport

setViewportTopLeft

computeRawX

computeRawY

computeRawDistanceX

computeRawDistanceY

rawPixelsToDataPoint

computeScrollSurfaceSize

isWithinContentRect

getContentRectMinusAllMargins

getContentRectMinusAxesMargins

getCurrentViewport

setCurrentViewport

setCurrentViewport

getMaximumViewport

setMaxViewport

setMaxViewport

getVisibleViewport

setVisibleViewport

getMinimumViewportWidth

getMinimumViewportHeight

setViewportChangeListener

getChartWidth

getChartHeight

getMaxZoom

setMaxZoom