org.pepstock.charba.client.defaults.scale

Class Ticks

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.defaults.AbstractItem

org.pepstock.charba.client.defaults.FontItem

org.pepstock.charba.client.defaults.scale.Ticks

public final class Ticks
extends FontItem

All configuration for ticks of a chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
int	getAutoSkipPadding() Returns the padding between the ticks on the horizontal axis when autoSkip is enabled.
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.
int	getLabelOffset() Returns the distance in pixels to offset the label from the centre point of the tick (in the y direction for the x axis, and the x direction for the y axis). Note: this can cause labels at the edges to be cropped by the edge of the canvas.
FontItem	getMajor()
double	getMax() Returns the user defined maximum number for the scale, overrides maximum value from data.
int	getMaxRotation() Returns the maximum rotation for tick labels when rotating to condense labels.
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.
FontItem	getMinor()
int	getMinRotation() Returns the minimum rotation for tick labels.
int	getPadding() Returns the padding between the tick label and the axis.
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	isAutoSkip() If true, automatically calculates how many labels that can be shown and hides labels accordingly.
boolean	isBeginAtZero() If true, scale will include 0 if it is not already included.
boolean	isDisplay() If true, show tick marks
boolean	isMirror() Returns the flips tick labels around axis, displaying the labels inside the chart instead of outside.
boolean	isReverse() Returns the reverses order of tick labels.
boolean	isShowLabelBackdrop() If true, draw a background behind the tick labels.
void	setAutoSkip(boolean autoSkip) If true, automatically calculates how many labels that can be shown and hides labels accordingly.
void	setAutoSkipPadding(int autoSkipPadding) Sets the padding between the ticks on the horizontal axis when autoSkip is enabled.
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	setLabelOffset(int labelOffset) Sets the distance in pixels to offset the label from the centre point of the tick (in the y direction for the x axis, and the x direction for the y axis). Note: this can cause labels at the edges to be cropped by the edge of the canvas.
void	setMax(double max) Sets the user defined maximum number for the scale, overrides maximum value from data.
void	setMaxRotation(int maxRotation) Sets the maximum rotation for tick labels when rotating to condense labels.
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	setMinRotation(int minRotation) Sets the minimum rotation for tick labels.
void	setMirror(boolean mirror) Sets the flips tick labels around axis, displaying the labels inside the chart instead of outside.
void	setPadding(int padding) Sets the padding between the tick label and the axis.
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.defaults.FontItem

getFontColor, getFontColorAsString, getFontFamily, getFontSize, getFontStyle, setFontColor, setFontColor, setFontFamily, setFontSize, setFontStyle

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

checkAndAddToParent, hasProperty

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

getMinor

public FontItem getMinor()

Returns:

the minor

getMajor

public FontItem getMajor()

Returns:

the major

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.. Default is false

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. Default is true.

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. Default is false.

setAutoSkip

public void setAutoSkip(boolean autoSkip)

If true, automatically calculates how many labels that can be shown and hides labels accordingly. Turn it off to show all labels no matter what

Parameters:

autoSkip - If true, automatically calculates how many labels that can be shown and hides labels accordingly. Turn it off to show all labels no matter what

isAutoSkip

public boolean isAutoSkip()

If true, automatically calculates how many labels that can be shown and hides labels accordingly. Turn it off to show all labels no matter what

Returns:

If true, automatically calculates how many labels that can be shown and hides labels accordingly. Turn it off to show all labels no matter what. Default is true

setAutoSkipPadding

public void setAutoSkipPadding(int autoSkipPadding)

Sets the padding between the ticks on the horizontal axis when autoSkip is enabled. Note: Only applicable to horizontal scales.

Parameters:

autoSkipPadding - padding between the ticks on the horizontal axis when autoSkip is enabled. Note: Only applicable to horizontal scales.

getAutoSkipPadding

public int getAutoSkipPadding()

Returns the padding between the ticks on the horizontal axis when autoSkip is enabled. Note: Only applicable to horizontal scales.

Returns:

padding between the ticks on the horizontal axis when autoSkip is enabled. Note: Only applicable to horizontal scales. Defualt is 0.

setLabelOffset

public void setLabelOffset(int labelOffset)

Sets the distance in pixels to offset the label from the centre point of the tick (in the y direction for the x axis, and the x direction for the y axis).
Note: this can cause labels at the edges to be cropped by the edge of the canvas.

Parameters:

labelOffset - the distance in pixels to offset the label from the centre point of the tick (in the y direction for the x axis, and the x direction for the y axis)

getLabelOffset

public int getLabelOffset()

Returns the distance in pixels to offset the label from the centre point of the tick (in the y direction for the x axis, and the x direction for the y axis).
Note: this can cause labels at the edges to be cropped by the edge of the canvas.

Returns:

the distance in pixels to offset the label from the centre point of the tick (in the y direction for the x axis, and the x direction for the y axis). Default is 0.

setMaxRotation

public void setMaxRotation(int maxRotation)

Sets the maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.

Parameters:

maxRotation - maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.

getMaxRotation

public int getMaxRotation()

Returns the maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.

Returns:

maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales. Default is 90

setMinRotation

public void setMinRotation(int minRotation)

Sets the minimum rotation for tick labels. Note: Only applicable to horizontal scales.

Parameters:

minRotation - minimum rotation for tick labels. Note: Only applicable to horizontal scales.

getMinRotation

public int getMinRotation()

Returns the minimum rotation for tick labels. Note: Only applicable to horizontal scales.

Returns:

minimum rotation for tick labels. Note: Only applicable to horizontal scales.. Default is 0.

setMirror

public void setMirror(boolean mirror)

Sets the flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.

Parameters:

mirror - flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.

isMirror

public boolean isMirror()

Returns the flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.

Returns:

flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales. Default is false.

setPadding

public void setPadding(int padding)

Sets the padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.

Parameters:

padding - padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.

getPadding

public int getPadding()

Returns the padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.

Returns:

padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction. Default is 10.

setMin

public void setMin(double min)

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

Parameters:

min - the 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:

the user defined minimum number for the scale, overrides minimum value from data. Default is Double.MIN_VALUE.

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. Default is Double.MAX_VALUE.

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. Default is 11.

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. Default is Double.MIN_VALUE.

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. Default is 'rgba(255, 255, 255, 0.75)'

getBackdropColor

public IsColor getBackdropColor()

Returns the color of label backdrops.

Returns:

color of label backdrops. Default is 'rgba(255, 255, 255, 0.75)'

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. Default is 2.

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. Default is 2.

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. Default is true.