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

Class DefaultScaleBorder

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultScaleBorder

All Implemented Interfaces:

IsDefaultScaleBorder

public final class DefaultScaleBorder
extends Object
implements IsDefaultScaleBorder

CHART.JS default values for BORDER element.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
String	getColorAsString()	If set, used as the color of the border line. If unset, the first color option is resolved and used.
List<Integer>	getDash()	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.
double	getDashOffset()	Returns the line dash pattern offset.
int	getWidth()	If set, used as the width of the border line. If unset, the first lineWidth option is resolved and used.
int	getZ()	Returns z-index of border layer. Values less than or equals to 0 are drawn under data sets, greater than 0 on top.
boolean	isDisplay()	If true, draw border at the edge between the axis and the chart area.

Methods inherited from class java.lang.Object

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

Method Detail

isDisplay

public boolean isDisplay()

Description copied from interface: IsDefaultScaleBorder

If true, draw border at the edge between the axis and the chart area.

Specified by:

isDisplay in interface IsDefaultScaleBorder

Returns:

if true, draw border at the edge between the axis and the chart area.

getWidth

public int getWidth()

Description copied from interface: IsDefaultScaleBorder

If set, used as the width of the border line.
If unset, the first lineWidth option is resolved and used.

Specified by:

getWidth in interface IsDefaultScaleBorder

Returns:

if set, used as the width of the border line.
If unset, the first lineWidth option is resolved and used.

getColorAsString

public String getColorAsString()

Description copied from interface: IsDefaultScaleBorder

If set, used as the color of the border line.
If unset, the first color option is resolved and used.

Specified by:

getColorAsString in interface IsDefaultScaleBorder

Returns:

if set, used as the color of the border line.
If unset, the first color option is resolved and used.

getDashOffset

public double getDashOffset()

Description copied from interface: IsDefaultScaleBorder

Returns the line dash pattern offset.

Specified by:

getDashOffset in interface IsDefaultScaleBorder

Returns:

offset for line dashes.

getDash

public List<Integer> getDash()

Description copied from interface: IsDefaultScaleBorder

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.

Specified by:

getDash in interface IsDefaultScaleBorder

Returns:

the line dash pattern used when stroking lines

getZ

public int getZ()

Description copied from interface: IsDefaultScaleBorder

Returns z-index of border layer.
Values less than or equals to 0 are drawn under data sets, greater than 0 on top.

Specified by:

getZ in interface IsDefaultScaleBorder

Returns:

z-index of border layer.
Values less than or equals to 0 are drawn under data sets, greater than 0 on top.