org.pepstock.charba.client.data

Class HovingDataset

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.data.Dataset

org.pepstock.charba.client.data.HovingFlexDataset

org.pepstock.charba.client.data.HovingDataset

All Implemented Interfaces:

HasDataset

Direct Known Subclasses:

BubbleDataset, PieDataset, PolarAreaDataset

public abstract class HovingDataset
extends HovingFlexDataset

The chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested classes/interfaces inherited from class org.pepstock.charba.client.data.Dataset

Dataset.Property

Method Summary

Modifier and Type	Method and Description
protected void	applyGradient(Key key, List<CanvasGradient> canvasGradientsList) Stores the canvas gradients into dataset object by property name passed as key.
protected void	applyPattern(Key key, List<CanvasPattern> canvasPatternsList) Stores the canvas patterns into dataset object by property name passed as key.
List<Gradient>	getHoverBackgroundColorAsGradient() Returns the fill gradients of the arcs in the dataset when hovered.
List<Pattern>	getHoverBackgroundColorAsPatterns() Returns the fill patterns of the arcs in the dataset when hovered.
List<String>	getHoverBackgroundColorAsString() Returns the fill color of the arcs when hovered as string.
BackgroundColorCallback	getHoverBackgroundColorCallback() Returns the hover background color callback, if set, otherwise null.
List<Gradient>	getHoverBorderColorAsGradient() Returns the stroke gradients of the arcs in the dataset when hovered.
List<String>	getHoverBorderColorAsString() Returns the stroke color of the arcs when hovered.
BorderColorCallback	getHoverBorderColorCallback() Returns the hover border color callback, if set, otherwise null.
List<Integer>	getHoverBorderWidth() Returns the stroke width of the arcs when hovered.
BorderWidthCallback	getHoverBorderWidthCallback() Returns the hover border width callback, if set, otherwise null.
void	setHoverBackgroundColor(BackgroundColorCallback hoverBackgroundColorCallback) Sets the hover background color callback.
void	setHoverBackgroundColor(Gradient... colors) Sets the fill gradient of the arcs in the dataset when hovered.
void	setHoverBackgroundColor(IsColor... colors) Sets the fill color of the arcs when hovered
void	setHoverBackgroundColor(Pattern... colors) Sets the fill pattern of the arcs in the dataset when hovered.
void	setHoverBackgroundColor(String... colors) Sets the fill color of the arcs when hovered as string
void	setHoverBorderColor(BorderColorCallback hoverBorderColorCallback) Sets the hover border color callback.
void	setHoverBorderColor(Gradient... colors) Sets the stroke gradient of the arcs in the dataset when hovered as gradient.
void	setHoverBorderColor(IsColor... colors) Sets the stroke color of the arcs when hovered as string.
void	setHoverBorderColor(String... colors) Sets the stroke color of the arcs when hovered as string.
void	setHoverBorderWidth(BorderWidthCallback hoverBorderWidthCallback) Sets the hover border width callback.

Methods inherited from class org.pepstock.charba.client.data.HovingFlexDataset

getBackgroundColor, getBackgroundColorAsGradient, getBackgroundColorAsPatterns, getBackgroundColorAsString, getBorderColor, getBorderColorAsGradient, getBorderColorAsString, getBorderWidth, getHoverBackgroundColor, getHoverBorderColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderColor, setBorderWidth, setHoverBorderWidth

Methods inherited from class org.pepstock.charba.client.data.Dataset

getBackgroundColorCallback, getBorderColorCallback, getBorderWidthCallback, getData, getData, getDataset, getDataType, getDefaultBackgroundColorAsString, getDefaultBorderColorAsString, getDefaultBorderWidth, getDefaultValues, getId, getLabel, getOptions, getType, hasOptions, invokeColorCallback, isHidden, setBackgroundColor, setBorderColor, setBorderWidth, setData, setData, setHidden, setLabel, setOptions

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

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

Methods inherited from class java.lang.Object

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

Method Detail

setHoverBackgroundColor

public void setHoverBackgroundColor(IsColor... colors)

Sets the fill color of the arcs when hovered

Overrides:

setHoverBackgroundColor in class HovingFlexDataset

Parameters:

colors - the fill color of the arcs when hovered

setHoverBackgroundColor

public void setHoverBackgroundColor(String... colors)

Sets the fill color of the arcs when hovered as string

Overrides:

setHoverBackgroundColor in class HovingFlexDataset

Parameters:

colors - the fill color of the arcs when hovered as string

setHoverBackgroundColor

public void setHoverBackgroundColor(Pattern... colors)

Sets the fill pattern of the arcs in the dataset when hovered.

Overrides:

setHoverBackgroundColor in class HovingFlexDataset

Parameters:

colors - the fill pattern of the arcs in the dataset when hovered.

setHoverBackgroundColor

public void setHoverBackgroundColor(Gradient... colors)

Sets the fill gradient of the arcs in the dataset when hovered.

