All Implemented Interfaces:

org.osmdroid.util.constants.GeoConstants , org.osmdroid.views.util.constants.OverlayConstants
```
public class ScaleBarOverlay
extends Overlay implements GeoConstants
                    
```
ScaleBarOverlay.java
Puts a scale bar in the top-left corner of the screen, offset by a configurable number of pixels. The bar is scaled to 1-inch length by querying for the physical DPI of the screen. The size of the bar is printed between the tick marks. A vertical (longitude) scale can be enabled. Scale is printed in metric (kilometers, meters), imperial (miles, feet) and nautical (nautical miles, feet).
Author: Erik Burrows, Griffin Systems LLC erik@griffinsystems.org
Change Log: 2010-10-08: Inclusion to osmdroid trunk 2015-12-17: Allow for top, bottom, left or right placement by W. Strickling
Usage: MapView map = new MapView(...); ScaleBarOverlay scaleBar = new ScaleBarOverlay(map); // Thiw is an important change of calling!
map.getOverlays().add(scaleBar);
To Do List: 1. Allow for top, bottom, left or right placement. // done in this changement 2. Scale bar to precise displayed scale text after rounding.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`ScaleBarOverlay.UnitsOfMeasure`

Field Summary

Fields
Modifier and Type	Field	Description
`double`	`minZoom`
`ScaleBarOverlay.UnitsOfMeasure`	`unitsOfMeasure`
`protected boolean`	`alignBottom`
`protected boolean`	`alignRight`
`public float`	`xdpi`
`public float`	`ydpi`
`public int`	`screenWidth`
`public int`	`screenHeight`
`private Paint`	`barPaint`
`private Paint`	`textPaint`
`private boolean`	`centred`
`private float`	`maxLength`

Constructor Summary

Constructors
Constructor	Description
`ScaleBarOverlay(MapView mapView)`
`ScaleBarOverlay(Context pContext, int pMapWidth, int pMapHeight)`

Method Summary

Modifier and Type	Method	Description
`void`	`setMinZoom(double zoom)`	Sets the minimum zoom level for the scale bar to be drawn.
`ScaleBarOverlay.UnitsOfMeasure`	`getUnitsOfMeasure()`	Gets the units of measure to be shown in the scale bar
`void`	`setUnitsOfMeasure(ScaleBarOverlay.UnitsOfMeasure unitsOfMeasure)`	Sets the units of measure to be shown in the scale bar
`void`	`setAlignBottom(boolean alignBottom)`
`void`	`setAlignRight(boolean alignRight)`
`Paint`	`getBarPaint()`	Return's the paint used to draw the bar
`void`	`setBarPaint(Paint pBarPaint)`	Sets the paint for drawing the bar
`Paint`	`getTextPaint()`	Returns the paint used to draw the text
`void`	`setTextPaint(Paint pTextPaint)`	Sets the paint for drawing the text
`void`	`setCentred(boolean centred)`	Flag to draw the bar centered around the set offset coordinates or to the right/bottom of thecoordinates (default)
`void`	`setMaxLength(float pMaxLengthInCm)`	Sets the maximum bar length.
`void`	`setScaleBarOffset(int x, int y)`	Sets the scale bar screen offset for the bar.
`void`	`setLineWidth(float width)`	Sets the bar's line width.
`void`	`setTextSize(float size)`	Sets the text size.
`void`	`drawLatitudeScale(boolean latitude)`	Latitudinal / horizontal scale bar flag
`void`	`drawLongitudeScale(boolean longitude)`	Longitudinal / vertical scale bar flag
`void`	`setBackgroundPaint(Paint pBgPaint)`	Sets the background paint.
`void`	`setEnableAdjustLength(boolean adjustLength)`	If enabled, the bar will automatically adjust the length to reflect a round number (startingwith 1, 2 or 5).
`void`	`draw(Canvas c, Projection projection)`
`void`	`disableScaleBar()`
`void`	`enableScaleBar()`
`void`	`onDetach(MapView mapView)`	Override to perform clean up of resources before shutdown.
`static String`	`getScaleString(Context pContext, String pValue, GeoConstants.UnitOfMeasure pUnitOfMeasure)`

Methods inherited from class org.osmdroid.views.overlay.Overlay
draw, draw, getBounds, isEnabled, onDetach, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onLongPress, onPause, onResume, onScroll, onShowPress, onSingleTapConfirmed, onSingleTapUp, onTouchEvent, onTrackballEvent, setEnabled
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScaleBarOverlay
```
ScaleBarOverlay(MapView mapView)
```
  - ScaleBarOverlay
