com.github.fluorumlabs.disconnect.highcharts.PaneOptions 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.lang.Any;
import js.lang.Unknown;
import js.util.collections.Array;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts) The pane serves as a container for axes and backgrounds for
 * circular gauges and polar charts.
 *
 * @see https://api.highcharts.com/highcharts/pane
 *
 */
public interface PaneOptions extends Any {
  /**
   * (Highcharts) An array of background items for the pane.
   *
   * @see https://api.highcharts.com/highcharts/pane.background
   *
   * @implspec background?: Array;
   *
   */
  @JSProperty("background")
  @Nullable
  Array getBackground();

  /**
   * (Highcharts) An array of background items for the pane.
   *
   * @see https://api.highcharts.com/highcharts/pane.background
   *
   * @implspec background?: Array;
   *
   */
  @JSProperty("background")
  void setBackground(Array value);

  /**
   * (Highcharts) The center of a polar chart or angular gauge, given as an
   * array of [x, y] positions. Positions can be given as integers that
   * transform to pixels, or as percentages of the plot area size.
   *
   * @see https://api.highcharts.com/highcharts/pane.center
   *
   * @implspec center?: Array<(string|number)>;
   *
   */
  @JSProperty("center")
  @Nullable
  Array getCenter();

  /**
   * (Highcharts) The center of a polar chart or angular gauge, given as an
   * array of [x, y] positions. Positions can be given as integers that
   * transform to pixels, or as percentages of the plot area size.
   *
   * @see https://api.highcharts.com/highcharts/pane.center
   *
   * @implspec center?: Array<(string|number)>;
   *
   */
  @JSProperty("center")
  void setCenter(Array value);

  /**
   * (Highcharts) The end angle of the polar X axis or gauge value axis, given
   * in degrees where 0 is north. Defaults to startAngle
   *
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * @see https://api.highcharts.com/highcharts/pane.endAngle
   *
   * @implspec endAngle?: number;
   *
   */
  @JSProperty("endAngle")
  double getEndAngle();

  /**
   * (Highcharts) The end angle of the polar X axis or gauge value axis, given
   * in degrees where 0 is north. Defaults to startAngle
   *
   * 
   * 
   * 
   * 
   * 
   * 
   * 
   * @see https://api.highcharts.com/highcharts/pane.endAngle
   *
   * @implspec endAngle?: number;
   *
   */
  @JSProperty("endAngle")
  void setEndAngle(double value);

  /**
   * (Highcharts) The size of the pane, either as a number defining pixels, or
   * a percentage defining a percentage of the plot are.
   *
   * @see https://api.highcharts.com/highcharts/pane.size
   *
   * @implspec size?: (number|string);
   *
   */
  @JSProperty("size")
  @Nullable
  Unknown getSize();

  /**
   * (Highcharts) The size of the pane, either as a number defining pixels, or
   * a percentage defining a percentage of the plot are.
   *
   * @see https://api.highcharts.com/highcharts/pane.size
   *
   * @implspec size?: (number|string);
   *
   */
  @JSProperty("size")
  void setSize(double value);

  /**
   * (Highcharts) The size of the pane, either as a number defining pixels, or
   * a percentage defining a percentage of the plot are.
   *
   * @see https://api.highcharts.com/highcharts/pane.size
   *
   * @implspec size?: (number|string);
   *
   */
  @JSProperty("size")
  void setSize(String value);

  /**
   * (Highcharts) The start angle of the polar X axis or gauge axis, given in
   * degrees where 0 is north. Defaults to 0.
   *
   * @see https://api.highcharts.com/highcharts/pane.startAngle
   *
   * @implspec startAngle?: number;
   *
   */
  @JSProperty("startAngle")
  double getStartAngle();

  /**
   * (Highcharts) The start angle of the polar X axis or gauge axis, given in
   * degrees where 0 is north. Defaults to 0.
   *
   * @see https://api.highcharts.com/highcharts/pane.startAngle
   *
   * @implspec startAngle?: number;
   *
   */
  @JSProperty("startAngle")
  void setStartAngle(double value);
}