CartesianTimeTick (Charba - GWT Charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.configuration.CartesianTimeTick

```
public class CartesianTimeTick
extends Object
```
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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAutoSkipPadding()` Returns the padding between the ticks on the horizontal axis when autoSkip is enabled.
`Axis`	`getAxis()` Returns the axis instance.
`TimeTickCallback`	`getCallback()` Returns the user callback instance.
`IsColor`	`getFontColor()` Returns the font color for tick
`String`	`getFontColorAsString()` Returns the font color for tick
`String`	`getFontFamily()` Returns the font family for the tick, follows CSS font-family options.
`int`	`getFontSize()` Returns the font size for tick.
`FontStyle`	`getFontStyle()` Returns the font style for the tick, follows CSS font-style options (i.e.
`int`	`getLabelOffset()` Returns the distance in pixels to offset the label from the center 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.
`double`	`getLineHeight()` Returns the height of an individual line of text.
`String`	`getLineHeightAsString()` Returns the height of an individual line of text.
`org.pepstock.charba.client.configuration.BaseTick<TickMajor>`	`getMajor()` Returns major tick element.
`Date`	`getMax()` If defined, this will override the data maximum.
`int`	`getMaxRotation()` Returns the maximum rotation for tick labels when rotating to condense labels.
`Date`	`getMin()` If defined, this will override the data minimum.
`org.pepstock.charba.client.configuration.BaseTick<TickMinor>`	`getMinor()` Returns minor tick element.
`int`	`getMinRotation()` Returns the minimum rotation for tick labels.
`int`	`getPadding()` Returns the padding between the tick label and the axis.
`int`	`getSampleSize()` Returns the number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
`TickSource`	`getSource()` Returns the property controls the ticks generation.
`int`	`getZ()` Returns z-index of tick layer.
`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`	`setCallback(TimeTickCallback callback)` Sets the user callback instance.
`void`	`setDisplay(boolean display)` If true, show tick marks.
`void`	`setFontColor(IsColor fontColor)` Sets the font color for tick
`void`	`setFontColor(String fontColor)` Sets the font color for tick
`void`	`setFontFamily(String fontFamily)` Sets the font family for the tick, follows CSS font-family options.
`void`	`setFontSize(int fontSize)` Sets the font size for tick.
`void`	`setFontStyle(FontStyle fontStyle)` Sets the font style for the tick, follows CSS font-style options (i.e.
`void`	`setLabelOffset(int labelOffset)` Sets the distance in pixels to offset the label from the center 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`	`setLineHeight(double lineHeight)` Sets the height of an individual line of text.
`void`	`setLineHeight(String lineHeight)` Sets the height of an individual line of text.
`void`	`setMax(Date max)` If defined, this will override the data maximum.
`void`	`setMaxRotation(int maxRotation)` Sets the maximum rotation for tick labels when rotating to condense labels.
`void`	`setMin(Date min)` If defined, this will override the data minimum.
`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`	`setSampleSize(int sampleSize)` Sets the number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
`void`	`setSource(TickSource source)` Sets the property controls the ticks generation.
`void`	`setZ(int z)` Sets z-index of tick layer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.
  - getSource
```
public TickSource getSource()
```
    Returns the property controls the ticks generation.
    
    Returns:
    
    property controls the ticks generation.
  - setMax
```
public void setMax(Date max)
```
    If defined, this will override the data maximum.
    
    Parameters:
    
    max - If defined, this will override the data maximum.
  - getMax
```
public Date getMax()
```
    If defined, this will override the data maximum.
    
    Returns:
    
    If defined, this will override the data maximum.
  - setMin
```
public void setMin(Date min)
```
    If defined, this will override the data minimum.
    
    Parameters:
    
    min - If defined, this will override the data minimum.
  - getMin
```
public Date getMin()
```
    If defined, this will override the data minimum.
    
    Returns:
    
    If defined, this will override the data minimum.
  - getCallback
```
public TimeTickCallback getCallback()
```
    Returns the user callback instance.
    
    Returns:
    
    the callback
  - setCallback
```
public void setCallback(TimeTickCallback callback)
```
    Sets the user callback instance.
    
    Parameters:
    
    callback - the callback to set
  - 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 center 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 center 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 center 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 center 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.
  - setSampleSize
```
public void setSampleSize(int sampleSize)
```
    Sets the number of ticks to examine when deciding how many labels will fit.
    Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
    
    Parameters:
    
    sampleSize - the number of ticks to examine when deciding how many labels will fit.
  - getSampleSize
```
public int getSampleSize()
```
    Returns the number of ticks to examine when deciding how many labels will fit.
    Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
    
    Returns:
    
    the number of ticks to examine when deciding how many labels will fit.
  - getMinor
```
public org.pepstock.charba.client.configuration.BaseTick<TickMinor> getMinor()
```
    Returns minor tick element.
    
    Returns:
    
    the minor
  - getMajor
```
public org.pepstock.charba.client.configuration.BaseTick<TickMajor> getMajor()
```
    Returns major tick element.
    
    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.
  - setZ
```
public void setZ(int z)
```
    Sets z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
    
    Parameters:
    
    z - z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
  - getZ
```
public int getZ()
```
    Returns z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
    
    Returns:
    
    z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under datasets, greater than 0 on top.
  - setFontSize
```
public void setFontSize(int fontSize)
```
    Sets the font size for tick.
    
    Parameters:
    
    fontSize - the font size for tick.
  - getFontSize
```
public int getFontSize()
```
    Returns the font size for tick.
    
    Returns:
    
    the font size for tick.
  - setFontStyle
```
public void setFontStyle(FontStyle fontStyle)
```
    Sets the font style for the tick, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
    
    Parameters:
    
    fontStyle - Font style for the tick, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
  - getFontStyle
```
public FontStyle getFontStyle()
```
    Returns the font style for the tick, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
    
    Returns:
    
    the font style for the tick, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
  - setFontColor
```
public void setFontColor(IsColor fontColor)
```
    Sets the font color for tick
    
    Parameters:
    
    fontColor - Font color for tick
  - setFontColor
```
public void setFontColor(String fontColor)
```
    Sets the font color for tick
    
    Parameters:
    
    fontColor - Font color for tick
  - getFontColorAsString
```
public String getFontColorAsString()
```
    Returns the font color for tick
    
    Returns:
    
    Font color for tick.
  - getFontColor
```
public IsColor getFontColor()
```
    Returns the font color for tick
    
    Returns:
    
    Font color for tick.
  - setFontFamily
```
public void setFontFamily(String fontFamily)
```
    Sets the font family for the tick, follows CSS font-family options.
    
    Parameters:
    
    fontFamily - Font family for the tick, follows CSS font-family options.
  - getFontFamily
```
public String getFontFamily()
```
    Returns the font family for the tick, follows CSS font-family options.
    
    Returns:
    
    Font family for the tick, follows CSS font-family options.
  - setLineHeight
```
public void setLineHeight(double lineHeight)
```
    Sets the height of an individual line of text.
    
    Parameters:
    
    lineHeight - height of an individual line of text.
  - setLineHeight
```
public void setLineHeight(String lineHeight)
```
    Sets the height of an individual line of text.
    
    Parameters:
    
    lineHeight - height of an individual line of text.
  - getLineHeight
```
public double getLineHeight()
```
    Returns the height of an individual line of text.
    
    Returns:
    
    the height of an individual line of text.
  - getLineHeightAsString
```
public String getLineHeightAsString()
```
    Returns the height of an individual line of text.
    
    Returns:
    
    the height of an individual line of text.
  - getAxis
```
public final Axis getAxis()
```
    Returns the axis instance.
    
    Returns:
    
    the axis

Class CartesianTimeTick

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setSource

getSource

setMax

getMax

setMin

getMin

getCallback

setCallback

setAutoSkip

isAutoSkip

setAutoSkipPadding

getAutoSkipPadding

setLabelOffset

getLabelOffset

setMaxRotation

getMaxRotation

setMinRotation

getMinRotation

setMirror

isMirror

setPadding

getPadding

setSampleSize

getSampleSize

getMinor

getMajor

setDisplay

isDisplay

setReverse

isReverse

setZ

getZ

setFontSize

getFontSize

setFontStyle

getFontStyle

setFontColor

setFontColor

getFontColorAsString

getFontColor

setFontFamily

getFontFamily

setLineHeight

setLineHeight

getLineHeight

getLineHeightAsString

getAxis