Package org.pepstock.charba.client.defaults

Interface IsDefaultBar

All Superinterfaces:

IsDefaultOptionsElement, IsDefaultPointStyleHandler

All Known Implementing Classes:

Bar, DefaultBar, DefaultChartBar

public interface IsDefaultBar
extends IsDefaultOptionsElement, IsDefaultPointStyleHandler

Interface to define bar object defaults.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
double	getBase()	Returns the base value for the bar in data units along the value axis. If not set, defaults to the value axis base value.
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.
int	getInflateAmount()	Returns the amount of pixels to inflate the bar rectangles, when drawing.
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 interface org.pepstock.charba.client.defaults.IsDefaultOptionsElement

getBackgroundColorAsString, getBorderColorAsString, getBorderWidth, getHoverBackgroundColorAsString, getHoverBorderColorAsString, getHoverBorderWidth

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

getPointStyle, getPointStyleAsCanvas, getPointStyleAsImage, getPointStyleType

Method Detail

getBorderSkipped

BorderSkipped getBorderSkipped()

Returns the edge to skip drawing the border for.

Returns:

the edge to skip drawing the border for.

getBorderRadius

int getBorderRadius()

Returns the bar border radius (in pixels).

Returns:

the bar border radius (in pixels).

getHoverBorderRadius

int getHoverBorderRadius()

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

Returns:

the bar border radius (in pixels) when hovered.

isEnableBorderRadius

boolean isEnableBorderRadius()

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

Returns:

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

isAutoInflateAmount

boolean isAutoInflateAmount()

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

Returns:

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

getInflateAmount

int getInflateAmount()

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

Returns:

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

getBase

double getBase()

Returns the base value for the bar in data units along the value axis.
If not set, defaults to the value axis base value.

Returns:

base value for the bar in data units along the value axis.
If not set, defaults to the value axis base value