org.pepstock.charba.client.options

Class Arc

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

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

org.pepstock.charba.client.options.Arc

All Implemented Interfaces:

IsDefaultArc, IsDefaultOptionsElement

public class Arc
extends AbstractElement<IsDefaultArc>
implements IsDefaultArc

Arcs are used in the polar area, doughnut and pie charts.

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.
double	getAngle() Returns the arc angle to cover.
BorderAlign	getBorderAlign() Returns the property to set the border alignment on chart datasets.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
protected P	getParent() Returns the parent element.
double	getWeight() Returns the relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.
void	setAngle(double angle) Sets the arc angle to cover.
void	setBorderAlign(BorderAlign align) Sets the property to set the border alignment on chart datasets.
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	setWeight(double weight) Sets the relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.

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

setBorderAlign

public void setBorderAlign(BorderAlign align)

Sets the property to set the border alignment on chart datasets.

Parameters:

align - the property to set the border alignment on chart datasets

getBorderAlign

public BorderAlign getBorderAlign()

Returns the property to set the border alignment on chart datasets.

Specified by:

getBorderAlign in interface IsDefaultArc

Returns:

the property to set the border alignment on chart datasets.

setWeight

public void setWeight(double weight)

Sets the relative thickness of the dataset.
Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.

Parameters:

weight - the relative thickness of the dataset

getWeight

public double getWeight()

Returns the relative thickness of the dataset.
Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.

Specified by:

getWeight in interface IsDefaultArc

Returns:

the relative thickness of the dataset

setAngle

public void setAngle(double angle)

Sets the arc angle to cover.

Parameters:

angle - the arc angle to cover

getAngle

public double getAngle()

Returns the arc angle to cover.

Specified by:

getAngle in interface IsDefaultArc

Returns:

the arc angle to cover

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.