Class CartesianTimeSeriesAxis
- java.lang.Object
-
- org.pepstock.charba.client.configuration.Axis
-
- org.pepstock.charba.client.configuration.CartesianAxis<CartesianTimeTick>
-
- org.pepstock.charba.client.configuration.CartesianTimeAxis
-
- org.pepstock.charba.client.configuration.CartesianTimeSeriesAxis
-
public class CartesianTimeSeriesAxis extends CartesianTimeAxis
This object is used to map defined axis as time series. This is used to have time series charts.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Modifier Constructor Description CartesianTimeSeriesAxis(IsChart chart)
Builds the object storing the chart instance.CartesianTimeSeriesAxis(IsChart chart, String id)
Builds the object storing the chart instance.CartesianTimeSeriesAxis(IsChart chart, String id, AxisKind kind)
Builds the object storing the chart instance and axis type.CartesianTimeSeriesAxis(IsChart chart, AxisKind kind)
Builds the object storing the chart instance and axis type.CartesianTimeSeriesAxis(IsChart chart, ScaleId id)
Builds the object storing the chart instance.protected
CartesianTimeSeriesAxis(IsChart chart, ScaleId id, AxisType type, AxisKind kind)
Builds the object storing the chart instance and cartesian axis type.CartesianTimeSeriesAxis(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.default MinMaxCallback<T>
getMaxCallback()
Returns the callback to set the user defined maximum number for the scale, overrides maximum value from data.default MinMaxCallback<T>
getMinCallback()
Returns the callback to set the user defined minimum number for the scale, overrides minimum value from data.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.ChartEnvelop<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)
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.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.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.CartesianTimeAxis
getAdapters, getMax, getMin, getMinMaxCallbacksHandler, getTicks, getTime, isOffsetAfterAutoskip, setMax, setMin, setOffsetAfterAutoskip
-
Methods inherited from class org.pepstock.charba.client.configuration.CartesianAxis
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
-
CartesianTimeSeriesAxis
public CartesianTimeSeriesAxis(IsChart chart)
Builds the object storing the chart instance. Axis type is X by default.- Parameters:
chart
- chart instance
-
CartesianTimeSeriesAxis
public CartesianTimeSeriesAxis(IsChart chart, String id)
Builds the object storing the chart instance. Axis type is X by default.- Parameters:
chart
- chart instanceid
- axis id
-
CartesianTimeSeriesAxis
public CartesianTimeSeriesAxis(IsChart chart, ScaleId id)
Builds the object storing the chart instance. Axis type is X by default.- Parameters:
chart
- chart instanceid
- axis id
-
CartesianTimeSeriesAxis
public CartesianTimeSeriesAxis(IsChart chart, AxisKind kind)
Builds the object storing the chart instance and axis type.- Parameters:
chart
- chart instancekind
- axis kind
-
CartesianTimeSeriesAxis
public CartesianTimeSeriesAxis(IsChart chart, String id, AxisKind kind)
Builds the object storing the chart instance and axis type.- Parameters:
chart
- chart instanceid
- axis idkind
- axis kind
-
CartesianTimeSeriesAxis
public CartesianTimeSeriesAxis(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
-
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
-
-