com.github.fluorumlabs.disconnect.highcharts.NavigationButtonOptions 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 java.lang.String;
import javax.annotation.Nullable;
import js.extras.JsEnum;
import js.lang.Any;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) A collection of options for buttons
 * appearing in the exporting module.
 *
 * In styled mode, the buttons are styled with the .highcharts-contextbutton
 * and .highcharts-button-symbol classes.
 *
 * @see https://api.highcharts.com/highcharts/navigation.buttonOptions
 * @see https://api.highcharts.com/highstock/navigation.buttonOptions
 * @see https://api.highcharts.com/highmaps/navigation.buttonOptions
 *
 */
public interface NavigationButtonOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) Alignment for the buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.align
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.align
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.align
   *
   * @implspec align?: ("center"|"left"|"right");
   *
   */
  @JSProperty("align")
  @Nullable
  Align getAlign();

  /**
   * (Highcharts, Highstock, Highmaps) Alignment for the buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.align
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.align
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.align
   *
   * @implspec align?: ("center"|"left"|"right");
   *
   */
  @JSProperty("align")
  void setAlign(Align value);

  /**
   * (Highcharts, Highstock, Highmaps) The pixel spacing between buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.buttonSpacing
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.buttonSpacing
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.buttonSpacing
   *
   * @implspec buttonSpacing?: number;
   *
   */
  @JSProperty("buttonSpacing")
  double getButtonSpacing();

  /**
   * (Highcharts, Highstock, Highmaps) The pixel spacing between buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.buttonSpacing
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.buttonSpacing
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.buttonSpacing
   *
   * @implspec buttonSpacing?: number;
   *
   */
  @JSProperty("buttonSpacing")
  void setButtonSpacing(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Whether to enable buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.enabled
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.enabled
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  boolean getEnabled();

  /**
   * (Highcharts, Highstock, Highmaps) Whether to enable buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.enabled
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.enabled
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  void setEnabled(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) Pixel height of the buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.height
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.height
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.height
   *
   * @implspec height?: number;
   *
   */
  @JSProperty("height")
  double getHeight();

  /**
   * (Highcharts, Highstock, Highmaps) Pixel height of the buttons.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.height
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.height
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.height
   *
   * @implspec height?: number;
   *
   */
  @JSProperty("height")
  void setHeight(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Fill color for the symbol within the
   * button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolFill
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolFill
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolFill
   *
   * @implspec symbolFill?: ColorString;
   *
   */
  @JSProperty("symbolFill")
  @Nullable
  String getSymbolFill();

  /**
   * (Highcharts, Highstock, Highmaps) Fill color for the symbol within the
   * button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolFill
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolFill
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolFill
   *
   * @implspec symbolFill?: ColorString;
   *
   */
  @JSProperty("symbolFill")
  void setSymbolFill(String value);

  /**
   * (Highcharts, Highstock, Highmaps) The pixel size of the symbol on the
   * button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolSize
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolSize
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolSize
   *
   * @implspec symbolSize?: number;
   *
   */
  @JSProperty("symbolSize")
  double getSymbolSize();

  /**
   * (Highcharts, Highstock, Highmaps) The pixel size of the symbol on the
   * button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolSize
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolSize
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolSize
   *
   * @implspec symbolSize?: number;
   *
   */
  @JSProperty("symbolSize")
  void setSymbolSize(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The color of the symbol's stroke or
   * line.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolStroke
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolStroke
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolStroke
   *
   * @implspec symbolStroke?: ColorString;
   *
   */
  @JSProperty("symbolStroke")
  @Nullable
  String getSymbolStroke();

  /**
   * (Highcharts, Highstock, Highmaps) The color of the symbol's stroke or
   * line.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolStroke
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolStroke
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolStroke
   *
   * @implspec symbolStroke?: ColorString;
   *
   */
  @JSProperty("symbolStroke")
  void setSymbolStroke(String value);

  /**
   * (Highcharts, Highstock, Highmaps) The pixel stroke width of the symbol on
   * the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolStrokeWidth
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolStrokeWidth
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolStrokeWidth
   *
   * @implspec symbolStrokeWidth?: number;
   *
   */
  @JSProperty("symbolStrokeWidth")
  double getSymbolStrokeWidth();

  /**
   * (Highcharts, Highstock, Highmaps) The pixel stroke width of the symbol on
   * the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolStrokeWidth
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolStrokeWidth
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolStrokeWidth
   *
   * @implspec symbolStrokeWidth?: number;
   *
   */
  @JSProperty("symbolStrokeWidth")
  void setSymbolStrokeWidth(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The x position of the center of the
   * symbol inside the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolX
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolX
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolX
   *
   * @implspec symbolX?: number;
   *
   */
  @JSProperty("symbolX")
  double getSymbolX();

  /**
   * (Highcharts, Highstock, Highmaps) The x position of the center of the
   * symbol inside the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolX
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolX
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolX
   *
   * @implspec symbolX?: number;
   *
   */
  @JSProperty("symbolX")
  void setSymbolX(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The y position of the center of the
   * symbol inside the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolY
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolY
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolY
   *
   * @implspec symbolY?: number;
   *
   */
  @JSProperty("symbolY")
  double getSymbolY();

  /**
   * (Highcharts, Highstock, Highmaps) The y position of the center of the
   * symbol inside the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.symbolY
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.symbolY
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.symbolY
   *
   * @implspec symbolY?: number;
   *
   */
  @JSProperty("symbolY")
  void setSymbolY(double value);

  /**
   * (Highcharts, Highstock, Highmaps) A text string to add to the individual
   * button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.text
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.text
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.text
   *
   * @implspec text?: string;
   *
   */
  @JSProperty("text")
  @Nullable
  String getText();

  /**
   * (Highcharts, Highstock, Highmaps) A text string to add to the individual
   * button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.text
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.text
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.text
   *
   * @implspec text?: string;
   *
   */
  @JSProperty("text")
  void setText(String value);

  /**
   * (Highcharts, Highstock, 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/highcharts/navigation.buttonOptions.theme
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.theme
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.theme
   *
   * @implspec theme?: NavigationButtonThemeOptions;
   *
   */
  @JSProperty("theme")
  @Nullable
  NavigationButtonThemeOptions getTheme();

  /**
   * (Highcharts, Highstock, 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/highcharts/navigation.buttonOptions.theme
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.theme
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.theme
   *
   * @implspec theme?: NavigationButtonThemeOptions;
   *
   */
  @JSProperty("theme")
  void setTheme(NavigationButtonThemeOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) The vertical alignment of the buttons.
   * Can be one of "top", "middle" or "bottom".
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.verticalAlign
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.verticalAlign
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  @Nullable
  VerticalAlign getVerticalAlign();

  /**
   * (Highcharts, Highstock, Highmaps) The vertical alignment of the buttons.
   * Can be one of "top", "middle" or "bottom".
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.verticalAlign
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.verticalAlign
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  void setVerticalAlign(VerticalAlign value);

  /**
   * (Highcharts, Highstock, Highmaps) The pixel width of the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.width
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.width
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  double getWidth();

  /**
   * (Highcharts, Highstock, Highmaps) The pixel width of the button.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.width
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.width
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.width
   *
   * @implspec width?: number;
   *
   */
  @JSProperty("width")
  void setWidth(double value);

  /**
   * (Highcharts, Highstock, Highmaps) The vertical offset of the button's
   * position relative to its verticalAlign.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.y
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.y
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.y
   *
   * @implspec y?: number;
   *
   */
  @JSProperty("y")
  double getY();

  /**
   * (Highcharts, Highstock, Highmaps) The vertical offset of the button's
   * position relative to its verticalAlign.
   *
   * @see https://api.highcharts.com/highcharts/navigation.buttonOptions.y
   * @see https://api.highcharts.com/highstock/navigation.buttonOptions.y
   * @see https://api.highcharts.com/highmaps/navigation.buttonOptions.y
   *
   * @implspec y?: number;
   *
   */
  @JSProperty("y")
  void setY(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 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");
  }
}