Package com.vaadin.flow.component.charts.model

Class Breaks

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Breaks

All Implemented Interfaces:

Serializable

public class Breaks
extends AbstractConfigurationObject

An array defining breaks in the axis, the sections defined will be left out and all the points shifted closer to each other.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Breaks()

Method Summary

Modifier and Type	Method	Description
Number	getBreakSize()
Number	getFrom()
Number	getRepeat()
Number	getTo()
void	setBreakSize(Number breakSize)	A number indicating how much space should be left between the start and the end of the break.
void	setFrom(Number from)	The point where the break starts.
void	setFrom(Instant instant)
void	setFrom(Date date)	Deprecated. as of 4.0.
void	setRepeat(Number repeat)	Defines an interval after which the break appears again.
void	setTo(Number to)	The point where the break ends.
void	setTo(Instant instant)
void	setTo(Date date)	Deprecated. as of 4.0.

Methods inherited from class java.lang.Object

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

Constructor Details

Breaks

public Breaks()

Method Details

getBreakSize

public Number getBreakSize()

See Also:

• setBreakSize(Number)

setBreakSize

public void setBreakSize(Number breakSize)

A number indicating how much space should be left between the start and the end of the break. The break size is given in axis units, so for instance on a datetime axis, a break size of 3600000 would indicate the equivalent of an hour.

Defaults to: 0

getFrom

public Number getFrom()

See Also:

• setFrom(Number)

setFrom

public void setFrom(Number from)

The point where the break starts.

getRepeat

public Number getRepeat()

See Also:

• setRepeat(Number)

setRepeat

public void setRepeat(Number repeat)

Defines an interval after which the break appears again. By default the breaks do not repeat.

Defaults to: 0

getTo

public Number getTo()

See Also:

• setTo(Number)

setTo

public void setTo(Number to)

The point where the break ends.

setFrom

@Deprecated
public void setFrom(Date date)

Deprecated.

as of 4.0. Use #setPointStart(Instant)

setFrom

public void setFrom(Instant instant)

See Also:

• setFrom(Number)

setTo

@Deprecated
public void setTo(Date date)

Deprecated.

as of 4.0. Use #setPointStart(Instant)

setTo

public void setTo(Instant instant)

See Also:

• setTo(Number)