Package org.pepstock.charba.client.impl.plugins

Class ChartPointerOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.plugins.AbstractPluginOptions

org.pepstock.charba.client.impl.plugins.ChartPointerOptions

public final class ChartPointerOptions
extends AbstractPluginOptions

Configuration options of ChartPointer.ID plugin.
It manages the cursor to adopt when the cursor is over the dataset item and when not.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field	Description
static CursorType	DEFAULT_CURSOR_POINTER	Default cursor type when the cursor is over, CursorType.POINTER.

Constructor Summary

Constructors

Constructor	Description
ChartPointerOptions()	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.
ChartPointerOptions(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	Description
CursorType	getCursorPointer()	Returns the cursor type when the cursor is over the dataset item.
default CursorType	getCursorPointer()	Returns the cursor type when the cursor is over the dataset item.
Set<PointerElement>	getElements()	Returns the chart elements in scope to ChartPointer.ID plugin.
void	setCursorPointer(CursorType cursor)	Sets the cursor type when the cursor is over the dataset item.
void	setElements(Set<PointerElement> elements)	Sets the chart elements in scope to ChartPointer.ID plugin.
void	setElements(PointerElement... elements)	Sets the chart elements in scope to ChartPointer.ID plugin.

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

applyingDefaults, applyingDefaults, getEvents, getId, getPluginId, loadGlobalsPluginOptions, setEvents, setEvents, store, store, store, store

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

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

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CURSOR_POINTER

public static final CursorType DEFAULT_CURSOR_POINTER

Default cursor type when the cursor is over, CursorType.POINTER.

Constructor Detail

ChartPointerOptions

public ChartPointerOptions()

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.

ChartPointerOptions

public ChartPointerOptions(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

setElements

public void setElements(PointerElement... elements)

Sets the chart elements in scope to ChartPointer.ID plugin.

Parameters:

elements - the chart elements in scope to ChartPointer.ID plugin

setElements

public void setElements(Set<PointerElement> elements)

Sets the chart elements in scope to ChartPointer.ID plugin.

Parameters:

elements - the chart elements in scope to ChartPointer.ID plugin

getElements

public Set<PointerElement> getElements()

Returns the chart elements in scope to ChartPointer.ID plugin.

Returns:

the chart elements in scope to ChartPointer.ID plugin

getCursorPointer

public default CursorType getCursorPointer()

Returns the cursor type when the cursor is over the dataset item.

Returns:

cursor type when the cursor is over the dataset item

setCursorPointer

public final void setCursorPointer(CursorType cursor)

Sets the cursor type when the cursor is over the dataset item.

Parameters:

cursor - cursor type when the cursor is over the dataset item

getCursorPointer

public final CursorType getCursorPointer()

Returns the cursor type when the cursor is over the dataset item.

Returns:

cursor type when the cursor is over the dataset item