Package org.pepstock.charba.client.geo

Class ChoroplethBar

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.commons.AbstractNode

org.pepstock.charba.client.options.AbstractModel<Elements,D>

org.pepstock.charba.client.options.AbstractElement<IsDefaultBar>

org.pepstock.charba.client.options.Bar

org.pepstock.charba.client.geo.ChoroplethBar

All Implemented Interfaces:

IsDefaultBar, IsDefaultOptionsElement, IsDefaultPointStyleHandler

public final class ChoroplethBar
extends Bar

The styling of the new element ChoroplethBar is based on Bar element with some additional options for the outline and graticule.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
org.pepstock.charba.client.geo.CommonOptionsElementHandler	getCommonElementHandler()
default IsColor	getGraticuleBorderColor()	Returns the graticule border color.
default String	getGraticuleBorderColorAsString()	Returns the graticule border color.
default int	getGraticuleBorderWidth()	Returns the graticule border width.
default IsColor	getOutlineBackgroundColor()	Returns the outline background color.
default String	getOutlineBackgroundColorAsString()	Returns the outline background color.
default IsColor	getOutlineBorderColor()	Returns the outline border color.
default String	getOutlineBorderColorAsString()	Returns the outline border color.
default int	getOutlineBorderWidth()	Returns the outline border width.
default PointStyle	getPointStyle()	Returns the style of the point.
default Canvas	getPointStyleAsCanvas()	Returns the style of the point as canvas. If property is missing or not an canvas, returns null.
default Img	getPointStyleAsImage()	Returns the style of the point as image. If property is missing or not an image, returns null.
default PointStyleType	getPointStyleType()	Returns the type of point style.
default void	setGraticuleBorderColor(String borderColor)	Sets the graticule border color.
default void	setGraticuleBorderColor(IsColor borderColor)	Sets the graticule border color.
default void	setGraticuleBorderWidth(int borderWidth)	Sets the graticule border width.
default void	setOutlineBackgroundColor(String backgroundColor)	Sets the outline background color.
default void	setOutlineBackgroundColor(IsColor backgroundColor)	Sets the outline background color.
default void	setOutlineBorderColor(String borderColor)	Sets the outline border color.
default void	setOutlineBorderColor(IsColor borderColor)	Sets the outline border color.
default void	setOutlineBorderWidth(int borderWidth)	Sets the outline border width.
default void	setPointStyle(Canvas pointStyle)	Sets the style of the point as canvas.
default void	setPointStyle(Img pointStyle)	Sets the style of the point as image.
default void	setPointStyle(PointStyle pointStyle)	Sets the style of the point.

Methods inherited from class org.pepstock.charba.client.options.Bar

getBorderRadius, getBorderSkipped, getHoverBorderRadius, getInflateAmount, getPointStyleHandler, isAutoInflateAmount, isEnableBorderRadius, setAutoInflateAmount, setBorderRadius, setBorderSkipped, setBorderSkipped, setEnableBorderRadius, setHoverBorderRadius, setInflateAmount

Methods inherited from class org.pepstock.charba.client.options.AbstractElement

getBackgroundColor, getBackgroundColorAsString, getBorderColor, getBorderColorAsString, getBorderWidth, getHoverBackgroundColor, getHoverBackgroundColorAsString, getHoverBorderColor, getHoverBorderColorAsString, getHoverBorderWidth, setBackgroundColor, setBackgroundColor, setBorderColor, setBorderColor, setBorderWidth, setHoverBackgroundColor, setHoverBackgroundColor, setHoverBorderColor, setHoverBorderColor, setHoverBorderWidth

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

getDefaultValues, getParent, loadPadding, setCallbackToModel, setCallbackToModel, setEventToModel

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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultOptionsElement

getBackgroundColorAsString, getBorderColorAsString, getBorderWidth, getHoverBackgroundColorAsString, getHoverBorderColorAsString, getHoverBorderWidth

Method Detail

getCommonElementHandler

