org.pepstock.charba.client.options

Class AngleLines

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AngleLines

All Implemented Interfaces:

IsDefaultAngleLines

public final class AngleLines
extends NativeObjectContainer
implements IsDefaultAngleLines

It is used to configure angled lines that radiate from the center of the chart to the point labels.
Note that these options only apply if display is true.

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.
List<Integer>	getBorderDash() Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
int	getBorderDashOffset() Returns the line dash pattern offset or "phase".
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
IsColor	getColor() Returns the color of angled lines.
String	getColorAsString() Returns the color of angled lines.
protected D	getDefaultValues() Returns the default provider instance.
int	getLineWidth() Returns the width of angled lines.
protected P	getParent() Returns the parent element.
boolean	isDisplay() If true, angle lines are shown
void	setBorderDash(int... borderDash) Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
void	setBorderDashOffset(int borderDashOffset) Sets the line dash pattern offset or "phase".
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.
void	setColor(IsColor color) Sets the color of angled lines.
void	setColor(String color) Sets the color of angled lines.
void	setDisplay(boolean display) If true, angle lines are shown
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	setLineWidth(int lineWidth) Sets the width of angled lines.

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.IsDefaultAngleLines

getBorderDashOffset

Method Detail

setDisplay

public void setDisplay(boolean display)

If true, angle lines are shown

Parameters:

display - if true, angle lines are shown

isDisplay

public boolean isDisplay()

If true, angle lines are shown

Specified by:

isDisplay in interface IsDefaultAngleLines

Returns:

if true, angle lines are shown.

setColor

public void setColor(IsColor color)

Sets the color of angled lines.

Parameters:

color - color of angled lines.

setColor

public void setColor(String color)

Sets the color of angled lines.

Parameters:

color - color of angled lines.

getColorAsString

public String getColorAsString()

Returns the color of angled lines.

Specified by:

getColorAsString in interface IsDefaultAngleLines

Returns:

color of angled lines.

getColor

public IsColor getColor()

Returns the color of angled lines.

Returns:

color of angled lines.

setLineWidth

public void setLineWidth(int lineWidth)

Sets the width of angled lines.

Parameters:

lineWidth - width of angled lines.

getLineWidth

public int getLineWidth()

Returns the width of angled lines.

Specified by:

getLineWidth in interface IsDefaultAngleLines

Returns:

width of angled lines.

setBorderDash

public final void setBorderDash(int... borderDash)

Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

Parameters:

borderDash - the line dash pattern used when stroking lines

getBorderDash

public final List<Integer> getBorderDash()

Returns the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.

Returns:

the line dash pattern used when stroking lines

setBorderDashOffset

public final void setBorderDashOffset(int borderDashOffset)

Sets the line dash pattern offset or "phase".

Parameters:

borderDashOffset - Offset for line dashes.

getBorderDashOffset

public final int getBorderDashOffset()

Returns the line dash pattern offset or "phase".

Returns:

Offset for line dashes.

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.