be.ceau.chart.options.scales

Class XAxis<T extends Ticks<T>>

java.lang.Object

be.ceau.chart.options.scales.XAxis<T>

public class XAxis<T extends Ticks<T>>
extends Object

Constructor Summary

Constructors

Constructor and Description
XAxis()

Method Summary

Modifier and Type	Method and Description
BigDecimal	getBarPercentage()
BigDecimal	getBarThickness()
BigDecimal	getCategoryPercentage()
Boolean	getDisplay()
GridLines	getGridLines()
String	getId()
BigDecimal	getMaxBarThickness()
Boolean	getStacked()
T	getTicks()
String	getType()
XAxis<T>	setBarPercentage(BigDecimal barPercentage) Percent (0-1) of the available width each bar should be within the category percentage.
XAxis<T>	setBarThickness(BigDecimal barThickness) Manually set width of each bar in pixels.
XAxis<T>	setCategoryPercentage(BigDecimal 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.
XAxis<T>	setDisplay(Boolean display) If true, show the scale.
XAxis<T>	setGridLines(GridLines gridLines) If true, the bars for a particular data point fall between the grid lines.
XAxis<T>	setId(String id) Id of the axis so that data can bind to it
XAxis<T>	setMaxBarThickness(BigDecimal maxBarThickness) Set this to ensure that bars are not sized thicker than this.
XAxis<T>	setStacked(Boolean stacked) If true, bars are stacked on the x-axis
XAxis<T>	setTicks(T ticks) Defines options for the tick marks that are generated by the axis
XAxis<T>	setType(String type) As defined in Scales.

Methods inherited from class java.lang.Object

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

Constructor Detail

XAxis

public XAxis()

Method Detail

getTicks

public T getTicks()

See Also:

setTicks(Ticks)

setTicks

public XAxis<T> setTicks(T ticks)

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

getType

public String getType()

See Also:

setType(String type)

setType

public XAxis<T> setType(String type)

As defined in Scales.

getDisplay

public Boolean getDisplay()

See Also:

setDisplay(Boolean display)

setDisplay

public XAxis<T> setDisplay(Boolean display)

If true, show the scale.

getId

public String getId()

See Also:

setId(String id)

setId

public XAxis<T> setId(String id)

Id of the axis so that data can bind to it

getStacked

public Boolean getStacked()

See Also:

setStacked(Boolean stacked)

setStacked

public XAxis<T> setStacked(Boolean stacked)

If true, bars are stacked on the x-axis

getCategoryPercentage

public BigDecimal getCategoryPercentage()

See Also:

setCategoryPercentage(BigDecimal categoryPercentage)

setCategoryPercentage

public XAxis<T> setCategoryPercentage(BigDecimal 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 BigDecimal getBarPercentage()

See Also:

setBarPercentage(BigDecimal barPercentage)

setBarPercentage

public XAxis<T> setBarPercentage(BigDecimal 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 BigDecimal getBarThickness()

See Also:

setBarThickness(BigDecimal)

setBarThickness

public XAxis<T> setBarThickness(BigDecimal 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 BigDecimal getMaxBarThickness()

See Also:

setGridLines(GridLines gridLines)

setMaxBarThickness

public XAxis<T> setMaxBarThickness(BigDecimal maxBarThickness)

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

getGridLines

public GridLines getGridLines()

See Also:

setGridLines(GridLines gridLines)

setGridLines

public XAxis<T> setGridLines(GridLines gridLines)

If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval. If false, the grid line will go right down the middle of the bars.