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(ControllerContext context, IsChart chart, int index) Create a single element for the data at the given index and reset its state.
void	addElements(ControllerContext context, IsChart chart) Create elements for each piece of data in the dataset.
static void	checkIfValid(Controller controller) Checks if key passed as argument is not null and its type is valid as well.
void	draw(ControllerContext context, IsChart chart, double ease) Draw the representation of the dataset.
ControllerType	getType() Controller must define a unique id in order to be configurable. Returns the controller id.
void	initialize(ControllerContext context, IsChart chart, int datasetIndex) Initializes the controller.
static boolean	isConsistent(Controller controller, ControllerContext context, IsChart chart) Returns true if all arguments are consistent.
static boolean	isValid(Controller controller) Returns true if the controller is consistent.
void	removeHoverStyle(ControllerContext context, IsChart chart, StyleElement element) Remove hover styling from the given element.
void	setHoverStyle(ControllerContext context, IsChart chart, StyleElement element) Add hover styling to the given element.
void	update(ControllerContext context, IsChart chart, boolean reset) Update the elements in response to new data.

Method Detail

isConsistent

static boolean isConsistent(Controller controller,
                            ControllerContext context,
                            IsChart chart)

Returns true if all arguments are consistent.

Parameters:

controller - controller instance to check

context - controller context instance, should be provided by CHART.JS.

chart - chart instance

Returns:

true if all arguments are consistent

checkIfValid

static void checkIfValid(Controller controller)

Checks if key passed as argument is not null and its type is valid as well. If not, throw a IllegalArgumentException.

Parameters:

controller - controller instance to check

isValid

static boolean isValid(Controller controller)

Returns true if the controller is consistent.

Parameters:

controller - controller instance to check

Returns:

true if the controller is consistent

getType

ControllerType getType()

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

Returns:

the controller id.

initialize

void initialize(ControllerContext context,
                IsChart chart,
                int datasetIndex)

Initializes the controller.

Parameters:

context - context of controller

chart - chart instance

datasetIndex - dataset index

addElements

void addElements(ControllerContext context,
                 IsChart chart)

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

Parameters:

context - context of controller

chart - chart instance

addElementAndReset

void addElementAndReset(ControllerContext context,
                        IsChart chart,
                        int index)

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

Parameters:

context - context of controller

chart - chart instance

index - dataset index

draw

void draw(ControllerContext context,
          IsChart chart,
          double ease)

Draw the representation of the dataset.

Parameters:

context - context of controller

chart - chart instance

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

removeHoverStyle

void removeHoverStyle(ControllerContext context,
                      IsChart chart,
                      StyleElement element)

Remove hover styling from the given element.

Parameters:

context - context of controller

chart - chart instance

element - element to be removed.

setHoverStyle

void setHoverStyle(ControllerContext context,
                   IsChart chart,
                   StyleElement element)

Add hover styling to the given element.

Parameters:

context - context of controller

chart - chart instance

element - element to be set.

update

void update(ControllerContext context,
            IsChart chart,
            boolean reset)

Update the elements in response to new data.

Parameters:

context - context of controller

chart - chart instance

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