Skip to content

Latest commit

 

History

History
22 lines (19 loc) · 2.11 KB

PointAnnotation.md

File metadata and controls

22 lines (19 loc) · 2.11 KB
Raw

<MapboxGL.PointAnnotation />

PointAnnotation represents a one-dimensional shape located at a single geographical coordinate. PointAnnotation is legacy, soon to be deprecated, and should use ShapeSource and SymbolLayer instead.

props

Prop Type Default Required Description
id string none true A string that uniquely identifies the annotation
title string none false The string containing the annotation’s title. Note this is required to be set if you want to see a callout appear on iOS.
snippet string none false The string containing the annotation’s snippet(subtitle). Not displayed in the default callout.
selected bool none false Manually selects/deselects annotation
@type {[type]}
draggable bool false false Enable or disable dragging. Defaults to false.
coordinate array none true The center point (specified as a map coordinate) of the annotation.
anchor shape {x: 0.5, y: 0.5} false Specifies 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.
  x number none true FIX ME NO DESCRIPTION
  y number none true FIX ME NO DESCRIPTION
onSelected func none false This callback is fired once this annotation is selected. Returns a Feature as the first param.
onDeselected func none false This callback is fired once this annotation is deselected.
onDragStart func none false This callback is fired once this annotation has started being dragged.
onDragEnd func none false This callback is fired once this annotation has stopped being dragged.