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

Class Breaks

  • All Implemented Interfaces:

    Serializable


    @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:

    Serialized Form

    • Constructor Detail

      • Breaks

        public Breaks()
    • Method Detail

      • 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

      • setFrom

        public void setFrom(Number from)

        The point where the break starts.

      • 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

      • 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)

      • setTo

        @Deprecated
        public void setTo(Date date)

        Deprecated. as of 4.0. Use #setPointStart(Instant)