com.aquafold.openapi.chart
Interface AQChartRow

public interface AQChartRow

ChartRow

Synopsis:

ChartRow represents one row of chart data.

Description:
A ChartRow contains a category and a list of values, one for each series in the model.

Method Summary

Object	getCategory() Get the category object for the row.
double	getCategoryNumeric() Get a numeric representation of the category object.
int	getOriginalRowIndex() Get the index of this row in its original datasource (if any exists).
List<Number>	getValues() Get this row's list of values, where value[0] is from series 0, value[1] is from series 1, etc.
void	setCategory(Object category) Set the category object for the row.
void	setCategoryNumeric(double categoryNumeric) Set the numeric representation of the category object.
void	setOriginalRowIndex(int originalRowIndex) Set the index of this row in its original datasource (if any exists).
void	setValues(List<Number> values) Set this row's list of values, where value[0] is from series 0, value[1] is from series 1, etc.

Method Detail

getCategory

Object getCategory()

Get the category object for the row.

If this value is a Date, Time, DateTime or Number, then it will be rendered in the Chart using the appropriate formatter. The default format is defined by the application. The AQChartProperties contains format properties which can override the defaults.

Returns:

Category object

setCategory

void setCategory(Object category)

Set the category object for the row.

If this value is a Date, Time, DateTime or Number, then it will be rendered in the Chart using the appropriate formatter. The default format is defined by the application. The AQChartProperties contains format properties which can override the defaults.

Parameters:

category - Category object

getValues

List<Number> getValues()

Get this row's list of values, where value[0] is from series 0, value[1] is from series 1, etc.

Returns:

List of numbers, one for each series in the data model

setValues

void setValues(List<Number> values)

Set this row's list of values, where value[0] is from series 0, value[1] is from series 1, etc.

Parameters:

values - List of numbers, one for each series in the data model

getCategoryNumeric

double getCategoryNumeric()

Get a numeric representation of the category object. Defaults to zero, if the category object is not a numeric type.

Returns:

numeric representation of the category object

setCategoryNumeric

void setCategoryNumeric(double categoryNumeric)

Set the numeric representation of the category object.

Parameters:

categoryNumeric - numeric representation of the category object

getOriginalRowIndex

int getOriginalRowIndex()

Get the index of this row in its original datasource (if any exists).

Returns:

Index of this row in the original datasource (if any exists)

setOriginalRowIndex

void setOriginalRowIndex(int originalRowIndex)

Set the index of this row in its original datasource (if any exists).

Parameters:

originalRowIndex - Index of this row in the original table model (if any exists)