org.pepstock.charba.client.defaults.chart

Class DefaultChartTicks

java.lang.Object

org.pepstock.charba.client.defaults.chart.DefaultChartTicks

All Implemented Interfaces:

IsDefaultBaseTick, IsDefaultFontItem, IsDefaultTicks

public final class DefaultChartTicks
extends Object
implements IsDefaultTicks

Defaults for ticks option element, based on chart type.

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.
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.
String	getFontColorAsString() Returns the font color
String	getFontFamily() Returns the font family, follows CSS font-family options.
int	getFontSize() Returns the font size.
FontStyle	getFontStyle() Returns the font style, 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.
IsDefaultMajorTick	getMajor() Returns the major tick defaults.
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.
IsDefaultMinorTick	getMinor() Returns the minor tick defaults.
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.
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.
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.
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	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.

Methods inherited from class java.lang.Object

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

Method Detail

getFontColorAsString

public String getFontColorAsString()

Description copied from interface: IsDefaultFontItem

Returns the font color

Specified by:

getFontColorAsString in interface IsDefaultFontItem

Returns:

Font color

getFontSize

public int getFontSize()

Description copied from interface: IsDefaultFontItem

Returns the font size.

Specified by:

getFontSize in interface IsDefaultFontItem

Returns:

the font size.

getFontStyle

public FontStyle getFontStyle()

Description copied from interface: IsDefaultFontItem

Returns the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Specified by:

getFontStyle in interface IsDefaultFontItem

Returns:

the font style, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

getFontFamily

public String getFontFamily()

Description copied from interface: IsDefaultFontItem

Returns the font family, follows CSS font-family options.

Specified by:

getFontFamily in interface IsDefaultFontItem

Returns:

Font family, follows CSS font-family options.

getMinor

public IsDefaultMinorTick getMinor()

Description copied from interface: IsDefaultTicks

Returns the minor tick defaults.

Specified by:

getMinor in interface IsDefaultTicks

Returns:

the minor tick defaults.

getMajor

public IsDefaultMajorTick getMajor()

Description copied from interface: IsDefaultTicks

Returns the major tick defaults.

Specified by:

getMajor in interface IsDefaultTicks

Returns:

the major tick defaults.

isBeginAtZero

public boolean isBeginAtZero()

Description copied from interface: IsDefaultTicks

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.

isDisplay

public boolean isDisplay()

Description copied from interface: IsDefaultTicks

If true, show tick marks

Specified by:

isDisplay in interface IsDefaultTicks

Returns:

if true, show tick marks.

isReverse

public boolean isReverse()

Description copied from interface: IsDefaultTicks

Returns the reverses order of tick labels.

Specified by:

isReverse in interface IsDefaultTicks

Returns:

reverses order of tick labels.

isAutoSkip

public boolean isAutoSkip()

Description copied from interface: IsDefaultTicks

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.

getAutoSkipPadding

public int getAutoSkipPadding()

Description copied from interface: IsDefaultTicks

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.

getLabelOffset

public int getLabelOffset()

Description copied from 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).
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).

getMaxRotation

public int getMaxRotation()

Description copied from interface: IsDefaultTicks

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.

getMinRotation

public int getMinRotation()

Description copied from interface: IsDefaultTicks

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.

isMirror

public boolean isMirror()

Description copied from interface: IsDefaultTicks

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.

getPadding

public int getPadding()

Description copied from interface: IsDefaultTicks

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.

getMin

public double getMin()

Description copied from interface: IsDefaultTicks

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.

getMax

public double getMax()

Description copied from interface: IsDefaultTicks

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.

getMaxTicksLimit

public int getMaxTicksLimit()

Description copied from interface: IsDefaultTicks

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.

getStepSize

public double getStepSize()

Description copied from interface: IsDefaultTicks

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.

getSuggestedMax

public double getSuggestedMax()

Description copied from interface: IsDefaultTicks

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.

getSuggestedMin

public double getSuggestedMin()

Description copied from interface: IsDefaultTicks

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.

getBackdropColorAsString

public String getBackdropColorAsString()

Description copied from interface: IsDefaultTicks

Returns the color of label backdrops.

Specified by:

getBackdropColorAsString in interface IsDefaultTicks

Returns:

color of label backdrops.

getBackdropPaddingX

public int getBackdropPaddingX()

Description copied from interface: IsDefaultTicks

Returns the horizontal padding of label backdrop.

Specified by:

getBackdropPaddingX in interface IsDefaultTicks

Returns:

horizontal padding of label backdrop.

getBackdropPaddingY

public int getBackdropPaddingY()

Description copied from interface: IsDefaultTicks

Returns the vertical padding of label backdrop.

Specified by:

getBackdropPaddingY in interface IsDefaultTicks

Returns:

vertical padding of label backdrop.

isShowLabelBackdrop

public boolean isShowLabelBackdrop()

Description copied from interface: IsDefaultTicks

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.

getSource

public TickSource getSource()

Description copied from interface: IsDefaultTicks

Returns the property controls the ticks generation.

Specified by:

getSource in interface IsDefaultTicks

Returns:

property controls the ticks generation.

getPrecision

public int getPrecision()

Description copied from interface: IsDefaultTicks

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.

getLineHeight

public double getLineHeight()

Description copied from interface: IsDefaultBaseTick

Returns the height of an individual line of text.

Specified by:

getLineHeight in interface IsDefaultBaseTick

Returns:

the height of an individual line of text.

getZ

public int getZ()

Description copied from interface: IsDefaultTicks

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.

Specified by:

getZ in interface IsDefaultTicks

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.

getSampleSize

public int getSampleSize()

Description copied from interface: IsDefaultTicks

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.

Specified by:

getSampleSize in interface IsDefaultTicks

Returns:

the number of ticks to examine when deciding how many labels will fit.