• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• YAxisPlotBandsLabelOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.fluorumlabs.disconnect.highcharts.YAxisPlotBandsLabelOptions Maven / Gradle / Ivy

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, Gantt) Text labels for the plot bands
 *
 * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label
 * @see https://api.highcharts.com/highstock/yAxis.plotBands.label
 * @see https://api.highcharts.com/gantt/yAxis.plotBands.label
 *
 */
public interface YAxisPlotBandsLabelOptions extends Any {
  /**
   * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
   * one of "left", "center" or "right".
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.align
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.align
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.align
   *
   * @implspec align?: string;
   *
   */
  @JSProperty("align")
  @Nullable
  String getAlign();

  /**
   * (Highcharts, Highstock, Gantt) Horizontal alignment of the label. Can be
   * one of "left", "center" or "right".
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.align
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.align
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.align
   *
   * @implspec align?: string;
   *
   */
  @JSProperty("align")
  void setAlign(String value);

  /**
   * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees .
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.rotation
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.rotation
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.rotation
   *
   * @implspec rotation?: number;
   *
   */
  @JSProperty("rotation")
  double getRotation();

  /**
   * (Highcharts, Highstock, Gantt) Rotation of the text label in degrees .
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.rotation
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.rotation
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.rotation
   *
   * @implspec rotation?: number;
   *
   */
  @JSProperty("rotation")
  void setRotation(double value);

  /**
   * (Highcharts, Highstock, Gantt) CSS styles for the text label.
   *
   * In styled mode, the labels are styled by the
   * .highcharts-plot-band-label class.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.style
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.style
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  @Nullable
  CSSObject getStyle();

  /**
   * (Highcharts, Highstock, Gantt) CSS styles for the text label.
   *
   * In styled mode, the labels are styled by the
   * .highcharts-plot-band-label class.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.style
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.style
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.style
   *
   * @implspec style?: CSSObject;
   *
   */
  @JSProperty("style")
  void setStyle(CSSObject value);

  /**
   * (Highcharts, Highstock, Gantt) The string text itself. A subset of HTML
   * is supported.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.text
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.text
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.text
   *
   * @implspec text?: string;
   *
   */
  @JSProperty("text")
  @Nullable
  String getText();

  /**
   * (Highcharts, Highstock, Gantt) The string text itself. A subset of HTML
   * is supported.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.text
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.text
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.text
   *
   * @implspec text?: string;
   *
   */
  @JSProperty("text")
  void setText(String value);

  /**
   * (Highcharts, Highstock, Gantt) The text alignment for the label. While
   * align determines where the texts anchor point is placed within the plot
   * band, textAlign determines how the text is aligned against its anchor
   * point. Possible values are "left", "center" and "right". Defaults to the
   * same as the align option.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.textAlign
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.textAlign
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.textAlign
   *
   * @implspec textAlign?: ("center"|"left"|"right");
   *
   */
  @JSProperty("textAlign")
  @Nullable
  TextAlign getTextAlign();

  /**
   * (Highcharts, Highstock, Gantt) The text alignment for the label. While
   * align determines where the texts anchor point is placed within the plot
   * band, textAlign determines how the text is aligned against its anchor
   * point. Possible values are "left", "center" and "right". Defaults to the
   * same as the align option.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.textAlign
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.textAlign
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.textAlign
   *
   * @implspec textAlign?: ("center"|"left"|"right");
   *
   */
  @JSProperty("textAlign")
  void setTextAlign(TextAlign value);

  /**
   * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.useHTML
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.useHTML
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.useHTML
   *
   * @implspec useHTML?: boolean;
   *
   */
  @JSProperty("useHTML")
  boolean getUseHTML();

  /**
   * (Highcharts, Highstock, Gantt) Whether to use HTML to render the labels.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.useHTML
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.useHTML
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.useHTML
   *
   * @implspec useHTML?: boolean;
   *
   */
  @JSProperty("useHTML")
  void setUseHTML(boolean value);

  /**
   * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
   * to the plot band. Can be one of "top", "middle" or "bottom".
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.verticalAlign
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.verticalAlign
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  @Nullable
  VerticalAlign getVerticalAlign();

  /**
   * (Highcharts, Highstock, Gantt) Vertical alignment of the label relative
   * to the plot band. Can be one of "top", "middle" or "bottom".
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.verticalAlign
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.verticalAlign
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.verticalAlign
   *
   * @implspec verticalAlign?: ("bottom"|"middle"|"top");
   *
   */
  @JSProperty("verticalAlign")
  void setVerticalAlign(VerticalAlign value);

  /**
   * (Highcharts, Highstock, Gantt) Horizontal position relative the
   * alignment. Default varies by orientation.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.x
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.x
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  double getX();

  /**
   * (Highcharts, Highstock, Gantt) Horizontal position relative the
   * alignment. Default varies by orientation.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.x
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.x
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.x
   *
   * @implspec x?: number;
   *
   */
  @JSProperty("x")
  void setX(double value);

  /**
   * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
   * relative to the alignment. Default varies by orientation.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.y
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.y
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.y
   *
   * @implspec y?: number;
   *
   */
  @JSProperty("y")
  double getY();

  /**
   * (Highcharts, Highstock, Gantt) Vertical position of the text baseline
   * relative to the alignment. Default varies by orientation.
   *
   * @see https://api.highcharts.com/highcharts/yAxis.plotBands.label.y
   * @see https://api.highcharts.com/highstock/yAxis.plotBands.label.y
   * @see https://api.highcharts.com/gantt/yAxis.plotBands.label.y
   *
   * @implspec y?: number;
   *
   */
  @JSProperty("y")
  void setY(double value);

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

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

    public static final TextAlign 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");
  }
}