com.gwidgets.api.leaflet.options

Class PanOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.PanOptions.Builder

Enclosing class:

PanOptions

public static class PanOptions.Builder
extends java.lang.Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder() Instantiates a new builder.

Method Summary

Modifier and Type	Method and Description
PanOptions.Builder	animate(java.lang.Boolean animate) If true, panning will always be animated if possible.
PanOptions	build() Builds the PanOptions new instance
PanOptions.Builder	duration(java.lang.Number duration) Duration of animated panning.
PanOptions.Builder	easeLinearity(java.lang.Number easeLinearity) The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve).
PanOptions.Builder	noMoveStart(java.lang.Boolean noMoveStart) If true, panning won't fire movestart event on start (used internally for panning inertia).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Instantiates a new builder.

Method Detail

animate

public PanOptions.Builder animate(java.lang.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

Returns:

the builder

duration

public PanOptions.Builder duration(java.lang.Number duration)

Duration of animated panning.
default 0.25

Parameters:

duration - the duration

Returns:

the builder

easeLinearity

public PanOptions.Builder easeLinearity(java.lang.Number easeLinearity)

The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, the less the more bowed the curve.
default 0.25

Parameters:

easeLinearity - the ease linearity

Returns:

the builder

noMoveStart

public PanOptions.Builder noMoveStart(java.lang.Boolean noMoveStart)

If true, panning won't fire movestart event on start (used internally for panning inertia).
default false

Parameters:

noMoveStart - the no move start

Returns:

the builder

build

public PanOptions build()

Builds the PanOptions new instance

Returns:

the pan options