com.github.fluorumlabs.disconnect.highcharts.LoadingOptions 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 javax.annotation.Nullable;
import js.lang.Any;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) The loading options control the appearance
 * of the loading screen that covers the plot area on chart operations. This
 * screen only appears after an explicit call to chart.showLoading(). It is a
 * utility for developers to communicate to the end user that something is going
 * on, for example while retrieving new data via an XHR connection. The
 * "Loading..." text itself is not part of this configuration object, but part
 * of the lang object.
 *
 * @see https://api.highcharts.com/highcharts/loading
 * @see https://api.highcharts.com/highstock/loading
 * @see https://api.highcharts.com/highmaps/loading
 *
 */
public interface LoadingOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) The duration in milliseconds of the
   * fade out effect.
   *
   * @see https://api.highcharts.com/highcharts/loading.hideDuration
   * @see https://api.highcharts.com/highstock/loading.hideDuration
   * @see https://api.highcharts.com/highmaps/loading.hideDuration
   *
   * @implspec hideDuration?: number;
   *
   */
  @JSProperty("hideDuration")
  double getHideDuration();

  /**
   * (Highcharts, Highstock, Highmaps) The duration in milliseconds of the
   * fade out effect.
   *
   * @see https://api.highcharts.com/highcharts/loading.hideDuration
   * @see https://api.highcharts.com/highstock/loading.hideDuration
   * @see https://api.highcharts.com/highmaps/loading.hideDuration
   *
   * @implspec hideDuration?: number;
   *
   */
  @JSProperty("hideDuration")
  void setHideDuration(double value);

  /**
   * (Highcharts, Highstock, Highmaps) CSS styles for the loading label
   * span.
   *
   * @see https://api.highcharts.com/highcharts/loading.labelStyle
   * @see https://api.highcharts.com/highstock/loading.labelStyle
   * @see https://api.highcharts.com/highmaps/loading.labelStyle
   *
   * @implspec labelStyle?: CSSObject;
   *
   */
  @JSProperty("labelStyle")
  @Nullable
  CSSObject getLabelStyle();

  /**
   * (Highcharts, Highstock, Highmaps) CSS styles for the loading label
   * span.
   *
   * @see https://api.highcharts.com/highcharts/loading.labelStyle
   * @see https://api.highcharts.com/highstock/loading.labelStyle
   * @see https://api.highcharts.com/highmaps/loading.labelStyle
   *
   * @implspec labelStyle?: CSSObject;
   *
   */
  @JSProperty("labelStyle")
  void setLabelStyle(CSSObject value);

  /**
   * (Highcharts, Highstock, Highmaps) The duration in milliseconds of the
   * fade in effect.
   *
   * @see https://api.highcharts.com/highcharts/loading.showDuration
   * @see https://api.highcharts.com/highstock/loading.showDuration
   * @see https://api.highcharts.com/highmaps/loading.showDuration
   *
   * @implspec showDuration?: number;
   *
   */
  @JSProperty("showDuration")
  double getShowDuration();

  /**
   * (Highcharts, Highstock, Highmaps) The duration in milliseconds of the
   * fade in effect.
   *
   * @see https://api.highcharts.com/highcharts/loading.showDuration
   * @see https://api.highcharts.com/highstock/loading.showDuration
   * @see https://api.highcharts.com/highmaps/loading.showDuration
   *
   * @implspec showDuration?: number;
   *
   */
  @JSProperty("showDuration")
  void setShowDuration(double value);

  /**
   * (Highcharts, Highstock, Highmaps) CSS styles for the loading screen that
   * covers the plot area.
   *
   * In styled mode, the loading label is styled with the
   * .highcharts-loading class.
   *
   * @see https://api.highcharts.com/highcharts/loading.style
   * @see https://api.highcharts.com/highstock/loading.style
   * @see https://api.highcharts.com/highmaps/loading.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  @Nullable
  CSSObject getStyle();

  /**
   * (Highcharts, Highstock, Highmaps) CSS styles for the loading screen that
   * covers the plot area.
   *
   * In styled mode, the loading label is styled with the
   * .highcharts-loading class.
   *
   * @see https://api.highcharts.com/highcharts/loading.style
   * @see https://api.highcharts.com/highstock/loading.style
   * @see https://api.highcharts.com/highmaps/loading.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  void setStyle(CSSObject value);
}