org.pepstock.charba.client.options.scales

Class BarCategoryAxis

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.scales.Axis

org.pepstock.charba.client.options.scales.CartesianCategoryAxis

org.pepstock.charba.client.options.scales.BarCategoryAxis

public final 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()
double	getCategoryPercentage() Returns the percent (0-1) of the available width each category should be within the sample width.
GridLines	getGrideLines()
java.lang.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()
T	getTicks()
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()
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.
void	setId(java.lang.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.

Methods inherited from class org.pepstock.charba.client.options.scales.Axis

getBuildTicksCallback, getCalculateTickRotationCallback, getDataLimitsCallback, getDimensionsCallback, getFitCallback, getScale, getTickToLabelConversionCallback, getType, getUpdateCallback, getWeight, isDisplay, onAfterBuildTicks, onAfterCalculateTickRotation, onAfterDataLimits, onAfterFit, onAfterSetDimensions, onAfterTickToLabelConversion, onAfterUpdate, onBeforeBuildTicks, onBeforeCalculateTickRotation, onBeforeDataLimits, onBeforeFit, onBeforeSetDimensions, onBeforeTickToLabelConversion, onBeforeUpdate, setBuildTicksCallback, setCalculateTickRotationCallback, setDataLimitsCallback, setDimensionsCallback, setDisplay, setFitCallback, setTickToLabelConversionCallback, setType, setUpdateCallback, setWeight

Methods inherited from class org.pepstock.charba.client.commons.ChartContainer

getChart

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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 grideLines

See Also:

GridLines

getScaleLabel

public CartesianScaleLabel getScaleLabel()

Returns:

the scaleLabel

See Also:

CartesianScaleLabel

getTicks

public T getTicks()

Returns:

the ticks

See Also:

Tick

getCartesianType

public CartesianAxisType getCartesianType()

Returns:

the cartesianType

See Also:

CartesianAxisType

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()

Returns:

the stacked

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(java.lang.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 java.lang.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

See Also:

Position

getPosition

public Position getPosition()

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

Returns:

position of axis.

See Also:

Position