Class CartesianTimeAxis
- java.lang.Object
-
- org.pepstock.charba.client.configuration.Axis
-
- org.pepstock.charba.client.configuration.CartesianAxis<CartesianTimeTick>
-
- org.pepstock.charba.client.configuration.CartesianTimeAxis
-
- Direct Known Subclasses:
CartesianTimeSeriesAxis
public class CartesianTimeAxis extends CartesianAxis<CartesianTimeTick>
This object is used to map defined axis as time.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Modifier Constructor Description CartesianTimeAxis(IsChart chart)
Builds the object storing the chart instance.CartesianTimeAxis(IsChart chart, String id)
Builds the object storing the chart instance.CartesianTimeAxis(IsChart chart, String id, AxisKind kind)
Builds the object storing the chart instance and axis type.CartesianTimeAxis(IsChart chart, AxisKind kind)
Builds the object storing the chart instance and axis type.CartesianTimeAxis(IsChart chart, ScaleId id)
Builds the object storing the chart instance.protected
CartesianTimeAxis(IsChart chart, ScaleId id, AxisType type, AxisKind kind)
Builds the object storing the chart instance and cartesian axis type.CartesianTimeAxis(IsChart chart, ScaleId id, AxisKind kind)
Builds the object storing the chart instance and axis type.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Adapters
getAdapters()
Returns the adapters element.IsChart
getChart()
Returns the chart instanceprotected T
getConfiguration()
Returns the configuration element.Date
getMax()
If defined, this will override the data maximum.Date
getMin()
If defined, this will override the data minimum.CartesianTimeTick
getTicks()
Returns the ticks elementTime
getTime()
Returns the time element.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)
void
setMax(Date max)
If defined, this will override the data maximum.void
setMin(Date min)
If defined, this will override the data minimum.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
-
-
-
-
Constructor Detail
-
CartesianTimeAxis
public CartesianTimeAxis(IsChart chart)
Builds the object storing the chart instance. Axis type is X by default.- Parameters:
chart
- chart instance
-
CartesianTimeAxis
public CartesianTimeAxis(IsChart chart, String id)
Builds the object storing the chart instance. Axis type is X by default.- Parameters:
chart
- chart instanceid
- axis id
-
CartesianTimeAxis
public CartesianTimeAxis(IsChart chart, ScaleId id)
Builds the object storing the chart instance. Axis type is X by default.- Parameters:
chart
- chart instanceid
- axis id
-
CartesianTimeAxis
public CartesianTimeAxis(IsChart chart, AxisKind kind)
Builds the object storing the chart instance and axis type.- Parameters:
chart
- chart instancekind
- axis kind
-
CartesianTimeAxis
public CartesianTimeAxis(IsChart chart, String id, AxisKind kind)
Builds the object storing the chart instance and axis type.- Parameters:
chart
- chart instanceid
- axis idkind
- axis kind
-
CartesianTimeAxis
public CartesianTimeAxis(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 CartesianTimeTick getTicks()
Description copied from class:CartesianAxis
Returns the ticks element- Specified by:
getTicks
in classCartesianAxis<CartesianTimeTick>
- Returns:
- the ticks
-
getTime
public Time getTime()
Returns the time element.- Returns:
- the time
-
getAdapters
public Adapters getAdapters()
Returns the adapters element.- Returns:
- the adapters
-
setMax
public void setMax(Date max)
If defined, this will override the data maximum.- Parameters:
max
- If defined, this will override the data maximum.
-
getMax
public Date getMax()
If defined, this will override the data maximum.- Returns:
- If defined, this will override the data maximum.
-
setMin
public void setMin(Date min)
If defined, this will override the data minimum.- Parameters:
min
- If defined, this will override the data minimum.
-
getMin
public Date getMin()
If defined, this will override the data minimum.- Returns:
- If defined, this will override the data minimum.
-
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
-
-