Package org.pepstock.charba.client.options

Class ScaleBorder

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.options.AbstractModel<AbstractScale,IsDefaultScaleBorder>

org.pepstock.charba.client.options.ScaleBorder

All Implemented Interfaces:

IsDefaultScaleBorder

public final class ScaleBorder
extends AbstractModel<AbstractScale,IsDefaultScaleBorder>
implements IsDefaultScaleBorder

Defines options for the border that run perpendicular to the axis.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
IsColor	getColor()	If set, used as the color of the border line. If unset, the first color option is resolved and used.
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.
int	getZ()	Returns z-index of border layer. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
boolean	isDisplay()	If true, draw border at the edge between the axis and the chart area.
void	setColor(String color)	If set, used as the color of the border line. If unset, the first color option is resolved and used.
void	setColor(IsColor color)	If set, used as the color of the border line. If unset, the first color option is resolved and used.
void	setDash(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	setDashOffset(double borderDashOffset)	Sets the line dash pattern offset.
void	setDisplay(boolean display)	If true, draw border at the edge between the axis and the chart area.
void	setWidth(int borderWidth)	If set, used as the width of the border line.
void	setZ(int z)	Sets z-index of border layer. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.

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

getDefaultValues, getParent, loadPadding, setCallbackToModel, setCallbackToModel, setEventToModel

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

checkAndAddToParent, getChildKey, getParentNode, getRootNode, getUpdateListener, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setUpdateListener, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent

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

checkAndGetColor, checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, 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

Method Detail

setDisplay

public void setDisplay(boolean display)

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

Parameters:

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

isDisplay

public boolean isDisplay()

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.

setColor

public void setColor(IsColor color)

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

Parameters:

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

setColor

public void setColor(String color)

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

Parameters:

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

getColorAsString

public String getColorAsString()

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.

getColor

public IsColor getColor()

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

Returns:

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

setDash

public final void setDash(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

getDash

public final 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.

Specified by:

getDash in interface IsDefaultScaleBorder

Returns:

the line dash pattern used when stroking lines

setDashOffset

public final void setDashOffset(double borderDashOffset)

Sets the line dash pattern offset.

Parameters:

borderDashOffset - Offset for line dashes.

getDashOffset

public final double getDashOffset()

Returns the line dash pattern offset.

Specified by:

getDashOffset in interface IsDefaultScaleBorder

Returns:

Offset for line dashes.

setWidth

public void setWidth(int borderWidth)

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

Parameters:

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

getWidth

public int getWidth()

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.

setZ

public void setZ(int z)

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

Parameters:

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

getZ

public int getZ()

Returns z-index of border layer.
Values less than or equals to 0 are drawn under datasets, 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 datasets, greater than 0 on top.