Package software.xdev.chartjs.model.options.scales

Class Scale<T extends Ticks<T>,S extends Scale<T,S>>

java.lang.Object

software.xdev.chartjs.model.options.scales.Scale<T,S>

Direct Known Subclasses:

BarScale, CategoryScale, LinearScale, RadialLinearScale, TimeScale

public class Scale<T extends Ticks<T>,S extends Scale<T,S>>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected JavaScriptFunction	afterBuildTicks
protected JavaScriptFunction	afterCalculateTickRotation
protected JavaScriptFunction	afterDataLimits
protected JavaScriptFunction	afterFit
protected JavaScriptFunction	afterSetDimensions
protected JavaScriptFunction	afterTickToLabelConversion
protected JavaScriptFunction	afterUpdate
protected JavaScriptFunction	beforeBuildTicks
protected JavaScriptFunction	beforeCalculateTickRotation
protected JavaScriptFunction	beforeDataLimits
protected JavaScriptFunction	beforeFit
protected JavaScriptFunction	beforeSetDimensions
protected JavaScriptFunction	beforeTickToLabelConversion
protected JavaScriptFunction	beforeUpdate
protected Boolean	display
protected GridLines	gridLines
protected BigDecimal	max
protected BigDecimal	min
protected ScalesPosition	position
protected String	stack
protected Boolean	stacked
protected BigDecimal	stackWeight
protected BigDecimal	suggestedMax
protected BigDecimal	suggestedMin
protected T	ticks
protected ScaleTitle	title

Constructor Summary

Constructors

Constructor	Description
Scale()

Method Summary

Modifier and Type	Method	Description
JavaScriptFunction	getAfterBuildTicks()
JavaScriptFunction	getAfterCalculateTickRotation()
JavaScriptFunction	getAfterDataLimits()
JavaScriptFunction	getAfterFit()
JavaScriptFunction	getAfterSetDimensions()
JavaScriptFunction	getAfterTickToLabelConversion()
JavaScriptFunction	getAfterUpdate()
JavaScriptFunction	getBeforeBuildTicks()
JavaScriptFunction	getBeforeCalculateTickRotation()
JavaScriptFunction	getBeforeDataLimits()
JavaScriptFunction	getBeforeFit()
JavaScriptFunction	getBeforeSetDimensions()
JavaScriptFunction	getBeforeTickToLabelConversion()
JavaScriptFunction	getBeforeUpdate()
Boolean	getDisplay()
GridLines	getGridLines()
BigDecimal	getMax()
BigDecimal	getMin()
ScalesPosition	getPosition()
String	getStack()
Boolean	getStacked()
BigDecimal	getStackWeight()
BigDecimal	getSuggestedMax()
BigDecimal	getSuggestedMin()
T	getTicks()
ScaleTitle	getTitle()
protected S	self()
S	setAfterBuildTicks(JavaScriptFunction afterBuildTicks)	Callback that runs after ticks are created.
S	setAfterCalculateTickRotation(JavaScriptFunction afterCalculateTickRotation)	Callback that runs after tick rotation is determined.
S	setAfterDataLimits(JavaScriptFunction afterDataLimits)	Callback that runs after data limits are determined.
S	setAfterFit(JavaScriptFunction afterFit)	Callback that runs after the scale fits to the canvas.
S	setAfterSetDimensions(JavaScriptFunction afterSetDimensions)	Callback that runs after dimensions are set.
S	setAfterTickToLabelConversion(JavaScriptFunction afterTickToLabelConversion)	Callback that runs after ticks are converted into strings.
S	setAfterUpdate(JavaScriptFunction afterUpdate)	Callback that runs at the end of the update process.
S	setBeforeBuildTicks(JavaScriptFunction beforeBuildTicks)	Callback that runs before ticks are created.
S	setBeforeCalculateTickRotation(JavaScriptFunction beforeCalculateTickRotation)	Callback that runs before tick rotation is determined.
S	setBeforeDataLimits(JavaScriptFunction beforeDataLimits)	Callback that runs before data limits are determined.
S	setBeforeFit(JavaScriptFunction beforeFit)	Callback that runs before the scale fits to the canvas.
S	setBeforeSetDimensions(JavaScriptFunction beforeSetDimensions)	Callback that runs before dimensions are set.
S	setBeforeTickToLabelConversion(JavaScriptFunction beforeTickToLabelConversion)	Callback that runs before ticks are converted into strings.
S	setBeforeUpdate(JavaScriptFunction beforeUpdate)	Callback called before the update process starts.
S	setDisplay(Boolean display)	If true, show the scale including gridlines, ticks, and labels.
S	setGridLines(GridLines gridLines)	See grid line configuration section.
S	setMax(BigDecimal max)
S	setMin(BigDecimal min)
S	setPosition(ScalesPosition position)	Position of the scale.
S	setStack(String stack)
S	setStacked(Boolean stacked)	If true, bars are stacked on the x-axis
S	setStackWeight(BigDecimal stackWeight)
S	setSuggestedMax(BigDecimal suggestedMax)
S	setSuggestedMin(BigDecimal suggestedMin)
S	setTicks(T ticks)	Defines options for the tick marks that are generated by the axis
S	setTitle(ScaleTitle title)	See scale title configuration section.

