public final class ColorSchemesOptions extends AbstractPluginOptions
ColorSchemes.ID
plugin options, both at chart and global level.Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_BACKGROUND_ALPHA
Default transparency value for the background color, 0.5.
|
static boolean |
DEFAULT_REVERSE
Default the order of the colors in the selected scheme is reversed, false.
|
static ColorScheme |
DEFAULT_SCHEME
Default color scheme,
BrewerScheme.PAIRED12 . |
static String |
DEFAULT_SCHEME_CATEGORY
Default category when new color scheme has been created on top of the available schemes,
"custom".
|
static SchemeScope |
DEFAULT_SCHEME_SCOPE
Default color scheme scope (for bar and bubble charts),
SchemeScope.DATASET . |
Constructor and Description |
---|
ColorSchemesOptions()
Creates an empty object with plugin options.
|
Modifier and Type | Method and Description |
---|---|
double |
getBackgroundColorAlpha()
The transparency value for the background color.
|
ColorScheme |
getScheme()
Returns the color scheme.
|
SchemeScope |
getSchemeScope()
Returns the color scheme scope when the scheme is applied to hoving flex datasets, like bars charts.
|
boolean |
isReverse()
If set to
true , the order of the colors in the selected scheme is reversed. |
void |
setBackgroundColorAlpha(double backgroundColorAlpha)
The transparency value for the background color.
|
void |
setReverse(boolean reverse)
If set to
true , the order of the colors in the selected scheme is reversed. |
void |
setScheme(ColorScheme scheme)
Sets the color scheme.
|
void |
setSchemeScope(SchemeScope schemeScope)
Sets the color scheme scope when the scheme is applied to hoving flex datasets, like bars charts.
|
getId, getPluginId, loadGlobalsPluginOptions, store, store
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
public static final ColorScheme DEFAULT_SCHEME
BrewerScheme.PAIRED12
.public static final SchemeScope DEFAULT_SCHEME_SCOPE
SchemeScope.DATASET
.public static final double DEFAULT_BACKGROUND_ALPHA
public static final boolean DEFAULT_REVERSE
public static final String DEFAULT_SCHEME_CATEGORY
public ColorSchemesOptions()
public void setSchemeScope(SchemeScope schemeScope)
schemeScope
- the color scheme scope when the scheme is applied to hoving flex datasets, like bars charts.public SchemeScope getSchemeScope()
public void setScheme(ColorScheme scheme)
scheme
- the color scheme.public ColorScheme getScheme()
public void setBackgroundColorAlpha(double backgroundColorAlpha)
backgroundColorAlpha
- the transparency value for the background colorpublic double getBackgroundColorAlpha()
public void setReverse(boolean reverse)
true
, the order of the colors in the selected scheme is reversed.reverse
- if set to true
, the order of the colors in the selected scheme is reversedpublic boolean isReverse()
true
, the order of the colors in the selected scheme is reversed.true
, the order of the colors in the selected scheme is reversed