Chart (hellocharts-library API)

All Known Implementing Classes:

AbstractChartView, BubbleChartView, ColumnChartView, ComboLineColumnChartView, LineChartView, PieChartView, PreviewColumnChartView, PreviewLineChartView
```
public interface Chart
```
Interface for all charts. Every chart must implements this interface but chart doesn't really have to extends View or ViewGroup class. It can be any java class for example chart that only draw on in-memory bitmap and saves it on sd card.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`animationDataFinished()` Called when data animation finished.
`void`	`animationDataUpdate(float scale)` Updates chart data with given scale.
`void`	`callTouchListener()`
`void`	`cancelDataAnimation()` Stops chart data animation.
`AxesRenderer`	`getAxesRenderer()`
`ChartComputator`	`getChartComputator()`
`ChartData`	`getChartData()` Returns generic chart data.
`ChartRenderer`	`getChartRenderer()`
`Viewport`	`getCurrentViewport()` Returns current viewport.
`Viewport`	`getMaximumViewport()` Returns maximum viewport for this chart.
`float`	`getMaxZoom()` Returns current maximum zoom value.
`SelectedValue`	`getSelectedValue()` Return currently selected value indexes.
`ChartTouchHandler`	`getTouchHandler()`
`float`	`getZoomLevel()` Returns current zoom level.
`ZoomType`	`getZoomType()` Returns current zoom type for this chart.
`boolean`	`isContainerScrollEnabled()`
`boolean`	`isInteractive()` Returns true if chart is interactive.
`boolean`	`isScrollEnabled()` Returns true if scrolling is enabled.
`boolean`	`isValueSelectionEnabled()` Return true if value selection mode is enabled.
`boolean`	`isValueTouchEnabled()` Return true if chart value can be touched.
`boolean`	`isViewportCalculationEnabled()` Return true if auto viewports recalculations are enabled, false otherwise.
`boolean`	`isZoomEnabled()` Returns true if pitch to zoom and double tap zoom is enabled.
`void`	`moveTo(float x, float y)` Move/Srcoll viewport to position x,y(that position must be within maximum chart viewport).
`void`	`moveToWithAnimation(float x, float y)` Animate viewport to position x,y(that position must be within maximum chart viewport).
`void`	`resetViewports()` Reset maximum viewport and current viewport.
`void`	`selectValue(SelectedValue selectedValue)` Select single value on chart.
`void`	`setChartRenderer(ChartRenderer renderer)`
`void`	`setContainerScrollEnabled(boolean isContainerScrollEnabled, ContainerScrollType containerScrollType)` Set isContainerScrollEnabled to true and containerScrollType to HORIZONTAL or VERTICAL if you are using chart within scroll container.
`void`	`setCurrentViewport(Viewport targetViewport)` Sets current viewport.
`void`	`setCurrentViewportWithAnimation(Viewport targetViewport)` Sets current viewport with animation.
`void`	`setCurrentViewportWithAnimation(Viewport targetViewport, long duration)` Sets current viewport with animation.
`void`	`setDataAnimationListener(ChartAnimationListener animationListener)` Set listener for data animation to be notified when data animation started and finished.
`void`	`setInteractive(boolean isInteractive)` Set true to allow user use touch gestures.
`void`	`setMaximumViewport(Viewport maxViewport)` Set maximum viewport.
`void`	`setMaxZoom(float maxZoom)` Set max zoom value.
`void`	`setScrollEnabled(boolean isScrollEnabled)` Set true to enable touch scroll/fling, false to disable touch scroll/fling, by default true;
`void`	`setValueSelectionEnabled(boolean isValueSelectionEnabled)` Set true if you want value selection with touch - value will stay selected until you touch somewhere else on the chart area.
`void`	`setValueTouchEnabled(boolean isValueTouchEnabled)` Set true if you want allow user to click value on chart, set false to disable that option.
`void`	`setViewportAnimationListener(ChartAnimationListener animationListener)` Set listener for viewport animation to be notified when viewport animation started and finished.
`void`	`setViewportCalculationEnabled(boolean isEnabled)` Set true to enable viewports(max and current) recalculations during animations or after set*ChartData method is called.
`void`	`setViewportChangeListener(ViewportChangeListener viewportChangeListener)` Set listener for current viewport changes.
`void`	`setZoomEnabled(boolean isZoomEnabled)` Set true to enable zoom, false to disable, by default true;
`void`	`setZoomLevel(float x, float y, float zoomLevel)` Programatically zoom chart to given point(viewport point).
`void`	`setZoomLevelWithAnimation(float x, float y, float zoomLevel)` Programatically zoom chart to given point(viewport point) with animation.
`void`	`setZoomType(ZoomType zoomType)` Set zoom type, available options: ZoomType.HORIZONTAL_AND_VERTICAL, ZoomType.HORIZONTAL, ZoomType.VERTICAL.
`void`	`startDataAnimation()` Starts chart data animation for given duration.
`void`	`startDataAnimation(long duration)` Starts chart data animation for given duration.