```
ScaleBarOverlay(Context pContext, int pMapWidth, int pMapHeight)
```
- Method Detail
  - setMinZoom
```
 void setMinZoom(double zoom)
```
    Sets the minimum zoom level for the scale bar to be drawn.
    
    Parameters:
    
    zoom - minimum zoom level
  - getUnitsOfMeasure
```
 ScaleBarOverlay.UnitsOfMeasure getUnitsOfMeasure()
```
    Gets the units of measure to be shown in the scale bar
  - setUnitsOfMeasure
```
 void setUnitsOfMeasure(ScaleBarOverlay.UnitsOfMeasure unitsOfMeasure)
```
    Sets the units of measure to be shown in the scale bar
  - setAlignBottom
```
 void setAlignBottom(boolean alignBottom)
```
  - setAlignRight
```
 void setAlignRight(boolean alignRight)
```
  - getBarPaint
```
 Paint getBarPaint()
```
    Return's the paint used to draw the bar
  - setBarPaint
```
 void setBarPaint(Paint pBarPaint)
```
    Sets the paint for drawing the bar
    
    Parameters:
    
    pBarPaint - bar drawing paint
  - getTextPaint
```
 Paint getTextPaint()
```
    Returns the paint used to draw the text
  - setTextPaint
```
 void setTextPaint(Paint pTextPaint)
```
    Sets the paint for drawing the text
    
    Parameters:
    
    pTextPaint - text drawing paint
  - setCentred
```
 void setCentred(boolean centred)
```
    Flag to draw the bar centered around the set offset coordinates or to the right/bottom of thecoordinates (default)
    
    Parameters:
    
    centred - set true to centre the bar around the given screen coordinates
  - setMaxLength
```
 void setMaxLength(float pMaxLengthInCm)
```
    Sets the maximum bar length. If adjustLength is disabled this will match exactly the lengthof the bar. If adjustLength is enabled, the bar will be shortened to reflect a round numberin length.
    
    Parameters:
    
    pMaxLengthInCm - maximum length of the bar in the screen in cm.
  - setScaleBarOffset
```
 void setScaleBarOffset(int x, int y)
```
    Sets the scale bar screen offset for the bar. Note: if the bar is set to be drawn centered,this will be the middle of the bar, otherwise the top left corner.
    
    Parameters:
    
    x - x screen offset
    
    y - z screen offset
  - setLineWidth
```
 void setLineWidth(float width)
```
    Sets the bar's line width. (the default is 2)
    
    Parameters:
    
    width - the new line width
  - setTextSize
```
 void setTextSize(float size)
```
    Sets the text size. (the default is 12)
    
    Parameters:
    
    size - the new text size
  - drawLatitudeScale
```
 void drawLatitudeScale(boolean latitude)
```
    Latitudinal / horizontal scale bar flag
  - drawLongitudeScale
```
 void drawLongitudeScale(boolean longitude)
```
    Longitudinal / vertical scale bar flag
  - setBackgroundPaint
```
 void setBackgroundPaint(Paint pBgPaint)
```
    Sets the background paint. Set to null to disable drawing of background (default)
    
    Parameters:
    
    pBgPaint - the paint for colouring the bar background
  - setEnableAdjustLength
```
 void setEnableAdjustLength(boolean adjustLength)
```
    If enabled, the bar will automatically adjust the length to reflect a round number (startingwith 1, 2 or 5). If disabled, the bar will always be drawn in full length representing afractional distance.
  - draw
```
 void draw(Canvas c, Projection projection)
```
  - disableScaleBar
```
 void disableScaleBar()
```
  - enableScaleBar
```
 void enableScaleBar()
```
  - onDetach
```
 void onDetach(MapView mapView)
```
    Override to perform clean up of resources before shutdown. By default does nothing.
  - getScaleString
```
 static String getScaleString(Context pContext, String pValue, GeoConstants.UnitOfMeasure pUnitOfMeasure)
```

Class ScaleBarOverlay

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.osmdroid.views.overlay.Overlay

Methods inherited from class java.lang.Object

Constructor Detail

ScaleBarOverlay

ScaleBarOverlay

Method Detail

setMinZoom

getUnitsOfMeasure

setUnitsOfMeasure

setAlignBottom

setAlignRight

getBarPaint

setBarPaint

getTextPaint

setTextPaint

setCentred

setMaxLength

setScaleBarOffset

setLineWidth

setTextSize

drawLatitudeScale

drawLongitudeScale

setBackgroundPaint

setEnableAdjustLength

draw

disableScaleBar

enableScaleBar

onDetach

getScaleString