Methods inherited from class java.lang.Object

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

Field Details

ticks

protected T extends Ticks<T> ticks

display

protected Boolean display

position

protected ScalesPosition position

min

protected BigDecimal min

max

protected BigDecimal max

suggestedMin

protected BigDecimal suggestedMin

suggestedMax

protected BigDecimal suggestedMax

stack

protected String stack

stackWeight

protected BigDecimal stackWeight

beforeUpdate

protected JavaScriptFunction beforeUpdate

beforeSetDimensions

protected JavaScriptFunction beforeSetDimensions

afterSetDimensions

protected JavaScriptFunction afterSetDimensions

beforeDataLimits

protected JavaScriptFunction beforeDataLimits

afterDataLimits

protected JavaScriptFunction afterDataLimits

beforeBuildTicks

protected JavaScriptFunction beforeBuildTicks

afterBuildTicks

protected JavaScriptFunction afterBuildTicks

beforeTickToLabelConversion

protected JavaScriptFunction beforeTickToLabelConversion

afterTickToLabelConversion

protected JavaScriptFunction afterTickToLabelConversion

beforeCalculateTickRotation

protected JavaScriptFunction beforeCalculateTickRotation

afterCalculateTickRotation

protected JavaScriptFunction afterCalculateTickRotation

beforeFit

protected JavaScriptFunction beforeFit

afterFit

protected JavaScriptFunction afterFit

afterUpdate

protected JavaScriptFunction afterUpdate

gridLines

protected GridLines gridLines

title

protected ScaleTitle title

stacked

protected Boolean stacked

Constructor Details

Scale

public Scale()

Method Details

getTicks

public T getTicks()

See Also:

• setTicks(Ticks)

setTicks

public S setTicks(T ticks)

Defines options for the tick marks that are generated by the axis

getMin

public BigDecimal getMin()

setMin

public S setMin(BigDecimal min)

getMax

public BigDecimal getMax()

setMax

public S setMax(BigDecimal max)

getSuggestedMin

public BigDecimal getSuggestedMin()

setSuggestedMin

public S setSuggestedMin(BigDecimal suggestedMin)

getSuggestedMax

public BigDecimal getSuggestedMax()

setSuggestedMax

public S setSuggestedMax(BigDecimal suggestedMax)

getDisplay

public Boolean getDisplay()

See Also:

• setDisplay(Boolean)

setDisplay

public S setDisplay(Boolean display)

If true, show the scale including gridlines, ticks, and labels. Overrides gridLines.display, scaleLabel.display, and ticks.display.

Default true

getPosition

public ScalesPosition getPosition()

See Also:

• setPosition(ScalesPosition)

setPosition

public S setPosition(ScalesPosition position)

Position of the scale. Possible values are 'top', 'left', 'bottom' and 'right'.

Default "left"

getBeforeUpdate

public JavaScriptFunction getBeforeUpdate()

See Also:

• setBeforeUpdate(JavaScriptFunction)

setBeforeUpdate

public S setBeforeUpdate(JavaScriptFunction beforeUpdate)

Callback called before the update process starts. Passed a single argument, the scale instance.

Default undefined

getBeforeSetDimensions

public JavaScriptFunction getBeforeSetDimensions()

See Also:

• setBeforeSetDimensions(JavaScriptFunction)

setBeforeSetDimensions

public S setBeforeSetDimensions(JavaScriptFunction beforeSetDimensions)

Callback that runs before dimensions are set. Passed a single argument, the scale instance.

Default undefined

getAfterSetDimensions

public JavaScriptFunction getAfterSetDimensions()

See Also:

• setAfterSetDimensions(JavaScriptFunction)

setAfterSetDimensions

public S setAfterSetDimensions(JavaScriptFunction afterSetDimensions)

Callback that runs after dimensions are set. Passed a single argument, the scale instance.

Default undefined

getBeforeDataLimits

public JavaScriptFunction getBeforeDataLimits()

See Also:

• setBeforeDataLimits(JavaScriptFunction)