- Method Detail
  - getChartData
```
ChartData getChartData()
```
    Returns generic chart data. For specific class call get*ChartData method from data provider implementation.
  - getChartRenderer
```
ChartRenderer getChartRenderer()
```
  - setChartRenderer
```
void setChartRenderer(ChartRenderer renderer)
```
  - getAxesRenderer
```
AxesRenderer getAxesRenderer()
```
  - getChartComputator
```
ChartComputator getChartComputator()
```
  - getTouchHandler
```
ChartTouchHandler getTouchHandler()
```
  - animationDataUpdate
```
void animationDataUpdate(float scale)
```
    Updates chart data with given scale. Called during chart data animation update.
  - animationDataFinished
```
void animationDataFinished()
```
    Called when data animation finished.
  - startDataAnimation
```
void startDataAnimation()
```
    Starts chart data animation for given duration. Before you call this method you should change target values of chart data.
  - startDataAnimation
```
void startDataAnimation(long duration)
```
    Starts chart data animation for given duration. If duration is negative the default value of 500ms will be used. Before you call this method you should change target values of chart data.
  - cancelDataAnimation
```
void cancelDataAnimation()
```
    Stops chart data animation. All chart data values are set to their target values.
  - isViewportCalculationEnabled
```
boolean isViewportCalculationEnabled()
```
    Return true if auto viewports recalculations are enabled, false otherwise.
  - setViewportCalculationEnabled
```
void setViewportCalculationEnabled(boolean isEnabled)
```
    Set true to enable viewports(max and current) recalculations during animations or after set*ChartData method is called. If you disable viewports calculations viewports will not change until you change them manually or enable calculations again. Disabled viewport calculations is usefull if you want show only part of chart by setting custom viewport and don't want any operation to change that viewport
  - setDataAnimationListener
```
void setDataAnimationListener(ChartAnimationListener animationListener)
```
    Set listener for data animation to be notified when data animation started and finished. By default that flag is set to true so be careful with animation and custom viewports.
  - setViewportAnimationListener
```
void setViewportAnimationListener(ChartAnimationListener animationListener)
```
    Set listener for viewport animation to be notified when viewport animation started and finished.
  - setViewportChangeListener
```
void setViewportChangeListener(ViewportChangeListener viewportChangeListener)
```
    Set listener for current viewport changes. It will be called when viewport change either by gesture or programmatically. Note! This method works only for preview charts. It is intentionally disabled for other types of charts to avoid unnecessary method calls during invalidation.
  - callTouchListener
```
void callTouchListener()
```
  - isInteractive
```
boolean isInteractive()
```
    Returns true if chart is interactive.
    
    See Also:
    
    setInteractive(boolean)
  - setInteractive
```
void setInteractive(boolean isInteractive)
```
    Set true to allow user use touch gestures. If set to false user will not be able zoom, scroll or select/touch value. By default true.
  - isZoomEnabled
```
boolean isZoomEnabled()
```
    Returns true if pitch to zoom and double tap zoom is enabled.
    
    See Also:
    
    setZoomEnabled(boolean)
  - setZoomEnabled
```
void setZoomEnabled(boolean isZoomEnabled)
```
    Set true to enable zoom, false to disable, by default true;
  - isScrollEnabled
```
boolean isScrollEnabled()
```
    Returns true if scrolling is enabled.
    
    See Also:
    
    setScrollEnabled(boolean)
  - setScrollEnabled
```
void setScrollEnabled(boolean isScrollEnabled)
```
    Set true to enable touch scroll/fling, false to disable touch scroll/fling, by default true;
  - moveTo
```
void moveTo(float x,
            float y)
```
    Move/Srcoll viewport to position x,y(that position must be within maximum chart viewport). If possible viewport will be centered at this point. Width and height of viewport will not be modified.
    
    See Also:
    
    setCurrentViewport(lecho.lib.hellocharts.model.Viewport)
  - moveToWithAnimation
```
void moveToWithAnimation(float x,
                         float y)
```
    Animate viewport to position x,y(that position must be within maximum chart viewport). If possible viewport will be centered at this point. Width and height of viewport will not be modified.
    
    See Also:
    
    ;
  - getZoomType
```
ZoomType getZoomType()
```
    Returns current zoom type for this chart.
    
    See Also:
    
    setZoomType(ZoomType)
  - setZoomType
```
void setZoomType(ZoomType zoomType)
```
    Set zoom type, available options: ZoomType.HORIZONTAL_AND_VERTICAL, ZoomType.HORIZONTAL, ZoomType.VERTICAL. By default HORIZONTAL_AND_VERTICAL.
  - getMaxZoom
```
float getMaxZoom()
```
    Returns current maximum zoom value.
  - setMaxZoom
```
void setMaxZoom(float maxZoom)
```
    Set max zoom value. Default maximum zoom is 20.
  - getZoomLevel
```
float getZoomLevel()
```
    Returns current zoom level.
  - setZoomLevel
