org.pepstock.charba.client.options.scales

Class RadialLinearTick

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.scales.BaseTick

org.pepstock.charba.client.options.scales.RadialLinearTick

public final class RadialLinearTick
extends BaseTick

This object is used to map defined radial axis as linear.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
IsColor	getBackdropColor() Returns the color of label backdrops.
java.lang.String	getBackdropColorAsString() Returns the color of label backdrops.
int	getBackdropPaddingX() Returns the horizontal padding of label backdrop.
int	getBackdropPaddingY() Returns the vertical padding of label backdrop.
BaseTick	getMajor()
double	getMax() Returns the user defined maximum number for the scale, overrides maximum value from data.
int	getMaxTicksLimit() Returns the maximum number of ticks and gridlines to show.
double	getMin() Returns the user defined minimum number for the scale, overrides minimum value from data.
BaseTick	getMinor()
double	getStepSize() Returns the user defined fixed step size for the scale.
double	getSuggestedMax() Returns the adjustment used when calculating the maximum data value.
double	getSuggestedMin() Returns the adjustment used when calculating the minimum data value.
boolean	isBeginAtZero() If true, scale will include 0 if it is not already included.
boolean	isDisplay() If true, show tick marks
boolean	isReverse() Returns the reverses order of tick labels.
boolean	isShowLabelBackdrop() If true, draw a background behind the tick labels.
void	setBackdropColor(IsColor backdropColor) Sets the color of label backdrops.
void	setBackdropColor(java.lang.String backdropColor) Sets the color of label backdrops.
void	setBackdropPaddingX(int backdropPaddingX) Sets the horizontal padding of label backdrop.
void	setBackdropPaddingY(int backdropPaddingY) Sets the vertical padding of label backdrop.
void	setBeginAtZero(boolean beginAtZero) If true, scale will include 0 if it is not already included.
void	setDisplay(boolean display) If true, show tick marks.
void	setMax(double max) Sets the user defined maximum number for the scale, overrides maximum value from data.
void	setMaxTicksLimit(int maxTicksLimit) Sets the maximum number of ticks and gridlines to show.
void	setMin(double min) Sets the user defined minimum number for the scale, overrides minimum value from data.
void	setReverse(boolean reverse) Sets the reverses order of tick labels.
void	setShowLabelBackdrop(boolean showLabelBackdrop) If true, draw a background behind the tick labels.
void	setStepSize(double stepSize) Sets the user defined fixed step size for the scale.
void	setSuggestedMax(double suggestedMax) Sets the adjustment used when calculating the maximum data value.
void	setSuggestedMin(double suggestedMin) Sets the adjustment used when calculating the minimum data value.

Methods inherited from class org.pepstock.charba.client.options.scales.BaseTick

getCallback, getFontColor, getFontColorAsString, getFontFamily, getFontSize, getFontStyle, onCallback, setCallback, setFontColor, setFontColor, setFontFamily, setFontSize, setFontStyle

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

getChart

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

setBeginAtZero

public void setBeginAtZero(boolean beginAtZero)

If true, scale will include 0 if it is not already included.

Parameters:

beginAtZero - if true, scale will include 0 if it is not already included.

isBeginAtZero

public boolean isBeginAtZero()

If true, scale will include 0 if it is not already included.

Returns:

if true, scale will include 0 if it is not already included.

setMin

public void setMin(double min)

Sets the user defined minimum number for the scale, overrides minimum value from data.

Parameters:

min - user defined minimum number for the scale, overrides minimum value from data.

getMin

public double getMin()

Returns the user defined minimum number for the scale, overrides minimum value from data.

Returns:

user defined minimum number for the scale, overrides minimum value from data.

setMax

public void setMax(double max)

Sets the user defined maximum number for the scale, overrides maximum value from data.

Parameters:

max - user defined maximum number for the scale, overrides maximum value from data.

getMax

public double getMax()

Returns the user defined maximum number for the scale, overrides maximum value from data.

Returns:

user defined maximum number for the scale, overrides maximum value from data.

setMaxTicksLimit

public void setMaxTicksLimit(int maxTicksLimit)

Sets the maximum number of ticks and gridlines to show.

Parameters:

maxTicksLimit - maximum number of ticks and gridlines to show.

getMaxTicksLimit

public int getMaxTicksLimit()

Returns the maximum number of ticks and gridlines to show.

Returns:

maximum number of ticks and gridlines to show.

setStepSize

public void setStepSize(double stepSize)

Sets the user defined fixed step size for the scale.

Parameters:

stepSize - user defined fixed step size for the scale.

getStepSize

public double getStepSize()

Returns the user defined fixed step size for the scale.

Returns:

user defined fixed step size for the scale.

setSuggestedMax

public void setSuggestedMax(double suggestedMax)

Sets the adjustment used when calculating the maximum data value.

Parameters:

suggestedMax - adjustment used when calculating the maximum data value.

getSuggestedMax

public double getSuggestedMax()

Returns the adjustment used when calculating the maximum data value.

Returns:

adjustment used when calculating the maximum data value.

setSuggestedMin

public void setSuggestedMin(double suggestedMin)

Sets the adjustment used when calculating the minimum data value.

Parameters:

suggestedMin - adjustment used when calculating the minimum data value.

getSuggestedMin

public double getSuggestedMin()

Returns the adjustment used when calculating the minimum data value.

Returns:

adjustment used when calculating the minimum data value.

setBackdropColor

public void setBackdropColor(IsColor backdropColor)

Sets the color of label backdrops.

Parameters:

backdropColor - color of label backdrops.

setBackdropColor

public void setBackdropColor(java.lang.String backdropColor)

Sets the color of label backdrops.

Parameters:

backdropColor - color of label backdrops.

getBackdropColorAsString

public java.lang.String getBackdropColorAsString()

Returns the color of label backdrops.

Returns:

color of label backdrops.

getBackdropColor

public IsColor getBackdropColor()

Returns the color of label backdrops.

Returns:

color of label backdrops.

setBackdropPaddingX

public void setBackdropPaddingX(int backdropPaddingX)

Sets the horizontal padding of label backdrop.

Parameters:

backdropPaddingX - horizontal padding of label backdrop.

getBackdropPaddingX

public int getBackdropPaddingX()

Returns the horizontal padding of label backdrop.

Returns:

horizontal padding of label backdrop.

setBackdropPaddingY

public void setBackdropPaddingY(int backdropPaddingY)

Sets the vertical padding of label backdrop.

Parameters:

backdropPaddingY - vertical padding of label backdrop.

getBackdropPaddingY

public int getBackdropPaddingY()

Returns the vertical padding of label backdrop.

Returns:

vertical padding of label backdrop.

setShowLabelBackdrop

public void setShowLabelBackdrop(boolean showLabelBackdrop)

If true, draw a background behind the tick labels.

Parameters:

showLabelBackdrop - if true, draw a background behind the tick labels.

isShowLabelBackdrop

public boolean isShowLabelBackdrop()

If true, draw a background behind the tick labels.

Returns:

if true, draw a background behind the tick labels.

getMinor

public BaseTick getMinor()

Returns:

the minor

getMajor

public BaseTick getMajor()

Returns:

the major

setDisplay

public void setDisplay(boolean display)

If true, show tick marks.

Parameters:

display - if true, show tick marks

isDisplay

public boolean isDisplay()

If true, show tick marks

Returns:

if true, show tick marks.

setReverse

public void setReverse(boolean reverse)

Sets the reverses order of tick labels.

Parameters:

reverse - reverses order of tick labels.

isReverse

public boolean isReverse()

Returns the reverses order of tick labels.

Returns:

reverses order of tick labels.