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:
public class Hover extends AbstractConfigurationObject
Options for the hovered series
See Also:
-
-
Method Summary
All Methods Modifier and Type Method Description Boolean
getAnimation()
Color
getBorderColor()
Number
getBrightness()
Color
getColor()
Boolean
getEnabled()
Color
getFillColor()
Halo
getHalo()
Color
getLineColor()
Number
getLineWidth()
Number
getLineWidthPlus()
Marker
getMarker()
Number
getOpacity()
Number
getRadius()
Number
getRadiusPlus()
void
setAnimation(Boolean animation)
Animation setting for hovering the graph in line-type series.
void
setBorderColor(Color borderColor)
A specific border color for the hovered point.
void
setBrightness(Number brightness)
How much to brighten the point on interaction.
void
setColor(Color color)
A specific color for the hovered point.
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
setFillColor(Color fillColor)
The fill color of the marker in hover state.
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
setLineColor(Color lineColor)
The color of the point marker's outline.
void
setLineWidth(Number lineWidth)
Pixel with of the graph line.
void
setLineWidthPlus(Number lineWidthPlus)
The additional line width for the graph of a hovered series.
void
setMarker(Marker marker)
void
setOpacity(Number opacity)
The opacity of a point in treemap.
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.
-
-
-
Constructor Detail
-
Hover
public Hover()
-
Hover
public Hover(Boolean enabled)
-
-
Method Detail
-
getAnimation
public Boolean getAnimation()
See Also:
-
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
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
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 tofalse
.In styled mode, the halo is styled with the
.highcharts-halo
class, with colors inherited from.highcharts-color-{n}
.
-
getLineWidth
public Number getLineWidth()
See Also:
-
setLineWidth
public void setLineWidth(Number lineWidth)
Pixel with of the graph line.
Defaults to: 2
-
getLineWidthPlus
public Number getLineWidthPlus()
See Also:
-
setLineWidthPlus
public void setLineWidthPlus(Number lineWidthPlus)
The additional line width for the graph of a hovered series.
Defaults to: 1
-
getFillColor
public Color getFillColor()
See Also:
-
setFillColor
public void setFillColor(Color fillColor)
The fill color of the marker in hover state.
-
getLineColor
public Color getLineColor()
See Also:
-
setLineColor
public void setLineColor(Color lineColor)
The color of the point marker's outline. When
null
, the series' or point's color is used.Defaults to: #ffffff
-
getRadius
public Number getRadius()
See Also:
-
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
public void setRadiusPlus(Number radiusPlus)
The number of pixels to increase the radius of the hovered point.
Defaults to: 2
-
getBorderColor
public Color getBorderColor()
See Also:
-
setBorderColor
public void setBorderColor(Color borderColor)
A specific border color for the hovered point. Defaults to inherit the normal state border color.
-
getBrightness
public Number getBrightness()
See Also:
-
setBrightness
public void setBrightness(Number brightness)
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.Defaults to: 0.1
-
getColor
public Color getColor()
See Also:
-
setColor
public void setColor(Color color)
A specific color for the hovered point.
Defaults to: undefined
-
getOpacity
public Number getOpacity()
See Also:
-
setOpacity
public void setOpacity(Number opacity)
The opacity of a point in treemap. When a point has children, the visibility of the children is determined by the opacity.
Defaults to: 0.75
-
getMarker
public Marker getMarker()
See Also:
-
setMarker
public void setMarker(Marker marker)
-
-