Package software.xdev.chartjs.model.options.ticks

Class LinearTicks

java.lang.Object

software.xdev.chartjs.model.options.ticks.Ticks<LinearTicks>

software.xdev.chartjs.model.options.ticks.LinearTicks

public class LinearTicks
extends Ticks<LinearTicks>

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	beginAtZero
protected BigDecimal	fixedStepSize
protected BigDecimal	max
protected BigDecimal	maxTicksLimit
protected BigDecimal	min
protected BigDecimal	stepSize
protected BigDecimal	suggestedMax
protected BigDecimal	suggestedMin

Fields inherited from class software.xdev.chartjs.model.options.ticks.Ticks

autoSkip, autoSkipPadding, callback, display, fontColor, fontFamily, fontSize, fontStyle, labelOffset, maxRotation, minRotation, mirror, padding, reverse

Constructor Summary

Constructors

Constructor	Description
LinearTicks()

Method Summary

Modifier and Type	Method	Description
Boolean	getBeginAtZero()
BigDecimal	getFixedStepSize()
BigDecimal	getMax()
BigDecimal	getMaxTicksLimit()
BigDecimal	getMin()
BigDecimal	getStepSize()
BigDecimal	getSuggestedMax()
BigDecimal	getSuggestedMin()
LinearTicks	setBeginAtZero(Boolean beginAtZero)	if true, scale will inclulde 0 if it is not already included.
LinearTicks	setFixedStepSize(BigDecimal fixedStepSize)	User defined fixed step size for the scale.
LinearTicks	setMax(int max)
LinearTicks	setMax(BigDecimal max)	User defined maximum number for the scale, overrides maximum value from data.
LinearTicks	setMaxTicksLimit(BigDecimal maxTicksLimit)	Maximum number of ticks and gridlines to show.
LinearTicks	setMin(int min)
LinearTicks	setMin(BigDecimal min)	User defined minimum number for the scale, overrides minimum value from data.
LinearTicks	setStepSize(double stepSize)
LinearTicks	setStepSize(int stepSize)
LinearTicks	setStepSize(BigDecimal stepSize)	if defined, it can be used along with the min and the max to give a custom number of steps.
LinearTicks	setSuggestedMax(BigDecimal suggestedMax)	User defined maximum number for the scale, overrides maximum value except for if it is lower than the maximum value.
LinearTicks	setSuggestedMin(BigDecimal suggestedMin)	User defined minimum number for the scale, overrides minimum value except for if it is higher than the minimum value.

Methods inherited from class software.xdev.chartjs.model.options.ticks.Ticks

getAutoSkip, getAutoSkipPadding, getCallback, getDisplay, getFontColor, getFontFamily, getFontSize, getFontStyle, getLabelOffset, getMaxRotation, getMinRotation, getMirror, getPadding, getReverse, setAutoSkip, setAutoSkipPadding, setCallback, setDisplay, setFontColor, setFontFamily, setFontSize, setFontStyle, setLabelOffset, setMaxRotation, setMinRotation, setMirror, setPadding, setReverse

Methods inherited from class java.lang.Object

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

Field Details

beginAtZero

protected Boolean beginAtZero

min

protected BigDecimal min

max

protected BigDecimal max

maxTicksLimit

protected BigDecimal maxTicksLimit

fixedStepSize

protected BigDecimal fixedStepSize

stepSize

protected BigDecimal stepSize

suggestedMax

protected BigDecimal suggestedMax

suggestedMin

protected BigDecimal suggestedMin

Constructor Details

LinearTicks

public LinearTicks()

Method Details

getBeginAtZero

public Boolean getBeginAtZero()

setBeginAtZero

public LinearTicks setBeginAtZero(Boolean beginAtZero)

if true, scale will inclulde 0 if it is not already included.

Default -

getMin

public BigDecimal getMin()

See Also:

• setMin(BigDecimal)

setMin

public LinearTicks setMin(int min)

See Also:

• setMin(BigDecimal)

setMin

public LinearTicks setMin(BigDecimal min)

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

Default -

getMax

public BigDecimal getMax()

See Also:

• setMax(BigDecimal)

setMax

public LinearTicks setMax(int max)

See Also:

• setMax(BigDecimal)

setMax

public LinearTicks setMax(BigDecimal max)

User defined maximum number for the scale, overrides maximum value from data.

Default -

getMaxTicksLimit

public BigDecimal getMaxTicksLimit()

See Also:

• setMaxTicksLimit(BigDecimal)

setMaxTicksLimit

public LinearTicks setMaxTicksLimit(BigDecimal maxTicksLimit)

Maximum number of ticks and gridlines to show. If not defined, it will limit to 11 ticks but will show all gridlines.

Default 11

getFixedStepSize

public BigDecimal getFixedStepSize()

See Also:

• setFixedStepSize(BigDecimal)

setFixedStepSize

public LinearTicks setFixedStepSize(BigDecimal fixedStepSize)

User defined fixed step size for the scale. If set, the scale ticks will be enumerated by multiple of stepSize, having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.

Default -

getStepSize

public BigDecimal getStepSize()

See Also:

• setStepSize(BigDecimal)

setStepSize

public LinearTicks setStepSize(double stepSize)

See Also:

• setStepSize(BigDecimal)

setStepSize

public LinearTicks setStepSize(int stepSize)

See Also:

• setStepSize(BigDecimal)

setStepSize

public LinearTicks setStepSize(BigDecimal stepSize)

if defined, it can be used along with the min and the max to give a custom number of steps. See the example below.

Default -

getSuggestedMax

public BigDecimal getSuggestedMax()

See Also:

• setSuggestedMax(BigDecimal)

setSuggestedMax

public LinearTicks setSuggestedMax(BigDecimal suggestedMax)

User defined maximum number for the scale, overrides maximum value except for if it is lower than the maximum value.

Default -

getSuggestedMin

public BigDecimal getSuggestedMin()

See Also:

• setSuggestedMin(BigDecimal)

setSuggestedMin

public LinearTicks setSuggestedMin(BigDecimal suggestedMin)

User defined minimum number for the scale, overrides minimum value except for if it is higher than the minimum value.

Default -