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
All Methods Instance Methods Concrete Methods Default Methods Modifier and Type Method Description IsChart
getChart()
Returns the chart instanceprotected 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.default MinMaxCallback<T>
getMaxCallback()
Returns the callback to set the user defined maximum number for the scale, overrides maximum value from data.int
getMaxIndex()
Returns the maximum item at passed index to display.String
getMin()
Returns the minimum item to displaydefault MinMaxCallback<T>
getMinCallback()
Returns the callback to set the user defined minimum number for the scale, overrides minimum value from data.int
getMinIndex()
Returns the minimum item at passed index to displayorg.pepstock.charba.client.configuration.MinMaxCallbacksHandler<String>
getMinMaxCallbacksHandler()
default MinMaxCallback<T>
getSuggestedMaxCallback()
Returns the callback to set the adjustment used when calculating the maximum data value.default MinMaxCallback<T>
getSuggestedMinCallback()
Returns the callback to set the adjustment used when calculating the minimum data value.CartesianCategoryTick
getTicks()
Returns the ticks elementChartEnvelop<NativeObject>
loadNativeObject(ChartEnvelop<NativeObject> envelop)
Returns the native object instance inside an envelop.
It can be called only fromorg.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.default void
setMax(MinMaxCallback<T> maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.default void
setMax(NativeCallback maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.void
setMaxIndex(int max)
Sets the maximum item at passed index to display.void
setMin(String min)
Sets the minimum item to display.default void
setMin(MinMaxCallback<T> minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.default void
setMin(NativeCallback minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.void
setMinIndex(int min)
Sets the minimum item at passed index to display.default void
setSuggestedMax(MinMaxCallback<T> suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.default void
setSuggestedMax(NativeCallback suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.default void
setSuggestedMin(MinMaxCallback<T> suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.default void
setSuggestedMin(NativeCallback suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.String
toJSON()
Returns the JSON representation of the object.-
Methods inherited from class org.pepstock.charba.client.configuration.CartesianAxis
getBorder, getBounds, getBoundsCallback, getGrid, getOffsetCallback, getPosition, getPositionCallback, getStack, getStackCallback, getStackedCallback, getStackWeight, getStackWeightCallback, getTitle, isOffset, isSingleStacked, isStacked, setBounds, setBounds, setBounds, setOffset, setOffset, setOffset, setPosition, setPosition, setPosition, setSingleStacked, setStack, setStack, setStack, setStacked, setStacked, setStacked, setStackWeight, setStackWeight, setStackWeight
-
Methods inherited from class org.pepstock.charba.client.configuration.Axis
getAlignToPixelsCallback, getAxis, getAxisBuildTicksCallback, getAxisCalculateLabelRotationCallback, getAxisDataLimitsCallback, getAxisDimensionsCallback, getAxisFitCallback, getAxisTickToLabelConversionCallback, getAxisUpdateCallback, getBackgroundColor, getBackgroundColorAsString, getBackgroundColorCallback, getCharbaId, getDisplay, getDisplayCallback, getId, getReverseCallback, getType, getWeight, getWeightCallback, isAlignToPixels, isReverse, setAlignToPixels, setAlignToPixels, setAlignToPixels, setAxisBuildTicksCallback, setAxisCalculateLabelRotationCallback, setAxisDataLimitsCallback, setAxisDimensionsCallback, setAxisFitCallback, setAxisTickToLabelConversionCallback, setAxisUpdateCallback, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setDisplay, setDisplay, setDisplay, setDisplay, setReverse, setReverse, setReverse, setWeight, setWeight, setWeight
-
-
-
-
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 instanceid
- 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 instanceid
- axis id
-
CartesianCategoryAxis
public CartesianCategoryAxis(IsChart chart, AxisKind kind)
Builds the object storing the chart instance and axis type.- Parameters:
chart
- chart instancekind
- axis kind.
-
CartesianCategoryAxis
public CartesianCategoryAxis(IsChart chart, String id, AxisKind kind)
Builds the object storing the chart instance and axis type.- Parameters:
chart
- chart instanceid
- axis idkind
- axis kind.
-
CartesianCategoryAxis
public CartesianCategoryAxis(IsChart chart, ScaleId id, AxisKind kind)
Builds the object storing the chart instance and axis type.- Parameters:
chart
- chart instanceid
- axis idkind
- axis kind.
-
-
Method Detail
-
getTicks
public CartesianCategoryTick getTicks()
Description copied from class:CartesianAxis
Returns the ticks element- Specified by:
getTicks
in classCartesianAxis<CartesianCategoryTick>
- Returns:
- the ticks
-
getMinMaxCallbacksHandler
public org.pepstock.charba.client.configuration.MinMaxCallbacksHandler<String> getMinMaxCallbacksHandler()
-
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
- iftrue
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.
-
getMinCallback
public default MinMaxCallback<T> getMinCallback()
Returns the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Returns:
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMin
public default void setMin(MinMaxCallback<T> minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Parameters:
minCallback
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMin
public default void setMin(NativeCallback minCallback)
Sets the callback to set the user defined minimum number for the scale, overrides minimum value from data.- Parameters:
minCallback
- the callback to set the user defined minimum number for the scale, overrides minimum value from data.
-
setMax
public default void setMax(MinMaxCallback<T> maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Parameters:
maxCallback
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
setMax
public default void setMax(NativeCallback maxCallback)
Sets the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Parameters:
maxCallback
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
getMaxCallback
public default MinMaxCallback<T> getMaxCallback()
Returns the callback to set the user defined maximum number for the scale, overrides maximum value from data.- Returns:
- the callback to set the user defined maximum number for the scale, overrides maximum value from data.
-
getSuggestedMinCallback
public default MinMaxCallback<T> getSuggestedMinCallback()
Returns the callback to set the adjustment used when calculating the minimum data value.- Returns:
- the callback to set the adjustment used when calculating the minimum data value.
-
setSuggestedMin
public default void setSuggestedMin(MinMaxCallback<T> suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.- Parameters:
suggestedMinCallback
- the callback to set the adjustment used when calculating the minimum data value.
-
setSuggestedMin
public default void setSuggestedMin(NativeCallback suggestedMinCallback)
Sets the callback to set the adjustment used when calculating the minimum data value.- Parameters:
suggestedMinCallback
- the callback to set the adjustment used when calculating the minimum data value.
-
getSuggestedMaxCallback
public default MinMaxCallback<T> getSuggestedMaxCallback()
Returns the callback to set the adjustment used when calculating the maximum data value.- Returns:
- the callback to set the adjustment used when calculating the maximum data value.
-
setSuggestedMax
public default void setSuggestedMax(MinMaxCallback<T> suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.- Parameters:
suggestedMaxCallback
- the callback to set the adjustment used when calculating the maximum data value.
-
setSuggestedMax
public default void setSuggestedMax(NativeCallback suggestedMaxCallback)
Sets the callback to set the adjustment used when calculating the maximum data value.- Parameters:
suggestedMaxCallback
- the callback to set the adjustment used when calculating the maximum data value.
-
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 addproperty
- 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 fromorg.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
-
-