org.pepstock.charba.client.options.scales

Class CartesianTimeTick

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

public final class CartesianTimeTick
extends BaseTick

The time scale is use to chart time data.
It can be placed on either the x or y axis.

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.
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.
BaseTick	getMajor()
int	getMaxRotation() Returns the maximum rotation for tick labels when rotating to condense labels.
BaseTick	getMinor()
int	getMinRotation() Returns the minimum rotation for tick labels.
int	getPadding() Returns the padding between the tick label and the axis.
TickSource	getSource() Returns the property controls the ticks generation.
boolean	isAutoSkip() If true, automatically calculates how many labels that can be shown and hides labels accordingly.
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.
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	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	setMaxRotation(int maxRotation) Sets the maximum rotation for tick labels when rotating to condense labels.
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	setSource(TickSource source) Sets the property controls the ticks generation.

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

setSource

public void setSource(TickSource source)

Sets the property controls the ticks generation.

Parameters:

source - property controls the ticks generation.

See Also:

TickSource

getSource

public TickSource getSource()

Returns the property controls the ticks generation.

Returns:

property controls the ticks generation.

See Also:

TickSource

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.

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.

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

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.

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.

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.

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.

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.