com.github.fluorumlabs.disconnect.highcharts.ResponsiveRulesConditionOptions 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) Under which conditions the rule applies.
 *
 * @see https://api.highcharts.com/highcharts/responsive.rules.condition
 * @see https://api.highcharts.com/highstock/responsive.rules.condition
 * @see https://api.highcharts.com/highmaps/responsive.rules.condition
 *
 */
public interface ResponsiveRulesConditionOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) A callback function to gain complete
   * control on when the responsive rule applies. Return true if it applies.
   * This opens for checking against other metrics than the chart size, or
   * example the document size or other elements.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.callback
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.callback
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.callback
   *
   * @implspec callback?: ResponsiveCallbackFunction;
   *
   */
  @JSProperty("callback")
  @Nullable
  ResponsiveCallbackFunction getCallback();

  /**
   * (Highcharts, Highstock, Highmaps) A callback function to gain complete
   * control on when the responsive rule applies. Return true if it applies.
   * This opens for checking against other metrics than the chart size, or
   * example the document size or other elements.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.callback
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.callback
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.callback
   *
   * @implspec callback?: ResponsiveCallbackFunction;
   *
   */
  @JSProperty("callback")
  void setCallback(ResponsiveCallbackFunction value);

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart height is less than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.maxHeight
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.maxHeight
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.maxHeight
   *
   * @implspec maxHeight?: number;
   *
   */
  @JSProperty("maxHeight")
  double getMaxHeight();

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart height is less than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.maxHeight
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.maxHeight
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.maxHeight
   *
   * @implspec maxHeight?: number;
   *
   */
  @JSProperty("maxHeight")
  void setMaxHeight(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart width is less than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.maxWidth
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.maxWidth
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.maxWidth
   *
   * @implspec maxWidth?: number;
   *
   */
  @JSProperty("maxWidth")
  double getMaxWidth();

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart width is less than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.maxWidth
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.maxWidth
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.maxWidth
   *
   * @implspec maxWidth?: number;
   *
   */
  @JSProperty("maxWidth")
  void setMaxWidth(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart height is greater than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.minHeight
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.minHeight
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.minHeight
   *
   * @implspec minHeight?: number;
   *
   */
  @JSProperty("minHeight")
  double getMinHeight();

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart height is greater than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.minHeight
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.minHeight
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.minHeight
   *
   * @implspec minHeight?: number;
   *
   */
  @JSProperty("minHeight")
  void setMinHeight(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart width is greater than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.minWidth
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.minWidth
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.minWidth
   *
   * @implspec minWidth?: number;
   *
   */
  @JSProperty("minWidth")
  double getMinWidth();

  /**
   * (Highcharts, Highstock, Highmaps) The responsive rule applies if the
   * chart width is greater than this.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.condition.minWidth
   * @see https://api.highcharts.com/highstock/responsive.rules.condition.minWidth
   * @see https://api.highcharts.com/highmaps/responsive.rules.condition.minWidth
   *
   * @implspec minWidth?: number;
   *
   */
  @JSProperty("minWidth")
  void setMinWidth(double value);
}