org.pepstock.charba.client.impl.plugins.enums

Enum GoogleChartScheme

java.lang.Object

java.lang.Enum<GoogleChartScheme>

org.pepstock.charba.client.impl.plugins.enums.GoogleChartScheme

All Implemented Interfaces:

Serializable, Comparable<GoogleChartScheme>

public enum GoogleChartScheme
extends Enum<GoogleChartScheme>

Contains all scheme definitions to map the Google chart schemes.
To configure ColorSchemes.ID plugin, where category is "googlechart".
Every color scheme has a number at the end of its name, which indicates the number of that colors included in the scheme.
If the number of the datasets is larger than it, the same colors will appear repeatedly.
A color is not modified if it is specified by dataset options.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Color scheme name "ALL" -
EIGHT Color scheme name "EIGHT" -
SIXTEEN Color scheme name "SIXTEEN" -
TWELVE Color scheme name "TWELVE" -
TWENTY Color scheme name "TWENTY" -
TWENTY_FOUR Color scheme name "TWENTY_FOUR" -

Method Summary

Modifier and Type	Method and Description
default String	category() Returns the color scheme category.
default Gradient	createGradient() Creates a LINEAR gradient, with topDown orientation and chart scope.
default Gradient	createGradient(GradientType type) Creates a gradient by a type, with chart scope.
default Gradient	createGradient(GradientType type, GradientOrientation orientation) Creates a gradient by a type and an orientation, with chart scope.
default Gradient	createGradient(GradientType type, GradientOrientation orientation, GradientScope scope) Creates a gradient by a type, an orientation and a scope.
default Gradient	createGradient(GradientType type, GradientScope scope) Creates a gradient by a type and a scope.
default List<IsColor>	getColors() Returns a list of colors which are composing a color scheme.
ColorScheme	getScheme() Returns the internal enumerated scheme instance.
default String	value() Returns the name value of property
static GoogleChartScheme	valueOf(String name) Returns the enum constant of this type with the specified name.
static GoogleChartScheme[]	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.impl.plugins.ColorScheme

isValid

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

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

EIGHT

public static final GoogleChartScheme EIGHT

Color scheme name "EIGHT" -

TWELVE

public static final GoogleChartScheme TWELVE

Color scheme name "TWELVE" -

SIXTEEN

public static final GoogleChartScheme SIXTEEN

Color scheme name "SIXTEEN" -

TWENTY

public static final GoogleChartScheme TWENTY

Color scheme name "TWENTY" -

TWENTY_FOUR

public static final GoogleChartScheme TWENTY_FOUR

Color scheme name "TWENTY_FOUR" -

ALL

public static final GoogleChartScheme ALL

Color scheme name "ALL" -

Method Detail

values

public static GoogleChartScheme[] 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 (GoogleChartScheme c : GoogleChartScheme.values())
    System.out.println(c);

Returns:

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

valueOf

public static GoogleChartScheme 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

getScheme

public ColorScheme getScheme()

Returns the internal enumerated scheme instance.

Returns:

the internal enumerated scheme instance

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property

category

public String category()

Description copied from interface: ColorScheme

Returns the color scheme category. If not implemented, the default is ColorSchemesOptions.DEFAULT_SCHEME_CATEGORY.

Specified by:

category in interface ColorScheme

Returns:

the color scheme category. If not implemented, the default is ColorSchemesOptions.DEFAULT_SCHEME_CATEGORY

getColors

public List<IsColor> getColors()

Description copied from interface: ColorScheme

Returns a list of colors which are composing a color scheme.

Specified by:

getColors in interface ColorScheme

Returns:

a list of colors which are composing a color scheme

createGradient

public Gradient createGradient()

Creates a LINEAR gradient, with topDown orientation and chart scope.

Returns:

new gradient based on color scheme

createGradient

public Gradient createGradient(GradientType type)

Creates a gradient by a type, with chart scope.

Parameters:

type - gradient type

Returns:

new gradient based on color scheme

createGradient

public Gradient createGradient(GradientType type,
                               GradientOrientation orientation)

Creates a gradient by a type and an orientation, with chart scope.

Parameters:

type - gradient type

orientation - orientation of gradient

Returns:

new gradient based on color scheme

createGradient

public Gradient createGradient(GradientType type,
                               GradientScope scope)

Creates a gradient by a type and a scope.

Parameters:

type - gradient type

scope - scope of gradient

Returns:

new gradient based on color scheme

createGradient

public Gradient createGradient(GradientType type,
                               GradientOrientation orientation,
                               GradientScope scope)

Creates a gradient by a type, an orientation and a scope.

Parameters:

type - gradient type

orientation - orientation of gradient

scope - scope of gradient

Returns:

new gradient based on color scheme