Package org.vaadin.addons.componentfactory.leaflet.options

Class PanOptions

java.lang.Object
org.vaadin.addons.componentfactory.leaflet.options.PanOptions
All Implemented Interfaces:
Serializable
public class PanOptions extends Object implements Serializable
Some of the Map methods which modify the center of the map take in an options parameter.
Since:
2020-03-11
Version:
1.0
Author:
Gabor Kokeny Email: kokeny19@gmail.com
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    PanOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getDuration()
    Returns the duration of the panning animation, in seconds.
    double
    getEaseLinearity()
    Returns the curvature factor of the panning animation easing.
    boolean
    isAnimate()
    Returns whether panning is animated.
    boolean
    isNoMoveStart()
    Returns whether panning suppresses the movestart event on start.
    void
    setAnimate(boolean animate)
    If true, panning will always be animated if possible.
    void
    setDuration(double duration)
    Duration of animated panning, in seconds.
    void
    setEaseLinearity(double easeLinearity)
    The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve).
    void
    setNoMoveStart(boolean noMoveStart)
    If true, panning won't fire movestart event on start (used internally for panning inertia).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PanOptions

      public PanOptions()

  • Method Details

    • isAnimate

      public boolean isAnimate()
      Returns whether panning is animated.
      Returns:
      the animate

    • setAnimate

      public void setAnimate(boolean animate)
      If true, panning will always be animated if possible. If false, it will not animate panning, either resetting the map view if panning more than a screen away, or just setting a new offset for the map pane (except for panBy which always does the latter).
      Parameters:
      animate - the animate to set

    • getDuration

      public double getDuration()
      Returns the duration of the panning animation, in seconds.
      Returns:
      the duration

    • setDuration

      public void setDuration(double duration)
      Duration of animated panning, in seconds.
      Parameters:
      duration - the duration to set

    • getEaseLinearity

      public double getEaseLinearity()
      Returns the curvature factor of the panning animation easing.
      Returns:
      the easeLinearity

    • setEaseLinearity

      public void setEaseLinearity(double easeLinearity)
      The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, and the smaller this number, the more bowed the curve.
      Parameters:
      easeLinearity - the easeLinearity to set

    • isNoMoveStart

      public boolean isNoMoveStart()
      Returns whether panning suppresses the movestart event on start.
      Returns:
      the noMoveStart

    • setNoMoveStart

      public void setNoMoveStart(boolean noMoveStart)
      If true, panning won't fire movestart event on start (used internally for panning inertia).
      Parameters:
      noMoveStart - the noMoveStart to set