org.pepstock.charba.client.impl.plugins

Class DatasetsItemsSelectorOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.plugins.AbstractPluginOptions

org.pepstock.charba.client.impl.plugins.DatasetsItemsSelectorOptions

public final class DatasetsItemsSelectorOptions
extends AbstractPluginOptions

Configuration options of DatasetsItemsSelector.ID plugin.
It is managing:

• the X axis ID
• the selection color
• the border color
• the border width
• the border dash
• the border dash offset
• if firing event on clear selection

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_ALPHA Default alpha of selecting/selection colors, 0.3.
static String	DEFAULT_AXIS_ID Default X axis id, Scales.DEFAULT_X_AXIS_ID.
static IsColor	DEFAULT_BORDER_COLOR Default border color for area, GwtMaterialColor.GREY_DARKEN_2.
static int	DEFAULT_BORDER_DASH_OFFSET Default border dash offset of selection area, 0.
static int	DEFAULT_BORDER_WIDTH Default border width of selection area, 0.
static IsColor	DEFAULT_COLOR Default color for area, GwtMaterialColor.ORANGE_LIGHTEN_3, alpha 0.3.
static boolean	DEFAULT_FIRE_EVENT_ON_CLEAR_SELECTION Default flag if fire event after clear selection, false.

Constructor Summary

Constructors

Constructor and Description
DatasetsItemsSelectorOptions() Builds the object with new java script object setting the default value of plugin. The global plugin options is used, if exists, as defaults values.
DatasetsItemsSelectorOptions(IsChart chart) Builds the object with a chart instance in order to get the right defaults. If the plugin options have not been set by chart type, it will use the global.

Method Summary

Modifier and Type	Method and Description
IsColor	getBorderColor() Returns the color.
String	getBorderColorAsString() Returns the color.
List<Integer>	getBorderDash() 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.
int	getBorderDashOffset() Returns the line dash pattern offset or "phase".
int	getBorderWidth() Returns the border width of the selection.
ClearSelection	getClearSelection() Returns the clear selection element.
IsColor	getColor() Returns the color.
String	getColorAsString() Returns the color.
String	getXAxisID() Returns the ID of the x axis to plot this dataset on.
boolean	isFireEventOnClearSelection() Returns true if it will fire event after clear of selection, otherwise false.
void	setBorderColor(IsColor color) Sets the color.
void	setBorderColor(String color) Sets the color.
void	setBorderDash(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	setBorderDashOffset(int borderDashOffset) Sets the line dash pattern offset or "phase".
void	setBorderWidth(int borderWidth) Sets the border width of the selection.
void	setColor(IsColor color) Sets the color.
void	setColor(String color) Sets the color.
void	setFireEventOnClearSelection(boolean fireEvent) Sets true if it will fire event after clear of selection, otherwise false.
void	setXAxisID(String xAxisID) Sets the ID of the x axis to plot this dataset on.

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPluginOptions

getId, getPluginId, loadGlobalsPluginOptions, store, store, store, store

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

checkValue, empty, getArrayValue, getNativeChart, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setArrayValue, setValue, 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

Field Detail

DEFAULT_ALPHA

public static final double DEFAULT_ALPHA

Default alpha of selecting/selection colors, 0.3.

See Also:

Constant Field Values

DEFAULT_COLOR

public static final IsColor DEFAULT_COLOR

Default color for area, GwtMaterialColor.ORANGE_LIGHTEN_3, alpha 0.3.

DEFAULT_AXIS_ID

public static final String DEFAULT_AXIS_ID

Default X axis id, Scales.DEFAULT_X_AXIS_ID.

See Also:

Constant Field Values

DEFAULT_BORDER_WIDTH

public static final int DEFAULT_BORDER_WIDTH

Default border width of selection area, 0.

See Also:

Constant Field Values

DEFAULT_BORDER_DASH_OFFSET

public static final int DEFAULT_BORDER_DASH_OFFSET

Default border dash offset of selection area, 0.

See Also:

Constant Field Values

DEFAULT_BORDER_COLOR

public static final IsColor DEFAULT_BORDER_COLOR

Default border color for area, GwtMaterialColor.GREY_DARKEN_2.

DEFAULT_FIRE_EVENT_ON_CLEAR_SELECTION

public static final boolean DEFAULT_FIRE_EVENT_ON_CLEAR_SELECTION

Default flag if fire event after clear selection, false.

See Also:

Constant Field Values

Constructor Detail

DatasetsItemsSelectorOptions

public DatasetsItemsSelectorOptions()

Builds the object with new java script object setting the default value of plugin.
The global plugin options is used, if exists, as defaults values.

DatasetsItemsSelectorOptions

public DatasetsItemsSelectorOptions(IsChart chart)

Builds the object with a chart instance in order to get the right defaults.
If the plugin options have not been set by chart type, it will use the global.

Parameters:

chart - chart instance related to the plugin options

Method Detail

getClearSelection

public ClearSelection getClearSelection()

Returns the clear selection element.

Returns:

the clear selection element

setXAxisID

public void setXAxisID(String xAxisID)

Sets the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

Parameters:

xAxisID - the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

getXAxisID

public String getXAxisID()

Returns the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

Returns:

the ID of the x axis to plot this dataset on. If not specified, this defaults to the ID of the first found x axis.

getColorAsString

public String getColorAsString()

Returns the color.

Returns:

the color.

getColor

public IsColor getColor()

Returns the color.

Returns:

the color.

setColor

public void setColor(String color)

Sets the color.

Parameters:

color - the color.

setColor

public void setColor(IsColor color)

Sets the color.

Parameters:

color - the color.

setBorderDash

public void setBorderDash(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

getBorderDash

public List<Integer> getBorderDash()

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.

Returns:

the line dash pattern used when stroking lines.

setBorderDashOffset

public void setBorderDashOffset(int borderDashOffset)

Sets the line dash pattern offset or "phase".

Parameters:

borderDashOffset - the line dash pattern offset or "phase".

getBorderDashOffset

public int getBorderDashOffset()

Returns the line dash pattern offset or "phase".

Returns:

the line dash pattern offset or "phase".

setBorderWidth

public void setBorderWidth(int borderWidth)

Sets the border width of the selection.

Parameters:

borderWidth - the border width of the selection.

getBorderWidth

public int getBorderWidth()

Returns the border width of the selection.

Returns:

list of the border width of the selection.

getBorderColorAsString

public String getBorderColorAsString()

Returns the color.

Returns:

the color.

getBorderColor

public IsColor getBorderColor()

Returns the color.

Returns:

the color.

setBorderColor

public void setBorderColor(String color)

Sets the color.

Parameters:

color - the color.

setBorderColor

public void setBorderColor(IsColor color)

Sets the color.

Parameters:

color - the color.

setFireEventOnClearSelection

public void setFireEventOnClearSelection(boolean fireEvent)

Sets true if it will fire event after clear of selection, otherwise false.

Parameters:

fireEvent - true if it will fire event after clear of selection, otherwise false

isFireEventOnClearSelection

public boolean isFireEventOnClearSelection()

Returns true if it will fire event after clear of selection, otherwise false.

Returns:

true if it will fire event after clear of selection, otherwise false