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 Number	fixedStepSize
protected Number	max
protected Number	maxTicksLimit
protected Number	min
protected Number	stepSize
protected Number	suggestedMax
protected Number	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

Constructor Summary

Constructors

Constructor	Description
LinearTicks()

Method Summary

Modifier and Type	Method	Description
Boolean	getBeginAtZero()
Number	getFixedStepSize()
Number	getMax()
Number	getMaxTicksLimit()
Number	getMin()
Number	getStepSize()
Number	getSuggestedMax()
Number	getSuggestedMin()
LinearTicks	setBeginAtZero(Boolean beginAtZero)	if true, scale will inclulde 0 if it is not already included.
LinearTicks	setFixedStepSize(Number fixedStepSize)	User defined fixed step size for the scale.
LinearTicks	setMax(Number max)	User defined maximum number for the scale, overrides maximum value from data.
LinearTicks	setMaxTicksLimit(Number maxTicksLimit)	Maximum number of ticks and gridlines to show.
LinearTicks	setMin(Number min)	User defined minimum number for the scale, overrides minimum value from data.
LinearTicks	setStepSize(Number stepSize)	if defined, it can be used along with the min and the max to give a custom number of steps.
LinearTicks	setSuggestedMax(Number suggestedMax)	User defined maximum number for the scale, overrides maximum value except for if it is lower than the maximum value.
LinearTicks	setSuggestedMin(Number 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, setAutoSkip, setAutoSkipPadding, setCallback, setDisplay, setFontColor, setFontFamily, setFontSize, setFontStyle, setLabelOffset, setMaxRotation, setMinRotation, setMirror, setPadding

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 Number min

max

protected Number max

maxTicksLimit

protected Number maxTicksLimit

fixedStepSize

protected Number fixedStepSize

stepSize

protected Number stepSize

suggestedMax

protected Number suggestedMax

suggestedMin

protected Number 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 Number getMin()

See Also:

• setMin(Number)

setMin

public LinearTicks setMin(Number min)

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

Default -

getMax

public Number getMax()

See Also:

• setMax(Number)

setMax

public LinearTicks setMax(Number max)

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

Default -

getMaxTicksLimit

public Number getMaxTicksLimit()

See Also:

• setMaxTicksLimit(Number)

setMaxTicksLimit

public LinearTicks setMaxTicksLimit(Number 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 Number getFixedStepSize()

See Also:

• setFixedStepSize(Number)

setFixedStepSize

public LinearTicks setFixedStepSize(Number 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 Number getStepSize()

See Also:

• setStepSize(Number)

setStepSize

public LinearTicks setStepSize(Number 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 Number getSuggestedMax()

See Also:

• setSuggestedMax(Number)

setSuggestedMax

public LinearTicks setSuggestedMax(Number suggestedMax)

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

Default -

getSuggestedMin

public Number getSuggestedMin()

See Also:

• setSuggestedMin(Number)

setSuggestedMin

public LinearTicks setSuggestedMin(Number suggestedMin)

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

Default -