Package org.pepstock.charba.client.defaults.globals

Class DefaultArc

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultArc

All Implemented Interfaces:

IsDefaultArc, IsDefaultOptionsElement

public final class DefaultArc
extends Object
implements IsDefaultArc

CHART.JS default values for ARC element.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
double	getAngle()	Returns the arc angle to cover.
String	getBackgroundColorAsString()	Returns the background color.
BorderAlign	getBorderAlign()	Returns the property to set the border alignment on chart datasets.
String	getBorderColorAsString()	Returns the border color.
int	getBorderRadius()	Returns the arc border radius (in pixels).
int	getBorderWidth()	Returns the border width.
String	getHoverBackgroundColorAsString()	Returns the background color when hovered.
String	getHoverBorderColorAsString()	Returns the border color when hovered.
int	getHoverBorderWidth()	Returns the border width when hovered.
int	getHoverOffset()	Returns the arc offset (in pixels) when hovered.
int	getOffset()	Returns the arc offset (in pixels).
int	getSpacing()	Returns the fixed arc offset (in pixels). Similar to offset but applies to all arcs.
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.
boolean	isCircular()	Returns true if the arc is curved.

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

getBorderJoinStyle, getHoverBorderJoinStyle

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

getBackgroundColorAsString, getBorderColorAsString, getBorderWidth, getHoverBackgroundColorAsString, getHoverBorderColorAsString, getHoverBorderWidth

Method Detail

getBorderAlign

public BorderAlign getBorderAlign()

Description copied from interface: IsDefaultArc

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.

getWeight

public double getWeight()

Description copied from interface: IsDefaultArc

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

getAngle

public double getAngle()

Description copied from interface: IsDefaultArc

Returns the arc angle to cover.

Specified by:

getAngle in interface IsDefaultArc

Returns:

the arc angle to cover

getOffset

public int getOffset()

Description copied from interface: IsDefaultArc

Returns the arc offset (in pixels).

Specified by:

getOffset in interface IsDefaultArc

Returns:

the arc offset

getBorderRadius

public int getBorderRadius()

Description copied from interface: IsDefaultArc

Returns the arc border radius (in pixels).

Specified by:

getBorderRadius in interface IsDefaultArc

Returns:

the arc border radius (in pixels).

getHoverOffset

public int getHoverOffset()

Description copied from interface: IsDefaultArc

Returns the arc offset (in pixels) when hovered.

Specified by:

getHoverOffset in interface IsDefaultArc

Returns:

the arc offset when hovered

getSpacing

public int getSpacing()

Description copied from interface: IsDefaultArc

Returns the fixed arc offset (in pixels).
Similar to offset but applies to all arcs.

Specified by:

getSpacing in interface IsDefaultArc

Returns:

the fixed arc offset (in pixels)

isCircular

public boolean isCircular()

Description copied from interface: IsDefaultArc

Returns true if the arc is curved.

Specified by:

isCircular in interface IsDefaultArc

Returns:

true if the arc is curved

getBackgroundColorAsString

public final String getBackgroundColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the background color.

Specified by:

getBackgroundColorAsString in interface IsDefaultOptionsElement

Returns:

the background color.

getBorderWidth

public final int getBorderWidth()

Description copied from interface: IsDefaultOptionsElement

Returns the border width.

Specified by:

getBorderWidth in interface IsDefaultOptionsElement

Returns:

the border width.

getBorderColorAsString

public final String getBorderColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the border color.

Specified by:

getBorderColorAsString in interface IsDefaultOptionsElement

Returns:

the border color.

getHoverBackgroundColorAsString

public String getHoverBackgroundColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the background color when hovered.

Specified by:

getHoverBackgroundColorAsString in interface IsDefaultOptionsElement

Returns:

the background color when hovered.

getHoverBorderWidth

public int getHoverBorderWidth()

Description copied from interface: IsDefaultOptionsElement

Returns the border width when hovered.

Specified by:

getHoverBorderWidth in interface IsDefaultOptionsElement

Returns:

the border width when hovered.

getHoverBorderColorAsString

public String getHoverBorderColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the border color when hovered.

Specified by:

getHoverBorderColorAsString in interface IsDefaultOptionsElement

Returns:

the border color when hovered.