org.pepstock.charba.client.defaults.chart

Class DefaultChartTime

java.lang.Object

org.pepstock.charba.client.defaults.chart.DefaultChartTime

All Implemented Interfaces:

IsDefaultTime

public final class DefaultChartTime
extends Object
implements IsDefaultTime

Defaults for time option element, based on chart type.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
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.
double	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

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.

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 double 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.