org.pepstock.charba.client.defaults.globals

Class DefaultTime

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultTime

All Implemented Interfaces:

IsDefaultTime

public class DefaultTime
extends Object
implements IsDefaultTime

CHART.JS default values for TIME element.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
DefaultTime()

Method Summary

Modifier and Type	Method and Description
Date	getMax() If defined, this will override the data maximum.
Date	getMin() If defined, this will override the data minimum.
TimeUnit	getMinUnit() The minimum display format to be used for a time unit.
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.
int	getStepSize() The number of units between grid lines.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTime

public DefaultTime()

Method Detail

isIsoWeekday

public boolean isIsoWeekday()

Description copied from interface: IsDefaultTime

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

Specified by:

isIsoWeekday in interface IsDefaultTime

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.

getMax

public Date getMax()

Description copied from interface: IsDefaultTime

If defined, this will override the data maximum.

Specified by:

getMax in interface IsDefaultTime

Returns:

If defined, this will override the data maximum.

getMin

public Date getMin()

Description copied from interface: IsDefaultTime

If defined, this will override the data minimum.

Specified by:

getMin in interface IsDefaultTime

Returns:

If defined, this will override the data minimum.

getRound

public TimeUnit getRound()

Description copied from interface: IsDefaultTime

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

Specified by:

getRound in interface IsDefaultTime

Returns:

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

getTooltipFormat

public String getTooltipFormat()

Description copied from interface: IsDefaultTime

The moment js format string to use for the tooltip.

Specified by:

getTooltipFormat in interface IsDefaultTime

Returns:

The moment js format string to use for the tooltip.

getUnit

public TimeUnit getUnit()

Description copied from interface: IsDefaultTime

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

Specified by:

getUnit in interface IsDefaultTime

Returns:

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

getStepSize

public int getStepSize()

Description copied from interface: IsDefaultTime

The number of units between grid lines.

Specified by:

getStepSize in interface IsDefaultTime

Returns:

The number of units between grid lines.

getMinUnit

public TimeUnit getMinUnit()

Description copied from interface: IsDefaultTime

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

Specified by:

getMinUnit in interface IsDefaultTime

Returns:

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

getParser

public String getParser()

Description copied from interface: IsDefaultTime

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

Specified by:

getParser in interface IsDefaultTime

Returns:

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