Class: Toybox.WatchUi.MapMarker

Inherits:

Toybox.Lang.Object

Overview

The base class for the MapMarker object.

The MapMarker is used to hold a BitmapResource, or a MAP_MARKER_ICON_* enum value, and the corresponding x, y value to note the "hotspot" for the image to be used as an icon for a marker within a MapView. This class also contains the Location at which the MapMarker should be displayed on the map.

Since:

API Level 3.0.0

Supported Devices:

Instance Method Summary collapse

getLocation() as Position.Location

Get the location for the MapMarker.
initialize(location as Position.Location)

Constructor.
setIcon(icon as Graphics.BitmapType or WatchUi.MapMarkerIcon or Lang.Number, x as Lang.Number, y as Lang.Number) as Void

Set a bitmap icon to use for the MapMarker object on a MapView.
setLabel(label as Lang.String or Lang.ResourceId) as Void

Instance Method Details

getLocation() as Position.Location

Get the location for the MapMarker.

Returns:

Position.Location —

The location for this MapMarker as a Location object

Since:

API Level 3.0.0

initialize(location as Position.Location)

Constructor

Parameters:

location — (Position.Location) —

The Location at which the MapMarker object will be rendered on the map

Since:

API Level 3.0.0

Throws:

(Lang.UnexpectedTypeException) —

Thrown if location is not a Location type

setIcon(icon as Graphics.BitmapType or WatchUi.MapMarkerIcon or Lang.Number, x as Lang.Number, y as Lang.Number) as Void

Set a bitmap icon to use for the MapMarker object on a MapView.

Parameters:

icon — (Graphics.BitmapType, Lang.Number) —

A BitmapType or MAP_MARKER_ICON_* value
x — (Lang.Number) —

The x location of the hotspot on the bitmap in pixels (px). Used to align the hotspot with the longitude of the MapMarker. This value is required, but will be disregarded when used with MAP_MARKER_ICON_* type.
y — (Lang.Number) —

The y location of the hotspot on the bitmap in pixels (px). Used to align the hotspot with the latitude value of the MapMarker. This value is required, but will be disregarded when used with MAP_MARKER_ICON_* type.

Since:

API Level 3.0.0

Throws:

(WatchUi.InvalidPointException) —

Thrown if the x, y values for the hotspot fall outside the bounds of the icon image
(Lang.UnexpectedTypeException) —

Thrown if icon is not a supported type
(Lang.InvalidValueException) —

Thrown if icon is not a supported value

setLabel(label as Lang.String or Lang.ResourceId) as Void

Parameters:

label — (Lang.String, Lang.ResourceId) —

The label for the marker object as a String or string ResourceId