com.github.fluorumlabs.disconnect.highcharts.ChartResetZoomButtonOptions 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.extras.JsEnum;
import js.lang.Any;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) The button that appears after a selection
 * zoom, allowing the user to reset zoom.
 *
 * @see https://api.highcharts.com/highcharts/chart.resetZoomButton
 * @see https://api.highcharts.com/highstock/chart.resetZoomButton
 * @see https://api.highcharts.com/highmaps/chart.resetZoomButton
 *
 */
public interface ChartResetZoomButtonOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) The position of the button.
   *
   * @see https://api.highcharts.com/highcharts/chart.resetZoomButton.position
   * @see https://api.highcharts.com/highstock/chart.resetZoomButton.position
   * @see https://api.highcharts.com/highmaps/chart.resetZoomButton.position
   *
   * @implspec position?: ChartResetZoomButtonPositionOptions;
   *
   */
  @JSProperty("position")
  @Nullable
  ChartResetZoomButtonPositionOptions getPosition();

  /**
   * (Highcharts, Highstock, Highmaps) The position of the button.
   *
   * @see https://api.highcharts.com/highcharts/chart.resetZoomButton.position
   * @see https://api.highcharts.com/highstock/chart.resetZoomButton.position
   * @see https://api.highcharts.com/highmaps/chart.resetZoomButton.position
   *
   * @implspec position?: ChartResetZoomButtonPositionOptions;
   *
   */
  @JSProperty("position")
  void setPosition(ChartResetZoomButtonPositionOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) What frame the button should be placed
   * related to. Can be either plot or chart
   *
   * @see https://api.highcharts.com/highcharts/chart.resetZoomButton.relativeTo
   * @see https://api.highcharts.com/highstock/chart.resetZoomButton.relativeTo
   * @see https://api.highcharts.com/highmaps/chart.resetZoomButton.relativeTo
   *
   * @implspec relativeTo?: ("chart"|"plot");
   *
   */
  @JSProperty("relativeTo")
  @Nullable
  RelativeTo getRelativeTo();

  /**
   * (Highcharts, Highstock, Highmaps) What frame the button should be placed
   * related to. Can be either plot or chart
   *
   * @see https://api.highcharts.com/highcharts/chart.resetZoomButton.relativeTo
   * @see https://api.highcharts.com/highstock/chart.resetZoomButton.relativeTo
   * @see https://api.highcharts.com/highmaps/chart.resetZoomButton.relativeTo
   *
   * @implspec relativeTo?: ("chart"|"plot");
   *
   */
  @JSProperty("relativeTo")
  void setRelativeTo(RelativeTo value);

  /**
   * (Highcharts, Highstock, Highmaps) A collection of attributes for the
   * button. The object takes SVG attributes like fill, stroke,
   * stroke-width or r, the border radius. The theme also supports
   * style, a collection of CSS properties for the text. Equivalent
   * attributes for the hover state are given in theme.states.hover.
   *
   * @see https://api.highcharts.com/highcharts/chart.resetZoomButton.theme
   * @see https://api.highcharts.com/highstock/chart.resetZoomButton.theme
   * @see https://api.highcharts.com/highmaps/chart.resetZoomButton.theme
   *
   * @implspec theme?: ChartResetZoomButtonThemeOptions;
   *
   */
  @JSProperty("theme")
  @Nullable
  ChartResetZoomButtonThemeOptions getTheme();

  /**
   * (Highcharts, Highstock, Highmaps) A collection of attributes for the
   * button. The object takes SVG attributes like fill, stroke,
   * stroke-width or r, the border radius. The theme also supports
   * style, a collection of CSS properties for the text. Equivalent
   * attributes for the hover state are given in theme.states.hover.
   *
   * @see https://api.highcharts.com/highcharts/chart.resetZoomButton.theme
   * @see https://api.highcharts.com/highstock/chart.resetZoomButton.theme
   * @see https://api.highcharts.com/highmaps/chart.resetZoomButton.theme
   *
   * @implspec theme?: ChartResetZoomButtonThemeOptions;
   *
   */
  @JSProperty("theme")
  void setTheme(ChartResetZoomButtonThemeOptions value);

  /**
   */
  abstract class RelativeTo extends JsEnum {
    public static final RelativeTo CHART = JsEnum.of("chart");

    public static final RelativeTo PLOT = JsEnum.of("plot");
  }
}