org.pepstock.charba.client.configuration

Class BarCategoryAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

org.pepstock.charba.client.configuration.CartesianCategoryAxis

org.pepstock.charba.client.configuration.BarCategoryAxis

public class BarCategoryAxis
extends CartesianCategoryAxis

This a cartesian axis for BAR chart.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
BarCategoryAxis(AbstractChart<?,?> chart) Builds the object storing the chart instance.

Method Summary

Modifier and Type	Method and Description
double	getBarPercentage() Returns the percent (0-1) of the available width each bar should be within the category width.
int	getBarThickness() Returns the width of each bar in pixels.
CartesianAxisType	getCartesianType() Returns the axis type
double	getCategoryPercentage() Returns the percent (0-1) of the available width each category should be within the sample width.
AbstractChart<?,?>	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
GridLines	getGrideLines() Returns the grid lines element
String	getId() The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
int	getMaxBarThickness() Returns the maximum bar thickness.
Position	getPosition() Position of the axis in the chart.
CartesianScaleLabel	getScaleLabel() Returns the scale label element
boolean	isOffset() If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
boolean	isStacked() Gets if the axis are stacked or not.
void	setBarPercentage(double barPercentage) Sets the percent (0-1) of the available width each bar should be within the category width.
void	setBarThickness(int barThickness) Sets the width of each bar in pixels.
void	setCategoryPercentage(double categoryPercentage) Sets the percent (0-1) of the available width each category should be within the sample width.
protected void	setConfiguration(T configuration)
void	setId(String id) The ID is used to link datasets and scale axes together. This is especially needed if multi-axes charts are used.
void	setMaxBarThickness(int maxBarThickness) Sets the maximum bar thickness, to ensure that bars are not sized thicker than this
void	setOffset(boolean offset) If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.
void	setPosition(Position position) Position of the axis in the chart.
void	setStacked(boolean stacked) Sets if the axis are stacked or not.
String	toJSON() Returns the JSON representation of the object.

Methods inherited from class org.pepstock.charba.client.configuration.CartesianCategoryAxis

getTicks

Methods inherited from class org.pepstock.charba.client.configuration.Axis

getAxisBuildTicksCallback, getAxisCalculateTickRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getType, getWeight, isDisplay, setAxisBuildTicksCallback, setAxisCalculateTickRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setDisplay, setType, setWeight

Methods inherited from class java.lang.Object

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

Constructor Detail

BarCategoryAxis

public BarCategoryAxis(AbstractChart<?,?> chart)

Builds the object storing the chart instance.

Parameters:

chart - chart instance

Method Detail

setBarPercentage

public void setBarPercentage(double barPercentage)

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

Parameters:

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

getBarPercentage

public double getBarPercentage()

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

Returns:

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

setCategoryPercentage

public void setCategoryPercentage(double categoryPercentage)

Sets the percent (0-1) of the available width each category should be within the sample width.

Parameters:

categoryPercentage - percent (0-1) of the available width each category should be within the sample width.

getCategoryPercentage

public double getCategoryPercentage()

Returns the percent (0-1) of the available width each category should be within the sample width.

Returns:

the percent (0-1) of the available width each category should be within the sample width.

setBarThickness

public void setBarThickness(int barThickness)

Sets the 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.

Parameters:

barThickness - 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.

getBarThickness

public int getBarThickness()

Returns the 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.

Returns:

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.

setMaxBarThickness

public void setMaxBarThickness(int maxBarThickness)

Sets the maximum bar thickness, to ensure that bars are not sized thicker than this

Parameters:

maxBarThickness - the maximum bar thickness.

getMaxBarThickness

public int getMaxBarThickness()

Returns the maximum bar thickness.

Returns:

the maximum bar thickness.

getGrideLines

public GridLines getGrideLines()

Returns the grid lines element

Returns:

the grideLines

getScaleLabel

public CartesianScaleLabel getScaleLabel()

Returns the scale label element

Returns:

the scaleLabel

getCartesianType

public CartesianAxisType getCartesianType()

Returns the axis type

Returns:

the cartesianType

setStacked

public void setStacked(boolean stacked)

Sets if the axis are stacked or not.

Parameters:

stacked - if the axis are stacked or not.

isStacked

public boolean isStacked()

Gets if the axis are stacked or not.

Returns:

if the axis are stacked or not.

setOffset

public void setOffset(boolean offset)

If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.

Parameters:

offset - extra space of axis

isOffset

public boolean isOffset()

If true, extra space is added to the both edges and the axis is scaled to fit into the chart area.

Returns:

extra space of axis.

setId

public void setId(String id)

The ID is used to link datasets and scale axes together.
This is especially needed if multi-axes charts are used.

Parameters:

id - The ID is used to link datasets and scale axes together

getId

public String getId()

The ID is used to link datasets and scale axes together.
This is especially needed if multi-axes charts are used.

Returns:

The ID is used to link datasets and scale axes together

setPosition

public void setPosition(Position position)

Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'

Parameters:

position - position of axis

getPosition

public Position getPosition()

Position of the axis in the chart. Possible values are: 'top', 'left', 'bottom', 'right'

Returns:

position of axis.

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final AbstractChart<?,?> getChart()

Returns the chart instance

Returns:

the chart