org.pepstock.charba.client.enums

Enum Fill

java.lang.Object

java.lang.Enum<Fill>

org.pepstock.charba.client.enums.Fill

All Implemented Interfaces:

Serializable, Comparable<Fill>, Key, IsFill

public enum Fill
extends Enum<Fill>
implements IsFill

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary.
These are the constants of predefined filling mode values.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
end Fill the area from the top X axis
nofill Does not fill any area
origin Fill the area from 0 axis to top or bottom, depending on value. Default.
start Fill the area from the bottom X axis

Method Summary

Modifier and Type	Method and Description
static IsFill	getFill(int index) Returns a fill, based on absolute dataset index, using the passed index.
static IsFill	getFill(String index) Returns a fill, based on relative dataset index, using the passed index. If the passed argument is not a relative dataset index, checks if is predefined fill.
FillingMode	getMode() Returns the type of filling.
String	getValue() Returns the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.
int	getValueAsInt() Returns the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.
static boolean	isPredefined(IsFill fill) Checks if the fill passed by argument is a predefined fill, the returns true.
static Fill	valueOf(String name) Returns the enum constant of this type with the specified name.
static Fill[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.commons.Key

name

Enum Constant Detail

start

public static final Fill start

Fill the area from the bottom X axis

end

public static final Fill end

Fill the area from the top X axis

origin

public static final Fill origin

Fill the area from 0 axis to top or bottom, depending on value.
Default.

nofill

public static final Fill nofill

Does not fill any area

Method Detail

values

public static Fill[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Fill c : Fill.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Fill valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMode

public FillingMode getMode()

Description copied from interface: IsFill

Returns the type of filling.

Specified by:

getMode in interface IsFill

Returns:

the type of filling.

getValueAsInt

public int getValueAsInt()

Description copied from interface: IsFill

Returns the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.

Specified by:

getValueAsInt in interface IsFill

Returns:

the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.

getValue

public String getValue()

Description copied from interface: IsFill

Returns the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.

Specified by:

getValue in interface IsFill

Returns:

the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.

isPredefined

public static boolean isPredefined(IsFill fill)

Checks if the fill passed by argument is a predefined fill, the returns true.

Parameters:

fill - fill instance

Returns:

true if the fill passed by argument is a predefined fill otherwise false.

getFill

public static IsFill getFill(int index)

Returns a fill, based on absolute dataset index, using the passed index.

Parameters:

index - absolute dataset index to use for filling

Returns:

a fill object with tthe right configuration to set into chart

getFill

public static IsFill getFill(String index)

Returns a fill, based on relative dataset index, using the passed index.
If the passed argument is not a relative dataset index, checks if is predefined fill.

Parameters:

index - relative dataset index to use for filling

Returns:

a fill object with the right configuration to set into chart.