org.pepstock.charba.client.defaults

Interface IsDefaultTime

All Known Implementing Classes:

DefaultChartTime, DefaultTime, Time

public interface IsDefaultTime

Interface to define time object defaults.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
IsoWeekDay	getIsoWeekday() Returns the ISO day of the week with 0 being Sunday and 6 being Saturday.
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 LUXON 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.
String	getTooltipFormat() The date format string to use for the tooltip.
TimeUnit	getUnit() If defined, will force the unit to be a certain type.

Method Detail

getIsoWeekday

IsoWeekDay getIsoWeekday()

Returns the ISO day of the week with 0 being Sunday and 6 being Saturday.

Returns:

ISO day of the week with 0 being Sunday and 6 being Saturday

getRound

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.

getTooltipFormat

String getTooltipFormat()

The date format string to use for the tooltip.

Returns:

date format string to use for the tooltip.

getUnit

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.

getStepSize

double getStepSize()

The number of units between grid.

Returns:

The number of units between grid.

getMinUnit

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.

getParser

String getParser()

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

Returns:

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