com.github.fluorumlabs.disconnect.highcharts.PaneBackgroundOptions 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 js.lang.Unknown;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts) An array of background items for the pane.
 *
 * @see https://api.highcharts.com/highcharts/pane.background
 *
 */
public interface PaneBackgroundOptions extends Any {
  /**
   * (Highcharts) The background color or gradient for the pane.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.backgroundColor
   *
   * @implspec backgroundColor?: GradientColorObject;
   *
   */
  @JSProperty("backgroundColor")
  @Nullable
  GradientColorObject getBackgroundColor();

  /**
   * (Highcharts) The background color or gradient for the pane.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.backgroundColor
   *
   * @implspec backgroundColor?: GradientColorObject;
   *
   */
  @JSProperty("backgroundColor")
  void setBackgroundColor(GradientColorObject value);

  /**
   * (Highcharts) The pane background border color.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  @Nullable
  String getBorderColor();

  /**
   * (Highcharts) The pane background border color.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  void setBorderColor(String value);

  /**
   * (Highcharts) The pixel border width of the pane background.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  double getBorderWidth();

  /**
   * (Highcharts) The pixel border width of the pane background.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  void setBorderWidth(double value);

  /**
   * (Highcharts) The class name for this background.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  @Nullable
  String getClassName();

  /**
   * (Highcharts) The class name for this background.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.className
   *
   * @implspec className?: string;
   *
   */
  @JSProperty("className")
  void setClassName(String value);

  /**
   * (Highcharts) The inner radius of the pane background. Can be either
   * numeric (pixels) or a percentage string.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.innerRadius
   *
   * @implspec innerRadius?: (number|string);
   *
   */
  @JSProperty("innerRadius")
  @Nullable
  Unknown getInnerRadius();

  /**
   * (Highcharts) The inner radius of the pane background. Can be either
   * numeric (pixels) or a percentage string.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.innerRadius
   *
   * @implspec innerRadius?: (number|string);
   *
   */
  @JSProperty("innerRadius")
  void setInnerRadius(double value);

  /**
   * (Highcharts) The inner radius of the pane background. Can be either
   * numeric (pixels) or a percentage string.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.innerRadius
   *
   * @implspec innerRadius?: (number|string);
   *
   */
  @JSProperty("innerRadius")
  void setInnerRadius(String value);

  /**
   * (Highcharts) The outer radius of the circular pane background. Can be
   * either numeric (pixels) or a percentage string.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.outerRadius
   *
   * @implspec outerRadius?: (number|string);
   *
   */
  @JSProperty("outerRadius")
  @Nullable
  Unknown getOuterRadius();

  /**
   * (Highcharts) The outer radius of the circular pane background. Can be
   * either numeric (pixels) or a percentage string.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.outerRadius
   *
   * @implspec outerRadius?: (number|string);
   *
   */
  @JSProperty("outerRadius")
  void setOuterRadius(double value);

  /**
   * (Highcharts) The outer radius of the circular pane background. Can be
   * either numeric (pixels) or a percentage string.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.outerRadius
   *
   * @implspec outerRadius?: (number|string);
   *
   */
  @JSProperty("outerRadius")
  void setOuterRadius(String value);

  /**
   * (Highcharts) The shape of the pane background. When solid, the
   * background is circular. When arc, the background extends only from the
   * min to the max of the value axis.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.shape
   *
   * @implspec shape?: ("arc"|"circle"|"solid");
   *
   */
  @JSProperty("shape")
  @Nullable
  Shape getShape();

  /**
   * (Highcharts) The shape of the pane background. When solid, the
   * background is circular. When arc, the background extends only from the
   * min to the max of the value axis.
   *
   * @see https://api.highcharts.com/highcharts/pane.background.shape
   *
   * @implspec shape?: ("arc"|"circle"|"solid");
   *
   */
  @JSProperty("shape")
  void setShape(Shape value);

  /**
   */
  abstract class Shape extends JsEnum {
    public static final Shape ARC = JsEnum.of("arc");

    public static final Shape CIRCLE = JsEnum.of("circle");

    public static final Shape SOLID = JsEnum.of("solid");
  }
}