com.gwidgets.api.leaflet.options

Class ControlScaleOptions

java.lang.Object

com.gwidgets.api.leaflet.options.ControlScaleOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class ControlScaleOptions
extends Object

The Class ControlScaleOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlScaleOptions.Builder The Class Builder.

Method Summary

Modifier and Type	Method and Description
boolean	getImperial() Gets Whether to show the imperial scale line (mi/ft).
double	getMaxWidth() Gets Maximum width of the control in pixels.
boolean	getMetric() Gets Whether to show the metric scale line (m/km).
String	getPosition() Gets the position of the control (one of the map corners) default "bottomleft"
boolean	getUpdateWhenIdle() Gets whether the control is updated on moveend, otherwise it's always up-to-date (updated on move).

Methods inherited from class java.lang.Object

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

Method Detail

getPosition

@JsOverlay
public final String getPosition()

Gets the position of the control (one of the map corners)
default "bottomleft"

Returns:

the position

getMaxWidth

@JsOverlay
public final double getMaxWidth()

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

Returns:

the max width

getMetric

@JsOverlay
public final boolean getMetric()

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

Returns:

the metric

getImperial

@JsOverlay
public final boolean getImperial()

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

Returns:

the imperial

getUpdateWhenIdle

@JsOverlay
public final boolean getUpdateWhenIdle()

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

Returns:

the update when idle