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

Class Zooming

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.Zooming
All Implemented Interfaces:
Serializable
public class Zooming extends AbstractConfigurationObject
Options for zooming configuration. This enables zooming in on plots and provides options for controlling zoom behavior including mouse wheel support.
See Also:

  • Constructor Details

    • Zooming

      public Zooming()

  • Method Details

    • getKey

      public PanKey getKey()
      See Also:

    • setKey

      public void setKey(PanKey key)
      Set a key to hold when dragging to zoom the chart. This is useful to avoid zooming while moving points. Should be set different than ChartModel.getPanKey().
      Parameters:
      key -

    • getMouseWheel

      public ZoomingMouseWheel getMouseWheel()
      See Also:

    • setMouseWheel

      public void setMouseWheel(ZoomingMouseWheel mouseWheel)
      Configuration for mouse wheel zoom.
      Parameters:
      mouseWheel -

    • getPinchType

      public Dimension getPinchType()
      See Also:

    • setPinchType

      public void setPinchType(Dimension pinchType)
      Equivalent to type, but for pinch gestures. By default, the pinchType is the same as the getType() setting.
      Parameters:
      pinchType -

    • getResetButton

      public ZoomingResetButton getResetButton()
      See Also:

    • setResetButton

      public void setResetButton(ZoomingResetButton resetButton)
      The button that appears after a selection zoom, allowing the user to reset zoom.
      Parameters:
      resetButton -

    • getSingleTouch

      public Boolean getSingleTouch()
      See Also:

    • setSingleTouch

      public void setSingleTouch(Boolean singleTouch)
      Enables zooming by a single touch, in combination with getType(). When enabled, two-finger pinch will still work as set up by getPinchType(). However, single-touch will interfere with touch-dragging the chart to read the tooltip. And especially when vertical zooming is enabled, it will make it hard to scroll vertically on the page.
      Parameters:
      singleTouch -

    • getType

      public Dimension getType()
      See Also:

    • setType

      public void setType(Dimension type)
      Decides in what dimensions the user can zoom by dragging the mouse. Note: For non-cartesian series, the only supported zooming type is Dimension.XY, as zooming in a single direction is not applicable due to the radial nature of the coordinate system.
      Parameters:
      type -