com.github.fluorumlabs.disconnect.highcharts.NavigatorXAxisBreaksOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
There is a newer version: 0.1.0-alpha2
Show newest version
package com.github.fluorumlabs.disconnect.highcharts;

import js.lang.Any;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Gantt) An array defining breaks in the axis, the
 * sections defined will be left out and all the points shifted closer to each
 * other.
 *
 * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks
 * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks
 * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks
 *
 */
public interface NavigatorXAxisBreaksOptions extends Any {
  /**
   * (Highcharts, Highstock, Gantt) 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.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.breakSize
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.breakSize
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.breakSize
   *
   * @implspec breakSize?: number;
   *
   */
  @JSProperty("breakSize")
  double getBreakSize();

  /**
   * (Highcharts, Highstock, Gantt) 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.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.breakSize
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.breakSize
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.breakSize
   *
   * @implspec breakSize?: number;
   *
   */
  @JSProperty("breakSize")
  void setBreakSize(double value);

  /**
   * (Highcharts, Highstock, Gantt) The point where the break starts.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.from
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.from
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.from
   *
   * @implspec from?: number;
   *
   */
  @JSProperty("from")
  double getFrom();

  /**
   * (Highcharts, Highstock, Gantt) The point where the break starts.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.from
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.from
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.from
   *
   * @implspec from?: number;
   *
   */
  @JSProperty("from")
  void setFrom(double value);

  /**
   * (Highcharts, Highstock, Gantt) Defines an interval after which the break
   * appears again. By default the breaks do not repeat.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.repeat
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.repeat
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.repeat
   *
   * @implspec repeat?: number;
   *
   */
  @JSProperty("repeat")
  double getRepeat();

  /**
   * (Highcharts, Highstock, Gantt) Defines an interval after which the break
   * appears again. By default the breaks do not repeat.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.repeat
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.repeat
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.repeat
   *
   * @implspec repeat?: number;
   *
   */
  @JSProperty("repeat")
  void setRepeat(double value);

  /**
   * (Highcharts, Highstock, Gantt) The point where the break ends.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.to
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.to
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.to
   *
   * @implspec to?: number;
   *
   */
  @JSProperty("to")
  double getTo();

  /**
   * (Highcharts, Highstock, Gantt) The point where the break ends.
   *
   * @see https://api.highcharts.com/highcharts/navigator.xAxis.breaks.to
   * @see https://api.highcharts.com/highstock/navigator.xAxis.breaks.to
   * @see https://api.highcharts.com/gantt/navigator.xAxis.breaks.to
   *
   * @implspec to?: number;
   *
   */
  @JSProperty("to")
  void setTo(double value);
}