com.mapbox.pluginscalebar

Class ScaleBarOptions

java.lang.Object

com.mapbox.pluginscalebar.ScaleBarOptions

public class ScaleBarOptions
extends Object

Builder class from which a scale bar is created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScaleBarOptions.LocaleUnitResolver Helper class to determine the user measuring system.

Field Summary

Fields

Modifier and Type	Field and Description
static int	REFRESH_INTERVAL_DEFAULT

Constructor Summary

Constructors

Constructor and Description
ScaleBarOptions(Context context)

Method Summary

Modifier and Type	Method and Description
ScaleBarOptions	setBarHeight(float barHeight) Set the height for blocks in scale bar.
ScaleBarOptions	setBarHeight(int barHeight) Set the height for blocks in scale bar.
ScaleBarOptions	setBorderWidth(float borderWidth) Set the border width in scale bar.
ScaleBarOptions	setBorderWidth(int borderWidth) Set the border width in scale bar.
ScaleBarOptions	setMarginLeft(float marginLeft) Set the left margin between scale bar and mapView.
ScaleBarOptions	setMarginLeft(int marginLeft) Set the left margin between scale bar and mapView.
ScaleBarOptions	setMarginTop(float marginTop) Set the margin between scale bar and the top of mapView.
ScaleBarOptions	setMarginTop(int marginTop) Set the margin between scale bar and the top of mapView.
ScaleBarOptions	setMaxWidthRatio(float ratio) Set the ratio of scale bar max width compared with MapView width.
ScaleBarOptions	setMetricUnit(boolean metricUnit) Set whether to use metric unit or not.
ScaleBarOptions	setPrimaryColor(int primaryColor) Set the primary color of the scale bar, will be used to draw odd index blocks, default value is android.R.color.black.
ScaleBarOptions	setRefreshInterval(int refreshInterval) Set plugin's minimum refresh interval, default value is REFRESH_INTERVAL_DEFAULT.
ScaleBarOptions	setSecondaryColor(int secondaryColor) Set the secondary color of the scale bar, will be used to draw even index blocks, default value is android.R.color.white.
ScaleBarOptions	setTextBarMargin(float textBarMargin) Set the margin between text and blocks inside scale bar.
ScaleBarOptions	setTextBarMargin(int textBarMargin) Set the margin between text and blocks inside scale bar.
ScaleBarOptions	setTextColor(int textColor) Set the text color on scale bar, default value is android.R.color.black.
ScaleBarOptions	setTextSize(float textSize) Set the text size of scale bar.
ScaleBarOptions	setTextSize(int textSize) Set the text size of scale bar.

Methods inherited from class java.lang.Object

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

Field Detail

REFRESH_INTERVAL_DEFAULT

public static final int REFRESH_INTERVAL_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ScaleBarOptions

public ScaleBarOptions(Context context)

Method Detail

setRefreshInterval

public ScaleBarOptions setRefreshInterval(int refreshInterval)

Set plugin's minimum refresh interval, default value is REFRESH_INTERVAL_DEFAULT.

Parameters:

refreshInterval - the min refresh interval, in millisecond.

Returns:

this

setTextColor

public ScaleBarOptions setTextColor(int textColor)

Set the text color on scale bar, default value is android.R.color.black.

Parameters:

textColor - the text color on scale bar.

Returns:

this.

setPrimaryColor

public ScaleBarOptions setPrimaryColor(int primaryColor)

Set the primary color of the scale bar, will be used to draw odd index blocks, default value is android.R.color.black.

Parameters:

primaryColor - the primary color of the scale bar.

Returns:

this.

setSecondaryColor

public ScaleBarOptions setSecondaryColor(int secondaryColor)

Set the secondary color of the scale bar, will be used to draw even index blocks, default value is android.R.color.white.

Parameters:

secondaryColor - the secondaryColor color of the scale bar.

Returns:

this.

setMarginTop

public ScaleBarOptions setMarginTop(float marginTop)

Set the margin between scale bar and the top of mapView.

Parameters:

marginTop - the margin between scale bar and the top of mapView, in pixel.

Returns:

this.

setMarginTop

public ScaleBarOptions setMarginTop(int marginTop)

Set the margin between scale bar and the top of mapView.

Parameters:

marginTop - the margin between scale bar and the top of mapView, in dp.

Returns:

this.

setBarHeight

public ScaleBarOptions setBarHeight(float barHeight)

Set the height for blocks in scale bar.

Parameters:

barHeight - the height for blocks in scale bar, in pixel.

Returns:

this.

setBarHeight

public ScaleBarOptions setBarHeight(int barHeight)

Set the height for blocks in scale bar.

Parameters:

barHeight - the height for blocks in scale bar, in dp.

Returns:

this.

setBorderWidth

public ScaleBarOptions setBorderWidth(float borderWidth)

Set the border width in scale bar.

Parameters:

borderWidth - the border width in scale bar, in pixel.

Returns:

this.

setBorderWidth

public ScaleBarOptions setBorderWidth(int borderWidth)

Set the border width in scale bar.

Parameters:

borderWidth - the border width in scale bar, in dp.

Returns:

this.

setTextSize

public ScaleBarOptions setTextSize(float textSize)

Set the text size of scale bar.

Parameters:

textSize - the text size of scale bar, in pixel.

Returns:

this.

setTextSize

public ScaleBarOptions setTextSize(int textSize)

Set the text size of scale bar.

Parameters:

textSize - the text size of scale bar, in dp.

Returns:

this.

setMetricUnit

public ScaleBarOptions setMetricUnit(boolean metricUnit)

Set whether to use metric unit or not. The default value is depends on settings of device.

Parameters:

metricUnit - whether to use metric unit or not.

Returns:

this.

setMarginLeft

public ScaleBarOptions setMarginLeft(float marginLeft)

Set the left margin between scale bar and mapView.

Parameters:

marginLeft - the left margin between scale bar and mapView, in pixel.

Returns:

this.

setMarginLeft

public ScaleBarOptions setMarginLeft(int marginLeft)

Set the left margin between scale bar and mapView.

Parameters:

marginLeft - the left margin between scale bar and mapView, in dp.

Returns:

this.

setTextBarMargin

public ScaleBarOptions setTextBarMargin(float textBarMargin)

Set the margin between text and blocks inside scale bar.

Parameters:

textBarMargin - the margin between text and blocks inside scale bar, in pixel.

Returns:

this.

setTextBarMargin

public ScaleBarOptions setTextBarMargin(int textBarMargin)

Set the margin between text and blocks inside scale bar.

Parameters:

textBarMargin - the margin between text and blocks inside scale bar, in dp.

Returns:

this.

setMaxWidthRatio

public ScaleBarOptions setMaxWidthRatio(float ratio)

Set the ratio of scale bar max width compared with MapView width.

Parameters:

ratio - the ratio scale bar will use, must be in the range from 0.1f to 1.0f.