Package org.pepstock.charba.client.configuration

Class CartesianCategoryAxis

java.lang.Object

org.pepstock.charba.client.configuration.Axis

org.pepstock.charba.client.configuration.CartesianAxis<CartesianCategoryTick>

org.pepstock.charba.client.configuration.CartesianCategoryAxis

public class CartesianCategoryAxis
extends CartesianAxis<CartesianCategoryTick>

This object is used to map defined axis as category.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor	Description
	CartesianCategoryAxis(IsChart chart)	Builds the object storing the chart instance.
	CartesianCategoryAxis(IsChart chart, String id)	Builds the object storing the chart instance.
	CartesianCategoryAxis(IsChart chart, String id, AxisKind kind)	Builds the object storing the chart instance and axis type.
	CartesianCategoryAxis(IsChart chart, AxisKind kind)	Builds the object storing the chart instance and axis type.
	CartesianCategoryAxis(IsChart chart, ScaleId id)	Builds the object storing the chart instance.
protected	CartesianCategoryAxis(IsChart chart, ScaleId id, AxisType type, AxisKind kind)	Builds the object storing the chart instance and cartesian axis type, to use to extend the axis.
	CartesianCategoryAxis(IsChart chart, ScaleId id, AxisKind kind)	Builds the object storing the chart instance and axis type.

Method Summary

Modifier and Type	Method	Description
IsChart	getChart()	Returns the chart instance
protected T	getConfiguration()	Returns the configuration element.
Labels	getLabels()	Returns the labels.
Labels	getLabels(boolean binding)	Returns the labels for axes.
String	getMax()	Returns the maximum item to display.
int	getMaxIndex()	Returns the maximum item at passed index to display.
String	getMin()	Returns the minimum item to display
int	getMinIndex()	Returns the minimum item at passed index to display
CartesianCategoryTick	getTicks()	Returns the ticks element
ChartEnvelop<NativeObject>	loadNativeObject(ChartEnvelop<NativeObject> envelop)	Returns the native object instance inside an envelop. It can be called only from org.pepstock.charba.client package.
void	merge(NativeObjectContainer source, String property)	Merge a native object in the this one with a specific property name. This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.
protected void	setConfiguration(T configuration)
void	setLabels(String... labels)	Sets an array of labels to display.
void	setLabels(List<String> labels)	Sets an array of labels to display.
void	setLabels(Labels labels)	Sets the labels of the data.
void	setMax(String max)	Sets the maximum item to display.
void	setMaxIndex(int max)	Sets the maximum item at passed index to display.
void	setMin(String min)	Sets the minimum item to display.
void	setMinIndex(int min)	Sets the minimum item at passed index to display.
String	toJSON()	Returns the JSON representation of the object.

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

getBounds, getGrid, getPosition, getStack, getStackWeight, getTitle, isOffset, isSingleStacked, isStacked, setBounds, setOffset, setPosition, setSingleStacked, setStack, setStacked, setStackWeight

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

getAxis, getAxisBuildTicksCallback, getAxisCalculateLabelRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getCharbaId, getDisplay, getId, getType, getWeight, isAlignToPixels, isReverse, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateLabelRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setBackgroundColor, setBackgroundColor, setDisplay, setDisplay, setReverse, setWeight

Methods inherited from class java.lang.Object

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

Constructor Detail

CartesianCategoryAxis

public CartesianCategoryAxis(IsChart chart)

Builds the object storing the chart instance. Axis type is X by default.

Parameters:

chart - chart instance

CartesianCategoryAxis

public CartesianCategoryAxis(IsChart chart,
                             String id)

Builds the object storing the chart instance. Axis type is X by default.

Parameters:

chart - chart instance

id - axis id

CartesianCategoryAxis

public CartesianCategoryAxis(IsChart chart,
                             ScaleId id)

Builds the object storing the chart instance. Axis type is X by default.

Parameters:

chart - chart instance

id - axis id

CartesianCategoryAxis

public CartesianCategoryAxis(IsChart chart,
                             AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

kind - axis kind.

CartesianCategoryAxis

public CartesianCategoryAxis(IsChart chart,
                             String id,
                             AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

id - axis id

kind - axis kind.

CartesianCategoryAxis

public CartesianCategoryAxis(IsChart chart,
                             ScaleId id,
                             AxisKind kind)

Builds the object storing the chart instance and axis type.

Parameters:

chart - chart instance

id - axis id

kind - axis kind.

CartesianCategoryAxis

protected CartesianCategoryAxis(IsChart chart,
                                ScaleId id,
                                AxisType type,
                                AxisKind kind)

Builds the object storing the chart instance and cartesian axis type, to use to extend the axis.

Parameters:

chart - chart instance

id - axis id

type - axis type

kind - axis kind

Method Detail

getTicks

public CartesianCategoryTick getTicks()

Description copied from class: CartesianAxis

Returns the ticks element

Specified by:

getTicks in class CartesianAxis<CartesianCategoryTick>

Returns:

the ticks

setLabels

public void setLabels(String... labels)

Sets an array of labels to display.

Parameters:

labels - An array of labels to display.

setLabels

public void setLabels(List<String> labels)

Sets an array of labels to display.

Parameters:

labels - An array of labels to display.

setLabels

public void setLabels(Labels labels)

Sets the labels of the data.

Parameters:

labels - labels object to manage also multi-line labels

getLabels

public Labels getLabels()

Returns the labels.

Returns:

the labels

getLabels

public Labels getLabels(boolean binding)

Returns the labels for axes.

Parameters:

binding - if true binds the new labels in the container

Returns:

the labels for axes

setMin

public void setMin(String min)

Sets the minimum item to display.

Parameters:

min - The minimum item to display

getMin

public String getMin()

Returns the minimum item to display

Returns:

The minimum item to display

getMinIndex

public int getMinIndex()

Returns the minimum item at passed index to display

Returns:

The minimum item at passed index to display

setMinIndex

public void setMinIndex(int min)

Sets the minimum item at passed index to display.

Parameters:

min - The minimum item at passed index to display

setMax

public void setMax(String max)

Sets the maximum item to display.

Parameters:

max - the maximum item to display.

getMax

public String getMax()

Returns the maximum item to display.

Returns:

the maximum item to display.

setMaxIndex

public void setMaxIndex(int max)

Sets the maximum item at passed index to display.

Parameters:

max - the maximum item at passed index to display.

getMaxIndex

public int getMaxIndex()

Returns the maximum item at passed index to display.

Returns:

the maximum item at passed index to display.

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.

merge

public final void merge(NativeObjectContainer source,
                        String property)

Merge a native object in the this one with a specific property name.
This is used by plugins implementation (native java script ones) when they are not using the standard way to add plugin configuration in the options of chart.

Parameters:

source - native object container to add

property - property name

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

loadNativeObject

public final ChartEnvelop<NativeObject> loadNativeObject(ChartEnvelop<NativeObject> envelop)

Returns the native object instance inside an envelop.
It can be called only from org.pepstock.charba.client package.

Parameters:

envelop - envelop instance which will contain the native object

Returns:

the envelop, passed as argument, loaded with the native object

getChart

public final IsChart getChart()

Returns the chart instance

Returns:

the chart