com.github.fluorumlabs.disconnect.highcharts.ResponsiveRulesOptions 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) A set of rules for responsive settings. The
 * rules are executed from the top down.
 *
 * @see https://api.highcharts.com/highcharts/responsive.rules
 * @see https://api.highcharts.com/highstock/responsive.rules
 * @see https://api.highcharts.com/highmaps/responsive.rules
 *
 */
public interface ResponsiveRulesOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) A full set of chart options to apply as
   * overrides to the general chart options. The chart options are applied
   * when the given rule is active.
   *
   * A special case is configuration objects that take arrays, for example
   * xAxis, yAxis or series. For these collections, an id option is used to
   * map the new option set to an existing object. If an existing object of
   * the same id is not found, the item of the same indexupdated. So for
   * example, setting chartOptions with two series items without an id,
   * will cause the existing chart's two series to be updated with respective
   * options.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.chartOptions
   * @see https://api.highcharts.com/highstock/responsive.rules.chartOptions
   * @see https://api.highcharts.com/highmaps/responsive.rules.chartOptions
   *
   * @implspec chartOptions?: Options;
   *
   */
  @JSProperty("chartOptions")
  @Nullable
  Options getChartOptions();

  /**
   * (Highcharts, Highstock, Highmaps) A full set of chart options to apply as
   * overrides to the general chart options. The chart options are applied
   * when the given rule is active.
   *
   * A special case is configuration objects that take arrays, for example
   * xAxis, yAxis or series. For these collections, an id option is used to
   * map the new option set to an existing object. If an existing object of
   * the same id is not found, the item of the same indexupdated. So for
   * example, setting chartOptions with two series items without an id,
   * will cause the existing chart's two series to be updated with respective
   * options.
   *
   * @see https://api.highcharts.com/highcharts/responsive.rules.chartOptions
   * @see https://api.highcharts.com/highstock/responsive.rules.chartOptions
   * @see https://api.highcharts.com/highmaps/responsive.rules.chartOptions
   *
   * @implspec chartOptions?: Options;
   *
   */
  @JSProperty("chartOptions")
  void setChartOptions(Options value);

  /**
   * (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
   *
   * @implspec condition?: ResponsiveRulesConditionOptions;
   *
   */
  @JSProperty("condition")
  @Nullable
  ResponsiveRulesConditionOptions getCondition();

  /**
   * (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
   *
   * @implspec condition?: ResponsiveRulesConditionOptions;
   *
   */
  @JSProperty("condition")
  void setCondition(ResponsiveRulesConditionOptions value);
}