com.github.fluorumlabs.disconnect.highcharts.MapNavigationButtonOptions 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;

/**
 * (Highmaps) General options for the map navigation buttons. Individual options
 * can be given from the mapNavigation.buttons option set.
 *
 * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions
 *
 */
public interface MapNavigationButtonOptions extends Any {
  /**
   * (Highmaps) The alignment of the navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.align
   *
   * @implspec align?: ("center"|"left"|"right");
   *
   */
  @JSProperty("align")
  @Nullable
  Align getAlign();

  /**
   * (Highmaps) The alignment of the navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.align
   *
   * @implspec align?: ("center"|"left"|"right");
   *
   */
  @JSProperty("align")
  void setAlign(Align value);

  /**
   * (Highmaps) What box to align the buttons to. Possible values are
   * plotBox and spacingBox.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.alignTo
   *
   * @implspec alignTo?: ("plotBox"|"spacingBox");
   *
   */
  @JSProperty("alignTo")
  @Nullable
  AlignTo getAlignTo();

  /**
   * (Highmaps) What box to align the buttons to. Possible values are
   * plotBox and spacingBox.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.alignTo
   *
   * @implspec alignTo?: ("plotBox"|"spacingBox");
   *
   */
  @JSProperty("alignTo")
  void setAlignTo(AlignTo value);

  /**
   * (Highmaps) The pixel height of the map navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.height
   *
   * @implspec height?: number;
   *
   */
  @JSProperty("height")
  double getHeight();

  /**
   * (Highmaps) The pixel height of the map navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.height
   *
   * @implspec height?: number;
   *
   */
  @JSProperty("height")
  void setHeight(double value);

  /**
   * (Highmaps) Padding for the navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.padding
   *
   * @implspec padding?: number;
   *
   */
  @JSProperty("padding")
  double getPadding();

  /**
   * (Highmaps) Padding for the navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.padding
   *
   * @implspec padding?: number;
   *
   */
  @JSProperty("padding")
  void setPadding(double value);

  /**
   * (Highmaps) Text styles for the map navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  @Nullable
  CSSObject getStyle();

  /**
   * (Highmaps) Text styles for the map navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  void setStyle(CSSObject value);

  /**
   * (Highmaps) A configuration object for the button theme. The object
   * accepts SVG properties like stroke-width, stroke and fill.
   * Tri-state button styles are supported by the states.hover and
   * states.select objects.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.theme
   *
   * @implspec theme?: SVGAttributes;
   *
   */
  @JSProperty("theme")
  @Nullable
  SVGAttributes getTheme();

  /**
   * (Highmaps) A configuration object for the button theme. The object
   * accepts SVG properties like stroke-width, stroke and fill.
   * Tri-state button styles are supported by the states.hover and
   * states.select objects.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.theme
   *
   * @implspec theme?: SVGAttributes;
   *
   */
  @JSProperty("theme")
  void setTheme(SVGAttributes value);

  /**
   * (Highmaps) The vertical alignment of the buttons. Individual alignment
   * can be adjusted by each button's y offset.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  @Nullable
  VerticalAlign getVerticalAlign();

  /**
   * (Highmaps) The vertical alignment of the buttons. Individual alignment
   * can be adjusted by each button's y offset.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  void setVerticalAlign(VerticalAlign value);

  /**
   * (Highmaps) The width of the map navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  double getWidth();

  /**
   * (Highmaps) The width of the map navigation buttons.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  void setWidth(double value);

  /**
   * (Highmaps) The X offset of the buttons relative to its align setting.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  double getX();

  /**
   * (Highmaps) The X offset of the buttons relative to its align setting.
   *
   * @see https://api.highcharts.com/highmaps/mapNavigation.buttonOptions.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  void setX(double value);

  /**
   */
  abstract class Align extends JsEnum {
    public static final Align CENTER = JsEnum.of("center");

    public static final Align LEFT = JsEnum.of("left");

    public static final Align RIGHT = JsEnum.of("right");
  }

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

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

  /**
   */
  abstract class VerticalAlign extends JsEnum {
    public static final VerticalAlign BOTTOM = JsEnum.of("bottom");

    public static final VerticalAlign MIDDLE = JsEnum.of("middle");

    public static final VerticalAlign TOP = JsEnum.of("top");
  }
}