com.vaadin.flow.component.charts.model

Class Hover

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Hover

All Implemented Interfaces:

Serializable

@Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class Hover
extends AbstractConfigurationObject

Options for the hovered series

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Hover()
Hover(Boolean enabled)

Method Summary

Modifier and Type	Method and Description
Boolean	getAnimation()
Boolean	getEnabled()
Halo	getHalo()
Marker	getMarker()
Number	getRadius()
Number	getRadiusPlus()
void	setAnimation(Boolean animation) Animation setting for hovering the graph in line-type series.
void	setEnabled(Boolean enabled) Enable separate styles for the hovered series to visualize that the user hovers either the series itself or the legend.
void	setHalo(Halo halo) Options for the halo appearing around the hovered point in line-type series as well as outside the hovered slice in pie charts.
void	setMarker(Marker marker)
void	setRadius(Number radius) The radius of the point marker.
void	setRadiusPlus(Number radiusPlus) The number of pixels to increase the radius of the hovered point.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Hover

public Hover()

Hover

public Hover(Boolean enabled)

Method Detail

getAnimation

public Boolean getAnimation()

See Also:

setAnimation(Boolean)

setAnimation

public void setAnimation(Boolean animation)

Animation setting for hovering the graph in line-type series.

Defaults to: { "duration": 50 }

getEnabled

public Boolean getEnabled()

See Also:

setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Enable separate styles for the hovered series to visualize that the user hovers either the series itself or the legend. .

Defaults to: true

getHalo

public Halo getHalo()

See Also:

setHalo(Halo)

setHalo

public void setHalo(Halo halo)

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}.

getRadius

public Number getRadius()

See Also:

setRadius(Number)

setRadius

public void setRadius(Number radius)

The radius of the point marker. In hover state, it defaults to the normal state's radius + 2 as per the radiusPlus option.

getRadiusPlus

public Number getRadiusPlus()

See Also:

setRadiusPlus(Number)

setRadiusPlus

public void setRadiusPlus(Number radiusPlus)

The number of pixels to increase the radius of the hovered point.

Defaults to: 2

getMarker

public Marker getMarker()

See Also:

setMarker(Marker)

setMarker

public void setMarker(Marker marker)