com.github.fluorumlabs.disconnect.highcharts.DrilldownDrillUpButtonOptions 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, Highmaps) Options for the drill up button that appears when
 * drilling down on a series. The text for the button is defined in
 * lang.drillUpText.
 *
 * @see https://api.highcharts.com/highcharts/drilldown.drillUpButton
 * @see https://api.highcharts.com/highmaps/drilldown.drillUpButton
 *
 */
public interface DrilldownDrillUpButtonOptions extends Any {
  /**
   * (Highcharts, Highmaps) Positioning options for the button within the
   * relativeTo box. Available properties are x, y, align and
   * verticalAlign.
   *
   * @see https://api.highcharts.com/highcharts/drilldown.drillUpButton.position
   * @see https://api.highcharts.com/highmaps/drilldown.drillUpButton.position
   *
   * @implspec position?: DrilldownDrillUpButtonPositionOptions;
   *
   */
  @JSProperty("position")
  @Nullable
  DrilldownDrillUpButtonPositionOptions getPosition();

  /**
   * (Highcharts, Highmaps) Positioning options for the button within the
   * relativeTo box. Available properties are x, y, align and
   * verticalAlign.
   *
   * @see https://api.highcharts.com/highcharts/drilldown.drillUpButton.position
   * @see https://api.highcharts.com/highmaps/drilldown.drillUpButton.position
   *
   * @implspec position?: DrilldownDrillUpButtonPositionOptions;
   *
   */
  @JSProperty("position")
  void setPosition(DrilldownDrillUpButtonPositionOptions value);

  /**
   * (Highcharts, Highmaps) What box to align the button to. Can be either
   * plotBox or spacingBox.
   *
   * @see https://api.highcharts.com/highcharts/drilldown.drillUpButton.relativeTo
   * @see https://api.highcharts.com/highmaps/drilldown.drillUpButton.relativeTo
   *
   * @implspec relativeTo?: ("plotBox"|"spacingBox");
   *
   */
  @JSProperty("relativeTo")
  @Nullable
  RelativeTo getRelativeTo();

  /**
   * (Highcharts, Highmaps) What box to align the button to. Can be either
   * plotBox or spacingBox.
   *
   * @see https://api.highcharts.com/highcharts/drilldown.drillUpButton.relativeTo
   * @see https://api.highcharts.com/highmaps/drilldown.drillUpButton.relativeTo
   *
   * @implspec relativeTo?: ("plotBox"|"spacingBox");
   *
   */
  @JSProperty("relativeTo")
  void setRelativeTo(RelativeTo value);

  /**
   * (Highcharts, 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.
   *
   * In styled mode, drill-up button styles can be applied with the
   * .highcharts-drillup-button class.
   *
   * @see https://api.highcharts.com/highcharts/drilldown.drillUpButton.theme
   * @see https://api.highcharts.com/highmaps/drilldown.drillUpButton.theme
   *
   * @implspec theme?: object;
   *
   */
  @JSProperty("theme")
  @Nullable
  Any getTheme();

  /**
   * (Highcharts, 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.
   *
   * In styled mode, drill-up button styles can be applied with the
   * .highcharts-drillup-button class.
   *
   * @see https://api.highcharts.com/highcharts/drilldown.drillUpButton.theme
   * @see https://api.highcharts.com/highmaps/drilldown.drillUpButton.theme
   *
   * @implspec theme?: object;
   *
   */
  @JSProperty("theme")
  void setTheme(Any value);

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

    public static final RelativeTo SPACINGBOX = JsEnum.of("spacingBox");
  }
}