Ticks (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer
- - org.pepstock.charba.client.options.AbstractModel<P,D>
  - - org.pepstock.charba.client.options.FontItem<P,D>
    - - org.pepstock.charba.client.options.AbstractTick<Scale,IsDefaultTicks>
      - org.pepstock.charba.client.options.Ticks

All Implemented Interfaces:

IsDefaultFontItem, IsDefaultTicks
```
public final class Ticks
extends AbstractTick<Scale,IsDefaultTicks>
implements IsDefaultTicks
```
All configuration for ticks of a chart.
It defines options for the tick marks that are generated by the 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.
`IsColor`	`getBackdropColor()` Returns the color of label backdrops.
`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 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.
`List<String>`	`getLabels()` Returns the array of labels to display.
`TickMajor`	`getMajor()` Returns the major element.
`double`	`getMax()` Returns the user defined maximum number for the scale, overrides maximum value from data.
`String`	`getMaxAsString()` 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.
`String`	`getMinAsString()` Returns the user defined minimum number for the scale, overrides minimum value from data.
`TickMinor`	`getMinor()` Returns the 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`	`getPrecision()` If defined and stepSize is not specified, the step size will be rounded to this many decimal places.
`TickSource`	`getSource()` Returns the property controls the ticks generation.
`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(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 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`	`setLabels(List<String> labels)` Sets an array of labels to display.
`void`	`setLabels(String... labels)` Sets an array of labels to display.
`void`	`setMax(double max)` Sets the user defined maximum number for the scale, overrides maximum value from data.
`void`	`setMax(String 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`	`setMin(String 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`	`setPrecision(int precision)` If defined and stepSize is not specified, the step size will be rounded to this many decimal places.
`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`	`setSource(TickSource source)` Sets the property controls the ticks generation.
`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.FontItem
getFontColor, getFontColorAsString, getFontFamily, getFontSize, getFontStyle, setFontColor, setFontColor, setFontFamily, setFontSize, setFontStyle

Methods inherited from class org.pepstock.charba.client.options.AbstractModel
checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultFontItem
getFontColorAsString, getFontFamily, getFontSize, getFontStyle

- Method Detail
  - getMinor
```
public final TickMinor getMinor()
```
    Returns the minor tick element.
    
    Specified by:
    
    getMinor in interface IsDefaultTicks
    
    Returns:
    
    the minor
  - getMajor
```
public final TickMajor getMajor()
```
    Returns the major element.
    
    Specified by:
    
    getMajor in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    isBeginAtZero in interface IsDefaultTicks
    
    Returns:
    
    if true, scale will include 0 if it is not already included.
  - 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.
    
    Specified by:
    
    isDisplay in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    isReverse in interface IsDefaultTicks
    
    Returns:
    
    if true reverses order of tick labels.
  - 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
    
    Specified by:
    
    isAutoSkip in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getAutoSkipPadding in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getLabelOffset in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getMaxRotation in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getMinRotation in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    isMirror in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getPadding in interface IsDefaultTicks
    
    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.
  - 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.
    
    Specified by:
    
    getMin in interface IsDefaultTicks
    
    Returns:
    
    the 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.
    
    Specified by:
    
    getMax in interface IsDefaultTicks
    
    Returns:
    
    user defined maximum number for the scale, overrides maximum value from data.
  - setMin
```
public void setMin(String 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.
  - getMinAsString
```
public String getMinAsString()
```
    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.
  - setMax
```
public void setMax(String 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.
  - getMaxAsString
```
public String getMaxAsString()
```
    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.
    
    Specified by:
    
    getMaxTicksLimit in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getStepSize in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getSuggestedMax in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getSuggestedMin in interface IsDefaultTicks
    
    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(String backdropColor)
```
    Sets the color of label backdrops.
    
    Parameters:
    
    backdropColor - color of label backdrops.
  - getBackdropColorAsString
```
public String getBackdropColorAsString()
```
    Returns the color of label backdrops.
    
    Specified by:
    
    getBackdropColorAsString in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getBackdropPaddingX in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    getBackdropPaddingY in interface IsDefaultTicks
    
    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.
    
    Specified by:
    
    isShowLabelBackdrop in interface IsDefaultTicks
    
    Returns:
    
    if true, draw a background behind the tick labels.
  - setLabels
```
public void setLabels(String... labels)
```
    Sets an array of labels to display.
    
    Parameters:
    
    labels - An array of labels to display.
  - setLabels
```
public void setLabels(List<String> labels)
```
    Sets an array of labels to display.
    
    Parameters:
    
    labels - A list of labels to display.
  - getLabels
```
public List<String> getLabels()
```
    Returns the array of labels to display.
    
    Returns:
    
    the array of labels to display.
  - 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.
    
    Specified by:
    
    getSource in interface IsDefaultTicks
    
    Returns:
    
    property controls the ticks generation.
  - setPrecision
```
public void setPrecision(int precision)
```
    If defined and stepSize is not specified, the step size will be rounded to this many decimal places.
    
    Parameters:
    
    precision - if defined and stepSize is not specified, the step size will be rounded to this many decimal places.
  - getPrecision
```
public int getPrecision()
```
    If defined and stepSize is not specified, the step size will be rounded to this many decimal places.
    
    Specified by:
    
    getPrecision in interface IsDefaultTicks
    
    Returns:
    
    if defined and stepSize is not specified, the step size will be rounded to this many decimal places.

Class Ticks

Method Summary

Methods inherited from class org.pepstock.charba.client.options.FontItem

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

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

Methods inherited from class java.lang.Object

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

Method Detail

getMinor

getMajor

setBeginAtZero

isBeginAtZero

setDisplay

isDisplay

setReverse

isReverse

setAutoSkip

isAutoSkip

setAutoSkipPadding

getAutoSkipPadding

setLabelOffset

getLabelOffset

setMaxRotation

getMaxRotation

setMinRotation

getMinRotation

setMirror

isMirror

setPadding

getPadding

setMin

getMin

setMax

getMax

setMin

getMinAsString

setMax

getMaxAsString

setMaxTicksLimit

getMaxTicksLimit

setStepSize

getStepSize

setSuggestedMax

getSuggestedMax

setSuggestedMin

getSuggestedMin

setBackdropColor

setBackdropColor

getBackdropColorAsString

getBackdropColor

setBackdropPaddingX

getBackdropPaddingX

setBackdropPaddingY

getBackdropPaddingY

setShowLabelBackdrop

isShowLabelBackdrop

setLabels

setLabels

getLabels

setSource

getSource

setPrecision

getPrecision