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

/**
 * (Highcharts) Options for the hovered series. These settings override the
 * normal state options when a series is moused over or touched.
 *
 * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover
 *
 */
public interface PlotPyramidStatesHoverOptions extends Any {
  /**
   * (Highcharts) Animation setting for hovering the graph in line-type
   * series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.animation
   *
   * @implspec animation?: (boolean|AnimationOptionsObject|PlotPyramidStatesHoverAnimationOptions);
   *
   */
  @JSProperty("animation")
  @Nullable
  Unknown getAnimation();

  /**
   * (Highcharts) Animation setting for hovering the graph in line-type
   * series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.animation
   *
   * @implspec animation?: (boolean|AnimationOptionsObject|PlotPyramidStatesHoverAnimationOptions);
   *
   */
  @JSProperty("animation")
  void setAnimation(boolean value);

  /**
   * (Highcharts) Animation setting for hovering the graph in line-type
   * series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.animation
   *
   * @implspec animation?: (boolean|AnimationOptionsObject|PlotPyramidStatesHoverAnimationOptions);
   *
   */
  @JSProperty("animation")
  void setAnimation(PlotPyramidStatesHoverAnimationOptions value);

  /**
   * (Highcharts) Animation setting for hovering the graph in line-type
   * series.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.animation
   *
   * @implspec animation?: (boolean|AnimationOptionsObject|PlotPyramidStatesHoverAnimationOptions);
   *
   */
  @JSProperty("animation")
  void setAnimation(AnimationOptionsObject value);

  /**
   * (Highmaps) The border color of the point in this state.
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  @Nullable
  String getBorderColor();

  /**
   * (Highmaps) The border color of the point in this state.
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.borderColor
   *
   * @implspec borderColor?: ColorString;
   *
   */
  @JSProperty("borderColor")
  void setBorderColor(String value);

  /**
   * (Highmaps) The border width of the point in this state
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  double getBorderWidth();

  /**
   * (Highmaps) The border width of the point in this state
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.borderWidth
   *
   * @implspec borderWidth?: number;
   *
   */
  @JSProperty("borderWidth")
  void setBorderWidth(double value);

  /**
   * (Highcharts) How much to brighten the point on interaction. Requires the
   * main color to be defined in hex or rgb(a) format.
   *
   * In styled mode, the hover brightness is by default replaced by a
   * fill-opacity given in the .highcharts-point-hover class.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.brightness
   *
   * @implspec brightness?: number;
   *
   */
  @JSProperty("brightness")
  double getBrightness();

  /**
   * (Highcharts) How much to brighten the point on interaction. Requires the
   * main color to be defined in hex or rgb(a) format.
   *
   * In styled mode, the hover brightness is by default replaced by a
   * fill-opacity given in the .highcharts-point-hover class.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.brightness
   *
   * @implspec brightness?: number;
   *
   */
  @JSProperty("brightness")
  void setBrightness(double value);

  /**
   * (Highmaps) The color of the shape in this state.
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  @Nullable
  Unknown getColor();

  /**
   * (Highmaps) The color of the shape in this state.
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(GradientColorObject value);

  /**
   * (Highmaps) The color of the shape in this state.
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(String value);

  /**
   * (Highmaps) The color of the shape in this state.
   *
   * @see https://api.highcharts.com/highmaps/plotOptions.pyramid.states.hover.color
   *
   * @implspec color?: (ColorString|GradientColorObject|object);
   *
   */
  @JSProperty("color")
  void setColor(Any value);

  /**
   * (Highcharts) Enable separate styles for the hovered series to visualize
   * that the user hovers either the series itself or the legend. .
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  boolean getEnabled();

  /**
   * (Highcharts) Enable separate styles for the hovered series to visualize
   * that the user hovers either the series itself or the legend. .
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.pyramid.states.hover.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  void setEnabled(boolean value);
}