Package com.vaadin.flow.component.charts.model

Class ZoomingMouseWheel

java.lang.Object

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

com.vaadin.flow.component.charts.model.ZoomingMouseWheel

All Implemented Interfaces:

Serializable

public class ZoomingMouseWheel
extends AbstractConfigurationObject

Configuration for mouse wheel zoom.

Zooming with the mouse wheel is enabled by default in Chart.setTimeline(Boolean) charts. In other chart types, it is enabled if Zooming#getEnabled() is set. It can be disabled by setting setEnabled(Boolean) option to false.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ZoomingMouseWheel()

Method Summary

Modifier and Type	Method	Description
Boolean	getEnabled()
Number	getSensitivity()
Dimension	getType()
void	setEnabled(Boolean enabled)	Enable zooming with mouse wheel.
void	setSensitivity(Number sensitivity)	Adjust the sensitivity of the mouse wheel.
void	setType(Dimension type)	Decides in what dimensions the user can zoom scrolling the wheel.

Methods inherited from class java.lang.Object

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

Constructor Details

ZoomingMouseWheel

public ZoomingMouseWheel()

Method Details

getEnabled

public Boolean getEnabled()

See Also:

• setEnabled(Boolean)

setEnabled

public void setEnabled(Boolean enabled)

Enable zooming with mouse wheel.

Parameters:

enabled -

getSensitivity

public Number getSensitivity()

See Also:

• setSensitivity(Number)

setSensitivity

public void setSensitivity(Number sensitivity)

Adjust the sensitivity of the mouse wheel. Higher values mean the zoom changes more with each wheel turn. Lower values require more wheel turns to zoom the same amount.

Sensitivity of mouse wheel or trackpad scrolling. 1 is no sensitivity, while with 2, one mouse wheel delta will zoom in 50%.

Parameters:

sensitivity -

getType

public Dimension getType()

See Also:

• setType(Dimension)

setType

public void setType(Dimension type)

Decides in what dimensions the user can zoom scrolling the wheel. In charts not of type Chart.setTimeline(Boolean), if not specified here, it will inherit the type from Zooming.getType(). In Chart.setTimeline(Boolean) charts, it defaults to Dimension.X. Note that particularly with mouse wheel in the y direction, the zoom is affected by the default YAxis.getStartOnTick() and YAxis.getEndOnTick() settings. In order to respect these settings, the zoom level will adjust after the user has stopped zooming. To prevent this, consider setting YAxis.setStartOnTick(Boolean) and YAxis.setEndOnTick(Boolean) to false.

Parameters:

type -