org.pepstock.charba.client.options.scales

Class Time

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.scales.Time

public class Time
extends ChartContainer

The following display formats are used to configure how different time units are formed into strings for the axis tick marks.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
DisplayFormats	getDisplayFormats()
java.util.Date	getMax() If defined, this will override the data maximum.
java.util.Date	getMin() If defined, this will override the data minimum.
TimeUnit	getMinUnit() The minimum display format to be used for a time unit.
java.lang.String	getParser() Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
TimeUnit	getRound() If defined, dates will be rounded to the start of this unit.
java.lang.String	getTooltipFormat() The moment js format string to use for the tooltip.
TimeUnit	getUnit() If defined, will force the unit to be a certain type.
boolean	isIsoWeekday() If true and the unit is set to 'week', then the first day of the week will be Monday.
int	isStepSize() The number of units between grid lines.
void	setIsoWeekday(boolean isoWeekday) If true and the unit is set to 'week', then the first day of the week will be Monday.
void	setMax(java.util.Date max) If defined, this will override the data maximum.
void	setMin(java.util.Date min) If defined, this will override the data minimum.
void	setMinUnit(TimeUnit unit) The minimum display format to be used for a time unit.
void	setParser(java.lang.String parser) Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
void	setRound(boolean round) If defined, dates will be rounded to the start of this unit.
void	setRound(TimeUnit round) If defined, dates will be rounded to the start of this unit.
void	setStepSize(int stepSize) The number of units between grid lines.
void	setTooltipFormat(java.lang.String tooltipFormat) The moment js format string to use for the tooltip.
void	setUnit(boolean unit) If defined, will force the unit to be a certain type.
void	setUnit(TimeUnit unit) If defined, will force the unit to be a certain type.

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

Method Detail

getDisplayFormats

public DisplayFormats getDisplayFormats()

Returns:

the displayFormats

setIsoWeekday

public void setIsoWeekday(boolean isoWeekday)

If true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.

Parameters:

isoWeekday - If true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.

isIsoWeekday

public boolean isIsoWeekday()

If true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.

Returns:

If true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. Default is true.

setMax

public void setMax(java.util.Date max)

If defined, this will override the data maximum.

Parameters:

max - If defined, this will override the data maximum.

getMax

public java.util.Date getMax()

If defined, this will override the data maximum.

Returns:

If defined, this will override the data maximum. Default is null.

setMin

public void setMin(java.util.Date min)

If defined, this will override the data minimum.

Parameters:

min - If defined, this will override the data minimum.

getMin

public java.util.Date getMin()

If defined, this will override the data minimum.

Returns:

If defined, this will override the data minimum. Default is null.

setRound

public void setRound(boolean round)

If defined, dates will be rounded to the start of this unit.

Parameters:

round - If defined, this will override the data minimum.

setRound

public void setRound(TimeUnit round)

If defined, dates will be rounded to the start of this unit.

Parameters:

round - If defined, this will override the data minimum.

See Also:

TimeUnit

getRound

public TimeUnit getRound()

If defined, dates will be rounded to the start of this unit.

Returns:

If defined, dates will be rounded to the start of this unit. Default is null.

See Also:

TimeUnit

setTooltipFormat

public void setTooltipFormat(java.lang.String tooltipFormat)

The moment js format string to use for the tooltip.

Parameters:

tooltipFormat - The moment js format string to use for the tooltip.

getTooltipFormat

public java.lang.String getTooltipFormat()

The moment js format string to use for the tooltip.

Returns:

The moment js format string to use for the tooltip. Default is null.

setUnit

public void setUnit(boolean unit)

If defined, will force the unit to be a certain type.

Parameters:

unit - If defined, will force the unit to be a certain type..

setUnit

public void setUnit(TimeUnit unit)

If defined, will force the unit to be a certain type.

Parameters:

unit - If defined, will force the unit to be a certain type.

See Also:

TimeUnit

getUnit

public TimeUnit getUnit()

If defined, will force the unit to be a certain type.

Returns:

If defined, will force the unit to be a certain type. Default is null.

See Also:

TimeUnit

setStepSize

public void setStepSize(int stepSize)

The number of units between grid lines.

Parameters:

stepSize - The number of units between grid lines.

isStepSize

public int isStepSize()

The number of units between grid lines.

Returns:

The number of units between grid lines. Default is 1.

setMinUnit

public void setMinUnit(TimeUnit unit)

The minimum display format to be used for a time unit.

Parameters:

unit - The minimum display format to be used for a time unit.

See Also:

TimeUnit

getMinUnit

public TimeUnit getMinUnit()

The minimum display format to be used for a time unit.

Returns:

The minimum display format to be used for a time unit. Default is TimeUnit.millisecond.

See Also:

TimeUnit

setParser

public void setParser(java.lang.String parser)

Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.

Parameters:

parser - Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.

getParser

public java.lang.String getParser()

Defined as a string, it is interpreted as a custom format to be used by moment to parse the date.

Returns:

Defined as a string, it is interpreted as a custom format to be used by moment to parse the date. Default is null.