PointAnnotation.md

March 20, 2019 · View on GitHub

<MapboxGL.PointAnnotation />

PointAnnotation represents a one-dimensional shape located at a single geographical coordinate.

props

PropTypeDefaultRequiredDescription
idstringnonetrueA string that uniquely identifies the annotation
titlestringnonefalseThe string containing the annotation’s title. Note this is required to be set if you want to see a callout appear on iOS.
snippetstringnonefalseThe string containing the annotation’s snippet(subtitle). Not displayed in the default callout.
selectedboolnonefalseManually selects/deselects annotation
@type {[type]}
coordinatearrayOfnonetrueThe center point (specified as a map coordinate) of the annotation.
anchorshape{x: 0.5, y: 0.5}falseSpecifies the anchor being set on a particular point of the annotation.
The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],
where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.
Note this is only for custom annotations not the default pin view.
Defaults to the center of the view.
onSelectedfuncnonefalseThis callback is fired once this annotation is selected. Returns a Feature as the first param.
onDeselectedfuncnonefalseThis callback is fired once this annotation is deselected.