com.github.fluorumlabs.disconnect.highcharts.SeriesRocOptions 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 js.extras.JsEnum;
import org.teavm.jso.JSProperty;

/**
 * (Highstock) A ROC series. If the type option is not specified, it is
 * inherited from chart.type.
 *
 * Rate of change indicator (ROC). The indicator value for each point is defined
 * as:
 *
 * (C - Cn) / Cn * 100
 *
 * where: C is the close value of the point of the same x in the linked series
 * and Cn is the close value of the point n periods ago. n is set through
 * period.
 *
 * This series requires linkedTo option to be set.
 *
 * Configuration options for the series are given in three levels:
 *
 * 
 * 
 * Options for all series in a chart are defined in the plotOptions.series
 * object.
 *
 * 
 * 
 * Options for all roc series are defined in plotOptions.roc.
 *
 * 
 * 
 * Options for one single series are given in the series instance array.
 *
 * 
 * 
 * (see online documentation for example)
 *
 * @see https://api.highcharts.com/highstock/series.roc
 *
 */
public interface SeriesRocOptions extends PlotRocOptions, SeriesOptions {
  /**
   * (Highcharts, Highstock, Highmaps) This property is only in TypeScript
   * non-optional and might be undefined in series objects from unknown
   * sources.
   *
   * @implspec type: "roc";
   *
   */
  @JSProperty("type")
  Type getType();

  /**
   * (Highcharts, Highstock, Highmaps) This property is only in TypeScript
   * non-optional and might be undefined in series objects from unknown
   * sources.
   *
   * @implspec type: "roc";
   *
   */
  @JSProperty("type")
  void setType(Type value);

  /**
   */
  abstract class Type extends JsEnum {
    public static final Type ROC = JsEnum.of("roc");
  }
}