Package org.pepstock.charba.client.defaults.globals

Class DefaultBar

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultBar

All Implemented Interfaces:

IsDefaultBar, IsDefaultOptionsElement, IsDefaultPointStyleHandler

public final class DefaultBar
extends Object
implements IsDefaultBar

CHART.JS default values for BAR element.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUTO_INFLATE_AMOUNT	Value to store in the CHART.JS configuration when the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculated, "auto".

Method Summary

Modifier and Type	Method	Description
String	getBackgroundColorAsString()	Returns the background color.
String	getBorderColorAsString()	Returns the border color.
int	getBorderRadius()	Returns the bar border radius (in pixels).
BorderSkipped	getBorderSkipped()	Returns the edge to skip drawing the border for.
int	getBorderWidth()	Returns the border width.
String	getHoverBackgroundColorAsString()	Returns the background color when hovered.
String	getHoverBorderColorAsString()	Returns the border color when hovered.
int	getHoverBorderRadius()	Returns the bar border radius (in pixels) when hovered.
int	getHoverBorderWidth()	Returns the border width when hovered.
int	getInflateAmount()	Returns the amount of pixels to inflate the bar rectangles, when drawing.
PointStyle	getPointStyle()	Returns the style of the point.
Canvas	getPointStyleAsCanvas()	Returns the style of the point as canvas. If property is missing or not an canvas, returns null.
Img	getPointStyleAsImage()	Returns the style of the point as image. If property is missing or not an image, returns null.
PointStyleType	getPointStyleType()	Returns the type of point style.
boolean	isAutoInflateAmount()	Returns true if the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculated.
boolean	isEnableBorderRadius()	If true, it only shows the borderRadius of a bar when the bar is at the end of the stack.

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

Field Detail

AUTO_INFLATE_AMOUNT

public static final String AUTO_INFLATE_AMOUNT

Value to store in the CHART.JS configuration when the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculated, "auto".

See Also:

Constant Field Values

Method Detail

getBorderSkipped

public BorderSkipped getBorderSkipped()

Description copied from interface: IsDefaultBar

Returns the edge to skip drawing the border for.

Specified by:

getBorderSkipped in interface IsDefaultBar

Returns:

the edge to skip drawing the border for.

getBorderRadius

public int getBorderRadius()

Description copied from interface: IsDefaultBar

Returns the bar border radius (in pixels).

Specified by:

getBorderRadius in interface IsDefaultBar

Returns:

the bar border radius (in pixels).

getPointStyle

public PointStyle getPointStyle()

Description copied from interface: IsDefaultPointStyleHandler

Returns the style of the point.

Specified by:

getPointStyle in interface IsDefaultPointStyleHandler

Returns:

the style of the point.

getPointStyleType

public PointStyleType getPointStyleType()

Description copied from interface: IsDefaultPointStyleHandler

Returns the type of point style.

Specified by:

getPointStyleType in interface IsDefaultPointStyleHandler

Returns:

the type of point style

getPointStyleAsImage

public Img getPointStyleAsImage()

Description copied from interface: IsDefaultPointStyleHandler

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.

getPointStyleAsCanvas

public Canvas getPointStyleAsCanvas()

Description copied from interface: IsDefaultPointStyleHandler

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.

getHoverBorderRadius

public int getHoverBorderRadius()

Description copied from interface: IsDefaultBar

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

Specified by:

getHoverBorderRadius in interface IsDefaultBar

Returns:

the bar border radius (in pixels) when hovered.

isEnableBorderRadius

public boolean isEnableBorderRadius()

Description copied from interface: IsDefaultBar

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

isAutoInflateAmount

public boolean isAutoInflateAmount()

Description copied from interface: IsDefaultBar

Returns true if the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculated.

Specified by:

isAutoInflateAmount in interface IsDefaultBar

Returns:

true if the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculated

getInflateAmount

public int getInflateAmount()

Description copied from interface: IsDefaultBar

Returns the amount of pixels to inflate the bar rectangles, when drawing.

Specified by:

getInflateAmount in interface IsDefaultBar

Returns:

the amount of pixels to inflate the bar rectangles, when drawing

getBackgroundColorAsString

public final String getBackgroundColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the background color.

Specified by:

getBackgroundColorAsString in interface IsDefaultOptionsElement

Returns:

the background color.

getBorderWidth

public final int getBorderWidth()

Description copied from interface: IsDefaultOptionsElement

Returns the border width.

Specified by:

getBorderWidth in interface IsDefaultOptionsElement

Returns:

the border width.

getBorderColorAsString

public final String getBorderColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the border color.

Specified by:

getBorderColorAsString in interface IsDefaultOptionsElement

Returns:

the border color.

getHoverBackgroundColorAsString

public String getHoverBackgroundColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the background color when hovered.

Specified by:

getHoverBackgroundColorAsString in interface IsDefaultOptionsElement

Returns:

the background color when hovered.

getHoverBorderWidth

public int getHoverBorderWidth()

Description copied from interface: IsDefaultOptionsElement

Returns the border width when hovered.

Specified by:

getHoverBorderWidth in interface IsDefaultOptionsElement

Returns:

the border width when hovered.

getHoverBorderColorAsString

public String getHoverBorderColorAsString()

Description copied from interface: IsDefaultOptionsElement

Returns the border color when hovered.

Specified by:

getHoverBorderColorAsString in interface IsDefaultOptionsElement

Returns:

the border color when hovered.