org.pepstock.charba.client.options

Class Point

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractElement<IsDefaultPoint>

org.pepstock.charba.client.options.Point

All Implemented Interfaces:

IsDefaultOptionsElement, IsDefaultPoint

public final class Point
extends AbstractElement<IsDefaultPoint>
implements IsDefaultPoint

Point elements are used to represent the points in a line chart or a bubble chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
double	getHitRadius() Returns the pixel size of the non-displayed point that reacts to mouse events.
int	getHoverBorderWidth() Returns the border width of point when hovered.
double	getHoverRadius() Returns the radius of the point when hovered.
protected P	getParent() Returns the parent element.
PointStyle	getPointStyle() Returns the style of the point.
ImageElement	getPointStyleAsImages() Returns the style of the point as image.
double	getRadius() Returns the radius of the point when hovered.
double	getRotation() Returns the point rotation (in degrees).
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.
void	setHitRadius(double hitRadius) Sets the pixel size of the non-displayed point that reacts to mouse events.
void	setHoverBorderWidth(int hoverBorderWidth) Sets the border width of point when hovered.
void	setHoverRadius(double hoverRadius) Sets the radius of the point when hovered.
void	setPointStyle(Image pointStyle) Sets the style of the point as image.
void	setPointStyle(ImageElement pointStyle) Sets the style of the point as image.
void	setPointStyle(ImageResource pointStyle) Sets the style of the point as image.
void	setPointStyle(PointStyle pointStyle) Sets the style of the point.
void	setRadius(double radius) Sets the radius of the point shape.
void	setRotation(double rotation) Sets the point rotation (in degrees).

Methods inherited from class org.pepstock.charba.client.options.AbstractElement

getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getBorderWidth, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderWidth

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

checkValue, empty, getArrayValue, 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, 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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultOptionsElement

getBackgroundColorAsString, getBorderColorAsString, getBorderWidth

Method Detail

setRadius

public void setRadius(double radius)

Sets the radius of the point shape. If set to 0, the point is not rendered.

Parameters:

radius - array of the radius of the point shape.

getRadius

public double getRadius()

Returns the radius of the point when hovered.

Specified by:

getRadius in interface IsDefaultPoint

Returns:

list of the radius of the point when hovered.

setPointStyle

public void setPointStyle(PointStyle pointStyle)

Sets the style of the point.

Parameters:

pointStyle - array of the style of the point.

getPointStyle

public PointStyle getPointStyle()

Returns the style of the point.

Specified by:

getPointStyle in interface IsDefaultPoint

Returns:

the style of the point or null if point style is set as image

setPointStyle

public void setPointStyle(ImageResource pointStyle)

Sets the style of the point as image.

Parameters:

pointStyle - image resource of the style of the point as image.

setPointStyle

public void setPointStyle(Image pointStyle)

Sets the style of the point as image.

Parameters:

pointStyle - image resource of the style of the point as image.

setPointStyle

public void setPointStyle(ImageElement pointStyle)

Sets the style of the point as image.

Parameters:

pointStyle - image element of the style of the point as image.

getPointStyleAsImages

public ImageElement getPointStyleAsImages()

Returns the style of the point as image. If property is missing or not an image, returns null.

Returns:

image of the style of the point as image. If property is missing or not a image, returns null.

setHitRadius

public void setHitRadius(double hitRadius)

Sets the pixel size of the non-displayed point that reacts to mouse events.

Parameters:

hitRadius - the pixel size of the non-displayed point.

getHitRadius

public double getHitRadius()

Returns the pixel size of the non-displayed point that reacts to mouse events.

Specified by:

getHitRadius in interface IsDefaultPoint

Returns:

the pixel size of the non-displayed point.

setHoverRadius

public void setHoverRadius(double hoverRadius)

Sets the radius of the point when hovered.

Parameters:

hoverRadius - the radius of the point when hovered.

getHoverRadius

public double getHoverRadius()

Returns the radius of the point when hovered.

Specified by:

getHoverRadius in interface IsDefaultPoint

Returns:

the radius of the point when hovered.

setHoverBorderWidth

public void setHoverBorderWidth(int hoverBorderWidth)

Sets the border width of point when hovered.

Parameters:

hoverBorderWidth - the border width of point when hovered.

getHoverBorderWidth

public int getHoverBorderWidth()

Returns the border width of point when hovered.

Specified by:

getHoverBorderWidth in interface IsDefaultPoint

Returns:

the border width of point when hovered.

setRotation

public void setRotation(double rotation)

Sets the point rotation (in degrees).

Parameters:

rotation - the point rotation (in degrees).

getRotation

public double getRotation()

Returns the point rotation (in degrees).

Specified by:

getRotation in interface IsDefaultPoint

Returns:

the point rotation (in degrees).

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.