com.gwidgets.api.leaflet.options

Class ControlScaleOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.ControlScaleOptions.Builder

Enclosing class:

ControlScaleOptions

public static class ControlScaleOptions.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
ControlScaleOptions	build() Builds the ControlScaleOptions new instance
ControlScaleOptions.Builder	imperial(java.lang.Boolean imperial) Whether to show the imperial scale line (mi/ft).
ControlScaleOptions.Builder	maxWidth(java.lang.Number maxWidth) Maximum width of the control in pixels.
ControlScaleOptions.Builder	metric(java.lang.Boolean metric) Whether to show the metric scale line (m/km).
ControlScaleOptions.Builder	position(java.lang.String position) The position of the control (one of the map corners possible values: "topleft", "topright", "bottomleft", "bottomright"
ControlScaleOptions.Builder	updateWhenIdle(java.lang.Boolean updateWhenIdle) If true, the control is updated on moveend, otherwise it's always up-to-date (updated on move).

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

position

public ControlScaleOptions.Builder position(java.lang.String position)

The position of the control (one of the map corners
possible values: "topleft", "topright", "bottomleft", "bottomright"

Parameters:

position - the position

Returns:

the builder

maxWidth

public ControlScaleOptions.Builder maxWidth(java.lang.Number maxWidth)

Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500).
default 100

Parameters:

maxWidth - the max width

Returns:

the builder

metric

public ControlScaleOptions.Builder metric(java.lang.Boolean metric)

Whether to show the metric scale line (m/km).
default true

Parameters:

metric - the metric

Returns:

the builder

imperial

public ControlScaleOptions.Builder imperial(java.lang.Boolean imperial)

Whether to show the imperial scale line (mi/ft).
default true

Parameters:

imperial - the imperial

Returns:

the builder

updateWhenIdle

public ControlScaleOptions.Builder updateWhenIdle(java.lang.Boolean updateWhenIdle)

If true, the control is updated on moveend, otherwise it's always up-to-date (updated on move).
default false

Parameters:

updateWhenIdle - the update when idle

Returns:

the builder

build

public ControlScaleOptions build()

Builds the ControlScaleOptions new instance

Returns:

the control scale options