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

public interface PlotZigzagParamsOptions extends Any {
  /**
   * (Highstock) The threshold for the value change.
   *
   * For example deviation=1 means the indicator will ignore all price
   * movements less than 1%.
   *
   * @see https://api.highcharts.com/highstock/plotOptions.zigzag.params.deviation
   *
   * @implspec deviation?: number;
   *
   */
  @JSProperty("deviation")
  double getDeviation();

  /**
   * (Highstock) The threshold for the value change.
   *
   * For example deviation=1 means the indicator will ignore all price
   * movements less than 1%.
   *
   * @see https://api.highcharts.com/highstock/plotOptions.zigzag.params.deviation
   *
   * @implspec deviation?: number;
   *
   */
  @JSProperty("deviation")
  void setDeviation(double value);

  /**
   * (Highstock) The point index which indicator calculations will base - high
   * value.
   *
   * For example using OHLC data, index=1 means the indicator will be
   * calculated using High values.
   *
   * @see https://api.highcharts.com/highstock/plotOptions.zigzag.params.highIndex
   *
   * @implspec highIndex?: number;
   *
   */
  @JSProperty("highIndex")
  double getHighIndex();

  /**
   * (Highstock) The point index which indicator calculations will base - high
   * value.
   *
   * For example using OHLC data, index=1 means the indicator will be
   * calculated using High values.
   *
   * @see https://api.highcharts.com/highstock/plotOptions.zigzag.params.highIndex
   *
   * @implspec highIndex?: number;
   *
   */
  @JSProperty("highIndex")
  void setHighIndex(double value);

  /**
   * (Highstock) The point index which indicator calculations will base - low
   * value.
   *
   * For example using OHLC data, index=2 means the indicator will be
   * calculated using Low values.
   *
   * @see https://api.highcharts.com/highstock/plotOptions.zigzag.params.lowIndex
   *
   * @implspec lowIndex?: number;
   *
   */
  @JSProperty("lowIndex")
  double getLowIndex();

  /**
   * (Highstock) The point index which indicator calculations will base - low
   * value.
   *
   * For example using OHLC data, index=2 means the indicator will be
   * calculated using Low values.
   *
   * @see https://api.highcharts.com/highstock/plotOptions.zigzag.params.lowIndex
   *
   * @implspec lowIndex?: number;
   *
   */
  @JSProperty("lowIndex")
  void setLowIndex(double value);
}