org.pepstock.charba.client.options

Class Bar

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

All Implemented Interfaces:

IsDefaultBar, IsDefaultOptionsElement, IsDefaultPointStyleHandler

Direct Known Subclasses:

ChoroplethBar

public class Bar
extends AbstractElement<IsDefaultBar>
implements IsDefaultBar

Bar elements are used to represent the bars in a bar chart.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Bar(Elements elements, Key childKey, IsDefaultBar defaultValues, NativeObject nativeObject) Creates the object with the parent, the key of this element, default values and native object to map java script properties.

Method Summary

Modifier and Type	Method and Description
int	getBorderRadius() Returns the bar border radius (in pixels).
BorderSkipped	getBorderSkipped() Returns the edge to skip drawing the border for.
int	getHoverBorderRadius() Returns the bar border radius (in pixels) when hovered.
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.
org.pepstock.charba.client.options.PointStyleHandler	getPointStyleHandler() Returns a point style handler instance to use in the default methods of this interface.
default PointStyleType	getPointStyleType() Returns the type of point style.
boolean	isEnableBorderRadius() If true, it only shows the borderRadius of a bar when the bar is at the end of the stack.
void	setBorderRadius(int borderRadius) Sets the bar border radius (in pixels).
void	setBorderSkipped(boolean borderskip) Sets the edge to skip drawing the border for.
void	setBorderSkipped(BorderSkipped position) Sets the edge to skip drawing the border for.
void	setEnableBorderRadius(boolean enableBorderRadius) If true, it only shows the borderRadius of a bar when the bar is at the end of the stack.
void	setHoverBorderRadius(int borderRadius) Sets the bar border radius (in pixels) when hovered.
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.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

Constructor Detail

Bar

protected Bar(Elements elements,
              Key childKey,
              IsDefaultBar defaultValues,
              NativeObject nativeObject)

Creates the object with the parent, the key of this element, default values and native object to map java script properties.

Parameters:

elements - parent node to use to add this element where changed

childKey - the property name of this element to use to add it to the parent.

defaultValues - default provider

nativeObject - native object to map java script properties

Method Detail

getPointStyleHandler

public org.pepstock.charba.client.options.PointStyleHandler getPointStyleHandler()

Returns a point style handler instance to use in the default methods of this interface.

Returns:

a point style handler instance

setEnableBorderRadius

public void setEnableBorderRadius(boolean enableBorderRadius)

If true, it only shows the borderRadius of a bar when the bar is at the end of the stack.

Parameters:

enableBorderRadius - if true, it only shows the borderRadius of a bar when the bar is at the end of the stack

isEnableBorderRadius

public boolean isEnableBorderRadius()

If true, it only shows the borderRadius of a bar when the bar is at the end of the stack.

Specified by:

isEnableBorderRadius in interface IsDefaultBar

Returns:

if true, it only shows the borderRadius of a bar when the bar is at the end of the stack

setBorderSkipped

public void setBorderSkipped(boolean borderskip)

Sets the edge to skip drawing the border for.

Parameters:

borderskip - to set false as border skipped. If set true, is ignored

setBorderSkipped

public void setBorderSkipped(BorderSkipped position)

Sets the edge to skip drawing the border for.

Parameters:

position - the edge to skip drawing the border for.

getBorderSkipped

public BorderSkipped getBorderSkipped()

Returns the edge to skip drawing the border for.

Specified by:

getBorderSkipped in interface IsDefaultBar

Returns:

the edge to skip drawing the border for.

setBorderRadius

public void setBorderRadius(int borderRadius)

Sets the bar border radius (in pixels).

Parameters:

borderRadius - the bar border radius (in pixels).

getBorderRadius

public int getBorderRadius()

Returns the bar border radius (in pixels).

Specified by:

getBorderRadius in interface IsDefaultBar

Returns:

the bar border radius (in pixels).

setHoverBorderRadius

public void setHoverBorderRadius(int borderRadius)

Sets the bar border radius (in pixels) when hovered.

Parameters:

borderRadius - the bar border radius (in pixels) when hovered.

getHoverBorderRadius

public int getHoverBorderRadius()

Returns the bar border radius (in pixels) when hovered.

Specified by:

getHoverBorderRadius in interface IsDefaultBar

Returns:

the bar border radius (in pixels) when hovered.

setPointStyle

public void setPointStyle(PointStyle pointStyle)

Sets the style of the point.

Parameters:

pointStyle - array of the style of the point.

getPointStyle

public 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 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 PointStyleType getPointStyleType()

Returns the type of point style.

Specified by:

getPointStyleType in interface IsDefaultPointStyleHandler

Returns:

the type of point style

getPointStyleAsImage

public 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 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 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.