com.github.fluorumlabs.disconnect.highcharts.PlotMappointStatesHoverHaloOptions 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 javax.annotation.Nullable;
import js.lang.Any;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock) Options for the halo appearing around the hovered
 * point in line- type series as well as outside the hovered slice in pie
 * charts. By default the halo is filled by the current point or series color
 * with an opacity of 0.25. The halo can be disabled by setting the halo
 * option to false.
 *
 * In styled mode, the halo is styled with the .highcharts-halo class, with
 * colors inherited from .highcharts-color-{n}.
 *
 * @see https://api.highcharts.com/highcharts/plotOptions.mappoint.states.hover.halo
 * @see https://api.highcharts.com/highstock/plotOptions.mappoint.states.hover.halo
 *
 */
public interface PlotMappointStatesHoverHaloOptions extends Any {
  /**
   * (Highcharts, Highstock) A collection of SVG attributes to override the
   * appearance of the halo, for example fill, stroke and stroke-width.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.mappoint.states.hover.halo.attributes
   * @see https://api.highcharts.com/highstock/plotOptions.mappoint.states.hover.halo.attributes
   *
   * @implspec attributes?: SVGAttributes;
   *
   */
  @JSProperty("attributes")
  @Nullable
  SVGAttributes getAttributes();

  /**
   * (Highcharts, Highstock) A collection of SVG attributes to override the
   * appearance of the halo, for example fill, stroke and stroke-width.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.mappoint.states.hover.halo.attributes
   * @see https://api.highcharts.com/highstock/plotOptions.mappoint.states.hover.halo.attributes
   *
   * @implspec attributes?: SVGAttributes;
   *
   */
  @JSProperty("attributes")
  void setAttributes(SVGAttributes value);

  /**
   * (Highcharts, Highstock) Opacity for the halo unless a specific fill is
   * overridden using the attributes setting. Note that Highcharts is only
   * able to apply opacity to colors of hex or rgb(a) formats.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.mappoint.states.hover.halo.opacity
   * @see https://api.highcharts.com/highstock/plotOptions.mappoint.states.hover.halo.opacity
   *
   * @implspec opacity?: number;
   *
   */
  @JSProperty("opacity")
  double getOpacity();

  /**
   * (Highcharts, Highstock) Opacity for the halo unless a specific fill is
   * overridden using the attributes setting. Note that Highcharts is only
   * able to apply opacity to colors of hex or rgb(a) formats.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.mappoint.states.hover.halo.opacity
   * @see https://api.highcharts.com/highstock/plotOptions.mappoint.states.hover.halo.opacity
   *
   * @implspec opacity?: number;
   *
   */
  @JSProperty("opacity")
  void setOpacity(double value);

  /**
   * (Highcharts, Highstock) The pixel size of the halo. For point markers
   * this is the radius of the halo. For pie slices it is the width of the
   * halo outside the slice. For bubbles it defaults to 5 and is the width of
   * the halo outside the bubble.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.mappoint.states.hover.halo.size
   * @see https://api.highcharts.com/highstock/plotOptions.mappoint.states.hover.halo.size
   *
   * @implspec size?: number;
   *
   */
  @JSProperty("size")
  double getSize();

  /**
   * (Highcharts, Highstock) The pixel size of the halo. For point markers
   * this is the radius of the halo. For pie slices it is the width of the
   * halo outside the slice. For bubbles it defaults to 5 and is the width of
   * the halo outside the bubble.
   *
   * @see https://api.highcharts.com/highcharts/plotOptions.mappoint.states.hover.halo.size
   * @see https://api.highcharts.com/highstock/plotOptions.mappoint.states.hover.halo.size
   *
   * @implspec size?: number;
   *
   */
  @JSProperty("size")
  void setSize(double value);
}