com.tomtom.sdk.maps:map-display-api/com.tomtom.sdk.map.display.marker/MarkerOptions

MarkerOptions

class MarkerOptions(val coordinate: GeoPoint, val pinImage: Image, val pinIconImage: Image? = null, val shieldImage: Image? = null, val pinIconAnchor: PointF = Marker.DEFAULT_PIN_ICON_ANCHOR, val placementAnchor: PointF = Marker.DEFAULT_PLACEMENT_ANCHOR, val shieldImageAnchor: PointF = Marker.DEFAULT_SHIELD_IMAGE_ANCHOR, val tag: String? = null, val label: Label? = null, val balloonText: String = "")

Defines configuration options for a Marker view which can be added and displayed on the map. See TomTomMap.addMarker(options: MarkerOptions).

Constructors

Link copied to clipboard
constructor(coordinate: GeoPoint, pinImage: Image, pinIconImage: Image? = null, shieldImage: Image? = null, pinIconAnchor: PointF = Marker.DEFAULT_PIN_ICON_ANCHOR, placementAnchor: PointF = Marker.DEFAULT_PLACEMENT_ANCHOR, shieldImageAnchor: PointF = Marker.DEFAULT_SHIELD_IMAGE_ANCHOR, tag: String? = null, label: Label? = null, balloonText: String = "", isVisible: Boolean = true)

Defines configuration options for a Marker view which can be added and displayed on the map. See TomTomMap.addMarker(options: MarkerOptions).

constructor(coordinate: GeoPoint, pinImage: Image, pinIconImage: Image? = null, shieldImage: Image? = null, pinIconAnchor: PointF = Marker.DEFAULT_PIN_ICON_ANCHOR, placementAnchor: PointF = Marker.DEFAULT_PLACEMENT_ANCHOR, shieldImageAnchor: PointF = Marker.DEFAULT_SHIELD_IMAGE_ANCHOR, tag: String? = null, label: Label? = null, balloonText: String = "")

Properties

Link copied to clipboard
val balloonText: String

Text displayed within the marker balloon (if visible).

Link copied to clipboard
val coordinate: GeoPoint

Location of the given Marker.

Link copied to clipboard
val isVisible: Boolean

Decides if the marker is visible.

Link copied to clipboard
val label: Label? = null

Label textually describing the Marker.

Link copied to clipboard
val pinIconAnchor: PointF

Sets the position of the icon relative to the pin. When the given x/y values are outside of the range 0, 1, the icon moves more than the width/height of the pin.

Link copied to clipboard
val pinIconImage: Image? = null

Image that will be used as a Marker pin icon.

Link copied to clipboard
val pinImage: Image

Image that will be used as a Marker pin.

Link copied to clipboard
val placementAnchor: PointF

Sets the whole marker's pin offset.

Link copied to clipboard
val shieldImage: Image? = null

Image that will be used as a Marker shield.

Link copied to clipboard
val shieldImageAnchor: PointF

Sets the pin's shield anchor.

Link copied to clipboard
val tag: String? = null

Сan be used to identify group of markers.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun component2(): Image
Link copied to clipboard
fun component3(): Image?
Link copied to clipboard
fun component4(): Image?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun component8(): String?
Link copied to clipboard
fun component9(): Label?
Link copied to clipboard
fun copy(coordinate: GeoPoint, pinImage: Image, pinIconImage: Image?, shieldImage: Image?, pinIconAnchor: PointF, placementAnchor: PointF, shieldImageAnchor: PointF, tag: String?, label: Label?, balloonText: String): MarkerOptions
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String