Package software.xdev.chartjs.model.options.scales

Class Time

java.lang.Object

software.xdev.chartjs.model.options.scales.Time

public class Time
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected DisplayFormats	displayFormats	Default -
protected Boolean	isoWeekday	Default false
protected Time	max	Default -
protected Time	min	Default -
protected String	minUnit	Default 'millisecond'
protected String	parser	Default -
protected String	round	Default -
protected String	tooltipFormat	Default ''
protected String	unit	Default -
protected BigDecimal	unitStepSize	Default 1

Constructor Summary

Constructors

Constructor	Description
Time()

Method Summary

Modifier and Type	Method	Description
DisplayFormats	getDisplayFormats()
Boolean	getIsoWeekday()
Time	getMax()
Time	getMin()
String	getMinUnit()
String	getParser()
String	getRound()
String	getTooltipFormat()
String	getUnit()
BigDecimal	getUnitStepSize()
Time	setDisplayFormats(DisplayFormats displayFormats)	See Display Formats section below.
Time	setIsoWeekday(Boolean isoWeekday)	If true and the unit is set to 'week', iso weekdays will be used.
Time	setMax(Time max)	If defined, this will override the data maximum
Time	setMin(Time min)	If defined, this will override the data minimum
Time	setMinUnit(String minUnit)	The minimum display format to be used for a time unit.
Time	setParser(String parser)	If defined as a string, it is interpreted as a custom format to be used by moment to parse the date.
Time	setRound(String round)	If defined, dates will be rounded to the start of this unit.
Time	setTooltipFormat(String tooltipFormat)	The moment js format string to use for the tooltip.
Time	setUnit(String unit)	If defined, will force the unit to be a certain type.
Time	setUnitStepSize(BigDecimal unitStepSize)	The number of units between grid lines.

Methods inherited from class java.lang.Object

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

Field Details

displayFormats

protected DisplayFormats displayFormats

Default -

See Also:

• setDisplayFormats(DisplayFormats)

isoWeekday

protected Boolean isoWeekday

Default false

See Also:

• setIsoWeekday(Boolean)

max

protected Time max

Default -

See Also:

• setMax(Time)

min

protected Time min

Default -

See Also:

• setMin(Time)

parser

protected String parser

Default -

See Also:

• setParser(String)

round

protected String round

Default -

See Also:

• setRound(String)

tooltipFormat

protected String tooltipFormat

Default ''

See Also:

• setTooltipFormat(String)

unit

protected String unit

Default -

See Also:

• setUnit(String)

minUnit

protected String minUnit

Default 'millisecond'

See Also:

• setMinUnit(String)

unitStepSize

protected BigDecimal unitStepSize

Default 1

See Also:

• setUnitStepSize(BigDecimal)

Constructor Details

Time

public Time()

Method Details

getDisplayFormats

public DisplayFormats getDisplayFormats()

See Also:

• setDisplayFormats(DisplayFormats)

setDisplayFormats

public Time setDisplayFormats(DisplayFormats displayFormats)

See Display Formats section below.

getIsoWeekday

public Boolean getIsoWeekday()

See Also:

• setIsoWeekday(Boolean)

setIsoWeekday

public Time setIsoWeekday(Boolean isoWeekday)

If true and the unit is set to 'week', iso weekdays will be used.

getMax

public Time getMax()

See Also:

• setMax(Time)

setMax

public Time setMax(Time max)

If defined, this will override the data maximum

getMin

public Time getMin()

See Also:

• setMin(Time)

setMin

public Time setMin(Time min)

If defined, this will override the data minimum

getParser

public String getParser()

See Also:

• setParser(String)

setParser

public Time setParser(String parser)

If defined as a string, it is interpreted as a custom format to be used by moment to parse the date. If this is a function, it must return a moment.js object given the appropriate data value.

getRound

public String getRound()

See Also:

• setRound(String)

setRound

public Time setRound(String round)

If defined, dates will be rounded to the start of this unit. See Time Units below for the allowed units.

getTooltipFormat

public String getTooltipFormat()

See Also:

• setTooltipFormat(String)

setTooltipFormat

public Time setTooltipFormat(String tooltipFormat)

The moment js format string to use for the tooltip.

getUnit

public String getUnit()

See Also:

• setUnit(String)

setUnit

public Time setUnit(String unit)

If defined, will force the unit to be a certain type. See Time Units section below for details.

getMinUnit

public String getMinUnit()

See Also:

• setMinUnit(String)

setMinUnit

public Time setMinUnit(String minUnit)

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

getUnitStepSize

public BigDecimal getUnitStepSize()

See Also:

• setUnitStepSize(BigDecimal)

setUnitStepSize

public Time setUnitStepSize(BigDecimal unitStepSize)

The number of units between grid lines.