Skip navigation links
Mapbox Android Scalebar Plugin 0.5.0 Reference
C G I L O R S 

C

com.mapbox.pluginscalebar - package com.mapbox.pluginscalebar
 
create(ScaleBarOptions) - Method in class com.mapbox.pluginscalebar.ScaleBarPlugin
Create a scale bar widget on mapView.

G

getBarHeight() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the bar height for blocks.
getBorderWidth() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the border width in scale bar.
getMapViewWidth() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the width of current mapView.
getMarginLeft() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the left margin between scale bar and mapView.
getMarginTop() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the margin between scale bar and the top of mapView,
getPrimaryColor() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the primary color of the scale bar.
getRatio() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the current ratio of scale bar.
getRefreshInterval() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get plugin's minimum refresh interval, in millisecond.
getSecondaryColor() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the secondary color of the scale bar.
getTextBarMargin() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the margin between text and blocks.
getTextColor() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the color for text.
getTextSize() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the text size of scale bar.

I

isEnabled() - Method in class com.mapbox.pluginscalebar.ScaleBarPlugin
Returns true if the scale plugin is currently enabled and visible.
isMetricSystem() - Static method in class com.mapbox.pluginscalebar.ScaleBarOptions.LocaleUnitResolver
Returns true if the user is in a country using the metric system.
isMetricUnit() - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Get the current setting for metrix unit.

L

LocaleUnitResolver() - Constructor for class com.mapbox.pluginscalebar.ScaleBarOptions.LocaleUnitResolver
 

O

onDraw(Canvas) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
 

R

REFRESH_INTERVAL_DEFAULT - Static variable in class com.mapbox.pluginscalebar.ScaleBarOptions
 

S

ScaleBarOptions - Class in com.mapbox.pluginscalebar
Builder class from which a scale bar is created.
ScaleBarOptions(Context) - Constructor for class com.mapbox.pluginscalebar.ScaleBarOptions
 
ScaleBarOptions.LocaleUnitResolver - Class in com.mapbox.pluginscalebar
Helper class to determine the user measuring system.
ScaleBarPlugin - Class in com.mapbox.pluginscalebar
Plugin class that shows a scale bar on MapView and changes the scale corresponding to the MapView's scale.
ScaleBarPlugin(MapView, MapboxMap) - Constructor for class com.mapbox.pluginscalebar.ScaleBarPlugin
 
ScaleBarWidget - Class in com.mapbox.pluginscalebar
The scale widget is a visual representation of the scale bar plugin.
setBarHeight(float) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the height for blocks in scale bar.
setBarHeight(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the height for blocks in scale bar.
setBarHeight(float) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the height for blocks in scale bar.
setBorderWidth(float) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the border width in scale bar.
setBorderWidth(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the border width in scale bar.
setBorderWidth(float) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the border width in scale bar.
setEnabled(boolean) - Method in class com.mapbox.pluginscalebar.ScaleBarPlugin
Toggles the scale plugin state.
setMarginLeft(float) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the left margin between scale bar and mapView.
setMarginLeft(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the left margin between scale bar and mapView.
setMarginLeft(float) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the left margin between scale bar and mapView.
setMarginTop(float) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the margin between scale bar and the top of mapView.
setMarginTop(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the margin between scale bar and the top of mapView.
setMarginTop(float) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the margin between scale bar and the top of mapView.
setMaxWidthRatio(float) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the ratio of scale bar max width compared with MapView width.
setMetricUnit(boolean) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set whether to use metric unit or not.
setMetricUnit(boolean) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set whether to use metric unit or not.
setPrimaryColor(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the primary color of the scale bar, will be used to draw odd index blocks, default value is android.R.color.black.
setPrimaryColor(int) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the primary color of the scale bar, will be used to draw odd index blocks,
setRatio(float) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the ratio of scale bar max width compared with MapView width.
setRefreshInterval(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set plugin's minimum refresh interval, default value is ScaleBarOptions.REFRESH_INTERVAL_DEFAULT.
setRefreshInterval(int) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set plugin's minimum refresh interval, in millisecond.
setSecondaryColor(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the secondary color of the scale bar, will be used to draw even index blocks, default value is android.R.color.white.
setSecondaryColor(int) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the secondary color of the scale bar, will be used to draw even index blocks,
setTextBarMargin(float) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the margin between text and blocks inside scale bar.
setTextBarMargin(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the margin between text and blocks inside scale bar.
setTextBarMargin(float) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the margin between text and blocks inside scale bar.
setTextColor(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the text color on scale bar, default value is android.R.color.black.
setTextColor(int) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the text color on scale bar,
setTextSize(float) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the text size of scale bar.
setTextSize(int) - Method in class com.mapbox.pluginscalebar.ScaleBarOptions
Set the text size of scale bar.
setTextSize(float) - Method in class com.mapbox.pluginscalebar.ScaleBarWidget
Set the text size of scale bar.
C G I L O R S 
Skip navigation links
Mapbox Android Scalebar Plugin 0.5.0 Reference

© 2015–2019 Mapbox. All rights reserved.