public org.pepstock.charba.client.geo.CommonOptionsElementHandler getCommonElementHandler()

setOutlineBackgroundColor

public default void setOutlineBackgroundColor(IsColor backgroundColor)

Sets the outline background color.

Parameters:

backgroundColor - the outline background color.

setOutlineBackgroundColor

public default void setOutlineBackgroundColor(String backgroundColor)

Sets the outline background color.

Parameters:

backgroundColor - the outline background color.

getOutlineBackgroundColorAsString

public default String getOutlineBackgroundColorAsString()

Returns the outline background color.

Returns:

the outline background color.

getOutlineBackgroundColor

public default IsColor getOutlineBackgroundColor()

Returns the outline background color.

Returns:

the outline background color.

setOutlineBorderWidth

public default void setOutlineBorderWidth(int borderWidth)

Sets the outline border width.

Parameters:

borderWidth - the outline border width.

getOutlineBorderWidth

public default int getOutlineBorderWidth()

Returns the outline border width.

Returns:

the outline border width.

setOutlineBorderColor

public default void setOutlineBorderColor(IsColor borderColor)

Sets the outline border color.

Parameters:

borderColor - the outline border color.

setOutlineBorderColor

public default void setOutlineBorderColor(String borderColor)

Sets the outline border color.

Parameters:

borderColor - the outline border color.

getOutlineBorderColorAsString

public default String getOutlineBorderColorAsString()

Returns the outline border color.

Returns:

the outline border color.

getOutlineBorderColor

public default IsColor getOutlineBorderColor()

Returns the outline border color.

Returns:

the outline border color.

setGraticuleBorderWidth

public default void setGraticuleBorderWidth(int borderWidth)

Sets the graticule border width.

Parameters:

borderWidth - the graticule border width.

getGraticuleBorderWidth

public default int getGraticuleBorderWidth()

Returns the graticule border width.

Returns:

the graticule border width.

setGraticuleBorderColor

public default void setGraticuleBorderColor(IsColor borderColor)

Sets the graticule border color.

Parameters:

borderColor - the graticule border color.

setGraticuleBorderColor

public default void setGraticuleBorderColor(String borderColor)

Sets the graticule border color.

Parameters:

borderColor - the graticule border color.

getGraticuleBorderColorAsString

public default String getGraticuleBorderColorAsString()

Returns the graticule border color.

Returns:

the graticule border color.

getGraticuleBorderColor

public default IsColor getGraticuleBorderColor()

Returns the graticule border color.

Returns:

the graticule border color.

setPointStyle

public default void setPointStyle(PointStyle pointStyle)

Sets the style of the point.

Parameters:

pointStyle - array of the style of the point.

getPointStyle

public default PointStyle getPointStyle()

Returns the style of the point.

Specified by:

getPointStyle in interface IsDefaultPointStyleHandler

Returns:

the style of the point or null if point style is set as image

setPointStyle

public default void setPointStyle(Img pointStyle)

Sets the style of the point as image.

Parameters:

pointStyle - image element of the style of the point as image.

getPointStyleType

public default PointStyleType getPointStyleType()

Returns the type of point style.

Specified by:

getPointStyleType in interface IsDefaultPointStyleHandler

Returns:

the type of point style

getPointStyleAsImage

public default Img getPointStyleAsImage()

Returns the style of the point as image.
If property is missing or not an image, returns null.

Specified by:

getPointStyleAsImage in interface IsDefaultPointStyleHandler

Returns:

image of the style of the point as image.
If property is missing or not a image, returns null.

setPointStyle

public default void setPointStyle(Canvas pointStyle)

Sets the style of the point as canvas.

Parameters:

pointStyle - canvas element of the style of the point as canvas.

getPointStyleAsCanvas

public default Canvas getPointStyleAsCanvas()

Returns the style of the point as canvas.
If property is missing or not an canvas, returns null.

Specified by:

getPointStyleAsCanvas in interface IsDefaultPointStyleHandler

Returns:

image of the style of the point as canvas.
If property is missing or not a canvas, returns null.