public final class DatasetsItemsSelectorOptions extends AbstractPluginOptions
DatasetsItemsSelector.ID
plugin.Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_ALPHA
Default alpha of selecting/selection colors, 0.3.
|
static DefaultScaleId |
DEFAULT_AXIS_ID
Default X axis id,
DefaultScaleId.X . |
static IsColor |
DEFAULT_BORDER_COLOR
Default border color for area,
GwtMaterialColor.GREY_DARKEN_2 . |
static double |
DEFAULT_BORDER_DASH_OFFSET
Default border dash offset of selection area, 0.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_ENABLED
Default enabled options, true.
|
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. |
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.
|
double |
getBorderDashOffset()
Returns the line dash pattern offset.
|
int |
getBorderWidth()
Returns the border width of the selection.
|
IsColor |
getColor()
Returns the color.
|
String |
getColorAsString()
Returns the color.
|
ModifierKey |
getModifierKey()
Returns the modifier key to activate selection.
|
SelectionCleaner |
getSelectionCleaner()
Returns the selection cleaner element.
|
ScaleId |
getXAxisID()
Returns the ID of the x axis to plot this dataset on.
|
boolean |
isEnabled()
Returns
true if plugin is enabled. |
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(double borderDashOffset)
Sets the line dash pattern offset.
|
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 |
setEnabled(boolean enabled)
Sets
true if plugin is enabled. |
void |
setModifierKey(ModifierKey modifierKey)
Sets the modifier key to activate selection.
|
void |
setXAxisID(ScaleId xAxisID)
Sets the ID of the x axis to plot this dataset on.
|
void |
setXAxisID(String xAxisID)
Sets the ID of the x axis to plot this dataset on.
|
applyingDefaults, applyingDefaults, getEvents, getId, getPluginId, loadGlobalsPluginOptions, setEvents, setEvents, store, store, store, store
checkAndAddToParent, getChildKey, getParentNode, getRootNode, retrieveRoot, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setArrayValueAndAddToParent, setElementAndAddToParent, setInternalCallbackToModel, setInternalCallbackToModel, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent, setValueOrArrayAndAddToParent
checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type
public static final boolean DEFAULT_ENABLED
public static final double DEFAULT_ALPHA
public static final IsColor DEFAULT_COLOR
GwtMaterialColor.ORANGE_LIGHTEN_3
, alpha 0.3.public static final DefaultScaleId DEFAULT_AXIS_ID
DefaultScaleId.X
.public static final int DEFAULT_BORDER_WIDTH
public static final double DEFAULT_BORDER_DASH_OFFSET
public static final IsColor DEFAULT_BORDER_COLOR
GwtMaterialColor.GREY_DARKEN_2
.public DatasetsItemsSelectorOptions()
public DatasetsItemsSelectorOptions(IsChart chart)
chart
- chart instance related to the plugin optionspublic SelectionCleaner getSelectionCleaner()
public void setEnabled(boolean enabled)
true
if plugin is enabled.enabled
- true
if plugin is enabled.public boolean isEnabled()
true
if plugin is enabled.true
if plugin is enabled.public void setXAxisID(String xAxisID)
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.public void setXAxisID(ScaleId xAxisID)
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.public ScaleId getXAxisID()
public String getColorAsString()
public IsColor getColor()
public void setColor(String color)
color
- the color.public void setColor(IsColor color)
color
- the color.public void setBorderDash(int... borderDash)
borderDash
- the line dash pattern used when stroking linespublic List<Integer> getBorderDash()
public void setBorderDashOffset(double borderDashOffset)
borderDashOffset
- the line dash pattern offset.public double getBorderDashOffset()
public void setBorderWidth(int borderWidth)
borderWidth
- the border width of the selection.public int getBorderWidth()
public String getBorderColorAsString()
public IsColor getBorderColor()
public void setBorderColor(String color)
color
- the color.public void setBorderColor(IsColor color)
color
- the color.public void setModifierKey(ModifierKey modifierKey)
modifierKey
- the modifier key to activate selectionpublic ModifierKey getModifierKey()