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:
@Generated(value="This class is generated and shouldn\'t be modified", comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new") 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:
-
-
Constructor Summary
Constructors Constructor and Description Breaks()
-
Method Summary
All Methods Modifier and Type Method and 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(Date date)
Deprecated.
as of 4.0. Use#setPointStart(Instant)
void
setFrom(Instant instant)
void
setFrom(Number from)
The point where the break starts.
void
setRepeat(Number repeat)
Defines an interval after which the break appears again.
void
setTo(Date date)
Deprecated.
as of 4.0. Use#setPointStart(Instant)
void
setTo(Instant instant)
void
setTo(Number to)
The point where the break ends.
-
-
-
Method Detail
-
getBreakSize
public Number getBreakSize()
See Also:
-
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
public void setFrom(Number from)
The point where the break starts.
-
getRepeat
public Number getRepeat()
See Also:
-
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
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:
-
setTo
@Deprecated public void setTo(Date date)
Deprecated. as of 4.0. Use
#setPointStart(Instant)
-
setTo
public void setTo(Instant instant)
See Also:
-
-