All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 0.1.0-alpha2
Show newest version
package com.github.fluorumlabs.disconnect.highcharts;

import java.lang.FunctionalInterface;
import javax.annotation.Nullable;
import js.lang.Any;
import org.teavm.jso.JSFunctor;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) Event handlers for the axis.
 *
 * @see https://api.highcharts.com/highcharts/zAxis.events
 * @see https://api.highcharts.com/highstock/zAxis.events
 * @see https://api.highcharts.com/highmaps/zAxis.events
 *
 */
public interface ZAxisEventsOptions extends Any {
  /**
   * (Highcharts, Gantt) An event fired after the breaks have rendered.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.afterBreaks
   * @see https://api.highcharts.com/gantt/zAxis.events.afterBreaks
   *
   * @implspec afterBreaks?: () => void;
   *
   */
  @JSProperty("afterBreaks")
  @Nullable
  AfterBreaks getAfterBreaks();

  /**
   * (Highcharts, Gantt) An event fired after the breaks have rendered.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.afterBreaks
   * @see https://api.highcharts.com/gantt/zAxis.events.afterBreaks
   *
   * @implspec afterBreaks?: () => void;
   *
   */
  @JSProperty("afterBreaks")
  void setAfterBreaks(AfterBreaks value);

  /**
   * (Highcharts, Highstock, Highmaps) As opposed to the setExtremes event,
   * this event fires after the final min and max values are computed and
   * corrected for minRange.
   *
   * Fires when the minimum and maximum is set for the axis, either by calling
   * the .setExtremes() method or by selecting an area in the chart. One
   * parameter, event, is passed to the function, containing common event
   * information.
   *
   * The new user set minimum and maximum values can be found by event.min
   * and event.max. These reflect the axis minimum and maximum in axis
   * values. The actual data extremes are found in event.dataMin and
   * event.dataMax.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.afterSetExtremes
   * @see https://api.highcharts.com/highstock/zAxis.events.afterSetExtremes
   * @see https://api.highcharts.com/highmaps/zAxis.events.afterSetExtremes
   *
   * @implspec afterSetExtremes?: () => void;
   *
   */
  @JSProperty("afterSetExtremes")
  @Nullable
  AfterSetExtremes getAfterSetExtremes();

  /**
   * (Highcharts, Highstock, Highmaps) As opposed to the setExtremes event,
   * this event fires after the final min and max values are computed and
   * corrected for minRange.
   *
   * Fires when the minimum and maximum is set for the axis, either by calling
   * the .setExtremes() method or by selecting an area in the chart. One
   * parameter, event, is passed to the function, containing common event
   * information.
   *
   * The new user set minimum and maximum values can be found by event.min
   * and event.max. These reflect the axis minimum and maximum in axis
   * values. The actual data extremes are found in event.dataMin and
   * event.dataMax.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.afterSetExtremes
   * @see https://api.highcharts.com/highstock/zAxis.events.afterSetExtremes
   * @see https://api.highcharts.com/highmaps/zAxis.events.afterSetExtremes
   *
   * @implspec afterSetExtremes?: () => void;
   *
   */
  @JSProperty("afterSetExtremes")
  void setAfterSetExtremes(AfterSetExtremes value);

  /**
   * (Highcharts, Gantt) An event fired when a break from this axis occurs on
   * a point.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.pointBreak
   * @see https://api.highcharts.com/gantt/zAxis.events.pointBreak
   *
   * @implspec pointBreak?: () => void;
   *
   */
  @JSProperty("pointBreak")
  @Nullable
  PointBreak getPointBreak();

  /**
   * (Highcharts, Gantt) An event fired when a break from this axis occurs on
   * a point.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.pointBreak
   * @see https://api.highcharts.com/gantt/zAxis.events.pointBreak
   *
   * @implspec pointBreak?: () => void;
   *
   */
  @JSProperty("pointBreak")
  void setPointBreak(PointBreak value);

  /**
   * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
   * break from this axis.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.pointInBreak
   * @see https://api.highcharts.com/highstock/zAxis.events.pointInBreak
   * @see https://api.highcharts.com/gantt/zAxis.events.pointInBreak
   *
   * @implspec pointInBreak?: () => void;
   *
   */
  @JSProperty("pointInBreak")
  @Nullable
  PointInBreak getPointInBreak();

  /**
   * (Highcharts, Highstock, Gantt) An event fired when a point falls inside a
   * break from this axis.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.pointInBreak
   * @see https://api.highcharts.com/highstock/zAxis.events.pointInBreak
   * @see https://api.highcharts.com/gantt/zAxis.events.pointInBreak
   *
   * @implspec pointInBreak?: () => void;
   *
   */
  @JSProperty("pointInBreak")
  void setPointInBreak(PointInBreak value);

  /**
   * (Highcharts, Highstock, Highmaps) Fires when the minimum and maximum is
   * set for the axis, either by calling the .setExtremes() method or by
   * selecting an area in the chart. One parameter, event, is passed to the
   * function, containing common event information.
   *
   * The new user set minimum and maximum values can be found by event.min
   * and event.max. These reflect the axis minimum and maximum in data
   * values. When an axis is zoomed all the way out from the "Reset zoom"
   * button, event.min and event.max are null, and the new extremes are
   * set based on this.dataMin and this.dataMax.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.setExtremes
   * @see https://api.highcharts.com/highstock/zAxis.events.setExtremes
   * @see https://api.highcharts.com/highmaps/zAxis.events.setExtremes
   *
   * @implspec setExtremes?: () => void;
   *
   */
  @JSProperty("setExtremes")
  @Nullable
  SetExtremes getSetExtremes();

  /**
   * (Highcharts, Highstock, Highmaps) Fires when the minimum and maximum is
   * set for the axis, either by calling the .setExtremes() method or by
   * selecting an area in the chart. One parameter, event, is passed to the
   * function, containing common event information.
   *
   * The new user set minimum and maximum values can be found by event.min
   * and event.max. These reflect the axis minimum and maximum in data
   * values. When an axis is zoomed all the way out from the "Reset zoom"
   * button, event.min and event.max are null, and the new extremes are
   * set based on this.dataMin and this.dataMax.
   *
   * @see https://api.highcharts.com/highcharts/zAxis.events.setExtremes
   * @see https://api.highcharts.com/highstock/zAxis.events.setExtremes
   * @see https://api.highcharts.com/highmaps/zAxis.events.setExtremes
   *
   * @implspec setExtremes?: () => void;
   *
   */
  @JSProperty("setExtremes")
  void setSetExtremes(SetExtremes value);

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface AfterBreaks extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface AfterSetExtremes extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface PointBreak extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface PointInBreak extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface SetExtremes extends Any {
    void apply();
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy