com.github.fluorumlabs.disconnect.highcharts.CreditsPositionOptions 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) Position configuration for the credits
 * label.
 *
 * @see https://api.highcharts.com/highcharts/credits.position
 * @see https://api.highcharts.com/highstock/credits.position
 * @see https://api.highcharts.com/highmaps/credits.position
 *
 */
public interface CreditsPositionOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) Horizontal alignment of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.align
   * @see https://api.highcharts.com/highstock/credits.position.align
   * @see https://api.highcharts.com/highmaps/credits.position.align
   *
   * @implspec align?: ("center"|"left"|"right");
   *
   */
  @JSProperty("align")
  @Nullable
  Align getAlign();

  /**
   * (Highcharts, Highstock, Highmaps) Horizontal alignment of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.align
   * @see https://api.highcharts.com/highstock/credits.position.align
   * @see https://api.highcharts.com/highmaps/credits.position.align
   *
   * @implspec align?: ("center"|"left"|"right");
   *
   */
  @JSProperty("align")
  void setAlign(Align value);

  /**
   * (Highcharts, Highstock, Highmaps) Vertical alignment of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.verticalAlign
   * @see https://api.highcharts.com/highstock/credits.position.verticalAlign
   * @see https://api.highcharts.com/highmaps/credits.position.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  @Nullable
  VerticalAlign getVerticalAlign();

  /**
   * (Highcharts, Highstock, Highmaps) Vertical alignment of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.verticalAlign
   * @see https://api.highcharts.com/highstock/credits.position.verticalAlign
   * @see https://api.highcharts.com/highmaps/credits.position.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  void setVerticalAlign(VerticalAlign value);

  /**
   * (Highcharts, Highstock, Highmaps) Horizontal pixel offset of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.x
   * @see https://api.highcharts.com/highstock/credits.position.x
   * @see https://api.highcharts.com/highmaps/credits.position.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  double getX();

  /**
   * (Highcharts, Highstock, Highmaps) Horizontal pixel offset of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.x
   * @see https://api.highcharts.com/highstock/credits.position.x
   * @see https://api.highcharts.com/highmaps/credits.position.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  void setX(double value);

  /**
   * (Highcharts, Highstock, Highmaps) Vertical pixel offset of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.y
   * @see https://api.highcharts.com/highstock/credits.position.y
   * @see https://api.highcharts.com/highmaps/credits.position.y
   *
   * @implspec y?: number;
   *
   */
  @JSProperty("y")
  double getY();

  /**
   * (Highcharts, Highstock, Highmaps) Vertical pixel offset of the credits.
   *
   * @see https://api.highcharts.com/highcharts/credits.position.y
   * @see https://api.highcharts.com/highstock/credits.position.y
   * @see https://api.highcharts.com/highmaps/credits.position.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");
  }
}