Class Time
- java.lang.Object
-
- org.pepstock.charba.client.configuration.Time
-
public class Time extends Object
The time configuration is used to configure how time and time series axes must configure the tick marks.- Author:
- Andrea "Stock" Stocchero
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Axis
getAxis()
Returns the axis instance.DisplayFormats
getDisplayFormats()
Returns the displayFormats element.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.String
getTooltipFormat()
The LUXON format string to use for the tooltip.TimeUnit
getUnit()
If defined, will force the unit to be a certain type.void
setIsoWeekday(IsoWeekDay isoWeekday)
Sets the ISO day of the week.void
setMinUnit(TimeUnit unit)
The minimum display format to be used for a time unit.void
setParser(String parser)
Defined as a string, it is interpreted as a custom format to be used by LUXON 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
setTooltipFormat(String tooltipFormat)
The LUXON 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.
-
-
-
Method Detail
-
getDisplayFormats
public DisplayFormats getDisplayFormats()
Returns the displayFormats element.- Returns:
- the displayFormats
-
setIsoWeekday
public void setIsoWeekday(IsoWeekDay isoWeekday)
Sets the ISO day of the week.- Parameters:
isoWeekday
- ISO day of the week
-
getIsoWeekday
public 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
-
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.
-
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.
-
setTooltipFormat
public void setTooltipFormat(String tooltipFormat)
The LUXON format string to use for the tooltip.- Parameters:
tooltipFormat
- The LUXON format string to use for the tooltip.
-
getTooltipFormat
public String getTooltipFormat()
The LUXON format string to use for the tooltip.- Returns:
- The LUXON format string to use for the tooltip.
-
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.
-
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.
-
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.
-
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.
-
setParser
public void setParser(String parser)
Defined as a string, it is interpreted as a custom format to be used by LUXON to parse the date.- Parameters:
parser
- Defined as a string, it is interpreted as a custom format to be used by LUXON to parse the date.
-
getParser
public 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.
-
getAxis
public final Axis getAxis()
Returns the axis instance.- Returns:
- the axis
-
-