com.github.fluorumlabs.disconnect.highcharts.SeriesXrangeDataPartialFillOptions 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 org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Gantt) A partial fill for each point, typically used
 * to visualize how much of a task is performed. The partial fill object can be
 * set either on series or point level.
 *
 * @see https://api.highcharts.com/highcharts/series.xrange.data.partialFill
 * @see https://api.highcharts.com/highstock/series.xrange.data.partialFill
 * @see https://api.highcharts.com/gantt/series.xrange.data.partialFill
 *
 */
public interface SeriesXrangeDataPartialFillOptions extends Any {
  /**
   * (Highcharts, Highstock, Gantt) The amount of the X-range point to be
   * filled. Values can be 0-1 and are converted to percentages in the default
   * data label formatter.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.partialFill.amount
   * @see https://api.highcharts.com/highstock/series.xrange.data.partialFill.amount
   * @see https://api.highcharts.com/gantt/series.xrange.data.partialFill.amount
   *
   * @implspec amount?: number;
   *
   */
  @JSProperty("amount")
  double getAmount();

  /**
   * (Highcharts, Highstock, Gantt) The amount of the X-range point to be
   * filled. Values can be 0-1 and are converted to percentages in the default
   * data label formatter.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.partialFill.amount
   * @see https://api.highcharts.com/highstock/series.xrange.data.partialFill.amount
   * @see https://api.highcharts.com/gantt/series.xrange.data.partialFill.amount
   *
   * @implspec amount?: number;
   *
   */
  @JSProperty("amount")
  void setAmount(double value);

  /**
   * (Highcharts, Highstock, Gantt) The fill color to be used for partial
   * fills. Defaults to a darker shade of the point color.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.partialFill.fill
   * @see https://api.highcharts.com/highstock/series.xrange.data.partialFill.fill
   * @see https://api.highcharts.com/gantt/series.xrange.data.partialFill.fill
   *
   * @implspec fill?: ColorString;
   *
   */
  @JSProperty("fill")
  @Nullable
  String getFill();

  /**
   * (Highcharts, Highstock, Gantt) The fill color to be used for partial
   * fills. Defaults to a darker shade of the point color.
   *
   * @see https://api.highcharts.com/highcharts/series.xrange.data.partialFill.fill
   * @see https://api.highcharts.com/highstock/series.xrange.data.partialFill.fill
   * @see https://api.highcharts.com/gantt/series.xrange.data.partialFill.fill
   *
   * @implspec fill?: ColorString;
   *
   */
  @JSProperty("fill")
  void setFill(String value);
}