```
void setZoomLevel(float x,
                  float y,
                  float zoomLevel)
```
    Programatically zoom chart to given point(viewport point). Call this method after chart data had been set.
    
    Parameters:
    
    x - x within chart maximum viewport
    
    y - y within chart maximum viewport
    
    zoomLevel - value from 1 to maxZoom(default 20). 1 means chart has no zoom.
  - setZoomLevelWithAnimation
```
void setZoomLevelWithAnimation(float x,
                               float y,
                               float zoomLevel)
```
    Programatically zoom chart to given point(viewport point) with animation. Call this method after chart data had been set.
    
    Parameters:
    
    x - x within chart maximum viewport
    
    y - y within chart maximum viewport
    
    zoomLevel - value from 1 to maxZoom(default 20). 1 means chart has no zoom.
  - isValueTouchEnabled
```
boolean isValueTouchEnabled()
```
    Return true if chart value can be touched.
    
    See Also:
    
    setValueTouchEnabled(boolean)
  - setValueTouchEnabled
```
void setValueTouchEnabled(boolean isValueTouchEnabled)
```
    Set true if you want allow user to click value on chart, set false to disable that option. By default true.
  - getMaximumViewport
```
Viewport getMaximumViewport()
```
    Returns maximum viewport for this chart. Don't modify it directly, use setMaximumViewport(Viewport) instead.
    
    See Also:
    
    setMaximumViewport(Viewport)
  - setMaximumViewport
```
void setMaximumViewport(Viewport maxViewport)
```
    Set maximum viewport. If you set bigger maximum viewport data will be more concentrate and there will be more empty spaces on sides. Note. MaxViewport have to be set after chartData has been set.
  - getCurrentViewport
```
Viewport getCurrentViewport()
```
    Returns current viewport. Don't modify it directly, use setCurrentViewport(Viewport) instead.
    
    See Also:
    
    setCurrentViewport(Viewport)
  - setCurrentViewport
```
void setCurrentViewport(Viewport targetViewport)
```
    Sets current viewport. Note. viewport have to be set after chartData has been set.
  - setCurrentViewportWithAnimation
```
void setCurrentViewportWithAnimation(Viewport targetViewport)
```
    Sets current viewport with animation. Note. viewport have to be set after chartData has been set.
  - setCurrentViewportWithAnimation
```
void setCurrentViewportWithAnimation(Viewport targetViewport,
                                     long duration)
```
    Sets current viewport with animation. Note. viewport have to be set after chartData has been set.
  - resetViewports
```
void resetViewports()
```
    Reset maximum viewport and current viewport. Values for both viewports will be auto-calculated using current chart data ranges.
  - isValueSelectionEnabled
```
boolean isValueSelectionEnabled()
```
    Return true if value selection mode is enabled.
    
    See Also:
    
    setValueSelectionEnabled(boolean)
  - setValueSelectionEnabled
```
void setValueSelectionEnabled(boolean isValueSelectionEnabled)
```
    Set true if you want value selection with touch - value will stay selected until you touch somewhere else on the chart area. By default false and value is automatically unselected when user stop pressing on it.
  - selectValue
```
void selectValue(SelectedValue selectedValue)
```
    Select single value on chart. If indexes are not valid IndexOutOfBoundsException will be thrown.
  - getSelectedValue
```
SelectedValue getSelectedValue()
```
    Return currently selected value indexes.
  - isContainerScrollEnabled
```
boolean isContainerScrollEnabled()
```
    See Also:
    
    setContainerScrollEnabled(boolean, ContainerScrollType)
  - setContainerScrollEnabled
```
void setContainerScrollEnabled(boolean isContainerScrollEnabled,
                               ContainerScrollType containerScrollType)
```
    Set isContainerScrollEnabled to true and containerScrollType to HORIZONTAL or VERTICAL if you are using chart within scroll container.

Interface Chart

Method Summary

Method Detail

getChartData

getChartRenderer

setChartRenderer

getAxesRenderer

getChartComputator

getTouchHandler

animationDataUpdate

animationDataFinished

startDataAnimation

startDataAnimation

cancelDataAnimation

isViewportCalculationEnabled

setViewportCalculationEnabled

setDataAnimationListener

setViewportAnimationListener

setViewportChangeListener

callTouchListener

isInteractive

setInteractive

isZoomEnabled

setZoomEnabled

isScrollEnabled

setScrollEnabled

moveTo

moveToWithAnimation

getZoomType

setZoomType

getMaxZoom

setMaxZoom

getZoomLevel

setZoomLevel

setZoomLevelWithAnimation

isValueTouchEnabled

setValueTouchEnabled

getMaximumViewport

setMaximumViewport

getCurrentViewport

setCurrentViewport

setCurrentViewportWithAnimation

setCurrentViewportWithAnimation

resetViewports

isValueSelectionEnabled

setValueSelectionEnabled

selectValue

getSelectedValue

isContainerScrollEnabled

setContainerScrollEnabled