org.pepstock.charba.client.data

Class DataPoint

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.DataPoint

public final class DataPoint
extends NativeObjectContainer

Used for sparse datasets, such as those in scatter charts. Each data point is specified using an object containing x and y properties.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
DataPoint() Creates the object with an empty native object.

Method Summary

Modifier and Type	Method and Description
double	getAttribute(Key key) Returns a custom field value from data point.
double	getR() Returns the bubble radius in pixels (not scaled).
Date	getT() Deprecated. use getXAsDate() instead.
double	getX() Returns X value as double (for scatter and bubble datasets).
Date	getXAsDate() Returns X value as date for time series.
String	getXAsString() Returns X value as string.
double	getY() Returns Y value.
void	setAttribute(Key key, double value) Sets a custom field to data point.
void	setR(double r) Sets the bubble radius in pixels (not scaled). It is not scaled by the chart, it is the raw radius in pixels of the bubble that is drawn on the canvas.
void	setT(Date t) Deprecated. use setX(Date) instead.
void	setX(Date x) Sets X value as date for time series.
void	setX(double x) Sets X value as double (for scatter and bubble datasets).
void	setX(String x) Sets X value as string.
void	setY(double y) Sets Y value.

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeChart, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataPoint

public DataPoint()

Creates the object with an empty native object.

Method Detail

setX

public void setX(double x)

Sets X value as double (for scatter and bubble datasets).

Parameters:

x - X value as double

getX

public double getX()

Returns X value as double (for scatter and bubble datasets).

Returns:

X value as double

setX

public void setX(Date x)

Sets X value as date for time series.

Parameters:

x - X value as date for time series

getXAsDate

public Date getXAsDate()

Returns X value as date for time series.

Returns:

X value as date for time series or null if is not set

setX

public void setX(String x)

Sets X value as string.

Parameters:

x - X value as string

getXAsString

public String getXAsString()

Returns X value as string.

Returns:

X value as string or UndefinedValues.STRING if is not set

setY

public void setY(double y)

Sets Y value.

Parameters:

y - Y value.

getY

public double getY()

Returns Y value.

Returns:

Y value.

setR

public void setR(double r)

Sets the bubble radius in pixels (not scaled).
It is not scaled by the chart, it is the raw radius in pixels of the bubble that is drawn on the canvas.

Parameters:

r - the bubble radius in pixels (not scaled).

getR

public double getR()

Returns the bubble radius in pixels (not scaled).

Returns:

the bubble radius in pixels (not scaled).

setT

@Deprecated
public void setT(Date t)

Deprecated. use setX(Date) instead.

Sets T value, is the date for time series.

Parameters:

t - T value.

getT

@Deprecated
public Date getT()

Deprecated. use getXAsDate() instead.

Returns T value, is the date for time series.

Returns:

T value or null if is not set.

setAttribute

public void setAttribute(Key key,
                         double value)

Sets a custom field to data point.

Parameters:

key - key of java script object to set.

value - value to set.

getAttribute

public double getAttribute(Key key)

Returns a custom field value from data point.

Parameters:

key - key of java script object to get.

Returns:

custom field value from data point. Default is UndefinedValues.DOUBLE.