org.pepstock.charba.client.configuration

Class Time

java.lang.Object

org.pepstock.charba.client.configuration.Time

public class Time
extends Object

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
Axis	getAxis() Returns the axis instance.
DisplayFormats	getDisplayFormats() Returns the displayFormats element.
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.
void	setIsoWeekday(boolean isoWeekday) If true and the unit is set to 'week', then the first day of the week will be Monday.
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 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(double stepSize) The number of units between grid lines.
void	setTooltipFormat(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 java.lang.Object

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

Method Detail

getDisplayFormats

public DisplayFormats getDisplayFormats()

Returns the displayFormats element.

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.

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 moment js format string to use for the tooltip.

Parameters:

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

getTooltipFormat

public String getTooltipFormat()

The moment js format string to use for the tooltip.

Returns:

The moment js 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.

setStepSize

public void setStepSize(double stepSize)

The number of units between grid lines.

Parameters:

stepSize - The number of units between grid lines.

getStepSize

public double getStepSize()

The number of units between grid lines.

Returns:

The number of units between grid lines.

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

getAxis

public final Axis getAxis()

Returns the axis instance.

Returns:

the axis