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

Class BarScale<T extends Ticks<T>>

java.lang.Object

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

software.xdev.chartjs.model.options.scales.BarScale<T>

public class BarScale<T extends Ticks<T>>
extends Scale<T,BarScale<T>>

Field Summary

Fields

Modifier and Type	Field	Description
protected Number	barPercentage	Default 0.9
protected Number	barThickness
protected Number	categoryPercentage	Default 0.8
protected Number	maxBarThickness
protected String	type	Default "Category"

Fields inherited from class software.xdev.chartjs.model.options.scales.Scale

afterBuildTicks, afterCalculateTickRotation, afterDataLimits, afterFit, afterSetDimensions, afterTickToLabelConversion, afterUpdate, beforeBuildTicks, beforeCalculateTickRotation, beforeDataLimits, beforeFit, beforeSetDimensions, beforeTickToLabelConversion, beforeUpdate, display, gridLines, max, min, position, reverse, stack, stacked, stackWeight, suggestedMax, suggestedMin, ticks, title

Constructor Summary

Constructors

Constructor	Description
BarScale()

Method Summary

Modifier and Type	Method	Description
Number	getBarPercentage()
Number	getBarThickness()
Number	getCategoryPercentage()
Number	getMaxBarThickness()
String	getType()
BarScale<T>	setBarPercentage(Number barPercentage)	Percent (0-1) of the available width each bar should be within the category percentage.
BarScale<T>	setBarThickness(Number barThickness)	Manually set width of each bar in pixels.
BarScale<T>	setCategoryPercentage(Number categoryPercentage)	Percent (0-1) of the available width (the space between the gridlines for small datasets) for each data-point to use for the bars.
BarScale<T>	setMaxBarThickness(Number maxBarThickness)	Set this to ensure that bars are not sized thicker than this.
BarScale<T>	setType(String type)	As defined in Scales.

Methods inherited from class software.xdev.chartjs.model.options.scales.Scale

getAfterBuildTicks, getAfterCalculateTickRotation, getAfterDataLimits, getAfterFit, getAfterSetDimensions, getAfterTickToLabelConversion, getAfterUpdate, getBeforeBuildTicks, getBeforeCalculateTickRotation, getBeforeDataLimits, getBeforeFit, getBeforeSetDimensions, getBeforeTickToLabelConversion, getBeforeUpdate, getDisplay, getGridLines, getMax, getMin, getPosition, getReverse, getStack, getStacked, getStackWeight, getSuggestedMax, getSuggestedMin, getTicks, getTitle, self, setAfterBuildTicks, setAfterCalculateTickRotation, setAfterDataLimits, setAfterFit, setAfterSetDimensions, setAfterTickToLabelConversion, setAfterUpdate, setBeforeBuildTicks, setBeforeCalculateTickRotation, setBeforeDataLimits, setBeforeFit, setBeforeSetDimensions, setBeforeTickToLabelConversion, setBeforeUpdate, setDisplay, setGridLines, setMax, setMin, setPosition, setReverse, setStack, setStacked, setStackWeight, setSuggestedMax, setSuggestedMin, setTicks, setTitle

Methods inherited from class java.lang.Object

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

Field Details

type

protected String type

Default "Category"

See Also:

• setType(String type)

categoryPercentage

protected Number categoryPercentage

Default 0.8

See Also:

• setCategoryPercentage(Number categoryPercentage)

barPercentage

protected Number barPercentage

Default 0.9

See Also:

• setBarPercentage(Number barPercentage)

barThickness

protected Number barThickness

maxBarThickness

protected Number maxBarThickness

Constructor Details

BarScale

public BarScale()

Method Details

getType

public String getType()

See Also:

• setType(String type)

setType

public BarScale<T> setType(String type)

As defined in Scales.

getCategoryPercentage

public Number getCategoryPercentage()

See Also:

• setCategoryPercentage(Number categoryPercentage)

setCategoryPercentage

public BarScale<T> setCategoryPercentage(Number categoryPercentage)

Percent (0-1) of the available width (the space between the gridlines for small datasets) for each data-point to use for the bars.

getBarPercentage

public Number getBarPercentage()

See Also:

• setBarPercentage(Number barPercentage)

setBarPercentage

public BarScale<T> setBarPercentage(Number barPercentage)

Percent (0-1) of the available width each bar should be within the category percentage. 1.0 will take the whole category width and put the bars right next to each other.

getBarThickness

public Number getBarThickness()

See Also:

• setBarThickness(Number)

setBarThickness

public BarScale<T> setBarThickness(Number barThickness)

Manually set width of each bar in pixels. If not set, the base sample widths are calculated automatically so that they take the full available widths without overlap. Then, the bars are sized using barPercentage and categoryPercentage.

getMaxBarThickness

public Number getMaxBarThickness()

See Also:

• Scale.setGridLines(GridLines gridLines)

setMaxBarThickness

public BarScale<T> setMaxBarThickness(Number maxBarThickness)

Set this to ensure that bars are not sized thicker than this.