com.gwidgets.api.leaflet.options

Class FitBoundsOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.FitBoundsOptions.Builder

Enclosing class:

FitBoundsOptions

public static class FitBoundsOptions.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
FitBoundsOptions	build() Builds the FitBoundsOptions new instance
FitBoundsOptions.Builder	maxZoom(java.lang.Number maxZoom) The maximum possible zoom to use.
FitBoundsOptions.Builder	padding(Point padding) Equivalent of setting both top left and bottom right padding to the same value.
FitBoundsOptions.Builder	paddingBottomRight(Point paddingBottomRight) The same for bottom right corner of the map.
FitBoundsOptions.Builder	paddingTopLeft(Point paddingTopLeft) Sets the amount of padding in the top left corner of a map container that shouldn't be accounted for when setting the view to fit bounds.

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

paddingTopLeft

public FitBoundsOptions.Builder paddingTopLeft(Point paddingTopLeft)

Sets the amount of padding in the top left corner of a map container that shouldn't be accounted for when setting the view to fit bounds. Useful if you have some control overlays on the map like a sidebar and you don't want them to obscure objects you're zooming to.
default [0, 0]

Parameters:

paddingTopLeft - the padding top left

Returns:

the builder

paddingBottomRight

public FitBoundsOptions.Builder paddingBottomRight(Point paddingBottomRight)

The same for bottom right corner of the map.
default [0, 0]

Parameters:

paddingBottomRight - the padding bottom right

Returns:

the builder

padding

public FitBoundsOptions.Builder padding(Point padding)

Equivalent of setting both top left and bottom right padding to the same value.
default [0, 0]

Parameters:

padding - the padding

Returns:

the builder

maxZoom

public FitBoundsOptions.Builder maxZoom(java.lang.Number maxZoom)

The maximum possible zoom to use.
default null

Parameters:

maxZoom - the max zoom

Returns:

the builder

build

public FitBoundsOptions build()

Builds the FitBoundsOptions new instance

Returns:

the fit bounds options