com.mapbox.pluginscalebar

Class ScaleBarPlugin

java.lang.Object

com.mapbox.pluginscalebar.ScaleBarPlugin

public class ScaleBarPlugin
extends Object

Plugin class that shows a scale bar on MapView and changes the scale corresponding to the MapView's scale.

Constructor Summary

Constructors

Constructor and Description
ScaleBarPlugin(MapView mapView, MapboxMap mapboxMap)

Method Summary

Modifier and Type	Method and Description
ScaleBarWidget	create(ScaleBarOptions option) Create a scale bar widget on mapView.
boolean	isEnabled() Returns true if the scale plugin is currently enabled and visible.
void	setEnabled(boolean enabled) Toggles the scale plugin state.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScaleBarPlugin

public ScaleBarPlugin(MapView mapView,
                      MapboxMap mapboxMap)

Method Detail

create

public ScaleBarWidget create(ScaleBarOptions option)

Create a scale bar widget on mapView.

Parameters:

option - The scale bar widget options that used to build scale bar widget.

Returns:

The created ScaleBarWidget instance.

isEnabled

public boolean isEnabled()

Returns true if the scale plugin is currently enabled and visible.

Returns:

true if enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Toggles the scale plugin state.

If the scale plugin wasn enabled, a com.mapbox.mapboxsdk.maps.MapboxMap.OnCameraMoveListener will be added to the MapView to listen to scale change events to update the state of this plugin. If the plugin was disabled the com.mapbox.mapboxsdk.maps.MapboxMap.OnCameraMoveListener will be removed from the map.