OpenMapView/de.afarber.openmapview/Marker

Marker

class Marker(position: LatLng, title: String? = null, snippet: String? = null, icon: BitmapDescriptor? = null, anchor: Pair<Float, Float> = Pair(0.5f, 1.0f), infoWindowAnchor: Pair<Float, Float> = Pair(0.5f, 0.0f), rotation: Float = 0.0f, isFlat: Boolean = false, visible: Boolean = true, alpha: Float = 1.0f, draggable: Boolean = false, zIndex: Float = 0.0f, tag: Any? = null)(source)

A marker on the map at a specific geographic location.

The marker returned by OpenMapView.addMarker is a live handle, as in the Maps SDK: setting a property redraws the map right away, and remove takes the marker off the map.

Parameters

position

The geographic location of the marker

title

Optional title text displayed when marker is clicked

snippet

Optional snippet text displayed below the title

icon

Custom icon descriptor. If null, a default red marker icon will be used

anchor

Anchor point for the marker icon. Default (0.5f, 1.0f) means the marker is centered horizontally and anchored at the bottom

infoWindowAnchor

The point of the icon the info window points at, as fractions of its width and height. Default (0.5f, 0.0f) is the top center

rotation

Clockwise rotation of the icon around the anchor, in degrees: relative to the screen, or to north for a flat icon. Default is 0

isFlat

Whether the icon lies flat on the map and turns with it when the camera has a bearing, instead of facing the screen. Default is false

visible

Whether the marker is visible. Default is true

alpha

Opacity of the marker from 0.0 (transparent) to 1.0 (opaque). Default is 1.0

draggable

Whether the marker can be dragged. Default is false

zIndex

Draw order. Markers with higher zIndex are drawn on top. Default is 0.0

tag

Optional user data associated with the marker

Constructors

Marker

constructor(position: LatLng, title: String? = null, snippet: String? = null, icon: BitmapDescriptor? = null, anchor: Pair<Float, Float> = Pair(0.5f, 1.0f), infoWindowAnchor: Pair<Float, Float> = Pair(0.5f, 0.0f), rotation: Float = 0.0f, isFlat: Boolean = false, visible: Boolean = true, alpha: Float = 1.0f, draggable: Boolean = false, zIndex: Float = 0.0f, tag: Any? = null)

Properties

alpha

var alpha: Float

Opacity from 0.0 (transparent) to 1.0 (opaque)

anchor

var anchor: Pair<Float, Float>

The point of the icon at position, as fractions of its width and height

draggable

var draggable: Boolean

Whether the marker can be dragged

icon

var icon: BitmapDescriptor?

Custom icon, or null for the default red marker

val id: String

The unique id of this marker, e.g. "m0", which stays the same for its lifetime. Useful as a key to find the marker again, e.g. in a listener. copy returns a marker with a new id.

infoWindowAnchor

var infoWindowAnchor: Pair<Float, Float>

The point of the icon the info window points at, as fractions of its width and height

isFlat

var isFlat: Boolean

Whether the icon lies flat on the map and turns with it, instead of facing the screen

isInfoWindowShown

var isInfoWindowShown: Boolean

Whether the info window is currently shown for this marker.

position

var position: LatLng

The geographic location of the marker, also changed while it is dragged

rotation

var rotation: Float

Clockwise rotation of the icon around the anchor in degrees, relative to the screen, or to north if isFlat

snippet

var snippet: String?

Snippet text shown below the title in the info window

tag

var tag: Any?

Optional user data

title

var title: String?

Title text shown in the info window

visible

var visible: Boolean

Whether the marker is visible

zIndex

var zIndex: Float

Draw order: markers with a higher zIndex are drawn on top

Functions

copy

fun copy(position: LatLng = this.position, title: String? = this.title, snippet: String? = this.snippet, icon: BitmapDescriptor? = this.icon, anchor: Pair<Float, Float> = this.anchor, infoWindowAnchor: Pair<Float, Float> = this.infoWindowAnchor, rotation: Float = this.rotation, isFlat: Boolean = this.isFlat, visible: Boolean = this.visible, alpha: Float = this.alpha, draggable: Boolean = this.draggable, zIndex: Float = this.zIndex, tag: Any? = this.tag): Marker

Returns a new marker with the given properties changed, not added to any map.

equals