com.vaadin.flow.component.charts.model

Class Halo

java.lang.Object

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

com.vaadin.flow.component.charts.model.Halo

All Implemented Interfaces:

Serializable

public class Halo
extends AbstractConfigurationObject

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 Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Halo()

Method Summary

Modifier and Type	Method and Description
Attributes	getAttributes()
Number	getOpacity()
Number	getSize()
void	setAttributes(Attributes attributes) A collection of SVG attributes to override the appearance of the halo, for example fill, stroke and stroke-width.
void	setOpacity(Number opacity) Opacity for the halo unless a specific fill is overridden using the attributes setting.
void	setSize(Number size) The pixel size of the halo.

Methods inherited from class java.lang.Object

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

Constructor Detail

Halo

public Halo()

Method Detail

getAttributes

public Attributes getAttributes()

See Also:

setAttributes(Attributes)

setAttributes

public void setAttributes(Attributes attributes)

A collection of SVG attributes to override the appearance of the halo, for example fill, stroke and stroke-width.

getOpacity

public Number getOpacity()

See Also:

setOpacity(Number)

setOpacity

public void setOpacity(Number opacity)

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.

Defaults to: 0.25

getSize

public Number getSize()

See Also:

setSize(Number)

setSize

public void setSize(Number size)

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.

Defaults to: 10