org.pepstock.charba.client

Interface Controller

All Known Implementing Classes:

AbstractController

public interface Controller

This interface enables the capability to create a custom chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
void	addElementAndReset(Context jsThis, AbstractChart<?,?> chart, int index) Create a single element for the data at the given index and reset its state.
void	addElements(Context jsThis, AbstractChart<?,?> chart) Create elements for each piece of data in the dataset.
void	draw(Context jsThis, AbstractChart<?,?> chart, double ease) Draw the representation of the dataset.
ChartType	getChartType() Controller must define the extended chart to use. If the controller does not extend any existing chart, returns null
Type	getType() Controller must define a unique id in order to be configurable. Returns the controller id.
void	initialize(Context jsThis, AbstractChart<?,?> chart, int datasetIndex) Initializes the controller.
void	removeHoverStyle(Context jsThis, AbstractChart<?,?> chart, StyleElement element) Remove hover styling from the given element.
void	setHoverStyle(Context jsThis, AbstractChart<?,?> chart, StyleElement element) Add hover styling to the given element.
void	update(Context jsThis, AbstractChart<?,?> chart, boolean reset) Update the elements in response to new data.

Method Detail

getType

Type getType()

Controller must define a unique id in order to be configurable.
Returns the controller id.

Returns:

the controller id.

getChartType

ChartType getChartType()

Controller must define the extended chart to use.
If the controller does not extend any existing chart, returns null

Returns:

chart type extended by controller. null if the controller does not extend any chart.

initialize

void initialize(Context jsThis,
                AbstractChart<?,?> chart,
                int datasetIndex)

Initializes the controller.

Parameters:

jsThis - context of controller

chart - chart instance

datasetIndex - dataset index

addElements

void addElements(Context jsThis,
                 AbstractChart<?,?> chart)

Create elements for each piece of data in the dataset. Store elements in an array on the dataset.

Parameters:

jsThis - context of controller

chart - chart instance

addElementAndReset

void addElementAndReset(Context jsThis,
                        AbstractChart<?,?> chart,
                        int index)

Create a single element for the data at the given index and reset its state.

Parameters:

jsThis - context of controller

chart - chart instance

index - dataset index

draw

void draw(Context jsThis,
          AbstractChart<?,?> chart,
          double ease)

Draw the representation of the dataset.

Parameters:

jsThis - context of controller

chart - chart instance

ease - if specified, this number represents how far to transition elements.

removeHoverStyle

void removeHoverStyle(Context jsThis,
                      AbstractChart<?,?> chart,
                      StyleElement element)

Remove hover styling from the given element.

Parameters:

jsThis - context of controller

chart - chart instance

element - element to be removed.

setHoverStyle

void setHoverStyle(Context jsThis,
                   AbstractChart<?,?> chart,
                   StyleElement element)

Add hover styling to the given element.

Parameters:

jsThis - context of controller

chart - chart instance

element - element to be set.

update

void update(Context jsThis,
            AbstractChart<?,?> chart,
            boolean reset)

Update the elements in response to new data.

Parameters:

jsThis - context of controller

chart - chart instance

reset - if true, put the elements into a reset state so they can animate to their final values