org.pepstock.charba.client.impl.plugins

Class ChartBackgroundColorOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.impl.plugins.ChartBackgroundColorOptions

public final class ChartBackgroundColorOptions
extends NativeObjectContainer

Configuration options of ChartBackgroundColor.ID plugin.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
ChartBackgroundColorOptions() Builds the object with new java script object setting the default value of plugin.

Method Summary

Modifier and Type	Method and Description
IsColor	getBackgroundColor() Returns the background color.
Gradient	getBackgroundColorAsGradient() Returns the background gradient.
Pattern	getBackgroundColorAsPattern() Returns the background pattern.
String	getBackgroundColorAsString() Returns the background color.
void	setBackgroundColor(Gradient gradient) Sets the background gradient.
void	setBackgroundColor(IsColor color) Sets the background color.
void	setBackgroundColor(Pattern pattern) Sets the background pattern.
void	setBackgroundColor(String color) Sets the background color.

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

checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, 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

Constructor Detail

ChartBackgroundColorOptions

public ChartBackgroundColorOptions()

Builds the object with new java script object setting the default value of plugin.

Method Detail

getBackgroundColorAsString

public String getBackgroundColorAsString()

Returns the background color. If it has been set a gradient or pattern, returns null, otherwise the default color, "white".

Returns:

the background color. If it has been set a gradient or pattern, returns null, otherwise the default color, "white".

getBackgroundColor

public IsColor getBackgroundColor()

Returns the background color. If it has been set a gradient or pattern, returns null, otherwise the default color, "white".

Returns:

the background color. If it has been set a gradient or pattern, returns null, otherwise the default color, "white".

getBackgroundColorAsGradient

public Gradient getBackgroundColorAsGradient()

Returns the background gradient. If it has been set a color or pattern, returns null.

Returns:

the background gradient. If it has been set a color or pattern, returns null

getBackgroundColorAsPattern

public Pattern getBackgroundColorAsPattern()

Returns the background pattern. If it has been set a color or gradient, returns null.

Returns:

the background pattern. If it has been set a color or pattern, returns null

setBackgroundColor

public void setBackgroundColor(String color)

Sets the background color.

Parameters:

color - the background color.

setBackgroundColor

public void setBackgroundColor(IsColor color)

Sets the background color.

Parameters:

color - the background color.

setBackgroundColor

public void setBackgroundColor(Gradient gradient)

Sets the background gradient.

Parameters:

gradient - the background gradient.

setBackgroundColor

public void setBackgroundColor(Pattern pattern)

Sets the background pattern.

Parameters:

pattern - the background pattern.