• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• AnnotationsOptions.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.AnnotationsOptions Maven / Gradle / Ivy

package com.github.fluorumlabs.disconnect.highcharts;

import java.lang.String;
import javax.annotation.Nullable;
import js.lang.Any;
import js.util.collections.Array;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) Options for configuring annotations, for
 * example labels, arrows or shapes. Annotations can be tied to points, axis
 * coordinates or chart pixel coordinates.
 *
 * @see https://api.highcharts.com/highcharts/annotations
 * @see https://api.highcharts.com/highstock/annotations
 * @see https://api.highcharts.com/highmaps/annotations
 *
 */
public interface AnnotationsOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) Sets an ID for an annotation. Can be
   * user later when removing an annotation in Chart.removeAnnotation(id)
   * method.
   *
   * @see https://api.highcharts.com/highcharts/annotations.id
   * @see https://api.highcharts.com/highstock/annotations.id
   * @see https://api.highcharts.com/highmaps/annotations.id
   *
   * @implspec id?: string;
   *
   */
  @JSProperty("id")
  @Nullable
  String getId();

  /**
   * (Highcharts, Highstock, Highmaps) Sets an ID for an annotation. Can be
   * user later when removing an annotation in Chart.removeAnnotation(id)
   * method.
   *
   * @see https://api.highcharts.com/highcharts/annotations.id
   * @see https://api.highcharts.com/highstock/annotations.id
   * @see https://api.highcharts.com/highmaps/annotations.id
   *
   * @implspec id?: string;
   *
   */
  @JSProperty("id")
  void setId(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Options for annotation's labels. Each
   * label inherits options from the labelOptions object. An option from the
   * labelOptions can be overwritten by config for a specific label.
   *
   * @see https://api.highcharts.com/highcharts/annotations.labelOptions
   * @see https://api.highcharts.com/highstock/annotations.labelOptions
   * @see https://api.highcharts.com/highmaps/annotations.labelOptions
   *
   * @implspec labelOptions?: AnnotationsLabelOptions;
   *
   */
  @JSProperty("labelOptions")
  @Nullable
  AnnotationsLabelOptions getLabelOptions();

  /**
   * (Highcharts, Highstock, Highmaps) Options for annotation's labels. Each
   * label inherits options from the labelOptions object. An option from the
   * labelOptions can be overwritten by config for a specific label.
   *
   * @see https://api.highcharts.com/highcharts/annotations.labelOptions
   * @see https://api.highcharts.com/highstock/annotations.labelOptions
   * @see https://api.highcharts.com/highmaps/annotations.labelOptions
   *
   * @implspec labelOptions?: AnnotationsLabelOptions;
   *
   */
  @JSProperty("labelOptions")
  void setLabelOptions(AnnotationsLabelOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) An array of labels for the annotation.
   * For options that apply to multiple labels, they can be added to the
   * labelOptions.
   *
   * @see https://api.highcharts.com/highcharts/annotations.labels
   * @see https://api.highcharts.com/highstock/annotations.labels
   * @see https://api.highcharts.com/highmaps/annotations.labels
   *
   * @implspec labels?: Array;
   *
   */
  @JSProperty("labels")
  @Nullable
  Array getLabels();

  /**
   * (Highcharts, Highstock, Highmaps) An array of labels for the annotation.
   * For options that apply to multiple labels, they can be added to the
   * labelOptions.
   *
   * @see https://api.highcharts.com/highcharts/annotations.labels
   * @see https://api.highcharts.com/highstock/annotations.labels
   * @see https://api.highcharts.com/highmaps/annotations.labels
   *
   * @implspec labels?: Array;
   *
   */
  @JSProperty("labels")
  void setLabels(Array value);

  /**
   * (Highcharts, Highstock, Highmaps) Options for annotation's shapes. Each
   * shape inherits options from the shapeOptions object. An option from the
   * shapeOptions can be overwritten by config for a specific shape.
   *
   * @see https://api.highcharts.com/highcharts/annotations.shapeOptions
   * @see https://api.highcharts.com/highstock/annotations.shapeOptions
   * @see https://api.highcharts.com/highmaps/annotations.shapeOptions
   *
   * @implspec shapeOptions?: AnnotationsShapeOptions;
   *
   */
  @JSProperty("shapeOptions")
  @Nullable
  AnnotationsShapeOptions getShapeOptions();

  /**
   * (Highcharts, Highstock, Highmaps) Options for annotation's shapes. Each
   * shape inherits options from the shapeOptions object. An option from the
   * shapeOptions can be overwritten by config for a specific shape.
   *
   * @see https://api.highcharts.com/highcharts/annotations.shapeOptions
   * @see https://api.highcharts.com/highstock/annotations.shapeOptions
   * @see https://api.highcharts.com/highmaps/annotations.shapeOptions
   *
   * @implspec shapeOptions?: AnnotationsShapeOptions;
   *
   */
  @JSProperty("shapeOptions")
  void setShapeOptions(AnnotationsShapeOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) An array of shapes for the annotation.
   * For options that apply to multiple shapes, then can be added to the
   * shapeOptions.
   *
   * @see https://api.highcharts.com/highcharts/annotations.shapes
   * @see https://api.highcharts.com/highstock/annotations.shapes
   * @see https://api.highcharts.com/highmaps/annotations.shapes
   *
   * @implspec shapes?: Array;
   *
   */
  @JSProperty("shapes")
  @Nullable
  Array getShapes();

  /**
   * (Highcharts, Highstock, Highmaps) An array of shapes for the annotation.
   * For options that apply to multiple shapes, then can be added to the
   * shapeOptions.
   *
   * @see https://api.highcharts.com/highcharts/annotations.shapes
   * @see https://api.highcharts.com/highstock/annotations.shapes
   * @see https://api.highcharts.com/highmaps/annotations.shapes
   *
   * @implspec shapes?: Array;
   *
   */
  @JSProperty("shapes")
  void setShapes(Array value);

  /**
   * (Highcharts, Highstock, Highmaps) Whether the annotation is visible.
   *
   * @see https://api.highcharts.com/highcharts/annotations.visible
   * @see https://api.highcharts.com/highstock/annotations.visible
   * @see https://api.highcharts.com/highmaps/annotations.visible
   *
   * @implspec visible?: boolean;
   *
   */
  @JSProperty("visible")
  boolean getVisible();

  /**
   * (Highcharts, Highstock, Highmaps) Whether the annotation is visible.
   *
   * @see https://api.highcharts.com/highcharts/annotations.visible
   * @see https://api.highcharts.com/highstock/annotations.visible
   * @see https://api.highcharts.com/highmaps/annotations.visible
   *
   * @implspec visible?: boolean;
   *
   */
  @JSProperty("visible")
  void setVisible(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) The Z index of the annotation.
   *
   * @see https://api.highcharts.com/highcharts/annotations.zIndex
   * @see https://api.highcharts.com/highstock/annotations.zIndex
   * @see https://api.highcharts.com/highmaps/annotations.zIndex
   *
   * @implspec zIndex?: number;
   *
   */
  @JSProperty("zIndex")
  double getZIndex();

  /**
   * (Highcharts, Highstock, Highmaps) The Z index of the annotation.
   *
   * @see https://api.highcharts.com/highcharts/annotations.zIndex
   * @see https://api.highcharts.com/highstock/annotations.zIndex
   * @see https://api.highcharts.com/highmaps/annotations.zIndex
   *
   * @implspec zIndex?: number;
   *
   */
  @JSProperty("zIndex")
  void setZIndex(double value);
}