com.github.fluorumlabs.disconnect.highcharts.PlotHistogramStatesHoverOptions 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
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
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, Highstock, Gantt) Options for the hovered point. These settings
* override the normal state options when a point is moused over or touched.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover
* @see https://api.highcharts.com/highstock/plotOptions.histogram.states.hover
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover
*
*/
public interface PlotHistogramStatesHoverOptions extends Any {
/**
* (Highcharts) Animation setting for hovering the graph in line-type
* series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotHistogramStatesHoverAnimationOptions);
*
*/
@JSProperty("animation")
@Nullable
Unknown getAnimation();
/**
* (Highcharts) Animation setting for hovering the graph in line-type
* series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotHistogramStatesHoverAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(boolean value);
/**
* (Highcharts) Animation setting for hovering the graph in line-type
* series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotHistogramStatesHoverAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(PlotHistogramStatesHoverAnimationOptions value);
/**
* (Highcharts) Animation setting for hovering the graph in line-type
* series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.animation
*
* @implspec animation?: (boolean|AnimationOptionsObject|PlotHistogramStatesHoverAnimationOptions);
*
*/
@JSProperty("animation")
void setAnimation(AnimationOptionsObject value);
/**
* (Highcharts, Gantt) A specific border color for the hovered point.
* Defaults to inherit the normal state border color.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.borderColor
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
@Nullable
String getBorderColor();
/**
* (Highcharts, Gantt) A specific border color for the hovered point.
* Defaults to inherit the normal state border color.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.borderColor
* @see https://api.highcharts.com/gantt/plotOptions.histogram.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.histogram.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.histogram.states.hover.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
void setBorderWidth(double value);
/**
* (Highcharts, Highstock, Gantt) 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 brightening is by default replaced with a
* fill-opacity set in the .highcharts-point:hover
rule.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.brightness
* @see https://api.highcharts.com/highstock/plotOptions.histogram.states.hover.brightness
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.brightness
*
* @implspec brightness?: number;
*
*/
@JSProperty("brightness")
double getBrightness();
/**
* (Highcharts, Highstock, Gantt) 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 brightening is by default replaced with a
* fill-opacity set in the .highcharts-point:hover
rule.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.brightness
* @see https://api.highcharts.com/highstock/plotOptions.histogram.states.hover.brightness
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.brightness
*
* @implspec brightness?: number;
*
*/
@JSProperty("brightness")
void setBrightness(double value);
/**
* (Highcharts, Gantt) A specific color for the hovered point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.color
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
@Nullable
Unknown getColor();
/**
* (Highcharts, Gantt) A specific color for the hovered point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.color
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(GradientColorObject value);
/**
* (Highcharts, Gantt) A specific color for the hovered point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.color
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(String value);
/**
* (Highcharts, Gantt) A specific color for the hovered point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.histogram.states.hover.color
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(Any value);
/**
* (Highcharts, Highstock, Gantt) 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.histogram.states.hover.enabled
* @see https://api.highcharts.com/highstock/plotOptions.histogram.states.hover.enabled
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
boolean getEnabled();
/**
* (Highcharts, Highstock, Gantt) 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.histogram.states.hover.enabled
* @see https://api.highcharts.com/highstock/plotOptions.histogram.states.hover.enabled
* @see https://api.highcharts.com/gantt/plotOptions.histogram.states.hover.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
void setEnabled(boolean value);
}