Marker (osmdroid-android 5.6.4 API)

java.lang.Object
- org.osmdroid.views.overlay.Overlay
- - org.osmdroid.views.overlay.OverlayWithIW
  - - org.osmdroid.views.overlay.Marker

All Implemented Interfaces:

OverlayConstants
```
public class Marker
extends OverlayWithIW
```
A marker is an icon placed at a particular point on the map's surface that can have a popup-InfoWindow (a bubble) Mimics the Marker class from Google Maps Android API v2 as much as possible. Main differences:
- Doesn't support Z-Index: as other osmdroid overlays, Marker is drawn in the order of appearance.
- The icon can be any standard Android Drawable, instead of the BitmapDescriptor introduced in Google Maps API v2.
- The icon can be changed at any time.
- The InfoWindow hosts a standard Android View. It can handle Android widgets like buttons and so on.
- Supports a "sub-description", to be displayed in the InfoWindow, under the snippet, in a smaller text font.
- Supports an image, to be displayed in the InfoWindow.
- Supports "panning to view" on/off option (when touching a marker, center the map on marker position).
- Opening a Marker InfoWindow automatically close others only if it's the same InfoWindow shared between Markers.
- Events listeners are set per marker, not per map.
TODO:
Impact of marker rotation on hitTest
When map is rotated, when panning the map, bug on the InfoWindow positioning (osmdroid issue #524)

See Also:

see also Google Maps Marker

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Marker.OnMarkerClickListener

static interface Marker.OnMarkerDragListener
- Nested classes/interfaces inherited from class org.osmdroid.views.overlay.Overlay
  Overlay.Snappable

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Marker.OnMarkerClickListener`
`static interface`	`Marker.OnMarkerDragListener`

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`ANCHOR_BOTTOM` Usual values in the (U,V) coordinates system of the icon image
`static float`	`ANCHOR_CENTER` Usual values in the (U,V) coordinates system of the icon image
`static float`	`ANCHOR_LEFT` Usual values in the (U,V) coordinates system of the icon image
`static float`	`ANCHOR_RIGHT` Usual values in the (U,V) coordinates system of the icon image
`static float`	`ANCHOR_TOP` Usual values in the (U,V) coordinates system of the icon image
`static boolean`	`ENABLE_TEXT_LABELS_WHEN_NO_IMAGE` this is an OPT IN feature that was used for kml parsing with osmbonuspack (on a remote branch) that set the image icon of a kml marker to a text label if no image url was provided.
`protected float`	`mAlpha`
`protected float`	`mAnchorU`
`protected float`	`mAnchorV`
`protected float`	`mBearing`
`protected static Drawable`	`mDefaultIcon`
`protected static MarkerInfoWindow`	`mDefaultInfoWindow`
`protected boolean`	`mDraggable`
`protected boolean`	`mFlat`
`protected Drawable`	`mIcon`
`protected Drawable`	`mImage`
`protected boolean`	`mIsDragged`
`protected float`	`mIWAnchorU`
`protected float`	`mIWAnchorV`
`protected Marker.OnMarkerClickListener`	`mOnMarkerClickListener`
`protected Marker.OnMarkerDragListener`	`mOnMarkerDragListener`
`protected boolean`	`mPanToView`
`protected GeoPoint`	`mPosition`
`protected Point`	`mPositionPixels`
`protected int`	`mTextLabelBackgroundColor`
`protected int`	`mTextLabelFontSize`
`protected int`	`mTextLabelForegroundColor`
`protected Resources`	`resource`

Fields inherited from class org.osmdroid.views.overlay.OverlayWithIW
mInfoWindow, mRelatedObject, mSnippet, mSubDescription, mTitle

Fields inherited from class org.osmdroid.views.overlay.Overlay
SHADOW_X_SKEW, SHADOW_Y_SCALE

Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants
DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Constructor Summary

Constructors
Constructor and Description

Marker(MapView mapView)

Marker(MapView mapView, Context resourceProxy)

Constructors
Constructor and Description
`Marker(MapView mapView)`
`Marker(MapView mapView, Context resourceProxy)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`cleanDefaults()` reference https://github.com/MKergall/osmbonuspack/pull/210
`void`	`draw(Canvas canvas, MapView mapView, boolean shadow)` Draw the overlay over the map.
`float`	`getAlpha()`
`Drawable`	`getImage()` get the image to be shown in the InfoWindow - this is not the marker icon
`GeoPoint`	`getPosition()`
`float`	`getRotation()`
`int`	`getTextLabelBackgroundColor()`
`int`	`getTextLabelFontSize()`
`int`	`getTextLabelForegroundColor()`
`boolean`	`hitTest(MotionEvent event, MapView mapView)`
`boolean`	`isDraggable()`
`boolean`	`isFlat()`
`boolean`	`isInfoWindowShown()`
`void`	`moveToEventPosition(MotionEvent event, MapView mapView)`
`void`	`onDetach(MapView mapView)` Null out the static references when the MapView is detached to prevent memory leaks.
`boolean`	`onLongPress(MotionEvent event, MapView mapView)` By default does nothing (`return false`).
`protected boolean`	`onMarkerClickDefault(Marker marker, MapView mapView)` default behaviour when no click listener is set
`boolean`	`onSingleTapConfirmed(MotionEvent event, MapView mapView)` By default does nothing (`return false`).
`boolean`	`onTouchEvent(MotionEvent event, MapView mapView)` You can prevent all(!) other Touch-related events from happening! By default does nothing (`return false`).
`void`	`remove(MapView mapView)` Removes this Marker from the MapView.
`void`	`setAlpha(float alpha)`
`void`	`setAnchor(float anchorU, float anchorV)`
`void`	`setDraggable(boolean draggable)`
`void`	`setFlat(boolean flat)`
`void`	`setIcon(Drawable icon)` Sets the icon for the marker.
`void`	`setImage(Drawable image)` set an image to be shown in the InfoWindow - this is not the marker icon
`void`	`setInfoWindow(MarkerInfoWindow infoWindow)` Set the InfoWindow to be used.
`void`	`setInfoWindowAnchor(float anchorU, float anchorV)`
`void`	`setOnMarkerClickListener(Marker.OnMarkerClickListener listener)`
`void`	`setOnMarkerDragListener(Marker.OnMarkerDragListener listener)`
`void`	`setPanToView(boolean panToView)` If set to true, when clicking the marker, the map will be centered on the marker position.
`void`	`setPosition(GeoPoint position)`
`void`	`setRotation(float rotation)`
`void`	`setTextLabelBackgroundColor(int mTextLabelBackgroundColor)`
`void`	`setTextLabelFontSize(int mTextLabelFontSize)`
`void`	`setTextLabelForegroundColor(int mTextLabelForegroundColor)`
`void`	`showInfoWindow()`

Methods inherited from class org.osmdroid.views.overlay.OverlayWithIW
closeInfoWindow, getInfoWindow, getRelatedObject, getSnippet, getSubDescription, getTitle, isInfoWindowOpen, onDestroy, setInfoWindow, setRelatedObject, setSnippet, setSubDescription, setTitle

Methods inherited from class org.osmdroid.views.overlay.Overlay
drawAt, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onScroll, onShowPress, onSingleTapUp, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENABLE_TEXT_LABELS_WHEN_NO_IMAGE
```
public static boolean ENABLE_TEXT_LABELS_WHEN_NO_IMAGE
```
    this is an OPT IN feature that was used for kml parsing with osmbonuspack (on a remote branch) that set the image icon of a kml marker to a text label if no image url was provided. It's also used in a few other cases, such as placing a generic text label on the map
  - mTextLabelBackgroundColor
```
protected int mTextLabelBackgroundColor
```
  - mTextLabelForegroundColor
```
protected int mTextLabelForegroundColor
```
  - mTextLabelFontSize
```
protected int mTextLabelFontSize
```
  - mIcon
```
protected Drawable mIcon
```
  - mPosition
```
protected GeoPoint mPosition
```
  - mBearing
```
protected float mBearing
```
  - mAnchorU
```
protected float mAnchorU
```
  - mAnchorV
```
protected float mAnchorV
```
  - mIWAnchorU
```
protected float mIWAnchorU
```
  - mIWAnchorV
```
protected float mIWAnchorV
```
  - mAlpha
```
protected float mAlpha
```
  - mDraggable
```
protected boolean mDraggable
```
  - mIsDragged
```
protected boolean mIsDragged
```
  - mFlat
```
protected boolean mFlat
```
  - mOnMarkerClickListener
```
protected Marker.OnMarkerClickListener mOnMarkerClickListener
```
  - mOnMarkerDragListener
```
protected Marker.OnMarkerDragListener mOnMarkerDragListener
```
  - mImage
```
protected Drawable mImage
```
  - mPanToView
```
protected boolean mPanToView
```
  - mPositionPixels
```
protected Point mPositionPixels
```
  - mDefaultInfoWindow
```
protected static MarkerInfoWindow mDefaultInfoWindow
```
  - mDefaultIcon
```
protected static Drawable mDefaultIcon
```
  - resource
```
protected Resources resource
```
  - ANCHOR_CENTER
```
public static final float ANCHOR_CENTER
```
    Usual values in the (U,V) coordinates system of the icon image
    
    See Also:
    
    Constant Field Values
  - ANCHOR_LEFT
```
public static final float ANCHOR_LEFT
```
    Usual values in the (U,V) coordinates system of the icon image
    
    See Also:
    
    Constant Field Values
  - ANCHOR_TOP
```
public static final float ANCHOR_TOP
```
    Usual values in the (U,V) coordinates system of the icon image
    
    See Also:
    
    Constant Field Values
  - ANCHOR_RIGHT
```
public static final float ANCHOR_RIGHT
```
    Usual values in the (U,V) coordinates system of the icon image
    
    See Also:
    
    Constant Field Values
  - ANCHOR_BOTTOM
```
public static final float ANCHOR_BOTTOM
```
    Usual values in the (U,V) coordinates system of the icon image
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Marker
```
public Marker(MapView mapView)
```
  - Marker
```
public Marker(MapView mapView,
              Context resourceProxy)
```
- Method Detail
  - setIcon
```
public void setIcon(Drawable icon)
```
    Sets the icon for the marker. Can be changed at any time.
    
    Parameters:
    
    icon - if null, the default osmdroid marker is used.
  - getPosition
```
public GeoPoint getPosition()
```
  - setPosition
```
public void setPosition(GeoPoint position)
```
  - getRotation
```
public float getRotation()
```
  - setRotation
```
public void setRotation(float rotation)
```
  - setAnchor
```
public void setAnchor(float anchorU,
                      float anchorV)
```
  - setInfoWindowAnchor
```
public void setInfoWindowAnchor(float anchorU,
                                float anchorV)
```
  - setAlpha
```
public void setAlpha(float alpha)
```
  - getAlpha
```
public float getAlpha()
```
  - setDraggable
```
public void setDraggable(boolean draggable)
```
  - isDraggable
```
public boolean isDraggable()
```
  - setFlat
```
public void setFlat(boolean flat)
```
  - isFlat
```
public boolean isFlat()
```
  - remove
```
public void remove(MapView mapView)
```
    Removes this Marker from the MapView. Note that this method will operate only if the Marker is in the MapView overlays (it should not be included in a container like a FolderOverlay).
    
    Parameters:
    
    mapView -
  - setOnMarkerClickListener
```
public void setOnMarkerClickListener(Marker.OnMarkerClickListener listener)
```
  - setOnMarkerDragListener
```
public void setOnMarkerDragListener(Marker.OnMarkerDragListener listener)
```
  - setImage
```
public void setImage(Drawable image)
```
    set an image to be shown in the InfoWindow - this is not the marker icon
  - getImage
```
public Drawable getImage()
```
    get the image to be shown in the InfoWindow - this is not the marker icon
  - setInfoWindow
```
public void setInfoWindow(MarkerInfoWindow infoWindow)
```
    Set the InfoWindow to be used. Default is a MarkerInfoWindow, with the layout named "bonuspack_bubble". You can use this method either to use your own layout, or to use your own sub-class of InfoWindow. Note that this InfoWindow will receive the Marker object as an input, so it MUST be able to handle Marker attributes. If you don't want any InfoWindow to open, you can set it to null.
  - setPanToView
```
public void setPanToView(boolean panToView)
```
    If set to true, when clicking the marker, the map will be centered on the marker position. Default is true.
  - showInfoWindow
```
public void showInfoWindow()
```
  - isInfoWindowShown
```
public boolean isInfoWindowShown()
```
  - draw
```
public void draw(Canvas canvas,
                 MapView mapView,
                 boolean shadow)
```
    Description copied from class: Overlay
    
    Draw the overlay over the map. This will be called on all active overlays with shadow=true, to lay down the shadow layer, and then again on all overlays with shadow=false. Callers should check isEnabled() before calling draw(). By default, draws nothing. changed for 5.6 to be public see https://github.com/osmdroid/osmdroid/issues/466
    
    Specified by:
    
    draw in class Overlay
  - onDetach
```
public void onDetach(MapView mapView)
```
    Null out the static references when the MapView is detached to prevent memory leaks.
    
    Overrides:
    
    onDetach in class Overlay
  - cleanDefaults
```
public static void cleanDefaults()
```
    reference https://github.com/MKergall/osmbonuspack/pull/210
  - hitTest
```
public boolean hitTest(MotionEvent event,
                       MapView mapView)
```
  - onSingleTapConfirmed
```
public boolean onSingleTapConfirmed(MotionEvent event,
                                    MapView mapView)
```
    Description copied from class: Overlay
    
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
    
    Overrides:
    
    onSingleTapConfirmed in class Overlay
  - moveToEventPosition
```
public void moveToEventPosition(MotionEvent event,
                                MapView mapView)
```
  - onLongPress
```
public boolean onLongPress(MotionEvent event,
                           MapView mapView)
```
    Description copied from class: Overlay
    
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
    
    Overrides:
    
    onLongPress in class Overlay
  - onTouchEvent
```
public boolean onTouchEvent(MotionEvent event,
                            MapView mapView)
```
    Description copied from class: Overlay
    
    You can prevent all(!) other Touch-related events from happening!
    By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.
    
    Overrides:
    
    onTouchEvent in class Overlay
  - onMarkerClickDefault
```
protected boolean onMarkerClickDefault(Marker marker,
                                       MapView mapView)
```
    default behaviour when no click listener is set
  - getTextLabelBackgroundColor
```
public int getTextLabelBackgroundColor()
```
  - setTextLabelBackgroundColor
```
public void setTextLabelBackgroundColor(int mTextLabelBackgroundColor)
```
  - getTextLabelForegroundColor
```
public int getTextLabelForegroundColor()
```
  - setTextLabelForegroundColor
```
public void setTextLabelForegroundColor(int mTextLabelForegroundColor)
```
  - getTextLabelFontSize
```
public int getTextLabelFontSize()
```
  - setTextLabelFontSize
```
public void setTextLabelFontSize(int mTextLabelFontSize)
```

Class Marker

Nested Class Summary

Nested classes/interfaces inherited from class org.osmdroid.views.overlay.Overlay

Field Summary

Fields inherited from class org.osmdroid.views.overlay.OverlayWithIW

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

Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

ENABLE_TEXT_LABELS_WHEN_NO_IMAGE

mTextLabelBackgroundColor

mTextLabelForegroundColor

mTextLabelFontSize

mIcon

mPosition

mBearing

mAnchorU

mAnchorV

mIWAnchorU

mIWAnchorV

mAlpha

mDraggable

mIsDragged

mFlat

mOnMarkerClickListener

mOnMarkerDragListener

mImage

mPanToView

mPositionPixels

mDefaultInfoWindow

mDefaultIcon

resource

ANCHOR_CENTER

ANCHOR_LEFT

ANCHOR_TOP

ANCHOR_RIGHT

ANCHOR_BOTTOM

Constructor Detail

Marker

Marker

Method Detail

setIcon

getPosition

setPosition

getRotation

setRotation

setAnchor

setInfoWindowAnchor

setAlpha

getAlpha

setDraggable

isDraggable

setFlat

isFlat

remove

setOnMarkerClickListener

setOnMarkerDragListener

setImage

getImage

setInfoWindow

setPanToView

showInfoWindow

isInfoWindowShown

draw

onDetach

cleanDefaults

hitTest

onSingleTapConfirmed

moveToEventPosition

onLongPress

onTouchEvent

onMarkerClickDefault

getTextLabelBackgroundColor

setTextLabelBackgroundColor

getTextLabelForegroundColor

setTextLabelForegroundColor