Overrides:

setHoverBackgroundColor in class HovingFlexDataset

Parameters:

colors - the fill gradient of the arcs in the dataset when hovered.

getHoverBackgroundColorAsString

public List<String> getHoverBackgroundColorAsString()

Returns the fill color of the arcs when hovered as string. If property is missing or not a color, returns an empty list.

Overrides:

getHoverBackgroundColorAsString in class HovingFlexDataset

Returns:

list of the fill color of the arcs when hovered as string. If property is missing or not a color, returns an empty list.

getHoverBackgroundColorAsPatterns

public List<Pattern> getHoverBackgroundColorAsPatterns()

Returns the fill patterns of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.

Overrides:

getHoverBackgroundColorAsPatterns in class HovingFlexDataset

Returns:

list of the fill patterns of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.

getHoverBackgroundColorAsGradient

public List<Gradient> getHoverBackgroundColorAsGradient()

Returns the fill gradients of the arcs in the dataset when hovered. If property is missing or not a gradient, returns an empty list.

Overrides:

getHoverBackgroundColorAsGradient in class HovingFlexDataset

Returns:

list of the fill gradients of the arcs in the dataset when hovered. If property is missing or not a gradient, returns an empty list.

setHoverBorderColor

public void setHoverBorderColor(IsColor... colors)

Sets the stroke color of the arcs when hovered as string.

Overrides:

setHoverBorderColor in class HovingFlexDataset

Parameters:

colors - the stroke color of the arcs when hovered as string.

setHoverBorderColor

public void setHoverBorderColor(String... colors)

Sets the stroke color of the arcs when hovered as string.

Overrides:

setHoverBorderColor in class HovingFlexDataset

Parameters:

colors - the stroke color of the arcs when hovered as string.

setHoverBorderColor

public void setHoverBorderColor(Gradient... colors)

Sets the stroke gradient of the arcs in the dataset when hovered as gradient.

Overrides:

setHoverBorderColor in class HovingFlexDataset

Parameters:

colors - the stroke gradient of the arcs in the dataset when hovered as gradient.

getHoverBorderColorAsString

public List<String> getHoverBorderColorAsString()

Returns the stroke color of the arcs when hovered.

Overrides:

getHoverBorderColorAsString in class HovingFlexDataset

Returns:

list of the stroke color of the arcs when hovered.

getHoverBorderColorAsGradient

public List<Gradient> getHoverBorderColorAsGradient()

Returns the stroke gradients of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.

Overrides:

getHoverBorderColorAsGradient in class HovingFlexDataset

Returns:

list of the stroke gradients of the arcs in the dataset when hovered. If property is missing or not a pattern, returns an empty list.

getHoverBorderWidth

public List<Integer> getHoverBorderWidth()

Returns the stroke width of the arcs when hovered.

Overrides:

getHoverBorderWidth in class HovingFlexDataset

Returns:

list of the stroke width of the arcs when hovered.

getHoverBackgroundColorCallback

public BackgroundColorCallback getHoverBackgroundColorCallback()

Returns the hover background color callback, if set, otherwise null.

Returns:

the hover background color callback, if set, otherwise null.

setHoverBackgroundColor

public void setHoverBackgroundColor(BackgroundColorCallback hoverBackgroundColorCallback)

Sets the hover background color callback.

Parameters:

hoverBackgroundColorCallback - the hover background color callback.

getHoverBorderColorCallback

public BorderColorCallback getHoverBorderColorCallback()

Returns the hover border color callback, if set, otherwise null.

Returns:

the hover border color callback, if set, otherwise null.

setHoverBorderColor

public void setHoverBorderColor(BorderColorCallback hoverBorderColorCallback)

Sets the hover border color callback.

Parameters:

hoverBorderColorCallback - the hover border color callback.

getHoverBorderWidthCallback

public BorderWidthCallback getHoverBorderWidthCallback()

Returns the hover border width callback, if set, otherwise null.

Returns:

the hover border width callback, if set, otherwise null.

setHoverBorderWidth

public void setHoverBorderWidth(BorderWidthCallback hoverBorderWidthCallback)

Sets the hover border width callback.

Parameters:

hoverBorderWidthCallback - the hover border width callback to set

applyPattern

protected final void applyPattern(Key key,
                                  List<CanvasPattern> canvasPatternsList)

Description copied from class: Dataset

Stores the canvas patterns into dataset object by property name passed as key.

Overrides:

applyPattern in class HovingFlexDataset

Parameters:

key - key property name to use to store canvas patterns into dataset object.

canvasPatternsList - list of canvas patterns

applyGradient

protected final void applyGradient(Key key,
                                   List<CanvasGradient> canvasGradientsList)

Description copied from class: Dataset

Stores the canvas gradients into dataset object by property name passed as key.

Overrides:

applyGradient in class HovingFlexDataset

Parameters:

key - key property name to use to store canvas gradients into dataset object.

canvasGradientsList - list of canvas gradients