setBeforeDataLimits

public S setBeforeDataLimits(JavaScriptFunction beforeDataLimits)

Callback that runs before data limits are determined. Passed a single argument, the scale instance.

Default undefined

getAfterDataLimits

public JavaScriptFunction getAfterDataLimits()

See Also:

• setAfterDataLimits(JavaScriptFunction)

setAfterDataLimits

public S setAfterDataLimits(JavaScriptFunction afterDataLimits)

Callback that runs after data limits are determined. Passed a single argument, the scale instance.

Default undefined

getBeforeBuildTicks

public JavaScriptFunction getBeforeBuildTicks()

See Also:

• setBeforeBuildTicks(JavaScriptFunction)

setBeforeBuildTicks

public S setBeforeBuildTicks(JavaScriptFunction beforeBuildTicks)

Callback that runs before ticks are created. Passed a single argument, the scale instance.

Default undefined

getAfterBuildTicks

public JavaScriptFunction getAfterBuildTicks()

See Also:

• setAfterBuildTicks(JavaScriptFunction)

setAfterBuildTicks

public S setAfterBuildTicks(JavaScriptFunction afterBuildTicks)

Callback that runs after ticks are created. Useful for filtering ticks. Passed a single argument, the scale instance.

Default undefined

getBeforeTickToLabelConversion

public JavaScriptFunction getBeforeTickToLabelConversion()

See Also:

• setBeforeTickToLabelConversion(JavaScriptFunction)

setBeforeTickToLabelConversion

public S setBeforeTickToLabelConversion(JavaScriptFunction beforeTickToLabelConversion)

Callback that runs before ticks are converted into strings. Passed a single argument, the scale instance.

Default undefined

getAfterTickToLabelConversion

public JavaScriptFunction getAfterTickToLabelConversion()

See Also:

• setAfterTickToLabelConversion(JavaScriptFunction)

setAfterTickToLabelConversion

public S setAfterTickToLabelConversion(JavaScriptFunction afterTickToLabelConversion)

Callback that runs after ticks are converted into strings. Passed a single argument, the scale instance.

Default undefined

getBeforeCalculateTickRotation

public JavaScriptFunction getBeforeCalculateTickRotation()

See Also:

• setBeforeCalculateTickRotation(JavaScriptFunction)

setBeforeCalculateTickRotation

public S setBeforeCalculateTickRotation(JavaScriptFunction beforeCalculateTickRotation)

Callback that runs before tick rotation is determined. Passed a single argument, the scale instance.

Default undefined

getAfterCalculateTickRotation

public JavaScriptFunction getAfterCalculateTickRotation()

See Also:

• setAfterCalculateTickRotation(JavaScriptFunction)

setAfterCalculateTickRotation

public S setAfterCalculateTickRotation(JavaScriptFunction afterCalculateTickRotation)

Callback that runs after tick rotation is determined. Passed a single argument, the scale instance.

Default undefined

getBeforeFit

public JavaScriptFunction getBeforeFit()

See Also:

• setBeforeFit(JavaScriptFunction)

setBeforeFit

public S setBeforeFit(JavaScriptFunction beforeFit)

Callback that runs before the scale fits to the canvas. Passed a single argument, the scale instance.

Default undefined

getAfterFit

public JavaScriptFunction getAfterFit()

See Also:

• setAfterFit(JavaScriptFunction)

setAfterFit

public S setAfterFit(JavaScriptFunction afterFit)

Callback that runs after the scale fits to the canvas. Passed a single argument, the scale instance.

Default undefined

getAfterUpdate

public JavaScriptFunction getAfterUpdate()

See Also:

• setAfterUpdate(JavaScriptFunction)

setAfterUpdate

public S setAfterUpdate(JavaScriptFunction afterUpdate)

Callback that runs at the end of the update process. Passed a single argument, the scale instance.

Default undefined

getGridLines

public GridLines getGridLines()

See Also:

• setGridLines(GridLines)

setGridLines

public S setGridLines(GridLines gridLines)

See grid line configuration section.

Default -

getTitle

public ScaleTitle getTitle()

See Also:

• setTitle(ScaleTitle)

setTitle

public S setTitle(ScaleTitle title)

See scale title configuration section.

Default

getStack

public String getStack()

setStack

public S setStack(String stack)

getStackWeight

public BigDecimal getStackWeight()

setStackWeight

public S setStackWeight(BigDecimal stackWeight)

getStacked

public Boolean getStacked()

See Also:

• setStacked(Boolean stacked)

setStacked

public S setStacked(Boolean stacked)

If true, bars are stacked on the x-axis

self

protected S self()